appendix_crds.adoc

Kafka schema reference

Property	Description
spec	The specification of the Kafka and Zookeeper clusters, and Topic Operator.
KafkaSpec
status	The status of the Kafka and Zookeeper clusters, and Topic Operator.
KafkaStatus

KafkaSpec schema reference

Used in: Kafka

Property	Description
kafka	Configuration of the Kafka cluster.
KafkaClusterSpec
zookeeper	Configuration of the Zookeeper cluster.
ZookeeperClusterSpec
topicOperator	The property topicOperator has been deprecated. This feature should now be configured at path spec.entityOerator.topicOperator. Configuration of the Topic Operator.
TopicOperatorSpec
entityOperator	Configuration of the Entity Operator.
EntityOperatorSpec
clusterCa	Configuration of the cluster certificate authority.
CertificateAuthority
clientsCa	Configuration of the clients certificate authority.
CertificateAuthority
kafkaExporter	Configuration of the Kafka Exporter. Kafka Exporter can provide additional metrics, for example lag of consumer group at topic/partition.
KafkaExporterSpec
maintenanceTimeWindows	A list of time windows for maintenance tasks (that is, certificates renewal). Each time window is defined by a cron expression.
string array

KafkaClusterSpec schema reference

Used in: KafkaSpec

Property	Description
replicas	The number of pods in the cluster.
integer
image	The docker image for the pods. The default value depends on the configured Kafka.spec.kafka.version.
string
storage	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].
EphemeralStorage, PersistentClaimStorage, JbodStorage
listeners	Configures listeners of Kafka brokers.
KafkaListeners
authorization	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].
KafkaAuthorizationSimple
config	The 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., principal.builder.class, log.dir, zookeeper.connect, zookeeper.set.acl, authorizer., super.user.
map
rack	Configuration of the broker.rack broker config.
Rack
brokerRackInitImage	The image of the init container used for initializing the broker.rack.
string
affinity	The property affinity has been deprecated. This feature should now be configured at path spec.kafka.template.pod.affinity. The pod’s affinity rules. See external documentation of core/v1 affinity.
Affinity
tolerations	The property tolerations has been deprecated. This feature should now be configured at path spec.kafka.template.pod.tolerations. The pod’s tolerations. See external documentation of core/v1 toleration.
Toleration array
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
jvmOptions	JVM Options for pods.
JvmOptions
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
metrics	The Prometheus JMX Exporter configuration. See https://github.com/prometheus/jmx_exporter for details of the structure of this configuration.
map
logging	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].
InlineLogging, ExternalLogging
tlsSidecar	TLS sidecar configuration.
TlsSidecar
template	Template for Kafka cluster resources. The template allows users to specify how are the StatefulSet, Pods and Services generated.
KafkaClusterTemplate
version	The kafka broker version. Defaults to {DefaultKafkaVersion}. Consult the user documentation to understand the process required to upgrade or downgrade the version.
string

EphemeralStorage schema reference

Used in: JbodStorage, KafkaClusterSpec, ZookeeperClusterSpec

The type property is a discriminator that distinguishes the use of the type EphemeralStorage from PersistentClaimStorage. It must have the value ephemeral for the type EphemeralStorage.

Property	Description
id	Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.
integer
type	Must be ephemeral.
string

PersistentClaimStorage schema reference

Used in: JbodStorage, KafkaClusterSpec, ZookeeperClusterSpec

The type property is a discriminator that distinguishes the use of the type PersistentClaimStorage from EphemeralStorage. It must have the value persistent-claim for the type PersistentClaimStorage.

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

PersistentClaimStorageOverride schema reference

Used in: PersistentClaimStorage

Property	Description
class	The storage class to use for dynamic volume allocation for this broker.
string
broker	Id of the kafka broker (broker identifier).
integer

JbodStorage schema reference

Used in: KafkaClusterSpec

The type property is a discriminator that distinguishes the use of the type JbodStorage from EphemeralStorage, PersistentClaimStorage. It must have the value jbod for the type JbodStorage.

Property	Description
type	Must be jbod.
string
volumes	List of volumes as Storage objects representing the JBOD disks array.
EphemeralStorage, PersistentClaimStorage array

KafkaListeners schema reference

Used in: KafkaClusterSpec

Property	Description
plain	Configures plain listener on port 9092.
KafkaListenerPlain
tls	Configures TLS listener on port 9093.
KafkaListenerTls
external	Configures external listener on port 9094. The type depends on the value of the external.type property within the given object, which must be one of [route, loadbalancer, nodeport, ingress].
KafkaListenerExternalRoute, KafkaListenerExternalLoadBalancer, KafkaListenerExternalNodePort, KafkaListenerExternalIngress

KafkaListenerPlain schema reference

Used in: KafkaListeners

Property	Description
authentication	Authentication configuration for this listener. Since this listener does not use TLS transport you cannot configure an authentication with type: tls. The type depends on the value of the authentication.type property within the given object, which must be one of [tls, scram-sha-512].
KafkaListenerAuthenticationTls, KafkaListenerAuthenticationScramSha512
networkPolicyPeers	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. See external documentation of networking.k8s.io/v1 networkpolicypeer.
NetworkPolicyPeer array

KafkaListenerAuthenticationTls schema reference

Used in: KafkaListenerExternalIngress, KafkaListenerExternalLoadBalancer, KafkaListenerExternalNodePort, KafkaListenerExternalRoute, KafkaListenerPlain, KafkaListenerTls

The type property is a discriminator that distinguishes the use of the type KafkaListenerAuthenticationTls from KafkaListenerAuthenticationScramSha512. It must have the value tls for the type KafkaListenerAuthenticationTls.

Property	Description
type	Must be tls.
string

KafkaListenerAuthenticationScramSha512 schema reference

Used in: KafkaListenerExternalIngress, KafkaListenerExternalLoadBalancer, KafkaListenerExternalNodePort, KafkaListenerExternalRoute, KafkaListenerPlain, KafkaListenerTls

The type property is a discriminator that distinguishes the use of the type KafkaListenerAuthenticationScramSha512 from KafkaListenerAuthenticationTls. It must have the value scram-sha-512 for the type KafkaListenerAuthenticationScramSha512.

Property	Description
type	Must be scram-sha-512.
string

KafkaListenerTls schema reference

Used in: KafkaListeners

Property	Description
authentication	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].
KafkaListenerAuthenticationTls, KafkaListenerAuthenticationScramSha512
networkPolicyPeers	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. See external documentation of networking.k8s.io/v1 networkpolicypeer.
NetworkPolicyPeer array

KafkaListenerExternalRoute schema reference

Used in: KafkaListeners

The type property is a discriminator that distinguishes the use of the type KafkaListenerExternalRoute from KafkaListenerExternalLoadBalancer, KafkaListenerExternalNodePort, KafkaListenerExternalIngress. It must have the value route for the type KafkaListenerExternalRoute.

