Kafka

kafka.strimzi.io / v1

apiVersion: kafka.strimzi.io/v1 kind: Kafka metadata: name: example

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

The specification of the Kafka cluster.

clientsCa object

Configuration of the clients certificate authority.

certificateExpirationPolicy string

How should CA certificate expiration be handled when `generateCertificateAuthority=true`. The default is for a new CA certificate to be generated reusing the existing private key.

enum: renew-certificate, replace-key

generateCertificateAuthority boolean

If true then Certificate Authority certificates will be generated automatically. Otherwise the user will need to provide a Secret with the CA certificate. Default is true.

generateSecretOwnerReference boolean

If `true`, the Cluster and Client CA Secrets are configured with the `ownerReference` set to the `Kafka` resource. If the `Kafka` resource is deleted when `true`, the CA Secrets are also deleted. If `false`, the `ownerReference` is disabled. If the `Kafka` resource is deleted when `false`, the CA Secrets are retained and available for reuse. Default is `true`.

renewalDays integer

The number of days in the certificate renewal period. This is the number of days before the a certificate expires during which renewal actions may be performed. When `generateCertificateAuthority` is true, this will cause the generation of a new certificate. When `generateCertificateAuthority` is true, this will cause extra logging at WARN level about the pending certificate expiry. Default is 30.

minimum: 1

validityDays integer

The number of days generated certificates should be valid for. The default is 365.

minimum: 1

clusterCa object

Configuration of the cluster certificate authority.

certificateExpirationPolicy string

How should CA certificate expiration be handled when `generateCertificateAuthority=true`. The default is for a new CA certificate to be generated reusing the existing private key.

enum: renew-certificate, replace-key

generateCertificateAuthority boolean

If true then Certificate Authority certificates will be generated automatically. Otherwise the user will need to provide a Secret with the CA certificate. Default is true.

generateSecretOwnerReference boolean

renewalDays integer

minimum: 1

validityDays integer

The number of days generated certificates should be valid for. The default is 365.

minimum: 1

cruiseControl object

Configuration for Cruise Control deployment. Deploys a Cruise Control instance when specified.

apiUsers object

Configuration of the Cruise Control REST API users.

type string required

Type of the Cruise Control API users configuration. Supported format is: `hashLoginService`.

enum: hashLoginService

valueFrom object required

Secret from which the custom Cruise Control API authentication credentials are read.

secretKeyRef object

Selects a key of a Secret in the resource's namespace.

key string

name string

optional boolean

autoRebalance []object

Auto-rebalancing on scaling related configuration listing the modes, when brokers are added or removed, with the corresponding rebalance template configurations.If this field is set, at least one mode has to be defined.

minItems: 1

mode string required

Specifies the mode for automatically rebalancing when brokers are added or removed. Supported modes are `add-brokers` and `remove-brokers`.

enum: add-brokers, remove-brokers

template object

Reference to the KafkaRebalance custom resource to be used as the configuration template for the auto-rebalancing on scaling when running for the corresponding mode.

name string

brokerCapacity object

The Cruise Control `brokerCapacity` configuration.

cpu string

Broker capacity for CPU resource in cores or millicores. For example, 1, 1.500, 1500m. For more information on valid CPU resource units see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu.

pattern: ^[0-9]+([.][0-9]{0,3}|[m]?)$

inboundNetwork string

Broker capacity for inbound network throughput in bytes per second. Use an integer value with standard Kubernetes byte units (K, M, G) or their bibyte (power of two) equivalents (Ki, Mi, Gi) per second. For example, 10000KiB/s.

pattern: ^[0-9]+([KMG]i?)?B/s$

outboundNetwork string

Broker capacity for outbound network throughput in bytes per second. Use an integer value with standard Kubernetes byte units (K, M, G) or their bibyte (power of two) equivalents (Ki, Mi, Gi) per second. For example, 10000KiB/s.

pattern: ^[0-9]+([KMG]i?)?B/s$

overrides []object

Overrides for individual brokers. The `overrides` property lets you specify a different capacity configuration for different brokers.

brokers []integer required

List of Kafka brokers (broker identifiers).

cpu string

pattern: ^[0-9]+([.][0-9]{0,3}|[m]?)$

inboundNetwork string

pattern: ^[0-9]+([KMG]i?)?B/s$

outboundNetwork string

pattern: ^[0-9]+([KMG]i?)?B/s$

config object

The Cruise Control configuration. For a full list of configuration options refer to https://github.com/linkedin/cruise-control/wiki/Configurations. Note that properties with the following prefixes cannot be set: bootstrap.servers, client.id, zookeeper., network., security., failed.brokers.zk.path,webserver.http., webserver.api.urlprefix, webserver.session.path, webserver.accesslog., two.step., request.reason.required,metric.reporter.sampler.bootstrap.servers, capacity.config.file, self.healing., ssl., kafka.broker.failure.detection.enable, topic.config.provider.class (with the exception of: ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols, webserver.http.cors.enabled, webserver.http.cors.origin, webserver.http.cors.exposeheaders, webserver.security.enable, webserver.ssl.enable).

image string

The container image used for Cruise Control pods. If no image name is explicitly specified, the image name corresponds to the name specified in the Cluster Operator configuration. If an image name is not defined in the Cluster Operator configuration, a default value is used.

jvmOptions object

JVM Options for the Cruise Control container.

-XX object

A map of -XX options to the JVM.

-Xms string

-Xms option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

-Xmx string

-Xmx option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

gcLoggingEnabled boolean

Specifies whether the Garbage Collection logging is enabled. The default is false.

javaSystemProperties []object

A map of additional system properties which will be passed using the `-D` option to the JVM.

name string

The system property name.

value string

The system property value.

livenessProbe object

Pod liveness checking for the Cruise Control container.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

logging object

Logging configuration (Log4j 2) for Cruise Control.

loggers object

A Map from logger name to logger level.

type string required

Logging type, must be either 'inline' or 'external'.

enum: inline, external

valueFrom object

`ConfigMap` entry where the logging configuration is stored.

configMapKeyRef object

Reference to the key in the ConfigMap containing the configuration.

key string

name string

optional boolean

metricsConfig object

Metrics configuration. Only `jmxPrometheusExporter` can be configured, as this component does not support `strimziMetricsReporter`.

type string required

Metrics type. The supported types are `jmxPrometheusExporter` and `strimziMetricsReporter`. Type `jmxPrometheusExporter` uses the Prometheus JMX Exporter to expose Kafka JMX metrics in Prometheus format through an HTTP endpoint. Type `strimziMetricsReporter` uses the Strimzi Metrics Reporter to directly expose Kafka metrics in Prometheus format through an HTTP endpoint.

enum: jmxPrometheusExporter, strimziMetricsReporter

valueFrom object

ConfigMap entry where the Prometheus JMX Exporter configuration is stored.

configMapKeyRef object

Reference to the key in the ConfigMap containing the configuration.

key string

name string

optional boolean

values object

Configuration values for the Strimzi Metrics Reporter.

