|
|
@@ -44,49 +44,20 @@ These commands deploy Kafka on the Kubernetes cluster in the default configurati
|
|
|
|
|
|
## Configuration and installation details
|
|
|
|
|
|
-### Resource requests and limits
|
|
|
-
|
|
|
-Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the `resources` value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
|
|
|
-
|
|
|
-To make this process easier, the chart contains the `resourcesPreset` values, which automatically sets the `resources` section according to different presets. Check these presets in [the bitnami/common chart](https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_resources.tpl#L15). However, in production workloads using `resourcesPreset` is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).
|
|
|
-
|
|
|
-### Prometheus metrics
|
|
|
-
|
|
|
-This chart can be integrated with Prometheus by setting `metrics.jmx.enabled` to `true`. This will deploy a sidecar container with [jmx_exporter](https://github.com/prometheus/jmx_exporter) in all pods and a `metrics` service, which can be configured under the `metrics.service` section. This `metrics` service will have the necessary annotations to be automatically scraped by Prometheus.
|
|
|
-
|
|
|
-#### Prometheus requirements
|
|
|
-
|
|
|
-It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the [Bitnami Prometheus helm chart](https://github.com/bitnami/charts/tree/main/bitnami/prometheus) or the [Bitnami Kube Prometheus helm chart](https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus) to easily have a working Prometheus in your cluster.
|
|
|
-
|
|
|
-#### Integration with Prometheus Operator
|
|
|
-
|
|
|
-The chart can deploy `ServiceMonitor` objects for integration with Prometheus Operator installations. To do so, set the value `metrics.serviceMonitor.enabled=true`. Ensure that the Prometheus Operator `CustomResourceDefinitions` are installed in the cluster or it will fail with the following error:
|
|
|
-
|
|
|
-```text
|
|
|
-no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
|
|
|
-```
|
|
|
-
|
|
|
-Install the [Bitnami Kube Prometheus helm chart](https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus) for having the necessary CRDs and the Prometheus Operator.
|
|
|
-
|
|
|
-### [Rolling VS Immutable tags](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-understand-rolling-tags-containers-index.html)
|
|
|
-
|
|
|
-It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
|
|
|
-
|
|
|
-Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
|
|
|
-
|
|
|
### Listeners configuration
|
|
|
|
|
|
-This chart allows you to automatically configure Kafka with 3 listeners:
|
|
|
+This chart allows you to automatically configure Kafka with 4 listeners:
|
|
|
|
|
|
-- One for inter-broker communications.
|
|
|
-- A second one for communications with clients within the K8s cluster.
|
|
|
-- (optional) a third listener for communications with clients outside the K8s cluster. Check [this section](#accessing-kafka-brokers-from-outside-the-cluster) for more information.
|
|
|
+- One for controller communications.
|
|
|
+- A second one for inter-broker communications.
|
|
|
+- A third one for communications with clients within the K8s cluster.
|
|
|
+- (optional) a forth listener for communications with clients outside the K8s cluster. Check [this section](#accessing-kafka-brokers-from-outside-the-cluster) for more information.
|
|
|
|
|
|
For more complex configurations, set the `listeners`, `advertisedListeners` and `listenerSecurityProtocolMap` parameters as needed.
|
|
|
|
|
|
-### Enable security for Kafka and Zookeeper
|
|
|
+### Enable security for Kafka
|
|
|
|
|
|
-You can configure different authentication protocols for each listener you configure in Kafka. For instance, you can use `sasl_tls` authentication for client communications, while using `tls` for inter-broker communications. This table shows the available protocols and the security they provide:
|
|
|
+You can configure different authentication protocols for each listener you configure in Kafka. For instance, you can use `sasl_tls` authentication for client communications, while using `tls` for controller and inter-broker communications. This table shows the available protocols and the security they provide:
|
|
|
|
|
|
| Method | Authentication | Encryption via TLS |
|
|
|
|-----------|------------------------------|--------------------|
|
|
|
@@ -96,19 +67,19 @@ You can configure different authentication protocols for each listener you confi
|
|
|
| sasl | Yes (via SASL) | No |
|
|
|
| sasl_tls | Yes (via SASL) | Yes |
|
|
|
|
|
|
-Configure the authentication protocols for client and inter-broker communications by setting the *auth.clientProtocol* and *auth.interBrokerProtocol* parameters to the desired ones, respectively.
|
|
|
+Configure the authentication protocols for client, controller and inter-broker communications by setting the `listeners.client.protocol`, `listeners.controller.protocol` and `listeners.interbroker.protocol` parameters to the desired ones, respectively.
|
|
|
|
|
|
If you enabled SASL authentication on any listener, you can set the SASL credentials using the parameters below:
|
|
|
|
|
|
-- `auth.sasl.jaas.clientUsers`/`auth.sasl.jaas.clientPasswords`: when enabling SASL authentication for communications with clients.
|
|
|
-- `auth.sasl.jaas.interBrokerUser`/`auth.sasl.jaas.interBrokerPassword`: when enabling SASL authentication for inter-broker communications.
|
|
|
-- `auth.jaas.zookeeperUser`/`auth.jaas.zookeeperPassword`: In the case that the Zookeeper chart is deployed with SASL authentication enabled.
|
|
|
+- `sasl.client.users`/`sasl.client.passwords`: when enabling SASL authentication for communications with clients.
|
|
|
+- `sasl.interbroker.user`/`sasl.interbroker.password`: when enabling SASL authentication for inter-broker communications.
|
|
|
+- `sasl.controller.user`/`sasl.controller.password`: when enabling SASL authentication for controller communications.
|
|
|
|
|
|
-In order to configure TLS authentication/encryption, you **can** create a secret per Kafka broker you have in the cluster containing the Java Key Stores (JKS) files: the truststore (`kafka.truststore.jks`) and the keystore (`kafka.keystore.jks`). Then, you need pass the secret names with the `tls.existingSecret` parameter when deploying the chart.
|
|
|
+In order to configure TLS authentication/encryption, you **can** create a secret per Kafka node you have in the cluster containing the Java Key Stores (JKS) files: the truststore (`kafka.truststore.jks`) and the keystore (`kafka.keystore.jks`). Then, you need pass the secret names with the `tls.existingSecret` parameter when deploying the chart.
|
|
|
|
|
|
-> **Note**: If the JKS files are password protected (recommended), you will need to provide the password to get access to the keystores. To do so, use the `tls.password` parameter to provide your password.
|
|
|
+> **Note**: If the JKS files are password protected (recommended), you will need to provide the password to get access to the keystores. To do so, use the `tls.keystorePassword` and `tls.truststorePassword` parameters to provide your passwords.
|
|
|
|
|
|
-For instance, to configure TLS authentication on a Kafka cluster with 2 Kafka brokers use the commands below to create the secrets:
|
|
|
+For instance, to configure TLS authentication on a Kafka cluster with 2 Kafka nodes use the commands below to create the secrets:
|
|
|
|
|
|
```console
|
|
|
kubectl create secret generic kafka-jks-0 --from-file=kafka.truststore.jks=./kafka.truststore.jks --from-file=kafka.keystore.jks=./kafka-0.keystore.jks
|
|
|
@@ -117,66 +88,37 @@ kubectl create secret generic kafka-jks-1 --from-file=kafka.truststore.jks=./kaf
|
|
|
|
|
|
> **Note**: the command above assumes you already created the truststore and keystores files. This [script](https://raw.githubusercontent.com/confluentinc/confluent-platform-security-tools/master/kafka-generate-ssl.sh) can help you with the JKS files generation.
|
|
|
|
|
|
-If, for some reason (like using Cert-Manager) you can not use the default JKS secret scheme, you can use the additional parameters:
|
|
|
+If, for some reason (like using CertManager) you can not use the default JKS secret scheme, you can use the additional parameters:
|
|
|
|
|
|
-- `tls.jksTruststoreSecret` to define additional secret, where the `kafka.truststore.jks` is being kept. The truststore password **must** be the same as in `tls.password`
|
|
|
-- `tls.jksTruststore` to overwrite the default value of the truststore key (`kafka.truststore.jks`).
|
|
|
+- `tls.jksTruststoreSecret` to define additional secret, where the `kafka.truststore.jks` is being kept. The truststore password **must** be the same as in `tls.truststorePassword`
|
|
|
+- `tls.jksTruststoreKey` to overwrite the default value of the truststore key (`kafka.truststore.jks`).
|
|
|
|
|
|
-> **Note**: If you are using cert-manager, particularly when an ACME issuer is used, the `ca.crt` field is not put in the `Secret` that cert-manager creates. To handle this, the `tls.pemChainIncluded` property can be set to `true` and the initContainer created by this Chart will attempt to extract the intermediate certs from the `tls.crt` field of the secret (which is a PEM chain)
|
|
|
-> **Note**: The truststore/keystore from above **must** be protected with the same password as in `tls.password`
|
|
|
+> **Note**: If you are using CertManager, particularly when an ACME issuer is used, the `ca.crt` field is not put in the `Secret` that CertManager creates. To handle this, the `tls.pemChainIncluded` property can be set to `true` and the initContainer created by this Chart will attempt to extract the intermediate certs from the `tls.crt` field of the secret (which is a PEM chain)
|
|
|
+> **Note**: The truststore/keystore from above **must** be protected with the same passwords set in the `tls.keystorePassword` and `tls.truststorePassword` parameters.
|
|
|
|
|
|
You can deploy the chart with authentication using the following parameters:
|
|
|
|
|
|
```console
|
|
|
replicaCount=2
|
|
|
-listeners.client.client.protocol=SASL
|
|
|
-listeners.client.interbroker.protocol=TLS
|
|
|
+listeners.client.protocol=SASL
|
|
|
+listeners.interbroker.protocol=TLS
|
|
|
tls.existingSecret=kafka-jks
|
|
|
-tls.password=jksPassword
|
|
|
+tls.keystorePassword=jksPassword
|
|
|
+tls.truststorePassword=jksPassword
|
|
|
sasl.client.users[0]=brokerUser
|
|
|
sasl.client.passwords[0]=brokerPassword
|
|
|
-sasl.zookeeper.user=zookeeperUser
|
|
|
-sasl.zookeeper.password=zookeeperPassword
|
|
|
-zookeeper.auth.enabled=true
|
|
|
-zookeeper.auth.serverUsers=zookeeperUser
|
|
|
-zookeeper.auth.serverPasswords=zookeeperPassword
|
|
|
-zookeeper.auth.clientUser=zookeeperUser
|
|
|
-zookeeper.auth.clientPassword=zookeeperPassword
|
|
|
-```
|
|
|
-
|
|
|
-You can deploy the chart with AclAuthorizer using the following parameters:
|
|
|
|
|
|
-```console
|
|
|
-replicaCount=2
|
|
|
-listeners.client.protocol=SASL
|
|
|
-listeners.interbroker.protocol=SASL_TLS
|
|
|
-tls.existingSecret=kafka-jks-0
|
|
|
-tls.password=jksPassword
|
|
|
-sasl.client.users[0]=brokerUser
|
|
|
-sasl.client.passwords[0]=brokerPassword
|
|
|
-sasl.zookeeper.user=zookeeperUser
|
|
|
-sasl.zookeeper.password=zookeeperPassword
|
|
|
-zookeeper.auth.enabled=true
|
|
|
-zookeeper.auth.serverUsers=zookeeperUser
|
|
|
-zookeeper.auth.serverPasswords=zookeeperPassword
|
|
|
-zookeeper.auth.clientUser=zookeeperUser
|
|
|
-zookeeper.auth.clientPassword=zookeeperPassword
|
|
|
-authorizerClassName=kafka.security.authorizer.AclAuthorizer
|
|
|
-allowEveryoneIfNoAclFound=false
|
|
|
-superUsers=User:admin
|
|
|
```
|
|
|
|
|
|
-If you are using Kafka ACLs, you might encounter in kafka-authorizer.log the following event: `[...] Principal = User:ANONYMOUS is Allowed Operation [...]`.
|
|
|
-
|
|
|
By setting the following parameter: `listeners.client.protocol=SSL` and `listener.client.sslClientAuth=required`, Kafka will require the clients to authenticate to Kafka brokers via certificate.
|
|
|
|
|
|
-As result, we will be able to see in kafka-authorizer.log the events specific Subject: `[...] Principal = User:CN=kafka,OU=...,O=...,L=...,C=..,ST=... is [...]`.
|
|
|
+As result, we will be able to see in `kafka-authorizer.log` the events specific Subject: `[...] Principal = User:CN=kafka,OU=...,O=...,L=...,C=..,ST=... is [...]`.
|
|
|
|
|
|
### Update credentials
|
|
|
|
|
|
The Bitnami Kafka chart, when upgrading, reuses the secret previously rendered by the chart or the one specified in `sasl.existingSecret`. To update credentials, use one of the following:
|
|
|
|
|
|
-- Run `helm upgrade` specifying new credentials in the `sasl` section as explained in the [authentication section](#enable-security-for-kafka-and-zookeeper).
|
|
|
+- Run `helm upgrade` specifying new credentials in the `sasl` section as explained in the [authentication section](#enable-security-for-kafka).
|
|
|
- Run `helm upgrade` specifying a new secret in `sasl.existingSecret`
|
|
|
|
|
|
### Accessing Kafka brokers from outside the cluster
|
|
|
@@ -197,7 +139,7 @@ externalAccess.broker.service.type=LoadBalancer
|
|
|
externalAccess.controller.service.type=LoadBalancer
|
|
|
externalAccess.broker.service.ports.external=9094
|
|
|
externalAccess.controller.service.containerPorts.external=9094
|
|
|
-externalAccess.autoDiscovery.enabled=true
|
|
|
+defaultInitContainers.autoDiscovery.enabled=true
|
|
|
serviceAccount.create=true
|
|
|
rbac.create=true
|
|
|
```
|
|
|
@@ -232,7 +174,7 @@ You have two alternatives to use NodePort services:
|
|
|
externalAccess.enabled=true
|
|
|
externalAccess.controller.service.type=NodePort
|
|
|
externalAccess.broker.service.type=NodePort
|
|
|
- externalAccess.autoDiscovery.enabled=true
|
|
|
+ defaultInitContainers.autoDiscovery.enabled=true
|
|
|
serviceAccount.create=true
|
|
|
rbac.create=true
|
|
|
```
|
|
|
@@ -299,28 +241,41 @@ externalAccess:
|
|
|
external-dns.alpha.kubernetes.io/hostname: "{{ .targetPod }}.example.com"
|
|
|
```
|
|
|
|
|
|
+### Resource requests and limits
|
|
|
+
|
|
|
+Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the `resources` values (check parameters table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
|
|
|
+
|
|
|
+To make this process easier, the chart contains the `resourcesPreset` values, which automatically sets the `resources` section according to different presets. Check these presets in [the bitnami/common chart](https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_resources.tpl#L15). However, in production workloads using `resourcesPreset` is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).
|
|
|
+
|
|
|
+### Prometheus metrics
|
|
|
+
|
|
|
### Enable metrics
|
|
|
|
|
|
-The chart can optionally start two metrics exporters:
|
|
|
+This chart can be integrated with Prometheus by setting `metrics.jmx.enabled` to `true`. This will deploy a sidecar container with [jmx_exporter](https://github.com/prometheus/jmx_exporter) in all pods and a `metrics` service, which can be configured under the `metrics.jmx.service` section. This service will have the necessary annotations to be automatically scraped by Prometheus.
|
|
|
|
|
|
-- JMX exporter, to expose JMX metrics. By default, it uses port 5556.
|
|
|
-- Zookeeper exporter, to expose Zookeeper metrics. By default, it uses port 9141.
|
|
|
+#### Prometheus requirements
|
|
|
|
|
|
-To expose JMX metrics to Prometheus, use the parameter below:
|
|
|
+It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the [Bitnami Prometheus helm chart](https://github.com/bitnami/charts/tree/main/bitnami/prometheus) or the [Bitnami Kube Prometheus helm chart](https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus) to easily have a working Prometheus in your cluster.
|
|
|
|
|
|
-```text
|
|
|
-metrics.jmx.enabled: true
|
|
|
-```
|
|
|
+#### Integration with Prometheus Operator
|
|
|
|
|
|
-- To enable Zookeeper chart metrics, use the parameter below:
|
|
|
+The chart can deploy `ServiceMonitor` objects for integration with Prometheus Operator installations. To do so, set the value `metrics.serviceMonitor.enabled=true`. Ensure that the Prometheus Operator `CustomResourceDefinitions` are installed in the cluster or it will fail with the following error:
|
|
|
|
|
|
```text
|
|
|
-zookeeper.metrics.enabled: true
|
|
|
+no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
|
|
|
```
|
|
|
|
|
|
+Install the [Bitnami Kube Prometheus helm chart](https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus) for having the necessary CRDs and the Prometheus Operator.
|
|
|
+
|
|
|
+### [Rolling VS Immutable tags](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-understand-rolling-tags-containers-index.html)
|
|
|
+
|
|
|
+It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
|
|
|
+
|
|
|
+Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
|
|
|
+
|
|
|
### Sidecars
|
|
|
|
|
|
-If you have a need for additional containers to run within the same pod as Kafka (e.g. an additional metrics or logging exporter), you can do so via the `sidecars` config parameter. Simply define your container according to the Kubernetes container spec.
|
|
|
+If you have a need for additional containers to run within the same pod as Kafka (e.g. an additional metrics or logging exporter), you can do so via the `sidecars` parameters. Simply define your container according to the Kubernetes container spec.
|
|
|
|
|
|
```yaml
|
|
|
sidecars:
|
|
|
@@ -343,8 +298,6 @@ As an alternative, you can use of the preset configurations for pod affinity, po
|
|
|
There are cases where you may want to deploy extra objects, such as Kafka Connect. For covering this case, the chart allows adding the full specification of other objects using the `extraDeploy` parameter. The following example would create a deployment including a Kafka Connect deployment so you can connect Kafka with MongoDB®:
|
|
|
|
|
|
```yaml
|
|
|
-## Extra objects to deploy (value evaluated as a template)
|
|
|
-##
|
|
|
extraDeploy:
|
|
|
- |
|
|
|
apiVersion: apps/v1
|
|
|
@@ -418,23 +371,22 @@ RUN mkdir -p /opt/bitnami/kafka/plugins && \
|
|
|
CMD /opt/bitnami/kafka/bin/connect-standalone.sh /opt/bitnami/kafka/config/connect-standalone.properties /opt/bitnami/kafka/config/mongo.properties
|
|
|
```
|
|
|
|
|
|
-### Backup and restore
|
|
|
-
|
|
|
-To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using [Velero](https://velero.io/), a Kubernetes backup/restore tool. Find the instructions for using Velero in [this guide](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-backup-restore-deployments-velero-index.html).
|
|
|
-
|
|
|
-## Persistence
|
|
|
+### Persistence
|
|
|
|
|
|
The [Bitnami Kafka](https://github.com/bitnami/containers/tree/main/bitnami/kafka) image stores the Kafka data at the `/bitnami/kafka` path of the container. Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube.
|
|
|
|
|
|
-### Adjust permissions of persistent volume mountpoint
|
|
|
+#### Adjust permissions of persistent volume mountpoint
|
|
|
|
|
|
As the image run as non-root by default, it is necessary to adjust the ownership of the persistent volume so that the container can write data into it.
|
|
|
|
|
|
-By default, the chart is configured to use Kubernetes Security Context to automatically change the ownership of the volume. However, this feature does not work in all Kubernetes distributions.
|
|
|
-As an alternative, this chart supports using an initContainer to change the ownership of the volume before mounting it in the final destination.
|
|
|
+By default, the chart is configured to use Kubernetes Security Context to automatically change the ownership of the volume. However, this feature does not work in all Kubernetes distributions. As an alternative, this chart supports using an initContainer to change the ownership of the volume before mounting it in the final destination.
|
|
|
|
|
|
You can enable this initContainer by setting `volumePermissions.enabled` to `true`.
|
|
|
|
|
|
+#### Backup and restore
|
|
|
+
|
|
|
+To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using [Velero](https://velero.io/), a Kubernetes backup/restore tool. Find the instructions for using Velero in [this guide](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-backup-restore-deployments-velero-index.html).
|
|
|
+
|
|
|
## Parameters
|
|
|
|
|
|
### Global parameters
|
|
|
@@ -444,7 +396,6 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `global.imageRegistry` | Global Docker image registry | `""` |
|
|
|
| `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` |
|
|
|
| `global.defaultStorageClass` | Global default StorageClass for Persistent Volume(s) | `""` |
|
|
|
-| `global.storageClass` | DEPRECATED: use global.defaultStorageClass instead | `""` |
|
|
|
| `global.security.allowInsecureImages` | Allows skipping image verification | `false` |
|
|
|
| `global.compatibility.openshift.adaptSecurityContext` | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | `auto` |
|
|
|
|
|
|
@@ -456,16 +407,18 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `apiVersions` | Override Kubernetes API versions reported by .Capabilities | `[]` |
|
|
|
| `nameOverride` | String to partially override common.names.fullname | `""` |
|
|
|
| `fullnameOverride` | String to fully override common.names.fullname | `""` |
|
|
|
+| `namespaceOverride` | String to fully override common.names.namespace | `""` |
|
|
|
| `clusterDomain` | Default Kubernetes cluster domain | `cluster.local` |
|
|
|
| `commonLabels` | Labels to add to all deployed objects | `{}` |
|
|
|
| `commonAnnotations` | Annotations to add to all deployed objects | `{}` |
|
|
|
| `extraDeploy` | Array of extra objects to deploy with the release | `[]` |
|
|
|
-| `serviceBindings.enabled` | Create secret for service binding (Experimental) | `false` |
|
|
|
+| `usePasswordFiles` | Mount credentials as files instead of using environment variables | `true` |
|
|
|
| `diagnosticMode.enabled` | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | `false` |
|
|
|
-| `diagnosticMode.command` | Command to override all containers in the statefulset | `["sleep"]` |
|
|
|
-| `diagnosticMode.args` | Args to override all containers in the statefulset | `["infinity"]` |
|
|
|
+| `diagnosticMode.command` | Command to override all containers in the chart release | `["sleep"]` |
|
|
|
+| `diagnosticMode.args` | Args to override all containers in the chart release | `["infinity"]` |
|
|
|
+| `serviceBindings.enabled` | Create secret for service binding (Experimental) | `false` |
|
|
|
|
|
|
-### Kafka parameters
|
|
|
+### Kafka common parameters
|
|
|
|
|
|
| Name | Description | Value |
|
|
|
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
|
@@ -475,18 +428,19 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `image.pullPolicy` | Kafka image pull policy | `IfNotPresent` |
|
|
|
| `image.pullSecrets` | Specify docker-registry secret names as an array | `[]` |
|
|
|
| `image.debug` | Specify if debug values should be set | `false` |
|
|
|
-| `extraInit` | Additional content for the kafka init script, rendered as a template. | `""` |
|
|
|
-| `config` | Configuration file for Kafka, rendered as a template. Auto-generated based on chart values when not specified. | `""` |
|
|
|
-| `existingConfigmap` | ConfigMap with Kafka Configuration | `""` |
|
|
|
-| `extraConfig` | Additional configuration to be appended at the end of the generated Kafka configuration file. | `""` |
|
|
|
-| `extraConfigYaml` | Additional configuration in yaml format to be appended at the end of the generated Kafka configuration file. | `{}` |
|
|
|
-| `secretConfig` | Additional configuration to be appended at the end of the generated Kafka configuration file. | `""` |
|
|
|
-| `existingSecretConfig` | Secret with additonal configuration that will be appended to the end of the generated Kafka configuration file | `""` |
|
|
|
-| `log4j` | An optional log4j.properties file to overwrite the default of the Kafka brokers | `""` |
|
|
|
-| `existingLog4jConfigMap` | The name of an existing ConfigMap containing a log4j.properties file | `""` |
|
|
|
+| `clusterId` | Kafka Kraft cluster ID (ignored if existingKraftSecret is set). A random cluster ID will be generated the 1st time Kraft is initialized if not set. | `""` |
|
|
|
+| `existingKraftSecret` | Name of the secret containing the Kafka KRaft Cluster ID and one directory ID per controller replica | `""` |
|
|
|
+| `config` | Specify content for Kafka configuration (auto-generated based on other parameters otherwise) | `{}` |
|
|
|
+| `overrideConfiguration` | Kafka common configuration override. Values defined here takes precedence over the ones defined at `config` | `{}` |
|
|
|
+| `existingConfigmap` | Name of an existing ConfigMap with the Kafka configuration | `""` |
|
|
|
+| `secretConfig` | Additional configuration to be appended at the end of the generated Kafka configuration (store in a secret) | `""` |
|
|
|
+| `existingSecretConfig` | Secret with additional configuration that will be appended to the end of the generated Kafka configuration | `""` |
|
|
|
+| `log4j2` | Specify content for Kafka log4j2 configuration (default one is used otherwise) | `""` |
|
|
|
+| `existingLog4j2ConfigMap` | The name of an existing ConfigMap containing the log4j2.yaml file | `""` |
|
|
|
| `heapOpts` | Kafka Java Heap configuration | `-XX:InitialRAMPercentage=75 -XX:MaxRAMPercentage=75` |
|
|
|
-| `brokerRackAssignment` | Set Broker Assignment for multi tenant environment Allowed values: `aws-az`, `azure` | `""` |
|
|
|
-| `brokerRackAssignmentApiVersion` | Set Broker Assignment API version when brokerRackAssignment set to : `azure` | `2023-11-15` |
|
|
|
+| `brokerRackAwareness.enabled` | Enable Kafka Rack Awareness | `false` |
|
|
|
+| `brokerRackAwareness.cloudProvider` | Cloud provider to use to set Broker Rack Awareness. Allowed values: `aws-az`, `azure` | `""` |
|
|
|
+| `brokerRackAwareness.azureApiVersion` | Metadata API version to use when brokerRackAwareness.cloudProvider is set to `azure` | `2023-11-15` |
|
|
|
| `interBrokerProtocolVersion` | Override the setting 'inter.broker.protocol.version' during the ZK migration. | `""` |
|
|
|
| `listeners.client.name` | Name for the Kafka client listener | `CLIENT` |
|
|
|
| `listeners.client.containerPort` | Port for the Kafka client listener | `9092` |
|
|
|
@@ -530,50 +484,94 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `sasl.controller.clientSecret` | Client Secret for controller communications when SASL is enabled with mechanism OAUTHBEARER. If not set and SASL is enabled for the inter-broker listener, a random secret will be generated. | `""` |
|
|
|
| `sasl.client.users` | Comma-separated list of usernames for client communications when SASL is enabled | `["user1"]` |
|
|
|
| `sasl.client.passwords` | Comma-separated list of passwords for client communications when SASL is enabled, must match the number of client.users | `""` |
|
|
|
-| `sasl.zookeeper.user` | Username for zookeeper communications when SASL is enabled. | `""` |
|
|
|
-| `sasl.zookeeper.password` | Password for zookeeper communications when SASL is enabled. | `""` |
|
|
|
-| `sasl.existingSecret` | Name of the existing secret containing credentials for clientUsers, interBrokerUser, controllerUser and zookeeperUser | `""` |
|
|
|
+| `sasl.existingSecret` | Name of the existing secret containing credentials for client.users, interbroker.user and controller.user | `""` |
|
|
|
|
|
|
### Kafka TLS parameters
|
|
|
|
|
|
-| Name | Description | Value |
|
|
|
-| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
|
-| `tls.type` | Format to use for TLS certificates. Allowed types: `JKS` and `PEM` | `JKS` |
|
|
|
-| `tls.pemChainIncluded` | Flag to denote that the Certificate Authority (CA) certificates are bundled with the endpoint cert. | `false` |
|
|
|
-| `tls.existingSecret` | Name of the existing secret containing the TLS certificates for the Kafka nodes. | `""` |
|
|
|
-| `tls.autoGenerated` | Generate automatically self-signed TLS certificates for Kafka brokers. Currently only supported if `tls.type` is `PEM` | `false` |
|
|
|
-| `tls.customAltNames` | Optionally specify extra list of additional subject alternative names (SANs) for the automatically generated TLS certificates. | `[]` |
|
|
|
-| `tls.passwordsSecret` | Name of the secret containing the password to access the JKS files or PEM key when they are password-protected. (`key`: `password`) | `""` |
|
|
|
-| `tls.passwordsSecretKeystoreKey` | The secret key from the tls.passwordsSecret containing the password for the Keystore. | `keystore-password` |
|
|
|
-| `tls.passwordsSecretTruststoreKey` | The secret key from the tls.passwordsSecret containing the password for the Truststore. | `truststore-password` |
|
|
|
-| `tls.passwordsSecretPemPasswordKey` | The secret key from the tls.passwordsSecret containing the password for the PEM key inside 'tls.passwordsSecret'. | `""` |
|
|
|
-| `tls.keystorePassword` | Password to access the JKS keystore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided. | `""` |
|
|
|
-| `tls.truststorePassword` | Password to access the JKS truststore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided. | `""` |
|
|
|
-| `tls.keyPassword` | Password to access the PEM key when it is password-protected. | `""` |
|
|
|
-| `tls.jksKeystoreKey` | The secret key from the `tls.existingSecret` containing the keystore | `""` |
|
|
|
-| `tls.jksTruststoreSecret` | Name of the existing secret containing your truststore if truststore not existing or different from the one in the `tls.existingSecret` | `""` |
|
|
|
-| `tls.jksTruststoreKey` | The secret key from the `tls.existingSecret` or `tls.jksTruststoreSecret` containing the truststore | `""` |
|
|
|
-| `tls.endpointIdentificationAlgorithm` | The endpoint identification algorithm to validate server hostname using server certificate | `https` |
|
|
|
-| `tls.sslClientAuth` | Sets the default value for the ssl.client.auth Kafka setting. | `required` |
|
|
|
-| `tls.zookeeper.enabled` | Enable TLS for Zookeeper client connections. | `false` |
|
|
|
-| `tls.zookeeper.verifyHostname` | Hostname validation. | `true` |
|
|
|
-| `tls.zookeeper.existingSecret` | Name of the existing secret containing the TLS certificates for ZooKeeper client communications. | `""` |
|
|
|
-| `tls.zookeeper.existingSecretKeystoreKey` | The secret key from the tls.zookeeper.existingSecret containing the Keystore. | `zookeeper.keystore.jks` |
|
|
|
-| `tls.zookeeper.existingSecretTruststoreKey` | The secret key from the tls.zookeeper.existingSecret containing the Truststore. | `zookeeper.truststore.jks` |
|
|
|
-| `tls.zookeeper.passwordsSecret` | Existing secret containing Keystore and Truststore passwords. | `""` |
|
|
|
-| `tls.zookeeper.passwordsSecretKeystoreKey` | The secret key from the tls.zookeeper.passwordsSecret containing the password for the Keystore. | `keystore-password` |
|
|
|
-| `tls.zookeeper.passwordsSecretTruststoreKey` | The secret key from the tls.zookeeper.passwordsSecret containing the password for the Truststore. | `truststore-password` |
|
|
|
-| `tls.zookeeper.keystorePassword` | Password to access the JKS keystore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided. | `""` |
|
|
|
-| `tls.zookeeper.truststorePassword` | Password to access the JKS truststore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided. | `""` |
|
|
|
-| `extraEnvVars` | Extra environment variables to add to Kafka pods | `[]` |
|
|
|
-| `extraEnvVarsCM` | ConfigMap with extra environment variables | `""` |
|
|
|
-| `extraEnvVarsSecret` | Secret with extra environment variables | `""` |
|
|
|
-| `extraVolumes` | Optionally specify extra list of additional volumes for the Kafka pod(s) | `[]` |
|
|
|
-| `extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for the Kafka container(s) | `[]` |
|
|
|
-| `sidecars` | Add additional sidecar containers to the Kafka pod(s) | `[]` |
|
|
|
-| `initContainers` | Add additional Add init containers to the Kafka pod(s) | `[]` |
|
|
|
-| `dnsPolicy` | Specifies the DNS policy for the zookeeper pods | `""` |
|
|
|
-| `dnsConfig` | allows users more control on the DNS settings for a Pod. Required if `dnsPolicy` is set to `None` | `{}` |
|
|
|
+| Name | Description | Value |
|
|
|
+| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
|
+| `tls.type` | Format to use for TLS certificates. Allowed types: `JKS` and `PEM` | `JKS` |
|
|
|
+| `tls.pemChainIncluded` | Flag to denote that the Certificate Authority (CA) certificates are bundled with the endpoint cert. | `false` |
|
|
|
+| `tls.autoGenerated.enabled` | Enable automatic generation of TLS certificates (only supported if `tls.type` is `PEM`) | `true` |
|
|
|
+| `tls.autoGenerated.engine` | Mechanism to generate the certificates (allowed values: helm, cert-manager) | `helm` |
|
|
|
+| `tls.autoGenerated.customAltNames` | List of additional subject alternative names (SANs) for the automatically generated TLS certificates. | `[]` |
|
|
|
+| `tls.autoGenerated.certManager.existingIssuer` | The name of an existing Issuer to use for generating the certificates (only for `cert-manager` engine) | `""` |
|
|
|
+| `tls.autoGenerated.certManager.existingIssuerKind` | Existing Issuer kind, defaults to Issuer (only for `cert-manager` engine) | `""` |
|
|
|
+| `tls.autoGenerated.certManager.keyAlgorithm` | Key algorithm for the certificates (only for `cert-manager` engine) | `RSA` |
|
|
|
+| `tls.autoGenerated.certManager.keySize` | Key size for the certificates (only for `cert-manager` engine) | `2048` |
|
|
|
+| `tls.autoGenerated.certManager.duration` | Duration for the certificates (only for `cert-manager` engine) | `2160h` |
|
|
|
+| `tls.autoGenerated.certManager.renewBefore` | Renewal period for the certificates (only for `cert-manager` engine) | `360h` |
|
|
|
+| `tls.existingSecret` | Name of the existing secret containing the TLS certificates for the Kafka nodes. | `""` |
|
|
|
+| `tls.passwordsSecret` | Name of the secret containing the password to access the JKS files or PEM key when they are password-protected. (`key`: `password`) | `""` |
|
|
|
+| `tls.passwordsSecretKeystoreKey` | The secret key from the tls.passwordsSecret containing the password for the Keystore. | `keystore-password` |
|
|
|
+| `tls.passwordsSecretTruststoreKey` | The secret key from the tls.passwordsSecret containing the password for the Truststore. | `truststore-password` |
|
|
|
+| `tls.passwordsSecretPemPasswordKey` | The secret key from the tls.passwordsSecret containing the password for the PEM key inside 'tls.passwordsSecret'. | `""` |
|
|
|
+| `tls.keystorePassword` | Password to access the JKS keystore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided. | `""` |
|
|
|
+| `tls.truststorePassword` | Password to access the JKS truststore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided. | `""` |
|
|
|
+| `tls.keyPassword` | Password to access the PEM key when it is password-protected. | `""` |
|
|
|
+| `tls.jksKeystoreKey` | The secret key from the `tls.existingSecret` containing the keystore | `""` |
|
|
|
+| `tls.jksTruststoreSecret` | Name of the existing secret containing your truststore if truststore not existing or different from the one in the `tls.existingSecret` | `""` |
|
|
|
+| `tls.jksTruststoreKey` | The secret key from the `tls.existingSecret` or `tls.jksTruststoreSecret` containing the truststore | `""` |
|
|
|
+| `tls.endpointIdentificationAlgorithm` | The endpoint identification algorithm to validate server hostname using server certificate | `https` |
|
|
|
+| `tls.sslClientAuth` | Sets the default value for the ssl.client.auth Kafka setting. | `required` |
|
|
|
+| `extraEnvVars` | Extra environment variables to add to Kafka pods | `[]` |
|
|
|
+| `extraEnvVarsCM` | ConfigMap with extra environment variables | `""` |
|
|
|
+| `extraEnvVarsSecret` | Secret with extra environment variables | `""` |
|
|
|
+| `extraVolumes` | Optionally specify extra list of additional volumes for the Kafka pod(s) | `[]` |
|
|
|
+| `extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for the Kafka container(s) | `[]` |
|
|
|
+| `sidecars` | Add additional sidecar containers to the Kafka pod(s) | `[]` |
|
|
|
+| `initContainers` | Add additional Add init containers to the Kafka pod(s) | `[]` |
|
|
|
+| `dnsPolicy` | Specifies the DNS policy for the Kafka pods | `""` |
|
|
|
+| `dnsConfig` | allows users more control on the DNS settings for a Pod. Required if `dnsPolicy` is set to `None` | `{}` |
|
|
|
+| `defaultInitContainers.volumePermissions.enabled` | Enable init container that changes the owner and group of the persistent volume | `false` |
|
|
|
+| `defaultInitContainers.volumePermissions.image.registry` | "volume-permissions" init-containers' image registry | `REGISTRY_NAME` |
|
|
|
+| `defaultInitContainers.volumePermissions.image.repository` | "volume-permissions" init-containers' image repository | `REPOSITORY_NAME/os-shell` |
|
|
|
+| `defaultInitContainers.volumePermissions.image.digest` | "volume-permissions" init-containers' image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
|
|
|
+| `defaultInitContainers.volumePermissions.image.pullPolicy` | "volume-permissions" init-containers' image pull policy | `IfNotPresent` |
|
|
|
+| `defaultInitContainers.volumePermissions.image.pullSecrets` | "volume-permissions" init-containers' image pull secrets | `[]` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.enabled` | Enabled "volume-permissions" init-containers' Security Context | `true` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.seLinuxOptions` | Set SELinux options in "volume-permissions" init-containers | `{}` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.runAsUser` | Set runAsUser in "volume-permissions" init-containers' Security Context | `0` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.privileged` | Set privileged in "volume-permissions" init-containers' Security Context | `false` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.allowPrivilegeEscalation` | Set allowPrivilegeEscalation in "volume-permissions" init-containers' Security Context | `false` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.capabilities.add` | List of capabilities to be added in "volume-permissions" init-containers | `[]` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.capabilities.drop` | List of capabilities to be dropped in "volume-permissions" init-containers | `["ALL"]` |
|
|
|
+| `defaultInitContainers.volumePermissions.containerSecurityContext.seccompProfile.type` | Set seccomp profile in "volume-permissions" init-containers | `RuntimeDefault` |
|
|
|
+| `defaultInitContainers.volumePermissions.resourcesPreset` | Set Kafka "volume-permissions" init container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if defaultInitContainers.volumePermissions.resources is set (defaultInitContainers.volumePermissions.resources is recommended for production). | `nano` |
|
|
|
+| `defaultInitContainers.volumePermissions.resources` | Set Kafka "volume-permissions" init container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.enabled` | Enabled "prepare-config" init-containers' Security Context | `true` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.seLinuxOptions` | Set SELinux options in "prepare-config" init-containers | `{}` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.runAsUser` | Set runAsUser in "prepare-config" init-containers' Security Context | `1001` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.runAsGroup` | Set runAsUser in "prepare-config" init-containers' Security Context | `1001` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.runAsNonRoot` | Set runAsNonRoot in "prepare-config" init-containers' Security Context | `true` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.readOnlyRootFilesystem` | Set readOnlyRootFilesystem in "prepare-config" init-containers' Security Context | `true` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.privileged` | Set privileged in "prepare-config" init-containers' Security Context | `false` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.allowPrivilegeEscalation` | Set allowPrivilegeEscalation in "prepare-config" init-containers' Security Context | `false` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.capabilities.add` | List of capabilities to be added in "prepare-config" init-containers | `[]` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.capabilities.drop` | List of capabilities to be dropped in "prepare-config" init-containers | `["ALL"]` |
|
|
|
+| `defaultInitContainers.prepareConfig.containerSecurityContext.seccompProfile.type` | Set seccomp profile in "prepare-config" init-containers | `RuntimeDefault` |
|
|
|
+| `defaultInitContainers.prepareConfig.resourcesPreset` | Set Kafka "prepare-config" init container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if defaultInitContainers.prepareConfig.resources is set (defaultInitContainers.prepareConfig.resources is recommended for production). | `nano` |
|
|
|
+| `defaultInitContainers.prepareConfig.resources` | Set Kafka "prepare-config" init container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
+| `defaultInitContainers.prepareConfig.extraInit` | Additional content for the "prepare-config" init script, rendered as a template. | `""` |
|
|
|
+| `defaultInitContainers.autoDiscovery.enabled` | Enable init container that auto-detects external IPs/ports by querying the K8s API | `false` |
|
|
|
+| `defaultInitContainers.autoDiscovery.image.registry` | "auto-discovery" init-containers' image registry | `REGISTRY_NAME` |
|
|
|
+| `defaultInitContainers.autoDiscovery.image.repository` | "auto-discovery" init-containers' image repository | `REPOSITORY_NAME/os-shell` |
|
|
|
+| `defaultInitContainers.autoDiscovery.image.digest` | "auto-discovery" init-containers' image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
|
|
|
+| `defaultInitContainers.autoDiscovery.image.pullPolicy` | "auto-discovery" init-containers' image pull policy | `IfNotPresent` |
|
|
|
+| `defaultInitContainers.autoDiscovery.image.pullSecrets` | "auto-discovery" init-containers' image pull secrets | `[]` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.enabled` | Enabled "auto-discovery" init-containers' Security Context | `true` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.seLinuxOptions` | Set SELinux options in "auto-discovery" init-containers | `{}` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.runAsUser` | Set runAsUser in "auto-discovery" init-containers' Security Context | `1001` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.runAsGroup` | Set runAsUser in "auto-discovery" init-containers' Security Context | `1001` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.runAsNonRoot` | Set runAsNonRoot in "auto-discovery" init-containers' Security Context | `true` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.readOnlyRootFilesystem` | Set readOnlyRootFilesystem in "auto-discovery" init-containers' Security Context | `true` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.privileged` | Set privileged in "auto-discovery" init-containers' Security Context | `false` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.allowPrivilegeEscalation` | Set allowPrivilegeEscalation in "auto-discovery" init-containers' Security Context | `false` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.capabilities.add` | List of capabilities to be added in "auto-discovery" init-containers | `[]` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.capabilities.drop` | List of capabilities to be dropped in "auto-discovery" init-containers | `["ALL"]` |
|
|
|
+| `defaultInitContainers.autoDiscovery.containerSecurityContext.seccompProfile.type` | Set seccomp profile in "auto-discovery" init-containers | `RuntimeDefault` |
|
|
|
+| `defaultInitContainers.autoDiscovery.resourcesPreset` | Set Kafka "auto-discovery" init container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if defaultInitContainers.autoDiscovery.resources is set (defaultInitContainers.autoDiscovery.resources is recommended for production). | `nano` |
|
|
|
+| `defaultInitContainers.autoDiscovery.resources` | Set Kafka "auto-discovery" init container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
|
|
|
### Controller-eligible statefulset parameters
|
|
|
|
|
|
@@ -581,14 +579,13 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
|
|
|
| `controller.replicaCount` | Number of Kafka controller-eligible nodes | `3` |
|
|
|
| `controller.controllerOnly` | If set to true, controller nodes will be deployed as dedicated controllers, instead of controller+broker processes. | `false` |
|
|
|
+| `controller.quorumBootstrapServers` | Override the Kafka controller quorum bootstrap servers of the Kafka Kraft cluster. If not set, it will be automatically configured to use all controller-eligible nodes. | `""` |
|
|
|
| `controller.minId` | Minimal node.id values for controller-eligible nodes. Do not change after first initialization. | `0` |
|
|
|
-| `controller.zookeeperMigrationMode` | Set to true to deploy cluster controller quorum | `false` |
|
|
|
-| `controller.config` | Configuration file for Kafka controller-eligible nodes, rendered as a template. Auto-generated based on chart values when not specified. | `""` |
|
|
|
-| `controller.existingConfigmap` | ConfigMap with Kafka Configuration for controller-eligible nodes. | `""` |
|
|
|
-| `controller.extraConfig` | Additional configuration to be appended at the end of the generated Kafka controller-eligible nodes configuration file. | `""` |
|
|
|
-| `controller.extraConfigYaml` | Additional configuration in yaml format to be appended at the end of the generated Kafka controller-eligible nodes configuration file. | `{}` |
|
|
|
-| `controller.secretConfig` | Additional configuration to be appended at the end of the generated Kafka controller-eligible nodes configuration file. | `""` |
|
|
|
-| `controller.existingSecretConfig` | Secret with additonal configuration that will be appended to the end of the generated Kafka controller-eligible nodes configuration file | `""` |
|
|
|
+| `controller.config` | Specify content for Kafka configuration for Kafka controller-eligible nodes (auto-generated based on other parameters otherwise) | `{}` |
|
|
|
+| `controller.overrideConfiguration` | Kafka configuration override for Kafka controller-eligible nodes. Values defined here takes precedence over the ones defined at `controller.config` | `{}` |
|
|
|
+| `controller.existingConfigmap` | Name of an existing ConfigMap with the Kafka configuration for Kafka controller-eligible nodes | `""` |
|
|
|
+| `controller.secretConfig` | Additional configuration to be appended at the end of the generated Kafka configuration for Kafka controller-eligible nodes (store in a secret) | `""` |
|
|
|
+| `controller.existingSecretConfig` | Secret with additional configuration that will be appended to the end of the generated Kafka configuration for Kafka controller-eligible nodes | `""` |
|
|
|
| `controller.heapOpts` | Kafka Java Heap size for controller-eligible nodes | `-Xmx1024m -Xms1024m` |
|
|
|
| `controller.command` | Override Kafka container command | `[]` |
|
|
|
| `controller.args` | Override Kafka container arguments | `[]` |
|
|
|
@@ -618,8 +615,6 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `controller.customReadinessProbe` | Custom readinessProbe that overrides the default one | `{}` |
|
|
|
| `controller.customStartupProbe` | Custom startupProbe that overrides the default one | `{}` |
|
|
|
| `controller.lifecycleHooks` | lifecycleHooks for the Kafka container to automate configuration before or after startup | `{}` |
|
|
|
-| `controller.initContainerResources.limits` | The resources limits for the init container | `{}` |
|
|
|
-| `controller.initContainerResources.requests` | The requested resources for the init container | `{}` |
|
|
|
| `controller.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if controller.resources is set (controller.resources is recommended for production). | `small` |
|
|
|
| `controller.resources` | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
| `controller.podSecurityContext.enabled` | Enable security context for the pods | `true` |
|
|
|
@@ -676,6 +671,7 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `controller.autoscaling.vpa.minAllowed` | VPA Min allowed resources for the pod | `{}` |
|
|
|
| `controller.autoscaling.vpa.updatePolicy.updateMode` | Autoscaling update policy Specifies whether recommended updates are applied when a Pod is started and whether recommended updates are applied during the life of a Pod | `Auto` |
|
|
|
| `controller.autoscaling.hpa.enabled` | Enable HPA for Kafka Controller | `false` |
|
|
|
+| `controller.autoscaling.hpa.annotations` | Annotations for HPA resource | `{}` |
|
|
|
| `controller.autoscaling.hpa.minReplicas` | Minimum number of Kafka Controller replicas | `""` |
|
|
|
| `controller.autoscaling.hpa.maxReplicas` | Maximum number of Kafka Controller replicas | `""` |
|
|
|
| `controller.autoscaling.hpa.targetCPU` | Target CPU utilization percentage | `""` |
|
|
|
@@ -683,7 +679,7 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `controller.pdb.create` | Deploy a pdb object for the Kafka pod | `true` |
|
|
|
| `controller.pdb.minAvailable` | Minimum number/percentage of available Kafka replicas | `""` |
|
|
|
| `controller.pdb.maxUnavailable` | Maximum number/percentage of unavailable Kafka replicas | `""` |
|
|
|
-| `controller.persistence.enabled` | Enable Kafka data persistence using PVC, note that ZooKeeper persistence is unaffected | `true` |
|
|
|
+| `controller.persistence.enabled` | Enable Kafka data persistence using PVC | `true` |
|
|
|
| `controller.persistence.existingClaim` | A manually managed Persistent Volume and Claim | `""` |
|
|
|
| `controller.persistence.storageClass` | PVC Storage Class for Kafka data volume | `""` |
|
|
|
| `controller.persistence.accessModes` | Persistent Volume Access Modes | `["ReadWriteOnce"]` |
|
|
|
@@ -692,7 +688,7 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `controller.persistence.labels` | Labels for the PVC | `{}` |
|
|
|
| `controller.persistence.selector` | Selector to match an existing Persistent Volume for Kafka data PVC. If set, the PVC can't have a PV dynamically provisioned for it | `{}` |
|
|
|
| `controller.persistence.mountPath` | Mount path of the Kafka data volume | `/bitnami/kafka` |
|
|
|
-| `controller.logPersistence.enabled` | Enable Kafka logs persistence using PVC, note that ZooKeeper persistence is unaffected | `false` |
|
|
|
+| `controller.logPersistence.enabled` | Enable Kafka logs persistence using PVC | `false` |
|
|
|
| `controller.logPersistence.existingClaim` | A manually managed Persistent Volume and Claim | `""` |
|
|
|
| `controller.logPersistence.storageClass` | PVC Storage Class for Kafka logs volume | `""` |
|
|
|
| `controller.logPersistence.accessModes` | Persistent Volume Access Modes | `["ReadWriteOnce"]` |
|
|
|
@@ -707,13 +703,11 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
|
|
|
| `broker.replicaCount` | Number of Kafka broker-only nodes | `0` |
|
|
|
| `broker.minId` | Minimal node.id values for broker-only nodes. Do not change after first initialization. | `100` |
|
|
|
-| `broker.zookeeperMigrationMode` | Set to true to deploy cluster controller quorum | `false` |
|
|
|
-| `broker.config` | Configuration file for Kafka broker-only nodes, rendered as a template. Auto-generated based on chart values when not specified. | `""` |
|
|
|
-| `broker.existingConfigmap` | ConfigMap with Kafka Configuration for broker-only nodes. | `""` |
|
|
|
-| `broker.extraConfig` | Additional configuration to be appended at the end of the generated Kafka broker-only nodes configuration file. | `""` |
|
|
|
-| `broker.extraConfigYaml` | Additional configuration in yaml format to be appended at the end of the generated Kafka broker-only nodes configuration file. | `{}` |
|
|
|
-| `broker.secretConfig` | Additional configuration to be appended at the end of the generated Kafka broker-only nodes configuration file. | `""` |
|
|
|
-| `broker.existingSecretConfig` | Secret with additonal configuration that will be appended to the end of the generated Kafka broker-only nodes configuration file | `""` |
|
|
|
+| `broker.config` | Specify content for Kafka configuration for Kafka broker-only nodes (auto-generated based on other parameters otherwise) | `{}` |
|
|
|
+| `broker.overrideConfiguration` | Kafka configuration override for Kafka broker-only nodes. Values defined here takes precedence over the ones defined at `broker.config` | `{}` |
|
|
|
+| `broker.existingConfigmap` | Name of an existing ConfigMap with the Kafka configuration for Kafka broker-only nodes | `""` |
|
|
|
+| `broker.secretConfig` | Additional configuration to be appended at the end of the generated Kafka configuration for Kafka broker-only nodes (store in a secret) | `""` |
|
|
|
+| `broker.existingSecretConfig` | Secret with additional configuration that will be appended to the end of the generated Kafka configuration for Kafka broker-only nodes | `""` |
|
|
|
| `broker.heapOpts` | Kafka Java Heap size for broker-only nodes | `-Xmx1024m -Xms1024m` |
|
|
|
| `broker.command` | Override Kafka container command | `[]` |
|
|
|
| `broker.args` | Override Kafka container arguments | `[]` |
|
|
|
@@ -743,8 +737,6 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `broker.customReadinessProbe` | Custom readinessProbe that overrides the default one | `{}` |
|
|
|
| `broker.customStartupProbe` | Custom startupProbe that overrides the default one | `{}` |
|
|
|
| `broker.lifecycleHooks` | lifecycleHooks for the Kafka container to automate configuration before or after startup | `{}` |
|
|
|
-| `broker.initContainerResources.limits` | The resources limits for the container | `{}` |
|
|
|
-| `broker.initContainerResources.requests` | The requested resources for the container | `{}` |
|
|
|
| `broker.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if broker.resources is set (broker.resources is recommended for production). | `small` |
|
|
|
| `broker.resources` | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
| `broker.podSecurityContext.enabled` | Enable security context for the pods | `true` |
|
|
|
@@ -803,11 +795,12 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `broker.autoscaling.vpa.minAllowed` | VPA Min allowed resources for the pod | `{}` |
|
|
|
| `broker.autoscaling.vpa.updatePolicy.updateMode` | Autoscaling update policy Specifies whether recommended updates are applied when a Pod is started and whether recommended updates are applied during the life of a Pod | `Auto` |
|
|
|
| `broker.autoscaling.hpa.enabled` | Enable HPA for Kafka Broker | `false` |
|
|
|
+| `broker.autoscaling.hpa.annotations` | Annotations for HPA resource | `{}` |
|
|
|
| `broker.autoscaling.hpa.minReplicas` | Minimum number of Kafka Broker replicas | `""` |
|
|
|
| `broker.autoscaling.hpa.maxReplicas` | Maximum number of Kafka Broker replicas | `""` |
|
|
|
| `broker.autoscaling.hpa.targetCPU` | Target CPU utilization percentage | `""` |
|
|
|
| `broker.autoscaling.hpa.targetMemory` | Target Memory utilization percentage | `""` |
|
|
|
-| `broker.persistence.enabled` | Enable Kafka data persistence using PVC, note that ZooKeeper persistence is unaffected | `true` |
|
|
|
+| `broker.persistence.enabled` | Enable Kafka data persistence using PVC | `true` |
|
|
|
| `broker.persistence.existingClaim` | A manually managed Persistent Volume and Claim | `""` |
|
|
|
| `broker.persistence.storageClass` | PVC Storage Class for Kafka data volume | `""` |
|
|
|
| `broker.persistence.accessModes` | Persistent Volume Access Modes | `["ReadWriteOnce"]` |
|
|
|
@@ -816,7 +809,7 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `broker.persistence.labels` | Labels for the PVC | `{}` |
|
|
|
| `broker.persistence.selector` | Selector to match an existing Persistent Volume for Kafka data PVC. If set, the PVC can't have a PV dynamically provisioned for it | `{}` |
|
|
|
| `broker.persistence.mountPath` | Mount path of the Kafka data volume | `/bitnami/kafka` |
|
|
|
-| `broker.logPersistence.enabled` | Enable Kafka logs persistence using PVC, note that ZooKeeper persistence is unaffected | `false` |
|
|
|
+| `broker.logPersistence.enabled` | Enable Kafka logs persistence using PVC | `false` |
|
|
|
| `broker.logPersistence.existingClaim` | A manually managed Persistent Volume and Claim | `""` |
|
|
|
| `broker.logPersistence.storageClass` | PVC Storage Class for Kafka logs volume | `""` |
|
|
|
| `broker.logPersistence.accessModes` | Persistent Volume Access Modes | `["ReadWriteOnce"]` |
|
|
|
@@ -827,112 +820,80 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
|
|
|
### Traffic Exposure parameters
|
|
|
|
|
|
-| Name | Description | Value |
|
|
|
-| -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
|
|
|
-| `service.type` | Kubernetes Service type | `ClusterIP` |
|
|
|
-| `service.ports.client` | Kafka svc port for client connections | `9092` |
|
|
|
-| `service.ports.controller` | Kafka svc port for controller connections. It is used if "kraft.enabled: true" | `9093` |
|
|
|
-| `service.ports.interbroker` | Kafka svc port for inter-broker connections | `9094` |
|
|
|
-| `service.ports.external` | Kafka svc port for external connections | `9095` |
|
|
|
-| `service.extraPorts` | Extra ports to expose in the Kafka service (normally used with the `sidecar` value) | `[]` |
|
|
|
-| `service.nodePorts.client` | Node port for the Kafka client connections | `""` |
|
|
|
-| `service.nodePorts.external` | Node port for the Kafka external connections | `""` |
|
|
|
-| `service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` |
|
|
|
-| `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` |
|
|
|
-| `service.clusterIP` | Kafka service Cluster IP | `""` |
|
|
|
-| `service.loadBalancerIP` | Kafka service Load Balancer IP | `""` |
|
|
|
-| `service.loadBalancerClass` | Kafka service Load Balancer Class | `""` |
|
|
|
-| `service.loadBalancerSourceRanges` | Kafka service Load Balancer sources | `[]` |
|
|
|
-| `service.allocateLoadBalancerNodePorts` | Whether to allocate node ports when service type is LoadBalancer | `true` |
|
|
|
-| `service.externalTrafficPolicy` | Kafka service external traffic policy | `Cluster` |
|
|
|
-| `service.annotations` | Additional custom annotations for Kafka service | `{}` |
|
|
|
-| `service.headless.controller.annotations` | Annotations for the controller-eligible headless service. | `{}` |
|
|
|
-| `service.headless.controller.labels` | Labels for the controller-eligible headless service. | `{}` |
|
|
|
-| `service.headless.broker.annotations` | Annotations for the broker-only headless service. | `{}` |
|
|
|
-| `service.headless.broker.labels` | Labels for the broker-only headless service. | `{}` |
|
|
|
-| `service.headless.ipFamilies` | IP families for the headless service | `[]` |
|
|
|
-| `service.headless.ipFamilyPolicy` | IP family policy for the headless service | `""` |
|
|
|
-| `externalAccess.enabled` | Enable Kubernetes external cluster access to Kafka brokers | `false` |
|
|
|
-| `externalAccess.autoDiscovery.enabled` | Enable using an init container to auto-detect external IPs/ports by querying the K8s API | `false` |
|
|
|
-| `externalAccess.autoDiscovery.image.registry` | Init container auto-discovery image registry | `REGISTRY_NAME` |
|
|
|
-| `externalAccess.autoDiscovery.image.repository` | Init container auto-discovery image repository | `REPOSITORY_NAME/kubectl` |
|
|
|
-| `externalAccess.autoDiscovery.image.digest` | Kubectl image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
|
|
|
-| `externalAccess.autoDiscovery.image.pullPolicy` | Init container auto-discovery image pull policy | `IfNotPresent` |
|
|
|
-| `externalAccess.autoDiscovery.image.pullSecrets` | Init container auto-discovery image pull secrets | `[]` |
|
|
|
-| `externalAccess.autoDiscovery.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if externalAccess.autoDiscovery.resources is set (externalAccess.autoDiscovery.resources is recommended for production). | `nano` |
|
|
|
-| `externalAccess.autoDiscovery.resources` | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.enabled` | Enable Kafka auto-discovery containers' Security Context | `true` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.seLinuxOptions` | Set SELinux options in container | `{}` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.runAsUser` | Set containers' Security Context runAsUser | `1001` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.runAsGroup` | Set containers' Security Context runAsGroup | `1001` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.runAsNonRoot` | Set Kafka auto-discovery containers' Security Context runAsNonRoot | `true` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.allowPrivilegeEscalation` | Set Kafka auto-discovery containers' Security Context allowPrivilegeEscalation | `false` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.readOnlyRootFilesystem` | Set Kafka auto-discovery containers' Security Context readOnlyRootFilesystem | `true` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.capabilities.drop` | Set Kafka auto-discovery containers' Security Context capabilities to be dropped | `["ALL"]` |
|
|
|
-| `externalAccess.autoDiscovery.containerSecurityContext.seccompProfile.type` | Set Kafka auto-discovery seccomp profile type | `RuntimeDefault` |
|
|
|
-| `externalAccess.controller.forceExpose` | If set to true, force exposing controller-eligible nodes although they are configured as controller-only nodes | `false` |
|
|
|
-| `externalAccess.controller.service.type` | Kubernetes Service type for external access. It can be NodePort, LoadBalancer or ClusterIP | `LoadBalancer` |
|
|
|
-| `externalAccess.controller.service.ports.external` | Kafka port used for external access when service type is LoadBalancer | `9094` |
|
|
|
-| `externalAccess.controller.service.loadBalancerClass` | Kubernetes Service Load Balancer class for external access when service type is LoadBalancer | `""` |
|
|
|
-| `externalAccess.controller.service.loadBalancerIPs` | Array of load balancer IPs for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.controller.service.loadBalancerNames` | Array of load balancer Names for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.controller.service.loadBalancerAnnotations` | Array of load balancer annotations for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.controller.service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | `[]` |
|
|
|
-| `externalAccess.controller.service.allocateLoadBalancerNodePorts` | Whether to allocate node ports when service type is LoadBalancer | `true` |
|
|
|
-| `externalAccess.controller.service.nodePorts` | Array of node ports used for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.controller.service.externalIPs` | Use distinct service host IPs to configure Kafka external listener when service type is NodePort. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.controller.service.useHostIPs` | Use service host IPs to configure Kafka external listener when service type is NodePort | `false` |
|
|
|
-| `externalAccess.controller.service.usePodIPs` | using the MY_POD_IP address for external access. | `false` |
|
|
|
-| `externalAccess.controller.service.domain` | Domain or external ip used to configure Kafka external listener when service type is NodePort or ClusterIP | `""` |
|
|
|
-| `externalAccess.controller.service.publishNotReadyAddresses` | Indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready | `false` |
|
|
|
-| `externalAccess.controller.service.labels` | Service labels for external access | `{}` |
|
|
|
-| `externalAccess.controller.service.annotations` | Service annotations for external access | `{}` |
|
|
|
-| `externalAccess.controller.service.extraPorts` | Extra ports to expose in the Kafka external service | `[]` |
|
|
|
-| `externalAccess.controller.service.ipFamilies` | IP families for the external controller service | `[]` |
|
|
|
-| `externalAccess.controller.service.ipFamilyPolicy` | IP family policy for the external controller service | `""` |
|
|
|
-| `externalAccess.broker.service.type` | Kubernetes Service type for external access. It can be NodePort, LoadBalancer or ClusterIP | `LoadBalancer` |
|
|
|
-| `externalAccess.broker.service.ports.external` | Kafka port used for external access when service type is LoadBalancer | `9094` |
|
|
|
-| `externalAccess.broker.service.loadBalancerClass` | Kubernetes Service Load Balancer class for external access when service type is LoadBalancer | `""` |
|
|
|
-| `externalAccess.broker.service.loadBalancerIPs` | Array of load balancer IPs for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.broker.service.loadBalancerNames` | Array of load balancer Names for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.broker.service.loadBalancerAnnotations` | Array of load balancer annotations for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.broker.service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | `[]` |
|
|
|
-| `externalAccess.broker.service.allocateLoadBalancerNodePorts` | Whether to allocate node ports when service type is LoadBalancer | `true` |
|
|
|
-| `externalAccess.broker.service.nodePorts` | Array of node ports used for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.broker.service.externalIPs` | Use distinct service host IPs to configure Kafka external listener when service type is NodePort. Length must be the same as replicaCount | `[]` |
|
|
|
-| `externalAccess.broker.service.useHostIPs` | Use service host IPs to configure Kafka external listener when service type is NodePort | `false` |
|
|
|
-| `externalAccess.broker.service.usePodIPs` | using the MY_POD_IP address for external access. | `false` |
|
|
|
-| `externalAccess.broker.service.domain` | Domain or external ip used to configure Kafka external listener when service type is NodePort or ClusterIP | `""` |
|
|
|
-| `externalAccess.broker.service.publishNotReadyAddresses` | Indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready | `false` |
|
|
|
-| `externalAccess.broker.service.labels` | Service labels for external access | `{}` |
|
|
|
-| `externalAccess.broker.service.annotations` | Service annotations for external access | `{}` |
|
|
|
-| `externalAccess.broker.service.extraPorts` | Extra ports to expose in the Kafka external service | `[]` |
|
|
|
-| `externalAccess.broker.service.ipFamilies` | IP families for the external broker service | `[]` |
|
|
|
-| `externalAccess.broker.service.ipFamilyPolicy` | IP family policy for the external broker service | `""` |
|
|
|
-| `networkPolicy.enabled` | Specifies whether a NetworkPolicy should be created | `true` |
|
|
|
-| `networkPolicy.allowExternal` | Don't require client label for connections | `true` |
|
|
|
-| `networkPolicy.allowExternalEgress` | Allow the pod to access any range of port and all destinations. | `true` |
|
|
|
-| `networkPolicy.addExternalClientAccess` | Allow access from pods with client label set to "true". Ignored if `networkPolicy.allowExternal` is true. | `true` |
|
|
|
-| `networkPolicy.extraIngress` | Add extra ingress rules to the NetworkPolicy | `[]` |
|
|
|
-| `networkPolicy.extraEgress` | Add extra ingress rules to the NetworkPolicy | `[]` |
|
|
|
-| `networkPolicy.ingressPodMatchLabels` | Labels to match to allow traffic from other pods. Ignored if `networkPolicy.allowExternal` is true. | `{}` |
|
|
|
-| `networkPolicy.ingressNSMatchLabels` | Labels to match to allow traffic from other namespaces. Ignored if `networkPolicy.allowExternal` is true. | `{}` |
|
|
|
-| `networkPolicy.ingressNSPodMatchLabels` | Pod labels to match to allow traffic from other namespaces. Ignored if `networkPolicy.allowExternal` is true. | `{}` |
|
|
|
-
|
|
|
-### Volume Permissions parameters
|
|
|
-
|
|
|
-| Name | Description | Value |
|
|
|
-| ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
|
-| `volumePermissions.enabled` | Enable init container that changes the owner and group of the persistent volume | `false` |
|
|
|
-| `volumePermissions.image.registry` | Init container volume-permissions image registry | `REGISTRY_NAME` |
|
|
|
-| `volumePermissions.image.repository` | Init container volume-permissions image repository | `REPOSITORY_NAME/os-shell` |
|
|
|
-| `volumePermissions.image.digest` | Init container volume-permissions image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
|
|
|
-| `volumePermissions.image.pullPolicy` | Init container volume-permissions image pull policy | `IfNotPresent` |
|
|
|
-| `volumePermissions.image.pullSecrets` | Init container volume-permissions image pull secrets | `[]` |
|
|
|
-| `volumePermissions.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if volumePermissions.resources is set (volumePermissions.resources is recommended for production). | `nano` |
|
|
|
-| `volumePermissions.resources` | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
-| `volumePermissions.containerSecurityContext.seLinuxOptions` | Set SELinux options in container | `{}` |
|
|
|
-| `volumePermissions.containerSecurityContext.runAsUser` | User ID for the init container | `0` |
|
|
|
+| Name | Description | Value |
|
|
|
+| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
|
+| `service.type` | Kubernetes Service type | `ClusterIP` |
|
|
|
+| `service.ports.client` | Kafka svc port for client connections | `9092` |
|
|
|
+| `service.ports.controller` | Kafka svc port for controller connections | `9093` |
|
|
|
+| `service.ports.interbroker` | Kafka svc port for inter-broker connections | `9094` |
|
|
|
+| `service.ports.external` | Kafka svc port for external connections | `9095` |
|
|
|
+| `service.extraPorts` | Extra ports to expose in the Kafka service (normally used with the `sidecar` value) | `[]` |
|
|
|
+| `service.nodePorts.client` | Node port for the Kafka client connections | `""` |
|
|
|
+| `service.nodePorts.external` | Node port for the Kafka external connections | `""` |
|
|
|
+| `service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` |
|
|
|
+| `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` |
|
|
|
+| `service.clusterIP` | Kafka service Cluster IP | `""` |
|
|
|
+| `service.loadBalancerIP` | Kafka service Load Balancer IP | `""` |
|
|
|
+| `service.loadBalancerClass` | Kafka service Load Balancer Class | `""` |
|
|
|
+| `service.loadBalancerSourceRanges` | Kafka service Load Balancer sources | `[]` |
|
|
|
+| `service.allocateLoadBalancerNodePorts` | Whether to allocate node ports when service type is LoadBalancer | `true` |
|
|
|
+| `service.externalTrafficPolicy` | Kafka service external traffic policy | `Cluster` |
|
|
|
+| `service.annotations` | Additional custom annotations for Kafka service | `{}` |
|
|
|
+| `service.headless.controller.annotations` | Annotations for the controller-eligible headless service. | `{}` |
|
|
|
+| `service.headless.controller.labels` | Labels for the controller-eligible headless service. | `{}` |
|
|
|
+| `service.headless.broker.annotations` | Annotations for the broker-only headless service. | `{}` |
|
|
|
+| `service.headless.broker.labels` | Labels for the broker-only headless service. | `{}` |
|
|
|
+| `service.headless.ipFamilies` | IP families for the headless service | `[]` |
|
|
|
+| `service.headless.ipFamilyPolicy` | IP family policy for the headless service | `""` |
|
|
|
+| `externalAccess.enabled` | Enable Kubernetes external cluster access to Kafka brokers | `false` |
|
|
|
+| `externalAccess.controller.forceExpose` | If set to true, force exposing controller-eligible nodes although they are configured as controller-only nodes | `false` |
|
|
|
+| `externalAccess.controller.service.type` | Kubernetes Service type for external access. It can be NodePort, LoadBalancer or ClusterIP | `LoadBalancer` |
|
|
|
+| `externalAccess.controller.service.ports.external` | Kafka port used for external access when service type is LoadBalancer | `9094` |
|
|
|
+| `externalAccess.controller.service.loadBalancerClass` | Kubernetes Service Load Balancer class for external access when service type is LoadBalancer | `""` |
|
|
|
+| `externalAccess.controller.service.loadBalancerIPs` | Array of load balancer IPs for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.controller.service.loadBalancerNames` | Array of load balancer Names for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.controller.service.loadBalancerAnnotations` | Array of load balancer annotations for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.controller.service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | `[]` |
|
|
|
+| `externalAccess.controller.service.allocateLoadBalancerNodePorts` | Whether to allocate node ports when service type is LoadBalancer | `true` |
|
|
|
+| `externalAccess.controller.service.nodePorts` | Array of node ports used for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.controller.service.externalIPs` | Use distinct service host IPs to configure Kafka external listener when service type is NodePort. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.controller.service.useHostIPs` | Use service host IPs to configure Kafka external listener when service type is NodePort | `false` |
|
|
|
+| `externalAccess.controller.service.usePodIPs` | using the MY_POD_IP address for external access. | `false` |
|
|
|
+| `externalAccess.controller.service.domain` | Domain or external ip used to configure Kafka external listener when service type is NodePort or ClusterIP | `""` |
|
|
|
+| `externalAccess.controller.service.publishNotReadyAddresses` | Indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready | `false` |
|
|
|
+| `externalAccess.controller.service.labels` | Service labels for external access | `{}` |
|
|
|
+| `externalAccess.controller.service.annotations` | Service annotations for external access | `{}` |
|
|
|
+| `externalAccess.controller.service.extraPorts` | Extra ports to expose in the Kafka external service | `[]` |
|
|
|
+| `externalAccess.controller.service.ipFamilies` | IP families for the external controller service | `[]` |
|
|
|
+| `externalAccess.controller.service.ipFamilyPolicy` | IP family policy for the external controller service | `""` |
|
|
|
+| `externalAccess.broker.service.type` | Kubernetes Service type for external access. It can be NodePort, LoadBalancer or ClusterIP | `LoadBalancer` |
|
|
|
+| `externalAccess.broker.service.ports.external` | Kafka port used for external access when service type is LoadBalancer | `9094` |
|
|
|
+| `externalAccess.broker.service.loadBalancerClass` | Kubernetes Service Load Balancer class for external access when service type is LoadBalancer | `""` |
|
|
|
+| `externalAccess.broker.service.loadBalancerIPs` | Array of load balancer IPs for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.broker.service.loadBalancerNames` | Array of load balancer Names for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.broker.service.loadBalancerAnnotations` | Array of load balancer annotations for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.broker.service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | `[]` |
|
|
|
+| `externalAccess.broker.service.allocateLoadBalancerNodePorts` | Whether to allocate node ports when service type is LoadBalancer | `true` |
|
|
|
+| `externalAccess.broker.service.nodePorts` | Array of node ports used for each Kafka broker. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.broker.service.externalIPs` | Use distinct service host IPs to configure Kafka external listener when service type is NodePort. Length must be the same as replicaCount | `[]` |
|
|
|
+| `externalAccess.broker.service.useHostIPs` | Use service host IPs to configure Kafka external listener when service type is NodePort | `false` |
|
|
|
+| `externalAccess.broker.service.usePodIPs` | using the MY_POD_IP address for external access. | `false` |
|
|
|
+| `externalAccess.broker.service.domain` | Domain or external ip used to configure Kafka external listener when service type is NodePort or ClusterIP | `""` |
|
|
|
+| `externalAccess.broker.service.publishNotReadyAddresses` | Indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready | `false` |
|
|
|
+| `externalAccess.broker.service.labels` | Service labels for external access | `{}` |
|
|
|
+| `externalAccess.broker.service.annotations` | Service annotations for external access | `{}` |
|
|
|
+| `externalAccess.broker.service.extraPorts` | Extra ports to expose in the Kafka external service | `[]` |
|
|
|
+| `externalAccess.broker.service.ipFamilies` | IP families for the external broker service | `[]` |
|
|
|
+| `externalAccess.broker.service.ipFamilyPolicy` | IP family policy for the external broker service | `""` |
|
|
|
+| `networkPolicy.enabled` | Specifies whether a NetworkPolicy should be created | `true` |
|
|
|
+| `networkPolicy.allowExternal` | Don't require client label for connections | `true` |
|
|
|
+| `networkPolicy.allowExternalEgress` | Allow the pod to access any range of port and all destinations. | `true` |
|
|
|
+| `networkPolicy.addExternalClientAccess` | Allow access from pods with client label set to "true". Ignored if `networkPolicy.allowExternal` is true. | `true` |
|
|
|
+| `networkPolicy.extraIngress` | Add extra ingress rules to the NetworkPolicy | `[]` |
|
|
|
+| `networkPolicy.extraEgress` | Add extra ingress rules to the NetworkPolicy | `[]` |
|
|
|
+| `networkPolicy.ingressPodMatchLabels` | Labels to match to allow traffic from other pods. Ignored if `networkPolicy.allowExternal` is true. | `{}` |
|
|
|
+| `networkPolicy.ingressNSMatchLabels` | Labels to match to allow traffic from other namespaces. Ignored if `networkPolicy.allowExternal` is true. | `{}` |
|
|
|
+| `networkPolicy.ingressNSPodMatchLabels` | Pod labels to match to allow traffic from other namespaces. Ignored if `networkPolicy.allowExternal` is true. | `{}` |
|
|
|
|
|
|
### Other Parameters
|
|
|
|
|
|
@@ -1068,42 +1029,15 @@ You can enable this initContainer by setting `volumePermissions.enabled` to `tru
|
|
|
| `provisioning.waitForKafka` | If true use an init container to wait until kafka is ready before starting provisioning | `true` |
|
|
|
| `provisioning.useHelmHooks` | Flag to indicate usage of helm hooks | `true` |
|
|
|
|
|
|
-### KRaft chart parameters
|
|
|
-
|
|
|
-| Name | Description | Value |
|
|
|
-| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
|
|
|
-| `kraft.enabled` | Switch to enable or disable the KRaft mode for Kafka | `true` |
|
|
|
-| `kraft.existingClusterIdSecret` | Name of the secret containing the cluster ID for the Kafka KRaft cluster. This is incompatible with the clusterId parameter. If both are set, the existingClusterIdSecret will be used | `""` |
|
|
|
-| `kraft.clusterId` | Kafka Kraft cluster ID. If not set, a random cluster ID will be generated the first time Kraft is initialized. | `""` |
|
|
|
-| `kraft.controllerQuorumVoters` | Override the Kafka controller quorum voters of the Kafka Kraft cluster. If not set, it will be automatically configured to use all controller-elegible nodes. | `""` |
|
|
|
-
|
|
|
-### ZooKeeper chart parameters
|
|
|
-
|
|
|
-| Name | Description | Value |
|
|
|
-| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
|
|
|
-| `zookeeperChrootPath` | Path which puts data under some path in the global ZooKeeper namespace | `""` |
|
|
|
-| `zookeeper.enabled` | Switch to enable or disable the ZooKeeper helm chart. Must be false if you use KRaft mode. | `false` |
|
|
|
-| `zookeeper.replicaCount` | Number of ZooKeeper nodes | `1` |
|
|
|
-| `zookeeper.auth.client.enabled` | Enable ZooKeeper auth | `false` |
|
|
|
-| `zookeeper.auth.client.clientUser` | User that will use ZooKeeper client (zkCli.sh) to authenticate. Must exist in the serverUsers comma-separated list. | `""` |
|
|
|
-| `zookeeper.auth.client.clientPassword` | Password that will use ZooKeeper client (zkCli.sh) to authenticate. Must exist in the serverPasswords comma-separated list. | `""` |
|
|
|
-| `zookeeper.auth.client.serverUsers` | Comma, semicolon or whitespace separated list of user to be created. Specify them as a string, for example: "user1,user2,admin" | `""` |
|
|
|
-| `zookeeper.auth.client.serverPasswords` | Comma, semicolon or whitespace separated list of passwords to assign to users when created. Specify them as a string, for example: "pass4user1, pass4user2, pass4admin" | `""` |
|
|
|
-| `zookeeper.persistence.enabled` | Enable persistence on ZooKeeper using PVC(s) | `true` |
|
|
|
-| `zookeeper.persistence.storageClass` | Persistent Volume storage class | `""` |
|
|
|
-| `zookeeper.persistence.accessModes` | Persistent Volume access modes | `["ReadWriteOnce"]` |
|
|
|
-| `zookeeper.persistence.size` | Persistent Volume size | `8Gi` |
|
|
|
-| `externalZookeeper.servers` | List of external zookeeper servers to use. Typically used in combination with 'zookeeperChrootPath'. Must be empty if you use KRaft mode. | `[]` |
|
|
|
-
|
|
|
```console
|
|
|
helm install my-release \
|
|
|
- --set replicaCount=3 \
|
|
|
+ --set controller.replicaCount=3 \
|
|
|
oci://REGISTRY_NAME/REPOSITORY_NAME/kafka
|
|
|
```
|
|
|
|
|
|
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
|
|
|
|
|
|
-The above command deploys Kafka with 3 brokers (replicas).
|
|
|
+The above command deploys Kafka with 3 Kafka controller-eligible nodes.
|
|
|
|
|
|
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
|
|
|
|
|
|
@@ -1120,6 +1054,27 @@ Find more information about how to deal with common errors related to Bitnami's
|
|
|
|
|
|
## Upgrading
|
|
|
|
|
|
+### To 32.0.0
|
|
|
+
|
|
|
+This major release bumps Kafka major version to `4.y.z` series. This version implies a significant milestone given now Kafka operates operate entirely without Apache ZooKeeper, running in KRaft mode by default. As a consequence, **ZooKeeper is no longer a chart dependency and every related parameter has been removed.**. Upgrading from `31.y.z` chart version is not supported unless KRaft mode was already enabled.
|
|
|
+
|
|
|
+Also, some KRaft-related parameters have been renamed or removed:
|
|
|
+
|
|
|
+- `kraft.enabled` has been removed. Kafka now operates in KRaft mode by default.
|
|
|
+- `kraft.controllerQuorumVoters` has been renamed to `controller.quorumVoters`.
|
|
|
+- `kraft.clusterId` and `kraft.existingClusterIdSecret` have been renamed to `clusterId` and `existingKraftSecret`, respectively.
|
|
|
+
|
|
|
+Other notable changes:
|
|
|
+
|
|
|
+- `log4j` and `existingLog4jConfig` parameters have been renamed to `log4j2` and `existingLog4j2ConfigMap`, respectively.
|
|
|
+- `controller.quorumVoters` has been removed in favor of `controller.quorumBootstrapServers`.
|
|
|
+- `brokerRackAssignment` and `brokerRackAssignmentApiVersion` are deprecated in favor of `brokerRackAwareness.*` parameters.
|
|
|
+- `tls.autoGenerated` boolean is now an object with extended configuration options.
|
|
|
+- `volumePermissions` parameters have been moved under `defaultInitContainers` parameter.
|
|
|
+- `externalAccess.autoDiscovery` parameters have been moved under `defaultInitContainers` parameter.
|
|
|
+- `controller.initContainerResources` and `broker.initContainerResources` have been removed. Use `defaultInitContainers.prepareConfig.resources` instead.
|
|
|
+- `extraInit` has been renamed to `defaultInitContainers.prepareConfig.extraInit`.
|
|
|
+
|
|
|
### To 31.1.0
|
|
|
|
|
|
This version introduces image verification for security purposes. To disable it, set `global.security.allowInsecureImages` to `true`. More details at [GitHub issue](https://github.com/bitnami/charts/issues/30850).
|
|
|
@@ -1568,4 +1523,4 @@ Unless required by applicable law or agreed to in writing, software
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
See the License for the specific language governing permissions and
|
|
|
-limitations under the License.
|
|
|
+limitations under the License.
|
Juan Ariza Toledano