Property	Description
type	Must be route.
string
authentication	Authentication configuration for Kafka brokers. The type depends on the value of the authentication.type property within the given object, which must be one of [tls, scram-sha-512].
KafkaListenerAuthenticationTls, KafkaListenerAuthenticationScramSha512
overrides	Overrides for external bootstrap and broker services and externally advertised addresses.
RouteListenerOverride
networkPolicyPeers	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. See external documentation of networking.k8s.io/v1 networkpolicypeer.
NetworkPolicyPeer array

RouteListenerOverride schema reference

Used in: KafkaListenerExternalRoute

Property	Description
bootstrap	External bootstrap service configuration.
RouteListenerBootstrapOverride
brokers	External broker services configuration.
RouteListenerBrokerOverride array

RouteListenerBootstrapOverride schema reference

Used in: RouteListenerOverride

Property	Description
address	Additional address name for the bootstrap service. The address will be added to the list of subject alternative names of the TLS certificates.
string
host	Host for the bootstrap route. This field will be used in the spec.host field of the OpenShift Route.
string

RouteListenerBrokerOverride schema reference

Used in: RouteListenerOverride

Property	Description
broker	Id of the kafka broker (broker identifier).
integer
advertisedHost	The host name which will be used in the brokers' advertised.brokers.
string
advertisedPort	The port number which will be used in the brokers' advertised.brokers.
integer
host	Host for the broker route. This field will be used in the spec.host field of the OpenShift Route.
string

KafkaListenerExternalLoadBalancer schema reference

Used in: KafkaListeners

The type property is a discriminator that distinguishes the use of the type KafkaListenerExternalLoadBalancer from KafkaListenerExternalRoute, KafkaListenerExternalNodePort, KafkaListenerExternalIngress. It must have the value loadbalancer for the type KafkaListenerExternalLoadBalancer.

Property	Description
type	Must be loadbalancer.
string
authentication	Authentication configuration for Kafka brokers. The type depends on the value of the authentication.type property within the given object, which must be one of [tls, scram-sha-512].
KafkaListenerAuthenticationTls, KafkaListenerAuthenticationScramSha512
overrides	Overrides for external bootstrap and broker services and externally advertised addresses.
LoadBalancerListenerOverride
networkPolicyPeers	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. See external documentation of networking.k8s.io/v1 networkpolicypeer.
NetworkPolicyPeer array
tls	Enables TLS encryption on the listener. By default set to true for enabled TLS encryption.
boolean

LoadBalancerListenerOverride schema reference

Used in: KafkaListenerExternalLoadBalancer

Property	Description
bootstrap	External bootstrap service configuration.
LoadBalancerListenerBootstrapOverride
brokers	External broker services configuration.
LoadBalancerListenerBrokerOverride array

LoadBalancerListenerBootstrapOverride schema reference

Used in: LoadBalancerListenerOverride

Property	Description
address	Additional address name for the bootstrap service. The address will be added to the list of subject alternative names of the TLS certificates.
string
dnsAnnotations	Annotations that will be added to the Service resource. You can use this field to configure DNS providers such as External DNS.
map
loadBalancerIP	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.
string

LoadBalancerListenerBrokerOverride schema reference

Used in: LoadBalancerListenerOverride

Property	Description
broker	Id of the kafka broker (broker identifier).
integer
advertisedHost	The host name which will be used in the brokers' advertised.brokers.
string
advertisedPort	The port number which will be used in the brokers' advertised.brokers.
integer
dnsAnnotations	Annotations that will be added to the Service resources for individual brokers. You can use this field to configure DNS providers such as External DNS.
map
loadBalancerIP	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.
string

KafkaListenerExternalNodePort schema reference

Used in: KafkaListeners

The type property is a discriminator that distinguishes the use of the type KafkaListenerExternalNodePort from KafkaListenerExternalRoute, KafkaListenerExternalLoadBalancer, KafkaListenerExternalIngress. It must have the value nodeport for the type KafkaListenerExternalNodePort.

Property	Description
type	Must be nodeport.
string
authentication	Authentication configuration for Kafka brokers. The type depends on the value of the authentication.type property within the given object, which must be one of [tls, scram-sha-512].
KafkaListenerAuthenticationTls, KafkaListenerAuthenticationScramSha512
overrides	Overrides for external bootstrap and broker services and externally advertised addresses.
NodePortListenerOverride
networkPolicyPeers	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. See external documentation of networking.k8s.io/v1 networkpolicypeer.
NetworkPolicyPeer array
tls	Enables TLS encryption on the listener. By default set to true for enabled TLS encryption.
boolean

NodePortListenerOverride schema reference

Used in: KafkaListenerExternalNodePort

Property	Description
bootstrap	External bootstrap service configuration.
NodePortListenerBootstrapOverride
brokers	External broker services configuration.
NodePortListenerBrokerOverride array

NodePortListenerBootstrapOverride schema reference

Used in: NodePortListenerOverride

Property	Description
address	Additional address name for the bootstrap service. The address will be added to the list of subject alternative names of the TLS certificates.
string
dnsAnnotations	Annotations that will be added to the Service resource. You can use this field to configure DNS providers such as External DNS.
map
nodePort	Node port for the bootstrap service.
integer

NodePortListenerBrokerOverride schema reference

Used in: NodePortListenerOverride

Property	Description
broker	Id of the kafka broker (broker identifier).
integer
advertisedHost	The host name which will be used in the brokers' advertised.brokers.
string
advertisedPort	The port number which will be used in the brokers' advertised.brokers.
integer
nodePort	Node port for the broker service.
integer
dnsAnnotations	Annotations that will be added to the Service resources for individual brokers. You can use this field to configure DNS providers such as External DNS.
map

KafkaListenerExternalIngress schema reference

Used in: KafkaListeners

The type property is a discriminator that distinguishes the use of the type KafkaListenerExternalIngress from KafkaListenerExternalRoute, KafkaListenerExternalLoadBalancer, KafkaListenerExternalNodePort. It must have the value ingress for the type KafkaListenerExternalIngress.

Property	Description
type	Must be ingress.
string
authentication	Authentication configuration for Kafka brokers. The type depends on the value of the authentication.type property within the given object, which must be one of [tls, scram-sha-512].
KafkaListenerAuthenticationTls, KafkaListenerAuthenticationScramSha512
class	Configures the Ingress class that defines which Ingress controller will be used. If not set, the Ingress class is set to nginx.
string
configuration	Overrides for external bootstrap and broker services and externally advertised addresses.
IngressListenerConfiguration
networkPolicyPeers	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. See external documentation of networking.k8s.io/v1 networkpolicypeer.
NetworkPolicyPeer array

IngressListenerConfiguration schema reference

Used in: KafkaListenerExternalIngress