allowList []string

A list of regex patterns to filter the metrics to collect. Should contain at least one element.

readinessProbe object

Pod readiness checking for the Cruise Control container.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

resources object

CPU and memory resources to reserve for the Cruise Control container.

claims []object

name string

request string

limits object

requests object

template object

Template to specify how Cruise Control resources, `Deployments` and `Pods`, are generated.

apiService object

Template for Cruise Control API `Service`.

ipFamilies []string

Specifies the IP Families used by the service. Available options are `IPv4` and `IPv6`. If unspecified, Kubernetes will choose the default value based on the `ipFamilyPolicy` setting.

ipFamilyPolicy string

Specifies the IP Family Policy used by the service. Available options are `SingleStack`, `PreferDualStack` and `RequireDualStack`. `SingleStack` is for a single IP family. `PreferDualStack` is for two IP families on dual-stack configured clusters or a single IP family on single-stack clusters. `RequireDualStack` fails unless there are two IP families on dual-stack configured clusters. If unspecified, Kubernetes will choose the default value based on the service type.

enum: SingleStack, PreferDualStack, RequireDualStack

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

cruiseControlContainer object

Template for the Cruise Control container.

env []object

Environment variables which should be applied to the container.

name string

The environment variable key.

value string

The environment variable value.

valueFrom object

Reference to the secret or config map property to which the environment variable is set.

configMapKeyRef object

Reference to a key in a config map.

key string

name string

optional boolean

secretKeyRef object

Reference to a key in a secret.

key string

name string

optional boolean

securityContext object

Security context for the container.

allowPrivilegeEscalation boolean

appArmorProfile object

localhostProfile string

type string

capabilities object

add []string

drop []string

privileged boolean

procMount string

readOnlyRootFilesystem boolean

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

volumeMounts []object

Additional volume mounts which should be applied to the container.

mountPath string

mountPropagation string

name string

readOnly boolean

recursiveReadOnly string

subPath string

subPathExpr string

deployment object

Template for Cruise Control `Deployment`.

deploymentStrategy string

Pod replacement strategy for deployment configuration changes. Valid values are `RollingUpdate` and `Recreate`. Defaults to `RollingUpdate`.

enum: RollingUpdate, Recreate

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

pod object

Template for Cruise Control `Pods`.

affinity object

The pod's affinity rules.

nodeAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

preference object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

weight integer

requiredDuringSchedulingIgnoredDuringExecution object

nodeSelectorTerms []object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

podAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

podAntiAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

dnsConfig object

The pod's DNSConfig. If specified, it will be merged to the generated DNS configuration based on the DNSPolicy.

nameservers []string

options []object

name string

value string

searches []string

dnsPolicy string

The pod's DNSPolicy. Defaults to `ClusterFirst`. Valid values are `ClusterFirstWithHostNet`, `ClusterFirst`, `Default` or `None`.

enum: ClusterFirst, ClusterFirstWithHostNet, Default, None

enableServiceLinks boolean

Indicates whether information about services should be injected into Pod's environment variables.

hostAliases []object

The pod's HostAliases. HostAliases is an optional list of hosts and IPs that will be injected into the Pod's hosts file if specified.

hostnames []string

ip string

hostUsers boolean

Use the host user namespace. Optional. Defaults to `true`. When `true` or not set, the pod runs in the host user namespace. This is required when the pod needs features available only in the host namespace, such as loading kernel modules with `CAP_SYS_MODULE`.When set to `false`, the pod runs in a new user namespace. Setting `false` helps mitigate container breakout vulnerabilities and allows containers to run as `root` without granting `root` privileges on the host. This property is alpha-level in Kubernetes and is supported only by Kubernetes clusters that enable the `UserNamespacesSupport` feature.

imagePullSecrets []object

List of references to secrets in the same namespace to use for pulling any of the images used by this Pod. When the `STRIMZI_IMAGE_PULL_SECRETS` environment variable in Cluster Operator and the `imagePullSecrets` option are specified, only the `imagePullSecrets` variable is used and the `STRIMZI_IMAGE_PULL_SECRETS` variable is ignored.

name string

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

priorityClassName string

The name of the priority class used to assign priority to the pods.

schedulerName string

The name of the scheduler used to dispatch this `Pod`. If not specified, the default scheduler will be used.

securityContext object

Configures pod-level security attributes and common container settings.

appArmorProfile object

localhostProfile string

type string

fsGroup integer

fsGroupChangePolicy string

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxChangePolicy string

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

supplementalGroups []integer

supplementalGroupsPolicy string

sysctls []object

name string

value string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

terminationGracePeriodSeconds integer

The grace period is the duration in seconds after the processes running in the pod are sent a termination signal, and the time when the processes are forcibly halted with a kill signal. Set this value to longer than the expected cleanup time for your process. Value must be a non-negative integer. A zero value indicates delete immediately. You might need to increase the grace period for very large Kafka clusters, so that the Kafka brokers have enough time to transfer their work to another broker before they are terminated. Defaults to 30 seconds.

minimum: 0

tmpDirSizeLimit string

Defines the total amount of pod memory allocated for the temporary `EmptyDir` volume `/tmp`. Specify the allocation in memory units, for example, `100Mi` for 100 mebibytes. Default value is `5Mi`. The `/tmp` volume is backed by pod memory, not disk storage, so avoid setting a high value as it consumes pod memory resources.

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

tolerations []object

The pod's tolerations.

effect string

key string

operator string

tolerationSeconds integer

value string

topologySpreadConstraints []object

The pod's topology spread constraints.

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

maxSkew integer

minDomains integer

nodeAffinityPolicy string

nodeTaintsPolicy string

topologyKey string

whenUnsatisfiable string

volumes []object

Additional volumes that can be mounted to the pod.

configMap object

`ConfigMap` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

name string

optional boolean

csi object

`CSIVolumeSource` object to use to populate the volume.

driver string

fsType string

nodePublishSecretRef object

name string

readOnly boolean

volumeAttributes object

emptyDir object

`EmptyDir` to use to populate the volume.

medium string

Medium represents the type of storage medium should back this volume. Valid values are unset or `Memory`. When not set, it will use the node's default medium.

enum: Memory

sizeLimit string

The total amount of local storage required for this EmptyDir volume (for example 1Gi).

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

image object

`ImageVolumeSource` object to use to populate the volume.

pullPolicy string

reference string

name string

Name to use for the volume. Required.

persistentVolumeClaim object

`PersistentVolumeClaim` object to use to populate the volume.

claimName string

readOnly boolean

secret object

`Secret` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

optional boolean

secretName string

podDisruptionBudget object

Template for Cruise Control `PodDisruptionBudget`.

maxUnavailable integer

Maximum number of unavailable pods to allow automatic Pod eviction. A Pod eviction is allowed when the `maxUnavailable` number of pods or fewer are unavailable after the eviction. Setting this value to 0 prevents all voluntary evictions, so the pods must be evicted manually. Defaults to 1.

