// 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


[options="header"]
|====
|Property       |Description
|spec    1.2+<.<a|The specification of the Kafka and ZooKeeper clusters, and Topic Operator.
|xref:type-KafkaSpec-{context}[`KafkaSpec`]
|status  1.2+<.<a|The status of the Kafka and ZooKeeper clusters, and Topic Operator.
|xref:type-KafkaStatus-{context}[`KafkaStatus`]
|====

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

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


[options="header"]
|====
|Property                       |Description
|kafka                   1.2+<.<a|Configuration of the Kafka cluster.
|xref:type-KafkaClusterSpec-{context}[`KafkaClusterSpec`]
|zookeeper               1.2+<.<a|Configuration of the ZooKeeper cluster.
|xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]
|entityOperator          1.2+<.<a|Configuration of the Entity Operator.
|xref:type-EntityOperatorSpec-{context}[`EntityOperatorSpec`]
|clusterCa               1.2+<.<a|Configuration of the cluster certificate authority.
|xref:type-CertificateAuthority-{context}[`CertificateAuthority`]
|clientsCa               1.2+<.<a|Configuration of the clients certificate authority.
|xref:type-CertificateAuthority-{context}[`CertificateAuthority`]
|cruiseControl           1.2+<.<a|Configuration for Cruise Control deployment. Deploys a Cruise Control instance when specified.
|xref:type-CruiseControlSpec-{context}[`CruiseControlSpec`]
|jmxTrans                1.2+<.<a|**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.
|xref:type-JmxTransSpec-{context}[`JmxTransSpec`]
|kafkaExporter           1.2+<.<a|Configuration of the Kafka Exporter. Kafka Exporter can provide additional metrics, for example lag of consumer group at topic/partition.
|xref:type-KafkaExporterSpec-{context}[`KafkaExporterSpec`]
|maintenanceTimeWindows  1.2+<.<a|A list of time windows for maintenance tasks (that is, certificates renewal). Each time window is defined by a cron expression.
|string array
|====

[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.KafkaClusterSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                    |Description
|version              1.2+<.<a|The kafka broker version. Defaults to {DefaultKafkaVersion}. Consult the user documentation to understand the process required to upgrade or downgrade the version.
|string
|replicas             1.2+<.<a|The number of pods in the cluster.
|integer
|image                1.2+<.<a|The docker image for the pods. The default value depends on the configured `Kafka.spec.kafka.version`.
|string
|listeners            1.2+<.<a|Configures listeners of Kafka brokers.
|xref:type-GenericKafkaListener-{context}[`GenericKafkaListener`] array
|config               1.2+<.<a|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. (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,controller.quorum.election.backoff.max.ms, controller.quorum.election.timeout.ms, controller.quorum.fetch.timeout.ms).
|map
|storage              1.2+<.<a|Storage configuration (disk). Cannot be updated. The type depends on the value of the `storage.type` property within the given object, which must be one of [ephemeral, persistent-claim, jbod].
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`], xref:type-JbodStorage-{context}[`JbodStorage`]
|authorization        1.2+<.<a|Authorization configuration for Kafka brokers. The type depends on the value of the `authorization.type` property within the given object, which must be one of [simple, opa, keycloak, custom].
|xref:type-KafkaAuthorizationSimple-{context}[`KafkaAuthorizationSimple`], xref:type-KafkaAuthorizationOpa-{context}[`KafkaAuthorizationOpa`], xref:type-KafkaAuthorizationKeycloak-{context}[`KafkaAuthorizationKeycloak`], xref:type-KafkaAuthorizationCustom-{context}[`KafkaAuthorizationCustom`]
|rack                 1.2+<.<a|Configuration of the `broker.rack` broker config.
|xref:type-Rack-{context}[`Rack`]
|brokerRackInitImage  1.2+<.<a|The image of the init container used for initializing the `broker.rack`.
|string
|livenessProbe        1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe       1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|jvmOptions           1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|jmxOptions           1.2+<.<a|JMX Options for Kafka brokers.
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|resources            1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|metricsConfig        1.2+<.<a|Metrics configuration. The type depends on the value of the `metricsConfig.type` property within the given object, which must be one of [jmxPrometheusExporter].
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`]
|logging              1.2+<.<a|Logging configuration for Kafka. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|template             1.2+<.<a|Template for Kafka cluster resources. The template allows users to specify how the Kubernetes resources are generated.
|xref:type-KafkaClusterTemplate-{context}[`KafkaClusterTemplate`]
|====

[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.listener.arraylistener.GenericKafkaListener.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                   |Description
|name                1.2+<.<a|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.
|string
|port                1.2+<.<a|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.
|integer
|type                1.2+<.<a|Type of the listener. Currently the supported types are `internal`, `route`, `loadbalancer`, `nodeport` and `ingress`. 

* `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.

|string (one of [ingress, internal, route, loadbalancer, cluster-ip, nodeport])
|tls                 1.2+<.<a|Enables TLS encryption on the listener. This is a required property.
|boolean
|authentication      1.2+<.<a|Authentication configuration for this listener. The type depends on the value of the `authentication.type` property within the given object, which must be one of [tls, scram-sha-512, oauth, custom].
|xref:type-KafkaListenerAuthenticationTls-{context}[`KafkaListenerAuthenticationTls`], xref:type-KafkaListenerAuthenticationScramSha512-{context}[`KafkaListenerAuthenticationScramSha512`], xref:type-KafkaListenerAuthenticationOAuth-{context}[`KafkaListenerAuthenticationOAuth`], xref:type-KafkaListenerAuthenticationCustom-{context}[`KafkaListenerAuthenticationCustom`]
|configuration       1.2+<.<a|Additional listener configuration.
|xref:type-GenericKafkaListenerConfiguration-{context}[`GenericKafkaListenerConfiguration`]
|networkPolicyPeers  1.2+<.<a|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. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#networkpolicypeer-v1-networking-k8s-io[external documentation for networking.k8s.io/v1 networkpolicypeer].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#networkpolicypeer-v1-networking-k8s-io[NetworkPolicyPeer] array
|====

[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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `tls`.
|string
|====

[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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `scram-sha-512`.
|string
|====

[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`.
[options="header"]
|====
|Property                                  |Description
|accessTokenIsJwt                   1.2+<.<a|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`.
|boolean
|checkAccessTokenType               1.2+<.<a|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`.
|boolean
|checkAudience                      1.2+<.<a|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`.
|boolean
|checkIssuer                        1.2+<.<a|Enable or disable issuer checking. By default issuer is checked using the value configured by `validIssuerUri`. Default value is `true`.
|boolean
|clientAudience                     1.2+<.<a|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.
|string
|clientId                           1.2+<.<a|OAuth Client ID which the Kafka broker can use to authenticate against the authorization server and use the introspect endpoint URI.
|string
|clientScope                        1.2+<.<a|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.
|string
|clientSecret                       1.2+<.<a|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.
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|connectTimeoutSeconds              1.2+<.<a|The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
|integer
|customClaimCheck                   1.2+<.<a|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.
|string
|disableTlsHostnameVerification     1.2+<.<a|Enable or disable TLS hostname verification. Default value is `false`.
|boolean
|enableECDSA                        1.2+<.<a|**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.
|boolean
|enableMetrics                      1.2+<.<a|Enable or disable OAuth metrics. Default value is `false`.
|boolean
|enableOauthBearer                  1.2+<.<a|Enable or disable OAuth authentication over SASL_OAUTHBEARER. Default value is `true`.
|boolean
|enablePlain                        1.2+<.<a|Enable or disable OAuth authentication over SASL_PLAIN. There is no re-authentication support when this mechanism is used. Default value is `false`.
|boolean
|failFast                           1.2+<.<a|Enable or disable termination of Kafka broker processes due to potentially recoverable runtime errors during startup. Default value is `true`.
|boolean
|fallbackUserNameClaim              1.2+<.<a|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.
|string
|fallbackUserNamePrefix             1.2+<.<a|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.
|string
|groupsClaim                        1.2+<.<a|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.
|string
|groupsClaimDelimiter               1.2+<.<a|A delimiter used to parse groups when they are extracted as a single String value rather than a JSON array. Default value is ',' (comma).
|string
|httpRetries                        1.2+<.<a|The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
|integer
|httpRetryPauseMs                   1.2+<.<a|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.
|integer
|introspectionEndpointUri           1.2+<.<a|URI of the token introspection endpoint which can be used to validate opaque non-JWT tokens.
|string
|jwksEndpointUri                    1.2+<.<a|URI of the JWKS certificate endpoint, which can be used for local JWT validation.
|string
|jwksExpirySeconds                  1.2+<.<a|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.
|integer
|jwksIgnoreKeyUse                   1.2+<.<a|Flag to ignore the 'use' attribute of `key` declarations in a JWKS endpoint response. Default value is `false`.
|boolean
|jwksMinRefreshPauseSeconds         1.2+<.<a|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.
|integer
|jwksRefreshSeconds                 1.2+<.<a|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.
|integer
|maxSecondsWithoutReauthentication  1.2+<.<a|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`).
|integer
|readTimeoutSeconds                 1.2+<.<a|The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
|integer
|tlsTrustedCertificates             1.2+<.<a|Trusted certificates for TLS connection to the OAuth server.
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|tokenEndpointUri                   1.2+<.<a|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).
|string
|type                               1.2+<.<a|Must be `oauth`.
|string
|userInfoEndpointUri                1.2+<.<a|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. 
|string
|userNameClaim                      1.2+<.<a|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`.
|string
|validIssuerUri                     1.2+<.<a|URI of the token issuer used for authentication.
|string
|validTokenType                     1.2+<.<a|Valid value for the `token_type` attribute returned by the Introspection Endpoint. No default value, and not checked by default.
|string
|====

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

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


[options="header"]
|====
|Property           |Description
|key         1.2+<.<a|The key under which the secret value is stored in the Kubernetes Secret.
|string
|secretName  1.2+<.<a|The name of the Kubernetes Secret containing the secret value.
|string
|====

[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`]


