Skip to content

Commit

Permalink
Merge pull request #77 from AnaisUrlichs/anais-cli-docs-updates
Browse files Browse the repository at this point in the history
fix: update cli integration and filter docs
  • Loading branch information
AlexsJones authored Nov 22, 2023
2 parents f1ba680 + 42677bf commit ed18a5b
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions docs/reference/cli/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
K8sGPT offers integration with other tools. Once an integration is added to K8sGPT, it is possible to use its resources as additional filters.

* Filters are a way of selecting which resources you wish to be part of your default analysis.
* Integrations are a way to add in additional resources to the filter list.
* Integrations are a way to add resources to the filter list.


The first integration that has been added is Trivy.
Expand Down Expand Up @@ -32,28 +32,35 @@ Activate the Trivy integration:
k8sgpt integration activate trivy
```

Once activated, you should see the following success message displayed:
> Activated integration trivy
This will install the Trivy Kubernetes Operator into the Kubernetes cluster and make it possible for K8sGPT to interact with the results of the Operator.

Once the Trivy Operator is installed inside the cluster, K8sGPT will have access to VulnerabilityReports:
Once the Trivy Operator is installed inside the cluster, K8sGPT will have access to VulnerabilityReports and ConfigAuditReports:
```bash
k8sgpt filters list
k8sgpt filters list

Active:
> VulnerabilityReport (integration)
Unused:
> Pod
> Deployment
> ConfigAuditReport (integration)
Unused:
> PersistentVolumeClaim
> Service
> CronJob
> Node
> MutatingWebhookConfiguration
> Deployment
> StatefulSet
> ValidatingWebhookConfiguration
> ReplicaSet
> PersistentVolumeClaim
> Ingress
> CronJob
> Node
> NetworkPolicy
> HorizontalPodAutoScaler
> PodDisruptionBudget
```
> NetworkPolicy

More information can be found on the official [Trivy-Operator documentation.](https://aquasecurity.github.io/trivy-operator/latest/docs/crds/)

## Using the new filters to analyze your cluster

Expand Down

0 comments on commit ed18a5b

Please sign in to comment.