Appendix C. Custom Resource API Reference

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

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

maintenanceTimeWindows

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

string array

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

Resource constraints (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 2.2.1. Consult the user documentation to understand the process required to upgrade or downgrade the version.

string

id

Storage identification number. It is mandatory only for storage volumes defined in a storage of type 'jbod'.

integer

type

Must be ephemeral.

string

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

class

The storage class to use for dynamic volume allocation for this broker.

string

broker

Id of the kafka broker (broker identifier).

integer

type

Must be jbod.

string

volumes

List of volumes as Storage objects representing the JBOD disks array.

EphemeralStorage, PersistentClaimStorage array

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

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

type

Must be tls.

string

type

Must be scram-sha-512.

string

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

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

bootstrap

External bootstrap service configuration.

RouteListenerBootstrapOverride

brokers

External broker services configuration.

RouteListenerBrokerOverride array

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

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

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

bootstrap

External bootstrap service configuration.

LoadBalancerListenerBootstrapOverride

brokers

External broker services configuration.

LoadBalancerListenerBrokerOverride array

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 which will be added to the Service resource. You can use this field to instrument DNS providers such as External DNS.

map

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 which will be added to the Service resources for individual brokers. You can use this field to instrument DNS providers such as External DNS.

map

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

bootstrap

External bootstrap service configuration.

NodePortListenerBootstrapOverride

brokers

External broker services configuration.

NodePortListenerBrokerOverride array

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

nodePort

Node port for the bootstrap service.

integer

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

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

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

bootstrap

External bootstrap ingress configuration.

IngressListenerBootstrapConfiguration

brokers

External broker ingress configuration.

IngressListenerBrokerConfiguration array

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 which will be added to the Ingress resource. You can use this field to instrument DNS providers such as External DNS.

map

host

Host for the bootstrap route. This field will be used in the Ingress resource.

string

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 which will be added to the Ingress resources for individual brokers. You can use this field to instrument DNS providers such as External DNS.

map

type

Must be simple.

string

superUsers

List of super users. Should contain list of user principals which should get unlimited access rights.

string array

topologyKey

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

string

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

-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

limits

map

requests

map

type

Must be inline.

string

loggers

A Map from logger name to logger level.

map

type

Must be external.

string

name

The name of the ConfigMap from which to get the logging configuration.

string

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

Resource constraints (limits and requests).

ResourceRequirements

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

externalBootstrapIngress

Template for Kafka external bootstrap Ingress.

ResourceTemplate

externalBootstrapRoute

Template for Kafka external bootstrap Route.

ResourceTemplate

externalBootstrapService

Template for Kafka external bootstrap Service.

ResourceTemplate

perPodIngress

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

ResourceTemplate

perPodRoute

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

ResourceTemplate

perPodService

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

ResourceTemplate

podDisruptionBudget

Template for Kafka PodDisruptionBudget.

PodDisruptionBudgetTemplate

metadata

Metadata which should be applied to the resource.

MetadataTemplate

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

metadata

Metadata which should be 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

tolerations

The pod’s tolerations.See external documentation of core/v1 toleration.

Toleration array

metadata

Metadata which should be applied to the PodDistruptionBugetTemplate resource.

MetadataTemplate

maxUnavailable

Maximum number of unavailable pods to allow voluntary Pod eviction. A Pod eviction will only be allowed when "maxUnavailable" or fewer pods are unavailable after the eviction. Setting this value to 0 will prevent all voluntary evictions and the pods will need to be evicted manually. Defaults to 1.

integer

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

Resource constraints (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

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

podDisruptionBudget

Template for Zookeeper PodDisruptionBudget.

PodDisruptionBudgetTemplate

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

Resource constraints (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

gcLoggingEnabled

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

boolean

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

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

Resource constraints (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

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

Resource constraints (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

deployment

Template for Entity Operator Deployment.

ResourceTemplate

pod

Template for Entity Operator Pods.

PodTemplate

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])

conditions

List of status conditions.

Condition array

observedGeneration

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

integer

listeners

Addresses of the internal and external listeners.

ListenerStatus array

type

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

string

status

The status of the condition, one of True, False, Unknown.

string

lastTransitionTime

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

string

reason

One-word CamelCase reason for the condition’s last transition.

string

message

Human-readable message indicating details about last transition.

string

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

host

The DNS name or IP address of Kafka bootstrap service.

string

port

The port of the Kafka bootstrap service.

integer

spec

The specification of the Kafka Connect deployment.

KafkaConnectSpec

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

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.

map

externalConfiguration

Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.

ExternalConfiguration

resources

Resource constraints (limits and requests).

ResourceRequirements

tls

TLS configuration.

KafkaConnectTls

version

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

string

deployment

Template for Kafka Connect Deployment.

ResourceTemplate

pod

Template for Kafka Connect Pods.

PodTemplate

apiService

Template for Kafka Connect API Service.

ResourceTemplate

podDisruptionBudget

Template for Kafka Connect PodDisruptionBudget.

PodDisruptionBudgetTemplate

certificateAndKey

Certificate and private key pair for TLS authentication.

CertAndKeySecretSource

type

Must be tls.

string

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

passwordSecret

Password used for the authentication.

PasswordSecretSource

type

Must be scram-sha-512.

string

username

Username used for the authentication.

string

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

passwordSecret

Password used for the authentication.

PasswordSecretSource

type

Must be plain.

string

username

Username used for the authentication.

string

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

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

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

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

trustedCertificates

Trusted certificates for TLS connection.

CertSecretSource array

certificate

The name of the file certificate in the Secret.

string

secretName

The name of the Secret containing the certificate.

string

spec

The specification of the Kafka Connect deployment.

KafkaConnectS2ISpec

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.

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

Resource constraints (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

version

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

string

spec

The specification of the topic.

KafkaTopicSpec

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

spec

The specification of the user.

KafkaUserSpec

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

type

Must be tls.

string

type

Must be scram-sha-512.

string

type

Must be simple.

string

acls

List of ACL rules which should be applied to this user.

AclRule array

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])

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])

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])

