// This file is auto-generated by io.strimzi.crdgenerator.DocGenerator.
// To change this documentation you need to edit the Java sources.

[id='type-Kafka-{context}']
= `Kafka` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaSpec-{context}[`KafkaSpec`]
|The specification of the Kafka cluster.
|status
|xref:type-KafkaStatus-{context}[`KafkaStatus`]
|The status of the Kafka cluster.
|====

[id='type-KafkaSpec-{context}']
= `KafkaSpec` schema reference

Used in: xref:type-Kafka-{context}[`Kafka`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|kafka
|xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]
|Configuration of the Kafka cluster.
|zookeeper
|xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]
|**The `zookeeper` property has been deprecated.** ZooKeeper-based Apache Kafka clusters are not supported anymore since Strimzi 0.46.0. As of Strimzi 0.46.0, ZooKeeper-based Apache Kafka clusters are not supported anymore and this option is ignored.
|entityOperator
|xref:type-EntityOperatorSpec-{context}[`EntityOperatorSpec`]
|Configuration of the Entity Operator.
|clusterCa
|xref:type-CertificateAuthority-{context}[`CertificateAuthority`]
|Configuration of the cluster certificate authority.
|clientsCa
|xref:type-CertificateAuthority-{context}[`CertificateAuthority`]
|Configuration of the clients certificate authority.
|cruiseControl
|xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`]
|Configuration for Cruise Control deployment. Deploys a Cruise Control instance when specified.
|jmxTrans
|xref:type-JmxTransSpec-{context}[`JmxTransSpec`]
|**The `jmxTrans` property has been deprecated.** JMXTrans is deprecated and related resources removed in Strimzi 0.35.0. As of Strimzi 0.35.0, JMXTrans is not supported anymore and this option is ignored.
|kafkaExporter
|xref:type-KafkaExporterSpec-{context}[`KafkaExporterSpec`]
|Configuration of the Kafka Exporter. Kafka Exporter can provide additional metrics, for example lag of consumer group at topic/partition.
|maintenanceTimeWindows
|string array
|A list of time windows for maintenance tasks (that is, certificates renewal). Each time window is defined by a cron expression.
|====

[id='type-KafkaClusterSpec-{context}']
= `KafkaClusterSpec` schema reference

Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]

xref:type-KafkaClusterSpec-schema-{context}[Full list of `KafkaClusterSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.KafkaClusterSpec.adoc[leveloffset=+1]

[id='type-KafkaClusterSpec-schema-{context}']
== `KafkaClusterSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|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.
|metadataVersion
|string
|Added in Strimzi 0.39.0. 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.
|replicas
|integer
|**The `replicas` property has been deprecated.** Use `KafkaNodePool` resources. Replicas are now configured in `KafkaNodePool` resources and this option is ignored.
|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. 
|listeners
|xref:type-GenericKafkaListener-{context}[`GenericKafkaListener`] array
|Configures listeners to provide access to Kafka brokers.
|config
|map
|Kafka broker config properties with the following prefixes cannot be set: listeners, advertised., broker., listener., host.name, port, inter.broker.listener.name, sasl., ssl., security., password., log.dir, zookeeper.connect, zookeeper.set.acl, zookeeper.ssl, zookeeper.clientCnxnSocket, authorizer., super.user, cruise.control.metrics.topic, cruise.control.metrics.reporter.bootstrap.servers, node.id, process.roles, controller., metadata.log.dir, zookeeper.metadata.migration.enable, client.quota.callback.static.kafka.admin., client.quota.callback.static.produce, client.quota.callback.static.fetch, client.quota.callback.static.storage.per.volume.limit.min.available., client.quota.callback.static.excluded.principal.name.list, prometheus.metrics.reporter. (with the exception of: zookeeper.connection.timeout.ms, sasl.server.max.receive.size, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols, ssl.secure.random.implementation, cruise.control.metrics.topic.num.partitions, cruise.control.metrics.topic.replication.factor, cruise.control.metrics.topic.retention.ms, cruise.control.metrics.topic.auto.create.retries, cruise.control.metrics.topic.auto.create.timeout.ms, cruise.control.metrics.topic.min.insync.replicas, broker.session.timeout.ms, broker.heartbeat.interval.ms, controller.socket.timeout.ms, controller.quorum.election.backoff.max.ms, controller.quorum.election.timeout.ms, controller.quorum.fetch.timeout.ms).
|storage
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`], xref:type-JbodStorage-{context}[`JbodStorage`]
|**The `storage` property has been deprecated.** Use `KafkaNodePool` resources. Storage is now configured in the `KafkaNodePool` resources and this option is ignored.
|authorization
|xref:type-KafkaAuthorizationSimple-{context}[`KafkaAuthorizationSimple`], xref:type-KafkaAuthorizationOpa-{context}[`KafkaAuthorizationOpa`], xref:type-KafkaAuthorizationKeycloak-{context}[`KafkaAuthorizationKeycloak`], xref:type-KafkaAuthorizationCustom-{context}[`KafkaAuthorizationCustom`]
|Authorization configuration for Kafka brokers.
|rack
|xref:type-Rack-{context}[`Rack`]
|Configuration of the `broker.rack` broker config.
|brokerRackInitImage
|string
|The image of the init container used for initializing the `broker.rack`.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|jmxOptions
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|JMX Options for Kafka brokers.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|metricsConfig
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`], xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`]
|Metrics configuration.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration for Kafka.
|template
|xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`]
|Template for Kafka cluster resources. The template allows users to specify how the Kubernetes resources are generated.
|tieredStorage
|xref:type-TieredStorageCustom-{context}[`TieredStorageCustom`]
|Configure the tiered storage feature for Kafka brokers.
|quotas
|xref:type-QuotasPluginKafka-{context}[`QuotasPluginKafka`], xref:type-QuotasPluginStrimzi-{context}[`QuotasPluginStrimzi`]
|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.
|====

[id='type-GenericKafkaListener-{context}']
= `GenericKafkaListener` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]

xref:type-GenericKafkaListener-schema-{context}[Full list of `GenericKafkaListener` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListener.adoc[leveloffset=+1]

[id='type-GenericKafkaListener-schema-{context}']
== `GenericKafkaListener` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|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.
|port
|integer
|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.
|type
|string (one of [ingress, internal, route, loadbalancer, cluster-ip, nodeport])
|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` type uses Kubernetes Nginx Ingress to expose Kafka with TLS passthrough.
* `cluster-ip` type uses a per-broker `ClusterIP` service.

|tls
|boolean
|Enables TLS encryption on the listener. This is a required property. For `route` and `ingress` type listeners, TLS encryption must be always enabled.
|authentication
|xref:type-KafkaListenerAuthenticationTls-{context}[`KafkaListenerAuthenticationTls`], xref:type-KafkaListenerAuthenticationScramSha512-{context}[`KafkaListenerAuthenticationScramSha512`], xref:type-KafkaListenerAuthenticationOAuth-{context}[`KafkaListenerAuthenticationOAuth`], xref:type-KafkaListenerAuthenticationCustom-{context}[`KafkaListenerAuthenticationCustom`]
|Authentication configuration for this listener.
|configuration
|xref:type-GenericKafkaListenerConfiguration-{context}[`GenericKafkaListenerConfiguration`]
|Additional listener configuration.
|networkPolicyPeers
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#networkpolicypeer-v1-networking-k8s-io[NetworkPolicyPeer] array
|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.
|====

[id='type-KafkaListenerAuthenticationTls-{context}']
= `KafkaListenerAuthenticationTls` schema reference

Used in: xref:type-GenericKafkaListener-{context}[`GenericKafkaListener`]


The `type` property is a discriminator that distinguishes use of the `KafkaListenerAuthenticationTls` type from xref:type-KafkaListenerAuthenticationScramSha512-{context}[`KafkaListenerAuthenticationScramSha512`], xref:type-KafkaListenerAuthenticationOAuth-{context}[`KafkaListenerAuthenticationOAuth`], xref:type-KafkaListenerAuthenticationCustom-{context}[`KafkaListenerAuthenticationCustom`].
It must have the value `tls` for the type `KafkaListenerAuthenticationTls`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `tls`.
|====

[id='type-KafkaListenerAuthenticationScramSha512-{context}']
= `KafkaListenerAuthenticationScramSha512` schema reference

Used in: xref:type-GenericKafkaListener-{context}[`GenericKafkaListener`]


The `type` property is a discriminator that distinguishes use of the `KafkaListenerAuthenticationScramSha512` type from xref:type-KafkaListenerAuthenticationTls-{context}[`KafkaListenerAuthenticationTls`], xref:type-KafkaListenerAuthenticationOAuth-{context}[`KafkaListenerAuthenticationOAuth`], xref:type-KafkaListenerAuthenticationCustom-{context}[`KafkaListenerAuthenticationCustom`].
It must have the value `scram-sha-512` for the type `KafkaListenerAuthenticationScramSha512`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `scram-sha-512`.
|====

[id='type-KafkaListenerAuthenticationOAuth-{context}']
= `KafkaListenerAuthenticationOAuth` schema reference

Used in: xref:type-GenericKafkaListener-{context}[`GenericKafkaListener`]


The `type` property is a discriminator that distinguishes use of the `KafkaListenerAuthenticationOAuth` type from xref:type-KafkaListenerAuthenticationTls-{context}[`KafkaListenerAuthenticationTls`], xref:type-KafkaListenerAuthenticationScramSha512-{context}[`KafkaListenerAuthenticationScramSha512`], xref:type-KafkaListenerAuthenticationCustom-{context}[`KafkaListenerAuthenticationCustom`].
It must have the value `oauth` for the type `KafkaListenerAuthenticationOAuth`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `oauth`.
|clientId
|string
|OAuth Client ID which the Kafka broker can use to authenticate against the authorization server and use the introspect endpoint URI.
|clientSecret
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|Link to Kubernetes Secret containing the OAuth client secret which the Kafka broker can use to authenticate against the authorization server and use the introspect endpoint URI.
|validIssuerUri
|string
|URI of the token issuer used for authentication.
|checkIssuer
|boolean
|Enable or disable issuer checking. By default issuer is checked using the value configured by `validIssuerUri`. Default value is `true`.
|checkAudience
|boolean
|Enable or disable audience checking. Audience checks identify the recipients of tokens. If audience checking is enabled, the OAuth Client ID also has to be configured using the `clientId` property. The Kafka broker will reject tokens that do not have its `clientId` in their `aud` (audience) claim.Default value is `false`.
|jwksEndpointUri
|string
|URI of the JWKS certificate endpoint, which can be used for local JWT validation.
|jwksRefreshSeconds
|integer
|Configures how often are the JWKS certificates refreshed. The refresh interval has to be at least 60 seconds shorter then the expiry interval specified in `jwksExpirySeconds`. Defaults to 300 seconds.
|jwksMinRefreshPauseSeconds
|integer
|The minimum pause between two consecutive refreshes. When an unknown signing key is encountered the refresh is scheduled immediately, but will always wait for this minimum pause. Defaults to 1 second.
|jwksExpirySeconds
|integer
|Configures how often are the JWKS certificates considered valid. The expiry interval has to be at least 60 seconds longer then the refresh interval specified in `jwksRefreshSeconds`. Defaults to 360 seconds.
|jwksIgnoreKeyUse
|boolean
|Flag to ignore the 'use' attribute of `key` declarations in a JWKS endpoint response. Default value is `false`.
|introspectionEndpointUri
|string
|URI of the token introspection endpoint which can be used to validate opaque non-JWT tokens.
|userNameClaim
|string
|Name of the claim from the JWT authentication token, Introspection Endpoint response or User Info Endpoint response which will be used to extract the user id. Defaults to `sub`.
|fallbackUserNameClaim
|string
|The fallback username claim to be used for the user ID if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client ID being provided in another claim. It only takes effect if `userNameClaim` is set.
|fallbackUserNamePrefix
|string
|The prefix to use with the value of `fallbackUserNameClaim` to construct the user id. This only takes effect if `fallbackUserNameClaim` is true, and the value is present for the claim. Mapping usernames and client ids into the same user id space is useful in preventing name collisions.
|groupsClaim
|string
|JsonPath query used to extract groups for the user during authentication. Extracted groups can be used by a custom authorizer. By default no groups are extracted.
|groupsClaimDelimiter
|string
|A delimiter used to parse groups when they are extracted as a single String value rather than a JSON array. Default value is ',' (comma).
|userInfoEndpointUri
|string
|URI of the User Info Endpoint to use as a fallback to obtaining the user id when the Introspection Endpoint does not return information that can be used for the user id. 
|checkAccessTokenType
|boolean
|Configure whether the access token type check is performed or not. This should be set to `false` if the authorization server does not include 'typ' claim in JWT token. Defaults to `true`.
|validTokenType
|string
|Valid value for the `token_type` attribute returned by the Introspection Endpoint. No default value, and not checked by default.
|accessTokenIsJwt
|boolean
|Configure whether the access token is treated as JWT. This must be set to `false` if the authorization server returns opaque tokens. Defaults to `true`.
|tlsTrustedCertificates
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|Trusted certificates for TLS connection to the OAuth server.
|disableTlsHostnameVerification
|boolean
|Enable or disable TLS hostname verification. Default value is `false`.
|enableECDSA
|boolean
|**The `enableECDSA` property has been deprecated.** Enable or disable ECDSA support by installing BouncyCastle crypto provider. ECDSA support is always enabled. The BouncyCastle libraries are no longer packaged with Strimzi. Value is ignored.
|maxSecondsWithoutReauthentication
|integer
|Maximum number of seconds the authenticated session remains valid without re-authentication. This enables Apache Kafka re-authentication feature, and causes sessions to expire when the access token expires. If the access token expires before max time or if max time is reached, the client has to re-authenticate, otherwise the server will drop the connection. Not set by default - the authenticated session does not expire when the access token expires. This option only applies to SASL_OAUTHBEARER authentication mechanism (when `enableOauthBearer` is `true`).
|enablePlain
|boolean
|Enable or disable OAuth authentication over SASL_PLAIN. There is no re-authentication support when this mechanism is used. Default value is `false`.
|tokenEndpointUri
|string
|URI of the Token Endpoint to use with SASL_PLAIN mechanism when the client authenticates with `clientId` and a `secret`. If set, the client can authenticate over SASL_PLAIN by either setting `username` to `clientId`, and setting `password` to client `secret`, or by setting `username` to account username, and `password` to access token prefixed with `$accessToken:`. If this option is not set, the `password` is always interpreted as an access token (without a prefix), and `username` as the account username (a so called 'no-client-credentials' mode).
|enableOauthBearer
|boolean
|Enable or disable OAuth authentication over SASL_OAUTHBEARER. Default value is `true`.
|customClaimCheck
|string
|JsonPath filter query to be applied to the JWT token or to the response of the introspection endpoint for additional token validation. Not set by default.
|connectTimeoutSeconds
|integer
|The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
|readTimeoutSeconds
|integer
|The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
|httpRetries
|integer
|The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
|httpRetryPauseMs
|integer
|The pause to take before retrying a failed HTTP request. If not set, the default is to not pause at all but to immediately repeat a request.
|clientScope
|string
|The scope to use when making requests to the authorization server's token endpoint. Used for inter-broker authentication and for configuring OAuth 2.0 over PLAIN using the `clientId` and `secret` method.
|clientAudience
|string
|The audience to use when making requests to the authorization server's token endpoint. Used for inter-broker authentication and for configuring OAuth 2.0 over PLAIN using the `clientId` and `secret` method.
|clientGrantType
|string
|The grant type to use when making requests to the authorization server's token endpoint. Used for `OAuth over PLAIN` when `username` and `password` passed via SASL_PLAIN client authentication are passed on to the authorization server as `clientId` and `secret`.
|enableMetrics
|boolean
|Enable or disable OAuth metrics. Default value is `false`.
|failFast
|boolean
|Enable or disable termination of Kafka broker processes due to potentially recoverable runtime errors during startup. Default value is `true`.
|includeAcceptHeader
|boolean
|Whether the Accept header should be set in requests to the authorization servers. The default value is `true`.
|serverBearerTokenLocation
|string
|Path to the file on the local filesystem that contains a bearer token to be used instead of client ID and secret when authenticating to authorization server.
|userNamePrefix
|string
|The prefix to use with the value of `userNameClaim` to construct the user ID. This only takes effect if `userNameClaim` is specified and the value is present for the claim. When used in combination with `fallbackUserNameClaims`, it ensures consistent mapping of usernames and client IDs into the same user ID space and prevents name collisions.
|====

[id='type-GenericSecretSource-{context}']
= `GenericSecretSource` schema reference

