Skip to content

Commit da8ea47

Browse files
authored
Merge pull request #117 from ronaldpetty/main
docs: initial kyverno documentation
2 parents a542b40 + 43350e2 commit da8ea47

File tree

1 file changed

+69
-10
lines changed

1 file changed

+69
-10
lines changed

docs/reference/cli/filters.md

Lines changed: 69 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,19 @@ K8sGPT offers integration with other tools. Once an integration is added to K8sG
55
* Filters are a way of selecting which resources you wish to be part of your default analysis.
66
* Integrations are a way to add resources to the filter list.
77

8-
9-
The first integration that has been added is Trivy.
10-
[Trivy](https://github.com/aquasecurity/trivy) is an open source, cloud native security scanner, maintained by Aqua Security.
11-
12-
K8sGPT also supports a [Prometheus](https://prometheus.io) integration. Prometheus is an open source monitoring solution.
13-
148
Use the following command to access all K8sGPT CLI options related to integrations:
159
```bash
1610
k8sgpt integrations
1711
```
1812

13+
1914
## Prerequisites
15+
2016
For using the K8sGPT integrations please ensure that you have the latest version of the [K8sGPT CLI](https://docs.k8sgpt.ai/getting-started/installation/) installed.
2117
Also, please make sure that you are connected to a Kubernetes cluster.
2218

23-
## Activating a new integration
19+
20+
## Activating an Integration
2421

2522
**Prerequisites**
2623

@@ -33,8 +30,12 @@ k8sgpt integrations list
3330

3431
This will provide you with a list of available integrations.
3532

33+
3634
## Trivy
3735

36+
The first integration that has been added is Trivy.
37+
[Trivy](https://github.com/aquasecurity/trivy) is an open source, cloud native security scanner, maintained by Aqua Security.
38+
3839
Activate the Trivy integration:
3940
```bash
4041
k8sgpt integration activate trivy
@@ -96,6 +97,8 @@ This command will analyze your cluster Vulnerabilities through K8sGPT. Depending
9697

9798
## Prometheus
9899

100+
K8sGPT supports a [Prometheus](https://prometheus.io) integration. Prometheus is an open source monitoring solution.
101+
99102
The Prometheus integration does not deploy resources in your cluster. Instead,
100103
it detects a running Prometheus stack in the provided namespace using the
101104
`--namespace` flag. If you do not have Prometheus running, you can install it
@@ -264,6 +267,63 @@ k8sgpt analyze --filter EKS
264267

265268
This command analyzes your cluster's EKS resources using K8sGPT. Make sure your EKS cluster is working in the specified namespace. The report's results will vary based on the EKS reports available in your cluster.
266269

270+
271+
## Kyverno
272+
273+
[Kyverno](https://kyverno.io/) is a policy engine designed for Kubernetes.
274+
275+
Kyverno must be installed prior to using this integration.
276+
277+
To activate the Kyverno integration:
278+
```
279+
k8sgpt integration activate kyverno
280+
281+
k8sgpt integration list
282+
Active:
283+
> kyverno
284+
Unused:
285+
> trivy
286+
> prometheus
287+
> aws
288+
> keda
289+
```
290+
291+
The following filters will become available:
292+
293+
* PolicyReport
294+
* ClusterPolicyReport
295+
296+
```
297+
k8sgpt filters list
298+
Active:
299+
> ClusterPolicyReport (integration)
300+
> ReplicaSet
301+
> Service
302+
> StatefulSet
303+
> PersistentVolumeClaim
304+
> ValidatingWebhookConfiguration
305+
> MutatingWebhookConfiguration
306+
> PolicyReport (integration)
307+
> Node
308+
> Pod
309+
> Deployment
310+
> Ingress
311+
> CronJob
312+
Unused:
313+
> Log
314+
> GatewayClass
315+
> Gateway
316+
> HTTPRoute
317+
> HorizontalPodAutoScaler
318+
> PodDisruptionBudget
319+
> NetworkPolicy
320+
```
321+
322+
Policy reports are generated and managed by Kyverno. You can learn more about this here https://kyverno.io/docs/policy-reports/.
323+
324+
Kyverno is currently only supported via the CLI, an operator is being developed.
325+
326+
267327
## Adding and removing default filters
268328

269329
_Remove default filters_
@@ -272,7 +332,7 @@ _Remove default filters_
272332
k8sgpt filters add [filter(s)]
273333
```
274334

275-
- Simple filter : `k8sgpt filters add Service`
335+
- Single filter : `k8sgpt filters add Service`
276336
- Multiple filters : `k8sgpt filters add Ingress,Pod`
277337

278338

@@ -283,5 +343,4 @@ k8sgpt filters remove [filter(s)]
283343
```
284344

285345
- Simple filter : `k8sgpt filters remove Service`
286-
- Multiple filters : `k8sgpt filters remove Ingress,Pod`
287-
346+
- Multiple filters : `k8sgpt filters remove Ingress,Pod`

0 commit comments

Comments
 (0)