minimum: 0

metadata object

Metadata to apply to the `PodDisruptionBudgetTemplate` resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

serviceAccount object

Template for the Cruise Control service account.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

entityOperator object

Configuration of the Entity Operator.

template object

Template for Entity Operator resources. The template allows users to specify how a `Deployment` and `Pod` is generated.

deployment object

Template for Entity Operator `Deployment`.

deploymentStrategy string

Pod replacement strategy for deployment configuration changes. Valid values are `RollingUpdate` and `Recreate`. Defaults to `RollingUpdate`.

enum: RollingUpdate, Recreate

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

entityOperatorRole object

Template for the Entity Operator Role.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

pod object

Template for Entity Operator `Pods`.

affinity object

The pod's affinity rules.

nodeAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

preference object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

weight integer

requiredDuringSchedulingIgnoredDuringExecution object

nodeSelectorTerms []object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

podAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

podAntiAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

dnsConfig object

The pod's DNSConfig. If specified, it will be merged to the generated DNS configuration based on the DNSPolicy.

nameservers []string

options []object

name string

value string

searches []string

dnsPolicy string

The pod's DNSPolicy. Defaults to `ClusterFirst`. Valid values are `ClusterFirstWithHostNet`, `ClusterFirst`, `Default` or `None`.

enum: ClusterFirst, ClusterFirstWithHostNet, Default, None

enableServiceLinks boolean

Indicates whether information about services should be injected into Pod's environment variables.

hostAliases []object

The pod's HostAliases. HostAliases is an optional list of hosts and IPs that will be injected into the Pod's hosts file if specified.

hostnames []string

ip string

hostUsers boolean

imagePullSecrets []object

name string

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

priorityClassName string

The name of the priority class used to assign priority to the pods.

schedulerName string

The name of the scheduler used to dispatch this `Pod`. If not specified, the default scheduler will be used.

securityContext object

Configures pod-level security attributes and common container settings.

appArmorProfile object

localhostProfile string

type string

fsGroup integer

fsGroupChangePolicy string

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxChangePolicy string

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

supplementalGroups []integer

supplementalGroupsPolicy string

sysctls []object

name string

value string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

terminationGracePeriodSeconds integer

minimum: 0

tmpDirSizeLimit string

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

tolerations []object

The pod's tolerations.

effect string

key string

operator string

tolerationSeconds integer

value string

topologySpreadConstraints []object

The pod's topology spread constraints.

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

maxSkew integer

minDomains integer

nodeAffinityPolicy string

nodeTaintsPolicy string

topologyKey string

whenUnsatisfiable string

volumes []object

Additional volumes that can be mounted to the pod.

configMap object

`ConfigMap` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

name string

optional boolean

csi object

`CSIVolumeSource` object to use to populate the volume.

driver string

fsType string

nodePublishSecretRef object

name string

readOnly boolean

volumeAttributes object

emptyDir object

`EmptyDir` to use to populate the volume.

medium string

Medium represents the type of storage medium should back this volume. Valid values are unset or `Memory`. When not set, it will use the node's default medium.

enum: Memory

sizeLimit string

The total amount of local storage required for this EmptyDir volume (for example 1Gi).

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

image object

`ImageVolumeSource` object to use to populate the volume.

pullPolicy string

reference string

name string

Name to use for the volume. Required.

persistentVolumeClaim object

`PersistentVolumeClaim` object to use to populate the volume.

claimName string

readOnly boolean

secret object

`Secret` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

optional boolean

secretName string

podDisruptionBudget object

Template for the Entity Operator Pod Disruption Budget.

maxUnavailable integer

minimum: 0

metadata object

Metadata to apply to the `PodDisruptionBudgetTemplate` resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

serviceAccount object

Template for the Entity Operator service account.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

topicOperatorContainer object

Template for the Entity Topic Operator container.

env []object

Environment variables which should be applied to the container.

name string

The environment variable key.

value string

The environment variable value.

valueFrom object

Reference to the secret or config map property to which the environment variable is set.

configMapKeyRef object

Reference to a key in a config map.

key string

name string

optional boolean

secretKeyRef object

Reference to a key in a secret.

key string

name string

optional boolean

securityContext object

Security context for the container.

allowPrivilegeEscalation boolean

appArmorProfile object

localhostProfile string

type string

capabilities object

add []string

drop []string

privileged boolean

procMount string

readOnlyRootFilesystem boolean

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

volumeMounts []object

Additional volume mounts which should be applied to the container.

mountPath string

mountPropagation string

name string

readOnly boolean

recursiveReadOnly string

subPath string

subPathExpr string

topicOperatorRoleBinding object

Template for the Entity Topic Operator RoleBinding.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

userOperatorContainer object

Template for the Entity User Operator container.

env []object

Environment variables which should be applied to the container.

name string

The environment variable key.

value string

The environment variable value.

valueFrom object

Reference to the secret or config map property to which the environment variable is set.

configMapKeyRef object

Reference to a key in a config map.

key string

name string

optional boolean

secretKeyRef object

Reference to a key in a secret.

key string

name string

optional boolean

securityContext object

Security context for the container.

allowPrivilegeEscalation boolean

appArmorProfile object

localhostProfile string

type string

capabilities object

add []string

drop []string

privileged boolean

procMount string

readOnlyRootFilesystem boolean

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

volumeMounts []object

Additional volume mounts which should be applied to the container.

mountPath string

mountPropagation string

name string

readOnly boolean

recursiveReadOnly string

subPath string

subPathExpr string

userOperatorRoleBinding object

Template for the Entity Topic Operator RoleBinding.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

topicOperator object

Configuration of the Topic Operator.

image string

The image to use for the Topic Operator.

jvmOptions object

JVM Options for pods.

-XX object

A map of -XX options to the JVM.

-Xms string

-Xms option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

-Xmx string

-Xmx option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

gcLoggingEnabled boolean

Specifies whether the Garbage Collection logging is enabled. The default is false.

javaSystemProperties []object

A map of additional system properties which will be passed using the `-D` option to the JVM.

name string

The system property name.

value string

The system property value.

livenessProbe object

Pod liveness checking.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

logging object

Logging configuration.

loggers object

A Map from logger name to logger level.

type string required

Logging type, must be either 'inline' or 'external'.

enum: inline, external

valueFrom object

`ConfigMap` entry where the logging configuration is stored.

configMapKeyRef object

Reference to the key in the ConfigMap containing the configuration.

key string

name string

optional boolean

readinessProbe object

Pod readiness checking.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

reconciliationIntervalMs integer

Interval between periodic reconciliations in milliseconds.

minimum: 0

resources object

CPU and memory resources to reserve.

claims []object

name string

request string

limits object

requests object

startupProbe object

Pod startup checking.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

watchedNamespace string

The namespace the Topic Operator should watch.

userOperator object

Configuration of the User Operator.

image string

The image to use for the User Operator.

jvmOptions object

JVM Options for pods.

-XX object

A map of -XX options to the JVM.

-Xms string