Property	Description
bootstrap	External bootstrap ingress configuration.
IngressListenerBootstrapConfiguration
brokers	External broker ingress configuration.
IngressListenerBrokerConfiguration array

IngressListenerBootstrapConfiguration schema reference

Used in: IngressListenerConfiguration

Property	Description
address	Additional address name for the bootstrap service. The address will be added to the list of subject alternative names of the TLS certificates.
string
dnsAnnotations	Annotations that will be added to the Ingress resource. You can use this field to configure DNS providers such as External DNS.
map
host	Host for the bootstrap route. This field will be used in the Ingress resource.
string

IngressListenerBrokerConfiguration schema reference

Used in: IngressListenerConfiguration

Property	Description
broker	Id of the kafka broker (broker identifier).
integer
advertisedHost	The host name which will be used in the brokers' advertised.brokers.
string
advertisedPort	The port number which will be used in the brokers' advertised.brokers.
integer
host	Host for the broker ingress. This field will be used in the Ingress resource.
string
dnsAnnotations	Annotations that will be added to the Ingress resources for individual brokers. You can use this field to configure DNS providers such as External DNS.
map

KafkaAuthorizationSimple schema reference

Used in: KafkaClusterSpec

The type property is a discriminator that distinguishes the use of the type KafkaAuthorizationSimple from other subtypes which may be added in the future. It must have the value simple for the type KafkaAuthorizationSimple.

Property	Description
type	Must be simple.
string
superUsers	List of super users. Should contain list of user principals which should get unlimited access rights.
string array

Rack schema reference

Used in: KafkaClusterSpec

Property	Description
topologyKey	A key that matches labels assigned to the Kubernetes cluster nodes. The value of the label is used to set the broker’s broker.rack config.
string

Probe schema reference

Used in: EntityTopicOperatorSpec, EntityUserOperatorSpec, KafkaBridgeSpec, KafkaClusterSpec, KafkaConnectS2ISpec, KafkaConnectSpec, KafkaExporterSpec, KafkaMirrorMakerSpec, TlsSidecar, TopicOperatorSpec, ZookeeperClusterSpec

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

JvmOptions schema reference

Used in: KafkaBridgeSpec, KafkaClusterSpec, KafkaConnectS2ISpec, KafkaConnectSpec, KafkaMirrorMakerSpec, ZookeeperClusterSpec

Property	Description
-XX	A map of -XX options to the JVM.
map
-Xms	-Xms option to to the JVM.
string
-Xmx	-Xmx option to to the JVM.
string
gcLoggingEnabled	Specifies whether the Garbage Collection logging is enabled. The default is true.
boolean

ResourceRequirements schema reference

Used in: EntityTopicOperatorSpec, EntityUserOperatorSpec, KafkaBridgeSpec, KafkaClusterSpec, KafkaConnectS2ISpec, KafkaConnectSpec, KafkaExporterSpec, KafkaMirrorMakerSpec, TlsSidecar, TopicOperatorSpec, ZookeeperClusterSpec

Property	Description
limits
map
requests
map

InlineLogging schema reference

Used in: EntityTopicOperatorSpec, EntityUserOperatorSpec, KafkaBridgeSpec, KafkaClusterSpec, KafkaConnectS2ISpec, KafkaConnectSpec, KafkaMirrorMakerSpec, TopicOperatorSpec, ZookeeperClusterSpec

The type property is a discriminator that distinguishes the use of the type InlineLogging from ExternalLogging. It must have the value inline for the type InlineLogging.

Property	Description
type	Must be inline.
string
loggers	A Map from logger name to logger level.
map

ExternalLogging schema reference

Used in: EntityTopicOperatorSpec, EntityUserOperatorSpec, KafkaBridgeSpec, KafkaClusterSpec, KafkaConnectS2ISpec, KafkaConnectSpec, KafkaMirrorMakerSpec, TopicOperatorSpec, ZookeeperClusterSpec

The type property is a discriminator that distinguishes the use of the type ExternalLogging from InlineLogging. It must have the value external for the type ExternalLogging.

Property	Description
type	Must be external.
string
name	The name of the ConfigMap from which to get the logging configuration.
string

TlsSidecar schema reference

Used in: EntityOperatorSpec, KafkaClusterSpec, TopicOperatorSpec, ZookeeperClusterSpec

Property	Description
image	The docker image for the container.
string
livenessProbe	Pod liveness checking.
Probe
logLevel	The log level for the TLS sidecar. Default value is notice.
string (one of [emerg, debug, crit, err, alert, warning, notice, info])
readinessProbe	Pod readiness checking.
Probe
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements

KafkaClusterTemplate schema reference

Used in: KafkaClusterSpec

Property	Description
statefulset	Template for Kafka StatefulSet.
ResourceTemplate
pod	Template for Kafka Pods.
PodTemplate
bootstrapService	Template for Kafka bootstrap Service.
ResourceTemplate
brokersService	Template for Kafka broker Service.
ResourceTemplate
externalBootstrapService	Template for Kafka external bootstrap Service.
ResourceTemplate
perPodService	Template for Kafka per-pod Services used for access from outside of Kubernetes.
ResourceTemplate
externalBootstrapRoute	Template for Kafka external bootstrap Route.
ResourceTemplate
perPodRoute	Template for Kafka per-pod Routes used for access from outside of OpenShift.
ResourceTemplate
externalBootstrapIngress	Template for Kafka external bootstrap Ingress.
ResourceTemplate
perPodIngress	Template for Kafka per-pod Ingress used for access from outside of Kubernetes.
ResourceTemplate
persistentVolumeClaim	Template for all Kafka PersistentVolumeClaims.
ResourceTemplate
podDisruptionBudget	Template for Kafka PodDisruptionBudget.
PodDisruptionBudgetTemplate
kafkaContainer	Template for the Kafka broker container.
ContainerTemplate
tlsSidecarContainer	Template for the Kafka broker TLS sidecar container.
ContainerTemplate
initContainer	Template for the Kafka init container.
ContainerTemplate

ResourceTemplate schema reference

Used in: EntityOperatorTemplate, KafkaBridgeTemplate, KafkaClusterTemplate, KafkaConnectTemplate, KafkaExporterTemplate, KafkaMirrorMakerTemplate, ZookeeperClusterTemplate

Property	Description
metadata	Metadata which should be applied to the resource.
MetadataTemplate

MetadataTemplate schema reference

Used in: PodDisruptionBudgetTemplate, PodTemplate, ResourceTemplate

Property	Description
labels	Labels which should be added to the resource template. Can be applied to different resources such as StatefulSets, Deployments, Pods, and Services.
map
annotations	Annotations which should be added to the resource template. Can be applied to different resources such as StatefulSets, Deployments, Pods, and Services.
map

PodTemplate schema reference

Used in: EntityOperatorTemplate, KafkaBridgeTemplate, KafkaClusterTemplate, KafkaConnectTemplate, KafkaExporterTemplate, KafkaMirrorMakerTemplate, ZookeeperClusterTemplate