Used in: xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaListenerAuthenticationCustom-{context}[`KafkaListenerAuthenticationCustom`], xref:type-KafkaListenerAuthenticationOAuth-{context}[`KafkaListenerAuthenticationOAuth`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|key
|string
|The key under which the secret value is stored in the Kubernetes Secret.
|secretName
|string
|The name of the Kubernetes Secret containing the secret value.
|====

[id='type-CertSecretSource-{context}']
= `CertSecretSource` schema reference

Used in: xref:type-ClientTls-{context}[`ClientTls`], xref:type-KafkaAuthorizationKeycloak-{context}[`KafkaAuthorizationKeycloak`], xref:type-KafkaAuthorizationOpa-{context}[`KafkaAuthorizationOpa`], xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaListenerAuthenticationOAuth-{context}[`KafkaListenerAuthenticationOAuth`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|secretName
|string
|The name of the Secret containing the certificate.
|certificate
|string
|The name of the file certificate in the secret.
|pattern
|string
|Pattern for the certificate files in the secret. Use the link:https://en.wikipedia.org/wiki/Glob_(programming)[_glob syntax_] for the pattern. All files in the secret that match the pattern are used.
|====

[id='type-KafkaListenerAuthenticationCustom-{context}']
= `KafkaListenerAuthenticationCustom` schema reference

Used in: xref:type-GenericKafkaListener-{context}[`GenericKafkaListener`]

xref:type-KafkaListenerAuthenticationCustom-schema-{context}[Full list of `KafkaListenerAuthenticationCustom` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.listener.KafkaListenerAuthenticationCustom.adoc[leveloffset=+1]

[id='type-KafkaListenerAuthenticationCustom-schema-{context}']
== `KafkaListenerAuthenticationCustom` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaListenerAuthenticationCustom` type from xref:type-KafkaListenerAuthenticationTls-{context}[`KafkaListenerAuthenticationTls`], xref:type-KafkaListenerAuthenticationScramSha512-{context}[`KafkaListenerAuthenticationScramSha512`], xref:type-KafkaListenerAuthenticationOAuth-{context}[`KafkaListenerAuthenticationOAuth`].
It must have the value `custom` for the type `KafkaListenerAuthenticationCustom`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `custom`.
|sasl
|boolean
|Enable or disable SASL on this listener.
|listenerConfig
|map
|Configuration to be used for a specific listener. All values are prefixed with `listener.name.<listener_name>`.
|secrets
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`] array
|**The `secrets` property has been deprecated.** Please use the template section to configure additional volumes instead. Secrets to be mounted to `/opt/kafka/custom-authn-secrets/custom-listener-<listener_name>-<port>/<secret_name>`.
|====

[id='type-GenericKafkaListenerConfiguration-{context}']
= `GenericKafkaListenerConfiguration` schema reference

Used in: xref:type-GenericKafkaListener-{context}[`GenericKafkaListener`]

xref:type-GenericKafkaListenerConfiguration-schema-{context}[Full list of `GenericKafkaListenerConfiguration` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc[leveloffset=+1]

[id='type-GenericKafkaListenerConfiguration-schema-{context}']
== `GenericKafkaListenerConfiguration` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|brokerCertChainAndKey
|xref:type-CertAndKeySecretSource-{context}[`CertAndKeySecretSource`]
|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.
|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.
|externalTrafficPolicy
|string (one of [Local, Cluster])
|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.
|loadBalancerSourceRanges
|string array
|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.
|bootstrap
|xref:type-GenericKafkaListenerConfigurationBootstrap-{context}[`GenericKafkaListenerConfigurationBootstrap`]
|Bootstrap configuration.
|brokers
|xref:type-GenericKafkaListenerConfigurationBroker-{context}[`GenericKafkaListenerConfigurationBroker`] array
|Per-broker configurations.
|ipFamilyPolicy
|string (one of [RequireDualStack, SingleStack, PreferDualStack])
|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.
|ipFamilies
|string (one or more of [IPv6, IPv4]) array
|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.
|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.
|finalizers
|string array
|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.
|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.
|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.
|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.
|preferredNodePortAddressType
|string (one of [ExternalDNS, ExternalIP, Hostname, InternalIP, InternalDNS])
|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.
|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.
|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}`.
|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}`.
|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.
|====

[id='type-CertAndKeySecretSource-{context}']
= `CertAndKeySecretSource` schema reference

Used in: xref:type-GenericKafkaListenerConfiguration-{context}[`GenericKafkaListenerConfiguration`], xref:type-KafkaClientAuthenticationTls-{context}[`KafkaClientAuthenticationTls`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|secretName
|string
|The name of the Secret containing the certificate.
|certificate
|string
|The name of the file certificate in the Secret.
|key
|string
|The name of the private key in the Secret.
|====

[id='type-GenericKafkaListenerConfigurationBootstrap-{context}']
= `GenericKafkaListenerConfigurationBootstrap` schema reference

Used in: xref:type-GenericKafkaListenerConfiguration-{context}[`GenericKafkaListenerConfiguration`]

xref:type-GenericKafkaListenerConfigurationBootstrap-schema-{context}[Full list of `GenericKafkaListenerConfigurationBootstrap` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfigurationBootstrap.adoc[leveloffset=+1]

[id='type-GenericKafkaListenerConfigurationBootstrap-schema-{context}']
== `GenericKafkaListenerConfigurationBootstrap` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|alternativeNames
|string array
|Additional alternative names for the bootstrap service. The alternative names will be added to the list of subject alternative names of the TLS certificates.
|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.
|nodePort
|integer
|Node port for the bootstrap service. For `nodeport` 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.
|annotations
|map
|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.
|labels
|map
|Labels added to `Ingress`, `Route`, or `Service` resources. For `loadbalancer`, `nodeport`, `route`, or `ingress` listeners only.
|externalIPs
|string array
|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.
|====

[id='type-GenericKafkaListenerConfigurationBroker-{context}']
= `GenericKafkaListenerConfigurationBroker` schema reference

Used in: xref:type-GenericKafkaListenerConfiguration-{context}[`GenericKafkaListenerConfiguration`]

xref:type-GenericKafkaListenerConfigurationBroker-schema-{context}[Full list of `GenericKafkaListenerConfigurationBroker` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfigurationBroker.adoc[leveloffset=+1]

[id='type-GenericKafkaListenerConfigurationBroker-schema-{context}']
== `GenericKafkaListenerConfigurationBroker` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|broker
|integer
|ID of the kafka broker (broker identifier). Broker IDs start from 0 and correspond to the number of broker replicas.
|advertisedHost
|string
|The host name used in the brokers' `advertised.listeners`.
|advertisedPort
|integer
|The port number used in the brokers' `advertised.listeners`.
|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.
|nodePort
|integer
|Node port for the per-broker service. This field can be used only with `nodeport` type listener.
|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.
|annotations
|map
|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.
|labels
|map
|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.
|externalIPs
|string array
|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.
|====

[id='type-EphemeralStorage-{context}']
= `EphemeralStorage` schema reference

Used in: xref:type-JbodStorage-{context}[`JbodStorage`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaNodePoolSpec-{context}[`KafkaNodePoolSpec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `EphemeralStorage` type from xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`].
It must have the value `ephemeral` for the type `EphemeralStorage`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|id
|integer
|Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.
|sizeLimit
|string
|When type=ephemeral, defines the total amount of local storage required for this EmptyDir volume (for example 1Gi).
|type
|string
|Must be `ephemeral`.
|kraftMetadata
|string (one of [shared])
|Specifies whether this volume should be used for storing KRaft metadata. This property is optional. When set, the only currently supported value is `shared`. At most one volume can have this property set.
|====

[id='type-PersistentClaimStorage-{context}']
= `PersistentClaimStorage` schema reference

Used in: xref:type-JbodStorage-{context}[`JbodStorage`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaNodePoolSpec-{context}[`KafkaNodePoolSpec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `PersistentClaimStorage` type from xref:type-EphemeralStorage-{context}[`EphemeralStorage`].
It must have the value `persistent-claim` for the type `PersistentClaimStorage`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|id
|integer
|Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.
|type
|string
|Must be `persistent-claim`.
|size
|string
|When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`.
|kraftMetadata
|string (one of [shared])
|Specifies whether this volume should be used for storing KRaft metadata. This property is optional. When set, the only currently supported value is `shared`. At most one volume can have this property set.
|class
|string
|The storage class to use for dynamic volume allocation.
|selector
|map
|Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
|deleteClaim
|boolean
|Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
|overrides
|xref:type-PersistentClaimStorageOverride-{context}[`PersistentClaimStorageOverride`] array
|**The `overrides` property has been deprecated.** The storage overrides for individual brokers are not supported anymore since Strimzi 0.46.0. As of Strimzi 0.46.0, the storage overrides for individual brokers are not supported anymore and this option is ignored.
|====

[id='type-PersistentClaimStorageOverride-{context}']
= `PersistentClaimStorageOverride` schema reference

Used in: xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|class
|string
|The storage class to use for dynamic volume allocation for this broker.
|broker
|integer
|Id of the kafka broker (broker identifier).
|====

[id='type-JbodStorage-{context}']
= `JbodStorage` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaNodePoolSpec-{context}[`KafkaNodePoolSpec`]


The `type` property is a discriminator that distinguishes use of the `JbodStorage` type from xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`].
It must have the value `jbod` for the type `JbodStorage`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `jbod`.
|volumes
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`] array
|List of volumes as Storage objects representing the JBOD disks array.
|====

[id='type-KafkaAuthorizationSimple-{context}']
= `KafkaAuthorizationSimple` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]

xref:type-KafkaAuthorizationSimple-schema-{context}[Full list of `KafkaAuthorizationSimple` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.KafkaAuthorizationSimple.adoc[leveloffset=+1]

[id='type-KafkaAuthorizationSimple-schema-{context}']
== `KafkaAuthorizationSimple` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaAuthorizationSimple` type from xref:type-KafkaAuthorizationOpa-{context}[`KafkaAuthorizationOpa`], xref:type-KafkaAuthorizationKeycloak-{context}[`KafkaAuthorizationKeycloak`], xref:type-KafkaAuthorizationCustom-{context}[`KafkaAuthorizationCustom`].
It must have the value `simple` for the type `KafkaAuthorizationSimple`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `simple`.
|superUsers
|string array
|List of super users. Should contain list of user principals which should get unlimited access rights.
|====

[id='type-KafkaAuthorizationOpa-{context}']
= `KafkaAuthorizationOpa` schema reference

*The type `KafkaAuthorizationOpa` has been deprecated.*
Please use xref:type-KafkaAuthorizationCustom-{context}[`KafkaAuthorizationCustom`] instead.

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]

xref:type-KafkaAuthorizationOpa-schema-{context}[Full list of `KafkaAuthorizationOpa` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.KafkaAuthorizationOpa.adoc[leveloffset=+1]

[id='type-KafkaAuthorizationOpa-schema-{context}']
== `KafkaAuthorizationOpa` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaAuthorizationOpa` type from xref:type-KafkaAuthorizationSimple-{context}[`KafkaAuthorizationSimple`], xref:type-KafkaAuthorizationKeycloak-{context}[`KafkaAuthorizationKeycloak`], xref:type-KafkaAuthorizationCustom-{context}[`KafkaAuthorizationCustom`].
It must have the value `opa` for the type `KafkaAuthorizationOpa`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `opa`.
|url
|string
|The URL used to connect to the Open Policy Agent server. The URL has to include the policy which will be queried by the authorizer. This option is required.
|allowOnError
|boolean
|Defines whether a Kafka client should be allowed or denied by default when the authorizer fails to query the Open Policy Agent, for example, when it is temporarily unavailable). Defaults to `false` - all actions will be denied.
|initialCacheCapacity
|integer
|Initial capacity of the local cache used by the authorizer to avoid querying the Open Policy Agent for every request Defaults to `5000`.
|maximumCacheSize
|integer
|Maximum capacity of the local cache used by the authorizer to avoid querying the Open Policy Agent for every request. Defaults to `50000`.
|expireAfterMs
|integer
|The expiration of the records kept in the local cache to avoid querying the Open Policy Agent for every request. Defines how often the cached authorization decisions are reloaded from the Open Policy Agent server. In milliseconds. Defaults to `3600000`.
|tlsTrustedCertificates
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|Trusted certificates for TLS connection to the OPA server.
|superUsers
|string array
|List of super users, which is specifically a list of user principals that have unlimited access rights.
|enableMetrics
|boolean
|Defines whether the Open Policy Agent authorizer plugin should provide metrics. Defaults to `false`.
|====

[id='type-KafkaAuthorizationKeycloak-{context}']
= `KafkaAuthorizationKeycloak` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `KafkaAuthorizationKeycloak` type from xref:type-KafkaAuthorizationSimple-{context}[`KafkaAuthorizationSimple`], xref:type-KafkaAuthorizationOpa-{context}[`KafkaAuthorizationOpa`], xref:type-KafkaAuthorizationCustom-{context}[`KafkaAuthorizationCustom`].
It must have the value `keycloak` for the type `KafkaAuthorizationKeycloak`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `keycloak`.
|clientId
|string
|OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
|tokenEndpointUri
|string
|Authorization server token endpoint URI.
|tlsTrustedCertificates
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|Trusted certificates for TLS connection to the OAuth server.
|disableTlsHostnameVerification
|boolean
|Enable or disable TLS hostname verification. Default value is `false`.
|delegateToKafkaAcls
|boolean
|Whether authorization decision should be delegated to the 'Simple' authorizer if DENIED by Keycloak Authorization Services policies. Default value is `false`.
|grantsRefreshPeriodSeconds
|integer
|The time between two consecutive grants refresh runs in seconds. The default value is 60.
|grantsRefreshPoolSize
|integer
|The number of threads to use to refresh grants for active sessions. The more threads, the more parallelism, so the sooner the job completes. However, using more threads places a heavier load on the authorization server. The default value is 5.
|grantsMaxIdleTimeSeconds
|integer
|The time, in seconds, after which an idle grant can be evicted from the cache. The default value is 300.
|grantsGcPeriodSeconds
|integer
|The time, in seconds, between consecutive runs of a job that cleans stale grants from the cache. The default value is 300.
|grantsAlwaysLatest
|boolean
|Controls whether the latest grants are fetched for a new session. When enabled, grants are retrieved from Keycloak and cached for the user. The default value is `false`.
|superUsers
|string array
|List of super users. Should contain list of user principals which should get unlimited access rights.
|connectTimeoutSeconds
|integer
|The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
|readTimeoutSeconds
|integer
|The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
|httpRetries
|integer
|The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
|enableMetrics
|boolean
|Enable or disable OAuth metrics. The default value is `false`.
|includeAcceptHeader
|boolean
|Whether the Accept header should be set in requests to the authorization servers. The default value is `true`.
|====

[id='type-KafkaAuthorizationCustom-{context}']
= `KafkaAuthorizationCustom` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]

xref:type-KafkaAuthorizationCustom-schema-{context}[Full list of `KafkaAuthorizationCustom` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.KafkaAuthorizationCustom.adoc[leveloffset=+1]

[id='type-KafkaAuthorizationCustom-schema-{context}']
== `KafkaAuthorizationCustom` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaAuthorizationCustom` type from xref:type-KafkaAuthorizationSimple-{context}[`KafkaAuthorizationSimple`], xref:type-KafkaAuthorizationOpa-{context}[`KafkaAuthorizationOpa`], xref:type-KafkaAuthorizationKeycloak-{context}[`KafkaAuthorizationKeycloak`].
It must have the value `custom` for the type `KafkaAuthorizationCustom`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `custom`.
|authorizerClass
|string
|Authorization implementation class, which must be available in classpath.
|superUsers
|string array
|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`.
|====

[id='type-Rack-{context}']
= `Rack` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]

xref:type-Rack-schema-{context}[Full list of `Rack` schema properties]

include::../api/io.strimzi.api.kafka.model.common.Rack.adoc[leveloffset=+1]

[id='type-Rack-schema-{context}']
== `Rack` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|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.
|====

[id='type-Probe-{context}']
= `Probe` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`], xref:type-EntityTopicOperatorSpec-{context}[`EntityTopicOperatorSpec`], xref:type-EntityUserOperatorSpec-{context}[`EntityUserOperatorSpec`], xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaExporterSpec-{context}[`KafkaExporterSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`], xref:type-TlsSidecar-{context}[`TlsSidecar`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|initialDelaySeconds
|integer
|The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.
|timeoutSeconds
|integer
|The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.
|periodSeconds
|integer
|How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 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.
|failureThreshold
|integer
|Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
|====

[id='type-JvmOptions-{context}']
= `JvmOptions` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`], xref:type-EntityTopicOperatorSpec-{context}[`EntityTopicOperatorSpec`], xref:type-EntityUserOperatorSpec-{context}[`EntityUserOperatorSpec`], xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`], xref:type-KafkaNodePoolSpec-{context}[`KafkaNodePoolSpec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|-XX
|map
|A map of -XX options to the JVM.
|-Xmx
|string
|-Xmx option to to the JVM.
|-Xms
|string
|-Xms option to to the JVM.
|gcLoggingEnabled
|boolean
|Specifies whether the Garbage Collection logging is enabled. The default is false.
|javaSystemProperties
|xref:type-SystemProperty-{context}[`SystemProperty`] array
|A map of additional system properties which will be passed using the `-D` option to the JVM.
|====

[id='type-SystemProperty-{context}']
= `SystemProperty` schema reference

Used in: xref:type-JvmOptions-{context}[`JvmOptions`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|The system property name.
|value
|string
|The system property value.
|====

[id='type-KafkaJmxOptions-{context}']
= `KafkaJmxOptions` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]

xref:type-KafkaJmxOptions-schema-{context}[Full list of `KafkaJmxOptions` schema properties]

include::../api/io.strimzi.api.kafka.model.common.jmx.KafkaJmxOptions.adoc[leveloffset=+1]

[id='type-KafkaJmxOptions-schema-{context}']
== `KafkaJmxOptions` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|authentication
|xref:type-KafkaJmxAuthenticationPassword-{context}[`KafkaJmxAuthenticationPassword`]
|Authentication configuration for connecting to the JMX port.
|====

[id='type-KafkaJmxAuthenticationPassword-{context}']
= `KafkaJmxAuthenticationPassword` schema reference

Used in: xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]


The `type` property is a discriminator that distinguishes use of the `KafkaJmxAuthenticationPassword` type from other subtypes which may be added in the future.
It must have the value `password` for the type `KafkaJmxAuthenticationPassword`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `password`.
|====

[id='type-JmxPrometheusExporterMetrics-{context}']
= `JmxPrometheusExporterMetrics` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`], xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `JmxPrometheusExporterMetrics` type from xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`].
It must have the value `jmxPrometheusExporter` for the type `JmxPrometheusExporterMetrics`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `jmxPrometheusExporter`.
|valueFrom
|xref:type-ExternalConfigurationReference-{context}[`ExternalConfigurationReference`]
|ConfigMap entry where the Prometheus JMX Exporter configuration is stored.
|====

[id='type-ExternalConfigurationReference-{context}']
= `ExternalConfigurationReference` schema reference

Used in: xref:type-ExternalLogging-{context}[`ExternalLogging`], xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|configMapKeyRef
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#configmapkeyselector-v1-core[ConfigMapKeySelector]
|Reference to the key in the ConfigMap containing the configuration.
|====

[id='type-StrimziMetricsReporter-{context}']
= `StrimziMetricsReporter` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`], xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `StrimziMetricsReporter` type from xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`].
It must have the value `strimziMetricsReporter` for the type `StrimziMetricsReporter`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `strimziMetricsReporter`.
|values
|xref:type-StrimziMetricsReporterValues-{context}[`StrimziMetricsReporterValues`]
|Configuration values for the Strimzi Metrics Reporter.
|====

[id='type-StrimziMetricsReporterValues-{context}']
= `StrimziMetricsReporterValues` schema reference

Used in: xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|allowList
|string array
|A list of regex patterns to filter the metrics to collect. Should contain at least one element.
|====

[id='type-InlineLogging-{context}']
= `InlineLogging` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`], xref:type-EntityTopicOperatorSpec-{context}[`EntityTopicOperatorSpec`], xref:type-EntityUserOperatorSpec-{context}[`EntityUserOperatorSpec`], xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `InlineLogging` type from xref:type-ExternalLogging-{context}[`ExternalLogging`].
It must have the value `inline` for the type `InlineLogging`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `inline`.
|loggers
|map
|A Map from logger name to logger level.
|====

[id='type-ExternalLogging-{context}']
= `ExternalLogging` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`], xref:type-EntityTopicOperatorSpec-{context}[`EntityTopicOperatorSpec`], xref:type-EntityUserOperatorSpec-{context}[`EntityUserOperatorSpec`], xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `ExternalLogging` type from xref:type-InlineLogging-{context}[`InlineLogging`].
It must have the value `external` for the type `ExternalLogging`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `external`.
|valueFrom
|xref:type-ExternalConfigurationReference-{context}[`ExternalConfigurationReference`]
|`ConfigMap` entry where the logging configuration is stored. 
|====

