-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): clarify installation guide (#4)
- Loading branch information
Showing
1 changed file
with
6 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,28 +2,15 @@ | |
|
||
[Helm](https://helm.sh/) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. | ||
|
||
## Clone the repository: | ||
|
||
```shell | ||
git clone [email protected]:NeuraLegion/sniffer-chart.git --depth 1 | ||
cd ./sniffer-chart | ||
``` | ||
|
||
## Render the Helm templates: | ||
|
||
```shell | ||
helm template . | ||
``` | ||
|
||
## Install the sniffer: | ||
## Install the sniffer | ||
|
||
Use the Helm command to install the Sniffer: | ||
|
||
```shell | ||
helm install sniffer . -f values.yaml | ||
helm install oci://ghcr.io/neuralegion/sniffer . -f values.yaml | ||
``` | ||
|
||
## Override default configurations (using values.yaml): | ||
## Override default configuration (using values.yaml) | ||
|
||
To customize configurations, modify the `values.yaml` file as follows: | ||
|
||
|
@@ -32,23 +19,14 @@ api: | |
apiKey: '<your API key with entry-points:manage or entry-points:admin scopes>' | ||
apiURL: 'https://app.brightsec.com/' | ||
projectID: '<your Bright project ID>' | ||
|
||
sniffer: | ||
image: | ||
pullPolicy: Always | ||
|
||
extraArgs: | ||
group-public-ips: true | ||
send-traffic-delta: true | ||
ebpf-dns-tracer-enabled: false | ||
``` | ||
## Uninstall the sniffer: | ||
## Uninstall the sniffer | ||
To remove the Sniffer, use the following command: | ||
If you want to delete the Sniffer from your Kubernetes cluster, use the following command: | ||
```shell | ||
helm uninstall sniffer | ||
helm delete sniffer | ||
``` | ||
|
||
## License | ||
|