-Xms option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

-Xmx string

-Xmx option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

gcLoggingEnabled boolean

Specifies whether the Garbage Collection logging is enabled. The default is false.

javaSystemProperties []object

A map of additional system properties which will be passed using the `-D` option to the JVM.

name string

The system property name.

value string

The system property value.

livenessProbe object

Pod liveness checking.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

logging object

Logging configuration.

loggers object

A Map from logger name to logger level.

type string required

Logging type, must be either 'inline' or 'external'.

enum: inline, external

valueFrom object

`ConfigMap` entry where the logging configuration is stored.

configMapKeyRef object

Reference to the key in the ConfigMap containing the configuration.

key string

name string

optional boolean

readinessProbe object

Pod readiness checking.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

reconciliationIntervalMs integer

Interval between periodic reconciliations in milliseconds.

minimum: 0

resources object

CPU and memory resources to reserve.

claims []object

name string

request string

limits object

requests object

secretPrefix string

The prefix that will be added to the KafkaUser name to be used as the Secret name.

watchedNamespace string

The namespace the User Operator should watch.

kafka object required

Configuration of the Kafka cluster.

authorization object

Authorization configuration for Kafka brokers.

authorizerClass string

Authorization implementation class, which must be available in classpath.

superUsers []string

List of super users, which are user principals with unlimited access rights.

supportsAdminApi boolean

Indicates whether the custom authorizer supports the APIs for managing ACLs using the Kafka Admin API. Defaults to `false`.

type string required

Authorization type. Currently, the supported types are `simple`, `keycloak`, `opa` and `custom`. `simple` authorization type uses Kafka's built-in authorizer for authorization. `keycloak` authorization type uses Keycloak Authorization Services for authorization. `opa` authorization type uses Open Policy Agent based authorization. `custom` authorization type uses user-provided implementation for authorization. `opa` (as of Strimzi 0.46.0) and `keycloak` (as of Strimzi 0.49.0) types are deprecated and will be removed in the `v1` API version. Please use `custom` type instead.

enum: simple, custom

brokerRackInitImage string

The image of the init container used for initializing the `broker.rack`.

config object

Kafka broker config properties with certain prefixes cannot be set unless it is in the exception list. Consult the documentation for the list of forbidden prefixes and exceptions.

image string

The container image used for Kafka pods. If the property is not set, the default Kafka image version is determined based on the `version` configuration. The image names are specifically mapped to corresponding versions in the Cluster Operator configuration. Changing the Kafka image version does not automatically update the image versions for other components, such as Kafka Exporter.

jmxOptions object

JMX Options for Kafka brokers.

authentication object

Authentication configuration for connecting to the JMX port.

type string required

Authentication type. Currently the only supported types are `password`.`password` type creates a username and protected port with no TLS.

enum: password

jvmOptions object

JVM Options for pods.

-XX object

A map of -XX options to the JVM.

-Xms string

-Xms option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

-Xmx string

-Xmx option to to the JVM.

pattern: ^[0-9]+[mMgG]?$

gcLoggingEnabled boolean

Specifies whether the Garbage Collection logging is enabled. The default is false.

javaSystemProperties []object

A map of additional system properties which will be passed using the `-D` option to the JVM.

name string

The system property name.

value string

The system property value.

listeners []object required

Configures listeners to provide access to Kafka brokers.

minItems: 1

authentication object

Authentication configuration for this listener.

listenerConfig object

Configuration to be used for a specific listener. All values are prefixed with `listener.name.<listener_name>`.

sasl boolean

Enable or disable SASL on this listener.

type string required

Authentication type. `oauth` type uses SASL OAUTHBEARER Authentication. `scram-sha-512` type uses SASL SCRAM-SHA-512 Authentication. `tls` type uses TLS Client Authentication. `tls` type is supported only on TLS listeners. `custom` type allows for any authentication type to be used. As of Strimzi 0.49.0, `oauth` type is deprecated and will be removed in the `v1` API version. Please use `custom` type instead.

enum: tls, scram-sha-512, custom

configuration object

Additional listener configuration.

advertisedHostTemplate string

Configures the template for generating the advertised hostnames of the individual brokers. Valid placeholders that you can use in the template are `{nodeId}` and `{nodePodName}`.

advertisedPortTemplate string

Configures the template for generating the advertised ports of the individual brokers. It allows to specify a simple mathematics formula that will be used to calculate the port. The only valid placeholder that you can use in the template is `{nodeId}`. Supported operations are `+`, `-`, and `*`. For example, `9000 + {nodeId}` will generate ports `9000`, `9001`, `9002`, and so on for the individual brokers. You can also use a fixed port number in the template, for example `9000`, which will generate the same port for all brokers.

allocateLoadBalancerNodePorts boolean

Configures whether to allocate NodePort automatically for the `Service` with type `LoadBalancer`. This is a one to one with the `spec.allocateLoadBalancerNodePorts` configuration in the `Service` type For `loadbalancer` listeners only.

bootstrap object

Bootstrap configuration.

alternativeNames []string

Additional alternative names for the bootstrap service. The alternative names will be added to the list of subject alternative names of the TLS certificates.

annotations object

Annotations added to `Ingress`, `Route`, or `Service` resources. You can use this property to configure DNS providers such as External DNS. For `loadbalancer`, `nodeport`, `route`, or `ingress` listeners only.

externalIPs []string

External IPs associated to the nodeport service. These IPs are used by clients external to the Kubernetes cluster to access the Kafka brokers. This property is helpful when `nodeport` without `externalIP` is not sufficient. For example on bare-metal Kubernetes clusters that do not support Loadbalancer service types. For `nodeport` listeners only.

host string

Specifies the hostname used for the bootstrap resource. For `route` (optional) or `ingress` (required) listeners only. Ensure the hostname resolves to the Ingress endpoints; no validation is performed by Strimzi.

labels object

Labels added to `Ingress`, `Route`, or `Service` resources. For `loadbalancer`, `nodeport`, `route`, or `ingress` listeners only.

loadBalancerIP string

The loadbalancer is requested with the IP address specified in this property. This feature depends on whether the underlying cloud provider supports specifying the `loadBalancerIP` when a load balancer is created. This property is ignored if the cloud provider does not support the feature. For `loadbalancer` listeners only.

nodePort integer

Node port for the bootstrap service. For `nodeport` listeners only.

brokerCertChainAndKey object

Reference to the `Secret` which holds the certificate and private key pair which will be used for this listener. The certificate can optionally contain the whole chain. This field can be used only with listeners with enabled TLS encryption.

certificate string required

The name of the file certificate in the Secret.

key string required

The name of the private key in the secret. The private key must be in unencrypted PKCS #8 format. For more information, see RFC 5208: https://datatracker.ietf.org/doc/html/rfc5208.

secretName string required

The name of the Secret containing the certificate.

brokers []object

Per-broker configurations.

advertisedHost string

The host name used in the brokers' `advertised.listeners`.

advertisedPort integer