[options="header"]
|====
|Property            |Description
|certificate  1.2+<.<a|The name of the file certificate in the Secret.
|string
|secretName   1.2+<.<a|The name of the Secret containing the certificate.
|string
|====

[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.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`.
[options="header"]
|====
|Property               |Description
|listenerConfig  1.2+<.<a|Configuration to be used for a specific listener. All values are prefixed with listener.name._<listener_name>_.
|map
|sasl            1.2+<.<a|Enable or disable SASL on this listener.
|boolean
|secrets         1.2+<.<a|Secrets to be mounted to /opt/kafka/custom-authn-secrets/custom-listener-_<listener_name>-<port>_/_<secret_name>_.
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`] array
|type            1.2+<.<a|Must be `custom`.
|string
|====

[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.listener.arraylistener.GenericKafkaListenerConfiguration.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                             |Description
|brokerCertChainAndKey         1.2+<.<a|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.
|xref:type-CertAndKeySecretSource-{context}[`CertAndKeySecretSource`]
|externalTrafficPolicy         1.2+<.<a|Specifies whether the service routes external traffic to node-local or cluster-wide 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 will use `Cluster` as the default.This field can be used only with `loadbalancer` or `nodeport` type listener.
|string (one of [Local, Cluster])
|loadBalancerSourceRanges      1.2+<.<a|A list of CIDR ranges (for example `10.0.0.0/8` or `130.211.204.1/32`) from which clients can connect to load balancer type 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. This field can be used only with `loadbalancer` type listener.
|string array
|bootstrap                     1.2+<.<a|Bootstrap configuration.
|xref:type-GenericKafkaListenerConfigurationBootstrap-{context}[`GenericKafkaListenerConfigurationBootstrap`]
|brokers                       1.2+<.<a|Per-broker configurations.
|xref:type-GenericKafkaListenerConfigurationBroker-{context}[`GenericKafkaListenerConfigurationBroker`] array
|ipFamilyPolicy                1.2+<.<a|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.
|string (one of [RequireDualStack, SingleStack, PreferDualStack])
|ipFamilies                    1.2+<.<a|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.
|string (one or more of [IPv6, IPv4]) array
|createBootstrapService        1.2+<.<a|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` type listener.
|boolean
|class                         1.2+<.<a|Configures a specific class for `Ingress` and `LoadBalancer` that defines which controller will be used. This field can only be used with `ingress` and `loadbalancer` type listeners. If not specified, the default controller is used. For an `ingress` listener, set the `ingressClassName` property in the `Ingress` resources. For a `loadbalancer` listener, set the `loadBalancerClass` property  in the `Service` resources.
|string
|finalizers                    1.2+<.<a|A list of finalizers which will be 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. This field can be used only with `loadbalancer` type listeners.
|string array
|maxConnectionCreationRate     1.2+<.<a|The maximum connection creation rate we allow in this listener at any time. New connections will be throttled if the limit is reached.
|integer
|maxConnections                1.2+<.<a|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.
|integer
|preferredNodePortAddressType  1.2+<.<a|Defines which address type should be used as the node address. Available types are: `ExternalDNS`, `ExternalIP`, `InternalDNS`, `InternalIP` and `Hostname`. By default, the addresses will be used in the following order (the first one found will be used):

* `ExternalDNS`
* `ExternalIP`
* `InternalDNS`
* `InternalIP`
* `Hostname`

This field 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. This field can only be used with `nodeport` type listener.
|string (one of [ExternalDNS, ExternalIP, Hostname, InternalIP, InternalDNS])
|useServiceDnsDomain           1.2+<.<a|Configures whether the Kubernetes service DNS domain should be used or not. If set to `true`, the generated addresses will contain the service DNS domain suffix (by default `.cluster.local`, can be configured using environment variable `KUBERNETES_SERVICE_DNS_DOMAIN`). Defaults to `false`.This field can be used only with `internal` and `cluster-ip` type listeners.
|boolean
|====

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

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


[options="header"]
|====
|Property            |Description
|certificate  1.2+<.<a|The name of the file certificate in the Secret.
|string
|key          1.2+<.<a|The name of the private key in the Secret.
|string
|secretName   1.2+<.<a|The name of the Secret containing the certificate.
|string
|====

[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.listener.arraylistener.GenericKafkaListenerConfigurationBootstrap.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                 |Description
|alternativeNames  1.2+<.<a|Additional alternative names for the bootstrap service. The alternative names will be added to the list of subject alternative names of the TLS certificates.
|string array
|host              1.2+<.<a|The bootstrap 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.
|string
|nodePort          1.2+<.<a|Node port for the bootstrap service. This field can be used only with `nodeport` type listener.
|integer
|loadBalancerIP    1.2+<.<a|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.
|string
|annotations       1.2+<.<a|Annotations that will be added to the `Ingress`, `Route`, 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`, `route`, or `ingress` type listeners.
|map
|labels            1.2+<.<a|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.
|map
|====

[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.listener.arraylistener.GenericKafkaListenerConfigurationBroker.adoc[leveloffset=+1]

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


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

[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`.
[options="header"]
|====
|Property          |Description
|id         1.2+<.<a|Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.
|integer
|sizeLimit  1.2+<.<a|When type=ephemeral, defines the total amount of local storage required for this EmptyDir volume (for example 1Gi).
|string
|type       1.2+<.<a|Must be `ephemeral`.
|string
|====

[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`.
[options="header"]
|====
|Property            |Description
|type         1.2+<.<a|Must be `persistent-claim`.
|string
|size         1.2+<.<a|When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim.
|string
|selector     1.2+<.<a|Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
|map
|deleteClaim  1.2+<.<a|Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
|boolean
|class        1.2+<.<a|The storage class to use for dynamic volume allocation.
|string
|id           1.2+<.<a|Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.
|integer
|overrides    1.2+<.<a|Overrides for individual brokers. The `overrides` field allows to specify a different configuration for different brokers.
|xref:type-PersistentClaimStorageOverride-{context}[`PersistentClaimStorageOverride`] array
|====

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

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


[options="header"]
|====
|Property       |Description
|class   1.2+<.<a|The storage class to use for dynamic volume allocation for this broker.
|string
|broker  1.2+<.<a|Id of the kafka broker (broker identifier).
|integer
|====

[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`.
[options="header"]
|====
|Property        |Description
|type     1.2+<.<a|Must be `jbod`.
|string
|volumes  1.2+<.<a|List of volumes as Storage objects representing the JBOD disks array.
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`] 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.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`.
[options="header"]
|====
|Property           |Description
|type        1.2+<.<a|Must be `simple`.
|string
|superUsers  1.2+<.<a|List of super users. Should contain list of user principals which should get unlimited access rights.
|string array
|====

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

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.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`.
[options="header"]
|====
|Property                       |Description
|type                    1.2+<.<a|Must be `opa`.
|string
|url                     1.2+<.<a|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.
|string
|allowOnError            1.2+<.<a|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.
|boolean
|initialCacheCapacity    1.2+<.<a|Initial capacity of the local cache used by the authorizer to avoid querying the Open Policy Agent for every request Defaults to `5000`.
|integer
|maximumCacheSize        1.2+<.<a|Maximum capacity of the local cache used by the authorizer to avoid querying the Open Policy Agent for every request. Defaults to `50000`.
|integer
|expireAfterMs           1.2+<.<a|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`.
|integer
|tlsTrustedCertificates  1.2+<.<a|Trusted certificates for TLS connection to the OPA server.
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|superUsers              1.2+<.<a|List of super users, which is specifically a list of user principals that have unlimited access rights.
|string array
|enableMetrics           1.2+<.<a|Defines whether the Open Policy Agent authorizer plugin should provide metrics. Defaults to `false`.
|boolean
|====

[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`.
[options="header"]
|====
|Property                               |Description
|type                            1.2+<.<a|Must be `keycloak`.
|string
|clientId                        1.2+<.<a|OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
|string
|tokenEndpointUri                1.2+<.<a|Authorization server token endpoint URI.
|string
|tlsTrustedCertificates          1.2+<.<a|Trusted certificates for TLS connection to the OAuth server.
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|disableTlsHostnameVerification  1.2+<.<a|Enable or disable TLS hostname verification. Default value is `false`.
|boolean
|delegateToKafkaAcls             1.2+<.<a|Whether authorization decision should be delegated to the 'Simple' authorizer if DENIED by Keycloak Authorization Services policies. Default value is `false`.
|boolean
|grantsRefreshPeriodSeconds      1.2+<.<a|The time between two consecutive grants refresh runs in seconds. The default value is 60.
|integer
|grantsRefreshPoolSize           1.2+<.<a|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.
|integer
|grantsGcPeriodSeconds           1.2+<.<a|The time, in seconds, between consecutive runs of a job that cleans stale grants from the cache. The default value is 300.
|integer
|grantsAlwaysLatest              1.2+<.<a|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`.
|boolean
|superUsers                      1.2+<.<a|List of super users. Should contain list of user principals which should get unlimited access rights.
|string array
|connectTimeoutSeconds           1.2+<.<a|The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
|integer
|readTimeoutSeconds              1.2+<.<a|The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
|integer
|httpRetries                     1.2+<.<a|The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
|integer
|enableMetrics                   1.2+<.<a|Enable or disable OAuth metrics. The default value is `false`.
|boolean
|grantsMaxIdleTimeSeconds        1.2+<.<a|The time, in seconds, after which an idle grant can be evicted from the cache. The default value is 300.
|integer
|====

[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.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`.
[options="header"]
|====
|Property                 |Description
|type              1.2+<.<a|Must be `custom`.
|string
|authorizerClass   1.2+<.<a|Authorization implementation class, which must be available in classpath.
|string
|superUsers        1.2+<.<a|List of super users, which are user principals with unlimited access rights.
|string array
|supportsAdminApi  1.2+<.<a|Indicates whether the custom authorizer supports the APIs for managing ACLs using the Kafka Admin API. Defaults to `false`.
|boolean
|====

[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.Rack.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property            |Description
|topologyKey  1.2+<.<a|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.
|string
|====

[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-KafkaMirrorMakerSpec-{context}[`KafkaMirrorMakerSpec`], xref:type-TlsSidecar-{context}[`TlsSidecar`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


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

[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-KafkaMirrorMakerSpec-{context}[`KafkaMirrorMakerSpec`], xref:type-KafkaNodePoolSpec-{context}[`KafkaNodePoolSpec`], xref:type-ZookeeperClusterSpec-{context}[`ZookeeperClusterSpec`]


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

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

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


[options="header"]
|====
|Property      |Description
|name   1.2+<.<a|The system property name.
|string
|value  1.2+<.<a|The system property value.
|string
|====

[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.KafkaJmxOptions.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property               |Description
|authentication  1.2+<.<a|Authentication configuration for connecting to the JMX port. The type depends on the value of the `authentication.type` property within the given object, which must be one of [password].
|xref:type-KafkaJmxAuthenticationPassword-{context}[`KafkaJmxAuthenticationPassword`]
|====

[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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `password`.
|string
|====

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

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


The `type` property is a discriminator that distinguishes use of the `JmxPrometheusExporterMetrics` type from other subtypes which may be added in the future.
It must have the value `jmxPrometheusExporter` for the type `JmxPrometheusExporterMetrics`.
[options="header"]
|====
|Property          |Description
|type       1.2+<.<a|Must be `jmxPrometheusExporter`.
|string
|valueFrom  1.2+<.<a|ConfigMap entry where the Prometheus JMX Exporter configuration is stored. For details of the structure of this configuration, see the {JMXExporter}.
|xref:type-ExternalConfigurationReference-{context}[`ExternalConfigurationReference`]
|====

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

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


[options="header"]
|====
|Property                |Description
|configMapKeyRef  1.2+<.<a|Reference to the key in the ConfigMap containing the configuration. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapkeyselector-v1-core[external documentation for core/v1 configmapkeyselector].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapkeyselector-v1-core[ConfigMapKeySelector]
|====

[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-KafkaMirrorMakerSpec-{context}[`KafkaMirrorMakerSpec`], 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`.
[options="header"]
|====
|Property        |Description
|type     1.2+<.<a|Must be `inline`.
|string
|loggers  1.2+<.<a|A Map from logger name to logger level.
|map
|====

[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-KafkaMirrorMakerSpec-{context}[`KafkaMirrorMakerSpec`], 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`.
[options="header"]
|====
|Property          |Description
|type       1.2+<.<a|Must be `external`.
|string
|valueFrom  1.2+<.<a|`ConfigMap` entry where the logging configuration is stored. 
|xref:type-ExternalConfigurationReference-{context}[`ExternalConfigurationReference`]
|====

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

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


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

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

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


[options="header"]
|====
|Property                    |Description
|metadata             1.2+<.<a|Metadata applied to the resource.
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|podManagementPolicy  1.2+<.<a|PodManagementPolicy which will be used for this StatefulSet. Valid values are `Parallel` and `OrderedReady`. Defaults to `Parallel`.
|string (one of [OrderedReady, 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.template.MetadataTemplate.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property            |Description
|labels       1.2+<.<a|Labels added to the Kubernetes resource.
|map
|annotations  1.2+<.<a|Annotations added to the Kubernetes resource.
|map
|====

[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-KafkaMirrorMakerTemplate-{context}[`KafkaMirrorMakerTemplate`], 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.template.PodTemplate.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                              |Description
|metadata                       1.2+<.<a|Metadata applied to the resource.
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|imagePullSecrets               1.2+<.<a|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. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#localobjectreference-v1-core[external documentation for core/v1 localobjectreference].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#localobjectreference-v1-core[LocalObjectReference] array
|securityContext                1.2+<.<a|Configures pod-level security attributes and common container settings. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#podsecuritycontext-v1-core[external documentation for core/v1 podsecuritycontext].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#podsecuritycontext-v1-core[PodSecurityContext]
|terminationGracePeriodSeconds  1.2+<.<a|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.
|integer
|affinity                       1.2+<.<a|The pod's affinity rules. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#affinity-v1-core[external documentation for core/v1 affinity].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#affinity-v1-core[Affinity]
|tolerations                    1.2+<.<a|The pod's tolerations. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#toleration-v1-core[external documentation for core/v1 toleration].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#toleration-v1-core[Toleration] array
|priorityClassName              1.2+<.<a|The name of the priority class used to assign priority to the pods. For more information about priority classes, see {K8sPriorityClass}.
|string
|schedulerName                  1.2+<.<a|The name of the scheduler used to dispatch this `Pod`. If not specified, the default scheduler will be used.
|string
|hostAliases                    1.2+<.<a|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. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#hostalias-v1-core[external documentation for core/v1 hostalias].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#hostalias-v1-core[HostAlias] array
|tmpDirSizeLimit                1.2+<.<a|Defines the total amount (for example `1Gi`) of local storage required for temporary EmptyDir volume (`/tmp`). Default value is `5Mi`.
|string
|enableServiceLinks             1.2+<.<a|Indicates whether information about services should be injected into Pod's environment variables.
|boolean
|topologySpreadConstraints      1.2+<.<a|The pod's topology spread constraints. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#topologyspreadconstraint-v1-core[external documentation for core/v1 topologyspreadconstraint].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#topologyspreadconstraint-v1-core[TopologySpreadConstraint] array
|====

[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`]


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

[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-KafkaMirrorMakerTemplate-{context}[`KafkaMirrorMakerTemplate`], xref:type-KafkaNodePoolTemplate-{context}[`KafkaNodePoolTemplate`], xref:type-KafkaUserTemplate-{context}[`KafkaUserTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]


[options="header"]
|====
|Property         |Description
|metadata  1.2+<.<a|Metadata applied to the resource.
|xref:type-MetadataTemplate-{context}[`MetadataTemplate`]
|====

[id='type-PodDisruptionBudgetTemplate-{context}']
= `PodDisruptionBudgetTemplate` 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-KafkaMirrorMakerTemplate-{context}[`KafkaMirrorMakerTemplate`], xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]

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

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

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


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

[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-KafkaMirrorMakerTemplate-{context}[`KafkaMirrorMakerTemplate`], 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.template.ContainerTemplate.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                |Description
|env              1.2+<.<a|Environment variables which should be applied to the container.
|xref:type-ContainerEnvVar-{context}[`ContainerEnvVar`] array
|securityContext  1.2+<.<a|Security context for the container. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#securitycontext-v1-core[external documentation for core/v1 securitycontext].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#securitycontext-v1-core[SecurityContext]
|====

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

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


[options="header"]
|====
|Property      |Description
|name   1.2+<.<a|The environment variable key.
|string
|value  1.2+<.<a|The environment variable value.
|string
|====

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

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

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

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

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


[options="header"]
|====
|Property               |Description
|replicas        1.2+<.<a|The number of pods in the cluster.
|integer
|image           1.2+<.<a|The docker image for the pods.
|string
|storage         1.2+<.<a|Storage configuration (disk). Cannot be updated. The type depends on the value of the `storage.type` property within the given object, which must be one of [ephemeral, persistent-claim].
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`]
|config          1.2+<.<a|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).
|map
|livenessProbe   1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe  1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|jvmOptions      1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|jmxOptions      1.2+<.<a|JMX Options for Zookeeper nodes.
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|resources       1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|metricsConfig   1.2+<.<a|Metrics configuration. The type depends on the value of the `metricsConfig.type` property within the given object, which must be one of [jmxPrometheusExporter].
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`]
|logging         1.2+<.<a|Logging configuration for ZooKeeper. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|template        1.2+<.<a|Template for ZooKeeper cluster resources. The template allows users to specify how the Kubernetes resources are generated.
|xref:type-ZookeeperClusterTemplate-{context}[`ZookeeperClusterTemplate`]
|====

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

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


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

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

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


[options="header"]
|====
|Property              |Description
|topicOperator  1.2+<.<a|Configuration of the Topic Operator.
|xref:type-EntityTopicOperatorSpec-{context}[`EntityTopicOperatorSpec`]
|userOperator   1.2+<.<a|Configuration of the User Operator.
|xref:type-EntityUserOperatorSpec-{context}[`EntityUserOperatorSpec`]
|tlsSidecar     1.2+<.<a|TLS sidecar configuration.
|xref:type-TlsSidecar-{context}[`TlsSidecar`]
|template       1.2+<.<a|Template for Entity Operator resources. The template allows users to specify how a `Deployment` and `Pod` is generated.
|xref:type-EntityOperatorTemplate-{context}[`EntityOperatorTemplate`]
|====

[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.EntityTopicOperatorSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                               |Description
|watchedNamespace                1.2+<.<a|The namespace the Topic Operator should watch.
|string
|image                           1.2+<.<a|The image to use for the Topic Operator.
|string
|reconciliationIntervalSeconds   1.2+<.<a|Interval between periodic reconciliations.
|integer
|zookeeperSessionTimeoutSeconds  1.2+<.<a|Timeout for the ZooKeeper session.
|integer
|startupProbe                    1.2+<.<a|Pod startup checking.
|xref:type-Probe-{context}[`Probe`]
|livenessProbe                   1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe                  1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|resources                       1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|topicMetadataMaxAttempts        1.2+<.<a|The number of attempts at getting topic metadata.
|integer
|logging                         1.2+<.<a|Logging configuration. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|jvmOptions                      1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|====

[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.EntityUserOperatorSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                               |Description
|watchedNamespace                1.2+<.<a|The namespace the User Operator should watch.
|string
|image                           1.2+<.<a|The image to use for the User Operator.
|string
|reconciliationIntervalSeconds   1.2+<.<a|Interval between periodic reconciliations.
|integer
|zookeeperSessionTimeoutSeconds  1.2+<.<a|**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.
|integer
|secretPrefix                    1.2+<.<a|The prefix that will be added to the KafkaUser name to be used as the Secret name.
|string
|livenessProbe                   1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe                  1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|resources                       1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|logging                         1.2+<.<a|Logging configuration. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|jvmOptions                      1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|====

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

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.TlsSidecar.adoc[leveloffset=+1]

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


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


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|====

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

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


[options="header"]
|====
|Property                         |Description
|deployment                1.2+<.<a|Template for Entity Operator `Deployment`.
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|pod                       1.2+<.<a|Template for Entity Operator `Pods`.
|xref:type-PodTemplate-{context}[`PodTemplate`]
|topicOperatorContainer    1.2+<.<a|Template for the Entity Topic Operator container.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|userOperatorContainer     1.2+<.<a|Template for the Entity User Operator container.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|tlsSidecarContainer       1.2+<.<a|Template for the Entity Operator TLS sidecar container.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|serviceAccount            1.2+<.<a|Template for the Entity Operator service account.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|entityOperatorRole        1.2+<.<a|Template for the Entity Operator Role.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|topicOperatorRoleBinding  1.2+<.<a|Template for the Entity Topic Operator RoleBinding.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|userOperatorRoleBinding   1.2+<.<a|Template for the Entity Topic Operator RoleBinding.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|====

[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-KafkaMirrorMakerTemplate-{context}[`KafkaMirrorMakerTemplate`]

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

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

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


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

[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`.

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

[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.CruiseControlSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property               |Description
|image           1.2+<.<a|The docker image for the pods.
|string
|tlsSidecar      1.2+<.<a|**The `tlsSidecar` property has been deprecated.** TLS sidecar configuration.
|xref:type-TlsSidecar-{context}[`TlsSidecar`]
|resources       1.2+<.<a|CPU and memory resources to reserve for the Cruise Control container. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|livenessProbe   1.2+<.<a|Pod liveness checking for the Cruise Control container.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe  1.2+<.<a|Pod readiness checking for the Cruise Control container.
|xref:type-Probe-{context}[`Probe`]
|jvmOptions      1.2+<.<a|JVM Options for the Cruise Control container.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|logging         1.2+<.<a|Logging configuration (Log4j 2) for Cruise Control. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|template        1.2+<.<a|Template to specify how Cruise Control resources, `Deployments` and `Pods`, are generated.
|xref:type-CruiseControlTemplate-{context}[`CruiseControlTemplate`]
|brokerCapacity  1.2+<.<a|The Cruise Control `brokerCapacity` configuration.
|xref:type-BrokerCapacity-{context}[`BrokerCapacity`]
|config          1.2+<.<a|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).
|map
|metricsConfig   1.2+<.<a|Metrics configuration. The type depends on the value of the `metricsConfig.type` property within the given object, which must be one of [jmxPrometheusExporter].
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`]
|====

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

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


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

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

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


[options="header"]
|====
|Property                |Description
|disk             1.2+<.<a|**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.
|string
|cpuUtilization   1.2+<.<a|**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).
|integer
|cpu              1.2+<.<a|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.
|string
|inboundNetwork   1.2+<.<a|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.
|string
|outboundNetwork  1.2+<.<a|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.
|string
|overrides        1.2+<.<a|Overrides for individual brokers. The `overrides` property lets you specify a different capacity configuration for different brokers.
|xref:type-BrokerCapacityOverride-{context}[`BrokerCapacityOverride`] array
|====

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

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


[options="header"]
|====
|Property                |Description
|brokers          1.2+<.<a|List of Kafka brokers (broker identifiers).
|integer array
|cpu              1.2+<.<a|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.
|string
|inboundNetwork   1.2+<.<a|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.
|string
|outboundNetwork  1.2+<.<a|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.
|string
|====

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

*The type `JmxTransSpec` has been deprecated.*

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


[options="header"]
|====
|Property                  |Description
|image              1.2+<.<a|The image to use for the JmxTrans.
|string
|outputDefinitions  1.2+<.<a|Defines the output hosts that will be referenced later on. For more information on these properties see, xref:type-JmxTransOutputDefinitionTemplate-reference[`JmxTransOutputDefinitionTemplate` schema reference].
|xref:type-JmxTransOutputDefinitionTemplate-{context}[`JmxTransOutputDefinitionTemplate`] array
|logLevel           1.2+<.<a|Sets the logging level of the JmxTrans deployment.For more information see, https://github.com/jmxtrans/jmxtrans-agent/wiki/Troubleshooting[JmxTrans Logging Level].
|string
|kafkaQueries       1.2+<.<a|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].
|xref:type-JmxTransQueryTemplate-{context}[`JmxTransQueryTemplate`] array
|resources          1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|template           1.2+<.<a|Template for JmxTrans resources.
|xref:type-JmxTransTemplate-{context}[`JmxTransTemplate`]
|====

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

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


[options="header"]
|====
|Property                    |Description
|outputType           1.2+<.<a|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].
|string
|host                 1.2+<.<a|The DNS/hostname of the remote host that the data is pushed to.
|string
|port                 1.2+<.<a|The port of the remote host that the data is pushed to.
|integer
|flushDelayInSeconds  1.2+<.<a|How many seconds the JmxTrans waits before pushing a new set of data out.
|integer
|typeNames            1.2+<.<a|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].
|string array
|name                 1.2+<.<a|Template for setting the name of the output definition. This is used to identify where to send the results of queries should be sent.
|string
|====

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

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


[options="header"]
|====
|Property            |Description
|targetMBean  1.2+<.<a|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.
|string
|attributes   1.2+<.<a|Determine which attributes of the targeted MBean should be included.
|string array
|outputs      1.2+<.<a|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.
|string array
|====

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

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


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

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

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


[options="header"]
|====
|Property                    |Description
|image                1.2+<.<a|The docker image for the pods.
|string
|groupRegex           1.2+<.<a|Regular expression to specify which consumer groups to collect. Default value is `.*`.
|string
|topicRegex           1.2+<.<a|Regular expression to specify which topics to collect. Default value is `.*`.
|string
|groupExcludeRegex    1.2+<.<a|Regular expression to specify which consumer groups to exclude.
|string
|topicExcludeRegex    1.2+<.<a|Regular expression to specify which topics to exclude.
|string
|resources            1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|logging              1.2+<.<a|Only log messages with the given severity or above. Valid levels: [`info`, `debug`, `trace`]. Default log level is `info`.
|string
|enableSaramaLogging  1.2+<.<a|Enable Sarama logging, a Go client library used by the Kafka Exporter.
|boolean
|template             1.2+<.<a|Customization of deployment templates and pods.
|xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`]
|livenessProbe        1.2+<.<a|Pod liveness check.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe       1.2+<.<a|Pod readiness check.
|xref:type-Probe-{context}[`Probe`]
|====

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

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


[options="header"]
|====
|Property               |Description
|deployment      1.2+<.<a|Template for Kafka Exporter `Deployment`.
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|pod             1.2+<.<a|Template for Kafka Exporter `Pods`.
|xref:type-PodTemplate-{context}[`PodTemplate`]
|service         1.2+<.<a|**The `service` property has been deprecated.** The Kafka Exporter service has been removed. Template for Kafka Exporter `Service`.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|container       1.2+<.<a|Template for the Kafka Exporter container.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|serviceAccount  1.2+<.<a|Template for the Kafka Exporter service account.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|====

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

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


[options="header"]
|====
|Property                   |Description
|conditions          1.2+<.<a|List of status conditions.
|xref:type-Condition-{context}[`Condition`] array
|observedGeneration  1.2+<.<a|The generation of the CRD that was last reconciled by the operator.
|integer
|listeners           1.2+<.<a|Addresses of the internal and external listeners.
|xref:type-ListenerStatus-{context}[`ListenerStatus`] array
|kafkaNodePools      1.2+<.<a|List of the KafkaNodePools used by this Kafka cluster.
|xref:type-UsedNodePoolStatus-{context}[`UsedNodePoolStatus`] array
|clusterId           1.2+<.<a|Kafka cluster Id.
|string
|====

[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-KafkaMirrorMakerStatus-{context}[`KafkaMirrorMakerStatus`], 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`]


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

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

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


[options="header"]
|====
|Property                 |Description
|type              1.2+<.<a|*The `type` property has been deprecated, and should now be configured using `name`.* The name of the listener.
|string
|name              1.2+<.<a|The name of the listener.
|string
|addresses         1.2+<.<a|A list of the addresses for this listener.
|xref:type-ListenerAddress-{context}[`ListenerAddress`] array
|bootstrapServers  1.2+<.<a|A comma-separated list of `host:port` pairs for connecting to the Kafka cluster using this listener.
|string
|certificates      1.2+<.<a|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.
|string array
|====

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

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


[options="header"]
|====
|Property     |Description
|host  1.2+<.<a|The DNS name or IP address of the Kafka bootstrap service.
|string
|port  1.2+<.<a|The port of the Kafka bootstrap service.
|integer
|====

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

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


[options="header"]
|====
|Property     |Description
|name  1.2+<.<a|The name of the KafkaNodePool used by this Kafka resource.
|string
|====

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


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

[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.KafkaConnectSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                      |Description
|version                1.2+<.<a|The Kafka Connect version. Defaults to {DefaultKafkaVersion}. Consult the user documentation to understand the process required to upgrade or downgrade the version.
|string
|replicas               1.2+<.<a|The number of pods in the Kafka Connect group. Defaults to `3`.
|integer
|image                  1.2+<.<a|The docker image for the pods.
|string
|bootstrapServers       1.2+<.<a|Bootstrap servers to connect to. This should be given as a comma separated list of _<hostname>_:_<port>_ pairs.
|string
|tls                    1.2+<.<a|TLS configuration.
|xref:type-ClientTls-{context}[`ClientTls`]
|authentication         1.2+<.<a|Authentication configuration for Kafka Connect. The type depends on the value of the `authentication.type` property within the given object, which must be one of [tls, scram-sha-256, scram-sha-512, plain, oauth].
|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`]
|config                 1.2+<.<a|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 (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
|map
|resources              1.2+<.<a|The maximum limits for CPU and memory resources and the requested initial resources. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|livenessProbe          1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe         1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|jvmOptions             1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|jmxOptions             1.2+<.<a|JMX Options.
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|logging                1.2+<.<a|Logging configuration for Kafka Connect. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|clientRackInitImage    1.2+<.<a|The image of the init container used for initializing the `client.rack`.
|string
|rack                   1.2+<.<a|Configuration of the node label which will be used as the `client.rack` consumer configuration.
|xref:type-Rack-{context}[`Rack`]
|tracing                1.2+<.<a|The configuration of tracing in Kafka Connect. The type depends on the value of the `tracing.type` property within the given object, which must be one of [jaeger, opentelemetry].
|xref:type-JaegerTracing-{context}[`JaegerTracing`], xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`]
|template               1.2+<.<a|Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Deployment`, `Pods` and `Service` are generated.
|xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`]
|externalConfiguration  1.2+<.<a|Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
|xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]
|build                  1.2+<.<a|Configures how the Connect container image should be built. Optional.
|xref:type-Build-{context}[`Build`]
|metricsConfig          1.2+<.<a|Metrics configuration. The type depends on the value of the `metricsConfig.type` property within the given object, which must be one of [jmxPrometheusExporter].
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`]
|====

[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-KafkaMirrorMakerConsumerSpec-{context}[`KafkaMirrorMakerConsumerSpec`], xref:type-KafkaMirrorMakerProducerSpec-{context}[`KafkaMirrorMakerProducerSpec`]

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

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

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


[options="header"]
|====
|Property                    |Description
|trustedCertificates  1.2+<.<a|Trusted certificates for TLS connection.
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|====

[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-KafkaMirrorMakerConsumerSpec-{context}[`KafkaMirrorMakerConsumerSpec`], xref:type-KafkaMirrorMakerProducerSpec-{context}[`KafkaMirrorMakerProducerSpec`]

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

include::../api/io.strimzi.api.kafka.model.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`].
It must have the value `tls` for the type `KafkaClientAuthenticationTls`.
[options="header"]
|====
|Property                  |Description
|certificateAndKey  1.2+<.<a|Reference to the `Secret` which holds the certificate and private key pair.
|xref:type-CertAndKeySecretSource-{context}[`CertAndKeySecretSource`]
|type               1.2+<.<a|Must be `tls`.
|string
|====

[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-KafkaMirrorMakerConsumerSpec-{context}[`KafkaMirrorMakerConsumerSpec`], xref:type-KafkaMirrorMakerProducerSpec-{context}[`KafkaMirrorMakerProducerSpec`]

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

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

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


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

[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`]


[options="header"]
|====
|Property           |Description
|password    1.2+<.<a|The name of the key in the Secret under which the password is stored.
|string
|secretName  1.2+<.<a|The name of the Secret containing the password.
|string
|====

[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-KafkaMirrorMakerConsumerSpec-{context}[`KafkaMirrorMakerConsumerSpec`], xref:type-KafkaMirrorMakerProducerSpec-{context}[`KafkaMirrorMakerProducerSpec`]

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

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

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


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

[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-KafkaMirrorMakerConsumerSpec-{context}[`KafkaMirrorMakerConsumerSpec`], xref:type-KafkaMirrorMakerProducerSpec-{context}[`KafkaMirrorMakerProducerSpec`]

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

include::../api/io.strimzi.api.kafka.model.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`].
It must have the value `plain` for the type `KafkaClientAuthenticationPlain`.
[options="header"]
|====
|Property               |Description
|passwordSecret  1.2+<.<a|Reference to the `Secret` which holds the password.
|xref:type-PasswordSecretSource-{context}[`PasswordSecretSource`]
|type            1.2+<.<a|Must be `plain`.
|string
|username        1.2+<.<a|Username used for the authentication.
|string
|====

[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-KafkaMirrorMakerConsumerSpec-{context}[`KafkaMirrorMakerConsumerSpec`], xref:type-KafkaMirrorMakerProducerSpec-{context}[`KafkaMirrorMakerProducerSpec`]

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

include::../api/io.strimzi.api.kafka.model.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`].
It must have the value `oauth` for the type `KafkaClientAuthenticationOAuth`.
[options="header"]
|====
|Property                               |Description
|accessToken                     1.2+<.<a|Link to Kubernetes Secret containing the access token which was obtained from the authorization server.
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|accessTokenIsJwt                1.2+<.<a|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`.
|boolean
|audience                        1.2+<.<a|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.
|string
|clientId                        1.2+<.<a|OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
|string
|clientSecret                    1.2+<.<a|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.
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|connectTimeoutSeconds           1.2+<.<a|The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
|integer
|disableTlsHostnameVerification  1.2+<.<a|Enable or disable TLS hostname verification. Default value is `false`.
|boolean
|enableMetrics                   1.2+<.<a|Enable or disable OAuth metrics. Default value is `false`.
|boolean
|httpRetries                     1.2+<.<a|The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
|integer
|httpRetryPauseMs                1.2+<.<a|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.
|integer
|maxTokenExpirySeconds           1.2+<.<a|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.
|integer
|passwordSecret                  1.2+<.<a|Reference to the `Secret` which holds the password.
|xref:type-PasswordSecretSource-{context}[`PasswordSecretSource`]
|readTimeoutSeconds              1.2+<.<a|The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
|integer
|refreshToken                    1.2+<.<a|Link to Kubernetes Secret containing the refresh token which can be used to obtain access token from the authorization server.
|xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
|scope                           1.2+<.<a|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.
|string
|tlsTrustedCertificates          1.2+<.<a|Trusted certificates for TLS connection to the OAuth server.
|xref:type-CertSecretSource-{context}[`CertSecretSource`] array
|tokenEndpointUri                1.2+<.<a|Authorization server token endpoint URI.
|string
|type                            1.2+<.<a|Must be `oauth`.
|string
|username                        1.2+<.<a|Username used for the authentication.
|string
|====

[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`], xref:type-KafkaMirrorMakerSpec-{context}[`KafkaMirrorMakerSpec`]


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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `jaeger`.
|string
|====

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

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


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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `opentelemetry`.
|string
|====

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

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


[options="header"]
|====
|Property                    |Description
|deployment           1.2+<.<a|Template for Kafka Connect `Deployment`.
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|podSet               1.2+<.<a|Template for Kafka Connect `StrimziPodSet` resource.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|pod                  1.2+<.<a|Template for Kafka Connect `Pods`.
|xref:type-PodTemplate-{context}[`PodTemplate`]
|apiService           1.2+<.<a|Template for Kafka Connect API `Service`.
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|headlessService      1.2+<.<a|Template for Kafka Connect headless `Service`.
|xref:type-InternalServiceTemplate-{context}[`InternalServiceTemplate`]
|connectContainer     1.2+<.<a|Template for the Kafka Connect container.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|initContainer        1.2+<.<a|Template for the Kafka init container.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|podDisruptionBudget  1.2+<.<a|Template for Kafka Connect `PodDisruptionBudget`.
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|serviceAccount       1.2+<.<a|Template for the Kafka Connect service account.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|clusterRoleBinding   1.2+<.<a|Template for the Kafka Connect ClusterRoleBinding.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|buildPod             1.2+<.<a|Template for Kafka Connect Build `Pods`. The build pod is used only on Kubernetes.
|xref:type-PodTemplate-{context}[`PodTemplate`]
|buildContainer       1.2+<.<a|Template for the Kafka Connect Build container. The build container is used only on Kubernetes.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|buildConfig          1.2+<.<a|Template for the Kafka Connect BuildConfig used to build new container images. The BuildConfig is used only on OpenShift.
|xref:type-BuildConfigTemplate-{context}[`BuildConfigTemplate`]
|buildServiceAccount  1.2+<.<a|Template for the Kafka Connect Build service account.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|jmxSecret            1.2+<.<a|Template for Secret of the Kafka Connect Cluster JMX authentication.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|====

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

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


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

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

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


[options="header"]
|====
|Property        |Description
|env      1.2+<.<a|Makes data from a Secret or ConfigMap available in the Kafka Connect pods as environment variables.
|xref:type-ExternalConfigurationEnv-{context}[`ExternalConfigurationEnv`] array
|volumes  1.2+<.<a|Makes data from a Secret or ConfigMap available in the Kafka Connect pods as volumes.
|xref:type-ExternalConfigurationVolumeSource-{context}[`ExternalConfigurationVolumeSource`] array
|====

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

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


[options="header"]
|====
|Property          |Description
|name       1.2+<.<a|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_`.
|string
|valueFrom  1.2+<.<a|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.
|xref:type-ExternalConfigurationEnvVarSource-{context}[`ExternalConfigurationEnvVarSource`]
|====

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

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


[options="header"]
|====
|Property                |Description
|configMapKeyRef  1.2+<.<a|Reference to a key in a ConfigMap. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapkeyselector-v1-core[external documentation for core/v1 configmapkeyselector].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapkeyselector-v1-core[ConfigMapKeySelector]
|secretKeyRef     1.2+<.<a|Reference to a key in a Secret. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#secretkeyselector-v1-core[external documentation for core/v1 secretkeyselector].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#secretkeyselector-v1-core[SecretKeySelector]
|====

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

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


[options="header"]
|====
|Property          |Description
|configMap  1.2+<.<a|Reference to a key in a ConfigMap. Exactly one Secret or ConfigMap has to be specified. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapvolumesource-v1-core[external documentation for core/v1 configmapvolumesource].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapvolumesource-v1-core[ConfigMapVolumeSource]
|name       1.2+<.<a|Name of the volume which will be added to the Kafka Connect pods.
|string
|secret     1.2+<.<a|Reference to a key in a Secret. Exactly one Secret or ConfigMap has to be specified. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#secretvolumesource-v1-core[external documentation for core/v1 secretvolumesource].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#secretvolumesource-v1-core[SecretVolumeSource]
|====

[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


[options="header"]
|====
|Property          |Description
|output     1.2+<.<a|Configures where should the newly built image be stored. Required. The type depends on the value of the `output.type` property within the given object, which must be one of [docker, imagestream].
|xref:type-DockerOutput-{context}[`DockerOutput`], xref:type-ImageStreamOutput-{context}[`ImageStreamOutput`]
|resources  1.2+<.<a|CPU and memory resources to reserve for the build. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|plugins    1.2+<.<a|List of connector plugins which should be added to the Kafka Connect. Required.
|xref:type-Plugin-{context}[`Plugin`] array
|====

[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`.
[options="header"]
|====
|Property                        |Description
|image                    1.2+<.<a|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.
|string
|pushSecret               1.2+<.<a|Container Registry Secret with the credentials for pushing the newly built image.
|string
|additionalKanikoOptions  1.2+<.<a|Configures additional options which will be passed to the Kaniko executor when building the new Connect image. Allowed options are: --customPlatform, --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. 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.
|string array
|type                     1.2+<.<a|Must be `docker`.
|string
|====

[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`.
[options="header"]
|====
|Property      |Description
|image  1.2+<.<a|The name and tag of the ImageStream where the newly built image will be pushed. For example `my-custom-connect:latest`. Required.
|string
|type   1.2+<.<a|Must be `imagestream`.
|string
|====

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

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


[options="header"]
|====
|Property          |Description
|name       1.2+<.<a|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.
|string
|artifacts  1.2+<.<a|List of artifacts which belong to this connector plugin. Required.
|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
|====

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

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


[options="header"]
|====
|Property          |Description
|url        1.2+<.<a|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.
|string
|sha512sum  1.2+<.<a|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. 
|string
|insecure   1.2+<.<a|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.
|boolean
|type       1.2+<.<a|Must be `jar`.
|string
|====

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

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


[options="header"]
|====
|Property          |Description
|url        1.2+<.<a|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.
|string
|sha512sum  1.2+<.<a|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. 
|string
|insecure   1.2+<.<a|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.
|boolean
|type       1.2+<.<a|Must be `tgz`.
|string
|====

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

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


[options="header"]
|====
|Property          |Description
|url        1.2+<.<a|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.
|string
|sha512sum  1.2+<.<a|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. 
|string
|insecure   1.2+<.<a|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.
|boolean
|type       1.2+<.<a|Must be `zip`.
|string
|====

[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`.
[options="header"]
|====
|Property           |Description
|repository  1.2+<.<a|Maven repository to download the artifact from. Applicable to the `maven` artifact type only.
|string
|group       1.2+<.<a|Maven group id. Applicable to the `maven` artifact type only.
|string
|artifact    1.2+<.<a|Maven artifact id. Applicable to the `maven` artifact type only.
|string
|version     1.2+<.<a|Maven version number. Applicable to the `maven` artifact type only.
|string
|insecure    1.2+<.<a|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.
|boolean
|type        1.2+<.<a|Must be `maven`.
|string
|====

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

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


[options="header"]
|====
|Property          |Description
|url        1.2+<.<a|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.
|string
|sha512sum  1.2+<.<a|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. 
|string
|fileName   1.2+<.<a|Name under which the artifact will be stored.
|string
|insecure   1.2+<.<a|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.
|boolean
|type       1.2+<.<a|Must be `other`.
|string
|====

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

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


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

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

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


[options="header"]
|====
|Property        |Description
|type     1.2+<.<a|The type of the connector plugin. The available types are `sink` and `source`.
|string
|version  1.2+<.<a|The version of the connector plugin.
|string
|class    1.2+<.<a|The class of the connector plugin.
|string
|====

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


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

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

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


[options="header"]
|====
|Property           |Description
|partitions  1.2+<.<a|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`.
|integer
|replicas    1.2+<.<a|The number of replicas the topic should have. When absent this will default to the broker configuration for `default.replication.factor`.
|integer
|config      1.2+<.<a|The topic configuration.
|map
|topicName   1.2+<.<a|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.
|string
|====

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

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


[options="header"]
|====
|Property                   |Description
|conditions          1.2+<.<a|List of status conditions.
|xref:type-Condition-{context}[`Condition`] array
|observedGeneration  1.2+<.<a|The generation of the CRD that was last reconciled by the operator.
|integer
|topicName           1.2+<.<a|Topic name.
|string
|====

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


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

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

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


[options="header"]
|====
|Property               |Description
|authentication  1.2+<.<a|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. The type depends on the value of the `authentication.type` property within the given object, which must be one of [tls, tls-external, scram-sha-512].
|xref:type-KafkaUserTlsClientAuthentication-{context}[`KafkaUserTlsClientAuthentication`], xref:type-KafkaUserTlsExternalClientAuthentication-{context}[`KafkaUserTlsExternalClientAuthentication`], xref:type-KafkaUserScramSha512ClientAuthentication-{context}[`KafkaUserScramSha512ClientAuthentication`]
|authorization   1.2+<.<a|Authorization rules for this Kafka user. The type depends on the value of the `authorization.type` property within the given object, which must be one of [simple].
|xref:type-KafkaUserAuthorizationSimple-{context}[`KafkaUserAuthorizationSimple`]
|quotas          1.2+<.<a|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.
|xref:type-KafkaUserQuotas-{context}[`KafkaUserQuotas`]
|template        1.2+<.<a|Template to specify how Kafka User `Secrets` are generated.
|xref:type-KafkaUserTemplate-{context}[`KafkaUserTemplate`]
|====

[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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `tls`.
|string
|====

[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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `tls-external`.
|string
|====

[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`.
[options="header"]
|====
|Property         |Description
|password  1.2+<.<a|Specify the password for the user. If not set, a new password is generated by the User Operator.
|xref:type-Password-{context}[`Password`]
|type      1.2+<.<a|Must be `scram-sha-512`.
|string
|====

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

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


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

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

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


[options="header"]
|====
|Property             |Description
|secretKeyRef  1.2+<.<a|Selects a key of a Secret in the resource's namespace. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#secretkeyselector-v1-core[external documentation for core/v1 secretkeyselector].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#secretkeyselector-v1-core[SecretKeySelector]
|====

[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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `simple`.
|string
|acls  1.2+<.<a|List of ACL rules which should be applied to this user.
|xref:type-AclRule-{context}[`AclRule`] array
|====

[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.AclRule.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property           |Description
|host        1.2+<.<a|The host from which the action described in the ACL rule is allowed or denied.
|string
|operation   1.2+<.<a|**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.
|string (one of [Read, Write, Delete, Alter, Describe, All, IdempotentWrite, ClusterAction, Create, AlterConfigs, DescribeConfigs])
|operations  1.2+<.<a|List of operations which will be allowed or denied. Supported operations are: Read, Write, Create, Delete, Alter, Describe, ClusterAction, AlterConfigs, DescribeConfigs, IdempotentWrite and All.
|string (one or more of [Read, Write, Delete, Alter, Describe, All, IdempotentWrite, ClusterAction, Create, AlterConfigs, DescribeConfigs]) array
|resource    1.2+<.<a|Indicates the resource for which given ACL rule applies. The type depends on the value of the `resource.type` property within the given object, which must be one of [topic, group, cluster, transactionalId].
|xref:type-AclRuleTopicResource-{context}[`AclRuleTopicResource`], xref:type-AclRuleGroupResource-{context}[`AclRuleGroupResource`], xref:type-AclRuleClusterResource-{context}[`AclRuleClusterResource`], xref:type-AclRuleTransactionalIdResource-{context}[`AclRuleTransactionalIdResource`]
|type        1.2+<.<a|The type of the rule. Currently the only supported type is `allow`. ACL rules with type `allow` are used to allow user to execute the specified operations. Default value is `allow`.
|string (one of [allow, deny])
|====

[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`.
[options="header"]
|====
|Property            |Description
|type         1.2+<.<a|Must be `topic`.
|string
|name         1.2+<.<a|Name of resource for which given ACL rule applies. Can be combined with `patternType` field to use prefix pattern.
|string
|patternType  1.2+<.<a|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`.
|string (one of [prefix, 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`.
[options="header"]
|====
|Property            |Description
|type         1.2+<.<a|Must be `group`.
|string
|name         1.2+<.<a|Name of resource for which given ACL rule applies. Can be combined with `patternType` field to use prefix pattern.
|string
|patternType  1.2+<.<a|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`.
|string (one of [prefix, 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`.
[options="header"]
|====
|Property     |Description
|type  1.2+<.<a|Must be `cluster`.
|string
|====

[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`.
[options="header"]
|====
|Property            |Description
|type         1.2+<.<a|Must be `transactionalId`.
|string
|name         1.2+<.<a|Name of resource for which given ACL rule applies. Can be combined with `patternType` field to use prefix pattern.
|string
|patternType  1.2+<.<a|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`.
|string (one of [prefix, 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.KafkaUserQuotas.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                       |Description
|consumerByteRate        1.2+<.<a|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.
|integer
|controllerMutationRate  1.2+<.<a|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.
|number
|producerByteRate        1.2+<.<a|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.
|integer
|requestPercentage       1.2+<.<a|A quota on the maximum CPU utilization of each client group as a percentage of network and I/O threads.
|integer
|====

[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.template.KafkaUserTemplate.adoc[leveloffset=+1]

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


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

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

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


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

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

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


[options="header"]
|====
|Property       |Description
|spec    1.2+<.<a|The specification of Kafka MirrorMaker.
|xref:type-KafkaMirrorMakerSpec-{context}[`KafkaMirrorMakerSpec`]
|status  1.2+<.<a|The status of Kafka MirrorMaker.
|xref:type-KafkaMirrorMakerStatus-{context}[`KafkaMirrorMakerStatus`]
|====

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

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

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

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

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


[options="header"]
|====
|Property               |Description
|version         1.2+<.<a|The Kafka MirrorMaker version. Defaults to {DefaultKafkaVersion}. Consult the documentation to understand the process required to upgrade or downgrade the version.
|string
|replicas        1.2+<.<a|The number of pods in the `Deployment`.
|integer
|image           1.2+<.<a|The docker image for the pods.
|string
|consumer        1.2+<.<a|Configuration of source cluster.
|xref:type-KafkaMirrorMakerConsumerSpec-{context}[`KafkaMirrorMakerConsumerSpec`]
|producer        1.2+<.<a|Configuration of target cluster.
|xref:type-KafkaMirrorMakerProducerSpec-{context}[`KafkaMirrorMakerProducerSpec`]
|resources       1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|whitelist       1.2+<.<a|**The `whitelist` property has been deprecated, and should now be configured using `spec.include`.** List of topics which are included for mirroring. This option allows any regular expression using Java-style regular expressions. Mirroring two topics named A and B is achieved by using the expression `A\|B`. Or, as a special case, you can mirror all topics using the regular expression `*`. You can also specify multiple regular expressions separated by commas.
|string
|include         1.2+<.<a|List of topics which are included for mirroring. This option allows any regular expression using Java-style regular expressions. Mirroring two topics named A and B is achieved by using the expression `A\|B`. Or, as a special case, you can mirror all topics using the regular expression `*`. You can also specify multiple regular expressions separated by commas.
|string
|jvmOptions      1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|logging         1.2+<.<a|Logging configuration for MirrorMaker. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|metricsConfig   1.2+<.<a|Metrics configuration. The type depends on the value of the `metricsConfig.type` property within the given object, which must be one of [jmxPrometheusExporter].
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`]
|tracing         1.2+<.<a|The configuration of tracing in Kafka MirrorMaker. The type depends on the value of the `tracing.type` property within the given object, which must be one of [jaeger, opentelemetry].
|xref:type-JaegerTracing-{context}[`JaegerTracing`], xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`]
|template        1.2+<.<a|Template to specify how Kafka MirrorMaker resources, `Deployments` and `Pods`, are generated.
|xref:type-KafkaMirrorMakerTemplate-{context}[`KafkaMirrorMakerTemplate`]
|livenessProbe   1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe  1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|====

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

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

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

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

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


[options="header"]
|====
|Property                     |Description
|numStreams            1.2+<.<a|Specifies the number of consumer stream threads to create.
|integer
|offsetCommitInterval  1.2+<.<a|Specifies the offset auto-commit interval in ms. Default value is 60000.
|integer
|bootstrapServers      1.2+<.<a|A list of host:port pairs for establishing the initial connection to the Kafka cluster.
|string
|groupId               1.2+<.<a|A unique string that identifies the consumer group this consumer belongs to.
|string
|authentication        1.2+<.<a|Authentication configuration for connecting to the cluster. The type depends on the value of the `authentication.type` property within the given object, which must be one of [tls, scram-sha-256, scram-sha-512, plain, oauth].
|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`]
|config                1.2+<.<a|The MirrorMaker consumer config. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, group.id, sasl., security., interceptor.classes (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
|map
|tls                   1.2+<.<a|TLS configuration for connecting MirrorMaker to the cluster.
|xref:type-ClientTls-{context}[`ClientTls`]
|====

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

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

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

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

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


[options="header"]
|====
|Property                   |Description
|bootstrapServers    1.2+<.<a|A list of host:port pairs for establishing the initial connection to the Kafka cluster.
|string
|abortOnSendFailure  1.2+<.<a|Flag to set the MirrorMaker to exit on a failed send. Default value is `true`.
|boolean
|authentication      1.2+<.<a|Authentication configuration for connecting to the cluster. The type depends on the value of the `authentication.type` property within the given object, which must be one of [tls, scram-sha-256, scram-sha-512, plain, oauth].
|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`]
|config              1.2+<.<a|The MirrorMaker producer config. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, sasl., security., interceptor.classes (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
|map
|tls                 1.2+<.<a|TLS configuration for connecting MirrorMaker to the cluster.
|xref:type-ClientTls-{context}[`ClientTls`]
|====

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

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


[options="header"]
|====
|Property                     |Description
|deployment            1.2+<.<a|Template for Kafka MirrorMaker `Deployment`.
|xref:type-DeploymentTemplate-{context}[`DeploymentTemplate`]
|pod                   1.2+<.<a|Template for Kafka MirrorMaker `Pods`.
|xref:type-PodTemplate-{context}[`PodTemplate`]
|podDisruptionBudget   1.2+<.<a|Template for Kafka MirrorMaker `PodDisruptionBudget`.
|xref:type-PodDisruptionBudgetTemplate-{context}[`PodDisruptionBudgetTemplate`]
|mirrorMakerContainer  1.2+<.<a|Template for Kafka MirrorMaker container.
|xref:type-ContainerTemplate-{context}[`ContainerTemplate`]
|serviceAccount        1.2+<.<a|Template for the Kafka MirrorMaker service account.
|xref:type-ResourceTemplate-{context}[`ResourceTemplate`]
|====

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

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


[options="header"]
|====
|Property                   |Description
|conditions          1.2+<.<a|List of status conditions.
|xref:type-Condition-{context}[`Condition`] array
|observedGeneration  1.2+<.<a|The generation of the CRD that was last reconciled by the operator.
|integer
|labelSelector       1.2+<.<a|Label selector for pods providing this resource.
|string
|replicas            1.2+<.<a|The current number of pods being used to provide this resource.
|integer
|====

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


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

[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.KafkaBridgeSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                    |Description
|replicas             1.2+<.<a|The number of pods in the `Deployment`.  Defaults to `1`.
|integer
|image                1.2+<.<a|The docker image for the pods.
|string
|bootstrapServers     1.2+<.<a|A list of host:port pairs for establishing the initial connection to the Kafka cluster.
|string
|tls                  1.2+<.<a|TLS configuration for connecting Kafka Bridge to the cluster.
|xref:type-ClientTls-{context}[`ClientTls`]
|authentication       1.2+<.<a|Authentication configuration for connecting to the cluster. The type depends on the value of the `authentication.type` property within the given object, which must be one of [tls, scram-sha-256, scram-sha-512, plain, oauth].
|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`]
|http                 1.2+<.<a|The HTTP related configuration.
|xref:type-KafkaBridgeHttpConfig-{context}[`KafkaBridgeHttpConfig`]
|adminClient          1.2+<.<a|Kafka AdminClient related configuration.
|xref:type-KafkaBridgeAdminClientSpec-{context}[`KafkaBridgeAdminClientSpec`]
|consumer             1.2+<.<a|Kafka consumer related configuration.
|xref:type-KafkaBridgeConsumerSpec-{context}[`KafkaBridgeConsumerSpec`]
|producer             1.2+<.<a|Kafka producer related configuration.
|xref:type-KafkaBridgeProducerSpec-{context}[`KafkaBridgeProducerSpec`]
|resources            1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|jvmOptions           1.2+<.<a|**Currently not supported** JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|logging              1.2+<.<a|Logging configuration for Kafka Bridge. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|clientRackInitImage  1.2+<.<a|The image of the init container used for initializing the `client.rack`.
|string
|rack                 1.2+<.<a|Configuration of the node label which will be used as the client.rack consumer configuration.
|xref:type-Rack-{context}[`Rack`]
|enableMetrics        1.2+<.<a|Enable the metrics for the Kafka Bridge. Default is false.
|boolean
|livenessProbe        1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe       1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|template             1.2+<.<a|Template for Kafka Bridge resources. The template allows users to specify how a `Deployment` and `Pod` is generated.
|xref:type-KafkaBridgeTemplate-{context}[`KafkaBridgeTemplate`]
|tracing              1.2+<.<a|The configuration of tracing in Kafka Bridge. The type depends on the value of the `tracing.type` property within the given object, which must be one of [jaeger, opentelemetry].
|xref:type-JaegerTracing-{context}[`JaegerTracing`], xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`]
|====

[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.KafkaBridgeHttpConfig.adoc[leveloffset=+1]

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


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

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

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


[options="header"]
|====
|Property               |Description
|allowedOrigins  1.2+<.<a|List of allowed origins. Java regular expressions can be used.
|string array
|allowedMethods  1.2+<.<a|List of allowed HTTP methods.
|string array
|====

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

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


[options="header"]
|====
|Property       |Description
|config  1.2+<.<a|The Kafka AdminClient configuration used for AdminClient instances created by the bridge.
|map
|====

[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.KafkaBridgeConsumerSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property       |Description
|config  1.2+<.<a|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).
|map
|====

[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.KafkaBridgeProducerSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property       |Description
|config  1.2+<.<a|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).
|map
|====

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

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


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

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

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


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

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


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

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

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


[options="header"]
|====
|Property            |Description
|class        1.2+<.<a|The Class for the Kafka Connector.
|string
|tasksMax     1.2+<.<a|The maximum number of tasks for the Kafka Connector.
|integer
|autoRestart  1.2+<.<a|Automatic restart of connector and tasks configuration.
|xref:type-AutoRestart-{context}[`AutoRestart`]
|config       1.2+<.<a|The Kafka Connector configuration. The following properties cannot be set: connector.class, tasks.max.
|map
|pause        1.2+<.<a|Whether the connector should be paused. Defaults to false.
|boolean
|====

[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.AutoRestart.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property        |Description
|enabled  1.2+<.<a|Whether automatic restart for failed connectors and tasks should be enabled or disabled.
|boolean
|====

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

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


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

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

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


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

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


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

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

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


[options="header"]
|====
|Property                      |Description
|version                1.2+<.<a|The Kafka Connect version. Defaults to {DefaultKafkaVersion}. Consult the user documentation to understand the process required to upgrade or downgrade the version.
|string
|replicas               1.2+<.<a|The number of pods in the Kafka Connect group. Defaults to `3`.
|integer
|image                  1.2+<.<a|The docker image for the pods.
|string
|connectCluster         1.2+<.<a|The cluster alias used for Kafka Connect. The alias must match a cluster in the list at `spec.clusters`.
|string
|clusters               1.2+<.<a|Kafka clusters for mirroring.
|xref:type-KafkaMirrorMaker2ClusterSpec-{context}[`KafkaMirrorMaker2ClusterSpec`] array
|mirrors                1.2+<.<a|Configuration of the MirrorMaker 2 connectors.
|xref:type-KafkaMirrorMaker2MirrorSpec-{context}[`KafkaMirrorMaker2MirrorSpec`] array
|resources              1.2+<.<a|The maximum limits for CPU and memory resources and the requested initial resources. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|livenessProbe          1.2+<.<a|Pod liveness checking.
|xref:type-Probe-{context}[`Probe`]
|readinessProbe         1.2+<.<a|Pod readiness checking.
|xref:type-Probe-{context}[`Probe`]
|jvmOptions             1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|jmxOptions             1.2+<.<a|JMX Options.
|xref:type-KafkaJmxOptions-{context}[`KafkaJmxOptions`]
|logging                1.2+<.<a|Logging configuration for Kafka Connect. The type depends on the value of the `logging.type` property within the given object, which must be one of [inline, external].
|xref:type-InlineLogging-{context}[`InlineLogging`], xref:type-ExternalLogging-{context}[`ExternalLogging`]
|clientRackInitImage    1.2+<.<a|The image of the init container used for initializing the `client.rack`.
|string
|rack                   1.2+<.<a|Configuration of the node label which will be used as the `client.rack` consumer configuration.
|xref:type-Rack-{context}[`Rack`]
|tracing                1.2+<.<a|The configuration of tracing in Kafka Connect. The type depends on the value of the `tracing.type` property within the given object, which must be one of [jaeger, opentelemetry].
|xref:type-JaegerTracing-{context}[`JaegerTracing`], xref:type-OpenTelemetryTracing-{context}[`OpenTelemetryTracing`]
|template               1.2+<.<a|Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Deployment`, `Pods` and `Service` are generated.
|xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`]
|externalConfiguration  1.2+<.<a|Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
|xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]
|metricsConfig          1.2+<.<a|Metrics configuration. The type depends on the value of the `metricsConfig.type` property within the given object, which must be one of [jmxPrometheusExporter].
|xref:type-JmxPrometheusExporterMetrics-{context}[`JmxPrometheusExporterMetrics`]
|====

[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.KafkaMirrorMaker2ClusterSpec.adoc[leveloffset=+1]

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


[options="header"]
|====
|Property                 |Description
|alias             1.2+<.<a|Alias used to reference the Kafka cluster.
|string
|bootstrapServers  1.2+<.<a|A comma-separated list of `host:port` pairs for establishing the connection to the Kafka cluster.
|string
|tls               1.2+<.<a|TLS configuration for connecting MirrorMaker 2 connectors to a cluster.
|xref:type-ClientTls-{context}[`ClientTls`]
|authentication    1.2+<.<a|Authentication configuration for connecting to the cluster. The type depends on the value of the `authentication.type` property within the given object, which must be one of [tls, scram-sha-256, scram-sha-512, plain, oauth].
|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`]
|config            1.2+<.<a|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).
|map
|====

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

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


[options="header"]
|====
|Property                       |Description
|sourceCluster           1.2+<.<a|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`.
|string
|targetCluster           1.2+<.<a|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`.
|string
|sourceConnector         1.2+<.<a|The specification of the Kafka MirrorMaker 2 source connector.
|xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]
|heartbeatConnector      1.2+<.<a|The specification of the Kafka MirrorMaker 2 heartbeat connector.
|xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]
|checkpointConnector     1.2+<.<a|The specification of the Kafka MirrorMaker 2 checkpoint connector.
|xref:type-KafkaMirrorMaker2ConnectorSpec-{context}[`KafkaMirrorMaker2ConnectorSpec`]
|topicsPattern           1.2+<.<a|A regular expression matching the topics to be mirrored, for example, "topic1\|topic2\|topic3". Comma-separated lists are also supported.
|string
|topicsBlacklistPattern  1.2+<.<a|**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.
|string
|topicsExcludePattern    1.2+<.<a|A regular expression matching the topics to exclude from mirroring. Comma-separated lists are also supported.
|string
|groupsPattern           1.2+<.<a|A regular expression matching the consumer groups to be mirrored. Comma-separated lists are also supported.
|string
|groupsBlacklistPattern  1.2+<.<a|**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.
|string
|groupsExcludePattern    1.2+<.<a|A regular expression matching the consumer groups to exclude from mirroring. Comma-separated lists are also supported.
|string
|====

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

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


[options="header"]
|====
|Property            |Description
|tasksMax     1.2+<.<a|The maximum number of tasks for the Kafka Connector.
|integer
|config       1.2+<.<a|The Kafka Connector configuration. The following properties cannot be set: connector.class, tasks.max.
|map
|autoRestart  1.2+<.<a|Automatic restart of connector and tasks configuration.
|xref:type-AutoRestart-{context}[`AutoRestart`]
|pause        1.2+<.<a|Whether the connector should be paused. Defaults to false.
|boolean
|====

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

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


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

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


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

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

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


[options="header"]
|====
|Property                                        |Description
|mode                                     1.2+<.<a|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.

|string (one of [remove-brokers, full, add-brokers])
|brokers                                  1.2+<.<a|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.
|integer array
|goals                                    1.2+<.<a|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.
|string array
|skipHardGoalCheck                        1.2+<.<a|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.
|boolean
|rebalanceDisk                            1.2+<.<a|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.
|boolean
|excludedTopics                           1.2+<.<a|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.
|string
|concurrentPartitionMovementsPerBroker    1.2+<.<a|The upper bound of ongoing partition replica movements going into/out of each broker. Default is 5.
|integer
|concurrentIntraBrokerPartitionMovements  1.2+<.<a|The upper bound of ongoing partition replica movements between disks within each broker. Default is 2.
|integer
|concurrentLeaderMovements                1.2+<.<a|The upper bound of ongoing partition leadership movements. Default is 1000.
|integer
|replicationThrottle                      1.2+<.<a|The upper bound, in bytes per second, on the bandwidth used to move replicas. There is no limit by default.
|integer
|replicaMovementStrategies                1.2+<.<a|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.
|string array
|====

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

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


[options="header"]
|====
|Property                   |Description
|conditions          1.2+<.<a|List of status conditions.
|xref:type-Condition-{context}[`Condition`] array
|observedGeneration  1.2+<.<a|The generation of the CRD that was last reconciled by the operator.
|integer
|sessionId           1.2+<.<a|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.
|string
|optimizationResult  1.2+<.<a|A JSON object describing the optimization result.
|map
|====

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


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

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

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


[options="header"]
|====
|Property           |Description
|replicas    1.2+<.<a|The number of pods in the pool.
|integer
|storage     1.2+<.<a|Storage configuration (disk). Cannot be updated. The type depends on the value of the `storage.type` property within the given object, which must be one of [ephemeral, persistent-claim, jbod].
|xref:type-EphemeralStorage-{context}[`EphemeralStorage`], xref:type-PersistentClaimStorage-{context}[`PersistentClaimStorage`], xref:type-JbodStorage-{context}[`JbodStorage`]
|roles       1.2+<.<a|The roles that the nodes in this pool will have when KRaft mode is enabled. Supported values are 'broker' and 'controller'. This field is required. When KRaft mode is disabled, the only allowed value if `broker`.
|string (one or more of [controller, broker]) array
|resources   1.2+<.<a|CPU and memory resources to reserve. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[external documentation for core/v1 resourcerequirements].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core[ResourceRequirements]
|jvmOptions  1.2+<.<a|JVM Options for pods.
|xref:type-JvmOptions-{context}[`JvmOptions`]
|template    1.2+<.<a|Template for pool resources. The template allows users to specify how the resources belonging to this pool are generated.
|xref:type-KafkaNodePoolTemplate-{context}[`KafkaNodePoolTemplate`]
|====

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

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


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

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

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


[options="header"]
|====
|Property                   |Description
|conditions          1.2+<.<a|List of status conditions.
|xref:type-Condition-{context}[`Condition`] array
|observedGeneration  1.2+<.<a|The generation of the CRD that was last reconciled by the operator.
|integer
|nodeIds             1.2+<.<a|Node IDs used by Kafka nodes in this pool.
|integer array
|clusterId           1.2+<.<a|Kafka cluster ID.
|string
|replicas            1.2+<.<a|The current number of pods being used to provide this resource.
|integer
|labelSelector       1.2+<.<a|Label selector for pods providing this resource.
|string
|====

[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.StrimziPodSet.adoc[leveloffset=+1]

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


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

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

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


[options="header"]
|====
|Property         |Description
|selector  1.2+<.<a|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. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta[external documentation for meta/v1 labelselector].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta[LabelSelector]
|pods      1.2+<.<a|The Pods managed by this StrimziPodSet. For more information, see the https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#pods-v1-core[external documentation for core/v1 pods].


|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#pods-v1-core[Map] array
|====

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

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


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