[id='type-KafkaClusterTemplate-{context}']
= `KafkaClusterTemplate` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|statefulset
|xref:type-StatefulSetTemplate-{context}[`StatefulSetTemplate`]
|**The `statefulset` property has been deprecated.** Support for StatefulSets was removed in Strimzi 0.35.0. This property is ignored. Template for Kafka `StatefulSet`.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Kafka `Pods`.
|bootstrapService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for Kafka bootstrap `Service`.
|brokersService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for Kafka broker `Service`.
|externalBootstrapService
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka external bootstrap `Service`.
|perPodService
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka per-pod `Services` used for access from outside of Kubernetes.
|externalBootstrapRoute
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka external bootstrap `Route`.
|perPodRoute
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka per-pod `Routes` used for access from outside of OpenShift.
|externalBootstrapIngress
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka external bootstrap `Ingress`.
|perPodIngress
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka per-pod `Ingress` used for access from outside of Kubernetes.
|persistentVolumeClaim
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for all Kafka `PersistentVolumeClaims`.
|podDisruptionBudget
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|Template for Kafka `PodDisruptionBudget`.
|kafkaContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka broker container.
|initContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka init container.
|clusterCaCert
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Secret with Kafka Cluster certificate public key.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka service account.
|jmxSecret
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Secret of the Kafka Cluster JMX authentication.
|clusterRoleBinding
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka ClusterRoleBinding.
|podSet
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka `StrimziPodSet` resource.
|====

[id='type-StatefulSetTemplate-{context}']
= `StatefulSetTemplate` schema reference

Used in: xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|metadata
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|Metadata applied to the resource.
|podManagementPolicy
|string (one of [OrderedReady, Parallel])
|PodManagementPolicy which will be used for this StatefulSet. Valid values are `Parallel` and `OrderedReady`. Defaults to `Parallel`.
|====

[id='type-MetadataTemplate-{context}']
= `MetadataTemplate` schema reference

Used in: xref:type-BuildConfigTemplate-{context}[`BuildConfigTemplate`], xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`], xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`], xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`], xref:type-PodTemplate-{context}[`PodTemplate`], xref:type-ResourceTemplate-{context}[`ResourceTemplate`], xref:type-StatefulSetTemplate-{context}[`StatefulSetTemplate`]

xref:type-MetadataTemplate-schema-{context}[Full list of `MetadataTemplate` schema properties]

include::../api/io.strimzi.api.kafka.model.common.template.MetadataTemplate.adoc[leveloffset=+1]

[id='type-MetadataTemplate-schema-{context}']
== `MetadataTemplate` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|labels
|map
|Labels added to the Kubernetes resource.
|annotations
|map
|Annotations added to the Kubernetes resource.
|====

[id='type-PodTemplate-{context}']
= `PodTemplate` schema reference

Used in: xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`], xref:type-EntityOperatorTemplate-{context}[`EntityOperatorTemplate`], xref:type-JmxTransTemplate-{context}[`JmxTransTemplate`], xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`], xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`], xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`], xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`], xref:type-KafkaNodePoolTemplate-{context}[`KafkaNodePoolTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]

xref:type-PodTemplate-schema-{context}[Full list of `PodTemplate` schema properties]

include::../api/io.strimzi.api.kafka.model.common.template.PodTemplate.adoc[leveloffset=+1]

[id='type-PodTemplate-schema-{context}']
== `PodTemplate` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|metadata
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|Metadata applied to the resource.
|imagePullSecrets
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#localobjectreference-v1-core[LocalObjectReference] array
|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.
|securityContext
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#podsecuritycontext-v1-core[PodSecurityContext]
|Configures pod-level security attributes and common container settings.
|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.
|affinity
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#affinity-v1-core[Affinity]
|The pod's affinity rules.
|tolerations
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#toleration-v1-core[Toleration] array
|The pod's tolerations.
|topologySpreadConstraints
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#topologyspreadconstraint-v1-core[TopologySpreadConstraint] array
|The pod's topology spread constraints.
|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.
|hostAliases
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#hostalias-v1-core[HostAlias] array
|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.
|dnsPolicy
|string (one of [ClusterFirstWithHostNet, ClusterFirst, Default, None])
|The pod's DNSPolicy. Defaults to `ClusterFirst`. Valid values are `ClusterFirstWithHostNet`, `ClusterFirst`, `Default` or `None`.
|dnsConfig
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#poddnsconfig-v1-core[PodDNSConfig]
|The pod's DNSConfig. If specified, it will be merged to the generated DNS configuration based on the DNSPolicy.
|enableServiceLinks
|boolean
|Indicates whether information about services should be injected into Pod's environment variables.
|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.
|volumes
|xref:type-AdditionalVolume-{context}[`AdditionalVolume`] array
|Additional volumes that can be mounted to the pod.
|====

[id='type-AdditionalVolume-{context}']
= `AdditionalVolume` schema reference

Used in: xref:type-PodTemplate-{context}[`PodTemplate`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|Name to use for the volume. Required.
|secret
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#secretvolumesource-v1-core[SecretVolumeSource]
|`Secret` to use to populate the volume.
|configMap
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#configmapvolumesource-v1-core[ConfigMapVolumeSource]
|`ConfigMap` to use to populate the volume.
|emptyDir
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#emptydirvolumesource-v1-core[EmptyDirVolumeSource]
|`EmptyDir` to use to populate the volume.
|persistentVolumeClaim
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#persistentvolumeclaimvolumesource-v1-core[PersistentVolumeClaimVolumeSource]
|`PersistentVolumeClaim` object to use to populate the volume.
|csi
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#csivolumesource-v1-core[CSIVolumeSource]
|`CSIVolumeSource` object to use to populate the volume.
|image
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#imagevolumesource-v1-core[ImageVolumeSource]
|`ImageVolumeSource` object to use to populate the volume.
|====

[id='type-InternalServiceTemplate-{context}']
= `InternalServiceTemplate` schema reference

Used in: xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`], xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`], xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`], xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|metadata
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|Metadata applied to the resource.
|ipFamilyPolicy
|string (one of [RequireDualStack, SingleStack, PreferDualStack])
|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.
|ipFamilies
|string (one or more of [IPv6, IPv4]) array
|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.
|====

[id='type-ResourceTemplate-{context}']
= `ResourceTemplate` schema reference

Used in: xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`], xref:type-EntityOperatorTemplate-{context}[`EntityOperatorTemplate`], xref:type-JmxTransTemplate-{context}[`JmxTransTemplate`], xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`], xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`], xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`], xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`], xref:type-KafkaNodePoolTemplate-{context}[`KafkaNodePoolTemplate`], xref:type-KafkaUserTemplate-{context}[`KafkaUserTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|metadata
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|Metadata applied to the resource.
|====

[id='type-PodDisruptionBudgetTemplate-{context}']
= `PodDisruptionBudgetTemplate` schema reference

Used in: xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`], xref:type-EntityOperatorTemplate-{context}[`EntityOperatorTemplate`], xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`], xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`], xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`], xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]

xref:type-PodDisruptionBudgetTemplate-schema-{context}[Full list of `PodDisruptionBudgetTemplate` schema properties]

include::../api/io.strimzi.api.kafka.model.common.template.PodDisruptionBudgetTemplate.adoc[leveloffset=+1]

[id='type-PodDisruptionBudgetTemplate-schema-{context}']
== `PodDisruptionBudgetTemplate` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|metadata
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|Metadata to apply to the `PodDisruptionBudgetTemplate` resource.
|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.
|====

[id='type-ContainerTemplate-{context}']
= `ContainerTemplate` schema reference

Used in: xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`], xref:type-EntityOperatorTemplate-{context}[`EntityOperatorTemplate`], xref:type-JmxTransTemplate-{context}[`JmxTransTemplate`], xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`], xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`], xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`], xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`], xref:type-KafkaNodePoolTemplate-{context}[`KafkaNodePoolTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]

xref:type-ContainerTemplate-schema-{context}[Full list of `ContainerTemplate` schema properties]

include::../api/io.strimzi.api.kafka.model.common.template.ContainerTemplate.adoc[leveloffset=+1]

[id='type-ContainerTemplate-schema-{context}']
== `ContainerTemplate` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|env
|xref:type-ContainerEnvVar-{context}[`ContainerEnvVar`] array
|Environment variables which should be applied to the container.
|securityContext
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#securitycontext-v1-core[SecurityContext]
|Security context for the container.
|volumeMounts
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#volumemount-v1-core[VolumeMount] array
|Additional volume mounts which should be applied to the container.
|====

[id='type-ContainerEnvVar-{context}']
= `ContainerEnvVar` schema reference

Used in: xref:type-ContainerTemplate-{context}[`ContainerTemplate`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|The environment variable key.
|value
|string
|The environment variable value.
|valueFrom
|xref:type-ContainerEnvVarSource-{context}[`ContainerEnvVarSource`]
|Reference to the secret or config map property to which the environment variable is set.
|====

[id='type-ContainerEnvVarSource-{context}']
= `ContainerEnvVarSource` schema reference

Used in: xref:type-ContainerEnvVar-{context}[`ContainerEnvVar`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|secretKeyRef
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#secretkeyselector-v1-core[SecretKeySelector]
|Reference to a key in a secret.
|configMapKeyRef
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#configmapkeyselector-v1-core[ConfigMapKeySelector]
|Reference to a key in a config map.
|====

[id='type-TieredStorageCustom-{context}']
= `TieredStorageCustom` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]

xref:type-TieredStorageCustom-schema-{context}[Full list of `TieredStorageCustom` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.tieredstorage.TieredStorageCustom.adoc[leveloffset=+1]

[id='type-TieredStorageCustom-schema-{context}']
== `TieredStorageCustom` schema properties


The `type` property is a discriminator that distinguishes use of the `TieredStorageCustom` type from other subtypes which may be added in the future.
It must have the value `custom` for the type `TieredStorageCustom`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `custom`.
|remoteStorageManager
|xref:type-RemoteStorageManager-{context}[`RemoteStorageManager`]
|Configuration for the Remote Storage Manager.
|====

[id='type-RemoteStorageManager-{context}']
= `RemoteStorageManager` schema reference

Used in: xref:type-TieredStorageCustom-{context}[`TieredStorageCustom`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|className
|string
|The class name for the `RemoteStorageManager` implementation.
|classPath
|string
|The class path for the `RemoteStorageManager` implementation.
|config
|map
|The additional configuration map for the `RemoteStorageManager` implementation. Keys will be automatically prefixed with `rsm.config.`, and added to Kafka broker configuration.
|====

[id='type-QuotasPluginKafka-{context}']
= `QuotasPluginKafka` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `QuotasPluginKafka` type from xref:type-QuotasPluginStrimzi-{context}[`QuotasPluginStrimzi`].
It must have the value `kafka` for the type `QuotasPluginKafka`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `kafka`.
|producerByteRate
|integer
|The default client quota on the maximum bytes per-second that each client can publish to each broker before it is throttled. Applied on a per-broker basis.
|consumerByteRate
|integer
|The default client quota on the maximum bytes per-second that each client can fetch from each broker before it is throttled. Applied on a per-broker basis.
|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.
|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.
|====

[id='type-QuotasPluginStrimzi-{context}']
= `QuotasPluginStrimzi` schema reference

Used in: xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]


The `type` property is a discriminator that distinguishes use of the `QuotasPluginStrimzi` type from xref:type-QuotasPluginKafka-{context}[`QuotasPluginKafka`].
It must have the value `strimzi` for the type `QuotasPluginStrimzi`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `strimzi`.
|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.
|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.
|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`.
|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`.
|excludedPrincipals
|string array
|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`.
|====

[id='type-ZookeeperClusterSpec-{context}']
= `ZookeeperClusterSpec` schema reference

*The type `ZookeeperClusterSpec` has been deprecated.*

Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|replicas
|integer
|The number of pods in the cluster.
|image
|string
|The container image used for ZooKeeper pods. If no image name is explicitly specified, it is determined based on the Kafka version set in `spec.kafka.version`. The image names are specifically mapped to corresponding versions in the Cluster Operator configuration.
|storage
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`]
|Storage configuration (disk). Cannot be updated.
|config
|map
|The ZooKeeper broker config. Properties with the following prefixes cannot be set: server., dataDir, dataLogDir, clientPort, authProvider, quorum.auth, requireClientAuthScheme, snapshot.trust.empty, standaloneEnabled, reconfigEnabled, 4lw.commands.whitelist, secureClientPort, ssl., serverCnxnFactory, sslQuorum (with the exception of: ssl.protocol, ssl.quorum.protocol, ssl.enabledProtocols, ssl.quorum.enabledProtocols, ssl.ciphersuites, ssl.quorum.ciphersuites, ssl.hostnameVerification, ssl.quorum.hostnameVerification).
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|jmxOptions
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|JMX Options for Zookeeper nodes.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|metricsConfig
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`], xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`]
|Metrics configuration.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration for ZooKeeper.
|template
|xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]
|Template for ZooKeeper cluster resources. The template allows users to specify how the Kubernetes resources are generated.
|====

[id='type-ZookeeperClusterTemplate-{context}']
= `ZookeeperClusterTemplate` schema reference

*The type `ZookeeperClusterTemplate` has been deprecated.*

Used in: xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|statefulset
|xref:type-StatefulSetTemplate-{context}[`StatefulSetTemplate`]
|**The `statefulset` property has been deprecated.** Support for StatefulSets was removed in Strimzi 0.35.0. This property is ignored. Template for ZooKeeper `StatefulSet`.
|podSet
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for ZooKeeper `StrimziPodSet` resource.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for ZooKeeper `Pods`.
|clientService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for ZooKeeper client `Service`.
|nodesService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for ZooKeeper nodes `Service`.
|persistentVolumeClaim
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for all ZooKeeper `PersistentVolumeClaims`.
|podDisruptionBudget
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|Template for ZooKeeper `PodDisruptionBudget`.
|zookeeperContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the ZooKeeper container.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the ZooKeeper service account.
|jmxSecret
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Secret of the Zookeeper Cluster JMX authentication.
|====

[id='type-EntityOperatorSpec-{context}']
= `EntityOperatorSpec` schema reference

Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|topicOperator
|xref:type-EntityTopicOperatorSpec-{context}[`EntityTopicOperatorSpec`]
|Configuration of the Topic Operator.
|userOperator
|xref:type-EntityUserOperatorSpec-{context}[`EntityUserOperatorSpec`]
|Configuration of the User Operator.
|tlsSidecar
|xref:type-TlsSidecar-{context}[`TlsSidecar`]
|**The `tlsSidecar` property has been deprecated.** TLS sidecar was removed in Strimzi 0.41.0. This property is ignored. TLS sidecar configuration.
|template
|xref:type-EntityOperatorTemplate-{context}[`EntityOperatorTemplate`]
|Template for Entity Operator resources. The template allows users to specify how a `Deployment` and `Pod` is generated.
|====

[id='type-EntityTopicOperatorSpec-{context}']
= `EntityTopicOperatorSpec` schema reference

Used in: xref:type-EntityOperatorSpec-{context}[`EntityOperatorSpec`]