The port number used in the brokers' `advertised.listeners`.

annotations object

Annotations that will be added to the `Ingress` or `Service` resource. You can use this field to configure DNS providers such as External DNS. This field can be used only with `loadbalancer`, `nodeport`, or `ingress` type listeners.

broker integer required

ID of the kafka broker (broker identifier). Broker IDs start from 0 and correspond to the number of broker replicas.

externalIPs []string

External IPs associated to the nodeport service. These IPs are used by clients external to the Kubernetes cluster to access the Kafka brokers. This field is helpful when `nodeport` without `externalIP` is not sufficient. For example on bare-metal Kubernetes clusters that do not support Loadbalancer service types. This field can only be used with `nodeport` type listener.

host string

The broker host. This field will be used in the Ingress resource or in the Route resource to specify the desired hostname. This field can be used only with `route` (optional) or `ingress` (required) type listeners.

labels object

Labels that will be added to the `Ingress`, `Route`, or `Service` resource. This field can be used only with `loadbalancer`, `nodeport`, `route`, or `ingress` type listeners.

loadBalancerIP string

The loadbalancer is requested with the IP address specified in this field. This feature depends on whether the underlying cloud provider supports specifying the `loadBalancerIP` when a load balancer is created. This field is ignored if the cloud provider does not support the feature.This field can be used only with `loadbalancer` type listener.

nodePort integer

Node port for the per-broker service. This field can be used only with `nodeport` type listener.

class string

Configures a specific class for `Ingress` and `LoadBalancer` that defines which controller is used. If not specified, the default controller is used. * For an `ingress` listener, the operator uses this property to set the `ingressClassName` property in the `Ingress` resources. * For a `loadbalancer` listener, the operator uses this property to set the `loadBalancerClass` property in the `Service` resources. For `ingress` and `loadbalancer` listeners only.

createBootstrapService boolean

Whether to create the bootstrap service or not. The bootstrap service is created by default (if not specified differently). This field can be used with the `loadbalancer` listener.

externalTrafficPolicy string

Specifies whether the service routes external traffic to cluster-wide or node-local endpoints: * `Cluster` may cause a second hop to another node and obscures the client source IP. * `Local` avoids a second hop for `LoadBalancer` and `Nodeport` type services and preserves the client source IP (when supported by the infrastructure). If unspecified, Kubernetes uses `Cluster` as the default. For `loadbalancer` or `nodeport` listeners only.

enum: Local, Cluster

finalizers []string

A list of finalizers configured for the `LoadBalancer` type services created for this listener. If supported by the platform, the finalizer `service.kubernetes.io/load-balancer-cleanup` to make sure that the external load balancer is deleted together with the service.For more information, see https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#garbage-collecting-load-balancers. For `loadbalancer` listeners only.

hostTemplate string

Configures the template for generating the hostnames of the individual brokers. Valid placeholders that you can use in the template are `{nodeId}` and `{nodePodName}`.

ipFamilies []string

Specifies the IP Families used by the service. Available options are `IPv4` and `IPv6`. If unspecified, Kubernetes will choose the default value based on the `ipFamilyPolicy` setting.

ipFamilyPolicy string

Specifies the IP Family Policy used by the service. Available options are `SingleStack`, `PreferDualStack` and `RequireDualStack`: * `SingleStack` is for a single IP family. * `PreferDualStack` is for two IP families on dual-stack configured clusters or a single IP family on single-stack clusters. * `RequireDualStack` fails unless there are two IP families on dual-stack configured clusters. If unspecified, Kubernetes will choose the default value based on the service type.

enum: SingleStack, PreferDualStack, RequireDualStack

loadBalancerSourceRanges []string

A list of CIDR ranges (for example `10.0.0.0/8` or `130.211.204.1/32`) from which clients can connect to loadbalancer listeners. If supported by the platform, traffic through the loadbalancer is restricted to the specified CIDR ranges. This field is applicable only for loadbalancer type services and is ignored if the cloud provider does not support the feature. For `loadbalancer` listeners only.

maxConnectionCreationRate integer

The maximum connection creation rate we allow in this listener at any time. New connections will be throttled if the limit is reached.

maxConnections integer

The maximum number of connections we allow for this listener in the broker at any time. New connections are blocked if the limit is reached.

preferredNodePortAddressType string

Defines which address type should be used as the node address. Available types are: `ExternalDNS`, `ExternalIP`, `InternalDNS`, `InternalIP` and `Hostname`. By default, the addresses are used in the following order (the first one found is used): * `ExternalDNS` * `ExternalIP` * `InternalDNS` * `InternalIP` * `Hostname` This property is used to select the preferred address type, which is checked first. If no address is found for this address type, the other types are checked in the default order. For `nodeport` listeners only.

enum: ExternalIP, ExternalDNS, InternalIP, InternalDNS, Hostname

publishNotReadyAddresses boolean

Configures whether the service endpoints are considered "ready" even if the Pods themselves are not. Defaults to `false`. This field can not be used with `internal` listeners.

useServiceDnsDomain boolean

Configures whether the Kubernetes service DNS domain should be included in the generated addresses. * If set to `false`, the generated addresses do not contain the service DNS domain suffix. For example, `my-cluster-kafka-0.my-cluster-kafka-brokers.myproject.svc`. * If set to `true`, the generated addresses contain the service DNS domain suffix. For example, `my-cluster-kafka-0.my-cluster-kafka-brokers.myproject.svc.cluster.local`. The default is `.cluster.local`, but this is customizable using the environment variable `KUBERNETES_SERVICE_DNS_DOMAIN`. For `internal` and `cluster-ip` listeners only.

name string required

Name of the listener. The name will be used to identify the listener and the related Kubernetes objects. The name has to be unique within given a Kafka cluster. The name can consist of lowercase characters and numbers and be up to 11 characters long.

pattern: ^[a-z0-9]{1,11}$

networkPolicyPeers []object

List of peers which should be able to connect to this listener. Peers in this list are combined using a logical OR operation. If this field is empty or missing, all connections will be allowed for this listener. If this field is present and contains at least one item, the listener only allows the traffic which matches at least one item in this list.

ipBlock object

cidr string

except []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

podSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

port integer required

Port number used by the listener inside Kafka. The port number has to be unique within a given Kafka cluster. Allowed port numbers are 9092 and higher with the exception of ports 9404 and 9999, which are already used for Prometheus and JMX. Depending on the listener type, the port number might not be the same as the port number that connects Kafka clients.

minimum: 9092

tls boolean required

Enables TLS encryption on the listener. This is a required property. For `route` and `ingress` type listeners, TLS encryption must be always enabled.

type string required

Type of the listener. The supported types are as follows: * `internal` type exposes Kafka internally only within the Kubernetes cluster. * `route` type uses OpenShift Routes to expose Kafka. * `loadbalancer` type uses LoadBalancer type services to expose Kafka. * `nodeport` type uses NodePort type services to expose Kafka. * `ingress` (deprecated) type uses Kubernetes Nginx Ingress to expose Kafka with TLS passthrough. * `cluster-ip` type uses a per-broker `ClusterIP` service.

