Skip to search

KafkaMirrorMaker

kafka.strimzi.io / v1beta2

apiVersion: kafka.strimzi.io/v1beta2 kind: KafkaMirrorMaker metadata: name: example
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object
spec object
The specification of Kafka MirrorMaker.
consumer object required
Configuration of source cluster.
authentication object
Authentication configuration for connecting to the cluster.
accessToken object
Link to Kubernetes Secret containing the access token which was obtained from the authorization server.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
accessTokenIsJwt boolean
Configure whether access token should be treated as JWT. This should be set to `false` if the authorization server returns opaque tokens. Defaults to `true`.
accessTokenLocation string
Path to the token file containing an access token to be used for authentication.
audience string
OAuth audience to use when authenticating against the authorization server. Some authorization servers require the audience to be explicitly set. The possible values depend on how the authorization server is configured. By default, `audience` is not specified when performing the token endpoint request.
certificateAndKey object
Reference to the `Secret` which holds the certificate and private key pair.
certificate string required
The name of the file certificate in the Secret.
key string required
The name of the private key in the Secret.
secretName string required
The name of the Secret containing the certificate.
clientAssertion object
Link to Kubernetes secret containing the client assertion which was manually configured for the client.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
clientAssertionLocation string
Path to the file containing the client assertion to be used for authentication.
clientAssertionType string
The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`.
clientId string
OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
clientSecret object
Link to Kubernetes Secret containing the OAuth client secret which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
connectTimeoutSeconds integer
The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
disableTlsHostnameVerification boolean
Enable or disable TLS hostname verification. Default value is `false`.
enableMetrics boolean
Enable or disable OAuth metrics. Default value is `false`.
httpRetries integer
The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
httpRetryPauseMs integer
The pause to take before retrying a failed HTTP request. If not set, the default is to not pause at all but to immediately repeat a request.
includeAcceptHeader boolean
Whether the Accept header should be set in requests to the authorization servers. The default value is `true`.
maxTokenExpirySeconds integer
Set or limit time-to-live of the access tokens to the specified number of seconds. This should be set if the authorization server returns opaque tokens.
passwordSecret object
Reference to the `Secret` which holds the password.
password string required
The name of the key in the Secret under which the password is stored.
secretName string required
The name of the Secret containing the password.
readTimeoutSeconds integer
The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
refreshToken object
Link to Kubernetes Secret containing the refresh token which can be used to obtain access token from the authorization server.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
saslExtensions object
SASL extensions parameters.
scope string
OAuth scope to use when authenticating against the authorization server. Some authorization servers require this to be set. The possible values depend on how authorization server is configured. By default `scope` is not specified when doing the token endpoint request.
tlsTrustedCertificates []object
Trusted certificates for TLS connection to the OAuth server.
certificate string
The name of the file certificate in the secret.
pattern string
Pattern for the certificate files in the secret. Use the link:https://en.wikipedia.org/wiki/Glob_(programming)[_glob syntax_] for the pattern. All files in the secret that match the pattern are used.
secretName string required
The name of the Secret containing the certificate.
tokenEndpointUri string
Authorization server token endpoint URI.
type string required
Authentication type. Currently the supported types are `tls`, `scram-sha-256`, `scram-sha-512`, `plain`, and 'oauth'. `scram-sha-256` and `scram-sha-512` types use SASL SCRAM-SHA-256 and SASL SCRAM-SHA-512 Authentication, respectively. `plain` type uses SASL PLAIN Authentication. `oauth` type uses SASL OAUTHBEARER Authentication. The `tls` type uses TLS Client Authentication. The `tls` type is supported only over TLS connections.
enum: tls, scram-sha-256, scram-sha-512, plain, oauth
username string
Username used for the authentication.
bootstrapServers string required
A list of host:port pairs for establishing the initial connection to the Kafka cluster.
config object
The MirrorMaker consumer config. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, group.id, sasl., security., interceptor.classes (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
groupId string required
A unique string that identifies the consumer group this consumer belongs to.
numStreams integer
Specifies the number of consumer stream threads to create.
minimum: 1
offsetCommitInterval integer
Specifies the offset auto-commit interval in ms. Default value is 60000.
tls object
TLS configuration for connecting MirrorMaker to the cluster.
trustedCertificates []object
Trusted certificates for TLS connection.
certificate string
The name of the file certificate in the secret.
pattern string
Pattern for the certificate files in the secret. Use the link:https://en.wikipedia.org/wiki/Glob_(programming)[_glob syntax_] for the pattern. All files in the secret that match the pattern are used.
secretName string required
The name of the Secret containing the certificate.
image string
The container image used for Kafka MirrorMaker pods. If no image name is explicitly specified, it is determined based on the `spec.version` configuration. The image names are specifically mapped to corresponding versions in the Cluster Operator configuration.
include string
List of topics which are included for mirroring. This option allows any regular expression using Java-style regular expressions. Mirroring two topics named A and B is achieved by using the expression `A\|B`. Or, as a special case, you can mirror all topics using the regular expression `*`. You can also specify multiple regular expressions separated by commas.
jvmOptions object
JVM Options for pods.
-XX object
A map of -XX options to the JVM.
-Xms string
-Xms option to to the JVM.
pattern: ^[0-9]+[mMgG]?$
-Xmx string
-Xmx option to to the JVM.
pattern: ^[0-9]+[mMgG]?$
gcLoggingEnabled boolean
Specifies whether the Garbage Collection logging is enabled. The default is false.
javaSystemProperties []object
A map of additional system properties which will be passed using the `-D` option to the JVM.
name string
The system property name.
value string
The system property value.
livenessProbe object
Pod liveness checking.
failureThreshold integer
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
minimum: 1
initialDelaySeconds integer
The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.
minimum: 0
periodSeconds integer
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
minimum: 1
successThreshold integer
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
minimum: 1
timeoutSeconds integer
The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.
minimum: 1
logging object
Logging configuration for MirrorMaker.
loggers object
A Map from logger name to logger level.
type string required
Logging type, must be either 'inline' or 'external'.
enum: inline, external
valueFrom object
`ConfigMap` entry where the logging configuration is stored.
configMapKeyRef object
Reference to the key in the ConfigMap containing the configuration.
key string
name string
optional boolean
metricsConfig object
Metrics configuration.
type string required
Metrics type. Only 'jmxPrometheusExporter' supported currently.
enum: jmxPrometheusExporter
valueFrom object required
ConfigMap entry where the Prometheus JMX Exporter configuration is stored.
configMapKeyRef object
Reference to the key in the ConfigMap containing the configuration.
key string
name string
optional boolean
producer object required
Configuration of target cluster.
abortOnSendFailure boolean
Flag to set the MirrorMaker to exit on a failed send. Default value is `true`.
authentication object
Authentication configuration for connecting to the cluster.
accessToken object
Link to Kubernetes Secret containing the access token which was obtained from the authorization server.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
accessTokenIsJwt boolean
Configure whether access token should be treated as JWT. This should be set to `false` if the authorization server returns opaque tokens. Defaults to `true`.
accessTokenLocation string
Path to the token file containing an access token to be used for authentication.
audience string
OAuth audience to use when authenticating against the authorization server. Some authorization servers require the audience to be explicitly set. The possible values depend on how the authorization server is configured. By default, `audience` is not specified when performing the token endpoint request.
certificateAndKey object
Reference to the `Secret` which holds the certificate and private key pair.
certificate string required
The name of the file certificate in the Secret.
key string required
The name of the private key in the Secret.
secretName string required
The name of the Secret containing the certificate.
clientAssertion object
Link to Kubernetes secret containing the client assertion which was manually configured for the client.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
clientAssertionLocation string
Path to the file containing the client assertion to be used for authentication.
clientAssertionType string
The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`.
clientId string
OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
clientSecret object
Link to Kubernetes Secret containing the OAuth client secret which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
connectTimeoutSeconds integer
The connect timeout in seconds when connecting to authorization server. If not set, the effective connect timeout is 60 seconds.
disableTlsHostnameVerification boolean
Enable or disable TLS hostname verification. Default value is `false`.
enableMetrics boolean
Enable or disable OAuth metrics. Default value is `false`.
httpRetries integer
The maximum number of retries to attempt if an initial HTTP request fails. If not set, the default is to not attempt any retries.
httpRetryPauseMs integer
The pause to take before retrying a failed HTTP request. If not set, the default is to not pause at all but to immediately repeat a request.
includeAcceptHeader boolean
Whether the Accept header should be set in requests to the authorization servers. The default value is `true`.
maxTokenExpirySeconds integer
Set or limit time-to-live of the access tokens to the specified number of seconds. This should be set if the authorization server returns opaque tokens.
passwordSecret object
Reference to the `Secret` which holds the password.
password string required
The name of the key in the Secret under which the password is stored.
secretName string required
The name of the Secret containing the password.
readTimeoutSeconds integer
The read timeout in seconds when connecting to authorization server. If not set, the effective read timeout is 60 seconds.
refreshToken object
Link to Kubernetes Secret containing the refresh token which can be used to obtain access token from the authorization server.
key string required
The key under which the secret value is stored in the Kubernetes Secret.
secretName string required
The name of the Kubernetes Secret containing the secret value.
saslExtensions object
SASL extensions parameters.
scope string
OAuth scope to use when authenticating against the authorization server. Some authorization servers require this to be set. The possible values depend on how authorization server is configured. By default `scope` is not specified when doing the token endpoint request.
tlsTrustedCertificates []object
Trusted certificates for TLS connection to the OAuth server.
certificate string
The name of the file certificate in the secret.
pattern string
Pattern for the certificate files in the secret. Use the link:https://en.wikipedia.org/wiki/Glob_(programming)[_glob syntax_] for the pattern. All files in the secret that match the pattern are used.
secretName string required
The name of the Secret containing the certificate.
tokenEndpointUri string
Authorization server token endpoint URI.
type string required
Authentication type. Currently the supported types are `tls`, `scram-sha-256`, `scram-sha-512`, `plain`, and 'oauth'. `scram-sha-256` and `scram-sha-512` types use SASL SCRAM-SHA-256 and SASL SCRAM-SHA-512 Authentication, respectively. `plain` type uses SASL PLAIN Authentication. `oauth` type uses SASL OAUTHBEARER Authentication. The `tls` type uses TLS Client Authentication. The `tls` type is supported only over TLS connections.
enum: tls, scram-sha-256, scram-sha-512, plain, oauth
username string
Username used for the authentication.
bootstrapServers string required
A list of host:port pairs for establishing the initial connection to the Kafka cluster.
config object
The MirrorMaker producer config. Properties with the following prefixes cannot be set: ssl., bootstrap.servers, sasl., security., interceptor.classes (with the exception of: ssl.endpoint.identification.algorithm, ssl.cipher.suites, ssl.protocol, ssl.enabled.protocols).
tls object
TLS configuration for connecting MirrorMaker to the cluster.
trustedCertificates []object
Trusted certificates for TLS connection.
certificate string
The name of the file certificate in the secret.
pattern string
Pattern for the certificate files in the secret. Use the link:https://en.wikipedia.org/wiki/Glob_(programming)[_glob syntax_] for the pattern. All files in the secret that match the pattern are used.
secretName string required
The name of the Secret containing the certificate.
readinessProbe object
Pod readiness checking.
failureThreshold integer
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
minimum: 1
initialDelaySeconds integer
The initial delay before first the health is first checked. Default to 15 seconds. Minimum value is 0.
minimum: 0
periodSeconds integer
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
minimum: 1
successThreshold integer
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
minimum: 1
timeoutSeconds integer
The timeout for each attempted health check. Default to 5 seconds. Minimum value is 1.
minimum: 1
replicas integer required
The number of pods in the `Deployment`.
minimum: 0
resources object
CPU and memory resources to reserve.
claims []object
name string
limits object
requests object
template object
Template to specify how Kafka MirrorMaker resources, `Deployments` and `Pods`, are generated.
deployment object
Template for Kafka MirrorMaker `Deployment`.
deploymentStrategy string
Pod replacement strategy for deployment configuration changes. Valid values are `RollingUpdate` and `Recreate`. Defaults to `RollingUpdate`.
enum: RollingUpdate, Recreate
metadata object
Metadata applied to the resource.
annotations object
Annotations added to the Kubernetes resource.
labels object
Labels added to the Kubernetes resource.
mirrorMakerContainer object
Template for Kafka MirrorMaker container.
env []object
Environment variables which should be applied to the container.
name string
The environment variable key.
value string
The environment variable value.
valueFrom object
Reference to the secret or config map property to which the environment variable is set.
configMapKeyRef object
Reference to a key in a config map.
key string
name string
optional boolean
secretKeyRef object
Reference to a key in a secret.
key string
name string
optional boolean
securityContext object
Security context for the container.
allowPrivilegeEscalation boolean
appArmorProfile object
localhostProfile string
type string
capabilities object
add []string
drop []string
privileged boolean
procMount string
readOnlyRootFilesystem boolean
runAsGroup integer
runAsNonRoot boolean
runAsUser integer
seLinuxOptions object
level string
role string
type string
user string
seccompProfile object
localhostProfile string
type string
windowsOptions object
gmsaCredentialSpec string
gmsaCredentialSpecName string
hostProcess boolean
runAsUserName string
volumeMounts []object
Additional volume mounts which should be applied to the container.
mountPath string
mountPropagation string
name string
readOnly boolean
recursiveReadOnly string
subPath string
subPathExpr string
pod object
Template for Kafka MirrorMaker `Pods`.
affinity object
The pod's affinity rules.
nodeAffinity object
preferredDuringSchedulingIgnoredDuringExecution []object
preference object
matchExpressions []object
key string
operator string
values []string
matchFields []object
key string
operator string
values []string
weight integer
requiredDuringSchedulingIgnoredDuringExecution object
nodeSelectorTerms []object
matchExpressions []object
key string
operator string
values []string
matchFields []object
key string
operator string
values []string
podAffinity object
preferredDuringSchedulingIgnoredDuringExecution []object
podAffinityTerm object
labelSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
matchLabelKeys []string
mismatchLabelKeys []string
namespaceSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
namespaces []string
topologyKey string
weight integer
requiredDuringSchedulingIgnoredDuringExecution []object
labelSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
matchLabelKeys []string
mismatchLabelKeys []string
namespaceSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
namespaces []string
topologyKey string
podAntiAffinity object
preferredDuringSchedulingIgnoredDuringExecution []object
podAffinityTerm object
labelSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
matchLabelKeys []string
mismatchLabelKeys []string
namespaceSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
namespaces []string
topologyKey string
weight integer
requiredDuringSchedulingIgnoredDuringExecution []object
labelSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
matchLabelKeys []string
mismatchLabelKeys []string
namespaceSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
namespaces []string
topologyKey string
enableServiceLinks boolean
Indicates whether information about services should be injected into Pod's environment variables.
hostAliases []object
The pod's HostAliases. HostAliases is an optional list of hosts and IPs that will be injected into the Pod's hosts file if specified.
hostnames []string
ip string
imagePullSecrets []object
List of references to secrets in the same namespace to use for pulling any of the images used by this Pod. When the `STRIMZI_IMAGE_PULL_SECRETS` environment variable in Cluster Operator and the `imagePullSecrets` option are specified, only the `imagePullSecrets` variable is used and the `STRIMZI_IMAGE_PULL_SECRETS` variable is ignored.
name string
metadata object
Metadata applied to the resource.
annotations object
Annotations added to the Kubernetes resource.
labels object
Labels added to the Kubernetes resource.
priorityClassName string
The name of the priority class used to assign priority to the pods.
schedulerName string
The name of the scheduler used to dispatch this `Pod`. If not specified, the default scheduler will be used.
securityContext object
Configures pod-level security attributes and common container settings.
appArmorProfile object
localhostProfile string
type string
fsGroup integer
fsGroupChangePolicy string
runAsGroup integer
runAsNonRoot boolean
runAsUser integer
seLinuxOptions object
level string
role string
type string
user string
seccompProfile object
localhostProfile string
type string
supplementalGroups []integer
sysctls []object
name string
value string
windowsOptions object
gmsaCredentialSpec string
gmsaCredentialSpecName string
hostProcess boolean
runAsUserName string
terminationGracePeriodSeconds integer
The grace period is the duration in seconds after the processes running in the pod are sent a termination signal, and the time when the processes are forcibly halted with a kill signal. Set this value to longer than the expected cleanup time for your process. Value must be a non-negative integer. A zero value indicates delete immediately. You might need to increase the grace period for very large Kafka clusters, so that the Kafka brokers have enough time to transfer their work to another broker before they are terminated. Defaults to 30 seconds.
minimum: 0
tmpDirSizeLimit string
Defines the total amount of pod memory allocated for the temporary `EmptyDir` volume `/tmp`. Specify the allocation in memory units, for example, `100Mi` for 100 mebibytes. Default value is `5Mi`. The `/tmp` volume is backed by pod memory, not disk storage, so avoid setting a high value as it consumes pod memory resources.
pattern: ^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$
tolerations []object
The pod's tolerations.
effect string
key string
operator string
tolerationSeconds integer
value string
topologySpreadConstraints []object
The pod's topology spread constraints.
labelSelector object
matchExpressions []object
key string
operator string
values []string
matchLabels object
matchLabelKeys []string
maxSkew integer
minDomains integer
nodeAffinityPolicy string
nodeTaintsPolicy string
topologyKey string
whenUnsatisfiable string
volumes []object
Additional volumes that can be mounted to the pod.
configMap object
ConfigMap to use to populate the volume.
defaultMode integer
items []object
key string
mode integer
path string
name string
optional boolean
csi object
CSIVolumeSource object to use to populate the volume.
driver string
fsType string
nodePublishSecretRef object
name string
readOnly boolean
volumeAttributes object
emptyDir object
EmptyDir to use to populate the volume.
medium string
sizeLimit object
amount string
format string
name string
Name to use for the volume. Required.
persistentVolumeClaim object
PersistentVolumeClaim object to use to populate the volume.
claimName string
readOnly boolean
secret object
Secret to use populate the volume.
defaultMode integer
items []object
key string
mode integer
path string
optional boolean
secretName string
podDisruptionBudget object
Template for Kafka MirrorMaker `PodDisruptionBudget`.
maxUnavailable integer
Maximum number of unavailable pods to allow automatic Pod eviction. A Pod eviction is allowed when the `maxUnavailable` number of pods or fewer are unavailable after the eviction. Setting this value to 0 prevents all voluntary evictions, so the pods must be evicted manually. Defaults to 1.
minimum: 0
metadata object
Metadata to apply to the `PodDisruptionBudgetTemplate` resource.
annotations object
Annotations added to the Kubernetes resource.
labels object
Labels added to the Kubernetes resource.
serviceAccount object
Template for the Kafka MirrorMaker service account.
metadata object
Metadata applied to the resource.
annotations object
Annotations added to the Kubernetes resource.
labels object
Labels added to the Kubernetes resource.
tracing object
The configuration of tracing in Kafka MirrorMaker.
type string required
Type of the tracing used. Currently the only supported type is `opentelemetry` for OpenTelemetry tracing. As of Strimzi 0.37.0, `jaeger` type is not supported anymore and this option is ignored.
enum: jaeger, opentelemetry
version string
The Kafka MirrorMaker version. Defaults to the latest version. Consult the documentation to understand the process required to upgrade or downgrade the version.
whitelist string
List of topics which are included for mirroring. This option allows any regular expression using Java-style regular expressions. Mirroring two topics named A and B is achieved by using the expression `A\|B`. Or, as a special case, you can mirror all topics using the regular expression `*`. You can also specify multiple regular expressions separated by commas.
status object
The status of Kafka MirrorMaker.
conditions []object
List of status conditions.
lastTransitionTime string
Last time the condition of a type changed from one status to another. The required format is 'yyyy-MM-ddTHH:mm:ssZ', in the UTC time zone.
message string
Human-readable message indicating details about the condition's last transition.
reason string
The reason for the condition's last transition (a single word in CamelCase).
status string
The status of the condition, either True, False or Unknown.
type string
The unique identifier of a condition, used to distinguish between other conditions in the resource.
labelSelector string
Label selector for pods providing this resource.
observedGeneration integer
The generation of the CRD that was last reconciled by the operator.
replicas integer
The current number of pods being used to provide this resource.

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