Skip to content
This repository was archived by the owner on Mar 26, 2025. It is now read-only.

Commit 2705265

Browse files
committed
Add Readme to the helm chart
1 parent 9a776d2 commit 2705265

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

charts/kafka-operator/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Kafka-operator chart
2+
3+
[Kafka-operator](https://github.com/banzaicloud/kafka-operator) is a Kubernetes operator to deploy and manage [Kafka](https://kafka.apache.org) resources for a Kubernetes cluster.
4+
5+
## Prerequisites
6+
7+
- Kubernetes 1.13.0+
8+
9+
## Installing the chart
10+
11+
To install the chart:
12+
13+
```
14+
$ helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com
15+
$ helm install --name=kafka-operator --namespace=kafka banzaicloud-stable/kafka-operator
16+
```
17+
18+
## Uninstalling the Chart
19+
20+
To uninstall/delete the `kafka-operator` release:
21+
22+
```
23+
$ helm delete --purge kafka-operator
24+
```
25+
26+
The command removes all the Kubernetes components associated with the chart and deletes the release.
27+
28+
## Configuration
29+
30+
The following table lists the configurable parameters of the Banzaicloud Kafka Operator chart and their default values.
31+
32+
Parameter | Description | Default
33+
--------- | ----------- | -------
34+
`operator.image.repository` | Operator container image repository | `banzaicloud/kafka-operator`
35+
`operator.image.tag` | Operator container image tag | `0.6.0`
36+
`operator.image.pullPolicy` | Operator container image pull policy | `IfNotPresent`
37+
`operator.resources` | CPU/Memory resource requests/limits (YAML) | Memory: `128Mi/256Mi`, CPU: `100m/200m`
38+
`prometheusMetrics.enabled` | If true, use direct access for Prometheus metrics | `false`
39+
`prometheusMetrics.authProxy.enabled` | If true, use auth proxy for Prometheus metrics | `true`
40+
`prometheusMetrics.authProxy.image.repository` | Auth proxy container image repository | `gcr.io/kubebuilder/kube-rbac-proxy`
41+
`prometheusMetrics.authProxy.image.tag` | Auth proxy container image tag | `v0.4.0`
42+
`prometheusMetrics.authProxy.image.pullPolicy` | Auth proxy container image pull policy | `IfNotPresent`
43+
`rbac.enabled` | Create rbac service account and roles | `true`
44+
`imagePullSecrets` | Image pull secrets can be set | `[]`
45+
`replicaCount` | Operator replica count can be set | `1`
46+
`alertManager.enable` | AlertManager can be enabled | `true`
47+
`nodeSelector` | Operator pod node selector can be set | `{}`
48+
`tolerations` | Operator pod tolerations can be set | `[]`
49+
`affinity` | Operator pod affinity can be set | `{}`
50+
`nameOverride` | Release name can be overwritten | `""`
51+
`fullnameOverride` | Release full name can be overwritten | `""`

0 commit comments

Comments
 (0)