enum: internal, route, loadbalancer, nodeport, ingress, cluster-ip

livenessProbe object

Pod liveness checking.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

logging object

Logging configuration for Kafka.

loggers object

A Map from logger name to logger level.

type string required

Logging type, must be either 'inline' or 'external'.

enum: inline, external

valueFrom object

`ConfigMap` entry where the logging configuration is stored.

configMapKeyRef object

Reference to the key in the ConfigMap containing the configuration.

key string

name string

optional boolean

metadataVersion string

The KRaft metadata version used by the Kafka cluster. This property is ignored when running in ZooKeeper mode. If the property is not set, it defaults to the metadata version that corresponds to the `version` property.

metricsConfig object

Metrics configuration.

type string required

enum: jmxPrometheusExporter, strimziMetricsReporter

valueFrom object

ConfigMap entry where the Prometheus JMX Exporter configuration is stored.

configMapKeyRef object

Reference to the key in the ConfigMap containing the configuration.

key string

name string

optional boolean

values object

Configuration values for the Strimzi Metrics Reporter.

allowList []string

A list of regex patterns to filter the metrics to collect. Should contain at least one element.

quotas object

Quotas plugin configuration for Kafka brokers allows setting quotas for disk usage, produce/fetch rates, and more. Supported plugin types include `kafka` (default) and `strimzi`. If not specified, the default `kafka` quotas plugin is used.

consumerByteRate integer

A per-broker byte-rate quota for clients consuming from a broker, independent of their number. If clients consume at maximum speed, the quota is shared equally between all non-excluded consumers. Otherwise, the quota is divided based on each client's consumption rate.

minimum: 0

controllerMutationRate number

The default client quota on the rate at which mutations are accepted per second for create topic requests, create partition requests, and delete topic requests, defined for each broker. The mutations rate is measured by the number of partitions created or deleted. Applied on a per-broker basis.

minimum: 0

excludedPrincipals []string

List of principals that are excluded from the quota. The principals have to be prefixed with `User:`, for example `User:my-user;User:CN=my-other-user`.

minAvailableBytesPerVolume integer

Stop message production if the available size (in bytes) of the storage is lower than or equal to this specified value. This condition is mutually exclusive with `minAvailableRatioPerVolume`.

minimum: 0

minAvailableRatioPerVolume number

Stop message production if the percentage of available storage space falls below or equals the specified ratio (set as a decimal representing a percentage). This condition is mutually exclusive with `minAvailableBytesPerVolume`.

minimum: 0

maximum: 1

producerByteRate integer

A per-broker byte-rate quota for clients producing to a broker, independent of their number. If clients produce at maximum speed, the quota is shared equally between all non-excluded producers. Otherwise, the quota is divided based on each client's production rate.

minimum: 0

requestPercentage integer

The default client quota limits the maximum CPU utilization of each client as a percentage of the network and I/O threads of each broker. Applied on a per-broker basis.

minimum: 0

type string required

Quotas plugin type. Currently, the supported types are `kafka` and `strimzi`. `kafka` quotas type uses Kafka's built-in quotas plugin. `strimzi` quotas type uses Strimzi quotas plugin.

enum: kafka, strimzi

rack object

Configuration of the `broker.rack` broker config.

envVarName string

The name of the environment variable that defines the rack ID. Its value sets the `broker.rack` configuration for Kafka brokers and the `client.rack` configuration for Kafka Connect or MirrorMaker 2.

topologyKey string

A key that matches labels assigned to the Kubernetes cluster nodes. The value of the label is used to set a broker's `broker.rack` config, and the `client.rack` config for Kafka Connect or MirrorMaker 2.

type string

Specifies the rack awareness type. Supported types are `topology-label` and `environment-variable`. `topology-label` uses a Kubernetes worker node label to set the `broker.rack` configuration for Kafka brokers and the `client.rack` configuration for Kafka Connect and MirrorMaker 2. `environment-variable` uses an environment variable to set the `broker.rack` configuration for Kafka brokers and the `client.rack` configuration for Kafka Connect and MirrorMaker 2. When not specified, `topology-label` type is used by default.

enum: topology-label, environment-variable

readinessProbe object

Pod readiness checking.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

template object

Template for Kafka cluster resources. The template allows users to specify how the Kubernetes resources are generated.

bootstrapService object

Template for Kafka bootstrap `Service`.

ipFamilies []string

Specifies the IP Families used by the service. Available options are `IPv4` and `IPv6`. If unspecified, Kubernetes will choose the default value based on the `ipFamilyPolicy` setting.

ipFamilyPolicy string

enum: SingleStack, PreferDualStack, RequireDualStack

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

brokersService object

Template for Kafka broker `Service`.

ipFamilies []string

Specifies the IP Families used by the service. Available options are `IPv4` and `IPv6`. If unspecified, Kubernetes will choose the default value based on the `ipFamilyPolicy` setting.

ipFamilyPolicy string

enum: SingleStack, PreferDualStack, RequireDualStack

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

clusterCaCert object

Template for Secret with Kafka Cluster certificate public key.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

clusterRoleBinding object

Template for the Kafka ClusterRoleBinding.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

externalBootstrapIngress object

Template for Kafka external bootstrap `Ingress`.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

externalBootstrapRoute object

Template for Kafka external bootstrap `Route`.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

externalBootstrapService object

Template for Kafka external bootstrap `Service`.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

initContainer object

Template for the Kafka init container.

env []object

Environment variables which should be applied to the container.

name string

The environment variable key.

value string

The environment variable value.

valueFrom object

Reference to the secret or config map property to which the environment variable is set.

configMapKeyRef object

Reference to a key in a config map.

key string

name string

optional boolean

secretKeyRef object

Reference to a key in a secret.

key string

name string

optional boolean

securityContext object

Security context for the container.

allowPrivilegeEscalation boolean

appArmorProfile object

localhostProfile string

type string

capabilities object

add []string

drop []string

privileged boolean

procMount string

readOnlyRootFilesystem boolean

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

volumeMounts []object

Additional volume mounts which should be applied to the container.

mountPath string

mountPropagation string

name string

readOnly boolean

recursiveReadOnly string

subPath string

subPathExpr string

jmxSecret object

Template for Secret of the Kafka Cluster JMX authentication.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

kafkaContainer object

Template for the Kafka broker container.

env []object

Environment variables which should be applied to the container.

name string

The environment variable key.

value string

The environment variable value.

valueFrom object

Reference to the secret or config map property to which the environment variable is set.

configMapKeyRef object

Reference to a key in a config map.

key string

name string

optional boolean

secretKeyRef object

Reference to a key in a secret.

key string

name string

optional boolean

securityContext object

Security context for the container.

allowPrivilegeEscalation boolean

appArmorProfile object

localhostProfile string

type string

capabilities object

add []string

drop []string

privileged boolean

procMount string

readOnlyRootFilesystem boolean

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