Property	Description
metadata	Metadata applied to the resource.
MetadataTemplate
imagePullSecrets	List of references to secrets in the same namespace to use for pulling any of the images used by this Pod. See external documentation of core/v1 localobjectreference.
LocalObjectReference array
securityContext	Configures pod-level security attributes and common container settings. See external documentation of core/v1 podsecuritycontext.
PodSecurityContext
terminationGracePeriodSeconds	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 longer than the expected cleanup time for your process.Value must be non-negative integer. The value zero indicates delete immediately. Defaults to 30 seconds.
integer
affinity	The pod’s affinity rules. See external documentation of core/v1 affinity.
Affinity
priorityClassName	The name of the Priority Class to which these pods will be assigned.
string
tolerations	The pod’s tolerations. See external documentation of core/v1 toleration.
Toleration array

PodDisruptionBudgetTemplate schema reference

Used in: KafkaBridgeTemplate, KafkaClusterTemplate, KafkaConnectTemplate, KafkaMirrorMakerTemplate, ZookeeperClusterTemplate

Property	Description
metadata	Metadata to apply to the PodDistruptionBugetTemplate resource.
MetadataTemplate
maxUnavailable	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

ContainerTemplate schema reference

Used in: EntityOperatorTemplate, KafkaBridgeTemplate, KafkaClusterTemplate, KafkaConnectTemplate, KafkaExporterTemplate, KafkaMirrorMakerTemplate, ZookeeperClusterTemplate

Property	Description
env	Environment variables which should be applied to the container.
ContainerEnvVar array

ContainerEnvVar schema reference

Used in: ContainerTemplate

Property	Description
name	The environment variable key.
string
value	The environment variable value.
string

ZookeeperClusterSpec schema reference

Used in: KafkaSpec

Property	Description
replicas	The number of pods in the cluster.
integer
image	The docker image for the pods.
string
storage	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].
EphemeralStorage, PersistentClaimStorage
config	The zookeeper broker config. Properties with the following prefixes cannot be set: server., dataDir, dataLogDir, clientPort, authProvider, quorum.auth, requireClientAuthScheme.
map
affinity	The property affinity has been deprecated. This feature should now be configured at path spec.zookeeper.template.pod.affinity. The pod’s affinity rules. See external documentation of core/v1 affinity.
Affinity
tolerations	The property tolerations has been deprecated. This feature should now be configured at path spec.zookeeper.template.pod.tolerations. The pod’s tolerations. See external documentation of core/v1 toleration.
Toleration array
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
jvmOptions	JVM Options for pods.
JvmOptions
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
metrics	The Prometheus JMX Exporter configuration. See https://github.com/prometheus/jmx_exporter for details of the structure of this configuration.
map
logging	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].
InlineLogging, ExternalLogging
tlsSidecar	TLS sidecar configuration.
TlsSidecar
template	Template for Zookeeper cluster resources. The template allows users to specify how are the StatefulSet, Pods and Services generated.
ZookeeperClusterTemplate

ZookeeperClusterTemplate schema reference

Used in: ZookeeperClusterSpec

Property	Description
statefulset	Template for Zookeeper StatefulSet.
ResourceTemplate
pod	Template for Zookeeper Pods.
PodTemplate
clientService	Template for Zookeeper client Service.
ResourceTemplate
nodesService	Template for Zookeeper nodes Service.
ResourceTemplate
persistentVolumeClaim	Template for all Zookeeper PersistentVolumeClaims.
ResourceTemplate
podDisruptionBudget	Template for Zookeeper PodDisruptionBudget.
PodDisruptionBudgetTemplate
zookeeperContainer	Template for the Zookeeper container.
ContainerTemplate
tlsSidecarContainer	Template for the Kafka broker TLS sidecar container.
ContainerTemplate

TopicOperatorSpec schema reference

Used in: KafkaSpec

Property	Description
watchedNamespace	The namespace the Topic Operator should watch.
string
image	The image to use for the Topic Operator.
string
reconciliationIntervalSeconds	Interval between periodic reconciliations.
integer
zookeeperSessionTimeoutSeconds	Timeout for the Zookeeper session.
integer
affinity	Pod affinity rules. See external documentation of core/v1 affinity.
Affinity
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
topicMetadataMaxAttempts	The number of attempts at getting topic metadata.
integer
tlsSidecar	TLS sidecar configuration.
TlsSidecar
logging	Logging configuration. The type depends on the value of the logging.type property within the given object, which must be one of [inline, external].
InlineLogging, ExternalLogging
jvmOptions	JVM Options for pods.
EntityOperatorJvmOptions
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe

EntityOperatorJvmOptions schema reference

Used in: EntityTopicOperatorSpec, EntityUserOperatorSpec, TopicOperatorSpec

Property	Description
gcLoggingEnabled	Specifies whether the Garbage Collection logging is enabled. The default is true.
boolean

EntityOperatorSpec schema reference

Used in: KafkaSpec

Property	Description
topicOperator	Configuration of the Topic Operator.
EntityTopicOperatorSpec
userOperator	Configuration of the User Operator.
EntityUserOperatorSpec
affinity	The property affinity has been deprecated. This feature should now be configured at path spec.template.pod.affinity. The pod’s affinity rules. See external documentation of core/v1 affinity.
Affinity
tolerations	The property tolerations has been deprecated. This feature should now be configured at path spec.template.pod.tolerations. The pod’s tolerations. See external documentation of core/v1 toleration.
Toleration array
tlsSidecar	TLS sidecar configuration.
TlsSidecar
template	Template for Entity Operator resources. The template allows users to specify how is the Deployment and Pods generated.
EntityOperatorTemplate

EntityTopicOperatorSpec schema reference

Used in: EntityOperatorSpec

Property	Description
watchedNamespace	The namespace the Topic Operator should watch.
string
image	The image to use for the Topic Operator.
string
reconciliationIntervalSeconds	Interval between periodic reconciliations.
integer
zookeeperSessionTimeoutSeconds	Timeout for the Zookeeper session.
integer
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
topicMetadataMaxAttempts	The number of attempts at getting topic metadata.
integer
logging	Logging configuration. The type depends on the value of the logging.type property within the given object, which must be one of [inline, external].
InlineLogging, ExternalLogging
jvmOptions	JVM Options for pods.
EntityOperatorJvmOptions

EntityUserOperatorSpec schema reference

Used in: EntityOperatorSpec

Property	Description
watchedNamespace	The namespace the User Operator should watch.
string
image	The image to use for the User Operator.
string
reconciliationIntervalSeconds	Interval between periodic reconciliations.
integer
zookeeperSessionTimeoutSeconds	Timeout for the Zookeeper session.
integer
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
logging	Logging configuration. The type depends on the value of the logging.type property within the given object, which must be one of [inline, external].
InlineLogging, ExternalLogging
jvmOptions	JVM Options for pods.
EntityOperatorJvmOptions

