1# This file has been modified by Chainguard, Inc.
3# Copyright Chainguard, Inc. All Rights Reserved.
4# Chainguard, Inc. modifications are subject to the license
5# available at: https://www.chainguard.dev/legal/software-license-agreement
7# Copyright Broadcom, Inc. All Rights Reserved.
8# SPDX-License-Identifier: APACHE-2.0
10## @section Global parameters
11## Global Docker image parameters
12## Please, note that this will override the image parameters, including dependencies, configured to use the global value
13## Current available global Docker image parameters: imageRegistry, imagePullSecrets and storageClass
16## @param global.imageRegistry Global Docker image registry
17## @param global.useImageTags Pull every image by tag and ignore all image digests, including digests set in values. Use this when your registry mirror does not have the chart's default image digests.
18## @param global.imagePullSecrets Global Docker registry secret names as an array
19## @param global.defaultStorageClass Global default StorageClass for Persistent Volume(s)
20## @param global.storageClass DEPRECATED: use global.defaultStorageClass instead
27 ## - myRegistryKeySecretName
30 defaultStorageClass: ""
32 ## Security parameters
35 ## @param global.security.allowInsecureImages Allows skipping image verification
36 allowInsecureImages: false
37 ## Compatibility adaptations for Kubernetes platforms
40 ## Compatibility adaptations for Openshift
43 ## @param 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)
45 adaptSecurityContext: auto
47## @section Common parameters
50## @param kubeVersion Override Kubernetes version
53## @param apiVersions Override Kubernetes API versions reported by .Capabilities
56## @param nameOverride String to partially override common.names.fullname
59## @param fullnameOverride String to fully override common.names.fullname
62## @param clusterDomain Default Kubernetes cluster domain
64clusterDomain: cluster.local
65## @param commonLabels Labels to add to all deployed objects
68## @param commonAnnotations Annotations to add to all deployed objects
71## @param extraDeploy Array of extra objects to deploy with the release
74## @param serviceBindings.enabled Create secret for service binding (Experimental)
75## Ref: https://servicebinding.io/service-provider/
79## Enable diagnostic mode in the statefulset
82 ## @param diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden)
85 ## @param diagnosticMode.command Command to override all containers in the statefulset
89 ## @param diagnosticMode.args Args to override all containers in the statefulset
93## @section Kafka parameters
96## Iamguarded Kafka image version
97## @param image.registry [default: REGISTRY_NAME] Kafka image registry
98## @param image.repository [default: REPOSITORY_NAME/kafka] Kafka image repository
99## @skip image.tag Kafka image tag (immutable tags are recommended)
100## @param image.digest Kafka image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
101## @param image.pullPolicy Kafka image pull policy
102## @param image.pullSecrets Specify docker-registry secret names as an array
103## @param image.debug Specify if debug values should be set
107 repository: chainguard-private/kafka-iamguarded
109 digest: sha256:e3c0d19e269967e4f270ecf3d6e27cb9c55014e274041f93df2713af2a805902
110 ## Specify a imagePullPolicy
111 ## ref: https://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
113 pullPolicy: IfNotPresent
114 ## Optionally specify an array of imagePullSecrets.
115 ## Secrets must be manually created in the namespace.
116 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
119 ## - myRegistryKeySecretName
122 ## Set to true if you would like to see extra information on logs
125## @param extraInit Additional content for the kafka init script, rendered as a template.
128## @param config Configuration file for Kafka, rendered as a template. Auto-generated based on chart values when not specified.
129## @param existingConfigmap ConfigMap with Kafka Configuration
130## NOTE: This will override the configuration based on values, please act carefully
131## If both are set, the existingConfigMap will be used.
135## @param extraConfig Additional configuration to be appended at the end of the generated Kafka configuration file.
138## @param extraConfigYaml Additional configuration in yaml format to be appended at the end of the generated Kafka configuration file.
142## default.replication.factor: 3
145## @param secretConfig Additional configuration to be appended at the end of the generated Kafka configuration file.
146## This value will be stored in a secret.
149## @param existingSecretConfig Secret with additonal configuration that will be appended to the end of the generated Kafka configuration file
150## The key for the configuration should be: server-secret.properties
151## NOTE: This will override secretConfig value
153existingSecretConfig: ""
154## @param log4j An optional log4j.properties file to overwrite the default of the Kafka brokers
155## An optional log4j.properties file to overwrite the default of the Kafka brokers
156## ref: https://github.com/apache/kafka/blob/trunk/config/log4j.properties
159## @param existingLog4jConfigMap The name of an existing ConfigMap containing a log4j.properties file
160## The name of an existing ConfigMap containing a log4j.properties file
161## NOTE: this will override `log4j`
163existingLog4jConfigMap: ""
164## @param heapOpts Kafka Java Heap configuration
166heapOpts: -XX:InitialRAMPercentage=75 -XX:MaxRAMPercentage=75
167## @param brokerRackAssignment Set Broker Assignment for multi tenant environment Allowed values: `aws-az`, `azure`
168## ref: https://cwiki.apache.org/confluence/display/KAFKA/KIP-392%3A+Allow+consumers+to+fetch+from+closest+replica
170brokerRackAssignment: ""
171## @param brokerRackAssignmentApiVersion Set Broker Assignment API version when brokerRackAssignment set to : `azure`
172brokerRackAssignmentApiVersion: "2023-11-15"
173## @param interBrokerProtocolVersion Override the setting 'inter.broker.protocol.version' during the ZK migration.
174## Ref. https://docs.confluent.io/platform/current/installation/migrate-zk-kraft.html
176interBrokerProtocolVersion: ""
177## Kafka listeners configuration
180 ## @param listeners.client.name Name for the Kafka client listener
181 ## @param listeners.client.containerPort Port for the Kafka client listener
182 ## @param listeners.client.protocol Security protocol for the Kafka client listener. Allowed values are 'PLAINTEXT', 'SASL_PLAINTEXT', 'SASL_SSL' and 'SSL'
183 ## @param listeners.client.sslClientAuth Optional. If SASL_SSL is enabled, configure mTLS TLS authentication type. If SSL protocol is enabled, overrides tls.authType for this listener. Allowed values are 'none', 'requested' and 'required'
186 protocol: SASL_PLAINTEXT
189 ## @param listeners.controller.name Name for the Kafka controller listener
190 ## @param listeners.controller.containerPort Port for the Kafka controller listener
191 ## @param listeners.controller.protocol Security protocol for the Kafka controller listener. Allowed values are 'PLAINTEXT', 'SASL_PLAINTEXT', 'SASL_SSL' and 'SSL'
192 ## @param listeners.controller.sslClientAuth Optional. If SASL_SSL is enabled, configure mTLS TLS authentication type. If SSL protocol is enabled, overrides tls.authType for this listener. Allowed values are 'none', 'requested' and 'required'
193 ## Ref: https://cwiki.apache.org/confluence/display/KAFKA/KIP-684+-+Support+mutual+TLS+authentication+on+SASL_SSL+listeners
197 protocol: SASL_PLAINTEXT
199 ## @param listeners.interbroker.name Name for the Kafka inter-broker listener
200 ## @param listeners.interbroker.containerPort Port for the Kafka inter-broker listener
201 ## @param listeners.interbroker.protocol Security protocol for the Kafka inter-broker listener. Allowed values are 'PLAINTEXT', 'SASL_PLAINTEXT', 'SASL_SSL' and 'SSL'
202 ## @param listeners.interbroker.sslClientAuth Optional. If SASL_SSL is enabled, configure mTLS TLS authentication type. If SSL protocol is enabled, overrides tls.authType for this listener. Allowed values are 'none', 'requested' and 'required'
205 protocol: SASL_PLAINTEXT
208 ## @param listeners.external.containerPort Port for the Kafka external listener
209 ## @param listeners.external.protocol Security protocol for the Kafka external listener. . Allowed values are 'PLAINTEXT', 'SASL_PLAINTEXT', 'SASL_SSL' and 'SSL'
210 ## @param listeners.external.name Name for the Kafka external listener
211 ## @param listeners.external.sslClientAuth Optional. If SASL_SSL is enabled, configure mTLS TLS authentication type. If SSL protocol is enabled, overrides tls.sslClientAuth for this listener. Allowed values are 'none', 'requested' and 'required'
214 protocol: SASL_PLAINTEXT
217 ## @param listeners.extraListeners Array of listener objects to be appended to already existing listeners
221 ## containerPort: 9097
222 ## protocol: SASL_PLAINTEXT
226 ## NOTE: If set, below values will override configuration set using the above values (extraListeners.*, controller.*, interbroker.*, client.* and external.*)
227 ## @param listeners.overrideListeners Overrides the Kafka 'listeners' configuration setting.
228 ## @param listeners.advertisedListeners Overrides the Kafka 'advertised.listener' configuration setting.
229 ## @param listeners.securityProtocolMap Overrides the Kafka 'security.protocol.map' configuration setting.
230 overrideListeners: ""
231 advertisedListeners: ""
232 securityProtocolMap: ""
233## @section Kafka SASL parameters
234## Kafka SASL settings for authentication, required if SASL_PLAINTEXT or SASL_SSL listeners are configured
237 ## @param sasl.enabledMechanisms Comma-separated list of allowed SASL mechanisms when SASL listeners are configured. Allowed types: `PLAIN`, `SCRAM-SHA-256`, `SCRAM-SHA-512`, `OAUTHBEARER`
238 ## NOTE: At the moment, Kafka Raft mode does not support SCRAM, that is why only PLAIN is configured.
240 enabledMechanisms: PLAIN,SCRAM-SHA-256,SCRAM-SHA-512
241 ## @param sasl.interBrokerMechanism SASL mechanism for inter broker communication.
243 interBrokerMechanism: PLAIN
244 ## @param sasl.controllerMechanism SASL mechanism for controller communications.
246 controllerMechanism: PLAIN
247 ## Settings for oauthbearer mechanism
248 ## @param sasl.oauthbearer.tokenEndpointUrl The URL for the OAuth/OIDC identity provider
249 ## @param sasl.oauthbearer.jwksEndpointUrl The OAuth/OIDC provider URL from which the provider's JWKS (JSON Web Key Set) can be retrieved
250 ## @param sasl.oauthbearer.expectedAudience The comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences
251 ## @param sasl.oauthbearer.subClaimName The OAuth claim name for the subject.
258 ## Credentials for inter-broker communications.
259 ## @param sasl.interbroker.user Username for inter-broker communications when SASL is enabled
260 ## @param sasl.interbroker.password Password for inter-broker communications when SASL is enabled. If not set and SASL is enabled for the controller listener, a random password will be generated.
261 ## @param sasl.interbroker.clientId Client ID for inter-broker communications when SASL is enabled with mechanism OAUTHBEARER
262 ## @param sasl.interbroker.clientSecret Client Secret for inter-broker communications when SASL is enabled with mechanism OAUTHBEARER. If not set and SASL is enabled for the controller listener, a random secret will be generated.
265 user: inter_broker_user
267 clientId: inter_broker_client
269 ## Credentials for controller communications.
270 ## @param sasl.controller.user Username for controller communications when SASL is enabled
271 ## @param sasl.controller.password Password for controller communications when SASL is enabled. If not set and SASL is enabled for the inter-broker listener, a random password will be generated.
272 ## @param sasl.controller.clientId Client ID for controller communications when SASL is enabled with mechanism OAUTHBEARER
273 ## @param 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.
276 user: controller_user
278 clientId: controller_broker_client
280 ## Credentials for client communications.
281 ## @param sasl.client.users Comma-separated list of usernames for client communications when SASL is enabled
282 ## @param sasl.client.passwords Comma-separated list of passwords for client communications when SASL is enabled, must match the number of client.users
288 ## Credentials for Zookeeper communications.
289 ## @param sasl.zookeeper.user Username for zookeeper communications when SASL is enabled.
290 ## @param sasl.zookeeper.password Password for zookeeper communications when SASL is enabled.
295 ## @param sasl.existingSecret Name of the existing secret containing credentials for clientUsers, interBrokerUser, controllerUser and zookeeperUser
296 ## Create this secret running the command below where SECRET_NAME is the name of the secret you want to create:
297 ## kubectl create secret generic SECRET_NAME --from-literal=client-passwords=CLIENT_PASSWORD1,CLIENT_PASSWORD2 --from-literal=inter-broker-password=INTER_BROKER_PASSWORD --from-literal=inter-broker-client-secret=INTER_BROKER_CLIENT_SECRET --from-literal=controller-password=CONTROLLER_PASSWORD --from-literal=controller-client-secret=CONTROLLER_CLIENT_SECRET --from-literal=zookeeper-password=ZOOKEEPER_PASSWORD
298 ## The client secrets are only required when using oauthbearer as sasl mechanism.
299 ## Client, interbroker and controller passwords are only required if the sasl mechanism includes something other than oauthbearer.
302## @section Kafka TLS parameters
303## Kafka TLS settings, required if SSL or SASL_SSL listeners are configured
306 ## @param tls.type Format to use for TLS certificates. Allowed types: `JKS` and `PEM`
309 ## @param tls.pemChainIncluded Flag to denote that the Certificate Authority (CA) certificates are bundled with the endpoint cert.
310 ## Certificates must be in proper order, where the top certificate is the leaf and the bottom certificate is the top-most intermediate CA.
312 pemChainIncluded: false
313 ## @param tls.existingSecret Name of the existing secret containing the TLS certificates for the Kafka nodes.
314 ## When using 'jks' format for certificates, each secret should contain a truststore and a keystore.
315 ## Create these secrets following the steps below:
316 ## 1) Generate your truststore and keystore files. Helpful script: https://raw.githubusercontent.com/confluentinc/confluent-platform-security-tools/master/kafka-generate-ssl.sh
317 ## 2) Rename your truststore to `kafka.truststore.jks`.
318 ## 3) Rename your keystores to `kafka-<role>-X.keystore.jks` where X is the replica number of the .
319 ## 4) Run the command below one time per broker to create its associated secret (SECRET_NAME_X is the name of the secret you want to create):
320 ## kubectl create secret generic SECRET_NAME_0 --from-file=kafka.truststore.jks=./kafka.truststore.jks \
321 ## --from-file=kafka-controller-0.keystore.jks=./kafka-controller-0.keystore.jks --from-file=kafka-broker-0.keystore.jks=./kafka-broker-0.keystore.jks ...
323 ## NOTE: Alternatively, a single keystore can be provided for all nodes under the key 'kafka.keystore.jks', this keystore will be used by all nodes unless overridden by the 'kafka-<role>-X.keystore.jks' file
325 ## When using 'pem' format for certificates, each secret should contain a public CA certificate, a public certificate and one private key.
326 ## Create these secrets following the steps below:
327 ## 1) Create a certificate key and signing request per Kafka broker, and sign the signing request with your CA
328 ## 2) Rename your CA file to `kafka-ca.crt`.
329 ## 3) Rename your certificates to `kafka-X.tls.crt` where X is the ID of each Kafka broker.
330 ## 3) Rename your keys to `kafka-X.tls.key` where X is the ID of each Kafka broker.
331 ## 4) Run the command below one time per broker to create its associated secret (SECRET_NAME_X is the name of the secret you want to create):
332 ## kubectl create secret generic SECRET_NAME_0 --from-file=kafka-ca.crt=./kafka-ca.crt --from-file=kafka-controller-0.crt=./kafka-controller-0.crt --from-file=kafka-controller-0.key=./kafka-controller-0.key \
333 ## --from-file=kafka-broker-0.crt=./kafka-broker-0.crt --from-file=kafka-broker-0.key=./kafka-broker-0.key ...
335 ## NOTE: Alternatively, a single key and certificate can be provided for all nodes under the keys 'kafka.crt' and 'kafka.key'. These certificates will be used by all nodes unless overridden by the 'kafka-<role>-X.key' and 'kafka-<role>-X.crt' files
336 ## NOTE: Alternatively, a single key and certificate can be provided for all nodes under the keys 'tls.crt' and 'tls.key'. These certificates will be used by all nodes unless overridden by the 'kafka-<role>-X.key' and 'kafka-<role>-X.crt' files
339 ## @param tls.autoGenerated Generate automatically self-signed TLS certificates for Kafka brokers. Currently only supported if `tls.type` is `PEM`
340 ## Note: ignored when using 'jks' format or `tls.existingSecret` is not empty
343 ## @param tls.customAltNames Optionally specify extra list of additional subject alternative names (SANs) for the automatically generated TLS certificates.
346 ## @param tls.passwordsSecret Name of the secret containing the password to access the JKS files or PEM key when they are password-protected. (`key`: `password`)
349 ## @param tls.passwordsSecretKeystoreKey The secret key from the tls.passwordsSecret containing the password for the Keystore.
351 passwordsSecretKeystoreKey: keystore-password
352 ## @param tls.passwordsSecretTruststoreKey The secret key from the tls.passwordsSecret containing the password for the Truststore.
354 passwordsSecretTruststoreKey: truststore-password
355 ## @param tls.passwordsSecretPemPasswordKey The secret key from the tls.passwordsSecret containing the password for the PEM key inside 'tls.passwordsSecret'.
357 passwordsSecretPemPasswordKey: ""
358 ## @param tls.keystorePassword Password to access the JKS keystore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided.
359 ## When using tls.type=PEM, the generated keystore will use this password or randomly generate one.
362 ## @param tls.truststorePassword Password to access the JKS truststore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided.
363 ## When using tls.type=PEM, the generated keystore will use this password or randomly generate one.
365 truststorePassword: ""
366 ## @param tls.keyPassword Password to access the PEM key when it is password-protected.
367 ## Note: ignored when using 'tls.passwordsSecret'
370 ## @param tls.jksKeystoreKey The secret key from the `tls.existingSecret` containing the keystore
371 ## Note: ignored when using 'pem' format for certificates.
374 ## @param tls.jksTruststoreSecret Name of the existing secret containing your truststore if truststore not existing or different from the one in the `tls.existingSecret`
375 ## Note: ignored when using 'pem' format for certificates.
377 jksTruststoreSecret: ""
378 ## @param tls.jksTruststoreKey The secret key from the `tls.existingSecret` or `tls.jksTruststoreSecret` containing the truststore
379 ## Note: ignored when using 'pem' format for certificates.
382 ## @param tls.endpointIdentificationAlgorithm The endpoint identification algorithm to validate server hostname using server certificate
383 ## Disable server host name verification by setting it to an empty string.
384 ## ref: https://docs.confluent.io/current/kafka/authentication_ssl.html#optional-settings
386 endpointIdentificationAlgorithm: https
387 ## @param tls.sslClientAuth Sets the default value for the ssl.client.auth Kafka setting.
388 ## ref: https://docs.confluent.io/current/kafka/authentication_ssl.html#optional-settings
390 sslClientAuth: "required"
391 ## Zookeeper TLS connection configuration for Kafka
394 ## @param tls.zookeeper.enabled Enable TLS for Zookeeper client connections.
397 ## @param tls.zookeeper.verifyHostname Hostname validation.
400 ## @param tls.zookeeper.existingSecret Name of the existing secret containing the TLS certificates for ZooKeeper client communications.
403 ## @param tls.zookeeper.existingSecretKeystoreKey The secret key from the tls.zookeeper.existingSecret containing the Keystore.
405 existingSecretKeystoreKey: zookeeper.keystore.jks
406 ## @param tls.zookeeper.existingSecretTruststoreKey The secret key from the tls.zookeeper.existingSecret containing the Truststore.
408 existingSecretTruststoreKey: zookeeper.truststore.jks
409 ## @param tls.zookeeper.passwordsSecret Existing secret containing Keystore and Truststore passwords.
412 ## @param tls.zookeeper.passwordsSecretKeystoreKey The secret key from the tls.zookeeper.passwordsSecret containing the password for the Keystore.
413 ## If no keystore password is included in the passwords secret, set this value to an empty string.
415 passwordsSecretKeystoreKey: keystore-password
416 ## @param tls.zookeeper.passwordsSecretTruststoreKey The secret key from the tls.zookeeper.passwordsSecret containing the password for the Truststore.
417 ## If no truststore password is included in the passwords secret, set this value to an empty string.
419 passwordsSecretTruststoreKey: truststore-password
420 ## @param tls.zookeeper.keystorePassword Password to access the JKS keystore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided.
421 ## When using tls.type=PEM, the generated keystore will use this password or randomly generate one.
424 ## @param tls.zookeeper.truststorePassword Password to access the JKS truststore when it is password-protected. Ignored when 'tls.passwordsSecret' is provided.
425 ## When using tls.type=PEM, the generated keystore will use this password or randomly generate one.
427 truststorePassword: ""
428## @param extraEnvVars Extra environment variables to add to Kafka pods
431## - name: KAFKA_CFG_BACKGROUND_THREADS
435## @param extraEnvVarsCM ConfigMap with extra environment variables
438## @param extraEnvVarsSecret Secret with extra environment variables
440extraEnvVarsSecret: ""
441## @param extraVolumes Optionally specify extra list of additional volumes for the Kafka pod(s)
446## secretName: kafka-jaas
449## @param extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Kafka container(s)
452## mountPath: /iamguarded/kafka/config/kafka_jaas.conf
453## subPath: kafka_jaas.conf
456## @param sidecars Add additional sidecar containers to the Kafka pod(s)
459## - name: your-image-name
461## imagePullPolicy: Always
464## containerPort: 1234
467## @param initContainers Add additional Add init containers to the Kafka pod(s)
470## - name: your-image-name
472## imagePullPolicy: Always
475## containerPort: 1234
479## Ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
480## @param dnsPolicy Specifies the DNS policy for the zookeeper pods
481## DNS policies can be set on a per-Pod basis. Currently Kubernetes supports the following Pod-specific DNS policies.
482## Available options: Default, ClusterFirst, ClusterFirstWithHostNet, None
483## Ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy
485## @param dnsConfig allows users more control on the DNS settings for a Pod. Required if `dnsPolicy` is set to `None`
486## The dnsConfig field is optional and it can work with any dnsPolicy settings.
487## Ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-config
491## - 192.0.2.1 # this is an example
493## - ns1.svc.cluster-domain.example
494## - my.dns.search.suffix
500## @section Controller-eligible statefulset parameters
503 ## @param controller.replicaCount Number of Kafka controller-eligible nodes
504 ## Ignore this section if running in Zookeeper mode.
507 ## @param controller.controllerOnly If set to true, controller nodes will be deployed as dedicated controllers, instead of controller+broker processes.
509 controllerOnly: false
510 ## @param controller.minId Minimal node.id values for controller-eligible nodes. Do not change after first initialization.
511 ## Broker-only id increment their ID starting at this minimal value.
512 ## We recommend setting this this value high enough, as IDs under this value will be used by controller-elegible nodes
515 ## @param controller.zookeeperMigrationMode Set to true to deploy cluster controller quorum
516 ## This allows configuring both kraft and zookeeper modes simultaneously in order to perform the migration of the Kafka metadata.
517 ## Ref. https://docs.confluent.io/platform/current/installation/migrate-zk-kraft.html
519 zookeeperMigrationMode: false
520 ## @param controller.config Configuration file for Kafka controller-eligible nodes, rendered as a template. Auto-generated based on chart values when not specified.
521 ## @param controller.existingConfigmap ConfigMap with Kafka Configuration for controller-eligible nodes.
522 ## NOTE: This will override the configuration based on values, please act carefully
523 ## If both are set, the existingConfigMap will be used.
526 existingConfigmap: ""
527 ## @param controller.extraConfig Additional configuration to be appended at the end of the generated Kafka controller-eligible nodes configuration file.
530 ## @param controller.extraConfigYaml Additional configuration in yaml format to be appended at the end of the generated Kafka controller-eligible nodes configuration file.
531 ## If keys of extraConfigYaml are duplicated here, the value from controller.extraConfigYaml is taken.
534 ## @param controller.secretConfig Additional configuration to be appended at the end of the generated Kafka controller-eligible nodes configuration file.
535 ## This value will be stored in a secret.
538 ## @param controller.existingSecretConfig Secret with additonal configuration that will be appended to the end of the generated Kafka controller-eligible nodes configuration file
539 ## The key for the configuration should be: server-secret.properties
540 ## NOTE: This will override controller.secretConfig value
542 existingSecretConfig: ""
543 ## @param controller.heapOpts Kafka Java Heap size for controller-eligible nodes
545 heapOpts: -Xmx1024m -Xms1024m
546 ## @param controller.command Override Kafka container command
549 ## @param controller.args Override Kafka container arguments
552 ## @param controller.extraEnvVars Extra environment variables to add to Kafka pods
555 ## - name: KAFKA_CFG_BACKGROUND_THREADS
559 ## @param controller.extraEnvVarsCM ConfigMap with extra environment variables
562 ## @param controller.extraEnvVarsSecret Secret with extra environment variables
564 extraEnvVarsSecret: ""
565 ## @param controller.extraContainerPorts Kafka controller-eligible extra containerPorts.
567 extraContainerPorts: []
568 ## Configure extra options for Kafka containers' liveness, readiness and startup probes
569 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes
570 ## @param controller.livenessProbe.enabled Enable livenessProbe on Kafka containers
571 ## @param controller.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
572 ## @param controller.livenessProbe.periodSeconds Period seconds for livenessProbe
573 ## @param controller.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
574 ## @param controller.livenessProbe.failureThreshold Failure threshold for livenessProbe
575 ## @param controller.livenessProbe.successThreshold Success threshold for livenessProbe
579 initialDelaySeconds: 10
584 ## @param controller.readinessProbe.enabled Enable readinessProbe on Kafka containers
585 ## @param controller.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
586 ## @param controller.readinessProbe.periodSeconds Period seconds for readinessProbe
587 ## @param controller.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
588 ## @param controller.readinessProbe.failureThreshold Failure threshold for readinessProbe
589 ## @param controller.readinessProbe.successThreshold Success threshold for readinessProbe
593 initialDelaySeconds: 5
598 ## @param controller.startupProbe.enabled Enable startupProbe on Kafka containers
599 ## @param controller.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe
600 ## @param controller.startupProbe.periodSeconds Period seconds for startupProbe
601 ## @param controller.startupProbe.timeoutSeconds Timeout seconds for startupProbe
602 ## @param controller.startupProbe.failureThreshold Failure threshold for startupProbe
603 ## @param controller.startupProbe.successThreshold Success threshold for startupProbe
607 initialDelaySeconds: 30
612 ## @param controller.customLivenessProbe Custom livenessProbe that overrides the default one
614 customLivenessProbe: {}
615 ## @param controller.customReadinessProbe Custom readinessProbe that overrides the default one
617 customReadinessProbe: {}
618 ## @param controller.customStartupProbe Custom startupProbe that overrides the default one
620 customStartupProbe: {}
621 ## @param controller.lifecycleHooks lifecycleHooks for the Kafka container to automate configuration before or after startup
624 ## Kafka init container resource requests and limits
625 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
626 ## @param controller.initContainerResources.limits The resources limits for the init container
627 ## @param controller.initContainerResources.requests The requested resources for the init container
629 initContainerResources:
632 ## Kafka resource requests and limits
633 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
634 ## @param 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).
636 resourcesPreset: "small"
637 ## @param controller.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
648 ## Kafka pods' Security Context
649 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
650 ## @param controller.podSecurityContext.enabled Enable security context for the pods
651 ## @param controller.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy
652 ## @param controller.podSecurityContext.sysctls Set kernel settings using the sysctl interface
653 ## @param controller.podSecurityContext.supplementalGroups Set filesystem extra groups
654 ## @param controller.podSecurityContext.fsGroup Set Kafka pod's Security Context fsGroup
655 ## @param controller.podSecurityContext.seccompProfile.type Set Kafka pods's Security Context seccomp profile
659 fsGroupChangePolicy: Always
661 supplementalGroups: []
664 type: "RuntimeDefault"
665 ## Kafka containers' Security Context
666 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
667 ## @param controller.containerSecurityContext.enabled Enable Kafka containers' Security Context
668 ## @param controller.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
669 ## @param controller.containerSecurityContext.runAsUser Set containers' Security Context runAsUser
670 ## @param controller.containerSecurityContext.runAsGroup Set containers' Security Context runAsGroup
671 ## @param controller.containerSecurityContext.runAsGroup Set Kafka containers' Security Context runAsGroup
672 ## @param controller.containerSecurityContext.runAsNonRoot Set Kafka containers' Security Context runAsNonRoot
673 ## @param controller.containerSecurityContext.allowPrivilegeEscalation Force the child process to be run as non-privileged
674 ## @param controller.containerSecurityContext.readOnlyRootFilesystem Allows the pod to mount the RootFS as ReadOnly only
675 ## @param controller.containerSecurityContext.capabilities.drop Set Kafka containers' server Security Context capabilities to be dropped
677 ## containerSecurityContext:
681 ## readOnlyRootFilesystem: true
683 containerSecurityContext:
689 allowPrivilegeEscalation: false
690 readOnlyRootFilesystem: true
693 ## @param controller.automountServiceAccountToken Mount Service Account token in pod
695 automountServiceAccountToken: false
696 ## @param controller.hostAliases Kafka pods host aliases
697 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
700 ## @param controller.hostNetwork Specify if host network should be enabled for Kafka pods
703 ## @param controller.hostIPC Specify if host IPC should be enabled for Kafka pods
706 ## @param controller.podLabels Extra labels for Kafka pods
707 ## Ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
710 ## @param controller.podAnnotations Extra annotations for Kafka pods
711 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
714 ## @param controller.podAffinityPreset Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
715 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
717 podAffinityPreset: ""
718 ## @param controller.podAntiAffinityPreset Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
719 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
721 podAntiAffinityPreset: soft
722 ## Node affinity preset
723 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
726 ## @param controller.nodeAffinityPreset.type Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
729 ## @param controller.nodeAffinityPreset.key Node label key to match Ignored if `affinity` is set.
731 ## key: "kubernetes.io/e2e-az-name"
734 ## @param controller.nodeAffinityPreset.values Node label values to match. Ignored if `affinity` is set.
741 ## @param controller.affinity Affinity for pod assignment
742 ## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
743 ## Note: podAffinityPreset, podAntiAffinityPreset, and nodeAffinityPreset will be ignored when it's set
746 ## @param controller.nodeSelector Node labels for pod assignment
747 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
750 ## @param controller.tolerations Tolerations for pod assignment
751 ## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
754 ## @param controller.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template
755 ## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/#spread-constraints-for-pods
757 topologySpreadConstraints: []
758 ## @param controller.terminationGracePeriodSeconds Seconds the pod needs to gracefully terminate
759 ## ref: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#hook-handler-execution
761 terminationGracePeriodSeconds: ""
762 ## @param controller.podManagementPolicy StatefulSet controller supports relax its ordering guarantees while preserving its uniqueness and identity guarantees. There are two valid pod management policies: OrderedReady and Parallel
763 ## ref: https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#pod-management-policy
765 podManagementPolicy: Parallel
766 ## @param controller.minReadySeconds How many seconds a pod needs to be ready before killing the next, during update
769 ## @param controller.priorityClassName Name of the existing priority class to be used by kafka pods
770 ## Ref: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
772 priorityClassName: ""
773 ## @param controller.runtimeClassName Name of the runtime class to be used by pod(s)
774 ## ref: https://kubernetes.io/docs/concepts/containers/runtime-class/
777 ## @param controller.enableServiceLinks Whether information about services should be injected into pod's environment variable
778 ## The environment variables injected by service links are not used, but can lead to slow kafka boot times or slow running of the scripts when there are many services in the current namespace.
779 ## If you experience slow pod startups or slow running of the scripts you probably want to set this to `false`.
781 enableServiceLinks: true
782 ## @param controller.schedulerName Name of the k8s scheduler (other than default)
783 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
786 ## @param controller.updateStrategy.type Kafka statefulset strategy type
787 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
791 ## @param controller.extraVolumes Optionally specify extra list of additional volumes for the Kafka pod(s)
794 ## - name: kafka-jaas
796 ## secretName: kafka-jaas
799 ## @param controller.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Kafka container(s)
800 ## extraVolumeMounts:
801 ## - name: kafka-jaas
802 ## mountPath: /iamguarded/kafka/config/kafka_jaas.conf
803 ## subPath: kafka_jaas.conf
805 extraVolumeMounts: []
806 ## @param controller.sidecars Add additional sidecar containers to the Kafka pod(s)
809 ## - name: your-image-name
811 ## imagePullPolicy: Always
814 ## containerPort: 1234
817 ## @param controller.initContainers Add additional Add init containers to the Kafka pod(s)
820 ## - name: your-image-name
822 ## imagePullPolicy: Always
825 ## containerPort: 1234
828 ## @section Experimental: Kafka Controller Autoscaling configuration
829 ## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
833 ## @param controller.autoscaling.vpa.enabled Enable VPA
836 ## @param controller.autoscaling.vpa.annotations Annotations for VPA resource
839 ## @param controller.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
841 controlledResources: []
842 ## @param controller.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
846 ## @param controller.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
851 ## @param 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
852 ## Possible values are "Off", "Initial", "Recreate", and "Auto".
856 ## @param controller.autoscaling.hpa.enabled Enable HPA for Kafka Controller
859 ## @param controller.autoscaling.hpa.minReplicas Minimum number of Kafka Controller replicas
862 ## @param controller.autoscaling.hpa.maxReplicas Maximum number of Kafka Controller replicas
865 ## @param controller.autoscaling.hpa.targetCPU Target CPU utilization percentage
868 ## @param controller.autoscaling.hpa.targetMemory Target Memory utilization percentage
871 ## Kafka Pod Disruption Budget
872 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/disruptions/
873 ## @param controller.pdb.create Deploy a pdb object for the Kafka pod
874 ## @param controller.pdb.minAvailable Minimum number/percentage of available Kafka replicas
875 ## @param controller.pdb.maxUnavailable Maximum number/percentage of unavailable Kafka replicas
881 ## Enable persistence using Persistent Volume Claims
882 ## ref: https://kubernetes.io/docs/concepts/storage/persistent-volumes/
885 ## @param controller.persistence.enabled Enable Kafka data persistence using PVC, note that ZooKeeper persistence is unaffected
888 ## @param controller.persistence.existingClaim A manually managed Persistent Volume and Claim
889 ## If defined, PVC must be created manually before volume will be bound
890 ## The value is evaluated as a template
893 ## @param controller.persistence.storageClass PVC Storage Class for Kafka data volume
894 ## If defined, storageClassName: <storageClass>
895 ## If set to "-", storageClassName: "", which disables dynamic provisioning
896 ## If undefined (the default) or set to null, no storageClassName spec is
897 ## set, choosing the default provisioner.
900 ## @param controller.persistence.accessModes Persistent Volume Access Modes
904 ## @param controller.persistence.size PVC Storage Request for Kafka data volume
907 ## @param controller.persistence.annotations Annotations for the PVC
910 ## @param controller.persistence.labels Labels for the PVC
913 ## @param 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
919 ## @param controller.persistence.mountPath Mount path of the Kafka data volume
921 mountPath: /iamguarded/kafka
922 ## Log Persistence parameters
925 ## @param controller.logPersistence.enabled Enable Kafka logs persistence using PVC, note that ZooKeeper persistence is unaffected
928 ## @param controller.logPersistence.existingClaim A manually managed Persistent Volume and Claim
929 ## If defined, PVC must be created manually before volume will be bound
930 ## The value is evaluated as a template
933 ## @param controller.logPersistence.storageClass PVC Storage Class for Kafka logs volume
934 ## If defined, storageClassName: <storageClass>
935 ## If set to "-", storageClassName: "", which disables dynamic provisioning
936 ## If undefined (the default) or set to null, no storageClassName spec is
937 ## set, choosing the default provisioner.
940 ## @param controller.logPersistence.accessModes Persistent Volume Access Modes
944 ## @param controller.logPersistence.size PVC Storage Request for Kafka logs volume
947 ## @param controller.logPersistence.annotations Annotations for the PVC
950 ## @param controller.logPersistence.selector Selector to match an existing Persistent Volume for Kafka log data PVC. If set, the PVC can't have a PV dynamically provisioned for it
956 ## @param controller.logPersistence.mountPath Mount path of the Kafka logs volume
958 mountPath: /opt/iamguarded/kafka/logs
959## @section Broker-only statefulset parameters
962 ## @param broker.replicaCount Number of Kafka broker-only nodes
965 ## @param broker.minId Minimal node.id values for broker-only nodes. Do not change after first initialization.
966 ## Broker-only id increment their ID starting at this minimal value.
967 ## We recommend setting this this value high enough, as IDs under this value will be used by controller-eligible nodes
971 ## @param broker.zookeeperMigrationMode Set to true to deploy cluster controller quorum
972 ## This allows configuring both kraft and zookeeper modes simultaneously in order to perform the migration of the Kafka metadata.
973 ## Ref. https://docs.confluent.io/platform/current/installation/migrate-zk-kraft.html
975 zookeeperMigrationMode: false
976 ## @param broker.config Configuration file for Kafka broker-only nodes, rendered as a template. Auto-generated based on chart values when not specified.
977 ## @param broker.existingConfigmap ConfigMap with Kafka Configuration for broker-only nodes.
978 ## NOTE: This will override the configuration based on values, please act carefully
979 ## If both are set, the existingConfigMap will be used.
982 existingConfigmap: ""
983 ## @param broker.extraConfig Additional configuration to be appended at the end of the generated Kafka broker-only nodes configuration file.
986 ## @param broker.extraConfigYaml Additional configuration in yaml format to be appended at the end of the generated Kafka broker-only nodes configuration file.
987 ## If keys of extraConfigYaml are duplicated here, the value from broker.extraConfigYaml is taken.
990 ## @param broker.secretConfig Additional configuration to be appended at the end of the generated Kafka broker-only nodes configuration file.
991 ## This value will be stored in a secret.
994 ## @param broker.existingSecretConfig Secret with additonal configuration that will be appended to the end of the generated Kafka broker-only nodes configuration file
995 ## The key for the configuration should be: server-secret.properties
996 ## NOTE: This will override broker.secretConfig value
998 existingSecretConfig: ""
999 ## @param broker.heapOpts Kafka Java Heap size for broker-only nodes
1001 heapOpts: -Xmx1024m -Xms1024m
1002 ## @param broker.command Override Kafka container command
1005 ## @param broker.args Override Kafka container arguments
1008 ## @param broker.extraEnvVars Extra environment variables to add to Kafka pods
1011 ## - name: KAFKA_CFG_BACKGROUND_THREADS
1015 ## @param broker.extraEnvVarsCM ConfigMap with extra environment variables
1018 ## @param broker.extraEnvVarsSecret Secret with extra environment variables
1020 extraEnvVarsSecret: ""
1021 ## @param broker.extraContainerPorts Kafka broker-only extra containerPorts.
1023 extraContainerPorts: []
1024 ## Configure extra options for Kafka containers' liveness, readiness and startup probes
1025 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes
1026 ## @param broker.livenessProbe.enabled Enable livenessProbe on Kafka containers
1027 ## @param broker.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
1028 ## @param broker.livenessProbe.periodSeconds Period seconds for livenessProbe
1029 ## @param broker.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
1030 ## @param broker.livenessProbe.failureThreshold Failure threshold for livenessProbe
1031 ## @param broker.livenessProbe.successThreshold Success threshold for livenessProbe
1035 initialDelaySeconds: 10
1040 ## @param broker.readinessProbe.enabled Enable readinessProbe on Kafka containers
1041 ## @param broker.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
1042 ## @param broker.readinessProbe.periodSeconds Period seconds for readinessProbe
1043 ## @param broker.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
1044 ## @param broker.readinessProbe.failureThreshold Failure threshold for readinessProbe
1045 ## @param broker.readinessProbe.successThreshold Success threshold for readinessProbe
1049 initialDelaySeconds: 5
1054 ## @param broker.startupProbe.enabled Enable startupProbe on Kafka containers
1055 ## @param broker.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe
1056 ## @param broker.startupProbe.periodSeconds Period seconds for startupProbe
1057 ## @param broker.startupProbe.timeoutSeconds Timeout seconds for startupProbe
1058 ## @param broker.startupProbe.failureThreshold Failure threshold for startupProbe
1059 ## @param broker.startupProbe.successThreshold Success threshold for startupProbe
1063 initialDelaySeconds: 30
1066 failureThreshold: 15
1068 ## @param broker.customLivenessProbe Custom livenessProbe that overrides the default one
1070 customLivenessProbe: {}
1071 ## @param broker.customReadinessProbe Custom readinessProbe that overrides the default one
1073 customReadinessProbe: {}
1074 ## @param broker.customStartupProbe Custom startupProbe that overrides the default one
1076 customStartupProbe: {}
1077 ## @param broker.lifecycleHooks lifecycleHooks for the Kafka container to automate configuration before or after startup
1080 ## Kafka init container resource requests and limits
1081 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
1082 ## @param broker.initContainerResources.limits The resources limits for the container
1083 ## @param broker.initContainerResources.requests The requested resources for the container
1085 initContainerResources:
1088 ## Kafka resource requests and limits
1089 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
1090 ## @param 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).
1092 resourcesPreset: "small"
1093 ## @param broker.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
1104 ## Kafka pods' Security Context
1105 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
1106 ## @param broker.podSecurityContext.enabled Enable security context for the pods
1107 ## @param broker.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy
1108 ## @param broker.podSecurityContext.sysctls Set kernel settings using the sysctl interface
1109 ## @param broker.podSecurityContext.supplementalGroups Set filesystem extra groups
1110 ## @param broker.podSecurityContext.fsGroup Set Kafka pod's Security Context fsGroup
1111 ## @param broker.podSecurityContext.seccompProfile.type Set Kafka pod's Security Context seccomp profile
1115 fsGroupChangePolicy: Always
1117 supplementalGroups: []
1120 type: "RuntimeDefault"
1121 ## Kafka containers' Security Context
1122 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
1123 ## @param broker.containerSecurityContext.enabled Enable Kafka containers' Security Context
1124 ## @param broker.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1125 ## @param broker.containerSecurityContext.runAsUser Set containers' Security Context runAsUser
1126 ## @param broker.containerSecurityContext.runAsGroup Set containers' Security Context runAsGroup
1127 ## @param broker.containerSecurityContext.runAsNonRoot Set Kafka containers' Security Context runAsNonRoot
1128 ## @param broker.containerSecurityContext.allowPrivilegeEscalation Force the child process to be run as non-privileged
1129 ## @param broker.containerSecurityContext.readOnlyRootFilesystem Allows the pod to mount the RootFS as ReadOnly only
1130 ## @param broker.containerSecurityContext.capabilities.drop Set Kafka containers' server Security Context capabilities to be dropped
1132 ## containerSecurityContext:
1135 ## drop: ["NET_RAW"]
1136 ## readOnlyRootFilesystem: true
1138 containerSecurityContext:
1144 allowPrivilegeEscalation: false
1145 readOnlyRootFilesystem: true
1148 ## @param broker.automountServiceAccountToken Mount Service Account token in pod
1150 automountServiceAccountToken: false
1151 ## @param broker.hostAliases Kafka pods host aliases
1152 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
1155 ## @param broker.hostNetwork Specify if host network should be enabled for Kafka pods
1158 ## @param broker.hostIPC Specify if host IPC should be enabled for Kafka pods
1161 ## @param broker.podLabels Extra labels for Kafka pods
1162 ## Ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1165 ## @param broker.podAnnotations Extra annotations for Kafka pods
1166 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
1169 ## @param broker.podAffinityPreset Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
1170 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
1172 podAffinityPreset: ""
1173 ## @param broker.podAntiAffinityPreset Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
1174 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
1176 podAntiAffinityPreset: soft
1177 ## Node affinity preset
1178 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
1181 ## @param broker.nodeAffinityPreset.type Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`
1184 ## @param broker.nodeAffinityPreset.key Node label key to match Ignored if `affinity` is set.
1186 ## key: "kubernetes.io/e2e-az-name"
1189 ## @param broker.nodeAffinityPreset.values Node label values to match. Ignored if `affinity` is set.
1196 ## @param broker.affinity Affinity for pod assignment
1197 ## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
1198 ## Note: podAffinityPreset, podAntiAffinityPreset, and nodeAffinityPreset will be ignored when it's set
1201 ## @param broker.nodeSelector Node labels for pod assignment
1202 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
1205 ## @param broker.tolerations Tolerations for pod assignment
1206 ## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1209 ## @param broker.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template
1210 ## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/#spread-constraints-for-pods
1212 topologySpreadConstraints: []
1213 ## @param broker.terminationGracePeriodSeconds Seconds the pod needs to gracefully terminate
1214 ## ref: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#hook-handler-execution
1216 terminationGracePeriodSeconds: ""
1217 ## @param broker.podManagementPolicy StatefulSet controller supports relax its ordering guarantees while preserving its uniqueness and identity guarantees. There are two valid pod management policies: OrderedReady and Parallel
1218 ## ref: https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#pod-management-policy
1220 podManagementPolicy: Parallel
1221 ## @param broker.minReadySeconds How many seconds a pod needs to be ready before killing the next, during update
1224 ## @param broker.priorityClassName Name of the existing priority class to be used by kafka pods
1225 ## Ref: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
1227 priorityClassName: ""
1228 ## @param broker.runtimeClassName Name of the runtime class to be used by pod(s)
1229 ## ref: https://kubernetes.io/docs/concepts/containers/runtime-class/
1231 runtimeClassName: ""
1232 ## @param broker.enableServiceLinks Whether information about services should be injected into pod's environment variable
1233 ## The environment variables injected by service links are not used, but can lead to slow kafka boot times or slow running of the scripts when there are many services in the current namespace.
1234 ## If you experience slow pod startups or slow running of the scripts you probably want to set this to `false`.
1236 enableServiceLinks: true
1237 ## @param broker.schedulerName Name of the k8s scheduler (other than default)
1238 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
1241 ## @param broker.updateStrategy.type Kafka statefulset strategy type
1242 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
1246 ## @param broker.extraVolumes Optionally specify extra list of additional volumes for the Kafka pod(s)
1249 ## - name: kafka-jaas
1251 ## secretName: kafka-jaas
1254 ## @param broker.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Kafka container(s)
1255 ## extraVolumeMounts:
1256 ## - name: kafka-jaas
1257 ## mountPath: /iamguarded/kafka/config/kafka_jaas.conf
1258 ## subPath: kafka_jaas.conf
1260 extraVolumeMounts: []
1261 ## @param broker.sidecars Add additional sidecar containers to the Kafka pod(s)
1264 ## - name: your-image-name
1265 ## image: your-image
1266 ## imagePullPolicy: Always
1269 ## containerPort: 1234
1272 ## @param broker.initContainers Add additional Add init containers to the Kafka pod(s)
1275 ## - name: your-image-name
1276 ## image: your-image
1277 ## imagePullPolicy: Always
1280 ## containerPort: 1234
1283 ## Kafka Pod Disruption Budget
1284 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/disruptions/
1285 ## @param broker.pdb.create Deploy a pdb object for the Kafka pod
1286 ## @param broker.pdb.minAvailable Maximum number/percentage of unavailable Kafka replicas
1287 ## @param broker.pdb.maxUnavailable Maximum number/percentage of unavailable Kafka replicas
1293 ## @section Experimental: Kafka Broker Autoscaling configuration
1294 ## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
1298 ## @param broker.autoscaling.vpa.enabled Enable VPA
1301 ## @param broker.autoscaling.vpa.annotations Annotations for VPA resource
1304 ## @param broker.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
1306 controlledResources: []
1307 ## @param broker.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
1311 ## @param broker.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
1316 ## @param 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
1317 ## Possible values are "Off", "Initial", "Recreate", and "Auto".
1321 ## @param broker.autoscaling.hpa.enabled Enable HPA for Kafka Broker
1324 ## @param broker.autoscaling.hpa.minReplicas Minimum number of Kafka Broker replicas
1327 ## @param broker.autoscaling.hpa.maxReplicas Maximum number of Kafka Broker replicas
1330 ## @param broker.autoscaling.hpa.targetCPU Target CPU utilization percentage
1333 ## @param broker.autoscaling.hpa.targetMemory Target Memory utilization percentage
1336 ## Enable persistence using Persistent Volume Claims
1337 ## ref: https://kubernetes.io/docs/concepts/storage/persistent-volumes/
1340 ## @param broker.persistence.enabled Enable Kafka data persistence using PVC, note that ZooKeeper persistence is unaffected
1343 ## @param broker.persistence.existingClaim A manually managed Persistent Volume and Claim
1344 ## If defined, PVC must be created manually before volume will be bound
1345 ## The value is evaluated as a template
1348 ## @param broker.persistence.storageClass PVC Storage Class for Kafka data volume
1349 ## If defined, storageClassName: <storageClass>
1350 ## If set to "-", storageClassName: "", which disables dynamic provisioning
1351 ## If undefined (the default) or set to null, no storageClassName spec is
1352 ## set, choosing the default provisioner.
1355 ## @param broker.persistence.accessModes Persistent Volume Access Modes
1359 ## @param broker.persistence.size PVC Storage Request for Kafka data volume
1362 ## @param broker.persistence.annotations Annotations for the PVC
1365 ## @param broker.persistence.labels Labels for the PVC
1368 ## @param 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
1374 ## @param broker.persistence.mountPath Mount path of the Kafka data volume
1376 mountPath: /iamguarded/kafka
1377 ## Log Persistence parameters
1380 ## @param broker.logPersistence.enabled Enable Kafka logs persistence using PVC, note that ZooKeeper persistence is unaffected
1383 ## @param broker.logPersistence.existingClaim A manually managed Persistent Volume and Claim
1384 ## If defined, PVC must be created manually before volume will be bound
1385 ## The value is evaluated as a template
1388 ## @param broker.logPersistence.storageClass PVC Storage Class for Kafka logs volume
1389 ## If defined, storageClassName: <storageClass>
1390 ## If set to "-", storageClassName: "", which disables dynamic provisioning
1391 ## If undefined (the default) or set to null, no storageClassName spec is
1392 ## set, choosing the default provisioner.
1395 ## @param broker.logPersistence.accessModes Persistent Volume Access Modes
1399 ## @param broker.logPersistence.size PVC Storage Request for Kafka logs volume
1402 ## @param broker.logPersistence.annotations Annotations for the PVC
1405 ## @param broker.logPersistence.selector Selector to match an existing Persistent Volume for Kafka log data PVC. If set, the PVC can't have a PV dynamically provisioned for it
1411 ## @param broker.logPersistence.mountPath Mount path of the Kafka logs volume
1413 mountPath: /opt/iamguarded/kafka/logs
1414## @section Traffic Exposure parameters
1417## Service parameters
1420 ## @param service.type Kubernetes Service type
1423 ## @param service.ports.client Kafka svc port for client connections
1424 ## @param service.ports.controller Kafka svc port for controller connections. It is used if "kraft.enabled: true"
1425 ## @param service.ports.interbroker Kafka svc port for inter-broker connections
1426 ## @param service.ports.external Kafka svc port for external connections
1433 ## @param service.extraPorts Extra ports to expose in the Kafka service (normally used with the `sidecar` value)
1436 ## @param service.nodePorts.client Node port for the Kafka client connections
1437 ## @param service.nodePorts.external Node port for the Kafka external connections
1438 ## NOTE: choose port between <30000-32767>
1443 ## @param service.sessionAffinity Control where client requests go, to the same pod or round-robin
1444 ## Values: ClientIP or None
1445 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/
1447 sessionAffinity: None
1448 ## @param service.sessionAffinityConfig Additional settings for the sessionAffinity
1449 ## sessionAffinityConfig:
1451 ## timeoutSeconds: 300
1453 sessionAffinityConfig: {}
1454 ## @param service.clusterIP Kafka service Cluster IP
1459 ## @param service.loadBalancerIP Kafka service Load Balancer IP
1460 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer
1463 ## @param service.loadBalancerClass Kafka service Load Balancer Class
1464 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#load-balancer-class
1466 loadBalancerClass: ""
1467 ## @param service.loadBalancerSourceRanges Kafka service Load Balancer sources
1468 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
1470 ## loadBalancerSourceRanges:
1473 loadBalancerSourceRanges: []
1474 ## @param service.allocateLoadBalancerNodePorts Whether to allocate node ports when service type is LoadBalancer
1475 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#load-balancer-nodeport-allocation
1477 allocateLoadBalancerNodePorts: true
1478 ## @param service.externalTrafficPolicy Kafka service external traffic policy
1479 ## ref https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip
1481 externalTrafficPolicy: Cluster
1482 ## @param service.annotations Additional custom annotations for Kafka service
1485 ## Headless service properties
1489 ## @param service.headless.controller.annotations Annotations for the controller-eligible headless service.
1492 ## @param service.headless.controller.labels Labels for the controller-eligible headless service.
1496 ## @param service.headless.broker.annotations Annotations for the broker-only headless service.
1499 ## @param service.headless.broker.labels Labels for the broker-only headless service.
1502 ## @param service.headless.ipFamilies IP families for the headless service
1505 ## @param service.headless.ipFamilyPolicy IP family policy for the headless service
1508## External Access to Kafka brokers configuration
1511 ## @param externalAccess.enabled Enable Kubernetes external cluster access to Kafka brokers
1514 ## External IPs auto-discovery configuration
1515 ## An init container is used to auto-detect LB IPs or node ports by querying the K8s API
1516 ## Note: RBAC might be required
1519 ## @param externalAccess.autoDiscovery.enabled Enable using an init container to auto-detect external IPs/ports by querying the K8s API
1522 ## Iamguarded Kubectl image
1523 ## @param externalAccess.autoDiscovery.image.registry [default: REGISTRY_NAME] Init container auto-discovery image registry
1524 ## @param externalAccess.autoDiscovery.image.repository [default: REPOSITORY_NAME/kubectl] Init container auto-discovery image repository
1525 ## @skip externalAccess.autoDiscovery.image.tag Init container auto-discovery image tag (immutable tags are recommended)
1526 ## @param externalAccess.autoDiscovery.image.digest Kubectl image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
1527 ## @param externalAccess.autoDiscovery.image.pullPolicy Init container auto-discovery image pull policy
1528 ## @param externalAccess.autoDiscovery.image.pullSecrets Init container auto-discovery image pull secrets
1532 repository: chainguard-private/kubectl-iamguarded
1534 digest: sha256:719de98d0968940752e42f3eee903dc8c250ff3b167f77679f6501986cf2925f
1535 ## Specify a imagePullPolicy
1536 ## ref: https://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
1538 pullPolicy: IfNotPresent
1539 ## Optionally specify an array of imagePullSecrets (secrets must be manually created in the namespace)
1540 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
1543 ## - myRegistryKeySecretName
1546 ## Init Container resource requests and limits
1547 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
1548 ## @param 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).
1550 resourcesPreset: "nano"
1551 ## @param externalAccess.autoDiscovery.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
1562 ## Kafka provisioning containers' Security Context
1563 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
1564 ## @param externalAccess.autoDiscovery.containerSecurityContext.enabled Enable Kafka auto-discovery containers' Security Context
1565 ## @param externalAccess.autoDiscovery.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1566 ## @param externalAccess.autoDiscovery.containerSecurityContext.runAsUser Set containers' Security Context runAsUser
1567 ## @param externalAccess.autoDiscovery.containerSecurityContext.runAsGroup Set containers' Security Context runAsGroup
1568 ## @param externalAccess.autoDiscovery.containerSecurityContext.runAsNonRoot Set Kafka auto-discovery containers' Security Context runAsNonRoot
1569 ## @param externalAccess.autoDiscovery.containerSecurityContext.allowPrivilegeEscalation Set Kafka auto-discovery containers' Security Context allowPrivilegeEscalation
1570 ## @param externalAccess.autoDiscovery.containerSecurityContext.readOnlyRootFilesystem Set Kafka auto-discovery containers' Security Context readOnlyRootFilesystem
1571 ## @param externalAccess.autoDiscovery.containerSecurityContext.capabilities.drop Set Kafka auto-discovery containers' Security Context capabilities to be dropped
1572 ## @param externalAccess.autoDiscovery.containerSecurityContext.seccompProfile.type Set Kafka auto-discovery seccomp profile type
1574 ## containerSecurityContext:
1577 ## drop: ["NET_RAW"]
1578 ## readOnlyRootFilesystem: true
1580 containerSecurityContext:
1586 allowPrivilegeEscalation: false
1587 readOnlyRootFilesystem: true
1591 type: "RuntimeDefault"
1594 ## @param externalAccess.controller.forceExpose If set to true, force exposing controller-eligible nodes although they are configured as controller-only nodes
1597 ## Parameters to configure K8s service(s) used to externally access Kafka brokers
1598 ## Note: A new service per broker will be created
1601 ## @param externalAccess.controller.service.type Kubernetes Service type for external access. It can be NodePort, LoadBalancer or ClusterIP
1604 ## @param externalAccess.controller.service.ports.external Kafka port used for external access when service type is LoadBalancer
1608 ## @param externalAccess.controller.service.loadBalancerClass Kubernetes Service Load Balancer class for external access when service type is LoadBalancer
1609 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#load-balancer-class
1611 loadBalancerClass: ""
1612 ## @param externalAccess.controller.service.loadBalancerIPs Array of load balancer IPs for each Kafka broker. Length must be the same as replicaCount
1619 ## @param externalAccess.controller.service.loadBalancerNames Array of load balancer Names for each Kafka broker. Length must be the same as replicaCount
1621 ## loadBalancerNames:
1622 ## - broker1.external.example.com
1623 ## - broker2.external.example.com
1625 loadBalancerNames: []
1626 ## @param externalAccess.controller.service.loadBalancerAnnotations Array of load balancer annotations for each Kafka broker. Length must be the same as replicaCount
1628 ## loadBalancerAnnotations:
1629 ## - external-dns.alpha.kubernetes.io/hostname: broker1.external.example.com.
1630 ## - external-dns.alpha.kubernetes.io/hostname: broker2.external.example.com.
1632 loadBalancerAnnotations: []
1633 ## @param externalAccess.controller.service.loadBalancerSourceRanges Address(es) that are allowed when service is LoadBalancer
1634 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
1636 ## loadBalancerSourceRanges:
1639 loadBalancerSourceRanges: []
1640 ## @param externalAccess.controller.service.allocateLoadBalancerNodePorts Whether to allocate node ports when service type is LoadBalancer
1641 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#load-balancer-nodeport-allocation
1643 allocateLoadBalancerNodePorts: true
1644 ## @param externalAccess.controller.service.nodePorts Array of node ports used for each Kafka broker. Length must be the same as replicaCount
1651 ## @param 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
1658 ## @param externalAccess.controller.service.useHostIPs Use service host IPs to configure Kafka external listener when service type is NodePort
1661 ## @param externalAccess.controller.service.usePodIPs using the MY_POD_IP address for external access.
1664 ## @param externalAccess.controller.service.domain Domain or external ip used to configure Kafka external listener when service type is NodePort or ClusterIP
1665 ## NodePort: If not specified, the container will try to get the kubernetes node external IP
1666 ## ClusterIP: Must be specified, ingress IP or domain where tcp for external ports is configured
1669 ## @param externalAccess.controller.service.publishNotReadyAddresses Indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready
1670 ## ref: https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/
1672 publishNotReadyAddresses: false
1673 ## @param externalAccess.controller.service.labels Service labels for external access
1676 ## @param externalAccess.controller.service.annotations Service annotations for external access
1679 ## @param externalAccess.controller.service.extraPorts Extra ports to expose in the Kafka external service
1682 ## @param externalAccess.controller.service.ipFamilies IP families for the external controller service
1685 ## @param externalAccess.controller.service.ipFamilyPolicy IP family policy for the external controller service
1689 ## Parameters to configure K8s service(s) used to externally access Kafka brokers
1690 ## Note: A new service per broker will be created
1693 ## @param externalAccess.broker.service.type Kubernetes Service type for external access. It can be NodePort, LoadBalancer or ClusterIP
1696 ## @param externalAccess.broker.service.ports.external Kafka port used for external access when service type is LoadBalancer
1700 ## @param externalAccess.broker.service.loadBalancerClass Kubernetes Service Load Balancer class for external access when service type is LoadBalancer
1701 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#load-balancer-class
1703 loadBalancerClass: ""
1704 ## @param externalAccess.broker.service.loadBalancerIPs Array of load balancer IPs for each Kafka broker. Length must be the same as replicaCount
1711 ## @param externalAccess.broker.service.loadBalancerNames Array of load balancer Names for each Kafka broker. Length must be the same as replicaCount
1713 ## loadBalancerNames:
1714 ## - broker1.external.example.com
1715 ## - broker2.external.example.com
1717 loadBalancerNames: []
1718 ## @param externalAccess.broker.service.loadBalancerAnnotations Array of load balancer annotations for each Kafka broker. Length must be the same as replicaCount
1720 ## loadBalancerAnnotations:
1721 ## - external-dns.alpha.kubernetes.io/hostname: broker1.external.example.com.
1722 ## - external-dns.alpha.kubernetes.io/hostname: broker2.external.example.com.
1724 loadBalancerAnnotations: []
1725 ## @param externalAccess.broker.service.loadBalancerSourceRanges Address(es) that are allowed when service is LoadBalancer
1726 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
1728 ## loadBalancerSourceRanges:
1731 loadBalancerSourceRanges: []
1732 ## @param externalAccess.broker.service.allocateLoadBalancerNodePorts Whether to allocate node ports when service type is LoadBalancer
1733 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#load-balancer-nodeport-allocation
1735 allocateLoadBalancerNodePorts: true
1736 ## @param externalAccess.broker.service.nodePorts Array of node ports used for each Kafka broker. Length must be the same as replicaCount
1743 ## @param 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
1750 ## @param externalAccess.broker.service.useHostIPs Use service host IPs to configure Kafka external listener when service type is NodePort
1753 ## @param externalAccess.broker.service.usePodIPs using the MY_POD_IP address for external access.
1756 ## @param externalAccess.broker.service.domain Domain or external ip used to configure Kafka external listener when service type is NodePort or ClusterIP
1757 ## NodePort: If not specified, the container will try to get the kubernetes node external IP
1758 ## ClusterIP: Must be specified, ingress IP or domain where tcp for external ports is configured
1761 ## @param externalAccess.broker.service.publishNotReadyAddresses Indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready
1762 ## ref: https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/
1764 publishNotReadyAddresses: false
1765 ## @param externalAccess.broker.service.labels Service labels for external access
1768 ## @param externalAccess.broker.service.annotations Service annotations for external access
1771 ## @param externalAccess.broker.service.extraPorts Extra ports to expose in the Kafka external service
1774 ## @param externalAccess.broker.service.ipFamilies IP families for the external broker service
1777 ## @param externalAccess.broker.service.ipFamilyPolicy IP family policy for the external broker service
1781## Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
1784 ## @param networkPolicy.enabled Specifies whether a NetworkPolicy should be created
1787 ## @param networkPolicy.allowExternal Don't require client label for connections
1788 ## When set to false, only pods with the correct client label will have network access to the port Redis® is
1789 ## listening on. When true, zookeeper accept connections from any source (with the correct destination port).
1792 ## @param networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
1794 allowExternalEgress: true
1795 ## @param networkPolicy.addExternalClientAccess Allow access from pods with client label set to "true". Ignored if `networkPolicy.allowExternal` is true.
1797 addExternalClientAccess: true
1798 ## @param networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
1808 ## - matchExpressions:
1814 ## @param networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy
1824 ## - matchExpressions:
1831 ## @param networkPolicy.ingressPodMatchLabels [object] Labels to match to allow traffic from other pods. Ignored if `networkPolicy.allowExternal` is true.
1833 ## ingressPodMatchLabels:
1834 ## my-client: "true"
1836 ingressPodMatchLabels: {}
1837 ## @param networkPolicy.ingressNSMatchLabels [object] Labels to match to allow traffic from other namespaces. Ignored if `networkPolicy.allowExternal` is true.
1838 ## @param networkPolicy.ingressNSPodMatchLabels [object] Pod labels to match to allow traffic from other namespaces. Ignored if `networkPolicy.allowExternal` is true.
1840 ingressNSMatchLabels: {}
1841 ingressNSPodMatchLabels: {}
1842## @section Volume Permissions parameters
1845## Init containers parameters:
1846## volumePermissions: Change the owner and group of the persistent volume(s) mountpoint(s) to 'runAsUser:fsGroup' on each node
1849 ## @param volumePermissions.enabled Enable init container that changes the owner and group of the persistent volume
1852 ## @param volumePermissions.image.registry [default: REGISTRY_NAME] Init container volume-permissions image registry
1853 ## @param volumePermissions.image.repository [default: REPOSITORY_NAME/os-shell] Init container volume-permissions image repository
1854 ## @skip volumePermissions.image.tag Init container volume-permissions image tag (immutable tags are recommended)
1855 ## @param volumePermissions.image.digest Init container volume-permissions image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
1856 ## @param volumePermissions.image.pullPolicy Init container volume-permissions image pull policy
1857 ## @param volumePermissions.image.pullSecrets Init container volume-permissions image pull secrets
1861 repository: chainguard-private/os-shell-iamguarded
1863 digest: sha256:df0339a4444737da04788f23e426c7dd04ef4d4cb171368914a4c4e5b045e9ec
1864 pullPolicy: IfNotPresent
1865 ## Optionally specify an array of imagePullSecrets.
1866 ## Secrets must be manually created in the namespace.
1867 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
1870 ## - myRegistryKeySecretName
1873 ## Init container resource requests and limits
1874 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
1875 ## @param 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).
1877 resourcesPreset: "nano"
1878 ## @param volumePermissions.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
1889 ## Init container' Security Context
1890 ## Note: the chown of the data folder is done to containerSecurityContext.runAsUser
1891 ## and not the below volumePermissions.containerSecurityContext.runAsUser
1892 ## @param volumePermissions.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1893 ## @param volumePermissions.containerSecurityContext.runAsUser User ID for the init container
1895 containerSecurityContext:
1898## @section Other Parameters
1901## ServiceAccount for Kafka
1902## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
1905 ## @param serviceAccount.create Enable creation of ServiceAccount for Kafka pods
1908 ## @param serviceAccount.name The name of the service account to use. If not set and `create` is `true`, a name is generated
1909 ## If not set and create is true, a name is generated using the kafka.serviceAccountName template
1912 ## @param serviceAccount.automountServiceAccountToken Allows auto mount of ServiceAccountToken on the serviceAccount created
1913 ## Can be set to false if pods using this serviceAccount do not need to use K8s API
1915 automountServiceAccountToken: false
1916 ## @param serviceAccount.annotations Additional custom annotations for the ServiceAccount
1919## Role Based Access Control
1920## ref: https://kubernetes.io/docs/admin/authorization/rbac/
1923 ## @param rbac.create Whether to create & use RBAC resources or not
1924 ## binding Kafka ServiceAccount to a role
1925 ## that allows Kafka pods querying the K8s API
1928## @section Metrics parameters
1931## Prometheus Exporters / Metrics
1934 ## Prometheus JMX exporter: exposes the majority of Kafka metrics
1937 ## @param metrics.jmx.enabled Whether or not to expose JMX metrics to Prometheus
1940 ## @param metrics.jmx.kafkaJmxPort JMX port where the exporter will collect metrics, exposed in the Kafka container.
1943 ## Iamguarded JMX exporter image
1944 ## @param metrics.jmx.image.registry [default: REGISTRY_NAME] JMX exporter image registry
1945 ## @param metrics.jmx.image.repository [default: REPOSITORY_NAME/jmx-exporter] JMX exporter image repository
1946 ## @skip metrics.jmx.image.tag JMX exporter image tag (immutable tags are recommended)
1947 ## @param metrics.jmx.image.digest JMX exporter image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
1948 ## @param metrics.jmx.image.pullPolicy JMX exporter image pull policy
1949 ## @param metrics.jmx.image.pullSecrets Specify docker-registry secret names as an array
1953 repository: chainguard-private/jmx-exporter-iamguarded
1955 digest: sha256:397a95a9726337c8ef6c022dc1df862e6b527d920defe54a7f28c663ea220db6
1956 ## Specify a imagePullPolicy
1957 ## ref: https://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
1959 pullPolicy: IfNotPresent
1960 ## Optionally specify an array of imagePullSecrets (secrets must be manually created in the namespace)
1961 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
1964 ## - myRegistryKeySecretName
1967 ## Prometheus JMX exporter containers' Security Context
1968 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
1969 ## @param metrics.jmx.containerSecurityContext.enabled Enable Prometheus JMX exporter containers' Security Context
1970 ## @param metrics.jmx.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1971 ## @param metrics.jmx.containerSecurityContext.runAsUser Set containers' Security Context runAsUser
1972 ## @param metrics.jmx.containerSecurityContext.runAsGroup Set containers' Security Context runAsGroup
1973 ## @param metrics.jmx.containerSecurityContext.runAsNonRoot Set Prometheus JMX exporter containers' Security Context runAsNonRoot
1974 ## @param metrics.jmx.containerSecurityContext.allowPrivilegeEscalation Set Prometheus JMX exporter containers' Security Context allowPrivilegeEscalation
1975 ## @param metrics.jmx.containerSecurityContext.readOnlyRootFilesystem Set Prometheus JMX exporter containers' Security Context readOnlyRootFilesystem
1976 ## @param metrics.jmx.containerSecurityContext.capabilities.drop Set Prometheus JMX exporter containers' Security Context capabilities to be dropped
1978 ## containerSecurityContext:
1981 ## drop: ["NET_RAW"]
1982 ## readOnlyRootFilesystem: true
1984 containerSecurityContext:
1990 allowPrivilegeEscalation: false
1991 readOnlyRootFilesystem: true
1994 ## @param metrics.jmx.containerPorts.metrics Prometheus JMX exporter metrics container port
1998 ## Prometheus JMX exporter resource requests and limits
1999 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
2000 ## @param metrics.jmx.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if metrics.jmx.resources is set (metrics.jmx.resources is recommended for production).
2002 resourcesPreset: "micro"
2003 ## @param metrics.jmx.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
2014 ## Configure extra options for liveness probe
2015 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes
2016 ## @param metrics.jmx.livenessProbe.enabled Enable livenessProbe
2017 ## @param metrics.jmx.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
2018 ## @param metrics.jmx.livenessProbe.periodSeconds Period seconds for livenessProbe
2019 ## @param metrics.jmx.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
2020 ## @param metrics.jmx.livenessProbe.failureThreshold Failure threshold for livenessProbe
2021 ## @param metrics.jmx.livenessProbe.successThreshold Success threshold for livenessProbe
2025 initialDelaySeconds: 60
2030 ## Configure extra options for readiness probe
2031 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes
2032 ## @param metrics.jmx.readinessProbe.enabled Enable readinessProbe
2033 ## @param metrics.jmx.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
2034 ## @param metrics.jmx.readinessProbe.periodSeconds Period seconds for readinessProbe
2035 ## @param metrics.jmx.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
2036 ## @param metrics.jmx.readinessProbe.failureThreshold Failure threshold for readinessProbe
2037 ## @param metrics.jmx.readinessProbe.successThreshold Success threshold for readinessProbe
2041 initialDelaySeconds: 30
2046 ## Prometheus JMX exporter service configuration
2049 ## @param metrics.jmx.service.ports.metrics Prometheus JMX exporter metrics service port
2053 ## @param metrics.jmx.service.clusterIP Static clusterIP or None for headless services
2054 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#choosing-your-own-ip-address
2057 ## @param metrics.jmx.service.sessionAffinity Control where client requests go, to the same pod or round-robin
2058 ## Values: ClientIP or None
2059 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/
2061 sessionAffinity: None
2062 ## @param metrics.jmx.service.annotations [object] Annotations for the Prometheus JMX exporter service
2065 prometheus.io/scrape: "true"
2066 prometheus.io/port: "{{ .Values.metrics.jmx.service.ports.metrics }}"
2067 prometheus.io/path: "/metrics"
2068 ## @param metrics.jmx.service.ipFamilies IP families for the jmx metrics service
2071 ## @param metrics.jmx.service.ipFamilyPolicy IP family policy for the jmx metrics service
2074 ## @param metrics.jmx.whitelistObjectNames Allows setting which JMX objects you want to expose to via JMX stats to JMX exporter
2075 ## Only whitelisted values will be exposed via JMX exporter. They must also be exposed via Rules. To expose all metrics
2076 ## (warning its crazy excessive and they aren't formatted in a prometheus style) (1) `whitelistObjectNames: []`
2077 ## (2) commented out above `overrideConfig`.
2079 whitelistObjectNames:
2080 - kafka.controller:*
2085 ## @param metrics.jmx.config [string] Configuration file for JMX exporter
2086 ## Specify content for jmx-kafka-prometheus.yml. Evaluated as a template
2088 ## Credits to the incubator/kafka chart for the JMX configuration.
2089 ## https://github.com/helm/charts/tree/master/incubator/kafka
2092 jmxUrl: service:jmx:rmi:///jndi/rmi://127.0.0.1:{{ .Values.metrics.jmx.kafkaJmxPort }}/jmxrmi
2093 lowercaseOutputName: true
2094 lowercaseOutputLabelNames: true
2096 {{- if .Values.metrics.jmx.whitelistObjectNames }}
2097 whitelistObjectNames: ["{{ join "\",\"" .Values.metrics.jmx.whitelistObjectNames }}"]
2099 ## @param metrics.jmx.existingConfigmap Name of existing ConfigMap with JMX exporter configuration
2100 ## NOTE: This will override metrics.jmx.config
2102 existingConfigmap: ""
2103 ## @param metrics.jmx.extraRules Add extra rules to JMX exporter configuration
2106 ## - pattern: kafka.server<type=socket-server-metrics, listener=(.+), networkProcessor=(.+)><>(connection-count)
2107 ## name: kafka_server_socket_server_metrics_$3
2112 ## Prometheus Operator ServiceMonitor configuration
2115 ## @param metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (requires `metrics.jmx.enabled` to be `true`)
2118 ## @param metrics.serviceMonitor.namespace Namespace in which Prometheus is running
2121 ## @param metrics.serviceMonitor.path Path where JMX exporter serves metrics
2124 ## @param metrics.serviceMonitor.interval Interval at which metrics should be scraped
2125 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
2128 ## @param metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended
2129 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
2132 ## @param metrics.serviceMonitor.labels Additional labels that can be used so ServiceMonitor will be discovered by Prometheus
2135 ## @param metrics.serviceMonitor.selector Prometheus instance selector labels
2138 ## @param metrics.serviceMonitor.relabelings RelabelConfigs to apply to samples before scraping
2141 ## @param metrics.serviceMonitor.metricRelabelings MetricRelabelConfigs to apply to samples before ingestion
2143 metricRelabelings: []
2144 ## @param metrics.serviceMonitor.honorLabels Specify honorLabels parameter to add the scrape endpoint
2147 ## @param metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in prometheus.
2151 ## @param metrics.prometheusRule.enabled if `true`, creates a Prometheus Operator PrometheusRule (requires `metrics.jmx.enabled` to be `true`)
2154 ## @param metrics.prometheusRule.namespace Namespace in which Prometheus is running
2157 ## @param metrics.prometheusRule.labels Additional labels that can be used so PrometheusRule will be discovered by Prometheus
2160 ## @param metrics.prometheusRule.groups Prometheus Rule Groups for Kafka
2163## @section Kafka provisioning parameters
2166## Kafka provisioning
2169 ## @param provisioning.enabled Enable kafka provisioning Job
2172 ## @param provisioning.automountServiceAccountToken Mount Service Account token in pod
2174 automountServiceAccountToken: false
2175 ## @param provisioning.numPartitions Default number of partitions for topics when unspecified
2178 ## @param provisioning.replicationFactor Default replication factor for topics when unspecified
2180 replicationFactor: 1
2181 ## @param provisioning.topics Kafka topics to provision
2182 ## - name: topic-name
2184 ## replicationFactor: 1
2185 ## ## https://kafka.apache.org/documentation/#topicconfigs
2187 ## max.message.bytes: 64000
2188 ## flush.messages: 1
2191 ## @param provisioning.nodeSelector Node labels for pod assignment
2192 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
2195 ## @param provisioning.tolerations Tolerations for pod assignment
2196 ## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
2199 ## @param provisioning.extraProvisioningCommands Extra commands to run to provision cluster resources
2200 ## - echo "Allow user to consume from any topic"
2202 ## /opt/iamguarded/kafka/bin/kafka-acls.sh
2203 ## --bootstrap-server $KAFKA_SERVICE
2204 ## --command-config $CLIENT_CONF
2206 ## --allow-principal User:user
2207 ## --consumer --topic *
2208 ## - "/opt/iamguarded/kafka/bin/kafka-acls.sh
2209 ## --bootstrap-server $KAFKA_SERVICE
2210 ## --command-config $CLIENT_CONF
2213 extraProvisioningCommands: []
2214 ## @param provisioning.parallel Number of provisioning commands to run at the same time
2217 ## @param provisioning.preScript Extra bash script to run before topic provisioning. $CLIENT_CONF is path to properties file with most needed configurations
2220 ## @param provisioning.postScript Extra bash script to run after topic provisioning. $CLIENT_CONF is path to properties file with most needed configurations
2223 ## Auth Configuration for kafka provisioning Job
2226 ## TLS configuration for kafka provisioning Job
2229 ## @param provisioning.auth.tls.type Format to use for TLS certificates. Allowed types: `JKS` and `PEM`.
2230 ## Note: ignored if auth.tls.client.protocol different from one of these values: "SSL" "SASL_SSL"
2233 ## @param provisioning.auth.tls.certificatesSecret Existing secret containing the TLS certificates for the Kafka provisioning Job.
2234 ## When using 'jks' format for certificates, the secret should contain a truststore and a keystore.
2235 ## When using 'pem' format for certificates, the secret should contain one of the following:
2236 ## 1. A public CA certificate, a public certificate and one private key.
2237 ## 2. A truststore and a keystore in PEM format
2238 ## If caCert is set, option 1 will be taken, otherwise option 2.
2240 certificatesSecret: ""
2241 ## @param provisioning.auth.tls.cert The secret key from the certificatesSecret if 'cert' key different from the default (tls.crt)
2244 ## @param provisioning.auth.tls.key The secret key from the certificatesSecret if 'key' key different from the default (tls.key)
2247 ## @param provisioning.auth.tls.caCert The secret key from the certificatesSecret if 'caCert' key different from the default (ca.crt)
2250 ## @param provisioning.auth.tls.keystore The secret key from the certificatesSecret if 'keystore' key different from the default (keystore.jks)
2252 keystore: keystore.jks
2253 ## @param provisioning.auth.tls.truststore The secret key from the certificatesSecret if 'truststore' key different from the default (truststore.jks)
2255 truststore: truststore.jks
2256 ## @param provisioning.auth.tls.passwordsSecret Name of the secret containing passwords to access the JKS files or PEM key when they are password-protected.
2257 ## It should contain two keys called "keystore-password" and "truststore-password", or "key-password" if using a password-protected PEM key.
2260 ## @param provisioning.auth.tls.keyPasswordSecretKey The secret key from the passwordsSecret if 'keyPasswordSecretKey' key different from the default (key-password)
2261 ## Note: must not be used if `passwordsSecret` is not defined.
2263 keyPasswordSecretKey: key-password
2264 ## @param provisioning.auth.tls.keystorePasswordSecretKey The secret key from the passwordsSecret if 'keystorePasswordSecretKey' key different from the default (keystore-password)
2265 ## Note: must not be used if `passwordsSecret` is not defined.
2267 keystorePasswordSecretKey: keystore-password
2268 ## @param provisioning.auth.tls.truststorePasswordSecretKey The secret key from the passwordsSecret if 'truststorePasswordSecretKey' key different from the default (truststore-password)
2269 ## Note: must not be used if `passwordsSecret` is not defined.
2271 truststorePasswordSecretKey: truststore-password
2272 ## @param provisioning.auth.tls.keyPassword Password to access the password-protected PEM key if necessary. Ignored if 'passwordsSecret' is provided.
2275 ## @param provisioning.auth.tls.keystorePassword Password to access the JKS keystore. Ignored if 'passwordsSecret' is provided.
2277 keystorePassword: ""
2278 ## @param provisioning.auth.tls.truststorePassword Password to access the JKS truststore. Ignored if 'passwordsSecret' is provided.
2280 truststorePassword: ""
2281 ## @param provisioning.command Override provisioning container command
2284 ## @param provisioning.args Override provisioning container arguments
2287 ## @param provisioning.extraEnvVars Extra environment variables to add to the provisioning pod
2290 ## - name: KAFKA_CFG_BACKGROUND_THREADS
2294 ## @param provisioning.extraEnvVarsCM ConfigMap with extra environment variables
2297 ## @param provisioning.extraEnvVarsSecret Secret with extra environment variables
2299 extraEnvVarsSecret: ""
2300 ## @param provisioning.podAnnotations Extra annotations for Kafka provisioning pods
2303 ## @param provisioning.podLabels Extra labels for Kafka provisioning pods
2304 ## Ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
2307 ## Kafka provisioning pods ServiceAccount
2308 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
2311 ## @param provisioning.serviceAccount.create Enable creation of ServiceAccount for Kafka provisioning pods
2314 ## @param provisioning.serviceAccount.name The name of the service account to use. If not set and `create` is `true`, a name is generated
2315 ## If not set and create is true, a name is generated using the provisioning.serviceAccount.name template
2318 ## @param provisioning.serviceAccount.automountServiceAccountToken Allows auto mount of ServiceAccountToken on the serviceAccount created
2319 ## Can be set to false if pods using this serviceAccount do not need to use K8s API
2321 automountServiceAccountToken: false
2322 ## Kafka provisioning resource requests and limits
2323 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
2324 ## @param provisioning.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if provisioning.resources is set (provisioning.resources is recommended for production).
2326 resourcesPreset: "micro"
2327 ## @param provisioning.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
2338 ## Kafka provisioning pods' Security Context
2339 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
2340 ## @param provisioning.podSecurityContext.enabled Enable security context for the pods
2341 ## @param provisioning.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy
2342 ## @param provisioning.podSecurityContext.sysctls Set kernel settings using the sysctl interface
2343 ## @param provisioning.podSecurityContext.supplementalGroups Set filesystem extra groups
2344 ## @param provisioning.podSecurityContext.fsGroup Set Kafka provisioning pod's Security Context fsGroup
2345 ## @param provisioning.podSecurityContext.seccompProfile.type Set Kafka provisioning pod's Security Context seccomp profile
2349 fsGroupChangePolicy: Always
2351 supplementalGroups: []
2354 type: "RuntimeDefault"
2355 ## Kafka provisioning containers' Security Context
2356 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
2357 ## @param provisioning.containerSecurityContext.enabled Enable Kafka provisioning containers' Security Context
2358 ## @param provisioning.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
2359 ## @param provisioning.containerSecurityContext.runAsUser Set containers' Security Context runAsUser
2360 ## @param provisioning.containerSecurityContext.runAsGroup Set containers' Security Context runAsGroup
2361 ## @param provisioning.containerSecurityContext.runAsNonRoot Set Kafka provisioning containers' Security Context runAsNonRoot
2362 ## @param provisioning.containerSecurityContext.allowPrivilegeEscalation Set Kafka provisioning containers' Security Context allowPrivilegeEscalation
2363 ## @param provisioning.containerSecurityContext.readOnlyRootFilesystem Set Kafka provisioning containers' Security Context readOnlyRootFilesystem
2364 ## @param provisioning.containerSecurityContext.capabilities.drop Set Kafka provisioning containers' Security Context capabilities to be dropped
2366 ## containerSecurityContext:
2369 ## drop: ["NET_RAW"]
2370 ## readOnlyRootFilesystem: true
2372 containerSecurityContext:
2378 allowPrivilegeEscalation: false
2379 readOnlyRootFilesystem: true
2382 ## @param provisioning.schedulerName Name of the k8s scheduler (other than default) for kafka provisioning
2383 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
2386 ## @param provisioning.enableServiceLinks Whether information about services should be injected into pod's environment variable
2387 ## The environment variables injected by service links are not used, but can lead to slow kafka boot times or slow running of the scripts when there are many services in the current namespace.
2388 ## If you experience slow pod startups or slow running of the scripts you probably want to set this to `false`.
2390 enableServiceLinks: true
2391 ## @param provisioning.extraVolumes Optionally specify extra list of additional volumes for the Kafka provisioning pod(s)
2394 ## - name: kafka-jaas
2396 ## secretName: kafka-jaas
2399 ## @param provisioning.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Kafka provisioning container(s)
2400 ## extraVolumeMounts:
2401 ## - name: kafka-jaas
2402 ## mountPath: /iamguarded/kafka/config/kafka_jaas.conf
2403 ## subPath: kafka_jaas.conf
2405 extraVolumeMounts: []
2406 ## @param provisioning.sidecars Add additional sidecar containers to the Kafka provisioning pod(s)
2409 ## - name: your-image-name
2410 ## image: your-image
2411 ## imagePullPolicy: Always
2414 ## containerPort: 1234
2417 ## @param provisioning.initContainers Add additional Add init containers to the Kafka provisioning pod(s)
2420 ## - name: your-image-name
2421 ## image: your-image
2422 ## imagePullPolicy: Always
2425 ## containerPort: 1234
2428 ## @param provisioning.waitForKafka If true use an init container to wait until kafka is ready before starting provisioning
2431 ## @param provisioning.useHelmHooks Flag to indicate usage of helm hooks
2433## @section KRaft chart parameters
2435## KRaft configuration
2436## Kafka mode without Zookeeper. Kafka nodes can work as controllers in this mode.
2439 ## @param kraft.enabled Switch to enable or disable the KRaft mode for Kafka
2442 ## @param 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
2443 existingClusterIdSecret: ""
2444 ## @param kraft.clusterId Kafka Kraft cluster ID. If not set, a random cluster ID will be generated the first time Kraft is initialized.
2445 ## NOTE: Already initialized Kafka nodes will use cluster ID stored in their persisted storage.
2446 ## If reusing existing PVCs or migrating from Zookeeper mode, make sure the cluster ID is set matching the stored cluster ID, otherwise new nodes will fail to join the cluster.
2447 ## In case the cluster ID stored in the secret does not match the value stored in /iamguarded/kafka/data/meta.properties, remove the secret and upgrade the chart setting the correct value.
2450 ## @param 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.
2452 controllerQuorumVoters: ""
2453## @section ZooKeeper chart parameters
2455## @param zookeeperChrootPath Path which puts data under some path in the global ZooKeeper namespace
2456## ref: https://kafka.apache.org/documentation/#brokerconfigs_zookeeper.connect
2458zookeeperChrootPath: ""
2459## ZooKeeper chart configuration
2462 ## @param zookeeper.enabled Switch to enable or disable the ZooKeeper helm chart. Must be false if you use KRaft mode.
2465 ## @param zookeeper.replicaCount Number of ZooKeeper nodes
2468 ## ZooKeeper authentication
2472 ## @param zookeeper.auth.client.enabled Enable ZooKeeper auth
2475 ## @param zookeeper.auth.client.clientUser User that will use ZooKeeper client (zkCli.sh) to authenticate. Must exist in the serverUsers comma-separated list.
2478 ## @param zookeeper.auth.client.clientPassword Password that will use ZooKeeper client (zkCli.sh) to authenticate. Must exist in the serverPasswords comma-separated list.
2481 ## @param 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"
2484 ## @param 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"
2487 ## ZooKeeper Persistence parameters
2488 ## ref: https://kubernetes.io/docs/concepts/storage/persistent-volumes/
2489 ## @param zookeeper.persistence.enabled Enable persistence on ZooKeeper using PVC(s)
2490 ## @param zookeeper.persistence.storageClass Persistent Volume storage class
2491 ## @param zookeeper.persistence.accessModes Persistent Volume access modes
2492 ## @param zookeeper.persistence.size Persistent Volume size
2500## External Zookeeper Configuration
2503 ## @param externalZookeeper.servers List of external zookeeper servers to use. Typically used in combination with 'zookeeperChrootPath'. Must be empty if you use KRaft mode.