Skip to content

Commit

Permalink
Add integrations docs
Browse files Browse the repository at this point in the history
Signed-off-by: Mmadu Manasseh <[email protected]>
  • Loading branch information
MeNsaaH committed Jan 10, 2025
1 parent 264b560 commit 9d9616c
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions docs/integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Integrations

`kubechecks` supports various integrations to enhance its functionality. Below are the integrations and how to configure them:

### OpenAI

OpenAI is used to explain the diffs

#### Configuration

To enable OpenAI diff explanation, set the following environment variable in your `values.yaml`:

```yaml
KUBECHECKS_OPENAI_API_TOKEN: true
```
### Conftest
Conftest is used for policy checking of manifests.
#### Configuration
To enable Conftest, set the following environment variable in your `values.yaml`:

```yaml
KUBECHECKS_ENABLE_CONFTEST: true
```

### Kubeconform

Kubeconform is used for validating Kubernetes manifests against the Kubernetes OpenAPI schemas.

#### Configuration

To enable Kubeconform, set the following environment variable in your `values.yaml`:

```yaml
KUBECHECKS_ENABLE_KUBECONFORM: true
```

### Kyverno

Kyverno is used for policy checks. This kyverno integration uses the `kyverno-cli` and only supports basic policies - policies without variables and contexts because these policies will require and external values configuration.

#### Configuration

To enable Kyverno, set the following environment variable in your `values.yaml`:

```yaml
KUBECHECKS_ENABLE_KYVERNO_CHECKS: true
```

Additionally, you'll need to set the location of Kyverno policies:

```yaml
KUBECHECKS_KYVERNO_POLICIES_LOCATION: <your-policies-location>
```

### OpenTelemetry

OpenTelemetry is used for observability and tracing.

#### Configuration

To enable OpenTelemetry, set the following environment variables in your `values.yaml`:

```yaml
KUBECHECKS_OTEL_ENABLED: true
KUBECHECKS_OTEL_COLLECTOR_HOST: <your-otel-collector-host>
KUBECHECKS_OTEL_COLLECTOR_PORT: <your-otel-collector-port>
```

0 comments on commit 9d9616c

Please sign in to comment.