volumeMounts []object

Additional volume mounts which should be applied to the container.

mountPath string

mountPropagation string

name string

readOnly boolean

recursiveReadOnly string

subPath string

subPathExpr string

perPodIngress object

Template for Kafka per-pod `Ingress` used for access from outside of Kubernetes.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

perPodRoute object

Template for Kafka per-pod `Routes` used for access from outside of OpenShift.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

perPodService object

Template for Kafka per-pod `Services` used for access from outside of Kubernetes.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

persistentVolumeClaim object

Template for all Kafka `PersistentVolumeClaims`.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

pod object

Template for Kafka `Pods`.

affinity object

The pod's affinity rules.

nodeAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

preference object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

weight integer

requiredDuringSchedulingIgnoredDuringExecution object

nodeSelectorTerms []object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

podAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

podAntiAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

dnsConfig object

The pod's DNSConfig. If specified, it will be merged to the generated DNS configuration based on the DNSPolicy.

nameservers []string

options []object

name string

value string

searches []string

dnsPolicy string

The pod's DNSPolicy. Defaults to `ClusterFirst`. Valid values are `ClusterFirstWithHostNet`, `ClusterFirst`, `Default` or `None`.

enum: ClusterFirst, ClusterFirstWithHostNet, Default, None

enableServiceLinks boolean

Indicates whether information about services should be injected into Pod's environment variables.

hostAliases []object

The pod's HostAliases. HostAliases is an optional list of hosts and IPs that will be injected into the Pod's hosts file if specified.

hostnames []string

ip string

hostUsers boolean

imagePullSecrets []object

name string

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

priorityClassName string

The name of the priority class used to assign priority to the pods.

schedulerName string

The name of the scheduler used to dispatch this `Pod`. If not specified, the default scheduler will be used.

securityContext object

Configures pod-level security attributes and common container settings.

appArmorProfile object

localhostProfile string

type string

fsGroup integer

fsGroupChangePolicy string

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxChangePolicy string

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

supplementalGroups []integer

supplementalGroupsPolicy string

sysctls []object

name string

value string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

terminationGracePeriodSeconds integer

minimum: 0

tmpDirSizeLimit string

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

tolerations []object

The pod's tolerations.

effect string

key string

operator string

tolerationSeconds integer

value string

topologySpreadConstraints []object

The pod's topology spread constraints.

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

maxSkew integer

minDomains integer

nodeAffinityPolicy string

nodeTaintsPolicy string

topologyKey string

whenUnsatisfiable string

volumes []object

Additional volumes that can be mounted to the pod.

configMap object

`ConfigMap` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

name string

optional boolean

csi object

`CSIVolumeSource` object to use to populate the volume.

driver string

fsType string

nodePublishSecretRef object

name string

readOnly boolean

volumeAttributes object

emptyDir object

`EmptyDir` to use to populate the volume.

medium string

Medium represents the type of storage medium should back this volume. Valid values are unset or `Memory`. When not set, it will use the node's default medium.

enum: Memory

sizeLimit string

The total amount of local storage required for this EmptyDir volume (for example 1Gi).

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

image object

`ImageVolumeSource` object to use to populate the volume.

pullPolicy string

reference string

name string

Name to use for the volume. Required.

persistentVolumeClaim object

`PersistentVolumeClaim` object to use to populate the volume.

claimName string

readOnly boolean

secret object

`Secret` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

optional boolean

secretName string

podDisruptionBudget object

Template for Kafka `PodDisruptionBudget`.

maxUnavailable integer

minimum: 0

metadata object

Metadata to apply to the `PodDisruptionBudgetTemplate` resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

podSet object

Template for Kafka `StrimziPodSet` resource.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

serviceAccount object

Template for the Kafka service account.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

tieredStorage object

Configure the tiered storage feature for Kafka brokers.

remoteStorageManager object

Configuration for the Remote Storage Manager.

className string

The class name for the `RemoteStorageManager` implementation.

classPath string

The class path for the `RemoteStorageManager` implementation.

config object

The additional configuration map for the `RemoteStorageManager` implementation. Keys will be automatically prefixed with `rsm.config.`, and added to Kafka broker configuration.

type string required

Storage type, only 'custom' is supported at the moment.

enum: custom

version string

The Kafka broker version. Defaults to the latest version. Consult the user documentation to understand the process required to upgrade or downgrade the version.

kafkaExporter object

Configuration of the Kafka Exporter. Kafka Exporter can provide additional metrics, for example lag of consumer group at topic/partition.

enableSaramaLogging boolean

Enable Sarama logging, a Go client library used by the Kafka Exporter.

groupExcludeRegex string

Regular expression to specify which consumer groups to exclude.

groupRegex string

Regular expression to specify which consumer groups to collect. Default value is `.*`.

image string

The container image used for the Kafka Exporter pods. If no image name is explicitly specified, the image name corresponds to the version specified in the Cluster Operator configuration. If an image name is not defined in the Cluster Operator configuration, a default value is used.

livenessProbe object

Pod liveness check.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

logging string

Only log messages with the given severity or above. Valid levels: [`info`, `debug`, `trace`]. Default log level is `info`.

readinessProbe object

Pod readiness check.

failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

minimum: 1

initialDelaySeconds integer

The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.

minimum: 0

periodSeconds integer

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

minimum: 1

successThreshold integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

minimum: 1

timeoutSeconds integer

The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.

minimum: 1

resources object

CPU and memory resources to reserve.

claims []object

name string

request string

limits object

requests object

showAllOffsets boolean

Whether show the offset/lag for all consumer group, otherwise, only show connected consumer groups.

template object

Customization of deployment templates and pods.

container object

Template for the Kafka Exporter container.

env []object

Environment variables which should be applied to the container.

name string

The environment variable key.

value string

The environment variable value.

valueFrom object

Reference to the secret or config map property to which the environment variable is set.

configMapKeyRef object

Reference to a key in a config map.

key string

name string

optional boolean

secretKeyRef object

Reference to a key in a secret.

key string

name string

optional boolean

securityContext object

Security context for the container.

allowPrivilegeEscalation boolean

appArmorProfile object

localhostProfile string

type string

capabilities object

add []string

drop []string

privileged boolean

procMount string

readOnlyRootFilesystem boolean

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

volumeMounts []object

Additional volume mounts which should be applied to the container.

mountPath string

mountPropagation string

name string

readOnly boolean

recursiveReadOnly string

subPath string

subPathExpr string

deployment object

Template for Kafka Exporter `Deployment`.

deploymentStrategy string

Pod replacement strategy for deployment configuration changes. Valid values are `RollingUpdate` and `Recreate`. Defaults to `RollingUpdate`.

enum: RollingUpdate, Recreate

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

pod object

Template for Kafka Exporter `Pods`.

affinity object

The pod's affinity rules.

nodeAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

preference object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

weight integer

requiredDuringSchedulingIgnoredDuringExecution object

nodeSelectorTerms []object

matchExpressions []object

key string

operator string