EntityOperatorTemplate schema reference

Used in: EntityOperatorSpec

Property	Description
deployment	Template for Entity Operator Deployment.
ResourceTemplate
pod	Template for Entity Operator Pods.
PodTemplate
tlsSidecarContainer	Template for the Entity Operator TLS sidecar container.
ContainerTemplate
topicOperatorContainer	Template for the Entity Topic Operator container.
ContainerTemplate
userOperatorContainer	Template for the Entity User Operator container.
ContainerTemplate

CertificateAuthority schema reference

Used in: 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.

Property	Description
generateCertificateAuthority	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
validityDays	The number of days generated certificates should be valid for. The default is 365.
integer
renewalDays	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	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])

KafkaExporterSpec schema reference

Used in: KafkaSpec

Property	Description
image	The docker image for the pods.
string
groupRegex	Regular expression to specify which consumer groups to collect. Default value is .*.
string
topicRegex	Regular expression to specify which topics to collect. Default value is .*.
string
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
logging	Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal]. Default log level is info.
string
enableSaramaLogging	Enable Sarama logging, a Go client library used by the Kafka Exporter.
boolean
template	Customization of deployment templates and pods.
KafkaExporterTemplate
livenessProbe	Pod liveness check.
Probe
readinessProbe	Pod readiness check.
Probe

KafkaExporterTemplate schema reference

Used in: KafkaExporterSpec

Property	Description
deployment	Template for Kafka Exporter Deployment.
ResourceTemplate
pod	Template for Kafka Exporter Pods.
PodTemplate
service	Template for Kafka Exporter Service.
ResourceTemplate
container	Template for the Kafka Exporter container.
ContainerTemplate

KafkaStatus schema reference

Used in: Kafka

Property	Description
conditions	List of status conditions.
Condition array
observedGeneration	The generation of the CRD that was last reconciled by the operator.
integer
listeners	Addresses of the internal and external listeners.
ListenerStatus array

Condition schema reference

Used in: KafkaBridgeStatus, KafkaConnectS2Istatus, KafkaConnectStatus, KafkaMirrorMakerStatus, KafkaStatus, KafkaTopicStatus, KafkaUserStatus

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

ListenerStatus schema reference

Used in: KafkaStatus

Property	Description
type	The type of the listener. Can be one of the following three types: plain, tls, and external.
string
addresses	A list of the addresses for this listener.
ListenerAddress array

ListenerAddress schema reference

Used in: ListenerStatus

Property	Description
host	The DNS name or IP address of Kafka bootstrap service.
string
port	The port of the Kafka bootstrap service.
integer

KafkaConnect schema reference

Property	Description
spec	The specification of the Kafka Connect cluster.
KafkaConnectSpec
status	The status of the Kafka Connect cluster.
KafkaConnectStatus

KafkaConnectSpec schema reference

Used in: KafkaConnect

Property	Description
replicas	The number of pods in the Kafka Connect group.
integer
image	The docker image for the pods.
string
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
jvmOptions	JVM Options for pods.
JvmOptions
affinity	The property affinity has been deprecated. This feature should now be configured at path spec.template.pod.affinity. The pod’s affinity rules. See external documentation of core/v1 affinity.
Affinity
tolerations	The property tolerations has been deprecated. This feature should now be configured at path spec.template.pod.tolerations. The pod’s tolerations. See external documentation of core/v1 toleration.
Toleration array
logging	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].
InlineLogging, ExternalLogging
metrics	The Prometheus JMX Exporter configuration. See https://github.com/prometheus/jmx_exporter for details of the structure of this configuration.
map
tracing	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].
JaegerTracing
template	Template for Kafka Connect and Kafka Connect S2I resources. The template allows users to specify how is the Deployment, Pods and Service generated.
KafkaConnectTemplate
authentication	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-512, plain].
KafkaConnectAuthenticationTls, KafkaConnectAuthenticationScramSha512, KafkaConnectAuthenticationPlain
bootstrapServers	Bootstrap servers to connect to. This should be given as a comma separated list of <hostname>:‍<port> pairs.
string
config	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.
map
externalConfiguration	Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
ExternalConfiguration
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
tls	TLS configuration.
KafkaConnectTls
version	The Kafka Connect version. Defaults to {DefaultKafkaVersion}. Consult the user documentation to understand the process required to upgrade or downgrade the version.
string

JaegerTracing schema reference

Used in: KafkaConnectS2ISpec, KafkaConnectSpec, KafkaMirrorMakerSpec

The type property is a discriminator that distinguishes the use of the type JaegerTracing from other subtypes which may be added in the future. It must have the value jaeger for the type JaegerTracing.

Property	Description
type	Must be jaeger.
string

KafkaConnectTemplate schema reference

Used in: KafkaConnectS2ISpec, KafkaConnectSpec

Property	Description
deployment	Template for Kafka Connect Deployment.
ResourceTemplate
pod	Template for Kafka Connect Pods.
PodTemplate
apiService	Template for Kafka Connect API Service.
ResourceTemplate
connectContainer	Template for the Kafka Connect container.
ContainerTemplate
podDisruptionBudget	Template for Kafka Connect PodDisruptionBudget.
PodDisruptionBudgetTemplate

KafkaConnectAuthenticationTls schema reference

Used in: KafkaConnectS2ISpec, KafkaConnectSpec

The type property is a discriminator that distinguishes the use of the type KafkaConnectAuthenticationTls from KafkaConnectAuthenticationScramSha512, KafkaConnectAuthenticationPlain. It must have the value tls for the type KafkaConnectAuthenticationTls.

Property	Description
certificateAndKey	Certificate and private key pair for TLS authentication.
CertAndKeySecretSource
type	Must be tls.
string

CertAndKeySecretSource schema reference

Used in: KafkaBridgeAuthenticationTls, KafkaConnectAuthenticationTls, KafkaMirrorMakerAuthenticationTls

Property	Description
certificate	The name of the file certificate in the Secret.
string
key	The name of the private key in the Secret.
string
secretName	The name of the Secret containing the certificate.
string

KafkaConnectAuthenticationScramSha512 schema reference

Used in: KafkaConnectS2ISpec, KafkaConnectSpec

The type property is a discriminator that distinguishes the use of the type KafkaConnectAuthenticationScramSha512 from KafkaConnectAuthenticationTls, KafkaConnectAuthenticationPlain. It must have the value scram-sha-512 for the type KafkaConnectAuthenticationScramSha512.

Property	Description
passwordSecret	Password used for the authentication.
PasswordSecretSource
type	Must be scram-sha-512.
string
username	Username used for the authentication.
string

PasswordSecretSource schema reference