type

Must be cluster.

string

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])

spec

The specification of the mirror maker.

KafkaMirrorMakerSpec

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 can be achieved by using the whitelist 'A|B'. Or, as a special case, you can mirror all topics using the whitelist '*'. Multiple regular expressions separated by commas can be specified as well.

string

consumer

Configuration of source cluster.

KafkaMirrorMakerConsumerSpec

producer

Configuration of target cluster.

KafkaMirrorMakerProducerSpec

resources

Resource constraints (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 JMX Exporter documentation for details of the structure of this configuration.

map

template

Template for Kafka Mirror Maker resources. The template allows users to specify how is the Deployment and Pods generated.

KafkaMirrorMakerTemplate

version

The Kafka Mirror Maker version. Defaults to 2.2.1. Consult the user documentation to understand the process required to upgrade or downgrade the version.

string

numStreams

Specifies the number of consumer stream threads to create.

integer

groupId

A unique string that identifies the consumer group this consumer belongs to.

string

bootstrapServers

A list of host:port pairs to use 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.

map

tls

TLS configuration for connecting to the cluster.

KafkaMirrorMakerTls

certificateAndKey

Reference to the Secret which holds the certificate and private key pair.

CertAndKeySecretSource

type

Must be tls.

string

passwordSecret

Reference to the Secret which holds the password.

PasswordSecretSource

type

Must be scram-sha-512.

string

username

Username used for the authentication.

string

passwordSecret

Reference to the Secret which holds the password.

PasswordSecretSource

type

Must be plain.

string

username

Username used for the authentication.

string

trustedCertificates

Trusted certificates for TLS connection.

CertSecretSource array

bootstrapServers

A list of host:port pairs to use 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 producer config. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, sasl., security.

map

tls

TLS configuration for connecting to the cluster.

KafkaMirrorMakerTls

deployment

Template for Kafka Mirror Maker Deployment.

ResourceTemplate

pod

Template for Kafka Mirror Maker Pods.

PodTemplate

podDisruptionBudget

Template for Kafka Mirror Maker PodDisruptionBudget.

PodDisruptionBudgetTemplate

spec

The specification of the Kafka Bridge.

KafkaBridgeSpec

replicas

The number of pods in the Deployment.

integer

image

The docker image for the pods.

string

bootstrapServers

A list of host:port pairs to use for establishing the initial connection to the Kafka cluster.

string

tls

TLS configuration for connecting 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

Resource constraints (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 JMX Exporter documentation 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

trustedCertificates

Trusted certificates for TLS connection.

CertSecretSource array

certificateAndKey

Reference to the Secret which holds the certificate and private key pair.

CertAndKeySecretSource

type

Must be tls.

string

passwordSecret

Reference to the Secret which holds the password.

PasswordSecretSource

type

Must be scram-sha-512.

string

username

Username used for the authentication.

string

passwordSecret

Reference to the Secret which holds the password.

PasswordSecretSource

type

Must be plain.

string

username

Username used for the authentication.

string

port

The port which is the server listening on. Avoid using port 8081 which is used for readiness checking.

integer

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

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

deployment

Template for Kafka Bridge Deployment.

ResourceTemplate

pod

Template for Kafka Bridge Pods.

PodTemplate

apiService

Template for Kafka Bridge API Service.

ResourceTemplate

podDisruptionBudget

Template for Kafka Bridge PodDisruptionBudget.

PodDisruptionBudgetTemplate