values []string

matchFields []object

key string

operator string

values []string

podAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

podAntiAffinity object

preferredDuringSchedulingIgnoredDuringExecution []object

podAffinityTerm object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

weight integer

requiredDuringSchedulingIgnoredDuringExecution []object

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

mismatchLabelKeys []string

namespaceSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

namespaces []string

topologyKey string

dnsConfig object

The pod's DNSConfig. If specified, it will be merged to the generated DNS configuration based on the DNSPolicy.

nameservers []string

options []object

name string

value string

searches []string

dnsPolicy string

The pod's DNSPolicy. Defaults to `ClusterFirst`. Valid values are `ClusterFirstWithHostNet`, `ClusterFirst`, `Default` or `None`.

enum: ClusterFirst, ClusterFirstWithHostNet, Default, None

enableServiceLinks boolean

Indicates whether information about services should be injected into Pod's environment variables.

hostAliases []object

The pod's HostAliases. HostAliases is an optional list of hosts and IPs that will be injected into the Pod's hosts file if specified.

hostnames []string

ip string

hostUsers boolean

imagePullSecrets []object

name string

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

priorityClassName string

The name of the priority class used to assign priority to the pods.

schedulerName string

The name of the scheduler used to dispatch this `Pod`. If not specified, the default scheduler will be used.

securityContext object

Configures pod-level security attributes and common container settings.

appArmorProfile object

localhostProfile string

type string

fsGroup integer

fsGroupChangePolicy string

runAsGroup integer

runAsNonRoot boolean

runAsUser integer

seLinuxChangePolicy string

seLinuxOptions object

level string

role string

type string

user string

seccompProfile object

localhostProfile string

type string

supplementalGroups []integer

supplementalGroupsPolicy string

sysctls []object

name string

value string

windowsOptions object

gmsaCredentialSpec string

gmsaCredentialSpecName string

hostProcess boolean

runAsUserName string

terminationGracePeriodSeconds integer

minimum: 0

tmpDirSizeLimit string

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

tolerations []object

The pod's tolerations.

effect string

key string

operator string

tolerationSeconds integer

value string

topologySpreadConstraints []object

The pod's topology spread constraints.

labelSelector object

matchExpressions []object

key string

operator string

values []string

matchLabels object

matchLabelKeys []string

maxSkew integer

minDomains integer

nodeAffinityPolicy string

nodeTaintsPolicy string

topologyKey string

whenUnsatisfiable string

volumes []object

Additional volumes that can be mounted to the pod.

configMap object

`ConfigMap` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

name string

optional boolean

csi object

`CSIVolumeSource` object to use to populate the volume.

driver string

fsType string

nodePublishSecretRef object

name string

readOnly boolean

volumeAttributes object

emptyDir object

`EmptyDir` to use to populate the volume.

medium string

Medium represents the type of storage medium should back this volume. Valid values are unset or `Memory`. When not set, it will use the node's default medium.

enum: Memory

sizeLimit string

The total amount of local storage required for this EmptyDir volume (for example 1Gi).

pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$

image object

`ImageVolumeSource` object to use to populate the volume.

pullPolicy string

reference string

name string

Name to use for the volume. Required.

persistentVolumeClaim object

`PersistentVolumeClaim` object to use to populate the volume.

claimName string

readOnly boolean

secret object

`Secret` to use to populate the volume.

defaultMode integer

items []object

key string

mode integer

path string

optional boolean

secretName string

podDisruptionBudget object

Template for the Pod Disruption Budget for Kafka Exporter pods.

maxUnavailable integer

minimum: 0

metadata object

Metadata to apply to the `PodDisruptionBudgetTemplate` resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

serviceAccount object

Template for the Kafka Exporter service account.

metadata object

Metadata applied to the resource.

annotations object

Annotations added to the Kubernetes resource.

labels object

Labels added to the Kubernetes resource.

topicExcludeRegex string

Regular expression to specify which topics to exclude.

topicRegex string

Regular expression to specify which topics to collect. Default value is `.*`.

maintenanceTimeWindows []string

A list of time windows for maintenance tasks (that is, certificates renewal). Each time window is defined by a cron expression.

status object

The status of the Kafka cluster.

autoRebalance object

The status of an auto-rebalancing triggered by a cluster scaling request.

lastTransitionTime string

The timestamp of the latest auto-rebalancing state update.

modes []object

List of modes where an auto-rebalancing operation is either running or queued. Each mode entry (`add-brokers` or `remove-brokers`) includes one of the following: * Broker IDs for a current auto-rebalance. * Broker IDs for a queued auto-rebalance (if a previous rebalance is still in progress).

brokers []integer

List of broker IDs involved in an auto-rebalancing operation related to the current mode. The list contains one of the following: * Broker IDs for a current auto-rebalance. * Broker IDs for a queued auto-rebalance (if a previous auto-rebalance is still in progress).

mode string

Mode for which there is an auto-rebalancing operation in progress or queued, when brokers are added or removed. The possible modes are `add-brokers` and `remove-brokers`.

enum: add-brokers, remove-brokers

state string

The current state of an auto-rebalancing operation. Possible values are: * `Idle` as the initial state when an auto-rebalancing is requested or as final state when it completes or fails. * `RebalanceOnScaleDown` if an auto-rebalance related to a scale-down operation is running. * `RebalanceOnScaleUp` if an auto-rebalance related to a scale-up operation is running.

enum: Idle, RebalanceOnScaleDown, RebalanceOnScaleUp

clusterId string

Kafka cluster Id.

conditions []object

List of status conditions.

lastTransitionTime string

Last time the condition of a type changed from one status to another. The required format is 'yyyy-MM-ddTHH:mm:ssZ', in the UTC time zone.

message string

Human-readable message indicating details about the condition's last transition.

reason string

The reason for the condition's last transition (a single word in CamelCase).

status string

The status of the condition, either True, False or Unknown.

type string

The unique identifier of a condition, used to distinguish between other conditions in the resource.

kafkaMetadataVersion string

The KRaft metadata.version currently used by the Kafka cluster.

kafkaNodePools []object

List of the KafkaNodePools used by this Kafka cluster.

name string

The name of the KafkaNodePool used by this Kafka resource.

kafkaVersion string

The version of Kafka currently deployed in the cluster.

listeners []object

Addresses of the internal and external listeners.

addresses []object

A list of the addresses for this listener.

host string

The DNS name or IP address of the Kafka bootstrap service.

port integer

The port of the Kafka bootstrap service.

bootstrapServers string

A comma-separated list of `host:port` pairs for connecting to the Kafka cluster using this listener.

certificates []string

A list of TLS certificates which can be used to verify the identity of the server when connecting to the given listener. Set only for `tls` and `external` listeners.

name string

The name of the listener.

observedGeneration integer

The generation of the CRD that was last reconciled by the operator.

operatorLastSuccessfulVersion string

The version of the Strimzi Cluster Operator which performed the last successful reconciliation.

No matches. Try .spec.clientsCa for an exact path