Used in: KafkaBridgeAuthenticationPlain, KafkaBridgeAuthenticationScramSha512, KafkaConnectAuthenticationPlain, KafkaConnectAuthenticationScramSha512, KafkaMirrorMakerAuthenticationPlain, KafkaMirrorMakerAuthenticationScramSha512

Property	Description
password	The name of the key in the Secret under which the password is stored.
string
secretName	The name of the Secret containing the password.
string

KafkaConnectAuthenticationPlain schema reference

Used in: KafkaConnectS2ISpec, KafkaConnectSpec

The type property is a discriminator that distinguishes the use of the type KafkaConnectAuthenticationPlain from KafkaConnectAuthenticationTls, KafkaConnectAuthenticationScramSha512. It must have the value plain for the type KafkaConnectAuthenticationPlain.

Property	Description
passwordSecret	Password used for the authentication.
PasswordSecretSource
type	Must be plain.
string
username	Username used for the authentication.
string

ExternalConfiguration schema reference

Used in: KafkaConnectS2ISpec, KafkaConnectSpec

Property	Description
env	Allows to pass data from Secret or ConfigMap to the Kafka Connect pods as environment variables.
ExternalConfigurationEnv array
volumes	Allows to pass data from Secret or ConfigMap to the Kafka Connect pods as volumes.
ExternalConfigurationVolumeSource array

ExternalConfigurationEnv schema reference

Used in: ExternalConfiguration

Property	Description
name	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	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.
ExternalConfigurationEnvVarSource

ExternalConfigurationEnvVarSource schema reference

Used in: ExternalConfigurationEnv

Property	Description
configMapKeyRef	Refernce to a key in a ConfigMap. See external documentation of core/v1 configmapkeyselector.
ConfigMapKeySelector
secretKeyRef	Reference to a key in a Secret. See external documentation of core/v1 secretkeyselector.
SecretKeySelector

ExternalConfigurationVolumeSource schema reference

Used in: ExternalConfiguration

Property	Description
configMap	Reference to a key in a ConfigMap. Exactly one Secret or ConfigMap has to be specified. See external documentation of core/v1 configmapvolumesource.
ConfigMapVolumeSource
name	Name of the volume which will be added to the Kafka Connect pods.
string
secret	Reference to a key in a Secret. Exactly one Secret or ConfigMap has to be specified. See external documentation of core/v1 secretvolumesource.
SecretVolumeSource

KafkaConnectTls schema reference

Used in: KafkaConnectS2ISpec, KafkaConnectSpec

Property	Description
trustedCertificates	Trusted certificates for TLS connection.
CertSecretSource array

CertSecretSource schema reference

Used in: KafkaBridgeTls, KafkaConnectTls, KafkaMirrorMakerTls

Property	Description
certificate	The name of the file certificate in the Secret.
string
secretName	The name of the Secret containing the certificate.
string

KafkaConnectStatus schema reference

Used in: KafkaConnect

Property	Description
conditions	List of status conditions.
Condition array
observedGeneration	The generation of the CRD that was last reconciled by the operator.
integer
url	The URL of the REST API endpoint for managing and monitoring Kafka Connect connectors.
string

KafkaConnectS2I schema reference

Property	Description
spec	The specification of the Kafka Connect Source-to-Image (S2I) cluster.
KafkaConnectS2ISpec
status	The status of the Kafka Connect Source-to-Image (S2I) cluster.
KafkaConnectS2Istatus

KafkaConnectS2ISpec schema reference

Used in: KafkaConnectS2I

Property	Description
replicas	The number of pods in the Kafka Connect group.
integer
image	The docker image for the pods.
string
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
jvmOptions	JVM Options for pods.
JvmOptions
affinity	The property affinity has been deprecated. This feature should now be configured at path spec.template.pod.affinity. The pod’s affinity rules. See external documentation of core/v1 affinity.
Affinity
logging	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].
InlineLogging, ExternalLogging
metrics	The Prometheus JMX Exporter configuration. See https://github.com/prometheus/jmx_exporter for details of the structure of this configuration.
map
template	Template for Kafka Connect and Kafka Connect S2I resources. The template allows users to specify how is the Deployment, Pods and Service generated.
KafkaConnectTemplate
authentication	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-512, plain].
KafkaConnectAuthenticationTls, KafkaConnectAuthenticationScramSha512, KafkaConnectAuthenticationPlain
bootstrapServers	Bootstrap servers to connect to. This should be given as a comma separated list of <hostname>:‍<port> pairs.
string
config	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.
map
externalConfiguration	Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
ExternalConfiguration
insecureSourceRepository	When true this configures the source repository with the 'Local' reference policy and an import policy that accepts insecure source tags.
boolean
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
tls	TLS configuration.
KafkaConnectTls
tolerations	The property tolerations has been deprecated. This feature should now be configured at path spec.template.pod.tolerations. The pod’s tolerations. See external documentation of core/v1 toleration.
Toleration array
tracing	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].
JaegerTracing
version	The Kafka Connect version. Defaults to {DefaultKafkaVersion}. Consult the user documentation to understand the process required to upgrade or downgrade the version.
string

KafkaConnectS2Istatus schema reference

Used in: KafkaConnectS2I

Property	Description
conditions	List of status conditions.
Condition array
observedGeneration	The generation of the CRD that was last reconciled by the operator.
integer
url	The URL of the REST API endpoint for managing and monitoring Kafka Connect connectors.
string
buildConfigName	The name of the build configuration.
string

KafkaTopic schema reference

Property	Description
spec	The specification of the topic.
KafkaTopicSpec
status	The status of the topic.
KafkaTopicStatus

KafkaTopicSpec schema reference

Used in: KafkaTopic

Property	Description
partitions	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.
integer
replicas	The number of replicas the topic should have.
integer
config	The topic configuration.
map
topicName	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

KafkaTopicStatus schema reference

Used in: KafkaTopic

Property	Description
conditions	List of status conditions.
Condition array
observedGeneration	The generation of the CRD that was last reconciled by the operator.
integer

KafkaUser schema reference

Property	Description
spec	The specification of the user.
KafkaUserSpec
status	The status of the Kafka User.
KafkaUserStatus

KafkaUserSpec schema reference

Used in: KafkaUser

Property	Description
authentication	Authentication mechanism enabled for this Kafka user. The type depends on the value of the authentication.type property within the given object, which must be one of [tls, scram-sha-512].
KafkaUserTlsClientAuthentication, KafkaUserScramSha512ClientAuthentication
authorization	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].
KafkaUserAuthorizationSimple

KafkaUserTlsClientAuthentication schema reference

Used in: KafkaUserSpec

The type property is a discriminator that distinguishes the use of the type KafkaUserTlsClientAuthentication from KafkaUserScramSha512ClientAuthentication. It must have the value tls for the type KafkaUserTlsClientAuthentication.

Property	Description
type	Must be tls.
string

