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

Improve Trivy explanation on default metrics #726

Merged
merged 2 commits into from
Dec 18, 2024
Merged

Improve Trivy explanation on default metrics #726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ff2a8a
update trivy explanation for default metrics
8naama Dec 16, 2024
ae126f6
auto generated manifest
8naama Dec 16, 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
27 changes: 24 additions & 3 deletions docs/shipping/Security/trivy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: Trivy
title: Trivy
overview: TThis integration utilizes the logzio-trivy Helm Chart to deploy the trivy-Operator Helm Chart that scans the cluster and creates Trivy reports and a deployment that looks for the Trivy reports in the cluster, processes them, and sends them to Logz.io
product: ['metrics']
product: ['logs', 'metrics']
os: ['windows', 'linux']
filters: ['Security']
logo: https://logzbucket.s3.eu-west-1.amazonaws.com/logz-docs/shipper-logos/trivy-logo.png
Expand Down Expand Up @@ -39,8 +39,6 @@ This integration is presently in its beta phase and may be subject to modificati
* An active Logz.io account
* Kubernetes cluster to send reports from




### Add `logzio-helm` repo

Expand Down Expand Up @@ -72,6 +70,29 @@ With this command, we instruct Helm to create the monitoring namespace if it doe
| `<<LISTENER-HOST>>` | Replace `<<LISTENER-HOST>>` with the host for your region, without the `http/https` prefix. |


#### Trivy Metrics
By default the `trivy-operator` [exposes a metrics endpoint](https://aquasecurity.github.io/trivy-operator/v0.23.0/tutorials/integrations/metrics/). As a result, if the chart is run alongside the [Logz.io Telemetry chart to collect metrics from the cluster](https://docs.logz.io/docs/k8s-360/unified-helm-chart/#send-your-metrics), the Trivy metrics will also be collected.


:::caution
The Logz.io Telemetry chart is sending metrics of the entire cluster and not only of trivy.
:::

```shell
helm install -n monitoring --create-namespace \
--set metricsOrTraces.enabled=true \
--set logzio-k8s-telemetry.metrics.enabled=true \
--set logzio-k8s-telemetry.secrets.MetricsToken="<<METRICS-SHIPPING-TOKEN>>" \
--set logzio-k8s-telemetry.secrets.ListenerHost="https://<<LISTENER-HOST>>:8053" \
--set logzio-k8s-telemetry.secrets.p8s_logzio_name="<<ENV-ID>>" \
--set logzio-k8s-telemetry.secrets.env_id="<<ENV-ID>>" \
--set securityReport.enabled=true \
--set logzio-trivy.env_id="<<ENV-ID>>" \
--set logzio-trivy.secrets.logzioShippingToken="<<LOG-SHIPPING-TOKEN>>" \
--set logzio-trivy.secrets.logzioListener="<<LISTENER-HOST>>" \
logzio-monitoring logzio-helm/logzio-monitoring
```

### Check Logz.io for your reports

Give your reports some time to get from your system to ours,
Expand Down
2 changes: 1 addition & 1 deletion static/manifest.json
View file
Open in desktop

Large diffs are not rendered by default.