xref:type-EntityTopicOperatorSpec-schema-{context}[Full list of `EntityTopicOperatorSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.entityoperator.EntityTopicOperatorSpec.adoc[leveloffset=+1]

[id='type-EntityTopicOperatorSpec-schema-{context}']
== `EntityTopicOperatorSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|watchedNamespace
|string
|The namespace the Topic Operator should watch.
|image
|string
|The image to use for the Topic Operator.
|reconciliationIntervalSeconds
|integer
|**The `reconciliationIntervalSeconds` property has been deprecated, and should now be configured using `.spec.entityOperator.topicOperator.reconciliationIntervalMs`.** Interval between periodic reconciliations in seconds. Ignored if reconciliationIntervalMs is set.
|reconciliationIntervalMs
|integer
|Interval between periodic reconciliations in milliseconds.
|zookeeperSessionTimeoutSeconds
|integer
|**The `zookeeperSessionTimeoutSeconds` property has been deprecated.** This property is not used anymore in Strimzi 0.41.0 and it is ignored. Timeout for the ZooKeeper session.
|startupProbe
|xref:type-Probe-{context}[`Probe`]
|Pod startup checking.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|topicMetadataMaxAttempts
|integer
|**The `topicMetadataMaxAttempts` property has been deprecated.** This property is not used anymore in Strimzi 0.41.0 and it is ignored. The number of attempts at getting topic metadata.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|====

[id='type-EntityUserOperatorSpec-{context}']
= `EntityUserOperatorSpec` schema reference

Used in: xref:type-EntityOperatorSpec-{context}[`EntityOperatorSpec`]

xref:type-EntityUserOperatorSpec-schema-{context}[Full list of `EntityUserOperatorSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.entityoperator.EntityUserOperatorSpec.adoc[leveloffset=+1]

[id='type-EntityUserOperatorSpec-schema-{context}']
== `EntityUserOperatorSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|watchedNamespace
|string
|The namespace the User Operator should watch.
|image
|string
|The image to use for the User Operator.
|reconciliationIntervalSeconds
|integer
|**The `reconciliationIntervalSeconds` property has been deprecated, and should now be configured using `.spec.entityOperator.userOperator.reconciliationIntervalMs`.** Interval between periodic reconciliations in seconds. Ignored if reconciliationIntervalMs is set.
|reconciliationIntervalMs
|integer
|Interval between periodic reconciliations in milliseconds.
|zookeeperSessionTimeoutSeconds
|integer
|**The `zookeeperSessionTimeoutSeconds` property has been deprecated.** This property has been deprecated because ZooKeeper is not used anymore by the User Operator. Timeout for the ZooKeeper session.
|secretPrefix
|string
|The prefix that will be added to the KafkaUser name to be used as the Secret name.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|====

[id='type-TlsSidecar-{context}']
= `TlsSidecar` schema reference

*The type `TlsSidecar` has been deprecated.*

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`], xref:type-EntityOperatorSpec-{context}[`EntityOperatorSpec`]

xref:type-TlsSidecar-schema-{context}[Full list of `TlsSidecar` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.entityoperator.TlsSidecar.adoc[leveloffset=+1]

[id='type-TlsSidecar-schema-{context}']
== `TlsSidecar` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|image
|string
|The docker image for the container.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|logLevel
|string (one of [emerg, debug, crit, err, alert, warning, notice, info])
|The log level for the TLS sidecar. Default value is `notice`.
|====

[id='type-EntityOperatorTemplate-{context}']
= `EntityOperatorTemplate` schema reference

Used in: xref:type-EntityOperatorSpec-{context}[`EntityOperatorSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|deployment
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|Template for Entity Operator `Deployment`.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Entity Operator `Pods`.
|topicOperatorContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Entity Topic Operator container.
|userOperatorContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Entity User Operator container.
|tlsSidecarContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|**The `tlsSidecarContainer` property has been deprecated.** TLS sidecar was removed in Strimzi 0.41.0. This property is ignored. Template for the Entity Operator TLS sidecar container.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Entity Operator service account.
|podDisruptionBudget
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|Template for the Entity Operator Pod Disruption Budget.
|entityOperatorRole
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Entity Operator Role.
|topicOperatorRoleBinding
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Entity Topic Operator RoleBinding.
|userOperatorRoleBinding
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Entity Topic Operator RoleBinding.
|====

[id='type-DeploymentTemplate-{context}']
= `DeploymentTemplate` schema reference

Used in: xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`], xref:type-EntityOperatorTemplate-{context}[`EntityOperatorTemplate`], xref:type-JmxTransTemplate-{context}[`JmxTransTemplate`], xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`], xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`], xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`]

xref:type-DeploymentTemplate-schema-{context}[Full list of `DeploymentTemplate` schema properties]

include::../api/io.strimzi.api.kafka.model.common.template.DeploymentTemplate.adoc[leveloffset=+1]

[id='type-DeploymentTemplate-schema-{context}']
== `DeploymentTemplate` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|metadata
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|Metadata applied to the resource.
|deploymentStrategy
|string (one of [RollingUpdate, Recreate])
|Pod replacement strategy for deployment configuration changes. Valid values are `RollingUpdate` and `Recreate`. Defaults to `RollingUpdate`.
|====

[id='type-CertificateAuthority-{context}']
= `CertificateAuthority` schema reference

Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]

Configuration of how TLS certificates are used within the cluster. This applies to certificates used for both internal communication within the cluster and to certificates used for client access via `Kafka.spec.kafka.listeners.tls`.

[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|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`.
|validityDays
|integer
|The number of days generated certificates should be valid for. The default is 365.
|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.
|certificateExpirationPolicy
|string (one of [replace-key, renew-certificate])
|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.
|====

[id='type-CruiseControlSpec-{context}']
= `CruiseControlSpec` schema reference

Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]

xref:type-CruiseControlSpec-schema-{context}[Full list of `CruiseControlSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.kafka.cruisecontrol.CruiseControlSpec.adoc[leveloffset=+1]

[id='type-CruiseControlSpec-schema-{context}']
== `CruiseControlSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|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.
|tlsSidecar
|xref:type-TlsSidecar-{context}[`TlsSidecar`]
|**The `tlsSidecar` property has been deprecated.** TLS sidecar configuration.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve for the Cruise Control container.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking for the Cruise Control container.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking for the Cruise Control container.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for the Cruise Control container.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration (Log4j 2) for Cruise Control.
|template
|xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`]
|Template to specify how Cruise Control resources, `Deployments` and `Pods`, are generated.
|brokerCapacity
|xref:type-BrokerCapacity-{context}[`BrokerCapacity`]
|The Cruise Control `brokerCapacity` configuration.
|config
|map
|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).
|metricsConfig
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`], xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`]
|Metrics configuration. Only `jmxPrometheusExporter` can be configured, as this component does not support `strimziMetricsReporter`.
|apiUsers
|xref:type-HashLoginServiceApiUsers-{context}[`HashLoginServiceApiUsers`]
|Configuration of the Cruise Control REST API users.
|autoRebalance
|xref:type-KafkaAutoRebalanceConfiguration-{context}[`KafkaAutoRebalanceConfiguration`] array
|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.
|====

[id='type-CruiseControlTemplate-{context}']
= `CruiseControlTemplate` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|deployment
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|Template for Cruise Control `Deployment`.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Cruise Control `Pods`.
|apiService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for Cruise Control API `Service`.
|podDisruptionBudget
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|Template for Cruise Control `PodDisruptionBudget`.
|cruiseControlContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Cruise Control container.
|tlsSidecarContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|**The `tlsSidecarContainer` property has been deprecated.** Template for the Cruise Control TLS sidecar container.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Cruise Control service account.
|====

[id='type-BrokerCapacity-{context}']
= `BrokerCapacity` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|disk
|string
|**The `disk` property has been deprecated.** The Cruise Control disk capacity setting has been deprecated, is ignored, and will be removed in the future Broker capacity for disk in bytes. Use a number value with either standard Kubernetes byte units (K, M, G, or T), their bibyte (power of two) equivalents (Ki, Mi, Gi, or Ti), or a byte value with or without E notation. For example, 100000M, 100000Mi, 104857600000, or 1e+11.
|cpuUtilization
|integer
|**The `cpuUtilization` property has been deprecated.** The Cruise Control CPU capacity setting has been deprecated, is ignored, and will be removed in the future Broker capacity for CPU resource utilization as a percentage (0 - 100).
|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.
|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.
|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.
|overrides
|xref:type-BrokerCapacityOverride-{context}[`BrokerCapacityOverride`] array
|Overrides for individual brokers. The `overrides` property lets you specify a different capacity configuration for different brokers.
|====

[id='type-BrokerCapacityOverride-{context}']
= `BrokerCapacityOverride` schema reference

Used in: xref:type-BrokerCapacity-{context}[`BrokerCapacity`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|brokers
|integer array
|List of Kafka brokers (broker identifiers).
|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.
|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.
|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.
|====

[id='type-HashLoginServiceApiUsers-{context}']
= `HashLoginServiceApiUsers` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`]


The `type` property is a discriminator that distinguishes use of the `HashLoginServiceApiUsers` type from other subtypes which may be added in the future.
It must have the value `hashLoginService` for the type `HashLoginServiceApiUsers`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `hashLoginService`.
|valueFrom
|xref:type-PasswordSource-{context}[`PasswordSource`]
|Secret from which the custom Cruise Control API authentication credentials are read.
|====

[id='type-PasswordSource-{context}']
= `PasswordSource` schema reference

Used in: xref:type-HashLoginServiceApiUsers-{context}[`HashLoginServiceApiUsers`], xref:type-Password-{context}[`Password`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|secretKeyRef
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#secretkeyselector-v1-core[SecretKeySelector]
|Selects a key of a Secret in the resource's namespace.
|====

[id='type-KafkaAutoRebalanceConfiguration-{context}']
= `KafkaAutoRebalanceConfiguration` schema reference

Used in: xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|mode
|string (one of [remove-brokers, add-brokers])
|Specifies the mode for automatically rebalancing when brokers are added or removed. Supported modes are `add-brokers` and `remove-brokers`. 

|template
|xref:type-LocalObjectReference-{context}[`LocalObjectReference`]
|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.
|====

[id='type-LocalObjectReference-{context}']
= `LocalObjectReference` schema reference

Used in: xref:type-AlterOffsets-{context}[`AlterOffsets`], xref:type-KafkaAutoRebalanceConfiguration-{context}[`KafkaAutoRebalanceConfiguration`], xref:type-ListOffsets-{context}[`ListOffsets`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|
|====

[id='type-JmxTransSpec-{context}']
= `JmxTransSpec` schema reference

*The type `JmxTransSpec` has been deprecated.*

Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|image
|string
|The image to use for the JmxTrans.
|outputDefinitions
|xref:type-JmxTransOutputDefinitionTemplate-{context}[`JmxTransOutputDefinitionTemplate`] array
|Defines the output hosts that will be referenced later on. For more information on these properties see, xref:type-JmxTransOutputDefinitionTemplate-reference[`JmxTransOutputDefinitionTemplate` schema reference].
|logLevel
|string
|Sets the logging level of the JmxTrans deployment.For more information see, https://github.com/jmxtrans/jmxtrans-agent/wiki/Troubleshooting[JmxTrans Logging Level].
|kafkaQueries
|xref:type-JmxTransQueryTemplate-{context}[`JmxTransQueryTemplate`] array
|Queries to send to the Kafka brokers to define what data should be read from each broker. For more information on these properties see, xref:type-JmxTransQueryTemplate-reference[`JmxTransQueryTemplate` schema reference].
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|template
|xref:type-JmxTransTemplate-{context}[`JmxTransTemplate`]
|Template for JmxTrans resources.
|====

[id='type-JmxTransOutputDefinitionTemplate-{context}']
= `JmxTransOutputDefinitionTemplate` schema reference

Used in: xref:type-JmxTransSpec-{context}[`JmxTransSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|outputType
|string
|Template for setting the format of the data that will be pushed.For more information see https://github.com/jmxtrans/jmxtrans/wiki/OutputWriters[JmxTrans OutputWriters].
|host
|string
|The DNS/hostname of the remote host that the data is pushed to.
|port
|integer
|The port of the remote host that the data is pushed to.
|flushDelayInSeconds
|integer
|How many seconds the JmxTrans waits before pushing a new set of data out.
|typeNames
|string array
|Template for filtering data to be included in response to a wildcard query. For more information see https://github.com/jmxtrans/jmxtrans/wiki/Queries[JmxTrans queries].
|name
|string
|Template for setting the name of the output definition. This is used to identify where to send the results of queries should be sent.
|====

[id='type-JmxTransQueryTemplate-{context}']
= `JmxTransQueryTemplate` schema reference

Used in: xref:type-JmxTransSpec-{context}[`JmxTransSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|targetMBean
|string
|If using wildcards instead of a specific MBean then the data is gathered from multiple MBeans. Otherwise if specifying an MBean then data is gathered from that specified MBean.
|attributes
|string array
|Determine which attributes of the targeted MBean should be included.
|outputs
|string array
|List of the names of output definitions specified in the spec.kafka.jmxTrans.outputDefinitions that have defined where JMX metrics are pushed to, and in which data format.
|====

[id='type-JmxTransTemplate-{context}']
= `JmxTransTemplate` schema reference

Used in: xref:type-JmxTransSpec-{context}[`JmxTransSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|deployment
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|Template for JmxTrans `Deployment`.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for JmxTrans `Pods`.
|container
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for JmxTrans container.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the JmxTrans service account.
|====

[id='type-KafkaExporterSpec-{context}']
= `KafkaExporterSpec` schema reference

Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|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.
|groupRegex
|string
|Regular expression to specify which consumer groups to collect. Default value is `.*`.
|topicRegex
|string
|Regular expression to specify which topics to collect. Default value is `.*`.
|groupExcludeRegex
|string
|Regular expression to specify which consumer groups to exclude.
|topicExcludeRegex
|string
|Regular expression to specify which topics to exclude.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|logging
|string
|Only log messages with the given severity or above. Valid levels: [`info`, `debug`, `trace`]. Default log level is `info`.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness check.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness check.
|enableSaramaLogging
|boolean
|Enable Sarama logging, a Go client library used by the Kafka Exporter.
|showAllOffsets
|boolean
|Whether show the offset/lag for all consumer group, otherwise, only show connected consumer groups.
|template
|xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`]
|Customization of deployment templates and pods.
|====

[id='type-KafkaExporterTemplate-{context}']
= `KafkaExporterTemplate` schema reference

Used in: xref:type-KafkaExporterSpec-{context}[`KafkaExporterSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|deployment
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|Template for Kafka Exporter `Deployment`.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Kafka Exporter `Pods`.
|service
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|**The `service` property has been deprecated.** The Kafka Exporter service has been removed. Template for Kafka Exporter `Service`.
|container
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka Exporter container.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka Exporter service account.
|podDisruptionBudget
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|Template for the Pod Disruption Budget for Kafka Exporter pods.
|====

[id='type-KafkaStatus-{context}']
= `KafkaStatus` schema reference

Used in: xref:type-Kafka-{context}[`Kafka`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|listeners
|xref:type-ListenerStatus-{context}[`ListenerStatus`] array
|Addresses of the internal and external listeners.
|kafkaNodePools
|xref:type-UsedNodePoolStatus-{context}[`UsedNodePoolStatus`] array
|List of the KafkaNodePools used by this Kafka cluster.
|registeredNodeIds
|integer array
|**The `registeredNodeIds` property has been deprecated.** The `registeredNodeIds` property is deprecated and it is not used anymore. It will be removed in the future. Registered node IDs used by this Kafka cluster. This field is used for internal purposes only and will be removed in the future.
|clusterId
|string
|Kafka cluster Id.
|operatorLastSuccessfulVersion
|string
|The version of the Strimzi Cluster Operator which performed the last successful reconciliation.
|kafkaVersion
|string
|The version of Kafka currently deployed in the cluster.
|kafkaMetadataVersion
|string
|The KRaft metadata.version currently used by the Kafka cluster.
|kafkaMetadataState
|string (one of [PreKRaft, ZooKeeper, KRaftMigration, KRaftDualWriting, KRaftPostMigration, KRaft])
|Defines where cluster metadata are stored. Since Kafka KRaft has been fully adopted, the only applicable value is `KRaft`.
|autoRebalance
|xref:type-KafkaAutoRebalanceStatus-{context}[`KafkaAutoRebalanceStatus`]
|The status of an auto-rebalancing triggered by a cluster scaling request.
|====

[id='type-Condition-{context}']
= `Condition` schema reference

Used in: xref:type-KafkaBridgeStatus-{context}[`KafkaBridgeStatus`], xref:type-KafkaConnectorStatus-{context}[`KafkaConnectorStatus`], xref:type-KafkaConnectStatus-{context}[`KafkaConnectStatus`], xref:type-KafkaMirrorMaker2Status-{context}[`KafkaMirrorMaker2Status`], xref:type-KafkaNodePoolStatus-{context}[`KafkaNodePoolStatus`], xref:type-KafkaRebalanceStatus-{context}[`KafkaRebalanceStatus`], xref:type-KafkaStatus-{context}[`KafkaStatus`], xref:type-KafkaTopicStatus-{context}[`KafkaTopicStatus`], xref:type-KafkaUserStatus-{context}[`KafkaUserStatus`], xref:type-StrimziPodSetStatus-{context}[`StrimziPodSetStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|The unique identifier of a condition, used to distinguish between other conditions in the resource.
|status
|string
|The status of the condition, either True, False or Unknown.
|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.
|reason
|string
|The reason for the condition's last transition (a single word in CamelCase).
|message
|string
|Human-readable message indicating details about the condition's last transition.
|====

[id='type-ListenerStatus-{context}']
= `ListenerStatus` schema reference

Used in: xref:type-KafkaStatus-{context}[`KafkaStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|**The `type` property has been deprecated.** The `type` property is not used anymore. Use the `name` property with the same value. The name of the listener.
|name
|string
|The name of the listener.
|addresses
|xref:type-ListenerAddress-{context}[`ListenerAddress`] array
|A list of the addresses for this listener.
|bootstrapServers
|string
|A comma-separated list of `host:port` pairs for connecting to the Kafka cluster using this listener.
|certificates
|string array
|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.
|====

[id='type-ListenerAddress-{context}']
= `ListenerAddress` schema reference

Used in: xref:type-ListenerStatus-{context}[`ListenerStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|host
|string
|The DNS name or IP address of the Kafka bootstrap service.
|port
|integer
|The port of the Kafka bootstrap service.
|====

[id='type-UsedNodePoolStatus-{context}']
= `UsedNodePoolStatus` schema reference

Used in: xref:type-KafkaStatus-{context}[`KafkaStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|The name of the KafkaNodePool used by this Kafka resource.
|====

[id='type-KafkaAutoRebalanceStatus-{context}']
= `KafkaAutoRebalanceStatus` schema reference

Used in: xref:type-KafkaStatus-{context}[`KafkaStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|state
|string (one of [RebalanceOnScaleUp, Idle, RebalanceOnScaleDown])
|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.
|lastTransitionTime
|string
|The timestamp of the latest auto-rebalancing state update.
|modes
|xref:type-KafkaAutoRebalanceStatusBrokers-{context}[`KafkaAutoRebalanceStatusBrokers`] array
|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).
|====

[id='type-KafkaAutoRebalanceStatusBrokers-{context}']
= `KafkaAutoRebalanceStatusBrokers` schema reference

Used in: xref:type-KafkaAutoRebalanceStatus-{context}[`KafkaAutoRebalanceStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|mode
|string (one of [remove-brokers, add-brokers])
|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`.
|brokers
|integer array
|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). 

|====

[id='type-KafkaConnect-{context}']
= `KafkaConnect` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`]
|The specification of the Kafka Connect cluster.
|status
|xref:type-KafkaConnectStatus-{context}[`KafkaConnectStatus`]
|The status of the Kafka Connect cluster.
|====

[id='type-KafkaConnectSpec-{context}']
= `KafkaConnectSpec` schema reference

Used in: xref:type-KafkaConnect-{context}[`KafkaConnect`]

xref:type-KafkaConnectSpec-schema-{context}[Full list of `KafkaConnectSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.connect.KafkaConnectSpec.adoc[leveloffset=+1]

[id='type-KafkaConnectSpec-schema-{context}']
== `KafkaConnectSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|version
|string
|The Kafka Connect version. Defaults to the latest version. Consult the user documentation to understand the process required to upgrade or downgrade the version.
|replicas
|integer
|The number of pods in the Kafka Connect group. Defaults to `3`.
|image
|string
|The container image used for Kafka Connect pods. If no image name is explicitly specified, it is determined based on the `spec.version` configuration. The image names are specifically mapped to corresponding versions in the Cluster Operator configuration.
|bootstrapServers
|string
|Bootstrap servers to connect to. This should be given as a comma separated list of _<hostname>_:_<port>_ pairs.
|tls
|xref:type-ClientTls-{context}[`ClientTls`]
|TLS configuration.
|authentication
|xref:type-KafkaClientAuthenticationTls-{context}[`KafkaClientAuthenticationTls`], xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`], xref:type-KafkaClientAuthenticationPlain-{context}[`KafkaClientAuthenticationPlain`], xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaClientAuthenticationCustom-{context}[`KafkaClientAuthenticationCustom`]
|Authentication configuration for Kafka Connect.
|config
|map
|The Kafka Connect configuration. Properties with the following prefixes cannot be set: ssl., sasl., security., listeners, plugin.path, rest., bootstrap.servers, consumer.interceptor.classes, producer.interceptor.classes, prometheus.metrics.reporter. (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|The maximum limits for CPU and memory resources and the requested initial resources.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|jmxOptions
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|JMX Options.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration for Kafka Connect.
|clientRackInitImage
|string
|The image of the init container used for initializing the `client.rack`.
|rack
|xref:type-Rack-{context}[`Rack`]
|Configuration of the node label which will be used as the `client.rack` consumer configuration.
|metricsConfig
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`], xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`]
|Metrics configuration.
|tracing
|xref:type-JaegerTracing-{context}[`JaegerTracing`], xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`]
|The configuration of tracing in Kafka Connect.
|template
|xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`]
|Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated.
|externalConfiguration
|xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]
|**The `externalConfiguration` property has been deprecated.** The external configuration is deprecated and will be removed in the future. Please use the template section instead to configure additional environment variables or volumes. Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
|build
|xref:type-Build-{context}[`Build`]
|Configures how the Connect container image should be built. Optional.
|plugins
|xref:type-MountedPlugin-{context}[`MountedPlugin`] array
|List of connector plugins to mount into the `KafkaConnect` pod.
|====

[id='type-ClientTls-{context}']
= `ClientTls` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`]

xref:type-ClientTls-schema-{context}[Full list of `ClientTls` schema properties]

include::../api/io.strimzi.api.kafka.model.common.ClientTls.adoc[leveloffset=+1]

[id='type-ClientTls-schema-{context}']
== `ClientTls` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|trustedCertificates
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|Trusted certificates for TLS connection.
|====

[id='type-KafkaClientAuthenticationTls-{context}']
= `KafkaClientAuthenticationTls` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`]

xref:type-KafkaClientAuthenticationTls-schema-{context}[Full list of `KafkaClientAuthenticationTls` schema properties]

include::../api/io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthenticationTls.adoc[leveloffset=+1]

[id='type-KafkaClientAuthenticationTls-schema-{context}']
== `KafkaClientAuthenticationTls` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaClientAuthenticationTls` type from xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`], xref:type-KafkaClientAuthenticationPlain-{context}[`KafkaClientAuthenticationPlain`], xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaClientAuthenticationCustom-{context}[`KafkaClientAuthenticationCustom`].
It must have the value `tls` for the type `KafkaClientAuthenticationTls`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `tls`.
|certificateAndKey
|xref:type-CertAndKeySecretSource-{context}[`CertAndKeySecretSource`]
|Reference to the `Secret` which holds the certificate and private key pair.
|====

[id='type-KafkaClientAuthenticationScramSha256-{context}']
= `KafkaClientAuthenticationScramSha256` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`]

xref:type-KafkaClientAuthenticationScramSha256-schema-{context}[Full list of `KafkaClientAuthenticationScramSha256` schema properties]

include::../api/io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthenticationScramSha256.adoc[leveloffset=+1]

[id='type-KafkaClientAuthenticationScramSha256-schema-{context}']
== `KafkaClientAuthenticationScramSha256` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `scram-sha-256`.
|username
|string
|Username used for the authentication.
|passwordSecret
|xref:type-PasswordSecretSource-{context}[`PasswordSecretSource`]
|Reference to the `Secret` which holds the password.
|====

[id='type-PasswordSecretSource-{context}']
= `PasswordSecretSource` schema reference

Used in: xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaClientAuthenticationPlain-{context}[`KafkaClientAuthenticationPlain`], xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|secretName
|string
|The name of the Secret containing the password.
|password
|string
|The name of the key in the Secret under which the password is stored.
|====

[id='type-KafkaClientAuthenticationScramSha512-{context}']
= `KafkaClientAuthenticationScramSha512` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`]

xref:type-KafkaClientAuthenticationScramSha512-schema-{context}[Full list of `KafkaClientAuthenticationScramSha512` schema properties]

include::../api/io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthenticationScramSha512.adoc[leveloffset=+1]

[id='type-KafkaClientAuthenticationScramSha512-schema-{context}']
== `KafkaClientAuthenticationScramSha512` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `scram-sha-512`.
|username
|string
|Username used for the authentication.
|passwordSecret
|xref:type-PasswordSecretSource-{context}[`PasswordSecretSource`]
|Reference to the `Secret` which holds the password.
|====

[id='type-KafkaClientAuthenticationPlain-{context}']
= `KafkaClientAuthenticationPlain` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`]

xref:type-KafkaClientAuthenticationPlain-schema-{context}[Full list of `KafkaClientAuthenticationPlain` schema properties]

include::../api/io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthenticationPlain.adoc[leveloffset=+1]

[id='type-KafkaClientAuthenticationPlain-schema-{context}']
== `KafkaClientAuthenticationPlain` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaClientAuthenticationPlain` type from xref:type-KafkaClientAuthenticationTls-{context}[`KafkaClientAuthenticationTls`], xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`], xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaClientAuthenticationCustom-{context}[`KafkaClientAuthenticationCustom`].
It must have the value `plain` for the type `KafkaClientAuthenticationPlain`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `plain`.
|username
|string
|Username used for the authentication.
|passwordSecret
|xref:type-PasswordSecretSource-{context}[`PasswordSecretSource`]
|Reference to the `Secret` which holds the password.
|====

