Skip to content

Commit

Permalink
Update helm.md (#1390)
Browse files Browse the repository at this point in the history
- Update the helm installation command and remove the `--set` option from it.
- Add a new helm installation command setting the `trivy.ignoreUnfixed` configuration as an example of using `--set`
  • Loading branch information
rammanoj authored Jul 27, 2023
1 parent 0496b2c commit d204543
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/getting-started/installation/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,25 @@ except `kube-system` and `trivy-system`:
helm install trivy-operator ./deploy/helm \
--namespace trivy-system \
--create-namespace \
--set="trivy.ignoreUnfixed=true"
```
Or install the chart from the Aqua chart repository:
```
helm install trivy-operator aqua/trivy-operator \
--namespace trivy-system \
--create-namespace \
--set="trivy.ignoreUnfixed=true" \
--version {{ var.chart_version }}
```

Configuration options can be passed using the `--set` parameter. To list only the fixed vulnerabilities in the cluster, one can use the following command.
```
helm install trivy-operator ./deploy/helm \
--namespace trivy-system \
--create-namespace \
--set="trivy.ignoreUnfixed=true"
```

There are many [values] in the chart that can be set to configure Trivy-Operator. See the [Customising][customising] section for more details.
3. Check that the `trivy-operator` Helm release is created in the `trivy-system` namespace, and it has status
4. Check that the `trivy-operator` Helm release is created in the `trivy-system` namespace, and it has status
`deployed`:
```console
$ helm list -n trivy-system
Expand Down Expand Up @@ -127,4 +134,4 @@ There are two ways to overwrite values in a Helm chart upon installation:
[charts]: https://helm.sh/docs/topics/charts/
[values]: https://raw.githubusercontent.com/aquasecurity/trivy-operator/{{ git.tag }}/deploy/helm/values.yaml
[customising]: ./#customising-the-helm-chart
[helm-dir]: https://github.com/aquasecurity/trivy-operator/tree/main/deploy/helm
[helm-dir]: https://github.com/aquasecurity/trivy-operator/tree/main/deploy/helm

0 comments on commit d204543

Please sign in to comment.