You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/cli/filters.md
+69-10Lines changed: 69 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,19 @@ K8sGPT offers integration with other tools. Once an integration is added to K8sG
5
5
* Filters are a way of selecting which resources you wish to be part of your default analysis.
6
6
* Integrations are a way to add resources to the filter list.
7
7
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
-
14
8
Use the following command to access all K8sGPT CLI options related to integrations:
15
9
```bash
16
10
k8sgpt integrations
17
11
```
18
12
13
+
19
14
## Prerequisites
15
+
20
16
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.
21
17
Also, please make sure that you are connected to a Kubernetes cluster.
22
18
23
-
## Activating a new integration
19
+
20
+
## Activating an Integration
24
21
25
22
**Prerequisites**
26
23
@@ -33,8 +30,12 @@ k8sgpt integrations list
33
30
34
31
This will provide you with a list of available integrations.
35
32
33
+
36
34
## Trivy
37
35
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
+
38
39
Activate the Trivy integration:
39
40
```bash
40
41
k8sgpt integration activate trivy
@@ -96,6 +97,8 @@ This command will analyze your cluster Vulnerabilities through K8sGPT. Depending
96
97
97
98
## Prometheus
98
99
100
+
K8sGPT supports a [Prometheus](https://prometheus.io) integration. Prometheus is an open source monitoring solution.
101
+
99
102
The Prometheus integration does not deploy resources in your cluster. Instead,
100
103
it detects a running Prometheus stack in the provided namespace using the
101
104
`--namespace` flag. If you do not have Prometheus running, you can install it
@@ -264,6 +267,63 @@ k8sgpt analyze --filter EKS
264
267
265
268
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.
266
269
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.
0 commit comments