[id='type-KafkaClientAuthenticationOAuth-{context}']
= `KafkaClientAuthenticationOAuth` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`]

xref:type-KafkaClientAuthenticationOAuth-schema-{context}[Full list of `KafkaClientAuthenticationOAuth` schema properties]

include::../api/io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthenticationOAuth.adoc[leveloffset=+1]

[id='type-KafkaClientAuthenticationOAuth-schema-{context}']
== `KafkaClientAuthenticationOAuth` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaClientAuthenticationOAuth` type from xref:type-KafkaClientAuthenticationTls-{context}[`KafkaClientAuthenticationTls`], xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`], xref:type-KafkaClientAuthenticationPlain-{context}[`KafkaClientAuthenticationPlain`], xref:type-KafkaClientAuthenticationCustom-{context}[`KafkaClientAuthenticationCustom`].
It must have the value `oauth` for the type `KafkaClientAuthenticationOAuth`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `oauth`.
|clientId
|string
|OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
|username
|string
|Username used for the authentication.
|scope
|string
|OAuth scope to use when authenticating against the authorization server. Some authorization servers require this to be set. The possible values depend on how authorization server is configured. By default `scope` is not specified when doing the token endpoint request.
|audience
|string
|OAuth audience to use when authenticating against the authorization server. Some authorization servers require the audience to be explicitly set. The possible values depend on how the authorization server is configured. By default, `audience` is not specified when performing the token endpoint request.
|tokenEndpointUri
|string
|Authorization server token endpoint URI.
|connectTimeoutSeconds
|integer
|The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
|readTimeoutSeconds
|integer
|The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
|httpRetries
|integer
|The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
|httpRetryPauseMs
|integer
|The pause to take before retrying a failed HTTP request. If not set, the default is to not pause at all but to immediately repeat a request.
|clientSecret
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|Link to Kubernetes Secret containing the OAuth client secret which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
|passwordSecret
|xref:type-PasswordSecretSource-{context}[`PasswordSecretSource`]
|Reference to the `Secret` which holds the password.
|accessToken
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|Link to Kubernetes Secret containing the access token which was obtained from the authorization server.
|refreshToken
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|Link to Kubernetes Secret containing the refresh token which can be used to obtain access token from the authorization server.
|tlsTrustedCertificates
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|Trusted certificates for TLS connection to the OAuth server.
|disableTlsHostnameVerification
|boolean
|Enable or disable TLS hostname verification. Default value is `false`.
|maxTokenExpirySeconds
|integer
|Set or limit time-to-live of the access tokens to the specified number of seconds. This should be set if the authorization server returns opaque tokens.
|accessTokenIsJwt
|boolean
|Configure whether access token should be treated as JWT. This should be set to `false` if the authorization server returns opaque tokens. Defaults to `true`.
|enableMetrics
|boolean
|Enable or disable OAuth metrics. Default value is `false`.
|includeAcceptHeader
|boolean
|Whether the Accept header should be set in requests to the authorization servers. The default value is `true`.
|accessTokenLocation
|string
|Path to the token file containing an access token to be used for authentication.
|clientAssertion
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|Link to Kubernetes secret containing the client assertion which was manually configured for the client.
|clientAssertionLocation
|string
|Path to the file containing the client assertion to be used for authentication.
|clientAssertionType
|string
|The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`.
|saslExtensions
|map
|SASL extensions parameters.
|grantType
|string
|A custom OAuth grant type to use when authenticating against the authorization server with `clientId` and one of `clientSecret` or `clientAssertion`. The value defaults to `client_credentials` in these cases. This is optional configuration, only used with custom authorization server implementations.
|====

[id='type-KafkaClientAuthenticationCustom-{context}']
= `KafkaClientAuthenticationCustom` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`]

xref:type-KafkaClientAuthenticationCustom-schema-{context}[Full list of `KafkaClientAuthenticationCustom` schema properties]

include::../api/io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthenticationCustom.adoc[leveloffset=+1]

[id='type-KafkaClientAuthenticationCustom-schema-{context}']
== `KafkaClientAuthenticationCustom` schema properties


The `type` property is a discriminator that distinguishes use of the `KafkaClientAuthenticationCustom` type from xref:type-KafkaClientAuthenticationTls-{context}[`KafkaClientAuthenticationTls`], xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`], xref:type-KafkaClientAuthenticationPlain-{context}[`KafkaClientAuthenticationPlain`], xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`].
It must have the value `custom` for the type `KafkaClientAuthenticationCustom`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `custom`.
|sasl
|boolean
|Enable or disable SASL on this authentication mechanism.
|config
|map
|Configuration for the custom authentication mechanism. Only properties with the `sasl.` and `ssl.keystore.` prefixes are allowed. Specify other options in the regular configuration section of the custom resource.
|====

[id='type-JaegerTracing-{context}']
= `JaegerTracing` schema reference

*The type `JaegerTracing` has been deprecated.*

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]


The `type` property is a discriminator that distinguishes use of the `JaegerTracing` type from xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`].
It must have the value `jaeger` for the type `JaegerTracing`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `jaeger`.
|====

[id='type-OpenTelemetryTracing-{context}']
= `OpenTelemetryTracing` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`], xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]


The `type` property is a discriminator that distinguishes use of the `OpenTelemetryTracing` type from xref:type-JaegerTracing-{context}[`JaegerTracing`].
It must have the value `opentelemetry` for the type `OpenTelemetryTracing`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `opentelemetry`.
|====

[id='type-KafkaConnectTemplate-{context}']
= `KafkaConnectTemplate` schema reference

Used in: xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|deployment
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|**The `deployment` property has been deprecated.** Kafka Connect and MirrorMaker 2 operands do not use `Deployment` resources anymore. This field will be ignored. Template for Kafka Connect `Deployment`.
|podSet
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka Connect `StrimziPodSet` resource.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Kafka Connect `Pods`.
|apiService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for Kafka Connect API `Service`.
|headlessService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for Kafka Connect headless `Service`.
|connectContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka Connect container.
|initContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka init container.
|podDisruptionBudget
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|Template for Kafka Connect `PodDisruptionBudget`.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka Connect service account.
|clusterRoleBinding
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka Connect ClusterRoleBinding.
|buildPod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Kafka Connect Build `Pods`. The build pod is used only on Kubernetes.
|buildContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka Connect Build container. The build container is used only on Kubernetes.
|buildConfig
|xref:type-BuildConfigTemplate-{context}[`BuildConfigTemplate`]
|Template for the Kafka Connect BuildConfig used to build new container images. The BuildConfig is used only on OpenShift.
|buildServiceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka Connect Build service account.
|jmxSecret
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Secret of the Kafka Connect Cluster JMX authentication.
|====

[id='type-BuildConfigTemplate-{context}']
= `BuildConfigTemplate` schema reference

Used in: xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|metadata
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|Metadata to apply to the `PodDisruptionBudgetTemplate` resource.
|pullSecret
|string
|Container Registry Secret with the credentials for pulling the base image.
|====

[id='type-ExternalConfiguration-{context}']
= `ExternalConfiguration` schema reference

*The type `ExternalConfiguration` has been deprecated.*
Please use xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`] instead.

Used in: xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`], xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]

xref:type-ExternalConfiguration-schema-{context}[Full list of `ExternalConfiguration` schema properties]

include::../api/io.strimzi.api.kafka.model.connect.ExternalConfiguration.adoc[leveloffset=+1]

[id='type-ExternalConfiguration-schema-{context}']
== `ExternalConfiguration` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|env
|xref:type-ExternalConfigurationEnv-{context}[`ExternalConfigurationEnv`] array
|**The `env` property has been deprecated.** The external configuration environment variables are deprecated and will be removed in the future. Please use the environment variables in a container template instead. Makes data from a Secret or ConfigMap available in the Kafka Connect pods as environment variables.
|volumes
|xref:type-ExternalConfigurationVolumeSource-{context}[`ExternalConfigurationVolumeSource`] array
|**The `volumes` property has been deprecated.** The external configuration volumes are deprecated and will be removed in the future. Please use the additional volumes and volume mounts in pod and container templates instead to mount additional secrets or config maps. Makes data from a Secret or ConfigMap available in the Kafka Connect pods as volumes.
|====

[id='type-ExternalConfigurationEnv-{context}']
= `ExternalConfigurationEnv` schema reference

*The type `ExternalConfigurationEnv` has been deprecated.*
Please use xref:type-ContainerEnvVar-{context}[`ContainerEnvVar`] instead.

Used in: xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|Name of the environment variable which will be passed to the Kafka Connect pods. The name of the environment variable cannot start with `KAFKA_` or `STRIMZI_`.
|valueFrom
|xref:type-ExternalConfigurationEnvVarSource-{context}[`ExternalConfigurationEnvVarSource`]
|Value of the environment variable which will be passed to the Kafka Connect pods. It can be passed either as a reference to Secret or ConfigMap field. The field has to specify exactly one Secret or ConfigMap.
|====

[id='type-ExternalConfigurationEnvVarSource-{context}']
= `ExternalConfigurationEnvVarSource` schema reference

Used in: xref:type-ExternalConfigurationEnv-{context}[`ExternalConfigurationEnv`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|secretKeyRef
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#secretkeyselector-v1-core[SecretKeySelector]
|Reference to a key in a Secret.
|configMapKeyRef
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#configmapkeyselector-v1-core[ConfigMapKeySelector]
|Reference to a key in a ConfigMap.
|====

[id='type-ExternalConfigurationVolumeSource-{context}']
= `ExternalConfigurationVolumeSource` schema reference

*The type `ExternalConfigurationVolumeSource` has been deprecated.*
Please use xref:type-AdditionalVolume-{context}[`AdditionalVolume`] instead.

Used in: xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|Name of the volume which will be added to the Kafka Connect pods.
|secret
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#secretvolumesource-v1-core[SecretVolumeSource]
|Reference to a key in a Secret. Exactly one Secret or ConfigMap has to be specified.
|configMap
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#configmapvolumesource-v1-core[ConfigMapVolumeSource]
|Reference to a key in a ConfigMap. Exactly one Secret or ConfigMap has to be specified.
|====

[id='type-Build-{context}']
= `Build` schema reference

Used in: xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`]