KafkaUserScramSha512ClientAuthentication schema reference

Used in: KafkaUserSpec

The type property is a discriminator that distinguishes the use of the type KafkaUserScramSha512ClientAuthentication from KafkaUserTlsClientAuthentication. It must have the value scram-sha-512 for the type KafkaUserScramSha512ClientAuthentication.

Property	Description
type	Must be scram-sha-512.
string

KafkaUserAuthorizationSimple schema reference

Used in: KafkaUserSpec

The type property is a discriminator that distinguishes the use of the type KafkaUserAuthorizationSimple from other subtypes which may be added in the future. It must have the value simple for the type KafkaUserAuthorizationSimple.

Property	Description
type	Must be simple.
string
acls	List of ACL rules which should be applied to this user.
AclRule array

AclRule schema reference

Used in: KafkaUserAuthorizationSimple

Property	Description
host	The host from which the action described in the ACL rule is allowed or denied.
string
operation	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])
resource	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].
AclRuleTopicResource, AclRuleGroupResource, AclRuleClusterResource, AclRuleTransactionalIdResource
type	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])

AclRuleTopicResource schema reference

Used in: AclRule

The type property is a discriminator that distinguishes the use of the type AclRuleTopicResource from AclRuleGroupResource, AclRuleClusterResource, AclRuleTransactionalIdResource. It must have the value topic for the type AclRuleTopicResource.

Property	Description
type	Must be topic.
string
name	Name of resource for which given ACL rule applies. Can be combined with patternType field to use prefix pattern.
string
patternType	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])

AclRuleGroupResource schema reference

Used in: AclRule

The type property is a discriminator that distinguishes the use of the type AclRuleGroupResource from AclRuleTopicResource, AclRuleClusterResource, AclRuleTransactionalIdResource. It must have the value group for the type AclRuleGroupResource.

Property	Description
type	Must be group.
string
name	Name of resource for which given ACL rule applies. Can be combined with patternType field to use prefix pattern.
string
patternType	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])

AclRuleClusterResource schema reference

Used in: AclRule

The type property is a discriminator that distinguishes the use of the type AclRuleClusterResource from AclRuleTopicResource, AclRuleGroupResource, AclRuleTransactionalIdResource. It must have the value cluster for the type AclRuleClusterResource.

Property	Description
type	Must be cluster.
string

AclRuleTransactionalIdResource schema reference

Used in: AclRule

The type property is a discriminator that distinguishes the use of the type AclRuleTransactionalIdResource from AclRuleTopicResource, AclRuleGroupResource, AclRuleClusterResource. It must have the value transactionalId for the type AclRuleTransactionalIdResource.

Property	Description
type	Must be transactionalId.
string
name	Name of resource for which given ACL rule applies. Can be combined with patternType field to use prefix pattern.
string
patternType	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])

KafkaUserStatus schema reference

Used in: KafkaUser

Property	Description
conditions	List of status conditions.
Condition array
observedGeneration	The generation of the CRD that was last reconciled by the operator.
integer
username	Username.
string
secret	The name of Secret where the credentials are stored.
string

KafkaMirrorMaker schema reference

Property	Description
spec	The specification of Kafka Mirror Maker.
KafkaMirrorMakerSpec
status	The status of Kafka Mirror Maker.
KafkaMirrorMakerStatus

KafkaMirrorMakerSpec schema reference

Used in: KafkaMirrorMaker

Property	Description
replicas	The number of pods in the Deployment.
integer
image	The docker image for the pods.
string
whitelist	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 whitelist 'A|B'. Or, as a special case, you can mirror all topics using the whitelist '*'. You can also specify multiple regular expressions separated by commas.
string
consumer	Configuration of source cluster.
KafkaMirrorMakerConsumerSpec
producer	Configuration of target cluster.
KafkaMirrorMakerProducerSpec
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
affinity	The property affinity has been deprecated. This feature should now be configured at path spec.template.pod.affinity. The pod’s affinity rules. See external documentation of core/v1 affinity.
Affinity
tolerations	The property tolerations has been deprecated. This feature should now be configured at path spec.template.pod.tolerations. The pod’s tolerations. See external documentation of core/v1 toleration.
Toleration array
jvmOptions	JVM Options for pods.
JvmOptions
logging	Logging configuration for Mirror Maker. The type depends on the value of the logging.type property within the given object, which must be one of [inline, external].
InlineLogging, ExternalLogging
metrics	The Prometheus JMX Exporter configuration. See {JMXExporter} for details of the structure of this configuration.
map
tracing	The configuration of tracing in Kafka Mirror Maker. The type depends on the value of the tracing.type property within the given object, which must be one of [jaeger].
JaegerTracing
template	Template to specify how Kafka Mirror Maker resources, Deployments and Pods, are generated.
KafkaMirrorMakerTemplate
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
version	The Kafka Mirror Maker version. Defaults to {DefaultKafkaVersion}. Consult the documentation to understand the process required to upgrade or downgrade the version.
string

KafkaMirrorMakerConsumerSpec schema reference

Used in: KafkaMirrorMakerSpec

Property	Description
numStreams	Specifies the number of consumer stream threads to create.
integer
offsetCommitInterval	Specifies the offset auto-commit interval in ms. Default value is 60000.
integer
groupId	A unique string that identifies the consumer group this consumer belongs to.
string
bootstrapServers	A list of host:port pairs for establishing the initial connection to the Kafka cluster.
string
authentication	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-512, plain].
KafkaMirrorMakerAuthenticationTls, KafkaMirrorMakerAuthenticationScramSha512, KafkaMirrorMakerAuthenticationPlain
config	The Mirror Maker consumer config. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, group.id, sasl., security., interceptor.classes.
map
tls	TLS configuration for connecting Mirror Maker to the cluster.
KafkaMirrorMakerTls

KafkaMirrorMakerAuthenticationTls schema reference

Used in: KafkaMirrorMakerConsumerSpec, KafkaMirrorMakerProducerSpec

The type property is a discriminator that distinguishes the use of the type KafkaMirrorMakerAuthenticationTls from KafkaMirrorMakerAuthenticationScramSha512, KafkaMirrorMakerAuthenticationPlain. It must have the value tls for the type KafkaMirrorMakerAuthenticationTls.

Property	Description
certificateAndKey	Reference to the Secret which holds the certificate and private key pair.
CertAndKeySecretSource
type	Must be tls.
string

KafkaMirrorMakerAuthenticationScramSha512 schema reference

Used in: KafkaMirrorMakerConsumerSpec, KafkaMirrorMakerProducerSpec

The type property is a discriminator that distinguishes the use of the type KafkaMirrorMakerAuthenticationScramSha512 from KafkaMirrorMakerAuthenticationTls, KafkaMirrorMakerAuthenticationPlain. It must have the value scram-sha-512 for the type KafkaMirrorMakerAuthenticationScramSha512.

