Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add information on running Helm Chart in client server mode #2005

Merged
merged 2 commits into from
Apr 15, 2024
Merged

docs: add information on running Helm Chart in client server mode #2005

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa21228
add information on running Helm Chart in client server mode
AnaisUrlichs Apr 15, 2024
720ebb8
add minor styling change
AnaisUrlichs Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion docs/docs/vulnerability-scanning/trivy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,26 @@ EOF

## ClientServer

You can connect Trivy to an external Trivy server by changing the default `trivy.mode` from
Running Trivy in Client Server mode is more efficient as every scan will access the same Trivy vulnerability database from the server.

There are two options to run the Trivy Operator in Client Server mode as detailed below.

**1. Server Managed by the Trivy Operator**

The Trivy Operator has an option [in the values.yaml file](https://github.com/aquasecurity/trivy-operator/blob/8b906fdf4d4c4ac425db6065e6d577af4e00c284/deploy/helm/values.yaml#L107) of the Helm chart to specify the Trivy Operator to run in Client Server mode:
```
operator:
builtInTrivyServer: false
```

Setting this option to `true` will enable the Client Server mode, managed by the Trivy Operator. No further configuration is required. The Trivy Operator will spin up two pods in the respective namsepace:

1. `trivy-operator`: Responsible for running scans
2. `trivy-server-0`: Provides the Trivy vulnerability database to the trivy-operator

**2. External Server Managed by the user**

Users can connect Trivy to an external Trivy server by changing the default `trivy.mode` from
[`Standalone`][trivy-standalone] to [`ClientServer`][trivy-clientserver] and specifying `trivy.serverURL`.

```bash
Expand Down
Loading