xref:type-Build-schema-{context}[Full list of `Build` schema properties]

include::../api/io.strimzi.api.kafka.model.connect.build.Build.adoc[leveloffset=+1]

[id='type-Build-schema-{context}']
== `Build` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|output
|xref:type-DockerOutput-{context}[`DockerOutput`], xref:type-ImageStreamOutput-{context}[`ImageStreamOutput`]
|Configures where should the newly built image be stored. Required.
|plugins
|xref:type-Plugin-{context}[`Plugin`] array
|List of connector plugins which should be added to the Kafka Connect. Required.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve for the build.
|====

[id='type-DockerOutput-{context}']
= `DockerOutput` schema reference

Used in: xref:type-Build-{context}[`Build`]


The `type` property is a discriminator that distinguishes use of the `DockerOutput` type from xref:type-ImageStreamOutput-{context}[`ImageStreamOutput`].
It must have the value `docker` for the type `DockerOutput`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|image
|string
|The full name which should be used for tagging and pushing the newly built image. For example `quay.io/my-organization/my-custom-connect:latest`. Required.
|pushSecret
|string
|Container Registry Secret with the credentials for pushing the newly built image.
|additionalKanikoOptions
|string array
|Configures additional options which will be passed to the Kaniko executor when building the new Connect image. Allowed options are: --customPlatform, --custom-platform, --insecure, --insecure-pull, --insecure-registry, --log-format, --log-timestamp, --registry-mirror, --reproducible, --single-snapshot, --skip-tls-verify, --skip-tls-verify-pull, --skip-tls-verify-registry, --verbosity, --snapshotMode, --use-new-run, --registry-certificate, --registry-client-cert, --ignore-path. These options will be used only on Kubernetes where the Kaniko executor is used. They will be ignored on OpenShift. The options are described in the link:https://github.com/GoogleContainerTools/kaniko[Kaniko GitHub repository^]. Changing this field does not trigger new build of the Kafka Connect image.
|type
|string
|Must be `docker`.
|====

[id='type-ImageStreamOutput-{context}']
= `ImageStreamOutput` schema reference

Used in: xref:type-Build-{context}[`Build`]


The `type` property is a discriminator that distinguishes use of the `ImageStreamOutput` type from xref:type-DockerOutput-{context}[`DockerOutput`].
It must have the value `imagestream` for the type `ImageStreamOutput`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `imagestream`.
|image
|string
|The name and tag of the ImageStream where the newly built image will be pushed. For example `my-custom-connect:latest`. Required.
|====

[id='type-Plugin-{context}']
= `Plugin` schema reference