Property	Description
passwordSecret	Reference to the Secret which holds the password.
PasswordSecretSource
type	Must be scram-sha-512.
string
username	Username used for the authentication.
string

KafkaMirrorMakerAuthenticationPlain schema reference

Used in: KafkaMirrorMakerConsumerSpec, KafkaMirrorMakerProducerSpec

The type property is a discriminator that distinguishes the use of the type KafkaMirrorMakerAuthenticationPlain from KafkaMirrorMakerAuthenticationTls, KafkaMirrorMakerAuthenticationScramSha512. It must have the value plain for the type KafkaMirrorMakerAuthenticationPlain.

Property	Description
passwordSecret	Reference to the Secret which holds the password.
PasswordSecretSource
type	Must be plain.
string
username	Username used for the authentication.
string

KafkaMirrorMakerTls schema reference

Used in: KafkaMirrorMakerConsumerSpec, KafkaMirrorMakerProducerSpec

Property	Description
trustedCertificates	Trusted certificates for TLS connection.
CertSecretSource array

KafkaMirrorMakerProducerSpec schema reference

Used in: KafkaMirrorMakerSpec

Property	Description
bootstrapServers	A list of host:port pairs for establishing the initial connection to the Kafka cluster.
string
abortOnSendFailure	Flag to set the Mirror Maker to exit on a failed send. Default value is true.
boolean
authentication	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-512, plain].
KafkaMirrorMakerAuthenticationTls, KafkaMirrorMakerAuthenticationScramSha512, KafkaMirrorMakerAuthenticationPlain
config	The Mirror Maker producer config. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, sasl., security., interceptor.classes.
map
tls	TLS configuration for connecting Mirror Maker to the cluster.
KafkaMirrorMakerTls

KafkaMirrorMakerTemplate schema reference

Used in: KafkaMirrorMakerSpec

Property	Description
deployment	Template for Kafka Mirror Maker Deployment.
ResourceTemplate
pod	Template for Kafka Mirror Maker Pods.
PodTemplate
mirrorMakerContainer	Template for Kafka Mirror Maker container.
ContainerTemplate
podDisruptionBudget	Template for Kafka Mirror Maker PodDisruptionBudget.
PodDisruptionBudgetTemplate

KafkaMirrorMakerStatus schema reference

Used in: KafkaMirrorMaker

Property	Description
conditions	List of status conditions.
Condition array
observedGeneration	The generation of the CRD that was last reconciled by the operator.
integer

KafkaBridge schema reference

Property	Description
spec	The specification of the Kafka Bridge.
KafkaBridgeSpec
status	The status of the Kafka Bridge.
KafkaBridgeStatus

KafkaBridgeSpec schema reference

Used in: KafkaBridge

Property	Description
replicas	The number of pods in the Deployment.
integer
image	The docker image for the pods.
string
bootstrapServers	A list of host:port pairs for establishing the initial connection to the Kafka cluster.
string
tls	TLS configuration for connecting Kafka Bridge to the cluster.
KafkaBridgeTls
authentication	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-512, plain].
KafkaBridgeAuthenticationTls, KafkaBridgeAuthenticationScramSha512, KafkaBridgeAuthenticationPlain
http	The HTTP related configuration.
KafkaBridgeHttpConfig
consumer	Kafka consumer related configuration.
KafkaBridgeConsumerSpec
producer	Kafka producer related configuration.
KafkaBridgeProducerSpec
resources	CPU and memory resources to reserve (limits and requests).
ResourceRequirements
jvmOptions	Currently not supported JVM Options for pods.
JvmOptions
logging	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].
InlineLogging, ExternalLogging
metrics	Currently not supported The Prometheus JMX Exporter configuration. See {JMXExporter} for details of the structure of this configuration.
map
livenessProbe	Pod liveness checking.
Probe
readinessProbe	Pod readiness checking.
Probe
template	Template for Kafka Bridge resources. The template allows users to specify how is the Deployment and Pods generated.
KafkaBridgeTemplate

KafkaBridgeTls schema reference

Used in: KafkaBridgeSpec

Property	Description
trustedCertificates	Trusted certificates for TLS connection.
CertSecretSource array

KafkaBridgeAuthenticationTls schema reference

Used in: KafkaBridgeSpec

The type property is a discriminator that distinguishes the use of the type KafkaBridgeAuthenticationTls from KafkaBridgeAuthenticationScramSha512, KafkaBridgeAuthenticationPlain. It must have the value tls for the type KafkaBridgeAuthenticationTls.

Property	Description
certificateAndKey	Reference to the Secret which holds the certificate and private key pair.
CertAndKeySecretSource
type	Must be tls.
string

KafkaBridgeAuthenticationScramSha512 schema reference

Used in: KafkaBridgeSpec

The type property is a discriminator that distinguishes the use of the type KafkaBridgeAuthenticationScramSha512 from KafkaBridgeAuthenticationTls, KafkaBridgeAuthenticationPlain. It must have the value scram-sha-512 for the type KafkaBridgeAuthenticationScramSha512.

Property	Description
passwordSecret	Reference to the Secret which holds the password.
PasswordSecretSource
type	Must be scram-sha-512.
string
username	Username used for the authentication.
string

KafkaBridgeAuthenticationPlain schema reference

Used in: KafkaBridgeSpec

The type property is a discriminator that distinguishes the use of the type KafkaBridgeAuthenticationPlain from KafkaBridgeAuthenticationTls, KafkaBridgeAuthenticationScramSha512. It must have the value plain for the type KafkaBridgeAuthenticationPlain.

Property	Description
passwordSecret	Reference to the Secret which holds the password.
PasswordSecretSource
type	Must be plain.
string
username	Username used for the authentication.
string

KafkaBridgeHttpConfig schema reference

Used in: KafkaBridgeSpec

Property	Description
port	The port which is the server listening on.
integer

KafkaBridgeConsumerSpec schema reference

Used in: KafkaBridgeSpec

Property	Description
config	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.
map

KafkaBridgeProducerSpec schema reference

Used in: KafkaBridgeSpec

Property	Description
config	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.
map

KafkaBridgeTemplate schema reference

Used in: KafkaBridgeSpec

Property	Description
deployment	Template for Kafka Bridge Deployment.
ResourceTemplate
pod	Template for Kafka Bridge Pods.
PodTemplate
apiService	Template for Kafka Bridge API Service.
ResourceTemplate
bridgeContainer	Template for the Kafka Bridge container.
ContainerTemplate
podDisruptionBudget	Template for Kafka Bridge PodDisruptionBudget.
PodDisruptionBudgetTemplate

KafkaBridgeStatus schema reference

Used in: KafkaBridge

Property	Description
conditions	List of status conditions.
Condition array
observedGeneration	The generation of the CRD that was last reconciled by the operator.
integer
url	The URL at which external client applications can access the Kafka Bridge.
string