Used in: xref:type-Build-{context}[`Build`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|The unique name of the connector plugin. Will be used to generate the path where the connector artifacts will be stored. The name has to be unique within the KafkaConnect resource. The name has to follow the following pattern: `^[a-z][-_a-z0-9]*[a-z]$`. Required.
|artifacts
|xref:type-JarArtifact-{context}[`JarArtifact`], xref:type-TgzArtifact-{context}[`TgzArtifact`], xref:type-ZipArtifact-{context}[`ZipArtifact`], xref:type-MavenArtifact-{context}[`MavenArtifact`], xref:type-OtherArtifact-{context}[`OtherArtifact`] array
|List of artifacts which belong to this connector plugin. Required.
|====

[id='type-JarArtifact-{context}']
= `JarArtifact` schema reference

Used in: xref:type-Plugin-{context}[`Plugin`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `jar`.
|url
|string
|URL of the artifact which will be downloaded. Strimzi does not do any security scanning of the downloaded artifacts. For security reasons, you should first verify the artifacts manually and configure the checksum verification to make sure the same artifact is used in the automated build. Required for `jar`, `zip`, `tgz` and `other` artifacts. Not applicable to the `maven` artifact type.
|sha512sum
|string
|SHA512 checksum of the artifact. Optional. If specified, the checksum will be verified while building the new container. If not specified, the downloaded artifact will not be verified. Not applicable to the `maven` artifact type. 
|insecure
|boolean
|By default, connections using TLS are verified to check they are secure. The server certificate used must be valid, trusted, and contain the server name. By setting this option to `true`, all TLS verification is disabled and the artifact will be downloaded, even when the server is considered insecure.
|====

[id='type-TgzArtifact-{context}']
= `TgzArtifact` schema reference

Used in: xref:type-Plugin-{context}[`Plugin`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `tgz`.
|url
|string
|URL of the artifact which will be downloaded. Strimzi does not do any security scanning of the downloaded artifacts. For security reasons, you should first verify the artifacts manually and configure the checksum verification to make sure the same artifact is used in the automated build. Required for `jar`, `zip`, `tgz` and `other` artifacts. Not applicable to the `maven` artifact type.
|sha512sum
|string
|SHA512 checksum of the artifact. Optional. If specified, the checksum will be verified while building the new container. If not specified, the downloaded artifact will not be verified. Not applicable to the `maven` artifact type. 
|insecure
|boolean
|By default, connections using TLS are verified to check they are secure. The server certificate used must be valid, trusted, and contain the server name. By setting this option to `true`, all TLS verification is disabled and the artifact will be downloaded, even when the server is considered insecure.
|====

[id='type-ZipArtifact-{context}']
= `ZipArtifact` schema reference

Used in: xref:type-Plugin-{context}[`Plugin`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `zip`.
|url
|string
|URL of the artifact which will be downloaded. Strimzi does not do any security scanning of the downloaded artifacts. For security reasons, you should first verify the artifacts manually and configure the checksum verification to make sure the same artifact is used in the automated build. Required for `jar`, `zip`, `tgz` and `other` artifacts. Not applicable to the `maven` artifact type.
|sha512sum
|string
|SHA512 checksum of the artifact. Optional. If specified, the checksum will be verified while building the new container. If not specified, the downloaded artifact will not be verified. Not applicable to the `maven` artifact type. 
|insecure
|boolean
|By default, connections using TLS are verified to check they are secure. The server certificate used must be valid, trusted, and contain the server name. By setting this option to `true`, all TLS verification is disabled and the artifact will be downloaded, even when the server is considered insecure.
|====

[id='type-MavenArtifact-{context}']
= `MavenArtifact` schema reference

Used in: xref:type-Plugin-{context}[`Plugin`]


The `type` property is a discriminator that distinguishes use of the `MavenArtifact` type from xref:type-JarArtifact-{context}[`JarArtifact`], xref:type-TgzArtifact-{context}[`TgzArtifact`], xref:type-ZipArtifact-{context}[`ZipArtifact`], xref:type-OtherArtifact-{context}[`OtherArtifact`].
It must have the value `maven` for the type `MavenArtifact`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `maven`.
|repository
|string
|Maven repository to download the artifact from. Applicable to the `maven` artifact type only.
|group
|string
|Maven group id. Applicable to the `maven` artifact type only.
|artifact
|string
|Maven artifact id. Applicable to the `maven` artifact type only.
|version
|string
|Maven version number. Applicable to the `maven` artifact type only.
|insecure
|boolean
|By default, connections using TLS are verified to check they are secure. The server certificate used must be valid, trusted, and contain the server name. By setting this option to `true`, all TLS verification is disabled and the artifacts will be downloaded, even when the server is considered insecure.
|====

[id='type-OtherArtifact-{context}']
= `OtherArtifact` schema reference

Used in: xref:type-Plugin-{context}[`Plugin`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `other`.
|url
|string
|URL of the artifact which will be downloaded. Strimzi does not do any security scanning of the downloaded artifacts. For security reasons, you should first verify the artifacts manually and configure the checksum verification to make sure the same artifact is used in the automated build. Required for `jar`, `zip`, `tgz` and `other` artifacts. Not applicable to the `maven` artifact type.
|sha512sum
|string
|SHA512 checksum of the artifact. Optional. If specified, the checksum will be verified while building the new container. If not specified, the downloaded artifact will not be verified. Not applicable to the `maven` artifact type. 
|fileName
|string
|Name under which the artifact will be stored.
|insecure
|boolean
|By default, connections using TLS are verified to check they are secure. The server certificate used must be valid, trusted, and contain the server name. By setting this option to `true`, all TLS verification is disabled and the artifact will be downloaded, even when the server is considered insecure.
|====

[id='type-MountedPlugin-{context}']
= `MountedPlugin` schema reference

Used in: xref:type-KafkaConnectSpec-{context}[`KafkaConnectSpec`]

xref:type-MountedPlugin-schema-{context}[Full list of `MountedPlugin` schema properties]

include::../api/io.strimzi.api.kafka.model.connect.MountedPlugin.adoc[leveloffset=+1]

[id='type-MountedPlugin-schema-{context}']
== `MountedPlugin` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|name
|string
|A unique name for the connector plugin. This name is used to generate the mount path for the connector artifacts. The name has to be unique within the KafkaConnect resource. The name must be unique within the `KafkaConnect` resource and match the pattern: `^[a-z][-_a-z0-9]*[a-z]$`. Required.
|artifacts
|xref:type-ImageArtifact-{context}[`ImageArtifact`] array
|List of artifacts associated with this connector plugin. Required.
|====

[id='type-ImageArtifact-{context}']
= `ImageArtifact` schema reference

Used in: xref:type-MountedPlugin-{context}[`MountedPlugin`]


The `type` property is a discriminator that distinguishes use of the `ImageArtifact` type from other subtypes which may be added in the future.
It must have the value `image` for the type `ImageArtifact`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `image`.
|reference
|string
|Reference to the container image (OCI artifact) containing the Kafka Connect plugin. The image is mounted as a volume and provides the plugin binary. Required.
|pullPolicy
|string
|Policy that determines when the container image (OCI artifact) is pulled.

Possible values are:

* `Always`: Always pull the image. If the pull fails, container creation fails.
* `Never`: Never pull the image. Use only a locally available image. Container creation fails if the image isn’t present.
* `IfNotPresent`: Pull the image only if it’s not already available locally. Container creation fails if the image isn’t present and the pull fails.

Defaults to `Always` if `:latest` tag is specified, or `IfNotPresent` otherwise.
|====

[id='type-KafkaConnectStatus-{context}']
= `KafkaConnectStatus` schema reference

Used in: xref:type-KafkaConnect-{context}[`KafkaConnect`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|url
|string
|The URL of the REST API endpoint for managing and monitoring Kafka Connect connectors.
|connectorPlugins
|xref:type-ConnectorPlugin-{context}[`ConnectorPlugin`] array
|The list of connector plugins available in this Kafka Connect deployment.
|replicas
|integer
|The current number of pods being used to provide this resource.
|labelSelector
|string
|Label selector for pods providing this resource.
|====

[id='type-ConnectorPlugin-{context}']
= `ConnectorPlugin` schema reference

Used in: xref:type-KafkaConnectStatus-{context}[`KafkaConnectStatus`], xref:type-KafkaMirrorMaker2Status-{context}[`KafkaMirrorMaker2Status`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|class
|string
|The class of the connector plugin.
|type
|string
|The type of the connector plugin. The available types are `sink` and `source`.
|version
|string
|The version of the connector plugin.
|====

[id='type-KafkaTopic-{context}']
= `KafkaTopic` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaTopicSpec-{context}[`KafkaTopicSpec`]
|The specification of the topic.
|status
|xref:type-KafkaTopicStatus-{context}[`KafkaTopicStatus`]
|The status of the topic.
|====

[id='type-KafkaTopicSpec-{context}']
= `KafkaTopicSpec` schema reference

Used in: xref:type-KafkaTopic-{context}[`KafkaTopic`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|topicName
|string
|The name of the topic. When absent this will default to the metadata.name of the topic. It is recommended to not set this unless the topic name is not a valid Kubernetes resource name.
|partitions
|integer
|The number of partitions the topic should have. This cannot be decreased after topic creation. It can be increased after topic creation, but it is important to understand the consequences that has, especially for topics with semantic partitioning. When absent this will default to the broker configuration for `num.partitions`.
|replicas
|integer
|The number of replicas the topic should have. When absent this will default to the broker configuration for `default.replication.factor`.
|config
|map
|The topic configuration.
|====

[id='type-KafkaTopicStatus-{context}']
= `KafkaTopicStatus` schema reference

Used in: xref:type-KafkaTopic-{context}[`KafkaTopic`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|topicName
|string
|Topic name.
|topicId
|string
|The topic's id. For a KafkaTopic with the ready condition, this will change only if the topic gets deleted and recreated with the same name.
|replicasChange
|xref:type-ReplicasChangeStatus-{context}[`ReplicasChangeStatus`]
|Replication factor change status.
|====

[id='type-ReplicasChangeStatus-{context}']
= `ReplicasChangeStatus` schema reference

Used in: xref:type-KafkaTopicStatus-{context}[`KafkaTopicStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|targetReplicas
|integer
|The target replicas value requested by the user. This may be different from .spec.replicas when a change is ongoing.
|state
|string (one of [ongoing, pending])
|Current state of the replicas change operation. This can be `pending`, when the change has been requested, or `ongoing`, when the change has been successfully submitted to Cruise Control.
|message
|string
|Message for the user related to the replicas change request. This may contain transient error messages that would disappear on periodic reconciliations.
|sessionId
|string
|The session identifier for replicas change requests pertaining to this KafkaTopic resource. This is used by the Topic Operator to track the status of `ongoing` replicas change operations.
|====

[id='type-KafkaUser-{context}']
= `KafkaUser` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaUserSpec-{context}[`KafkaUserSpec`]
|The specification of the user.
|status
|xref:type-KafkaUserStatus-{context}[`KafkaUserStatus`]
|The status of the Kafka User.
|====

[id='type-KafkaUserSpec-{context}']
= `KafkaUserSpec` schema reference

Used in: xref:type-KafkaUser-{context}[`KafkaUser`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|authentication
|xref:type-KafkaUserTlsClientAuthentication-{context}[`KafkaUserTlsClientAuthentication`], xref:type-KafkaUserTlsExternalClientAuthentication-{context}[`KafkaUserTlsExternalClientAuthentication`], xref:type-KafkaUserScramSha512ClientAuthentication-{context}[`KafkaUserScramSha512ClientAuthentication`]
|Authentication mechanism enabled for this Kafka user. The supported authentication mechanisms are `scram-sha-512`, `tls`, and `tls-external`. 

* `scram-sha-512` generates a secret with SASL SCRAM-SHA-512 credentials.
* `tls` generates a secret with user certificate for mutual TLS authentication.
* `tls-external` does not generate a user certificate.   But prepares the user for using mutual TLS authentication using a user certificate generated outside the User Operator.
  ACLs and quotas set for this user are configured in the `CN=<username>` format.

Authentication is optional. If authentication is not configured, no credentials are generated. ACLs and quotas set for the user are configured in the `<username>` format suitable for SASL authentication.
|authorization
|xref:type-KafkaUserAuthorizationSimple-{context}[`KafkaUserAuthorizationSimple`]
|Authorization rules for this Kafka user.
|quotas
|xref:type-KafkaUserQuotas-{context}[`KafkaUserQuotas`]
|Quotas on requests to control the broker resources used by clients. Network bandwidth and request rate quotas can be enforced.Kafka documentation for Kafka User quotas can be found at http://kafka.apache.org/documentation/#design_quotas.
|template
|xref:type-KafkaUserTemplate-{context}[`KafkaUserTemplate`]
|Template to specify how Kafka User `Secrets` are generated.
|====

[id='type-KafkaUserTlsClientAuthentication-{context}']
= `KafkaUserTlsClientAuthentication` schema reference

Used in: xref:type-KafkaUserSpec-{context}[`KafkaUserSpec`]


The `type` property is a discriminator that distinguishes use of the `KafkaUserTlsClientAuthentication` type from xref:type-KafkaUserTlsExternalClientAuthentication-{context}[`KafkaUserTlsExternalClientAuthentication`], xref:type-KafkaUserScramSha512ClientAuthentication-{context}[`KafkaUserScramSha512ClientAuthentication`].
It must have the value `tls` for the type `KafkaUserTlsClientAuthentication`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `tls`.
|====

[id='type-KafkaUserTlsExternalClientAuthentication-{context}']
= `KafkaUserTlsExternalClientAuthentication` schema reference

Used in: xref:type-KafkaUserSpec-{context}[`KafkaUserSpec`]


The `type` property is a discriminator that distinguishes use of the `KafkaUserTlsExternalClientAuthentication` type from xref:type-KafkaUserTlsClientAuthentication-{context}[`KafkaUserTlsClientAuthentication`], xref:type-KafkaUserScramSha512ClientAuthentication-{context}[`KafkaUserScramSha512ClientAuthentication`].
It must have the value `tls-external` for the type `KafkaUserTlsExternalClientAuthentication`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `tls-external`.
|====

[id='type-KafkaUserScramSha512ClientAuthentication-{context}']
= `KafkaUserScramSha512ClientAuthentication` schema reference

Used in: xref:type-KafkaUserSpec-{context}[`KafkaUserSpec`]


The `type` property is a discriminator that distinguishes use of the `KafkaUserScramSha512ClientAuthentication` type from xref:type-KafkaUserTlsClientAuthentication-{context}[`KafkaUserTlsClientAuthentication`], xref:type-KafkaUserTlsExternalClientAuthentication-{context}[`KafkaUserTlsExternalClientAuthentication`].
It must have the value `scram-sha-512` for the type `KafkaUserScramSha512ClientAuthentication`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `scram-sha-512`.
|password
|xref:type-Password-{context}[`Password`]
|Specify the password for the user. If not set, a new password is generated by the User Operator.
|====

[id='type-Password-{context}']
= `Password` schema reference

Used in: xref:type-KafkaUserScramSha512ClientAuthentication-{context}[`KafkaUserScramSha512ClientAuthentication`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|valueFrom
|xref:type-PasswordSource-{context}[`PasswordSource`]
|Secret from which the password should be read.
|====

[id='type-KafkaUserAuthorizationSimple-{context}']
= `KafkaUserAuthorizationSimple` schema reference

Used in: xref:type-KafkaUserSpec-{context}[`KafkaUserSpec`]


The `type` property is a discriminator that distinguishes use of the `KafkaUserAuthorizationSimple` type from other subtypes which may be added in the future.
It must have the value `simple` for the type `KafkaUserAuthorizationSimple`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `simple`.
|acls
|xref:type-AclRule-{context}[`AclRule`] array
|List of ACL rules which should be applied to this user.
|====

[id='type-AclRule-{context}']
= `AclRule` schema reference

Used in: xref:type-KafkaUserAuthorizationSimple-{context}[`KafkaUserAuthorizationSimple`]

xref:type-AclRule-schema-{context}[Full list of `AclRule` schema properties]

include::../api/io.strimzi.api.kafka.model.user.acl.AclRule.adoc[leveloffset=+1]

[id='type-AclRule-schema-{context}']
== `AclRule` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string (one of [allow, deny])
|The type of the rule. ACL rules with type `allow` are used to allow user to execute the specified operations. ACL rules with type `deny` are used to deny user to execute the specified operations. Default value is `allow`.
|resource
|xref:type-AclRuleTopicResource-{context}[`AclRuleTopicResource`], xref:type-AclRuleGroupResource-{context}[`AclRuleGroupResource`], xref:type-AclRuleClusterResource-{context}[`AclRuleClusterResource`], xref:type-AclRuleTransactionalIdResource-{context}[`AclRuleTransactionalIdResource`]
|Indicates the resource for which given ACL rule applies.
|host
|string
|The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*`, allowing or denying the action from any host.
|operation
|string (one of [Read, Write, Delete, Alter, Describe, All, IdempotentWrite, ClusterAction, Create, AlterConfigs, DescribeConfigs])
|**The `operation` property has been deprecated, and should now be configured using `spec.authorization.acls[*].operations`.** Operation which will be allowed or denied. Supported operations are: Read, Write, Create, Delete, Alter, Describe, ClusterAction, AlterConfigs, DescribeConfigs, IdempotentWrite and All.
|operations
|string (one or more of [Read, Write, Delete, Alter, Describe, All, IdempotentWrite, ClusterAction, Create, AlterConfigs, DescribeConfigs]) array
|List of operations to allow or deny. Supported operations are: Read, Write, Create, Delete, Alter, Describe, ClusterAction, AlterConfigs, DescribeConfigs, IdempotentWrite and All. Only certain operations work with the specified resource.
|====

[id='type-AclRuleTopicResource-{context}']
= `AclRuleTopicResource` schema reference

Used in: xref:type-AclRule-{context}[`AclRule`]


The `type` property is a discriminator that distinguishes use of the `AclRuleTopicResource` type from xref:type-AclRuleGroupResource-{context}[`AclRuleGroupResource`], xref:type-AclRuleClusterResource-{context}[`AclRuleClusterResource`], xref:type-AclRuleTransactionalIdResource-{context}[`AclRuleTransactionalIdResource`].
It must have the value `topic` for the type `AclRuleTopicResource`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `topic`.
|name
|string
|Name of resource for which given ACL rule applies. Can be combined with `patternType` field to use prefix pattern.
|patternType
|string (one of [prefix, literal])
|Describes the pattern used in the resource field. The supported types are `literal` and `prefix`. With `literal` pattern type, the resource field will be used as a definition of a full topic name. With `prefix` pattern type, the resource name will be used only as a prefix. Default value is `literal`.
|====

[id='type-AclRuleGroupResource-{context}']
= `AclRuleGroupResource` schema reference

Used in: xref:type-AclRule-{context}[`AclRule`]


The `type` property is a discriminator that distinguishes use of the `AclRuleGroupResource` type from xref:type-AclRuleTopicResource-{context}[`AclRuleTopicResource`], xref:type-AclRuleClusterResource-{context}[`AclRuleClusterResource`], xref:type-AclRuleTransactionalIdResource-{context}[`AclRuleTransactionalIdResource`].
It must have the value `group` for the type `AclRuleGroupResource`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `group`.
|name
|string
|Name of resource for which given ACL rule applies. Can be combined with `patternType` field to use prefix pattern.
|patternType
|string (one of [prefix, literal])
|Describes the pattern used in the resource field. The supported types are `literal` and `prefix`. With `literal` pattern type, the resource field will be used as a definition of a full topic name. With `prefix` pattern type, the resource name will be used only as a prefix. Default value is `literal`.
|====

[id='type-AclRuleClusterResource-{context}']
= `AclRuleClusterResource` schema reference

Used in: xref:type-AclRule-{context}[`AclRule`]


The `type` property is a discriminator that distinguishes use of the `AclRuleClusterResource` type from xref:type-AclRuleTopicResource-{context}[`AclRuleTopicResource`], xref:type-AclRuleGroupResource-{context}[`AclRuleGroupResource`], xref:type-AclRuleTransactionalIdResource-{context}[`AclRuleTransactionalIdResource`].
It must have the value `cluster` for the type `AclRuleClusterResource`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `cluster`.
|====

[id='type-AclRuleTransactionalIdResource-{context}']
= `AclRuleTransactionalIdResource` schema reference

Used in: xref:type-AclRule-{context}[`AclRule`]


The `type` property is a discriminator that distinguishes use of the `AclRuleTransactionalIdResource` type from xref:type-AclRuleTopicResource-{context}[`AclRuleTopicResource`], xref:type-AclRuleGroupResource-{context}[`AclRuleGroupResource`], xref:type-AclRuleClusterResource-{context}[`AclRuleClusterResource`].
It must have the value `transactionalId` for the type `AclRuleTransactionalIdResource`.
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|type
|string
|Must be `transactionalId`.
|name
|string
|Name of resource for which given ACL rule applies. Can be combined with `patternType` field to use prefix pattern.
|patternType
|string (one of [prefix, literal])
|Describes the pattern used in the resource field. The supported types are `literal` and `prefix`. With `literal` pattern type, the resource field will be used as a definition of a full name. With `prefix` pattern type, the resource name will be used only as a prefix. Default value is `literal`.
|====

[id='type-KafkaUserQuotas-{context}']
= `KafkaUserQuotas` schema reference

Used in: xref:type-KafkaUserSpec-{context}[`KafkaUserSpec`]

xref:type-KafkaUserQuotas-schema-{context}[Full list of `KafkaUserQuotas` schema properties]

include::../api/io.strimzi.api.kafka.model.user.KafkaUserQuotas.adoc[leveloffset=+1]

[id='type-KafkaUserQuotas-schema-{context}']
== `KafkaUserQuotas` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|producerByteRate
|integer
|A quota on the maximum bytes per-second that each client group can publish to a broker before the clients in the group are throttled. Defined on a per-broker basis.
|consumerByteRate
|integer
|A quota on the maximum bytes per-second that each client group can fetch from a broker before the clients in the group are throttled. Defined on a per-broker basis.
|requestPercentage
|integer
|A quota on the maximum CPU utilization of each client group as a percentage of network and I/O threads.
|controllerMutationRate
|number
|A quota on the rate at which mutations are accepted for the create topics request, the create partitions request and the delete topics request. The rate is accumulated by the number of partitions created or deleted.
|====

[id='type-KafkaUserTemplate-{context}']
= `KafkaUserTemplate` schema reference

Used in: xref:type-KafkaUserSpec-{context}[`KafkaUserSpec`]

xref:type-KafkaUserTemplate-schema-{context}[Full list of `KafkaUserTemplate` schema properties]

include::../api/io.strimzi.api.kafka.model.user.KafkaUserTemplate.adoc[leveloffset=+1]

[id='type-KafkaUserTemplate-schema-{context}']
== `KafkaUserTemplate` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|secret
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for KafkaUser resources. The template allows users to specify how the `Secret` with password or TLS certificates is generated.
|====

[id='type-KafkaUserStatus-{context}']
= `KafkaUserStatus` schema reference

Used in: xref:type-KafkaUser-{context}[`KafkaUser`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|username
|string
|Username.
|secret
|string
|The name of `Secret` where the credentials are stored.
|====

[id='type-KafkaBridge-{context}']
= `KafkaBridge` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`]
|The specification of the Kafka Bridge.
|status
|xref:type-KafkaBridgeStatus-{context}[`KafkaBridgeStatus`]
|The status of the Kafka Bridge.
|====

[id='type-KafkaBridgeSpec-{context}']
= `KafkaBridgeSpec` schema reference

Used in: xref:type-KafkaBridge-{context}[`KafkaBridge`]

xref:type-KafkaBridgeSpec-schema-{context}[Full list of `KafkaBridgeSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.bridge.KafkaBridgeSpec.adoc[leveloffset=+1]

[id='type-KafkaBridgeSpec-schema-{context}']
== `KafkaBridgeSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|replicas
|integer
|The number of pods in the `Deployment`.  Defaults to `1`.
|image
|string
|The container image used for Kafka Bridge pods. If no image name is explicitly specified, the image name corresponds to the image specified in the Cluster Operator configuration. If an image name is not defined in the Cluster Operator configuration, a default value is used.
|bootstrapServers
|string
|A list of host:port pairs for establishing the initial connection to the Kafka cluster.
|tls
|xref:type-ClientTls-{context}[`ClientTls`]
|TLS configuration for connecting Kafka Bridge to the cluster.
|authentication
|xref:type-KafkaClientAuthenticationTls-{context}[`KafkaClientAuthenticationTls`], xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`], xref:type-KafkaClientAuthenticationPlain-{context}[`KafkaClientAuthenticationPlain`], xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaClientAuthenticationCustom-{context}[`KafkaClientAuthenticationCustom`]
|Authentication configuration for connecting to the cluster.
|http
|xref:type-KafkaBridgeHttpConfig-{context}[`KafkaBridgeHttpConfig`]
|The HTTP related configuration.
|adminClient
|xref:type-KafkaBridgeAdminClientSpec-{context}[`KafkaBridgeAdminClientSpec`]
|Kafka AdminClient related configuration.
|consumer
|xref:type-KafkaBridgeConsumerSpec-{context}[`KafkaBridgeConsumerSpec`]
|Kafka consumer related configuration.
|producer
|xref:type-KafkaBridgeProducerSpec-{context}[`KafkaBridgeProducerSpec`]
|Kafka producer related configuration.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration for Kafka Bridge.
|clientRackInitImage
|string
|The image of the init container used for initializing the `client.rack`.
|rack
|xref:type-Rack-{context}[`Rack`]
|Configuration of the node label which will be used as the client.rack consumer configuration.
|enableMetrics
|boolean
|**The `enableMetrics` property has been deprecated, and should now be configured using `.spec.metricsConfig`.** The `enableMetrics` configuration is deprecated and will be removed in the future. Enable the metrics for the Kafka Bridge. Default is false.
|metricsConfig
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`], xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`]
|Metrics configuration.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|template
|xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`]
|Template for Kafka Bridge resources. The template allows users to specify how a `Deployment` and `Pod` is generated.
|tracing
|xref:type-JaegerTracing-{context}[`JaegerTracing`], xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`]
|The configuration of tracing in Kafka Bridge.
|====

[id='type-KafkaBridgeHttpConfig-{context}']
= `KafkaBridgeHttpConfig` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`]

xref:type-KafkaBridgeHttpConfig-schema-{context}[Full list of `KafkaBridgeHttpConfig` schema properties]

include::../api/io.strimzi.api.kafka.model.bridge.KafkaBridgeHttpConfig.adoc[leveloffset=+1]

[id='type-KafkaBridgeHttpConfig-schema-{context}']
== `KafkaBridgeHttpConfig` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|port
|integer
|The port which is the server listening on.
|cors
|xref:type-KafkaBridgeHttpCors-{context}[`KafkaBridgeHttpCors`]
|CORS configuration for the HTTP Bridge.
|====

[id='type-KafkaBridgeHttpCors-{context}']
= `KafkaBridgeHttpCors` schema reference

Used in: xref:type-KafkaBridgeHttpConfig-{context}[`KafkaBridgeHttpConfig`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|allowedOrigins
|string array
|List of allowed origins. Java regular expressions can be used.
|allowedMethods
|string array
|List of allowed HTTP methods.
|====

[id='type-KafkaBridgeAdminClientSpec-{context}']
= `KafkaBridgeAdminClientSpec` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|config
|map
|The Kafka AdminClient configuration used for AdminClient instances created by the bridge.
|====

[id='type-KafkaBridgeConsumerSpec-{context}']
= `KafkaBridgeConsumerSpec` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`]

xref:type-KafkaBridgeConsumerSpec-schema-{context}[Full list of `KafkaBridgeConsumerSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.bridge.KafkaBridgeConsumerSpec.adoc[leveloffset=+1]

[id='type-KafkaBridgeConsumerSpec-schema-{context}']
== `KafkaBridgeConsumerSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|enabled
|boolean
|Whether the HTTP consumer should be enabled or disabled. The default is enabled (`true`).
|timeoutSeconds
|integer
|The timeout in seconds for deleting inactive consumers, default is -1 (disabled).
|config
|map
|The Kafka consumer configuration used for consumer instances created by the bridge. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, group.id, sasl., security. (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
|====

[id='type-KafkaBridgeProducerSpec-{context}']
= `KafkaBridgeProducerSpec` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`]

xref:type-KafkaBridgeProducerSpec-schema-{context}[Full list of `KafkaBridgeProducerSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.bridge.KafkaBridgeProducerSpec.adoc[leveloffset=+1]

[id='type-KafkaBridgeProducerSpec-schema-{context}']
== `KafkaBridgeProducerSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|enabled
|boolean
|Whether the HTTP producer should be enabled or disabled. The default is enabled (`true`).
|config
|map
|The Kafka producer configuration used for producer instances created by the bridge. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, sasl., security. (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
|====

[id='type-KafkaBridgeTemplate-{context}']
= `KafkaBridgeTemplate` schema reference

Used in: xref:type-KafkaBridgeSpec-{context}[`KafkaBridgeSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|deployment
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|Template for Kafka Bridge `Deployment`.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Kafka Bridge `Pods`.
|apiService
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|Template for Kafka Bridge API `Service`.
|podDisruptionBudget
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|Template for Kafka Bridge `PodDisruptionBudget`.
|bridgeContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka Bridge container.
|clusterRoleBinding
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka Bridge ClusterRoleBinding.
|serviceAccount
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for the Kafka Bridge service account.
|initContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka Bridge init container.
|====

[id='type-KafkaBridgeStatus-{context}']
= `KafkaBridgeStatus` schema reference

Used in: xref:type-KafkaBridge-{context}[`KafkaBridge`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|url
|string
|The URL at which external client applications can access the Kafka Bridge.
|replicas
|integer
|The current number of pods being used to provide this resource.
|labelSelector
|string
|Label selector for pods providing this resource.
|====

[id='type-KafkaConnector-{context}']
= `KafkaConnector` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaConnectorSpec-{context}[`KafkaConnectorSpec`]
|The specification of the Kafka Connector.
|status
|xref:type-KafkaConnectorStatus-{context}[`KafkaConnectorStatus`]
|The status of the Kafka Connector.
|====

[id='type-KafkaConnectorSpec-{context}']
= `KafkaConnectorSpec` schema reference

Used in: xref:type-KafkaConnector-{context}[`KafkaConnector`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|class
|string
|The Class for the Kafka Connector.
|tasksMax
|integer
|The maximum number of tasks for the Kafka Connector.
|autoRestart
|xref:type-AutoRestart-{context}[`AutoRestart`]
|Automatic restart of connector and tasks configuration.
|config
|map
|The Kafka Connector configuration. The following properties cannot be set: name, connector.class, tasks.max.
|pause
|boolean
|**The `pause` property has been deprecated.** Deprecated in Strimzi 0.38.0, use state instead. Whether the connector should be paused. Defaults to false.
|state
|string (one of [running, paused, stopped])
|The state the connector should be in. Defaults to running.
|listOffsets
|xref:type-ListOffsets-{context}[`ListOffsets`]
|Configuration for listing offsets.
|alterOffsets
|xref:type-AlterOffsets-{context}[`AlterOffsets`]
|Configuration for altering offsets.
|====

[id='type-AutoRestart-{context}']
= `AutoRestart` schema reference

Used in: xref:type-KafkaConnectorSpec-{context}[`KafkaConnectorSpec`], xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]

xref:type-AutoRestart-schema-{context}[Full list of `AutoRestart` schema properties]

include::../api/io.strimzi.api.kafka.model.connector.AutoRestart.adoc[leveloffset=+1]

[id='type-AutoRestart-schema-{context}']
== `AutoRestart` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|enabled
|boolean
|Whether automatic restart for failed connectors and tasks should be enabled or disabled.
|maxRestarts
|integer
|The maximum number of connector restarts that the operator will try. If the connector remains in a failed state after reaching this limit, it must be restarted manually by the user. Defaults to an unlimited number of restarts.
|====

[id='type-ListOffsets-{context}']
= `ListOffsets` schema reference

Used in: xref:type-KafkaConnectorSpec-{context}[`KafkaConnectorSpec`], xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|toConfigMap
|xref:type-LocalObjectReference-{context}[`LocalObjectReference`]
|Reference to the ConfigMap where the list of offsets will be written to.
|====

[id='type-AlterOffsets-{context}']
= `AlterOffsets` schema reference

Used in: xref:type-KafkaConnectorSpec-{context}[`KafkaConnectorSpec`], xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|fromConfigMap
|xref:type-LocalObjectReference-{context}[`LocalObjectReference`]
|Reference to the ConfigMap where the new offsets are stored.
|====

[id='type-KafkaConnectorStatus-{context}']
= `KafkaConnectorStatus` schema reference

Used in: xref:type-KafkaConnector-{context}[`KafkaConnector`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|autoRestart
|xref:type-AutoRestartStatus-{context}[`AutoRestartStatus`]
|The auto restart status.
|connectorStatus
|map
|The connector status, as reported by the Kafka Connect REST API.
|tasksMax
|integer
|The maximum number of tasks for the Kafka Connector.
|topics
|string array
|The list of topics used by the Kafka Connector.
|====

[id='type-AutoRestartStatus-{context}']
= `AutoRestartStatus` schema reference

Used in: xref:type-KafkaConnectorStatus-{context}[`KafkaConnectorStatus`], xref:type-KafkaMirrorMaker2Status-{context}[`KafkaMirrorMaker2Status`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|count
|integer
|The number of times the connector or task is restarted.
|connectorName
|string
|The name of the connector being restarted.
|lastRestartTimestamp
|string
|The last time the automatic restart was attempted. The required format is 'yyyy-MM-ddTHH:mm:ssZ' in the UTC time zone.
|====

[id='type-KafkaMirrorMaker2-{context}']
= `KafkaMirrorMaker2` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]
|The specification of the Kafka MirrorMaker 2 cluster.
|status
|xref:type-KafkaMirrorMaker2Status-{context}[`KafkaMirrorMaker2Status`]
|The status of the Kafka MirrorMaker 2 cluster.
|====

[id='type-KafkaMirrorMaker2Spec-{context}']
= `KafkaMirrorMaker2Spec` schema reference

Used in: xref:type-KafkaMirrorMaker2-{context}[`KafkaMirrorMaker2`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|version
|string
|The Kafka Connect version. Defaults to the latest version. Consult the user documentation to understand the process required to upgrade or downgrade the version.
|replicas
|integer
|The number of pods in the Kafka Connect group. Defaults to `3`.
|image
|string
|The container image used for Kafka Connect pods. If no image name is explicitly specified, it is determined based on the `spec.version` configuration. The image names are specifically mapped to corresponding versions in the Cluster Operator configuration.
|connectCluster
|string
|The cluster alias used for Kafka Connect. The value must match the alias of the *target* Kafka cluster as specified in the `spec.clusters` configuration. The target Kafka cluster is used by the underlying Kafka Connect framework for its internal topics.
|clusters
|xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`] array
|Kafka clusters for mirroring.
|mirrors
|xref:type-KafkaMirrorMaker2MirrorSpec-{context}[`KafkaMirrorMaker2MirrorSpec`] array
|Configuration of the MirrorMaker 2 connectors.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|The maximum limits for CPU and memory resources and the requested initial resources.
|livenessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod liveness checking.
|readinessProbe
|xref:type-Probe-{context}[`Probe`]
|Pod readiness checking.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|jmxOptions
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|JMX Options.
|logging
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|Logging configuration for Kafka Connect.
|clientRackInitImage
|string
|The image of the init container used for initializing the `client.rack`.
|rack
|xref:type-Rack-{context}[`Rack`]
|Configuration of the node label which will be used as the `client.rack` consumer configuration.
|metricsConfig
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`], xref:type-StrimziMetricsReporter-{context}[`StrimziMetricsReporter`]
|Metrics configuration.
|tracing
|xref:type-JaegerTracing-{context}[`JaegerTracing`], xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`]
|The configuration of tracing in Kafka Connect.
|template
|xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`]
|Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated.
|externalConfiguration
|xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]
|**The `externalConfiguration` property has been deprecated.** The external configuration is deprecated and will be removed in the future. Please use the template section instead to configure additional environment variables or volumes. Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
|====

[id='type-KafkaMirrorMaker2ClusterSpec-{context}']
= `KafkaMirrorMaker2ClusterSpec` schema reference

Used in: xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]

xref:type-KafkaMirrorMaker2ClusterSpec-schema-{context}[Full list of `KafkaMirrorMaker2ClusterSpec` schema properties]

include::../api/io.strimzi.api.kafka.model.mirrormaker2.KafkaMirrorMaker2ClusterSpec.adoc[leveloffset=+1]

[id='type-KafkaMirrorMaker2ClusterSpec-schema-{context}']
== `KafkaMirrorMaker2ClusterSpec` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|alias
|string
|Alias used to reference the Kafka cluster.
|bootstrapServers
|string
|A comma-separated list of `host:port` pairs for establishing the connection to the Kafka cluster.
|tls
|xref:type-ClientTls-{context}[`ClientTls`]
|TLS configuration for connecting MirrorMaker 2 connectors to a cluster.
|authentication
|xref:type-KafkaClientAuthenticationTls-{context}[`KafkaClientAuthenticationTls`], xref:type-KafkaClientAuthenticationScramSha256-{context}[`KafkaClientAuthenticationScramSha256`], xref:type-KafkaClientAuthenticationScramSha512-{context}[`KafkaClientAuthenticationScramSha512`], xref:type-KafkaClientAuthenticationPlain-{context}[`KafkaClientAuthenticationPlain`], xref:type-KafkaClientAuthenticationOAuth-{context}[`KafkaClientAuthenticationOAuth`], xref:type-KafkaClientAuthenticationCustom-{context}[`KafkaClientAuthenticationCustom`]
|Authentication configuration for connecting to the cluster.
|config
|map
|The MirrorMaker 2 cluster config. Properties with the following prefixes cannot be set: ssl., sasl., security., listeners, plugin.path, rest., bootstrap.servers, consumer.interceptor.classes, producer.interceptor.classes (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
|====

[id='type-KafkaMirrorMaker2MirrorSpec-{context}']
= `KafkaMirrorMaker2MirrorSpec` schema reference

Used in: xref:type-KafkaMirrorMaker2Spec-{context}[`KafkaMirrorMaker2Spec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|sourceCluster
|string
|The alias of the source cluster used by the Kafka MirrorMaker 2 connectors. The alias must match a cluster in the list at `spec.clusters`.
|targetCluster
|string
|The alias of the target cluster used by the Kafka MirrorMaker 2 connectors. The alias must match a cluster in the list at `spec.clusters`.
|sourceConnector
|xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]
|The specification of the Kafka MirrorMaker 2 source connector.
|heartbeatConnector
|xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]
|The specification of the Kafka MirrorMaker 2 heartbeat connector.
|checkpointConnector
|xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]
|The specification of the Kafka MirrorMaker 2 checkpoint connector.
|topicsPattern
|string
|A regular expression matching the topics to be mirrored, for example, "topic1\|topic2\|topic3". Comma-separated lists are also supported.
|topicsBlacklistPattern
|string
|**The `topicsBlacklistPattern` property has been deprecated, and should now be configured using `.spec.mirrors.topicsExcludePattern`.** A regular expression matching the topics to exclude from mirroring. Comma-separated lists are also supported.
|topicsExcludePattern
|string
|A regular expression matching the topics to exclude from mirroring. Comma-separated lists are also supported.
|groupsPattern
|string
|A regular expression matching the consumer groups to be mirrored. Comma-separated lists are also supported.
|groupsBlacklistPattern
|string
|**The `groupsBlacklistPattern` property has been deprecated, and should now be configured using `.spec.mirrors.groupsExcludePattern`.** A regular expression matching the consumer groups to exclude from mirroring. Comma-separated lists are also supported.
|groupsExcludePattern
|string
|A regular expression matching the consumer groups to exclude from mirroring. Comma-separated lists are also supported.
|====

[id='type-KafkaMirrorMaker2ConnectorSpec-{context}']
= `KafkaMirrorMaker2ConnectorSpec` schema reference

Used in: xref:type-KafkaMirrorMaker2MirrorSpec-{context}[`KafkaMirrorMaker2MirrorSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|tasksMax
|integer
|The maximum number of tasks for the Kafka Connector.
|pause
|boolean
|**The `pause` property has been deprecated.** Deprecated in Strimzi 0.38.0, use state instead. Whether the connector should be paused. Defaults to false.
|config
|map
|The Kafka Connector configuration. The following properties cannot be set: name, connector.class, tasks.max.
|state
|string (one of [running, paused, stopped])
|The state the connector should be in. Defaults to running.
|autoRestart
|xref:type-AutoRestart-{context}[`AutoRestart`]
|Automatic restart of connector and tasks configuration.
|listOffsets
|xref:type-ListOffsets-{context}[`ListOffsets`]
|Configuration for listing offsets.
|alterOffsets
|xref:type-AlterOffsets-{context}[`AlterOffsets`]
|Configuration for altering offsets.
|====

[id='type-KafkaMirrorMaker2Status-{context}']
= `KafkaMirrorMaker2Status` schema reference

Used in: xref:type-KafkaMirrorMaker2-{context}[`KafkaMirrorMaker2`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|url
|string
|The URL of the REST API endpoint for managing and monitoring Kafka Connect connectors.
|connectors
|map array
|List of MirrorMaker 2 connector statuses, as reported by the Kafka Connect REST API.
|autoRestartStatuses
|xref:type-AutoRestartStatus-{context}[`AutoRestartStatus`] array
|List of MirrorMaker 2 connector auto restart statuses.
|connectorPlugins
|xref:type-ConnectorPlugin-{context}[`ConnectorPlugin`] array
|The list of connector plugins available in this Kafka Connect deployment.
|labelSelector
|string
|Label selector for pods providing this resource.
|replicas
|integer
|The current number of pods being used to provide this resource.
|====

[id='type-KafkaRebalance-{context}']
= `KafkaRebalance` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaRebalanceSpec-{context}[`KafkaRebalanceSpec`]
|The specification of the Kafka rebalance.
|status
|xref:type-KafkaRebalanceStatus-{context}[`KafkaRebalanceStatus`]
|The status of the Kafka rebalance.
|====

[id='type-KafkaRebalanceSpec-{context}']
= `KafkaRebalanceSpec` schema reference

Used in: xref:type-KafkaRebalance-{context}[`KafkaRebalance`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|mode
|string (one of [remove-disks, remove-brokers, full, add-brokers])
|Mode to run the rebalancing. The supported modes are `full`, `add-brokers`, `remove-brokers`.
If not specified, the `full` mode is used by default. 

* `full` mode runs the rebalancing across all the brokers in the cluster.
* `add-brokers` mode can be used after scaling up the cluster to move some replicas to the newly added brokers.
* `remove-brokers` mode can be used before scaling down the cluster to move replicas out of the brokers to be removed.
* `remove-disks` mode can be used to move data across the volumes within the same broker
.
|brokers
|integer array
|The list of newly added brokers in case of scaling up or the ones to be removed in case of scaling down to use for rebalancing. This list can be used only with rebalancing mode `add-brokers` and `removed-brokers`. It is ignored with `full` mode.
|goals
|string array
|A list of goals, ordered by decreasing priority, to use for generating and executing the rebalance proposal. The supported goals are available at https://github.com/linkedin/cruise-control#goals. If an empty goals list is provided, the goals declared in the default.goals Cruise Control configuration parameter are used.
|skipHardGoalCheck
|boolean
|Whether to allow the hard goals specified in the Kafka CR to be skipped in optimization proposal generation. This can be useful when some of those hard goals are preventing a balance solution being found. Default is false.
|rebalanceDisk
|boolean
|Enables intra-broker disk balancing, which balances disk space utilization between disks on the same broker. Only applies to Kafka deployments that use JBOD storage with multiple disks. When enabled, inter-broker balancing is disabled. Default is false.
|excludedTopics
|string
|A regular expression where any matching topics will be excluded from the calculation of optimization proposals. This expression will be parsed by the java.util.regex.Pattern class; for more information on the supported format consult the documentation for that class.
|concurrentPartitionMovementsPerBroker
|integer
|The upper bound of ongoing partition replica movements going into/out of each broker. Default is 5.
|concurrentIntraBrokerPartitionMovements
|integer
|The upper bound of ongoing partition replica movements between disks within each broker. Default is 2.
|concurrentLeaderMovements
|integer
|The upper bound of ongoing partition leadership movements. Default is 1000.
|replicationThrottle
|integer
|The upper bound, in bytes per second, on the bandwidth used to move replicas. There is no limit by default.
|replicaMovementStrategies
|string array
|A list of strategy class names used to determine the execution order for the replica movements in the generated optimization proposal. By default BaseReplicaMovementStrategy is used, which will execute the replica movements in the order that they were generated.
|moveReplicasOffVolumes
|xref:type-BrokerAndVolumeIds-{context}[`BrokerAndVolumeIds`] array
|List of brokers and their corresponding volumes from which replicas need to be moved.
|====

[id='type-BrokerAndVolumeIds-{context}']
= `BrokerAndVolumeIds` schema reference

Used in: xref:type-KafkaRebalanceSpec-{context}[`KafkaRebalanceSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|brokerId
|integer
|ID of the broker that contains the disk from which you want to move the partition replicas.
|volumeIds
|integer array
|IDs of the disks from which the partition replicas need to be moved.
|====

[id='type-KafkaRebalanceStatus-{context}']
= `KafkaRebalanceStatus` schema reference

Used in: xref:type-KafkaRebalance-{context}[`KafkaRebalance`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|sessionId
|string
|The session identifier for requests to Cruise Control pertaining to this KafkaRebalance resource. This is used by the Kafka Rebalance operator to track the status of ongoing rebalancing operations.
|progress
|xref:type-KafkaRebalanceProgress-{context}[`KafkaRebalanceProgress`]
|A reference to Config Map with the progress information.
|optimizationResult
|map
|A JSON object describing the optimization result.
|====

[id='type-KafkaRebalanceProgress-{context}']
= `KafkaRebalanceProgress` schema reference

Used in: xref:type-KafkaRebalanceStatus-{context}[`KafkaRebalanceStatus`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|rebalanceProgressConfigMap
|string
|The name of the `ConfigMap` containing information related to the progress of a partition rebalance.
|====

[id='type-KafkaNodePool-{context}']
= `KafkaNodePool` schema reference


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-KafkaNodePoolSpec-{context}[`KafkaNodePoolSpec`]
|The specification of the KafkaNodePool.
|status
|xref:type-KafkaNodePoolStatus-{context}[`KafkaNodePoolStatus`]
|The status of the KafkaNodePool.
|====

[id='type-KafkaNodePoolSpec-{context}']
= `KafkaNodePoolSpec` schema reference

Used in: xref:type-KafkaNodePool-{context}[`KafkaNodePool`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|replicas
|integer
|The number of pods in the pool.
|storage
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`], xref:type-JbodStorage-{context}[`JbodStorage`]
|Storage configuration (disk). Cannot be updated.
|roles
|string (one or more of [controller, broker]) array
|The roles assigned to the node pool. Supported values are `broker` and `controller`. This property is required.
|resources
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core[ResourceRequirements]
|CPU and memory resources to reserve.
|jvmOptions
|xref:type-JvmOptions-{context}[`JvmOptions`]
|JVM Options for pods.
|template
|xref:type-KafkaNodePoolTemplate-{context}[`KafkaNodePoolTemplate`]
|Template for pool resources. The template allows users to specify how the resources belonging to this pool are generated.
|====

[id='type-KafkaNodePoolTemplate-{context}']
= `KafkaNodePoolTemplate` schema reference

Used in: xref:type-KafkaNodePoolSpec-{context}[`KafkaNodePoolSpec`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|podSet
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka `StrimziPodSet` resource.
|pod
|xref:type-PodTemplate-{context}[`PodTemplate`]
|Template for Kafka `Pods`.
|perPodService
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka per-pod `Services` used for access from outside of Kubernetes.
|perPodRoute
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka per-pod `Routes` used for access from outside of OpenShift.
|perPodIngress
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for Kafka per-pod `Ingress` used for access from outside of Kubernetes.
|persistentVolumeClaim
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|Template for all Kafka `PersistentVolumeClaims`.
|kafkaContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka broker container.
|initContainer
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|Template for the Kafka init container.
|====

[id='type-KafkaNodePoolStatus-{context}']
= `KafkaNodePoolStatus` schema reference

Used in: xref:type-KafkaNodePool-{context}[`KafkaNodePool`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|nodeIds
|integer array
|Node IDs used by Kafka nodes in this pool.
|clusterId
|string
|Kafka cluster ID.
|roles
|string (one or more of [controller, broker]) array
|Added in Strimzi 0.39.0. The roles currently assigned to this pool.
|replicas
|integer
|The current number of pods being used to provide this resource.
|labelSelector
|string
|Label selector for pods providing this resource.
|====

[id='type-StrimziPodSet-{context}']
= `StrimziPodSet` schema reference

xref:type-StrimziPodSet-schema-{context}[Full list of `StrimziPodSet` schema properties]

include::../api/io.strimzi.api.kafka.model.podset.StrimziPodSet.adoc[leveloffset=+1]

[id='type-StrimziPodSet-schema-{context}']
== `StrimziPodSet` schema properties


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|spec
|xref:type-StrimziPodSetSpec-{context}[`StrimziPodSetSpec`]
|The specification of the StrimziPodSet.
|status
|xref:type-StrimziPodSetStatus-{context}[`StrimziPodSetStatus`]
|The status of the StrimziPodSet.
|====

[id='type-StrimziPodSetSpec-{context}']
= `StrimziPodSetSpec` schema reference

Used in: xref:type-StrimziPodSet-{context}[`StrimziPodSet`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|selector
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#labelselector-v1-meta[LabelSelector]
|Selector is a label query which matches all the pods managed by this `StrimziPodSet`. Only `matchLabels` is supported. If `matchExpressions` is set, it will be ignored.
|pods
|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#pods-v1-core[Map] array
|The Pods managed by this StrimziPodSet.
|====

[id='type-StrimziPodSetStatus-{context}']
= `StrimziPodSetStatus` schema reference

Used in: xref:type-StrimziPodSet-{context}[`StrimziPodSet`]


[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|conditions
|xref:type-Condition-{context}[`Condition`] array
|List of status conditions.
|observedGeneration
|integer
|The generation of the CRD that was last reconciled by the operator.
|pods
|integer
|Number of pods managed by this `StrimziPodSet` resource.
|readyPods
|integer
|Number of pods managed by this `StrimziPodSet` resource that are ready.
|currentPods
|integer
|Number of pods managed by this `StrimziPodSet` resource that have the current revision.
|====

