-
Language:
English
-
Language:
English
Using AMQ Streams on OpenShift
For use with AMQ Streams 1.3 on OpenShift Container Platform
Abstract
Chapter 1. Overview of AMQ Streams
AMQ Streams is based on Apache Kafka, a popular platform for streaming data delivery and processing. AMQ Streams makes it easy to run Apache Kafka on OpenShift.
AMQ Streams provides three operators:
- Cluster Operator
- Responsible for deploying and managing Apache Kafka clusters within an OpenShift cluster.
- Topic Operator
- Responsible for managing Kafka topics within a Kafka cluster running within an OpenShift cluster.
- User Operator
- Responsible for managing Kafka users within a Kafka cluster running within an OpenShift cluster.
The Cluster Operator can deploy the Topic Operator and User Operator (as part of an Entity Operator configuration) at the same time as a Kafka cluster.
Operators within the AMQ Streams architecture
1.1. Kafka Key Features
- Designed for horizontal scalability
- Message ordering guarantee at the partition level
Message rewind/replay
- "Long term" storage allows the reconstruction of an application state by replaying the messages
- Combines with compacted topics to use Kafka as a key-value store
Additional resources
- For more information about Apache Kafka, see the Apache Kafka website.
1.2. Document Conventions
Replaceables
In this document, replaceable text is styled in monospace and italics.
For example, in the following code, you will want to replace my-namespace
with the name of your namespace:
sed -i 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
Chapter 2. Getting started with AMQ Streams
AMQ Streams works on all types of clusters, from public and private clouds to local deployments intended for development. This guide assumes that an OpenShift cluster is available and the oc
command-line tool is installed and configured to connect to the running cluster.
AMQ Streams is based on Strimzi 0.14.x. This chapter describes the procedures to deploy AMQ Streams on OpenShift 3.11 and later.
To run the commands in this guide, your cluster user must have the rights to manage role-based access control (RBAC) and CRDs.
For more information about OpenShift and setting up OpenShift cluster, see OpenShift documentation.
2.1. Installing AMQ Streams and deploying components
To install AMQ Streams, download and extract the amq-streams-x.y.z-ocp-install-examples.zip
file from the AMQ Streams download site.
The folder contains several YAML files to help you deploy the components of AMQ Streams to OpenShift, perform common operations, and configure your Kafka cluster. The YAML files are referenced throughout this documentation.
The remainder of this chapter provides an overview of each component and instructions for deploying the components to OpenShift using the YAML files provided.
Although container images for AMQ Streams are available in the Red Hat Container Catalog, we recommend that you use the YAML files provided instead.
2.2. Custom resources
Custom resource definitions (CRDs) extend the Kubernetes API, providing definitions to create and modify custom resources to an OpenShift cluster. Custom resources are created as instances of CRDs.
In AMQ Streams, CRDs introduce custom resources specific to AMQ Streams to an OpenShift cluster, such as Kafka, Kafka Connect, Kafka Mirror Maker, and users and topics custom resources. CRDs provide configuration instructions, defining the schemas used to instantiate and manage the AMQ Streams-specific resources. CRDs also allow AMQ Streams resources to benefit from native OpenShift features like CLI accessibility and configuration validation.
CRDs require a one-time installation in a cluster. Depending on the cluster setup, installation typically requires cluster admin privileges.
Access to manage custom resources is limited to AMQ Streams administrators.
CRDs and custom resources are defined as YAML files.
A CRD defines a new kind
of resource, such as kind:Kafka
, within an OpenShift cluster.
The Kubernetes API server allows custom resources to be created based on the kind
and understands from the CRD how to validate and store the custom resource when it is added to the OpenShift cluster.
When CRDs are deleted, custom resources of that type are also deleted. Additionally, the resources created by the custom resource, such as pods and statefulsets are also deleted.
Additional resources
2.2.1. AMQ Streams custom resource example
Each AMQ Streams-specific custom resource conforms to the schema defined by the CRD for the resource’s kind
.
To understand the relationship between a CRD and a custom resource, let’s look at a sample of the CRD for a Kafka topic.
Kafka topic CRD
apiVersion: kafka.strimzi.io/v1beta1 kind: CustomResourceDefinition metadata: 1 name: kafkatopics.kafka.strimzi.io labels: app: strimzi spec: 2 group: kafka.strimzi.io versions: v1beta1 scope: Namespaced names: # ... singular: kafkatopic plural: kafkatopics shortNames: - kt 3 additionalPrinterColumns: 4 # ... subresources: status: {} 5 validation: 6 openAPIV3Schema: properties: spec: type: object properties: partitions: type: integer minimum: 1 replicas: type: integer minimum: 1 maximum: 32767 # ...
- 1
- The metadata for the topic CRD, its name and a label to identify the CRD.
- 2
- The specification for this CRD, including the group (domain) name, the plural name and the supported schema version, which are used in the URL to access the API of the topic. The other names are used to identify instance resources in the CLI. For example,
oc get kafkatopic my-topic
oroc get kafkatopics
. - 3
- The shortname can be used in CLI commands. For example,
oc get kt
can be used as an abbreviation instead ofoc get kafkatopic
. - 4
- The information presented when using a
get
command on the custom resource. - 5
- The current status of the CRD as described in the schema reference for the resource.
- 6
- openAPIV3Schema validation provides validation for the creation of topic custom resources. For example, a topic requires at least one partition and one replica.
You can identify the CRD YAML files supplied with the AMQ Streams installation files, because the file names contain an index number followed by ‘Crd’.
Here is a corresponding example of a KafkaTopic
custom resource.
Kafka topic custom resource
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaTopic 1 metadata: name: my-topic labels: strimzi.io/cluster: my-cluster 2 spec: 3 partitions: 1 replicas: 1 config: retention.ms: 7200000 segment.bytes: 1073741824 status: conditions: 4 lastTransitionTime: "2019-08-20T11:37:00.706Z" status: "True" type: Ready observedGeneration: 1 / ...
- 1
- The
kind
andapiVersion
identify the CRD of which the custom resource is an instance. - 2
- A label, applicable only to
KafkaTopic
andKafkaUser
resources, that defines the name of the Kafka cluster (which is same as the name of theKafka
resource) to which a topic or user belongs.The name is used by the Topic Operator and User Operator to identify the Kafka cluster when creating a topic or user.
- 3
- The spec shows the number of partitions and replicas for the topic as well as the configuration parameters for the topic itself. In this example, the retention period for a message to remain in the topic and the segment file size for the log are specified.
- 4
- Status conditions for the
KafkaTopic
resource. Thetype
condition changed toReady
at thelastTransitionTime
.
Custom resources can be applied to a cluster through the platform CLI. When the custom resource is created, it uses the same validation as the built-in resources of the Kubernetes API.
After a KafkaTopic
custom resource is created, the Topic Operator is notified and corresponding Kafka topics are created in AMQ Streams.
2.2.2. AMQ Streams custom resource status
The status
property of a AMQ Streams custom resource publishes information about the resource to users and tools that need it.
Several resources have a status
property, as described in the following table.
AMQ Streams resource | Schema reference | Publishes status information on… |
---|---|---|
| The Kafka cluster. | |
| The Kafka Connect cluster, if deployed. | |
| The Kafka Connect cluster with Source-to-Image support, if deployed. | |
| The Kafka MirrorMaker tool, if deployed. | |
| Kafka topics in your Kafka cluster. | |
| Kafka users in your Kafka cluster. | |
| The AMQ Streams Kafka Bridge, if deployed. |
The status
property of a resource provides information on the resource’s:
-
Current state, in the
status.conditions
property -
Last observed generation, in the
status.observedGeneration
property
The status
property also provides resource-specific information. For example:
-
KafkaConnectStatus
provides the REST API endpoint for Kafka Connect connectors. -
KafkaUserStatus
provides the user name of the Kafka user and theSecret
in which their credentials are stored. -
KafkaBridgeStatus
provides the HTTP address at which external client applications can access the Bridge service.
A resource’s current state is useful for tracking progress related to the resource achieving its desired state, as defined by the spec
property. The status conditions provide the time and reason the state of the resource changed and details of events preventing or delaying the operator from realizing the resource’s desired state.
The last observed generation is the generation of the resource that was last reconciled by the Cluster Operator. If the value of observedGeneration
is different from the value of metadata.generation
, the operator has not yet processed the latest update to the resource. If these values are the same, the status information reflects the most recent changes to the resource.
AMQ Streams creates and maintains the status of custom resources, periodically evaluating the current state of the custom resource and updating its status accordingly. When performing an update on a custom resource using oc edit
, for example, its status
is not editable. Moreover, changing the status
would not affect the configuration of the Kafka cluster.
Here we see the status
property specified for a Kafka custom resource.
Kafka custom resource with status
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: spec: # ... status: conditions: 1 - lastTransitionTime: 2019-07-23T23:46:57+0000 status: "True" type: Ready 2 observedGeneration: 4 3 listeners: 4 - addresses: - host: my-cluster-kafka-bootstrap.myproject.svc port: 9092 type: plain - addresses: - host: my-cluster-kafka-bootstrap.myproject.svc port: 9093 type: tls - addresses: - host: 172.29.49.180 port: 9094 type: external # ...
- 1
- Status
conditions
describe criteria related to the status that cannot be deduced from the existing resource information, or are specific to the instance of a resource. - 2
- The
Ready
condition indicates whether the Cluster Operator currently considers the Kafka cluster able to handle traffic. - 3
- The
observedGeneration
indicates the generation of theKafka
custom resource that was last reconciled by the Cluster Operator. - 4
- The
listeners
describe the current Kafka bootstrap addresses by type.ImportantThe address in the custom resource status for external listeners with type
nodeport
is currently not supported.
The Kafka bootstrap addresses listed in the status do not signify that those endpoints or the Kafka cluster is in a ready state.
Accessing status information
You can access status information for a resource from the command line. For more information, see Chapter 16, Checking the status of a custom resource.
2.3. Cluster Operator
The Cluster Operator is responsible for deploying and managing Apache Kafka clusters within an OpenShift cluster.
2.3.1. Overview of the Cluster Operator component
AMQ Streams uses the Cluster Operator to deploy and manage clusters for:
- Kafka (including Zookeeper, Entity Operator and Kafka Exporter)
- Kafka Connect
- Kafka Mirror Maker
- Kafka Bridge
Custom resources are used to deploy the clusters.
For example, to deploy a Kafka cluster:
-
A
Kafka
resource with the cluster configuration is created within the OpenShift cluster. -
The Cluster Operator deploys a corresponding Kafka cluster, based on what is declared in the
Kafka
resource.
The Cluster Operator can also deploy (through Entity Operator configuration of the Kafka
resource):
-
A Topic Operator to provide operator-style topic management through
KafkaTopic
custom resources -
A User Operator to provide operator-style user management through
KafkaUser
custom resources
For more information on the configuration options supported by the Kafka
resource, see Section 3.1, “Kafka cluster configuration”.
On OpenShift, a Kafka Connect deployment can incorporate a Source2Image feature to provides a convenient way to include connectors.
Example architecture for the Cluster Operator
2.3.2. Watch options for a Cluster Operator deployment
When the Cluster Operator is running, it starts to watch for updates of Kafka resources.
Depending on the deployment, the Cluster Operator can watch Kafka resources from:
AMQ Streams provides example YAML files to make the deployment process easier.
The Cluster Operator watches the following resources:
-
Kafka
for the Kafka cluster. -
KafkaConnect
for the Kafka Connect cluster. -
KafkaConnectS2I
for the Kafka Connect cluster with Source2Image support. -
KafkaMirrorMaker
for the Kafka Mirror Maker instance. -
KafkaBridge
for the Kafka Bridge instance
When one of these resources is created in the OpenShift cluster, the operator gets the cluster description from the resource and starts creating a new cluster for the resource by creating the necessary OpenShift resources, such as StatefulSets, Services and ConfigMaps.
Each time a Kafka resource is updated, the operator performs corresponding updates on the OpenShift resources that make up the cluster for the resource.
Resources are either patched or deleted, and then recreated in order to make the cluster for the resource reflect the desired state of the cluster. This operation might cause a rolling update that might lead to service disruption.
When a resource is deleted, the operator undeploys the cluster and deletes all related OpenShift resources.
2.3.3. Deploying the Cluster Operator to watch a single namespace
Prerequisites
-
This procedure requires use of an OpenShift user account which is able to create
CustomResourceDefinitions
,ClusterRoles
andClusterRoleBindings
. Use of Role Base Access Control (RBAC) in the OpenShift cluster usually means that permission to create, edit, and delete these resources is limited to OpenShift cluster administrators, such assystem:admin
. Modify the installation files according to the namespace the Cluster Operator is going to be installed in.
On Linux, use:
sed -i 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
On MacOS, use:
sed -i '' 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
Procedure
Deploy the Cluster Operator:
oc apply -f install/cluster-operator -n my-namespace
2.3.4. Deploying the Cluster Operator to watch multiple namespaces
Prerequisites
-
This procedure requires use of an OpenShift user account which is able to create
CustomResourceDefinitions
,ClusterRoles
andClusterRoleBindings
. Use of Role Base Access Control (RBAC) in the OpenShift cluster usually means that permission to create, edit, and delete these resources is limited to OpenShift cluster administrators, such assystem:admin
. Edit the installation files according to the namespace the Cluster Operator is going to be installed in.
On Linux, use:
sed -i 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
On MacOS, use:
sed -i '' 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
Procedure
Edit the file
install/cluster-operator/050-Deployment-strimzi-cluster-operator.yaml
and in the environment variableSTRIMZI_NAMESPACE
list all the namespaces where Cluster Operator should watch for resources. For example:apiVersion: apps/v1 kind: Deployment spec: # ... template: spec: serviceAccountName: strimzi-cluster-operator containers: - name: strimzi-cluster-operator image: registry.redhat.io/amq7/amq-streams-operator:1.3.0 imagePullPolicy: IfNotPresent env: - name: STRIMZI_NAMESPACE value: watched-namespace-1,watched-namespace-2,watched-namespace-3
For all namespaces which should be watched by the Cluster Operator (
watched-namespace-1
,watched-namespace-2
,watched-namespace-3
in the above example), install theRoleBindings
. Replace thewatched-namespace
with the namespace used in the previous step.This can be done using
oc apply
:oc apply -f install/cluster-operator/020-RoleBinding-strimzi-cluster-operator.yaml -n watched-namespace oc apply -f install/cluster-operator/031-RoleBinding-strimzi-cluster-operator-entity-operator-delegation.yaml -n watched-namespace oc apply -f install/cluster-operator/032-RoleBinding-strimzi-cluster-operator-topic-operator-delegation.yaml -n watched-namespace
Deploy the Cluster Operator
This can be done using
oc apply
:oc apply -f install/cluster-operator -n my-namespace
2.3.5. Deploying the Cluster Operator to watch all namespaces
You can configure the Cluster Operator to watch AMQ Streams resources across all namespaces in your OpenShift cluster. When running in this mode, the Cluster Operator automatically manages clusters in any new namespaces that are created.
Prerequisites
-
This procedure requires use of an OpenShift user account which is able to create
CustomResourceDefinitions
,ClusterRoles
andClusterRoleBindings
. Use of Role Base Access Control (RBAC) in the OpenShift cluster usually means that permission to create, edit, and delete these resources is limited to OpenShift cluster administrators, such assystem:admin
. - Your OpenShift cluster is running.
Procedure
Configure the Cluster Operator to watch all namespaces:
-
Edit the
050-Deployment-strimzi-cluster-operator.yaml
file. Set the value of the
STRIMZI_NAMESPACE
environment variable to*
.apiVersion: apps/v1 kind: Deployment spec: # ... template: spec: # ... serviceAccountName: strimzi-cluster-operator containers: - name: strimzi-cluster-operator image: registry.redhat.io/amq7/amq-streams-operator:1.3.0 imagePullPolicy: IfNotPresent env: - name: STRIMZI_NAMESPACE value: "*" # ...
-
Edit the
Create
ClusterRoleBindings
that grant cluster-wide access to all namespaces to the Cluster Operator.Use the
oc create clusterrolebinding
command:oc create clusterrolebinding strimzi-cluster-operator-namespaced --clusterrole=strimzi-cluster-operator-namespaced --serviceaccount my-namespace:strimzi-cluster-operator oc create clusterrolebinding strimzi-cluster-operator-entity-operator-delegation --clusterrole=strimzi-entity-operator --serviceaccount my-namespace:strimzi-cluster-operator oc create clusterrolebinding strimzi-cluster-operator-topic-operator-delegation --clusterrole=strimzi-topic-operator --serviceaccount my-namespace:strimzi-cluster-operator
Replace
my-namespace
with the namespace in which you want to install the Cluster Operator.Deploy the Cluster Operator to your OpenShift cluster.
Use the
oc apply
command:oc apply -f install/cluster-operator -n my-namespace
2.4. Kafka cluster
You can use AMQ Streams to deploy an ephemeral or persistent Kafka cluster to OpenShift. When installing Kafka, AMQ Streams also installs a Zookeeper cluster and adds the necessary configuration to connect Kafka with Zookeeper.
You can also use it to deploy Kafka Exporter.
- Ephemeral cluster
-
In general, an ephemeral (that is, temporary) Kafka cluster is suitable for development and testing purposes, not for production. This deployment uses
emptyDir
volumes for storing broker information (for Zookeeper) and topics or partitions (for Kafka). Using anemptyDir
volume means that its content is strictly related to the pod life cycle and is deleted when the pod goes down. - Persistent cluster
-
A persistent Kafka cluster uses
PersistentVolumes
to store Zookeeper and Kafka data. ThePersistentVolume
is acquired using aPersistentVolumeClaim
to make it independent of the actual type of thePersistentVolume
. For example, it can use Amazon EBS volumes in Amazon AWS deployments without any changes in the YAML files. ThePersistentVolumeClaim
can use aStorageClass
to trigger automatic volume provisioning.
AMQ Streams includes two templates for deploying a Kafka cluster:
-
kafka-ephemeral.yaml
deploys an ephemeral cluster, namedmy-cluster
by default. -
kafka-persistent.yaml
deploys a persistent cluster, namedmy-cluster
by default.
The cluster name is defined by the name of the resource and cannot be changed after the cluster has been deployed. To change the cluster name before you deploy the cluster, edit the Kafka.metadata.name
property of the resource in the relevant YAML file.
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster # ...
2.4.1. Deploying the Kafka cluster
You can deploy an ephemeral or persistent Kafka cluster to OpenShift on the command line.
Prerequisites
- The Cluster Operator is deployed.
Procedure
If you plan to use the cluster for development or testing purposes, you can create and deploy an ephemeral cluster using
oc apply
.oc apply -f examples/kafka/kafka-ephemeral.yaml
If you plan to use the cluster in production, create and deploy a persistent cluster using
oc apply
.oc apply -f examples/kafka/kafka-persistent.yaml
Additional resources
- For more information on deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
-
For more information on the different configuration options supported by the
Kafka
resource, see Section 3.1, “Kafka cluster configuration”.
2.5. Kafka Connect
Kafka Connect is a tool for streaming data between Apache Kafka and external systems. It provides a framework for moving large amounts of data into and out of your Kafka cluster while maintaining scalability and reliability. Kafka Connect is typically used to integrate Kafka with external databases and storage and messaging systems.
You can use Kafka Connect to:
- Build connector plug-ins (as JAR files) for your Kafka cluster
- Run connectors
Kafka Connect includes the following built-in connectors for moving file-based data into and out of your Kafka cluster.
File Connector | Description |
---|---|
| Transfers data to your Kafka cluster from a file (the source). |
| Transfers data from your Kafka cluster to a file (the sink). |
In AMQ Streams, you can use the Cluster Operator to deploy a Kafka Connect to your OpenShift cluster. OpenShift also supports Kafka Connect Source-2-Image (S2I) clusters.
A Kafka Connect cluster is implemented as a Deployment
with a configurable number of workers. The Kafka Connect REST API is available on port 8083, as the <connect-cluster-name>-connect-api
service.
For more information on deploying a Kafka Connect S2I cluster on OpenShift, see Creating a container image using OpenShift builds and Source-to-Image.
2.5.1. Deploying Kafka Connect to your cluster
You can deploy a Kafka Connect cluster to your OpenShift cluster by using the Cluster Operator.
Prerequisites
Procedure
Use the
oc apply
command to create aKafkaConnect
resource based on thekafka-connect.yaml
file:oc apply -f examples/kafka-connect/kafka-connect.yaml
Additional resources
2.5.2. Extending Kafka Connect with connector plug-ins
The AMQ Streams container images for Kafka Connect include the two built-in file connectors: FileStreamSourceConnector
and FileStreamSinkConnector
. You can add your own connectors by:
- Creating a container image from the Kafka Connect base image (manually or using your CI (continuous integration), for example).
- Creating a container image using OpenShift builds and Source-to-Image (S2I) - available only on OpenShift.
2.5.2.1. Creating a Docker image from the Kafka Connect base image
You can use the Kafka container image on Red Hat Container Catalog as a base image for creating your own custom image with additional connector plug-ins.
The following procedure explains how to create your custom image and add it to the /opt/kafka/plugins
directory. At startup, the AMQ Streams version of Kafka Connect loads any third-party connector plug-ins contained in the /opt/kafka/plugins
directory.
Prerequisites
Procedure
Create a new
Dockerfile
usingregistry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
as the base image:FROM registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0 USER root:root COPY ./my-plugins/ /opt/kafka/plugins/ USER jboss:jboss
- Build the container image.
- Push your custom image to your container registry.
Point to the new container image.
You can either:
Edit the
KafkaConnect.spec.image
property of theKafkaConnect
custom resource.If set, this property overrides the
STRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE
variable in the Cluster Operator.apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect-cluster spec: #... image: my-new-container-image
or
-
In the
install/cluster-operator/050-Deployment-strimzi-cluster-operator.yaml
file, edit theSTRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE
variable to point to the new container image and reinstall the Cluster Operator.
Additional resources
-
For more information on the
KafkaConnect.spec.image property
, see Section 3.2.11, “Container images”. -
For more information on the
STRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE
variable, see Section 4.1.7, “Cluster Operator Configuration”.
2.5.2.2. Creating a container image using OpenShift builds and Source-to-Image
You can use OpenShift builds and the Source-to-Image (S2I) framework to create new container images. An OpenShift build takes a builder image with S2I support, together with source code and binaries provided by the user, and uses them to build a new container image. Once built, container images are stored in OpenShift’s local container image repository and are available for use in deployments.
A Kafka Connect builder image with S2I support is provided on the Red Hat Container Catalog as part of the registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
image. This S2I image takes your binaries (with plug-ins and connectors) and stores them in the /tmp/kafka-plugins/s2i
directory. It creates a new Kafka Connect image from this directory, which can then be used with the Kafka Connect deployment. When started using the enhanced image, Kafka Connect loads any third-party plug-ins from the /tmp/kafka-plugins/s2i
directory.
Procedure
On the command line, use the
oc apply
command to create and deploy a Kafka Connect S2I cluster:oc apply -f examples/kafka-connect/kafka-connect-s2i.yaml
Create a directory with Kafka Connect plug-ins:
$ tree ./my-plugins/ ./my-plugins/ ├── debezium-connector-mongodb │ ├── bson-3.4.2.jar │ ├── CHANGELOG.md │ ├── CONTRIBUTE.md │ ├── COPYRIGHT.txt │ ├── debezium-connector-mongodb-0.7.1.jar │ ├── debezium-core-0.7.1.jar │ ├── LICENSE.txt │ ├── mongodb-driver-3.4.2.jar │ ├── mongodb-driver-core-3.4.2.jar │ └── README.md ├── debezium-connector-mysql │ ├── CHANGELOG.md │ ├── CONTRIBUTE.md │ ├── COPYRIGHT.txt │ ├── debezium-connector-mysql-0.7.1.jar │ ├── debezium-core-0.7.1.jar │ ├── LICENSE.txt │ ├── mysql-binlog-connector-java-0.13.0.jar │ ├── mysql-connector-java-5.1.40.jar │ ├── README.md │ └── wkb-1.0.2.jar └── debezium-connector-postgres ├── CHANGELOG.md ├── CONTRIBUTE.md ├── COPYRIGHT.txt ├── debezium-connector-postgres-0.7.1.jar ├── debezium-core-0.7.1.jar ├── LICENSE.txt ├── postgresql-42.0.0.jar ├── protobuf-java-2.6.1.jar └── README.md
Use the
oc start-build
command to start a new build of the image using the prepared directory:oc start-build my-connect-cluster-connect --from-dir ./my-plugins/
NoteThe name of the build is the same as the name of the deployed Kafka Connect cluster.
- Once the build has finished, the new image is used automatically by the Kafka Connect deployment.
2.6. Kafka Mirror Maker
The Cluster Operator deploys one or more Kafka Mirror Maker replicas to replicate data between Kafka clusters. This process is called mirroring to avoid confusion with the Kafka partitions replication concept. The Mirror Maker consumes messages from the source cluster and republishes those messages to the target cluster.
For information about example resources and the format for deploying Kafka Mirror Maker, see Kafka Mirror Maker configuration.
2.6.1. Deploying Kafka Mirror Maker
Prerequisites
- Before deploying Kafka Mirror Maker, the Cluster Operator must be deployed.
Procedure
Create a Kafka Mirror Maker cluster from the command-line:
oc apply -f examples/kafka-mirror-maker/kafka-mirror-maker.yaml
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”
2.7. Kafka Bridge
The Cluster Operator deploys one or more Kafka bridge replicas to send data between Kafka clusters and clients via HTTP API.
For information about example resources and the format for deploying Kafka Bridge, see Kafka Bridge configuration.
2.7.1. Deploying Kafka Bridge to your OpenShift cluster
You can deploy a Kafka Bridge cluster to your OpenShift cluster by using the Cluster Operator.
Prerequisites
Procedure
Use the
oc apply
command to create aKafkaBridge
resource based on thekafka-bridge.yaml
file:oc apply -f examples/kafka-bridge/kafka-bridge.yaml
Additional resources
2.8. Deploying example clients
Prerequisites
- An existing Kafka cluster for the client to connect to.
Procedure
Deploy the producer.
Use
oc run
:oc run kafka-producer -ti --image=registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0 --rm=true --restart=Never -- bin/kafka-console-producer.sh --broker-list cluster-name-kafka-bootstrap:9092 --topic my-topic
- Type your message into the console where the producer is running.
- Press Enter to send the message.
Deploy the consumer.
Use
oc run
:oc run kafka-consumer -ti --image=registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0 --rm=true --restart=Never -- bin/kafka-console-consumer.sh --bootstrap-server cluster-name-kafka-bootstrap:9092 --topic my-topic --from-beginning
- Confirm that you see the incoming messages in the consumer console.
2.9. Topic Operator
The Topic Operator is responsible for managing Kafka topics within a Kafka cluster running within an OpenShift cluster.
2.9.1. Overview of the Topic Operator component
The Topic Operator provides a way of managing topics in a Kafka cluster via OpenShift resources.
Example architecture for the Topic Operator
The role of the Topic Operator is to keep a set of KafkaTopic
OpenShift resources describing Kafka topics in-sync with corresponding Kafka topics.
Specifically, if a KafkaTopic
is:
- Created, the operator will create the topic it describes
- Deleted, the operator will delete the topic it describes
- Changed, the operator will update the topic it describes
And also, in the other direction, if a topic is:
-
Created within the Kafka cluster, the operator will create a
KafkaTopic
describing it -
Deleted from the Kafka cluster, the operator will delete the
KafkaTopic
describing it -
Changed in the Kafka cluster, the operator will update the
KafkaTopic
describing it
This allows you to declare a KafkaTopic
as part of your application’s deployment and the Topic Operator will take care of creating the topic for you. Your application just needs to deal with producing or consuming from the necessary topics.
If the topic is reconfigured or reassigned to different Kafka nodes, the KafkaTopic
will always be up to date.
For more details about creating, modifying and deleting topics, see Chapter 5, Using the Topic Operator.
2.9.2. Deploying the Topic Operator using the Cluster Operator
This procedure describes how to deploy the Topic Operator using the Cluster Operator. If you want to use the Topic Operator with a Kafka cluster that is not managed by AMQ Streams, you must deploy the Topic Operator as a standalone component. For more information, see Section 4.2.6, “Deploying the standalone Topic Operator”.
Prerequisites
- A running Cluster Operator
-
A
Kafka
resource to be created or updated
Procedure
Ensure that the
Kafka.spec.entityOperator
object exists in theKafka
resource. This configures the Entity Operator.apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: #... entityOperator: topicOperator: {} userOperator: {}
-
Configure the Topic Operator using the fields described in Section C.52, “
EntityTopicOperatorSpec
schema reference”. Create or update the Kafka resource in OpenShift.
Use
oc apply
:oc apply -f your-file
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Entity Operator, see Section 3.1.11, “Entity Operator”.
-
For more information about the
Kafka.spec.entityOperator
object used to configure the Topic Operator when deployed by the Cluster Operator, see Section C.51, “EntityOperatorSpec
schema reference”.
2.10. User Operator
The User Operator is responsible for managing Kafka users within a Kafka cluster running within an OpenShift cluster.
2.10.1. Overview of the User Operator component
The User Operator manages Kafka users for a Kafka cluster by watching for KafkaUser
resources that describe Kafka users and ensuring that they are configured properly in the Kafka cluster. For example:
-
if a
KafkaUser
is created, the User Operator will create the user it describes -
if a
KafkaUser
is deleted, the User Operator will delete the user it describes -
if a
KafkaUser
is changed, the User Operator will update the user it describes
Unlike the Topic Operator, the User Operator does not sync any changes from the Kafka cluster with the OpenShift resources. Unlike the Kafka topics which might be created by applications directly in Kafka, it is not expected that the users will be managed directly in the Kafka cluster in parallel with the User Operator, so this should not be needed.
The User Operator allows you to declare a KafkaUser
as part of your application’s deployment. When the user is created, the user credentials will be created in a Secret
. Your application needs to use the user and its credentials for authentication and to produce or consume messages.
In addition to managing credentials for authentication, the User Operator also manages authorization rules by including a description of the user’s rights in the KafkaUser
declaration.
2.10.2. Deploying the User Operator using the Cluster Operator
Prerequisites
- A running Cluster Operator
-
A
Kafka
resource to be created or updated.
Procedure
-
Edit the
Kafka
resource ensuring it has aKafka.spec.entityOperator.userOperator
object that configures the User Operator how you want. Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
-
For more information about the
Kafka.spec.entityOperator
object used to configure the User Operator when deployed by the Cluster Operator, seeEntityOperatorSpec
schema reference.
2.11. Strimzi Administrators
AMQ Streams includes several custom resources. By default, permission to create, edit, and delete these resources is limited to OpenShift cluster administrators. If you want to allow non-cluster administators to manage AMQ Streams resources, you must assign them the Strimzi Administrator role.
2.11.1. Designating Strimzi Administrators
Prerequisites
-
AMQ Streams
CustomResourceDefinitions
are installed.
Procedure
Create the
strimzi-admin
cluster role in OpenShift.Use
oc apply
:oc apply -f install/strimzi-admin
Assign the
strimzi-admin
ClusterRole
to one or more existing users in the OpenShift cluster.Use
oc create
:oc create clusterrolebinding strimzi-admin --clusterrole=strimzi-admin --user=user1 --user=user2
2.12. Container images
Container images for AMQ Streams are available in the Red Hat Container Catalog. The installation YAML files provided by AMQ Streams will pull the images directly from the Red Hat Container Catalog.
If you do not have access to the Red Hat Container Catalog or want to use your own container repository:
- Pull all container images listed here
- Push them into your own registry
- Update the image names in the installation YAML files
Each Kafka version supported for the release has a separate image.
Container image | Namespace/Repository | Description |
---|---|---|
Kafka |
| AMQ Streams image for running Kafka, including:
|
Operator |
| AMQ Streams image for running the operators:
|
Kafka Bridge |
| AMQ Streams image for running the AMQ Streams Kafka Bridge |
Chapter 3. Deployment configuration
This chapter describes how to configure different aspects of the supported deployments:
- Kafka clusters
- Kafka Connect clusters
- Kafka Connect clusters with Source2Image support
- Kafka Mirror Maker
- Kafka Bridge
- OAuth 2.0 token based authentication
3.1. Kafka cluster configuration
The full schema of the Kafka
resource is described in the Section C.1, “Kafka
schema reference”. All labels that are applied to the desired Kafka
resource will also be applied to the OpenShift resources making up the Kafka cluster. This provides a convenient mechanism for resources to be labeled as required.
3.1.1. Sample Kafka YAML configuration
For help in understanding the configuration options available for your Kafka deployment, refer to sample YAML file provided here.
The sample shows only some of the possible configuration options, but those that are particularly important include:
- Resource requests (CPU / Memory)
- JVM options for maximum and minimum memory allocation
- Listeners (and authentication)
- Authentication
- Storage
- Rack awareness
- Metrics
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: replicas: 3 1 version: 1.3 2 resources: 3 requests: memory: 64Gi cpu: "8" limits: 4 memory: 64Gi cpu: "12" jvmOptions: 5 -Xms: 8192m -Xmx: 8192m listeners: 6 tls: authentication:7 type: tls external: 8 type: route authentication: type: tls authorization: 9 type: simple config: 10 auto.create.topics.enable: "false" offsets.topic.replication.factor: 3 transaction.state.log.replication.factor: 3 transaction.state.log.min.isr: 2 storage: 11 type: persistent-claim 12 size: 10000Gi 13 rack: 14 topologyKey: failure-domain.beta.kubernetes.io/zone metrics: 15 lowercaseOutputName: true rules: 16 # Special cases and very specific rules - pattern : kafka.server<type=(.+), name=(.+), clientId=(.+), topic=(.+), partition=(.*)><>Value name: kafka_server_$1_$2 type: GAUGE labels: clientId: "$3" topic: "$4" partition: "$5" # ... zookeeper: 17 replicas: 3 resources: requests: memory: 8Gi cpu: "2" limits: memory: 8Gi cpu: "2" jvmOptions: -Xms: 4096m -Xmx: 4096m storage: type: persistent-claim size: 1000Gi metrics: # ... entityOperator: 18 topicOperator: resources: requests: memory: 512Mi cpu: "1" limits: memory: 512Mi cpu: "1" userOperator: resources: requests: memory: 512Mi cpu: "1" limits: memory: 512Mi cpu: "1" kafkaExporter: 19 # ...
- 1
- Replicas specifies the number of broker nodes.
- 2
- Kafka version, which can be changed by following the upgrade procedure.
- 3
- Resource requests specify the resources to reserve for a given container.
- 4
- Resource limits specify the maximum resources that can be consumed by a container.
- 5
- 6
- Listeners configure how clients connect to the Kafka cluster via bootstrap addresses. Listeners are configured as
plain
(without encryption),tls
orexternal
. - 7
- Listener authentication mechanisms may be configured for each listener, and specified as mutual TLS or SCRAM-SHA.
- 8
- External listener configuration specifies how the Kafka cluster is exposed outside OpenShift, such as through a
route
,loadbalancer
ornodeport
. - 9
- 10
- Config specifies the broker configuration. Standard Apache Kafka configuration may be provided, restricted to those properties not managed directly by AMQ Streams.
- 11
- 12
- Storage size for persistent volumes may be increased and additional volumes may be added to JBOD storage.
- 13
- Persistent storage has additional configuration options, such as a storage
id
andclass
for dynamic volume provisioning. - 14
- Rack awareness is configured to spread replicas across different racks. A
topology
key must match the label of a cluster node. - 15
- 16
- Kafka rules for exporting metrics to a Grafana dashboard through the JMX Exporter. A set of rules provided with AMQ Streams may be copied to your Kafka resource configuration.
- 17
- Zookeeper-specific configuration, which contains properties similar to the Kafka configuration.
- 18
- Entity Operator configuration, which specifies the configuration for the Topic Operator and User Operator.
- 19
- Kafka Exporter configuration, which is used to expose data as Prometheus metrics.
3.1.2. Data storage considerations
An efficient data storage infrastructure is essential to the optimal performance of AMQ Streams.
AMQ Streams requires block storage and is designed to work optimally with cloud-based block storage solutions, including Amazon Elastic Block Store (EBS). The use of file storage (for example, NFS) is not recommended.
Choose local storage (local persistent volumes) when possible. If local storage is not available, you can use a Storage Area Network (SAN) accessed by a protocol such as Fibre Channel or iSCSI.
3.1.2.1. Apache Kafka and Zookeeper storage
Use separate disks for Apache Kafka and Zookeeper.
Three types of data storage are supported:
- Ephemeral (Recommended for development only)
- Persistent
- JBOD (Just a Bunch of Disks, suitable for Kafka only)
For more information, see Kafka and Zookeeper storage.
Solid-state drives (SSDs), though not essential, can improve the performance of Kafka in large clusters where data is sent to and received from multiple topics asynchronously. SSDs are particularly effective with Zookeeper, which requires fast, low latency data access.
You do not need to provision replicated storage because Kafka and Zookeeper both have built-in data replication.
3.1.2.2. File systems
It is recommended that you configure your storage system to use the XFS file system. AMQ Streams is also compatible with the ext4 file system, but this might require additional configuration for best results.
3.1.3. Kafka and Zookeeper storage types
As stateful applications, Kafka and Zookeeper need to store data on disk. AMQ Streams supports three storage types for this data:
- Ephemeral
- Persistent
- JBOD storage
JBOD storage is supported only for Kafka, not for Zookeeper.
When configuring a Kafka
resource, you can specify the type of storage used by the Kafka broker and its corresponding Zookeeper node. You configure the storage type using the storage
property in the following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
The storage type is configured in the type
field.
The storage type cannot be changed after a Kafka cluster is deployed.
Additional resources
- For more information about ephemeral storage, see ephemeral storage schema reference.
- For more information about persistent storage, see persistent storage schema reference.
- For more information about JBOD storage, see JBOD schema reference.
-
For more information about the schema for
Kafka
, seeKafka
schema reference.
3.1.3.1. Ephemeral storage
Ephemeral storage uses the `emptyDir` volumes to store data. To use ephemeral storage, the type
field should be set to ephemeral
.
EmptyDir
volumes are not persistent and the data stored in them will be lost when the Pod is restarted. After the new pod is started, it has to recover all data from other nodes of the cluster. Ephemeral storage is not suitable for use with single node Zookeeper clusters and for Kafka topics with replication factor 1, because it will lead to data loss.
An example of Ephemeral storage
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... storage: type: ephemeral # ... zookeeper: # ... storage: type: ephemeral # ...
3.1.3.1.1. Log directories
The ephemeral volume will be used by the Kafka brokers as log directories mounted into the following path:
/var/lib/kafka/data/kafka-log_idx_
-
Where
idx
is the Kafka broker pod index. For example/var/lib/kafka/data/kafka-log0
.
3.1.3.2. Persistent storage
Persistent storage uses Persistent Volume Claims to provision persistent volumes for storing data. Persistent Volume Claims can be used to provision volumes of many different types, depending on the Storage Class which will provision the volume. The data types which can be used with persistent volume claims include many types of SAN storage as well as Local persistent volumes.
To use persistent storage, the type
has to be set to persistent-claim
. Persistent storage supports additional configuration options:
id
(optional)-
Storage identification number. This option is mandatory for storage volumes defined in a JBOD storage declaration. Default is
0
. size
(required)- Defines the size of the persistent volume claim, for example, "1000Gi".
class
(optional)- The OpenShift Storage Class to use for dynamic volume provisioning.
selector
(optional)- Allows selecting a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
deleteClaim
(optional)-
Boolean value which specifies if the Persistent Volume Claim has to be deleted when the cluster is undeployed. Default is
false
.
Increasing the size of persistent volumes in an existing AMQ Streams cluster is only supported in OpenShift versions that support persistent volume resizing. The persistent volume to be resized must use a storage class that supports volume expansion. For other versions of OpenShift and storage classes which do not support volume expansion, you must decide the necessary storage size before deploying the cluster. Decreasing the size of existing persistent volumes is not possible.
Example fragment of persistent storage configuration with 1000Gi size
# ... storage: type: persistent-claim size: 1000Gi # ...
The following example demonstrates the use of a storage class.
Example fragment of persistent storage configuration with specific Storage Class
# ... storage: type: persistent-claim size: 1Gi class: my-storage-class # ...
Finally, a selector
can be used to select a specific labeled persistent volume to provide needed features such as an SSD.
Example fragment of persistent storage configuration with selector
# ... storage: type: persistent-claim size: 1Gi selector: hdd-type: ssd deleteClaim: true # ...
3.1.3.2.1. Storage class overrides
You can specify a different storage class for one or more Kafka brokers, instead of using the default storage class. This is useful if, for example, storage classes are restricted to different availability zones or data centers. You can use the overrides
field for this purpose.
In this example, the default storage class is named my-storage-class
:
Example AMQ Streams cluster using storage class overrides
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: labels: app: my-cluster name: my-cluster namespace: myproject spec: # ... kafka: replicas: 3 storage: deleteClaim: true size: 100Gi type: persistent-claim class: my-storage-class overrides: - broker: 0 class: my-storage-class-zone-1a - broker: 1 class: my-storage-class-zone-1b - broker: 2 class: my-storage-class-zone-1c # ...
As a result of the configured overrides
property, the broker volumes use the following storage classes:
-
The persistent volumes of broker 0 will use
my-storage-class-zone-1a
. -
The persistent volumes of broker 1 will use
my-storage-class-zone-1b
. -
The persistent volumes of broker 2 will use
my-storage-class-zone-1c
.
The overrides
property is currently used only to override storage class configurations. Overriding other storage configuration fields is not currently supported. Other fields from the storage configuration are currently not supported.
3.1.3.2.2. Persistent Volume Claim naming
When persistent storage is used, it creates Persistent Volume Claims with the following names:
data-cluster-name-kafka-idx
-
Persistent Volume Claim for the volume used for storing data for the Kafka broker pod
idx
. data-cluster-name-zookeeper-idx
-
Persistent Volume Claim for the volume used for storing data for the Zookeeper node pod
idx
.
3.1.3.2.3. Log directories
The persistent volume will be used by the Kafka brokers as log directories mounted into the following path:
/var/lib/kafka/data/kafka-log_idx_
-
Where
idx
is the Kafka broker pod index. For example/var/lib/kafka/data/kafka-log0
.
3.1.3.3. Resizing persistent volumes
You can provision increased storage capacity by increasing the size of the persistent volumes used by an existing AMQ Streams cluster. Resizing persistent volumes is supported in clusters that use either a single persistent volume or multiple persistent volumes in a JBOD storage configuration.
You can increase but not decrease the size of persistent volumes. Decreasing the size of persistent volumes is not currently supported in OpenShift.
Prerequisites
- An OpenShift cluster with support for volume resizing.
- The Cluster Operator is running.
- A Kafka cluster using persistent volumes created using a storage class that supports volume expansion.
Procedure
In a
Kafka
resource, increase the size of the persistent volume allocated to the Kafka cluster, the Zookeeper cluster, or both.-
To increase the volume size allocated to the Kafka cluster, edit the
spec.kafka.storage
property. To increase the volume size allocated to the Zookeeper cluster, edit the
spec.zookeeper.storage
property.For example, to increase the volume size from
1000Gi
to2000Gi
:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... storage: type: persistent-claim size: 2000Gi class: my-storage-class # ... zookeeper: # ...
-
To increase the volume size allocated to the Kafka cluster, edit the
Create or update the resource.
Use
oc apply
:oc apply -f your-file
OpenShift increases the capacity of the selected persistent volumes in response to a request from the Cluster Operator. When the resizing is complete, the Cluster Operator restarts all pods that use the resized persistent volumes. This happens automatically.
Additional resources
For more information about resizing persistent volumes in OpenShift, see Resizing Persistent Volumes using Kubernetes.
3.1.3.4. JBOD storage overview
You can configure AMQ Streams to use JBOD, a data storage configuration of multiple disks or volumes. JBOD is one approach to providing increased data storage for Kafka brokers. It can also improve performance.
A JBOD configuration is described by one or more volumes, each of which can be either ephemeral or persistent. The rules and constraints for JBOD volume declarations are the same as those for ephemeral and persistent storage. For example, you cannot change the size of a persistent storage volume after it has been provisioned.
3.1.3.4.1. JBOD configuration
To use JBOD with AMQ Streams, the storage type
must be set to jbod
. The volumes
property allows you to describe the disks that make up your JBOD storage array or configuration. The following fragment shows an example JBOD configuration:
# ... storage: type: jbod volumes: - id: 0 type: persistent-claim size: 100Gi deleteClaim: false - id: 1 type: persistent-claim size: 100Gi deleteClaim: false # ...
The ids cannot be changed once the JBOD volumes are created.
Users can add or remove volumes from the JBOD configuration.
3.1.3.4.2. JBOD and Persistent Volume Claims
When persistent storage is used to declare JBOD volumes, the naming scheme of the resulting Persistent Volume Claims is as follows:
data-id-cluster-name-kafka-idx
-
Where
id
is the ID of the volume used for storing data for Kafka broker podidx
.
3.1.3.4.3. Log directories
The JBOD volumes will be used by the Kafka brokers as log directories mounted into the following path:
/var/lib/kafka/data-id/kafka-log_idx_
-
Where
id
is the ID of the volume used for storing data for Kafka broker podidx
. For example/var/lib/kafka/data-0/kafka-log0
.
3.1.3.5. Adding volumes to JBOD storage
This procedure describes how to add volumes to a Kafka cluster configured to use JBOD storage. It cannot be applied to Kafka clusters configured to use any other storage type.
When adding a new volume under an id
which was already used in the past and removed, you have to make sure that the previously used PersistentVolumeClaims
have been deleted.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
- A Kafka cluster with JBOD storage
Procedure
Edit the
spec.kafka.storage.volumes
property in theKafka
resource. Add the new volumes to thevolumes
array. For example, add the new volume with id2
:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... storage: type: jbod volumes: - id: 0 type: persistent-claim size: 100Gi deleteClaim: false - id: 1 type: persistent-claim size: 100Gi deleteClaim: false - id: 2 type: persistent-claim size: 100Gi deleteClaim: false # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
- Create new topics or reassign existing partitions to the new disks.
Additional resources
For more information about reassigning topics, see Section 3.1.24.2, “Partition reassignment”.
3.1.3.6. Removing volumes from JBOD storage
This procedure describes how to remove volumes from Kafka cluster configured to use JBOD storage. It cannot be applied to Kafka clusters configured to use any other storage type. The JBOD storage always has to contain at least one volume.
To avoid data loss, you have to move all partitions before removing the volumes.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
- A Kafka cluster with JBOD storage with two or more volumes
Procedure
- Reassign all partitions from the disks which are you going to remove. Any data in partitions still assigned to the disks which are going to be removed might be lost.
Edit the
spec.kafka.storage.volumes
property in theKafka
resource. Remove one or more volumes from thevolumes
array. For example, remove the volumes with ids1
and2
:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... storage: type: jbod volumes: - id: 0 type: persistent-claim size: 100Gi deleteClaim: false # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
For more information about reassigning topics, see Section 3.1.24.2, “Partition reassignment”.
3.1.4. Kafka broker replicas
A Kafka cluster can run with many brokers. You can configure the number of brokers used for the Kafka cluster in Kafka.spec.kafka.replicas
. The best number of brokers for your cluster has to be determined based on your specific use case.
3.1.4.1. Configuring the number of broker nodes
This procedure describes how to configure the number of Kafka broker nodes in a new cluster. It only applies to new clusters with no partitions. If your cluster already has topics defined, see Section 3.1.24, “Scaling clusters”.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
- A Kafka cluster with no topics defined yet
Procedure
Edit the
replicas
property in theKafka
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... replicas: 3 # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
If your cluster already has topics defined, see Section 3.1.24, “Scaling clusters”.
3.1.5. Kafka broker configuration
AMQ Streams allows you to customize the configuration of the Kafka brokers in your Kafka cluster. You can specify and configure most of the options listed in the "Broker Configs" section of the Apache Kafka documentation. You cannot configure options that are related to the following areas:
- Security (Encryption, Authentication, and Authorization)
- Listener configuration
- Broker ID configuration
- Configuration of log data directories
- Inter-broker communication
- Zookeeper connectivity
These options are automatically configured by AMQ Streams.
3.1.5.1. Kafka broker configuration
The config
property in Kafka.spec.kafka
contains Kafka broker configuration options as keys with values in one of the following JSON types:
- String
- Number
- Boolean
You can specify and configure all of the options in the "Broker Configs" section of the Apache Kafka documentation apart from those managed directly by AMQ Streams. Specifically, you are prevented from modifying all configuration options with keys equal to or starting with one of the following strings:
-
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
If the config
property specifies a restricted option, it is ignored and a warning message is printed to the Cluster Operator log file. All other supported options are passed to Kafka.
An example Kafka broker configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... config: num.partitions: 1 num.recovery.threads.per.data.dir: 1 default.replication.factor: 3 offsets.topic.replication.factor: 3 transaction.state.log.replication.factor: 3 transaction.state.log.min.isr: 1 log.retention.hours: 168 log.segment.bytes: 1073741824 log.retention.check.interval.ms: 300000 num.network.threads: 3 num.io.threads: 8 socket.send.buffer.bytes: 102400 socket.receive.buffer.bytes: 102400 socket.request.max.bytes: 104857600 group.initial.rebalance.delay.ms: 0 # ...
3.1.5.2. Configuring Kafka brokers
You can configure an existing Kafka broker, or create a new Kafka broker with a specified configuration.
Prerequisites
- An OpenShift cluster is available.
- The Cluster Operator is running.
Procedure
-
Open the YAML configuration file that contains the
Kafka
resource specifying the cluster deployment. In the
spec.kafka.config
property in theKafka
resource, enter one or more Kafka configuration settings. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... config: default.replication.factor: 3 offsets.topic.replication.factor: 3 transaction.state.log.replication.factor: 3 transaction.state.log.min.isr: 1 # ... zookeeper: # ...
Apply the new configuration to create or update the resource.
Use
oc apply
:oc apply -f kafka.yaml
where
kafka.yaml
is the YAML configuration file for the resource that you want to configure; for example,kafka-persistent.yaml
.
3.1.6. Kafka broker listeners
You can configure the listeners enabled in Kafka brokers. The following types of listener are supported:
- Plain listener on port 9092 (without encryption)
- TLS listener on port 9093 (with encryption)
- External listener on port 9094 for access from outside of OpenShift
OAuth 2.0
If you are using OAuth 2.0 token based authentication, you can configure the listeners to connect to your authorization server. For more information, see Using OAuth 2.0 token based authentication.
3.1.6.1. Kafka listeners
You can configure Kafka broker listeners using the listeners
property in the Kafka.spec.kafka
resource. The listeners
property contains three sub-properties:
-
plain
-
tls
-
external
Each listener will only be defined when the listeners
object has the given property.
An example of listeners
property with all listeners enabled
# ... listeners: plain: {} tls: {} external: type: loadbalancer # ...
An example of listeners
property with only the plain listener enabled
# ... listeners: plain: {} # ...
3.1.6.2. Configuring Kafka listeners
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
listeners
property in theKafka.spec.kafka
resource.An example configuration of the plain (unencrypted) listener without authentication:
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... listeners: plain: {} # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema, see
KafkaListeners
schema reference.
3.1.6.3. Listener authentication
The listener authentication
property is used to specify an authentication mechanism specific to that listener:
- Mutual TLS authentication (only on the listeners with TLS encryption)
- SCRAM-SHA authentication
If no authentication
property is specified then the listener does not authenticate clients which connect through that listener.
Authentication must be configured when using the User Operator to manage KafkaUsers
.
3.1.6.3.1. Authentication configuration for a listener
The following example shows:
-
A
plain
listener configured for SCRAM-SHA authentication -
A
tls
listener with mutual TLS authentication -
An
external
listener with mutual TLS authentication
An example showing listener authentication configuration
# ... listeners: plain: authentication: type: scram-sha-512 tls: authentication: type: tls external: type: loadbalancer tls: true authentication: type: tls # ...
3.1.6.3.2. Mutual TLS authentication
Mutual TLS authentication is always used for the communication between Kafka brokers and Zookeeper pods.
Mutual authentication or two-way authentication is when both the server and the client present certificates. AMQ Streams can configure Kafka to use TLS (Transport Layer Security) to provide encrypted communication between Kafka brokers and clients either with or without mutual authentication. When you configure mutual authentication, the broker authenticates the client and the client authenticates the broker.
TLS authentication is more commonly one-way, with one party authenticating the identity of another. For example, when HTTPS is used between a web browser and a web server, the server obtains proof of the identity of the browser.
3.1.6.3.2.1. When to use mutual TLS authentication for clients
Mutual TLS authentication is recommended for authenticating Kafka clients when:
- The client supports authentication using mutual TLS authentication
- It is necessary to use the TLS certificates rather than passwords
- You can reconfigure and restart client applications periodically so that they do not use expired certificates.
3.1.6.3.3. SCRAM-SHA authentication
SCRAM (Salted Challenge Response Authentication Mechanism) is an authentication protocol that can establish mutual authentication using passwords. AMQ Streams can configure Kafka to use SASL (Simple Authentication and Security Layer) SCRAM-SHA-512 to provide authentication on both unencrypted and TLS-encrypted client connections. TLS authentication is always used internally between Kafka brokers and Zookeeper nodes. When used with a TLS client connection, the TLS protocol provides encryption, but is not used for authentication.
The following properties of SCRAM make it safe to use SCRAM-SHA even on unencrypted connections:
- The passwords are not sent in the clear over the communication channel. Instead the client and the server are each challenged by the other to offer proof that they know the password of the authenticating user.
- The server and client each generate a new challenge for each authentication exchange. This means that the exchange is resilient against replay attacks.
3.1.6.3.3.1. Supported SCRAM credentials
AMQ Streams supports SCRAM-SHA-512 only. When a KafkaUser.spec.authentication.type
is configured with scram-sha-512
the User Operator will generate a random 12 character password consisting of upper and lowercase ASCII letters and numbers.
3.1.6.3.3.2. When to use SCRAM-SHA authentication for clients
SCRAM-SHA is recommended for authenticating Kafka clients when:
- The client supports authentication using SCRAM-SHA-512
- It is necessary to use passwords rather than the TLS certificates
- Authentication for unencrypted communication is required
3.1.6.4. External listeners
Use an external listener to expose your AMQ Streams Kafka cluster to a client outside an OpenShift environment.
Additional resources
3.1.6.4.1. Customizing advertised addresses on external listeners
By default, AMQ Streams tries to automatically determine the hostnames and ports that your Kafka cluster advertises to its clients. This is not sufficient in all situations, because the infrastructure on which AMQ Streams is running might not provide the right hostname or port through which Kafka can be accessed. You can customize the advertised hostname and port in the overrides
property of the external listener. AMQ Streams will then automatically configure the advertised address in the Kafka brokers and add it to the broker certificates so it can be used for TLS hostname verification. Overriding the advertised host and ports is available for all types of external listeners.
Example of an external listener configured with overrides for advertised addresses
# ... listeners: external: type: route authentication: type: tls overrides: brokers: - broker: 0 advertisedHost: example.hostname.0 advertisedPort: 12340 - broker: 1 advertisedHost: example.hostname.1 advertisedPort: 12341 - broker: 2 advertisedHost: example.hostname.2 advertisedPort: 12342 # ...
Additionally, you can specify the name of the bootstrap service. This name will be added to the broker certificates and can be used for TLS hostname verification. Adding the additional bootstrap address is available for all types of external listeners.
Example of an external listener configured with an additional bootstrap address
# ... listeners: external: type: route authentication: type: tls overrides: bootstrap: address: example.hostname # ...
3.1.6.4.2. Route external listeners
An external listener of type route
exposes Kafka using OpenShift Routes
and the HAProxy router.
route
is only supported on OpenShift
3.1.6.4.2.1. Exposing Kafka using OpenShift Routes
When exposing Kafka using OpenShift Routes
and the HAProxy router, a dedicated Route
is created for every Kafka broker pod. An additional Route
is created to serve as a Kafka bootstrap address. Kafka clients can use these Routes
to connect to Kafka on port 443.
TLS encryption is always used with Routes
.
By default, the route hosts are automatically assigned by OpenShift. However, you can override the assigned route hosts by specifying the requested hosts in the overrides
property. AMQ Streams will not perform any validation that the requested hosts are available; you must ensure that they are free and can be used.
Example of an external listener of type routes
configured with overrides for OpenShift route hosts
# ... listeners: external: type: route authentication: type: tls overrides: bootstrap: host: bootstrap.myrouter.com brokers: - broker: 0 host: broker-0.myrouter.com - broker: 1 host: broker-1.myrouter.com - broker: 2 host: broker-2.myrouter.com # ...
For more information on using Routes
to access Kafka, see Section 3.1.6.4.2.2, “Accessing Kafka using OpenShift routes”.
3.1.6.4.2.2. Accessing Kafka using OpenShift routes
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Deploy Kafka cluster with an external listener enabled and configured to the type
route
.An example configuration with an external listener configured to use
Routes
:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... listeners: external: type: route # ... # ... zookeeper: # ...
Create or update the resource.
oc apply -f your-file
Find the address of the bootstrap
Route
.oc get routes _cluster-name_-kafka-bootstrap -o=jsonpath='{.status.ingress[0].host}{"\n"}'
Use the address together with port 443 in your Kafka client as the bootstrap address.
Extract the public certificate of the broker certification authority
oc get secret _<cluster-name>_-cluster-ca-cert -o jsonpath='{.data.ca\.crt}' | base64 -d > ca.crt
Use the extracted certificate in your Kafka client to configure TLS connection. If you enabled any authentication, you will also need to configure SASL or TLS authentication.
Additional resources
-
For more information about the schema, see
KafkaListeners
schema reference.
3.1.6.4.3. Loadbalancer external listeners
External listeners of type loadbalancer
expose Kafka by using Loadbalancer
type Services
.
3.1.6.4.3.1. Exposing Kafka using loadbalancers
When exposing Kafka using Loadbalancer
type Services
, a new loadbalancer service is created for every Kafka broker pod. An additional loadbalancer is created to serve as a Kafka bootstrap address. Loadbalancers listen to connections on port 9094.
By default, TLS encryption is enabled. To disable it, set the tls
field to false
.
Example of an external listener of type loadbalancer
# ... listeners: external: type: loadbalancer authentication: type: tls # ...
For more information on using loadbalancers to access Kafka, see Section 3.1.6.4.3.4, “Accessing Kafka using loadbalancers”.
3.1.6.4.3.2. Customizing the DNS names of external loadbalancer listeners
On loadbalancer
listeners, you can use the dnsAnnotations
property to add additional annotations to the loadbalancer services. You can use these annotations to instrument DNS tooling such as External DNS, which automatically assigns DNS names to the loadbalancer services.
Example of an external listener of type loadbalancer
using dnsAnnotations
# ... listeners: external: type: loadbalancer authentication: type: tls overrides: bootstrap: dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-bootstrap.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" brokers: - broker: 0 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-broker-0.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" - broker: 1 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-broker-1.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" - broker: 2 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-broker-2.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" # ...
3.1.6.4.3.3. Customizing the loadbalancer IP addresses
On loadbalancer
listeners, you can use the loadBalancerIP
property to request a specific IP address when creating a loadbalancer. Use this property when you need to use a loadbalancer with a specific IP address. The loadBalancerIP
field is ignored if the cloud provider does not support the feature.
Example of an external listener of type loadbalancer
with specific loadbalancer IP address requests
# ... listeners: external: type: loadbalancer authentication: type: tls overrides: bootstrap: loadBalancerIP: 172.29.3.10 brokers: - broker: 0 loadBalancerIP: 172.29.3.1 - broker: 1 loadBalancerIP: 172.29.3.2 - broker: 2 loadBalancerIP: 172.29.3.3 # ...
3.1.6.4.3.4. Accessing Kafka using loadbalancers
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Deploy Kafka cluster with an external listener enabled and configured to the type
loadbalancer
.An example configuration with an external listener configured to use loadbalancers:
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... listeners: external: type: loadbalancer authentication: type: tls # ... # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Find the hostname of the bootstrap loadbalancer.
This can be done using
oc get
:oc get service cluster-name-kafka-external-bootstrap -o=jsonpath='{.status.loadBalancer.ingress[0].hostname}{"\n"}'
If no hostname was found (nothing was returned by the command), use the loadbalancer IP address.
This can be done using
oc get
:oc get service cluster-name-kafka-external-bootstrap -o=jsonpath='{.status.loadBalancer.ingress[0].ip}{"\n"}'
Use the hostname or IP address together with port 9094 in your Kafka client as the bootstrap address.
Unless TLS encryption was disabled, extract the public certificate of the broker certification authority.
This can be done using
oc get
:oc get secret cluster-name-cluster-ca-cert -o jsonpath='{.data.ca\.crt}' | base64 -d > ca.crt
Use the extracted certificate in your Kafka client to configure TLS connection. If you enabled any authentication, you will also need to configure SASL or TLS authentication.
Additional resources
-
For more information about the schema, see
KafkaListeners
schema reference.
3.1.6.4.4. Node Port external listeners
External listeners of type nodeport
expose Kafka by using NodePort
type Services
.
3.1.6.4.4.1. Exposing Kafka using node ports
When exposing Kafka using NodePort
type Services
, Kafka clients connect directly to the nodes of OpenShift. You must enable access to the ports on the OpenShift nodes for each client (for example, in firewalls or security groups). Each Kafka broker pod is then accessible on a separate port. Additional NodePort
type Service
is created to serve as a Kafka bootstrap address.
When configuring the advertised addresses for the Kafka broker pods, AMQ Streams uses the address of the node on which the given pod is running. When selecting the node address, the different address types are used with the following priority:
- ExternalDNS
- ExternalIP
- Hostname
- InternalDNS
- InternalIP
By default, TLS encryption is enabled. To disable it, set the tls
field to false
.
TLS hostname verification is not currently supported when exposing Kafka clusters using node ports.
By default, the port numbers used for the bootstrap and broker services are automatically assigned by OpenShift. However, you can override the assigned node ports by specifying the requested port numbers in the overrides
property. AMQ Streams does not perform any validation on the requested ports; you must ensure that they are free and available for use.
Example of an external listener configured with overrides for node ports
# ... listeners: external: type: nodeport tls: true authentication: type: tls overrides: bootstrap: nodePort: 32100 brokers: - broker: 0 nodePort: 32000 - broker: 1 nodePort: 32001 - broker: 2 nodePort: 32002 # ...
For more information on using node ports to access Kafka, see Section 3.1.6.4.4.3, “Accessing Kafka using node ports”.
3.1.6.4.4.2. Customizing the DNS names of external node port listeners
On nodeport
listeners, you can use the dnsAnnotations
property to add additional annotations to the nodeport services. You can use these annotations to instrument DNS tooling such as External DNS, which automatically assigns DNS names to the cluster nodes.
Example of an external listener of type nodeport
using dnsAnnotations
# ... listeners: external: type: nodeport tls: true authentication: type: tls overrides: bootstrap: dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-bootstrap.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" brokers: - broker: 0 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-broker-0.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" - broker: 1 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-broker-1.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" - broker: 2 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: kafka-broker-2.mydomain.com. external-dns.alpha.kubernetes.io/ttl: "60" # ...
3.1.6.4.4.3. Accessing Kafka using node ports
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Deploy Kafka cluster with an external listener enabled and configured to the type
nodeport
.An example configuration with an external listener configured to use node ports:
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... listeners: external: type: nodeport tls: true # ... # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Find the port number of the bootstrap service.
This can be done using
oc get
:oc get service cluster-name-kafka-external-bootstrap -o=jsonpath='{.spec.ports[0].nodePort}{"\n"}'
The port should be used in the Kafka bootstrap address.
Find the address of the OpenShift node.
This can be done using
oc get
:oc get node node-name -o=jsonpath='{range .status.addresses[*]}{.type}{"\t"}{.address}{"\n"}'
If several different addresses are returned, select the address type you want based on the following order:
- ExternalDNS
- ExternalIP
- Hostname
- InternalDNS
InternalIP
Use the address with the port found in the previous step in the Kafka bootstrap address.
Unless TLS encryption was disabled, extract the public certificate of the broker certification authority.
This can be done using
oc get
:oc get secret cluster-name-cluster-ca-cert -o jsonpath='{.data.ca\.crt}' | base64 -d > ca.crt
Use the extracted certificate in your Kafka client to configure TLS connection. If you enabled any authentication, you will also need to configure SASL or TLS authentication.
Additional resources
-
For more information about the schema, see
KafkaListeners
schema reference.
3.1.6.4.5. OpenShift Ingress external listeners
External listeners of type ingress
exposes Kafka by using Kubernetes Ingress
and the NGINX Ingress Controller for Kubernetes.
3.1.6.4.5.1. Exposing Kafka using Kubernetes Ingress
When exposing Kafka using using Kubernetes Ingress
and the NGINX Ingress Controller for Kubernetes, a dedicated Ingress
resource is created for every Kafka broker pod. An additional Ingress
resource is created to serve as a Kafka bootstrap address. Kafka clients can use these Ingress
resources to connect to Kafka on port 443.
External listeners using Ingress
have been currently tested only with the NGINX Ingress Controller for Kubernetes.
AMQ Streams uses the TLS passthrough feature of the NGINX Ingress Controller for Kubernetes. Make sure TLS passthrough is enabled in your NGINX Ingress Controller for Kubernetes deployment. For more information about enabling TLS passthrough see TLS passthrough documentation. Because it is using the TLS passthrough functionality, TLS encryption cannot be disabled when exposing Kafka using Ingress
.
The Ingress controller does not assign any hostnames automatically. You have to specify the hostnames which should be used by the bootstrap and per-broker services in the spec.kafka.listeners.external.configuration
section. You also have to make sure that the hostnames resolve to the Ingress endpoints. AMQ Streams will not perform any validation that the requested hosts are available and properly routed to the Ingress endpoints.
Example of an external listener of type ingress
# ... listeners: external: type: ingress authentication: type: tls configuration: bootstrap: host: bootstrap.myingress.com brokers: - broker: 0 host: broker-0.myingress.com - broker: 1 host: broker-1.myingress.com - broker: 2 host: broker-2.myingress.com # ...
For more information on using Ingress
to access Kafka, see Section 3.1.6.4.5.4, “Accessing Kafka using ingress”.
3.1.6.4.5.2. Configuring the Ingress
class
By default, the Ingress
class is set to nginx
. You can change the Ingress
class using the class
property.
Example of an external listener of type ingress
using Ingress
class nginx-internal
# ... listeners: external: type: ingress class: nginx-internal # ... # ...
3.1.6.4.5.3. Customizing the DNS names of external ingress listeners
On ingress
listeners, you can use the dnsAnnotations
property to add additional annotations to the ingress resources. You can use these annotations to instrument DNS tooling such as External DNS, which automatically assigns DNS names to the ingress resources.
Example of an external listener of type ingress
using dnsAnnotations
# ... listeners: external: type: ingress authentication: type: tls configuration: bootstrap: dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: bootstrap.myingress.com. external-dns.alpha.kubernetes.io/ttl: "60" host: bootstrap.myingress.com brokers: - broker: 0 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: broker-0.myingress.com. external-dns.alpha.kubernetes.io/ttl: "60" host: broker-0.myingress.com - broker: 1 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: broker-1.myingress.com. external-dns.alpha.kubernetes.io/ttl: "60" host: broker-1.myingress.com - broker: 2 dnsAnnotations: external-dns.alpha.kubernetes.io/hostname: broker-2.myingress.com. external-dns.alpha.kubernetes.io/ttl: "60" host: broker-2.myingress.com # ...
3.1.6.4.5.4. Accessing Kafka using ingress
This procedure shows how to access AMQ Streams Kafka clusters from outside of OpenShift using Ingress.
Prerequisites
- An OpenShift cluster
- Deployed NGINX Ingress Controller for Kubernetes with TLS passthrough enabled
- A running Cluster Operator
Procedure
Deploy Kafka cluster with an external listener enabled and configured to the type
ingress
.An example configuration with an external listener configured to use
Ingress
:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... listeners: external: type: ingress authentication: type: tls configuration: bootstrap: host: bootstrap.myingress.com brokers: - broker: 0 host: broker-0.myingress.com - broker: 1 host: broker-1.myingress.com - broker: 2 host: broker-2.myingress.com # ... zookeeper: # ...
-
Make sure the hosts in the
configuration
section properly resolve to the Ingress endpoints. Create or update the resource.
oc apply -f your-file
Extract the public certificate of the broker certificate authority
oc get secret cluster-name-cluster-ca-cert -o jsonpath='{.data.ca\.crt}' | base64 -d > ca.crt
- Use the extracted certificate in your Kafka client to configure the TLS connection. If you enabled any authentication, you will also need to configure SASL or TLS authentication. Connect with your client to the host you specified in the configuration on port 443.
Additional resources
-
For more information about the schema, see
KafkaListeners
schema reference.
3.1.6.5. Network policies
AMQ Streams automatically creates a NetworkPolicy
resource for every listener that is enabled on a Kafka broker. By default, a NetworkPolicy
grants access to a listener to all applications and namespaces.
If you want to restrict access to a listener at the network level to only selected applications or namespaces, use the networkPolicyPeers
field.
Use network policies in conjunction with authentication and authorization.
Each listener can have a different networkPolicyPeers
configuration.
3.1.6.5.1. Network policy configuration for a listener
The following example shows a networkPolicyPeers
configuration for a plain
and a tls
listener:
# ... listeners: plain: authentication: type: scram-sha-512 networkPolicyPeers: - podSelector: matchLabels: app: kafka-sasl-consumer - podSelector: matchLabels: app: kafka-sasl-producer tls: authentication: type: tls networkPolicyPeers: - namespaceSelector: matchLabels: project: myproject - namespaceSelector: matchLabels: project: myproject2 # ...
In the example:
-
Only application pods matching the labels
app: kafka-sasl-consumer
andapp: kafka-sasl-producer
can connect to theplain
listener. The application pods must be running in the same namespace as the Kafka broker. -
Only application pods running in namespaces matching the labels
project: myproject
andproject: myproject2
can connect to thetls
listener.
The syntax of the networkPolicyPeers
field is the same as the from
field in NetworkPolicy
resources. For more information about the schema, see NetworkPolicyPeer API reference and the KafkaListeners
schema reference.
Your configuration of OpenShift must support ingress NetworkPolicies in order to use network policies in AMQ Streams.
3.1.6.5.2. Restricting access to Kafka listeners using networkPolicyPeers
You can restrict access to a listener to only selected applications by using the networkPolicyPeers
field.
Prerequisites
- An OpenShift cluster with support for Ingress NetworkPolicies.
- The Cluster Operator is running.
Procedure
-
Open the
Kafka
resource. In the
networkPolicyPeers
field, define the application pods or namespaces that will be allowed to access the Kafka cluster.For example, to configure a
tls
listener to allow connections only from application pods with the labelapp
set tokafka-client
:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... listeners: tls: networkPolicyPeers: - podSelector: matchLabels: app: kafka-client # ... zookeeper: # ...
Create or update the resource.
Use
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema, see NetworkPolicyPeer API reference and the
KafkaListeners
schema reference.
3.1.7. Authentication and Authorization
AMQ Streams supports authentication and authorization. Authentication can be configured independently for each listener. Authorization is always configured for the whole Kafka cluster.
3.1.7.1. Authentication
Authentication is configured as part of the listener configuration in the authentication
property. The authentication mechanism is defined by the type
field.
When the authentication
property is missing, no authentication is enabled on a given listener. The listener will accept all connections without authentication.
Supported authentication mechanisms:
- TLS client authentication
- SASL SCRAM-SHA-512
- OAuth 2.0 token based authentication
3.1.7.1.1. TLS client authentication
TLS Client authentication is enabled by specifying the type
as tls
. The TLS client authentication is supported only on the tls
listener.
An example of authentication
with type tls
# ... authentication: type: tls # ...
3.1.7.2. Configuring authentication in Kafka brokers
Prerequisites
- An OpenShift cluster is available.
- The Cluster Operator is running.
Procedure
-
Open the YAML configuration file that contains the
Kafka
resource specifying the cluster deployment. In the
spec.kafka.listeners
property in theKafka
resource, add theauthentication
field to the listeners for which you want to enable authentication. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... listeners: tls: authentication: type: tls # ... zookeeper: # ...
Apply the new configuration to create or update the resource.
Use
oc apply
:oc apply -f kafka.yaml
where
kafka.yaml
is the YAML configuration file for the resource that you want to configure; for example,kafka-persistent.yaml
.
Additional resources
- For more information about the supported authentication mechanisms, see authentication reference.
-
For more information about the schema for
Kafka
, seeKafka
schema reference.
3.1.7.3. Authorization
You configure authorization for Kafka brokers using the authorization
property in the Kafka.spec.kafka
resource. If the authorization
property is missing, no authorization is enabled. When enabled, authorization is applied to all enabled listeners. The authorization method is defined in the type
field; only Simple authorization is currently supported.
You can optionally designate a list of super users in the superUsers
field.
3.1.7.3.1. Simple authorization
Simple authorization in AMQ Streams uses the SimpleAclAuthorizer
plugin, the default Access Control Lists (ACLs) authorization plugin provided with Apache Kafka. ACLs allow you to define which users have access to which resources at a granular level. To enable simple authorization, set the type
field to simple
.
An example of Simple authorization
# ... authorization: type: simple # ...
3.1.7.3.2. Super users
Super users can access all resources in your Kafka cluster regardless of any access restrictions defined in ACLs. To designate super users for a Kafka cluster, enter a list of user principles in the superUsers
field. If a user uses TLS Client Authentication, the username will be the common name from their certificate subject prefixed with CN=
.
An example of designating super users
# ... authorization: type: simple superUsers: - CN=fred - sam - CN=edward # ...
The super.user
configuration option in the config
property in Kafka.spec.kafka
is ignored. Designate super users in the authorization
property instead. For more information, see Kafka broker configuration.
3.1.7.4. Configuring authorization in Kafka brokers
Configure authorization and designate super users for a particular Kafka broker.
Prerequisites
- An OpenShift cluster
- The Cluster Operator is running
Procedure
Add or edit the
authorization
property in theKafka.spec.kafka
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... authorization: type: simple superUsers: - CN=fred - sam - CN=edward # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
- For more information about the supported authorization methods, see authorization reference.
-
For more information about the schema for
Kafka
, seeKafka
schema reference. - For more information about configuring user authentication, see Kafka User resource.
3.1.8. Zookeeper replicas
Zookeeper clusters or ensembles usually run with an odd number of nodes, typically three, five, or seven.
The majority of nodes must be available in order to maintain an effective quorum. If the Zookeeper cluster loses its quorum, it will stop responding to clients and the Kafka brokers will stop working. Having a stable and highly available Zookeeper cluster is crucial for AMQ Streams.
- Three-node cluster
- A three-node Zookeeper cluster requires at least two nodes to be up and running in order to maintain the quorum. It can tolerate only one node being unavailable.
- Five-node cluster
- A five-node Zookeeper cluster requires at least three nodes to be up and running in order to maintain the quorum. It can tolerate two nodes being unavailable.
- Seven-node cluster
- A seven-node Zookeeper cluster requires at least four nodes to be up and running in order to maintain the quorum. It can tolerate three nodes being unavailable.
For development purposes, it is also possible to run Zookeeper with a single node.
Having more nodes does not necessarily mean better performance, as the costs to maintain the quorum will rise with the number of nodes in the cluster. Depending on your availability requirements, you can decide for the number of nodes to use.
3.1.8.1. Number of Zookeeper nodes
The number of Zookeeper nodes can be configured using the replicas
property in Kafka.spec.zookeeper
.
An example showing replicas configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... replicas: 3 # ...
3.1.8.2. Changing the number of Zookeeper replicas
Prerequisites
- An OpenShift cluster is available.
- The Cluster Operator is running.
Procedure
-
Open the YAML configuration file that contains the
Kafka
resource specifying the cluster deployment. In the
spec.zookeeper.replicas
property in theKafka
resource, enter the number of replicated Zookeeper servers. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... replicas: 3 # ...
Apply the new configuration to create or update the resource.
Use
oc apply
:oc apply -f kafka.yaml
where
kafka.yaml
is the YAML configuration file for the resource that you want to configure; for example,kafka-persistent.yaml
.
3.1.9. Zookeeper configuration
AMQ Streams allows you to customize the configuration of Apache Zookeeper nodes. You can specify and configure most of the options listed in the Zookeeper documentation.
Options which cannot be configured are those related to the following areas:
- Security (Encryption, Authentication, and Authorization)
- Listener configuration
- Configuration of data directories
- Zookeeper cluster composition
These options are automatically configured by AMQ Streams.
3.1.9.1. Zookeeper configuration
Zookeeper nodes are configured using the config
property in Kafka.spec.zookeeper
. This property contains the Zookeeper configuration options as keys. The values can be described using one of the following JSON types:
- String
- Number
- Boolean
Users can specify and configure the options listed in Zookeeper documentation with the exception of those options which are managed directly by AMQ Streams. Specifically, all configuration options with keys equal to or starting with one of the following strings are forbidden:
-
server.
-
dataDir
-
dataLogDir
-
clientPort
-
authProvider
-
quorum.auth
-
requireClientAuthScheme
When one of the forbidden options is present in the config
property, it is ignored and a warning message is printed to the Custer Operator log file. All other options are passed to Zookeeper.
The Cluster Operator does not validate keys or values in the provided config
object. When invalid configuration is provided, the Zookeeper cluster might not start or might become unstable. In such cases, the configuration in the Kafka.spec.zookeeper.config
object should be fixed and the Cluster Operator will roll out the new configuration to all Zookeeper nodes.
Selected options have default values:
-
timeTick
with default value2000
-
initLimit
with default value5
-
syncLimit
with default value2
-
autopurge.purgeInterval
with default value1
These options will be automatically configured when they are not present in the Kafka.spec.zookeeper.config
property.
An example showing Zookeeper configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... zookeeper: # ... config: autopurge.snapRetainCount: 3 autopurge.purgeInterval: 1 # ...
3.1.9.2. Configuring Zookeeper
Prerequisites
- An OpenShift cluster is available.
- The Cluster Operator is running.
Procedure
-
Open the YAML configuration file that contains the
Kafka
resource specifying the cluster deployment. In the
spec.zookeeper.config
property in theKafka
resource, enter one or more Zookeeper configuration settings. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... zookeeper: # ... config: autopurge.snapRetainCount: 3 autopurge.purgeInterval: 1 # ...
Apply the new configuration to create or update the resource.
Use
oc apply
:oc apply -f kafka.yaml
where
kafka.yaml
is the YAML configuration file for the resource that you want to configure; for example,kafka-persistent.yaml
.
3.1.10. Zookeeper connection
Zookeeper services are secured with encryption and authentication and are not intended to be used by external applications that are not part of AMQ Streams.
However, if you want to use Kafka CLI tools that require a connection to Zookeeper, such as the kafka-topics
tool, you can use a terminal inside a Kafka container and connect to the local end of the TLS tunnel to Zookeeper by using localhost:2181
as the Zookeeper address.
3.1.10.1. Connecting to Zookeeper from a terminal
Open a terminal inside a Kafka container to use Kafka CLI tools that require a Zookeeper connection.
Prerequisites
- An OpenShift cluster is available.
- A kafka cluster is running.
- The Cluster Operator is running.
Procedure
Open the terminal using the OpenShift console or run the
exec
command from your CLI.For example:
oc exec -ti my-cluster-kafka-0 -- bin/kafka-topics.sh --list --zookeeper localhost:2181
Be sure to use
localhost:2181
.You can now run Kafka commands to Zookeeper.
3.1.11. Entity Operator
The Entity Operator is responsible for managing Kafka-related entities in a running Kafka cluster.
The Entity Operator comprises the:
- Topic Operator to manage Kafka topics
- User Operator to manage Kafka users
Through Kafka
resource configuration, the Cluster Operator can deploy the Entity Operator, including one or both operators, when deploying a Kafka cluster.
When deployed, the Entity Operator contains the operators according to the deployment configuration.
The operators are automatically configured to manage the topics and users of the Kafka cluster.
3.1.11.1. Configuration
The Entity Operator can be configured using the entityOperator
property in Kafka.spec
The entityOperator
property supports several sub-properties:
-
tlsSidecar
-
topicOperator
-
userOperator
-
template
The tlsSidecar
property can be used to configure the TLS sidecar container which is used to communicate with Zookeeper. For more details about configuring the TLS sidecar, see Section 3.1.19, “TLS sidecar”.
The template
property can be used to configure details of the Entity Operator pod, such as labels, annotations, affinity, tolerations and so on.
The topicOperator
property contains the configuration of the Topic Operator. When this option is missing, the Entity Operator is deployed without the Topic Operator.
The userOperator
property contains the configuration of the User Operator. When this option is missing, the Entity Operator is deployed without the User Operator.
Example of basic configuration enabling both operators
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... entityOperator: topicOperator: {} userOperator: {}
When both topicOperator
and userOperator
properties are missing, the Entity Operator will be not deployed.
3.1.11.1.1. Topic Operator
Topic Operator deployment can be configured using additional options inside the topicOperator
object. The following options are supported:
watchedNamespace
-
The OpenShift namespace in which the topic operator watches for
KafkaTopics
. Default is the namespace where the Kafka cluster is deployed. reconciliationIntervalSeconds
-
The interval between periodic reconciliations in seconds. Default
90
. zookeeperSessionTimeoutSeconds
-
The Zookeeper session timeout in seconds. Default
20
. topicMetadataMaxAttempts
-
The number of attempts at getting topic metadata from Kafka. The time between each attempt is defined as an exponential back-off. Consider increasing this value when topic creation could take more time due to the number of partitions or replicas. Default
6
. image
-
The
image
property can be used to configure the container image which will be used. For more details about configuring custom container images, see Section 3.1.18, “Container images”. resources
-
The
resources
property configures the amount of resources allocated to the Topic Operator. For more details about resource request and limit configuration, see Section 3.1.12, “CPU and memory resources”. logging
The
logging
property configures the logging of the Topic Operator.The Topic Operator has its own configurable logger:
-
rootLogger.level
-
Example of Topic Operator configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... entityOperator: # ... topicOperator: watchedNamespace: my-topic-namespace reconciliationIntervalSeconds: 60 # ...
3.1.11.1.2. User Operator
User Operator deployment can be configured using additional options inside the userOperator
object. The following options are supported:
watchedNamespace
-
The OpenShift namespace in which the topic operator watches for
KafkaUsers
. Default is the namespace where the Kafka cluster is deployed. reconciliationIntervalSeconds
-
The interval between periodic reconciliations in seconds. Default
120
. zookeeperSessionTimeoutSeconds
-
The Zookeeper session timeout in seconds. Default
6
. image
-
The
image
property can be used to configure the container image which will be used. For more details about configuring custom container images, see Section 3.1.18, “Container images”. resources
-
The
resources
property configures the amount of resources allocated to the User Operator. For more details about resource request and limit configuration, see Section 3.1.12, “CPU and memory resources”. logging
The
logging
property configures the logging of the User Operator.The User Operator has its own configurable logger:
-
rootLogger.level
-
Example of Topic Operator configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... entityOperator: # ... userOperator: watchedNamespace: my-user-namespace reconciliationIntervalSeconds: 60 # ...
3.1.11.2. Configuring Entity Operator
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
entityOperator
property in theKafka
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... entityOperator: topicOperator: watchedNamespace: my-topic-namespace reconciliationIntervalSeconds: 60 userOperator: watchedNamespace: my-user-namespace reconciliationIntervalSeconds: 60
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.12. CPU and memory resources
For every deployed container, AMQ Streams allows you to request specific resources and define the maximum consumption of those resources.
AMQ Streams supports two types of resources:
- CPU
- Memory
AMQ Streams uses the OpenShift syntax for specifying CPU and memory resources.
3.1.12.1. Resource limits and requests
Resource limits and requests are configured using the resources
property in the following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
Additional resources
- For more information about managing computing resources on OpenShift, see Managing Compute Resources for Containers.
3.1.12.1.1. Resource requests
Requests specify the resources to reserve for a given container. Reserving the resources ensures that they are always available.
If the resource request is for more than the available free resources in the OpenShift cluster, the pod is not scheduled.
Resources requests are specified in the requests
property. Resources requests currently supported by AMQ Streams:
-
cpu
-
memory
A request may be configured for one or more supported resources.
Example resource request configuration with all resources
# ... resources: requests: cpu: 12 memory: 64Gi # ...
3.1.12.1.2. Resource limits
Limits specify the maximum resources that can be consumed by a given container. The limit is not reserved and might not always be available. A container can use the resources up to the limit only when they are available. Resource limits should be always higher than the resource requests.
Resource limits are specified in the limits
property. Resource limits currently supported by AMQ Streams:
-
cpu
-
memory
A resource may be configured for one or more supported limits.
Example resource limits configuration
# ... resources: limits: cpu: 12 memory: 64Gi # ...
3.1.12.1.3. Supported CPU formats
CPU requests and limits are supported in the following formats:
-
Number of CPU cores as integer (
5
CPU core) or decimal (2.5
CPU core). -
Number or millicpus / millicores (
100m
) where 1000 millicores is the same1
CPU core.
Example CPU units
# ... resources: requests: cpu: 500m limits: cpu: 2.5 # ...
The computing power of 1 CPU core may differ depending on the platform where OpenShift is deployed.
Additional resources
- For more information on CPU specification, see the Meaning of CPU.
3.1.12.1.4. Supported memory formats
Memory requests and limits are specified in megabytes, gigabytes, mebibytes, and gibibytes.
-
To specify memory in megabytes, use the
M
suffix. For example1000M
. -
To specify memory in gigabytes, use the
G
suffix. For example1G
. -
To specify memory in mebibytes, use the
Mi
suffix. For example1000Mi
. -
To specify memory in gibibytes, use the
Gi
suffix. For example1Gi
.
An example of using different memory units
# ... resources: requests: memory: 512Mi limits: memory: 2Gi # ...
Additional resources
- For more details about memory specification and additional supported units, see Meaning of memory.
3.1.12.2. Configuring resource requests and limits
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
resources
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... resources: requests: cpu: "8" memory: 64Gi limits: cpu: "12" memory: 128Gi # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema, see
Resources
schema reference.
3.1.13. Logging
This section provides information on loggers and how to configure log levels.
You can set the log levels by specifying the loggers and their levels directly (inline) or use a custom (external) config map.
3.1.13.1. Kafka and Zookeeper loggers
Kafka has its own configurable loggers:
-
kafka.root.logger.level
-
log4j.logger.org.I0Itec.zkclient.ZkClient
-
log4j.logger.org.apache.zookeeper
-
log4j.logger.kafka
-
log4j.logger.org.apache.kafka
-
log4j.logger.kafka.request.logger
-
log4j.logger.kafka.network.Processor
-
log4j.logger.kafka.server.KafkaApis
-
log4j.logger.kafka.network.RequestChannel$
-
log4j.logger.kafka.controller
-
log4j.logger.kafka.log.LogCleaner
-
log4j.logger.state.change.logger
-
log4j.logger.kafka.authorizer.logger
Zookeeper has its own logger as well:
-
zookeeper.root.logger
3.1.13.2. Specifying inline logging
Procedure
Edit the YAML file to specify the loggers and logging level for the required components.
For example, the logging level here is set to INFO:
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... logging: type: inline loggers: logger.name: "INFO" # ... zookeeper: # ... logging: type: inline loggers: logger.name: "INFO" # ... entityOperator: # ... topicOperator: # ... logging: type: inline loggers: logger.name: "INFO" # ... # ... userOperator: # ... logging: type: inline loggers: logger.name: "INFO" # ...
You can set the log level to INFO, ERROR, WARN, TRACE, DEBUG, FATAL or OFF.
For more information about the log levels, see the log4j manual.
Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
3.1.13.3. Specifying an external ConfigMap for logging
Procedure
Edit the YAML file to specify the name of the
ConfigMap
to use for the required components. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... logging: type: external name: customConfigMap # ...
Remember to place your custom ConfigMap under the
log4j.properties
orlog4j2.properties
key.Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
Garbage collector (GC) logging can also be enabled (or disabled). For more information on GC, see Section 3.1.17.1, “JVM configuration”
3.1.14. Kafka rack awareness
The rack awareness feature in AMQ Streams helps to spread the Kafka broker pods and Kafka topic replicas across different racks. Enabling rack awareness helps to improve availability of Kafka brokers and the topics they are hosting.
"Rack" might represent an availability zone, data center, or an actual rack in your data center.
3.1.14.1. Configuring rack awareness in Kafka brokers
Kafka rack awareness can be configured in the rack
property of Kafka.spec.kafka
. The rack
object has one mandatory field named topologyKey
. This key needs to match one of the labels assigned to the OpenShift cluster nodes. The label is used by OpenShift when scheduling the Kafka broker pods to nodes. If the OpenShift cluster is running on a cloud provider platform, that label should represent the availability zone where the node is running. Usually, the nodes are labeled with failure-domain.beta.kubernetes.io/zone
that can be easily used as the topologyKey
value. This has the effect of spreading the broker pods across zones, and also setting the brokers' broker.rack
configuration parameter inside Kafka broker.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
- Consult your OpenShift administrator regarding the node label that represents the zone / rack into which the node is deployed.
Edit the
rack
property in theKafka
resource using the label as the topology key.apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... rack: topologyKey: failure-domain.beta.kubernetes.io/zone # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
- For information about Configuring init container image for Kafka rack awareness, see Section 3.1.18, “Container images”.
3.1.15. Healthchecks
Healthchecks are periodical tests which verify the health of an application. When a Healthcheck probe fails, OpenShift assumes that the application is not healthy and attempts to fix it.
OpenShift supports two types of Healthcheck probes:
- Liveness probes
- Readiness probes
For more details about the probes, see Configure Liveness and Readiness Probes. Both types of probes are used in AMQ Streams components.
Users can configure selected options for liveness and readiness probes.
3.1.15.1. Healthcheck configurations
Liveness and readiness probes can be configured using the livenessProbe
and readinessProbe
properties in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Both livenessProbe
and readinessProbe
support the following options:
-
initialDelaySeconds
-
timeoutSeconds
-
periodSeconds
-
successThreshold
-
failureThreshold
For more information about the livenessProbe
and readinessProbe
options, see Section C.34, “Probe
schema reference”.
An example of liveness and readiness probe configuration
# ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ...
3.1.15.2. Configuring healthchecks
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
livenessProbe
orreadinessProbe
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.16. Prometheus metrics
AMQ Streams supports Prometheus metrics using Prometheus JMX exporter to convert the JMX metrics supported by Apache Kafka and Zookeeper to Prometheus metrics. When metrics are enabled, they are exposed on port 9404.
For more information about configuring Prometheus and Grafana, see Metrics.
3.1.16.1. Metrics configuration
Prometheus metrics are enabled by configuring the metrics
property in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
When the metrics
property is not defined in the resource, the Prometheus metrics will be disabled. To enable Prometheus metrics export without any further configuration, you can set it to an empty object ({}
).
Example of enabling metrics without any further configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... metrics: {} # ... zookeeper: # ...
The metrics
property might contain additional configuration for the Prometheus JMX exporter.
Example of enabling metrics with additional Prometheus JMX Exporter configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... metrics: lowercaseOutputName: true rules: - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*><>Count" name: "kafka_server_$1_$2_total" - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*, topic=(.+)><>Count" name: "kafka_server_$1_$2_total" labels: topic: "$3" # ... zookeeper: # ...
3.1.16.2. Configuring Prometheus metrics
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
metrics
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... metrics: lowercaseOutputName: true # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.17. JVM Options
The following components of AMQ Streams run inside a Virtual Machine (VM):
- Apache Kafka
- Apache Zookeeper
- Apache Kafka Connect
- Apache Kafka Mirror Maker
- AMQ Streams Kafka Bridge
JVM configuration options optimize the performance for different platforms and architectures. AMQ Streams allows you to configure some of these options.
3.1.17.1. JVM configuration
JVM options can be configured using the jvmOptions
property in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Only a selected subset of available JVM options can be configured. The following options are supported:
-Xms and -Xmx
-Xms
configures the minimum initial allocation heap size when the JVM starts. -Xmx
configures the maximum heap size.
The units accepted by JVM settings such as -Xmx
and -Xms
are those accepted by the JDK java
binary in the corresponding image. Accordingly, 1g
or 1G
means 1,073,741,824 bytes, and Gi
is not a valid unit suffix. This is in contrast to the units used for memory requests and limits, which follow the OpenShift convention where 1G
means 1,000,000,000 bytes, and 1Gi
means 1,073,741,824 bytes
The default values used for -Xms
and -Xmx
depends on whether there is a memory request limit configured for the container:
- If there is a memory limit then the JVM’s minimum and maximum memory will be set to a value corresponding to the limit.
-
If there is no memory limit then the JVM’s minimum memory will be set to
128M
and the JVM’s maximum memory will not be defined. This allows for the JVM’s memory to grow as-needed, which is ideal for single node environments in test and development.
Setting -Xmx
explicitly requires some care:
-
The JVM’s overall memory usage will be approximately 4 × the maximum heap, as configured by
-Xmx
. -
If
-Xmx
is set without also setting an appropriate OpenShift memory limit, it is possible that the container will be killed should the OpenShift node experience memory pressure (from other Pods running on it). -
If
-Xmx
is set without also setting an appropriate OpenShift memory request, it is possible that the container will be scheduled to a node with insufficient memory. In this case, the container will not start but crash (immediately if-Xms
is set to-Xmx
, or some later time if not).
When setting -Xmx
explicitly, it is recommended to:
- set the memory request and the memory limit to the same value,
-
use a memory request that is at least 4.5 × the
-Xmx
, -
consider setting
-Xms
to the same value as-Xmx
.
Containers doing lots of disk I/O (such as Kafka broker containers) will need to leave some memory available for use as operating system page cache. On such containers, the requested memory should be significantly higher than the memory used by the JVM.
Example fragment configuring -Xmx
and -Xms
# ... jvmOptions: "-Xmx": "2g" "-Xms": "2g" # ...
In the above example, the JVM will use 2 GiB (=2,147,483,648 bytes) for its heap. Its total memory usage will be approximately 8GiB.
Setting the same value for initial (-Xms
) and maximum (-Xmx
) heap sizes avoids the JVM having to allocate memory after startup, at the cost of possibly allocating more heap than is really needed. For Kafka and Zookeeper pods such allocation could cause unwanted latency. For Kafka Connect avoiding over allocation may be the most important concern, especially in distributed mode where the effects of over-allocation will be multiplied by the number of consumers.
-server
-server
enables the server JVM. This option can be set to true or false.
Example fragment configuring -server
# ... jvmOptions: "-server": true # ...
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
-XX
-XX
object can be used for configuring advanced runtime options of a JVM. The -server
and -XX
options are used to configure the KAFKA_JVM_PERFORMANCE_OPTS
option of Apache Kafka.
Example showing the use of the -XX
object
jvmOptions: "-XX": "UseG1GC": true "MaxGCPauseMillis": 20 "InitiatingHeapOccupancyPercent": 35 "ExplicitGCInvokesConcurrent": true "UseParNewGC": false
The example configuration above will result in the following JVM options:
-XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -XX:-UseParNewGC
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
3.1.17.1.1. Garbage collector logging
The jvmOptions
section also allows you to enable and disable garbage collector (GC) logging. GC logging is enabled by default. To disable it, set the gcLoggingEnabled
property as follows:
Example of disabling GC logging
# ... jvmOptions: gcLoggingEnabled: false # ...
3.1.17.2. Configuring JVM options
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
jvmOptions
property in theKafka
,KafkaConnect
,KafkaConnectS2I
,KafkaMirrorMaker
, orKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... jvmOptions: "-Xmx": "8g" "-Xms": "8g" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.18. Container images
AMQ Streams allows you to configure container images which will be used for its components. Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such a case, you should either copy the AMQ Streams images or build them from the source. If the configured image is not compatible with AMQ Streams images, it might not work properly.
3.1.18.1. Container image configurations
Container image which should be used for given components can be specified using the image
property in:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
3.1.18.1.1. Configuring the Kafka.spec.kafka.image
property
The Kafka.spec.kafka.image
property functions differently from the others, because AMQ Streams supports multiple versions of Kafka, each requiring the own image. The STRIMZI_KAFKA_IMAGES
environment variable of the Cluster Operator configuration is used to provide a mapping between Kafka versions and the corresponding images. This is used in combination with the Kafka.spec.kafka.image
and Kafka.spec.kafka.version
properties as follows:
-
If neither
Kafka.spec.kafka.image
norKafka.spec.kafka.version
are given in the custom resource then theversion
will default to the Cluster Operator’s default Kafka version, and the image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
If
Kafka.spec.kafka.image
is given butKafka.spec.kafka.version
is not then the given image will be used and theversion
will be assumed to be the Cluster Operator’s default Kafka version. -
If
Kafka.spec.kafka.version
is given butKafka.spec.kafka.image
is not then image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
Both
Kafka.spec.kafka.version
andKafka.spec.kafka.image
are given the given image will be used, and it will be assumed to contain a Kafka broker with the given version.
It is best to provide just Kafka.spec.kafka.version
and leave the Kafka.spec.kafka.image
property unspecified. This reduces the chances of making a mistake in configuring the Kafka
resource. If you need to change the images used for different versions of Kafka, it is better to configure the Cluster Operator’s STRIMZI_KAFKA_IMAGES
environment variable.
3.1.18.1.2. Configuring the image
property in other resources
For the image
property in the other custom resources, the given value will be used during deployment. If the image
property is missing, the image
specified in the Cluster Operator configuration will be used. If the image
name is not defined in the Cluster Operator configuration, then the default value will be used.
For Kafka broker TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_KAFKA_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper nodes:
-
Container image specified in the
STRIMZI_DEFAULT_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper node TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Topic Operator:
-
Container image specified in the
STRIMZI_DEFAULT_TOPIC_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For User Operator:
-
Container image specified in the
STRIMZI_DEFAULT_USER_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For Entity Operator TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ENTITY_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect with Source2image support:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_S2I_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such case, you should either copy the AMQ Streams images or build them from source. In case the configured image is not compatible with AMQ Streams images, it might not work properly.
Example of container image configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
3.1.18.2. Configuring container images
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
image
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.19. TLS sidecar
A sidecar is a container that runs in a pod but serves a supporting purpose. In AMQ Streams, the TLS sidecar uses TLS to encrypt and decrypt all communication between the various components and Zookeeper. Zookeeper does not have native TLS support.
The TLS sidecar is used in:
- Kafka brokers
- Zookeeper nodes
- Entity Operator
3.1.19.1. TLS sidecar configuration
The TLS sidecar can be configured using the tlsSidecar
property in:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
Kafka.spec.entityOperator
The TLS sidecar supports the following additional options:
-
image
-
resources
-
logLevel
-
readinessProbe
-
livenessProbe
The resources
property can be used to specify the memory and CPU resources allocated for the TLS sidecar.
The image
property can be used to configure the container image which will be used. For more details about configuring custom container images, see Section 3.1.18, “Container images”.
The logLevel
property is used to specify the logging level. Following logging levels are supported:
- emerg
- alert
- crit
- err
- warning
- notice
- info
- debug
The default value is notice.
For more information about configuring the readinessProbe
and livenessProbe
properties for the healthchecks, see Section 3.1.15.1, “Healthcheck configurations”.
Example of TLS sidecar configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... tlsSidecar: image: my-org/my-image:latest resources: requests: cpu: 200m memory: 64Mi limits: cpu: 500m memory: 128Mi logLevel: debug readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ... zookeeper: # ...
3.1.19.2. Configuring TLS sidecar
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
tlsSidecar
property in theKafka
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... tlsSidecar: resources: requests: cpu: 200m memory: 64Mi limits: cpu: 500m memory: 128Mi # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.20. Configuring pod scheduling
When two applications are scheduled to the same OpenShift node, both applications might use the same resources like disk I/O and impact performance. That can lead to performance degradation. Scheduling Kafka pods in a way that avoids sharing nodes with other critical workloads, using the right nodes or dedicated a set of nodes only for Kafka are the best ways how to avoid such problems.
3.1.20.1. Scheduling pods based on other applications
3.1.20.1.1. Avoid critical applications to share the node
Pod anti-affinity can be used to ensure that critical applications are never scheduled on the same disk. When running Kafka cluster, it is recommended to use pod anti-affinity to ensure that the Kafka brokers do not share the nodes with other workloads like databases.
3.1.20.1.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.1.20.1.3. Configuring pod anti-affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
affinity
property in the resource specifying the cluster deployment. Use labels to specify the pods which should not be scheduled on the same nodes. ThetopologyKey
should be set tokubernetes.io/hostname
to specify that the selected pods should not be scheduled on nodes with the same hostname. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: podAntiAffinity: requiredDuringSchedulingIgnoredDuringExecution: - labelSelector: matchExpressions: - key: application operator: In values: - postgresql - mongodb topologyKey: "kubernetes.io/hostname" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.20.2. Scheduling pods to specific nodes
3.1.20.2.1. Node scheduling
The OpenShift cluster usually consists of many different types of worker nodes. Some are optimized for CPU heavy workloads, some for memory, while other might be optimized for storage (fast local SSDs) or network. Using different nodes helps to optimize both costs and performance. To achieve the best possible performance, it is important to allow scheduling of AMQ Streams components to use the right nodes.
OpenShift uses node affinity to schedule workloads onto specific nodes. Node affinity allows you to create a scheduling constraint for the node on which the pod will be scheduled. The constraint is specified as a label selector. You can specify the label using either the built-in node label like beta.kubernetes.io/instance-type
or custom labels to select the right node.
3.1.20.2.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.1.20.2.3. Configuring node affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Label the nodes where AMQ Streams components should be scheduled.
This can be done using
oc label
:oc label node your-node node-type=fast-network
Alternatively, some of the existing labels might be reused.
Edit the
affinity
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: node-type operator: In values: - fast-network # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.20.3. Using dedicated nodes
3.1.20.3.1. Dedicated nodes
Cluster administrators can mark selected OpenShift nodes as tainted. Nodes with taints are excluded from regular scheduling and normal pods will not be scheduled to run on them. Only services which can tolerate the taint set on the node can be scheduled on it. The only other services running on such nodes will be system services such as log collectors or software defined networks.
Taints can be used to create dedicated nodes. Running Kafka and its components on dedicated nodes can have many advantages. There will be no other applications running on the same nodes which could cause disturbance or consume the resources needed for Kafka. That can lead to improved performance and stability.
To schedule Kafka pods on the dedicated nodes, configure node affinity and tolerations.
3.1.20.3.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.1.20.3.3. Tolerations
Tolerations can be configured using the tolerations
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The format of the tolerations
property follows the OpenShift specification. For more details, see the Kubernetes taints and tolerations.
3.1.20.3.4. Setting up dedicated nodes and scheduling pods on them
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
- Select the nodes which should be used as dedicated.
- Make sure there are no workloads scheduled on these nodes.
Set the taints on the selected nodes:
This can be done using
oc adm taint
:oc adm taint node your-node dedicated=Kafka:NoSchedule
Additionally, add a label to the selected nodes as well.
This can be done using
oc label
:oc label node your-node dedicated=Kafka
Edit the
affinity
andtolerations
properties in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: tolerations: - key: "dedicated" operator: "Equal" value: "Kafka" effect: "NoSchedule" affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: dedicated operator: In values: - Kafka # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.1.21. Kafka Exporter
You can configure the Kafka
resource to automatically deploy Kafka Exporter in your cluster.
Kafka Exporter extracts data for analysis as Prometheus metrics, primarily data relating to offsets, consumer groups, consumer lag and topics.
For information on Kafka Exporter and why it is important to monitor consumer lag for performance, see Kafka Exporter.
3.1.21.1. Configuring Kafka Exporter
Configure Kafka Exporter in the Kafka
resource through KafkaExporter
properties.
Refer to the sample Kafka YAML configuration for an overview of the Kafka
resource and its properties.
The properties relevant to the Kafka Exporter configuration are shown in this procedure.
You can configure these properties as part of a deployment or redeployment of the Kafka cluster.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
KafkaExporter
properties for theKafka
resource.The properties you can configure are shown in this example configuration:
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: # ... kafkaExporter: image: my-org/my-image:latest 1 groupRegex: ".*" 2 topicRegex: ".*" 3 resources: 4 requests: cpu: 200m memory: 64Mi limits: cpu: 500m memory: 128Mi logging: debug 5 enableSaramaLogging: true 6 template: 7 pod: metadata: labels: label1: value1 imagePullSecrets: - name: my-docker-credentials securityContext: runAsUser: 1000001 fsGroup: 0 terminationGracePeriodSeconds: 120 readinessProbe: 8 initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: 9 initialDelaySeconds: 15 timeoutSeconds: 5 # ...
- 1
- ADVANCED OPTION: Container image configuration, which is recommended only in special situations.
- 2
- A regular expression to specify the consumer groups to include in the metrics.
- 3
- A regular expression to specify the topics to include in the metrics.
- 4
- 5
- Logging configuration, to log messages with a given severity (debug, info, warn, error, fatal) or above.
- 6
- Boolean to enable Sarama logging, a Go client library used by Kafka Exporter.
- 7
- 8
- 9
Create or update the resource:
oc apply -f kafka.yaml
What to do next
After configuring and deploying Kafka Exporter, you can enable Grafana to present the Kafka Exporter dashboards.
Additional resources
3.1.22. Performing a rolling update of a Kafka cluster
This procedure describes how to manually trigger a rolling update of an existing Kafka cluster by using an OpenShift annotation.
Prerequisites
- A running Kafka cluster.
- A running Cluster Operator.
Procedure
Find the name of the
StatefulSet
that controls the Kafka pods you want to manually update.For example, if your Kafka cluster is named my-cluster, the corresponding
StatefulSet
is named my-cluster-kafka.Annotate the
StatefulSet
resource in OpenShift. For example, usingoc annotate
:oc annotate statefulset cluster-name-kafka strimzi.io/manual-rolling-update=true
-
Wait for the next reconciliation to occur (every two minutes by default). A rolling update of all pods within the annotated
StatefulSet
is triggered, as long as the annotation was detected by the reconciliation process. When the rolling update of all the pods is complete, the annotation is removed from theStatefulSet
.
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Kafka cluster, see Section 2.4.1, “Deploying the Kafka cluster”.
3.1.23. Performing a rolling update of a Zookeeper cluster
This procedure describes how to manually trigger a rolling update of an existing Zookeeper cluster by using an OpenShift annotation.
Prerequisites
- A running Zookeeper cluster.
- A running Cluster Operator.
Procedure
Find the name of the
StatefulSet
that controls the Zookeeper pods you want to manually update.For example, if your Kafka cluster is named my-cluster, the corresponding
StatefulSet
is named my-cluster-zookeeper.Annotate the
StatefulSet
resource in OpenShift. For example, usingoc annotate
:oc annotate statefulset cluster-name-zookeeper strimzi.io/manual-rolling-update=true
-
Wait for the next reconciliation to occur (every two minutes by default). A rolling update of all pods within the annotated
StatefulSet
is triggered, as long as the annotation was detected by the reconciliation process. When the rolling update of all the pods is complete, the annotation is removed from theStatefulSet
.
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Zookeeper cluster, see Section 2.4.1, “Deploying the Kafka cluster”.
3.1.24. Scaling clusters
3.1.24.1. Scaling Kafka clusters
3.1.24.1.1. Adding brokers to a cluster
The primary way of increasing throughput for a topic is to increase the number of partitions for that topic. That works because the extra partitions allow the load of the topic to be shared between the different brokers in the cluster. However, in situations where every broker is constrained by a particular resource (typically I/O) using more partitions will not result in increased throughput. Instead, you need to add brokers to the cluster.
When you add an extra broker to the cluster, Kafka does not assign any partitions to it automatically. You must decide which partitions to move from the existing brokers to the new broker.
Once the partitions have been redistributed between all the brokers, the resource utilization of each broker should be reduced.
3.1.24.1.2. Removing brokers from a cluster
Because AMQ Streams uses StatefulSets
to manage broker pods, you cannot remove any pod from the cluster. You can only remove one or more of the highest numbered pods from the cluster. For example, in a cluster of 12 brokers the pods are named cluster-name-kafka-0
up to cluster-name-kafka-11
. If you decide to scale down by one broker, the cluster-name-kafka-11
will be removed.
Before you remove a broker from a cluster, ensure that it is not assigned to any partitions. You should also decide which of the remaining brokers will be responsible for each of the partitions on the broker being decommissioned. Once the broker has no assigned partitions, you can scale the cluster down safely.
3.1.24.2. Partition reassignment
The Topic Operator does not currently support reassigning replicas to different brokers, so it is necessary to connect directly to broker pods to reassign replicas to brokers.
Within a broker pod, the kafka-reassign-partitions.sh
utility allows you to reassign partitions to different brokers.
It has three different modes:
--generate
- Takes a set of topics and brokers and generates a reassignment JSON file which will result in the partitions of those topics being assigned to those brokers. Because this operates on whole topics, it cannot be used when you just need to reassign some of the partitions of some topics.
--execute
- Takes a reassignment JSON file and applies it to the partitions and brokers in the cluster. Brokers that gain partitions as a result become followers of the partition leader. For a given partition, once the new broker has caught up and joined the ISR (in-sync replicas) the old broker will stop being a follower and will delete its replica.
--verify
-
Using the same reassignment JSON file as the
--execute
step,--verify
checks whether all of the partitions in the file have been moved to their intended brokers. If the reassignment is complete, --verify also removes any throttles that are in effect. Unless removed, throttles will continue to affect the cluster even after the reassignment has finished.
It is only possible to have one reassignment running in a cluster at any given time, and it is not possible to cancel a running reassignment. If you need to cancel a reassignment, wait for it to complete and then perform another reassignment to revert the effects of the first reassignment. The kafka-reassign-partitions.sh
will print the reassignment JSON for this reversion as part of its output. Very large reassignments should be broken down into a number of smaller reassignments in case there is a need to stop in-progress reassignment.
3.1.24.2.1. Reassignment JSON file
The reassignment JSON file has a specific structure:
{
"version": 1,
"partitions": [
<PartitionObjects>
]
}
Where <PartitionObjects> is a comma-separated list of objects like:
{ "topic": <TopicName>, "partition": <Partition>, "replicas": [ <AssignedBrokerIds> ] }
Although Kafka also supports a "log_dirs"
property this should not be used in Red Hat AMQ Streams.
The following is an example reassignment JSON file that assigns topic topic-a
, partition 4
to brokers 2
, 4
and 7
, and topic topic-b
partition 2
to brokers 1
, 5
and 7
:
{ "version": 1, "partitions": [ { "topic": "topic-a", "partition": 4, "replicas": [2,4,7] }, { "topic": "topic-b", "partition": 2, "replicas": [1,5,7] } ] }
Partitions not included in the JSON are not changed.
3.1.24.2.2. Reassigning partitions between JBOD volumes
When using JBOD storage in your Kafka cluster, you can choose to reassign the partitions between specific volumes and their log directories (each volume has a single log directory). To reassign a partition to a specific volume, add the log_dirs
option to <PartitionObjects> in the reassignment JSON file.
{ "topic": <TopicName>, "partition": <Partition>, "replicas": [ <AssignedBrokerIds> ], "log_dirs": [ <AssignedLogDirs> ] }
The log_dirs
object should contain the same number of log directories as the number of replicas specified in the replicas
object. The value should be either an absolute path to the log directory, or the any
keyword.
For example:
{ "topic": "topic-a", "partition": 4, "replicas": [2,4,7]. "log_dirs": [ "/var/lib/kafka/data-0/kafka-log2", "/var/lib/kafka/data-0/kafka-log4", "/var/lib/kafka/data-0/kafka-log7" ] }
3.1.24.3. Generating reassignment JSON files
This procedure describes how to generate a reassignment JSON file that reassigns all the partitions for a given set of topics using the kafka-reassign-partitions.sh
tool.
Prerequisites
- A running Cluster Operator
-
A
Kafka
resource - A set of topics to reassign the partitions of
Procedure
Prepare a JSON file named
topics.json
that lists the topics to move. It must have the following structure:{ "version": 1, "topics": [ <TopicObjects> ] }
where <TopicObjects> is a comma-separated list of objects like:
{ "topic": <TopicName> }
For example if you want to reassign all the partitions of
topic-a
andtopic-b
, you would need to prepare atopics.json
file like this:{ "version": 1, "topics": [ { "topic": "topic-a"}, { "topic": "topic-b"} ] }
Copy the
topics.json
file to one of the broker pods:cat topics.json | oc exec -c kafka <BrokerPod> -i -- \ /bin/bash -c \ 'cat > /tmp/topics.json'
Use the
kafka-reassign-partitions.sh`
command to generate the reassignment JSON.oc exec <BrokerPod> -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --topics-to-move-json-file /tmp/topics.json \ --broker-list <BrokerList> \ --generate
For example, to move all the partitions of
topic-a
andtopic-b
to brokers4
and7
oc exec <BrokerPod> -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --topics-to-move-json-file /tmp/topics.json \ --broker-list 4,7 \ --generate
3.1.24.4. Creating reassignment JSON files manually
You can manually create the reassignment JSON file if you want to move specific partitions.
3.1.24.5. Reassignment throttles
Partition reassignment can be a slow process because it involves transferring large amounts of data between brokers. To avoid a detrimental impact on clients, you can throttle the reassignment process. This might cause the reassignment to take longer to complete.
- If the throttle is too low then the newly assigned brokers will not be able to keep up with records being published and the reassignment will never complete.
- If the throttle is too high then clients will be impacted.
For example, for producers, this could manifest as higher than normal latency waiting for acknowledgement. For consumers, this could manifest as a drop in throughput caused by higher latency between polls.
3.1.24.6. Scaling up a Kafka cluster
This procedure describes how to increase the number of brokers in a Kafka cluster.
Prerequisites
- An existing Kafka cluster.
-
A reassignment JSON file named
reassignment.json
that describes how partitions should be reassigned to brokers in the enlarged cluster.
Procedure
-
Add as many new brokers as you need by increasing the
Kafka.spec.kafka.replicas
configuration option. - Verify that the new broker pods have started.
Copy the
reassignment.json
file to the broker pod on which you will later execute the commands:cat reassignment.json | \ oc exec broker-pod -c kafka -i -- /bin/bash -c \ 'cat > /tmp/reassignment.json'
For example:
cat reassignment.json | \ oc exec my-cluster-kafka-0 -c kafka -i -- /bin/bash -c \ 'cat > /tmp/reassignment.json'
Execute the partition reassignment using the
kafka-reassign-partitions.sh
command line tool from the same broker pod.oc exec broker-pod -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --execute
If you are going to throttle replication you can also pass the
--throttle
option with an inter-broker throttled rate in bytes per second. For example:oc exec my-cluster-kafka-0 -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --throttle 5000000 \ --execute
This command will print out two reassignment JSON objects. The first records the current assignment for the partitions being moved. You should save this to a local file (not a file in the pod) in case you need to revert the reassignment later on. The second JSON object is the target reassignment you have passed in your reassignment JSON file.
If you need to change the throttle during reassignment you can use the same command line with a different throttled rate. For example:
oc exec my-cluster-kafka-0 -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --throttle 10000000 \ --execute
Periodically verify whether the reassignment has completed using the
kafka-reassign-partitions.sh
command line tool from any of the broker pods. This is the same command as the previous step but with the--verify
option instead of the--execute
option.oc exec broker-pod -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --verify
For example,
oc exec my-cluster-kafka-0 -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --verify
-
The reassignment has finished when the
--verify
command reports each of the partitions being moved as completed successfully. This final--verify
will also have the effect of removing any reassignment throttles. You can now delete the revert file if you saved the JSON for reverting the assignment to their original brokers.
3.1.24.7. Scaling down a Kafka cluster
Additional resources
This procedure describes how to decrease the number of brokers in a Kafka cluster.
Prerequisites
- An existing Kafka cluster.
-
A reassignment JSON file named
reassignment.json
describing how partitions should be reassigned to brokers in the cluster once the broker(s) in the highest numberedPod(s)
have been removed.
Procedure
Copy the
reassignment.json
file to the broker pod on which you will later execute the commands:cat reassignment.json | \ oc exec broker-pod -c kafka -i -- /bin/bash -c \ 'cat > /tmp/reassignment.json'
For example:
cat reassignment.json | \ oc exec my-cluster-kafka-0 -c kafka -i -- /bin/bash -c \ 'cat > /tmp/reassignment.json'
Execute the partition reassignment using the
kafka-reassign-partitions.sh
command line tool from the same broker pod.oc exec broker-pod -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --execute
If you are going to throttle replication you can also pass the
--throttle
option with an inter-broker throttled rate in bytes per second. For example:oc exec my-cluster-kafka-0 -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --throttle 5000000 \ --execute
This command will print out two reassignment JSON objects. The first records the current assignment for the partitions being moved. You should save this to a local file (not a file in the pod) in case you need to revert the reassignment later on. The second JSON object is the target reassignment you have passed in your reassignment JSON file.
If you need to change the throttle during reassignment you can use the same command line with a different throttled rate. For example:
oc exec my-cluster-kafka-0 -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --throttle 10000000 \ --execute
Periodically verify whether the reassignment has completed using the
kafka-reassign-partitions.sh
command line tool from any of the broker pods. This is the same command as the previous step but with the--verify
option instead of the--execute
option.oc exec broker-pod -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --verify
For example,
oc exec my-cluster-kafka-0 -c kafka -it -- \ bin/kafka-reassign-partitions.sh --zookeeper localhost:2181 \ --reassignment-json-file /tmp/reassignment.json \ --verify
-
The reassignment has finished when the
--verify
command reports each of the partitions being moved as completed successfully. This final--verify
will also have the effect of removing any reassignment throttles. You can now delete the revert file if you saved the JSON for reverting the assignment to their original brokers. Once all the partition reassignments have finished, the broker(s) being removed should not have responsibility for any of the partitions in the cluster. You can verify this by checking that the broker’s data log directory does not contain any live partition logs. If the log directory on the broker contains a directory that does not match the extended regular expression
\.[a-z0-9]-delete$
then the broker still has live partitions and it should not be stopped.You can check this by executing the command:
oc exec my-cluster-kafka-0 -c kafka -it -- \ /bin/bash -c \ "ls -l /var/lib/kafka/kafka-log_<N>_ | grep -E '^d' | grep -vE '[a-zA-Z0-9.-]+\.[a-z0-9]+-delete$'"
where N is the number of the
Pod(s)
being deleted.If the above command prints any output then the broker still has live partitions. In this case, either the reassignment has not finished, or the reassignment JSON file was incorrect.
-
Once you have confirmed that the broker has no live partitions you can edit the
Kafka.spec.kafka.replicas
of yourKafka
resource, which will scale down theStatefulSet
, deleting the highest numbered brokerPod(s)
.
3.1.25. Deleting Kafka nodes manually
Additional resources
This procedure describes how to delete an existing Kafka node by using an OpenShift annotation. Deleting a Kafka node consists of deleting both the Pod
on which the Kafka broker is running and the related PersistentVolumeClaim
(if the cluster was deployed with persistent storage). After deletion, the Pod
and its related PersistentVolumeClaim
are recreated automatically.
Deleting a PersistentVolumeClaim
can cause permanent data loss. The following procedure should only be performed if you have encountered storage issues.
Prerequisites
- A running Kafka cluster.
- A running Cluster Operator.
Procedure
Find the name of the
Pod
that you want to delete.For example, if the cluster is named cluster-name, the pods are named cluster-name-kafka-index, where index starts at zero and ends at the total number of replicas.
Annotate the
Pod
resource in OpenShift.Use
oc annotate
:oc annotate pod cluster-name-kafka-index strimzi.io/delete-pod-and-pvc=true
- Wait for the next reconciliation, when the annotated pod with the underlying persistent volume claim will be deleted and then recreated.
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Kafka cluster, see Section 2.4.1, “Deploying the Kafka cluster”.
3.1.26. Deleting Zookeeper nodes manually
This procedure describes how to delete an existing Zookeeper node by using an OpenShift annotation. Deleting a Zookeeper node consists of deleting both the Pod
on which Zookeeper is running and the related PersistentVolumeClaim
(if the cluster was deployed with persistent storage). After deletion, the Pod
and its related PersistentVolumeClaim
are recreated automatically.
Deleting a PersistentVolumeClaim
can cause permanent data loss. The following procedure should only be performed if you have encountered storage issues.
Prerequisites
- A running Zookeeper cluster.
- A running Cluster Operator.
Procedure
Find the name of the
Pod
that you want to delete.For example, if the cluster is named cluster-name, the pods are named cluster-name-zookeeper-index, where index starts at zero and ends at the total number of replicas.
Annotate the
Pod
resource in OpenShift.Use
oc annotate
:oc annotate pod cluster-name-zookeeper-index strimzi.io/delete-pod-and-pvc=true
- Wait for the next reconciliation, when the annotated pod with the underlying persistent volume claim will be deleted and then recreated.
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Zookeeper cluster, see Section 2.4.1, “Deploying the Kafka cluster”.
3.1.27. Maintenance time windows for rolling updates
Maintenance time windows allow you to schedule certain rolling updates of your Kafka and Zookeeper clusters to start at a convenient time.
3.1.27.1. Maintenance time windows overview
In most cases, the Cluster Operator only updates your Kafka or Zookeeper clusters in response to changes to the corresponding Kafka
resource. This enables you to plan when to apply changes to a Kafka
resource to minimize the impact on Kafka client applications.
However, some updates to your Kafka and Zookeeper clusters can happen without any corresponding change to the Kafka
resource. For example, the Cluster Operator will need to perform a rolling restart if a CA (Certificate Authority) certificate that it manages is close to expiry.
While a rolling restart of the pods should not affect availability of the service (assuming correct broker and topic configurations), it could affect performance of the Kafka client applications. Maintenance time windows allow you to schedule such spontaneous rolling updates of your Kafka and Zookeeper clusters to start at a convenient time. If maintenance time windows are not configured for a cluster then it is possible that such spontaneous rolling updates will happen at an inconvenient time, such as during a predictable period of high load.
3.1.27.2. Maintenance time window definition
You configure maintenance time windows by entering an array of strings in the Kafka.spec.maintenanceTimeWindows
property. Each string is a cron expression interpreted as being in UTC (Coordinated Universal Time, which for practical purposes is the same as Greenwich Mean Time).
The following example configures a single maintenance time window that starts at midnight and ends at 01:59am (UTC), on Sundays, Mondays, Tuesdays, Wednesdays, and Thursdays:
# ... maintenanceTimeWindows: - "* * 0-1 ? * SUN,MON,TUE,WED,THU *" # ...
In practice, maintenance windows should be set in conjunction with the Kafka.spec.clusterCa.renewalDays
and Kafka.spec.clientsCa.renewalDays
properties of the Kafka
resource, to ensure that the necessary CA certificate renewal can be completed in the configured maintenance time windows.
AMQ Streams does not schedule maintenance operations exactly according to the given windows. Instead, for each reconciliation, it checks whether a maintenance window is currently "open". This means that the start of maintenance operations within a given time window can be delayed by up to the Cluster Operator reconciliation interval. Maintenance time windows must therefore be at least this long.
Additional resources
- For more information about the Cluster Operator configuration, see Section 4.1.7, “Cluster Operator Configuration”.
3.1.27.3. Configuring a maintenance time window
You can configure a maintenance time window for rolling updates triggered by supported processes.
Prerequisites
- An OpenShift cluster.
- The Cluster Operator is running.
Procedure
Add or edit the
maintenanceTimeWindows
property in theKafka
resource. For example to allow maintenance between 0800 and 1059 and between 1400 and 1559 you would set themaintenanceTimeWindows
as shown below:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... maintenanceTimeWindows: - "* * 8-10 * * ?" - "* * 14-15 * * ?"
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
- Performing a rolling update of a Kafka cluster, see Section 3.1.22, “Performing a rolling update of a Kafka cluster”
- Performing a rolling update of a Zookeeper cluster, see Section 3.1.23, “Performing a rolling update of a Zookeeper cluster”
3.1.28. Renewing CA certificates manually
Unless the Kafka.spec.clusterCa.generateCertificateAuthority
and Kafka.spec.clientsCa.generateCertificateAuthority
objects are set to false
, the cluster and clients CA certificates will auto-renew at the start of their respective certificate renewal periods. You can manually renew one or both of these certificates before the certificate renewal period starts, if required for security reasons. A renewed certificate uses the same private key as the old certificate.
Prerequisites
- The Cluster Operator is running.
- A Kafka cluster in which CA certificates and private keys are installed.
Procedure
Apply the
strimzi.io/force-renew
annotation to theSecret
that contains the CA certificate that you want to renew.Certificate Secret Annotate command Cluster CA
<cluster-name>-cluster-ca-cert
oc annotate secret <cluster-name>-cluster-ca-cert strimzi.io/force-renew=true
Clients CA
<cluster-name>-clients-ca-cert
oc annotate secret <cluster-name>-clients-ca-cert strimzi.io/force-renew=true
At the next reconciliation the Cluster Operator will generate a new CA certificate for the Secret
that you annotated. If maintenance time windows are configured, the Cluster Operator will generate the new CA certificate at the first reconciliation within the next maintenance time window.
Client applications must reload the cluster and clients CA certificates that were renewed by the Cluster Operator.
3.1.29. Replacing private keys
You can replace the private keys used by the cluster CA and clients CA certificates. When a private key is replaced, the Cluster Operator generates a new CA certificate for the new private key.
Prerequisites
- The Cluster Operator is running.
- A Kafka cluster in which CA certificates and private keys are installed.
Procedure
Apply the
strimzi.io/force-replace
annotation to theSecret
that contains the private key that you want to renew.Private key for Secret Annotate command Cluster CA
<cluster-name>-cluster-ca
oc annotate secret <cluster-name>-cluster-ca strimzi.io/force-replace=true
Clients CA
<cluster-name>-clients-ca
oc annotate secret <cluster-name>-clients-ca strimzi.io/force-replace=true
At the next reconciliation the Cluster Operator will:
-
Generate a new private key for the
Secret
that you annotated - Generate a new CA certificate
If maintenance time windows are configured, the Cluster Operator will generate the new private key and CA certificate at the first reconciliation within the next maintenance time window.
Client applications must reload the cluster and clients CA certificates that were renewed by the Cluster Operator.
3.1.30. List of resources created as part of Kafka cluster
The following resources will created by the Cluster Operator in the OpenShift cluster:
cluster-name-kafka
- StatefulSet which is in charge of managing the Kafka broker pods.
cluster-name-kafka-brokers
- Service needed to have DNS resolve the Kafka broker pods IP addresses directly.
cluster-name-kafka-bootstrap
- Service can be used as bootstrap servers for Kafka clients.
cluster-name-kafka-external-bootstrap
- Bootstrap service for clients connecting from outside of the OpenShift cluster. This resource will be created only when external listener is enabled.
cluster-name-kafka-pod-id
- Service used to route traffic from outside of the OpenShift cluster to individual pods. This resource will be created only when external listener is enabled.
cluster-name-kafka-external-bootstrap
-
Bootstrap route for clients connecting from outside of the OpenShift cluster. This resource will be created only when external listener is enabled and set to type
route
. cluster-name-kafka-pod-id
-
Route for traffic from outside of the OpenShift cluster to individual pods. This resource will be created only when external listener is enabled and set to type
route
. cluster-name-kafka-config
- ConfigMap which contains the Kafka ancillary configuration and is mounted as a volume by the Kafka broker pods.
cluster-name-kafka-brokers
- Secret with Kafka broker keys.
cluster-name-kafka
- Service account used by the Kafka brokers.
cluster-name-kafka
- Pod Disruption Budget configured for the Kafka brokers.
strimzi-namespace-name-cluster-name-kafka-init
- Cluster role binding used by the Kafka brokers.
cluster-name-zookeeper
- StatefulSet which is in charge of managing the Zookeeper node pods.
cluster-name-zookeeper-nodes
- Service needed to have DNS resolve the Zookeeper pods IP addresses directly.
cluster-name-zookeeper-client
- Service used by Kafka brokers to connect to Zookeeper nodes as clients.
cluster-name-zookeeper-config
- ConfigMap which contains the Zookeeper ancillary configuration and is mounted as a volume by the Zookeeper node pods.
cluster-name-zookeeper-nodes
- Secret with Zookeeper node keys.
cluster-name-zookeeper
- Pod Disruption Budget configured for the Zookeeper nodes.
cluster-name-entity-operator
- Deployment with Topic and User Operators. This resource will be created only if Cluster Operator deployed Entity Operator.
cluster-name-entity-topic-operator-config
- Configmap with ancillary configuration for Topic Operators. This resource will be created only if Cluster Operator deployed Entity Operator.
cluster-name-entity-user-operator-config
- Configmap with ancillary configuration for User Operators. This resource will be created only if Cluster Operator deployed Entity Operator.
cluster-name-entity-operator-certs
- Secret with Entitiy operators keys for communication with Kafka and Zookeeper. This resource will be created only if Cluster Operator deployed Entity Operator.
cluster-name-entity-operator
- Service account used by the Entity Operator.
strimzi-cluster-name-topic-operator
- Role binding used by the Entity Operator.
strimzi-cluster-name-user-operator
- Role binding used by the Entity Operator.
cluster-name-cluster-ca
- Secret with the Cluster CA used to encrypt the cluster communication.
cluster-name-cluster-ca-cert
- Secret with the Cluster CA public key. This key can be used to verify the identity of the Kafka brokers.
cluster-name-clients-ca
- Secret with the Clients CA used to encrypt the communication between Kafka brokers and Kafka clients.
cluster-name-clients-ca-cert
- Secret with the Clients CA public key. This key can be used to verify the identity of the Kafka brokers.
cluster-name-cluster-operator-certs
- Secret with Cluster operators keys for communication with Kafka and Zookeeper.
data-cluster-name-kafka-idx
-
Persistent Volume Claim for the volume used for storing data for the Kafka broker pod
idx
. This resource will be created only if persistent storage is selected for provisioning persistent volumes to store data. data-id-cluster-name-kafka-idx
-
Persistent Volume Claim for the volume
id
used for storing data for the Kafka broker podidx
. This resource is only created if persistent storage is selected for JBOD volumes when provisioning persistent volumes to store data. data-cluster-name-zookeeper-idx
-
Persistent Volume Claim for the volume used for storing data for the Zookeeper node pod
idx
. This resource will be created only if persistent storage is selected for provisioning persistent volumes to store data.
3.2. Kafka Connect cluster configuration
The full schema of the KafkaConnect
resource is described in the Section C.62, “KafkaConnect
schema reference”. All labels that are applied to the desired KafkaConnect
resource will also be applied to the OpenShift resources making up the Kafka Connect cluster. This provides a convenient mechanism for resources to be labeled as required.
3.2.1. Replicas
Kafka Connect clusters can run multiple of nodes. The number of nodes is defined in the KafkaConnect
and KafkaConnectS2I
resources. Running a Kafka Connect cluster with multiple nodes can provide better availability and scalability. However, when running Kafka Connect on OpenShift it is not absolutely necessary to run multiple nodes of Kafka Connect for high availability. If a node where Kafka Connect is deployed to crashes, OpenShift will automatically reschedule the Kafka Connect pod to a different node. However, running Kafka Connect with multiple nodes can provide faster failover times, because the other nodes will be up and running already.
3.2.1.1. Configuring the number of nodes
The number of Kafka Connect nodes is configured using the replicas
property in KafkaConnect.spec
and KafkaConnectS2I.spec
.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
replicas
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnectS2I metadata: name: my-cluster spec: # ... replicas: 3 # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.2. Bootstrap servers
A Kafka Connect cluster always works in combination with a Kafka cluster. A Kafka cluster is specified as a list of bootstrap servers. On OpenShift, the list must ideally contain the Kafka cluster bootstrap service named cluster-name-kafka-bootstrap
, and a port of 9092 for plain traffic or 9093 for encrypted traffic.
The list of bootstrap servers is configured in the bootstrapServers
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. The servers must be defined as a comma-separated list specifying one or more Kafka brokers, or a service pointing to Kafka brokers specified as a hostname:_port_
pairs.
When using Kafka Connect with a Kafka cluster not managed by AMQ Streams, you can specify the bootstrap servers list according to the configuration of the cluster.
3.2.2.1. Configuring bootstrap servers
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
bootstrapServers
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... bootstrapServers: my-cluster-kafka-bootstrap:9092 # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.3. Connecting to Kafka brokers using TLS
By default, Kafka Connect tries to connect to Kafka brokers using a plain text connection. If you prefer to use TLS, additional configuration is required.
3.2.3.1. TLS support in Kafka Connect
TLS support is configured in the tls
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. The tls
property contains a list of secrets with key names under which the certificates are stored. The certificates must be stored in X509 format.
An example showing TLS configuration with multiple certificates
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... tls: trustedCertificates: - secretName: my-secret certificate: ca.crt - secretName: my-other-secret certificate: certificate.crt # ...
When multiple certificates are stored in the same secret, it can be listed multiple times.
An example showing TLS configuration with multiple certificates from the same secret
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnectS2I metadata: name: my-cluster spec: # ... tls: trustedCertificates: - secretName: my-secret certificate: ca.crt - secretName: my-secret certificate: ca2.crt # ...
3.2.3.2. Configuring TLS in Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
-
If they exist, the name of the
Secret
for the certificate used for TLS Server Authentication, and the key under which the certificate is stored in theSecret
Procedure
(Optional) If they do not already exist, prepare the TLS certificate used in authentication in a file and create a
Secret
.NoteThe secrets created by the Cluster Operator for Kafka cluster may be used directly.
This can be done using
oc create
:oc create secret generic my-secret --from-file=my-file.crt
Edit the
tls
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... tls: trustedCertificates: - secretName: my-cluster-cluster-cert certificate: ca.crt # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.4. Connecting to Kafka brokers with Authentication
By default, Kafka Connect will try to connect to Kafka brokers without authentication. Authentication is enabled through the KafkaConnect
and KafkaConnectS2I
resources.
3.2.4.1. Authentication support in Kafka Connect
Authentication is configured through the authentication
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. The authentication
property specifies the type of the authentication mechanisms which should be used and additional configuration details depending on the mechanism. The supported authentication types are:
- TLS client authentication
- SASL-based authentication using the SCRAM-SHA-512 mechanism
- SASL-based authentication using the PLAIN mechanism
- OAuth 2.0 token based authentication
3.2.4.1.1. TLS Client Authentication
To use TLS client authentication, set the type
property to the value tls
. TLS client authentication uses a TLS certificate to authenticate. The certificate is specified in the certificateAndKey
property and is always loaded from an OpenShift secret. In the secret, the certificate must be stored in X509 format under two different keys: public and private.
TLS client authentication can be used only with TLS connections. For more details about TLS configuration in Kafka Connect see Section 3.2.3, “Connecting to Kafka brokers using TLS”.
An example TLS client authentication configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... authentication: type: tls certificateAndKey: secretName: my-secret certificate: public.crt key: private.key # ...
3.2.4.1.2. SASL based SCRAM-SHA-512 authentication
To configure Kafka Connect to use SASL-based SCRAM-SHA-512 authentication, set the type
property to scram-sha-512
. This authentication mechanism requires a username and password.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name of theSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example SASL based SCRAM-SHA-512 client authentication configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... authentication: type: scram-sha-512 username: my-connect-user passwordSecret: secretName: my-connect-user password: my-connect-password-key # ...
3.2.4.1.3. SASL based PLAIN authentication
To configure Kafka Connect to use SASL-based PLAIN authentication, set the type
property to plain
. This authentication mechanism requires a username and password.
The SASL PLAIN mechanism will transfer the username and password across the network in cleartext. Only use SASL PLAIN authentication if TLS encryption is enabled.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name of such aSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example showing SASL based PLAIN client authentication configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... authentication: type: plain username: my-connect-user passwordSecret: secretName: my-connect-user password: my-connect-password-key # ...
3.2.4.2. Configuring TLS client authentication in Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
-
If they exist, the name of the
Secret
with the public and private keys used for TLS Client Authentication, and the keys under which they are stored in theSecret
Procedure
(Optional) If they do not already exist, prepare the keys used for authentication in a file and create the
Secret
.NoteSecrets created by the User Operator may be used.
This can be done using
oc create
:oc create secret generic my-secret --from-file=my-public.crt --from-file=my-private.key
Edit the
authentication
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... authentication: type: tls certificateAndKey: secretName: my-secret certificate: my-public.crt key: my-private.key # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.4.3. Configuring SCRAM-SHA-512 authentication in Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
- Username of the user which should be used for authentication
-
If they exist, the name of the
Secret
with the password used for authentication and the key under which the password is stored in theSecret
Procedure
(Optional) If they do not already exist, prepare a file with the password used in authentication and create the
Secret
.NoteSecrets created by the User Operator may be used.
This can be done using
oc create
:echo -n '<password>' > <my-password.txt> oc create secret generic <my-secret> --from-file=<my-password.txt>
Edit the
authentication
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... authentication: type: scram-sha-512 username: _<my-username>_ passwordSecret: secretName: _<my-secret>_ password: _<my-password.txt>_ # ...
Create or update the resource.
On OpenShift this can be done using
oc apply
:oc apply -f your-file
3.2.5. Kafka Connect configuration
AMQ Streams allows you to customize the configuration of Apache Kafka Connect nodes by editing certain options listed in Apache Kafka documentation.
Configuration options that cannot be configured relate to:
- Kafka cluster bootstrap address
- Security (Encryption, Authentication, and Authorization)
- Listener / REST interface configuration
- Plugin path configuration
These options are automatically configured by AMQ Streams.
3.2.5.1. Kafka Connect configuration
Kafka Connect is configured using the config
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. This property contains the Kafka Connect configuration options as keys. The values can be one of the following JSON types:
- String
- Number
- Boolean
You can specify and configure the options listed in the Apache Kafka documentation with the exception of those options that are managed directly by AMQ Streams. Specifically, configuration options with keys equal to or starting with one of the following strings are forbidden:
-
ssl.
-
sasl.
-
security.
-
listeners
-
plugin.path
-
rest.
-
bootstrap.servers
When a forbidden option is present in the config
property, it is ignored and a warning message is printed to the Custer Operator log file. All other options are passed to Kafka Connect.
The Cluster Operator does not validate keys or values in the config
object provided. When an invalid configuration is provided, the Kafka Connect cluster might not start or might become unstable. In this circumstance, fix the configuration in the KafkaConnect.spec.config
or KafkaConnectS2I.spec.config
object, then the Cluster Operator can roll out the new configuration to all Kafka Connect nodes.
Certain options have default values:
-
group.id
with default valueconnect-cluster
-
offset.storage.topic
with default valueconnect-cluster-offsets
-
config.storage.topic
with default valueconnect-cluster-configs
-
status.storage.topic
with default valueconnect-cluster-status
-
key.converter
with default valueorg.apache.kafka.connect.json.JsonConverter
-
value.converter
with default valueorg.apache.kafka.connect.json.JsonConverter
These options are automatically configured in case they are not present in the KafkaConnect.spec.config
or KafkaConnectS2I.spec.config
properties.
Example Kafka Connect configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... config: group.id: my-connect-cluster offset.storage.topic: my-connect-cluster-offsets config.storage.topic: my-connect-cluster-configs status.storage.topic: my-connect-cluster-status key.converter: org.apache.kafka.connect.json.JsonConverter value.converter: org.apache.kafka.connect.json.JsonConverter key.converter.schemas.enable: true value.converter.schemas.enable: true config.storage.replication.factor: 3 offset.storage.replication.factor: 3 status.storage.replication.factor: 3 # ...
3.2.5.2. Kafka Connect configuration for multiple instances
If you are running multiple instances of Kafka Connect, pay attention to the default configuration of the following properties:
# ... group.id: connect-cluster 1 offset.storage.topic: connect-cluster-offsets 2 config.storage.topic: connect-cluster-configs 3 status.storage.topic: connect-cluster-status 4 # ...
Values for the three topics must be the same for all Kafka Connect instances with the same group.id
.
Unless you change the default settings, each Kafka Connect instance connecting to the same Kafka cluster is deployed with the same values. What happens, in effect, is all instances are coupled to run in a cluster and use the same topics.
If multiple Kafka Connect clusters try to use the same topics, Kafka Connect will not work as expected and generate errors.
If you wish to run multiple Kafka Connect instances, change the values of these properties for each instance.
3.2.5.3. Configuring Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
config
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... config: group.id: my-connect-cluster offset.storage.topic: my-connect-cluster-offsets config.storage.topic: my-connect-cluster-configs status.storage.topic: my-connect-cluster-status key.converter: org.apache.kafka.connect.json.JsonConverter value.converter: org.apache.kafka.connect.json.JsonConverter key.converter.schemas.enable: true value.converter.schemas.enable: true config.storage.replication.factor: 3 offset.storage.replication.factor: 3 status.storage.replication.factor: 3 # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.6. CPU and memory resources
For every deployed container, AMQ Streams allows you to request specific resources and define the maximum consumption of those resources.
AMQ Streams supports two types of resources:
- CPU
- Memory
AMQ Streams uses the OpenShift syntax for specifying CPU and memory resources.
3.2.6.1. Resource limits and requests
Resource limits and requests are configured using the resources
property in the following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
Additional resources
- For more information about managing computing resources on OpenShift, see Managing Compute Resources for Containers.
3.2.6.1.1. Resource requests
Requests specify the resources to reserve for a given container. Reserving the resources ensures that they are always available.
If the resource request is for more than the available free resources in the OpenShift cluster, the pod is not scheduled.
Resources requests are specified in the requests
property. Resources requests currently supported by AMQ Streams:
-
cpu
-
memory
A request may be configured for one or more supported resources.
Example resource request configuration with all resources
# ... resources: requests: cpu: 12 memory: 64Gi # ...
3.2.6.1.2. Resource limits
Limits specify the maximum resources that can be consumed by a given container. The limit is not reserved and might not always be available. A container can use the resources up to the limit only when they are available. Resource limits should be always higher than the resource requests.
Resource limits are specified in the limits
property. Resource limits currently supported by AMQ Streams:
-
cpu
-
memory
A resource may be configured for one or more supported limits.
Example resource limits configuration
# ... resources: limits: cpu: 12 memory: 64Gi # ...
3.2.6.1.3. Supported CPU formats
CPU requests and limits are supported in the following formats:
-
Number of CPU cores as integer (
5
CPU core) or decimal (2.5
CPU core). -
Number or millicpus / millicores (
100m
) where 1000 millicores is the same1
CPU core.
Example CPU units
# ... resources: requests: cpu: 500m limits: cpu: 2.5 # ...
The computing power of 1 CPU core may differ depending on the platform where OpenShift is deployed.
Additional resources
- For more information on CPU specification, see the Meaning of CPU.
3.2.6.1.4. Supported memory formats
Memory requests and limits are specified in megabytes, gigabytes, mebibytes, and gibibytes.
-
To specify memory in megabytes, use the
M
suffix. For example1000M
. -
To specify memory in gigabytes, use the
G
suffix. For example1G
. -
To specify memory in mebibytes, use the
Mi
suffix. For example1000Mi
. -
To specify memory in gibibytes, use the
Gi
suffix. For example1Gi
.
An example of using different memory units
# ... resources: requests: memory: 512Mi limits: memory: 2Gi # ...
Additional resources
- For more details about memory specification and additional supported units, see Meaning of memory.
3.2.6.2. Configuring resource requests and limits
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
resources
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... resources: requests: cpu: "8" memory: 64Gi limits: cpu: "12" memory: 128Gi # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema, see
Resources
schema reference.
3.2.7. Logging
This section provides information on loggers and how to configure log levels.
You can set the log levels by specifying the loggers and their levels directly (inline) or use a custom (external) config map.
3.2.7.1. Kafka Connect loggers
Kafka Connect has its own configurable loggers:
-
connect.root.logger.level
-
log4j.logger.org.apache.zookeeper
-
log4j.logger.org.I0Itec.zkclient
-
log4j.logger.org.reflections
3.2.7.2. Specifying inline logging
Procedure
Edit the YAML file to specify the loggers and logging level for the required components.
For example, the logging level here is set to INFO:
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect spec: # ... logging: type: inline loggers: logger.name: "INFO" # ...
You can set the log level to INFO, ERROR, WARN, TRACE, DEBUG, FATAL or OFF.
For more information about the log levels, see the log4j manual.
Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
3.2.7.3. Specifying an external ConfigMap for logging
Procedure
Edit the YAML file to specify the name of the
ConfigMap
to use for the required components. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect spec: # ... logging: type: external name: customConfigMap # ...
Remember to place your custom ConfigMap under the
log4j.properties
orlog4j2.properties
key.Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
Garbage collector (GC) logging can also be enabled (or disabled). For more information on GC, see Section 3.1.17.1, “JVM configuration”
3.2.8. Healthchecks
Healthchecks are periodical tests which verify the health of an application. When a Healthcheck probe fails, OpenShift assumes that the application is not healthy and attempts to fix it.
OpenShift supports two types of Healthcheck probes:
- Liveness probes
- Readiness probes
For more details about the probes, see Configure Liveness and Readiness Probes. Both types of probes are used in AMQ Streams components.
Users can configure selected options for liveness and readiness probes.
3.2.8.1. Healthcheck configurations
Liveness and readiness probes can be configured using the livenessProbe
and readinessProbe
properties in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Both livenessProbe
and readinessProbe
support the following options:
-
initialDelaySeconds
-
timeoutSeconds
-
periodSeconds
-
successThreshold
-
failureThreshold
For more information about the livenessProbe
and readinessProbe
options, see Section C.34, “Probe
schema reference”.
An example of liveness and readiness probe configuration
# ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ...
3.2.8.2. Configuring healthchecks
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
livenessProbe
orreadinessProbe
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.9. Prometheus metrics
AMQ Streams supports Prometheus metrics using Prometheus JMX exporter to convert the JMX metrics supported by Apache Kafka and Zookeeper to Prometheus metrics. When metrics are enabled, they are exposed on port 9404.
For more information about configuring Prometheus and Grafana, see Metrics.
3.2.9.1. Metrics configuration
Prometheus metrics are enabled by configuring the metrics
property in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
When the metrics
property is not defined in the resource, the Prometheus metrics will be disabled. To enable Prometheus metrics export without any further configuration, you can set it to an empty object ({}
).
Example of enabling metrics without any further configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... metrics: {} # ... zookeeper: # ...
The metrics
property might contain additional configuration for the Prometheus JMX exporter.
Example of enabling metrics with additional Prometheus JMX Exporter configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... metrics: lowercaseOutputName: true rules: - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*><>Count" name: "kafka_server_$1_$2_total" - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*, topic=(.+)><>Count" name: "kafka_server_$1_$2_total" labels: topic: "$3" # ... zookeeper: # ...
3.2.9.2. Configuring Prometheus metrics
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
metrics
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... metrics: lowercaseOutputName: true # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.10. JVM Options
The following components of AMQ Streams run inside a Virtual Machine (VM):
- Apache Kafka
- Apache Zookeeper
- Apache Kafka Connect
- Apache Kafka Mirror Maker
- AMQ Streams Kafka Bridge
JVM configuration options optimize the performance for different platforms and architectures. AMQ Streams allows you to configure some of these options.
3.2.10.1. JVM configuration
JVM options can be configured using the jvmOptions
property in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Only a selected subset of available JVM options can be configured. The following options are supported:
-Xms and -Xmx
-Xms
configures the minimum initial allocation heap size when the JVM starts. -Xmx
configures the maximum heap size.
The units accepted by JVM settings such as -Xmx
and -Xms
are those accepted by the JDK java
binary in the corresponding image. Accordingly, 1g
or 1G
means 1,073,741,824 bytes, and Gi
is not a valid unit suffix. This is in contrast to the units used for memory requests and limits, which follow the OpenShift convention where 1G
means 1,000,000,000 bytes, and 1Gi
means 1,073,741,824 bytes
The default values used for -Xms
and -Xmx
depends on whether there is a memory request limit configured for the container:
- If there is a memory limit then the JVM’s minimum and maximum memory will be set to a value corresponding to the limit.
-
If there is no memory limit then the JVM’s minimum memory will be set to
128M
and the JVM’s maximum memory will not be defined. This allows for the JVM’s memory to grow as-needed, which is ideal for single node environments in test and development.
Setting -Xmx
explicitly requires some care:
-
The JVM’s overall memory usage will be approximately 4 × the maximum heap, as configured by
-Xmx
. -
If
-Xmx
is set without also setting an appropriate OpenShift memory limit, it is possible that the container will be killed should the OpenShift node experience memory pressure (from other Pods running on it). -
If
-Xmx
is set without also setting an appropriate OpenShift memory request, it is possible that the container will be scheduled to a node with insufficient memory. In this case, the container will not start but crash (immediately if-Xms
is set to-Xmx
, or some later time if not).
When setting -Xmx
explicitly, it is recommended to:
- set the memory request and the memory limit to the same value,
-
use a memory request that is at least 4.5 × the
-Xmx
, -
consider setting
-Xms
to the same value as-Xmx
.
Containers doing lots of disk I/O (such as Kafka broker containers) will need to leave some memory available for use as operating system page cache. On such containers, the requested memory should be significantly higher than the memory used by the JVM.
Example fragment configuring -Xmx
and -Xms
# ... jvmOptions: "-Xmx": "2g" "-Xms": "2g" # ...
In the above example, the JVM will use 2 GiB (=2,147,483,648 bytes) for its heap. Its total memory usage will be approximately 8GiB.
Setting the same value for initial (-Xms
) and maximum (-Xmx
) heap sizes avoids the JVM having to allocate memory after startup, at the cost of possibly allocating more heap than is really needed. For Kafka and Zookeeper pods such allocation could cause unwanted latency. For Kafka Connect avoiding over allocation may be the most important concern, especially in distributed mode where the effects of over-allocation will be multiplied by the number of consumers.
-server
-server
enables the server JVM. This option can be set to true or false.
Example fragment configuring -server
# ... jvmOptions: "-server": true # ...
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
-XX
-XX
object can be used for configuring advanced runtime options of a JVM. The -server
and -XX
options are used to configure the KAFKA_JVM_PERFORMANCE_OPTS
option of Apache Kafka.
Example showing the use of the -XX
object
jvmOptions: "-XX": "UseG1GC": true "MaxGCPauseMillis": 20 "InitiatingHeapOccupancyPercent": 35 "ExplicitGCInvokesConcurrent": true "UseParNewGC": false
The example configuration above will result in the following JVM options:
-XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -XX:-UseParNewGC
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
3.2.10.1.1. Garbage collector logging
The jvmOptions
section also allows you to enable and disable garbage collector (GC) logging. GC logging is enabled by default. To disable it, set the gcLoggingEnabled
property as follows:
Example of disabling GC logging
# ... jvmOptions: gcLoggingEnabled: false # ...
3.2.10.2. Configuring JVM options
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
jvmOptions
property in theKafka
,KafkaConnect
,KafkaConnectS2I
,KafkaMirrorMaker
, orKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... jvmOptions: "-Xmx": "8g" "-Xms": "8g" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.11. Container images
AMQ Streams allows you to configure container images which will be used for its components. Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such a case, you should either copy the AMQ Streams images or build them from the source. If the configured image is not compatible with AMQ Streams images, it might not work properly.
3.2.11.1. Container image configurations
Container image which should be used for given components can be specified using the image
property in:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
3.2.11.1.1. Configuring the Kafka.spec.kafka.image
property
The Kafka.spec.kafka.image
property functions differently from the others, because AMQ Streams supports multiple versions of Kafka, each requiring the own image. The STRIMZI_KAFKA_IMAGES
environment variable of the Cluster Operator configuration is used to provide a mapping between Kafka versions and the corresponding images. This is used in combination with the Kafka.spec.kafka.image
and Kafka.spec.kafka.version
properties as follows:
-
If neither
Kafka.spec.kafka.image
norKafka.spec.kafka.version
are given in the custom resource then theversion
will default to the Cluster Operator’s default Kafka version, and the image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
If
Kafka.spec.kafka.image
is given butKafka.spec.kafka.version
is not then the given image will be used and theversion
will be assumed to be the Cluster Operator’s default Kafka version. -
If
Kafka.spec.kafka.version
is given butKafka.spec.kafka.image
is not then image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
Both
Kafka.spec.kafka.version
andKafka.spec.kafka.image
are given the given image will be used, and it will be assumed to contain a Kafka broker with the given version.
It is best to provide just Kafka.spec.kafka.version
and leave the Kafka.spec.kafka.image
property unspecified. This reduces the chances of making a mistake in configuring the Kafka
resource. If you need to change the images used for different versions of Kafka, it is better to configure the Cluster Operator’s STRIMZI_KAFKA_IMAGES
environment variable.
3.2.11.1.2. Configuring the image
property in other resources
For the image
property in the other custom resources, the given value will be used during deployment. If the image
property is missing, the image
specified in the Cluster Operator configuration will be used. If the image
name is not defined in the Cluster Operator configuration, then the default value will be used.
For Kafka broker TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_KAFKA_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper nodes:
-
Container image specified in the
STRIMZI_DEFAULT_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper node TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Topic Operator:
-
Container image specified in the
STRIMZI_DEFAULT_TOPIC_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For User Operator:
-
Container image specified in the
STRIMZI_DEFAULT_USER_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For Entity Operator TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ENTITY_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect with Source2image support:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_S2I_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such case, you should either copy the AMQ Streams images or build them from source. In case the configured image is not compatible with AMQ Streams images, it might not work properly.
Example of container image configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
3.2.11.2. Configuring container images
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
image
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.12. Configuring pod scheduling
When two applications are scheduled to the same OpenShift node, both applications might use the same resources like disk I/O and impact performance. That can lead to performance degradation. Scheduling Kafka pods in a way that avoids sharing nodes with other critical workloads, using the right nodes or dedicated a set of nodes only for Kafka are the best ways how to avoid such problems.
3.2.12.1. Scheduling pods based on other applications
3.2.12.1.1. Avoid critical applications to share the node
Pod anti-affinity can be used to ensure that critical applications are never scheduled on the same disk. When running Kafka cluster, it is recommended to use pod anti-affinity to ensure that the Kafka brokers do not share the nodes with other workloads like databases.
3.2.12.1.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.2.12.1.3. Configuring pod anti-affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
affinity
property in the resource specifying the cluster deployment. Use labels to specify the pods which should not be scheduled on the same nodes. ThetopologyKey
should be set tokubernetes.io/hostname
to specify that the selected pods should not be scheduled on nodes with the same hostname. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: podAntiAffinity: requiredDuringSchedulingIgnoredDuringExecution: - labelSelector: matchExpressions: - key: application operator: In values: - postgresql - mongodb topologyKey: "kubernetes.io/hostname" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.12.2. Scheduling pods to specific nodes
3.2.12.2.1. Node scheduling
The OpenShift cluster usually consists of many different types of worker nodes. Some are optimized for CPU heavy workloads, some for memory, while other might be optimized for storage (fast local SSDs) or network. Using different nodes helps to optimize both costs and performance. To achieve the best possible performance, it is important to allow scheduling of AMQ Streams components to use the right nodes.
OpenShift uses node affinity to schedule workloads onto specific nodes. Node affinity allows you to create a scheduling constraint for the node on which the pod will be scheduled. The constraint is specified as a label selector. You can specify the label using either the built-in node label like beta.kubernetes.io/instance-type
or custom labels to select the right node.
3.2.12.2.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.2.12.2.3. Configuring node affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Label the nodes where AMQ Streams components should be scheduled.
This can be done using
oc label
:oc label node your-node node-type=fast-network
Alternatively, some of the existing labels might be reused.
Edit the
affinity
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: node-type operator: In values: - fast-network # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.12.3. Using dedicated nodes
3.2.12.3.1. Dedicated nodes
Cluster administrators can mark selected OpenShift nodes as tainted. Nodes with taints are excluded from regular scheduling and normal pods will not be scheduled to run on them. Only services which can tolerate the taint set on the node can be scheduled on it. The only other services running on such nodes will be system services such as log collectors or software defined networks.
Taints can be used to create dedicated nodes. Running Kafka and its components on dedicated nodes can have many advantages. There will be no other applications running on the same nodes which could cause disturbance or consume the resources needed for Kafka. That can lead to improved performance and stability.
To schedule Kafka pods on the dedicated nodes, configure node affinity and tolerations.
3.2.12.3.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.2.12.3.3. Tolerations
Tolerations can be configured using the tolerations
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The format of the tolerations
property follows the OpenShift specification. For more details, see the Kubernetes taints and tolerations.
3.2.12.3.4. Setting up dedicated nodes and scheduling pods on them
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
- Select the nodes which should be used as dedicated.
- Make sure there are no workloads scheduled on these nodes.
Set the taints on the selected nodes:
This can be done using
oc adm taint
:oc adm taint node your-node dedicated=Kafka:NoSchedule
Additionally, add a label to the selected nodes as well.
This can be done using
oc label
:oc label node your-node dedicated=Kafka
Edit the
affinity
andtolerations
properties in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: tolerations: - key: "dedicated" operator: "Equal" value: "Kafka" effect: "NoSchedule" affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: dedicated operator: In values: - Kafka # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.2.13. Using external configuration and secrets
Kafka Connect connectors are configured using an HTTP REST interface. The connector configuration is passed to Kafka Connect as part of an HTTP request and stored within Kafka itself.
Some parts of the configuration of a Kafka Connect connector can be externalized using ConfigMaps or Secrets. You can then reference the configuration values in HTTP REST commands (this keeps the configuration separate and more secure, if needed). This method applies especially to confidential data, such as usernames, passwords, or certificates.
ConfigMaps and Secrets are standard OpenShift resources used for storing of configurations and confidential data.
3.2.13.1. Storing connector configurations externally
You can mount ConfigMaps or Secrets into a Kafka Connect pod as volumes or environment variables. Volumes and environment variables are configured in the externalConfiguration
property in KafkaConnect.spec
and KafkaConnectS2I.spec
.
3.2.13.1.1. External configuration as environment variables
The env
property is used to specify one or more environment variables. These variables can contain a value from either a ConfigMap or a Secret.
The names of user-defined environment variables cannot start with KAFKA_
or STRIMZI_
.
To mount a value from a Secret to an environment variable, use the valueFrom
property and the secretKeyRef
as shown in the following example.
Example of an environment variable set to a value from a Secret
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: env: - name: MY_ENVIRONMENT_VARIABLE valueFrom: secretKeyRef: name: my-secret key: my-key
A common use case for mounting Secrets to environment variables is when your connector needs to communicate with Amazon AWS and needs to read the AWS_ACCESS_KEY_ID
and AWS_SECRET_ACCESS_KEY
environment variables with credentials.
To mount a value from a ConfigMap to an environment variable, use configMapKeyRef
in the valueFrom
property as shown in the following example.
Example of an environment variable set to a value from a ConfigMap
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: env: - name: MY_ENVIRONMENT_VARIABLE valueFrom: configMapKeyRef: name: my-config-map key: my-key
3.2.13.1.2. External configuration as volumes
You can also mount ConfigMaps or Secrets to a Kafka Connect pod as volumes. Using volumes instead of environment variables is useful in the following scenarios:
- Mounting truststores or keystores with TLS certificates
- Mounting a properties file that is used to configure Kafka Connect connectors
In the volumes
property of the externalConfiguration
resource, list the ConfigMaps or Secrets that will be mounted as volumes. Each volume must specify a name in the name
property and a reference to ConfigMap or Secret.
Example of volumes with external configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: volumes: - name: connector1 configMap: name: connector1-configuration - name: connector1-certificates secret: secretName: connector1-certificates
The volumes will be mounted inside the Kafka Connect containers in the path /opt/kafka/external-configuration/<volume-name>
. For example, the files from a volume named connector1
would appear in the directory /opt/kafka/external-configuration/connector1
.
The FileConfigProvider
has to be used to read the values from the mounted properties files in connector configurations.
3.2.13.2. Mounting Secrets as environment variables
You can create an OpenShift Secret and mount it to Kafka Connect as an environment variable.
Prerequisites
- A running Cluster Operator.
Procedure
Create a secret containing the information that will be mounted as an environment variable. For example:
apiVersion: v1 kind: Secret metadata: name: aws-creds type: Opaque data: awsAccessKey: QUtJQVhYWFhYWFhYWFhYWFg= awsSecretAccessKey: Ylhsd1lYTnpkMjl5WkE=
Create or edit the Kafka Connect resource. Configure the
externalConfiguration
section of theKafkaConnect
orKafkaConnectS2I
custom resource to reference the secret. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: env: - name: AWS_ACCESS_KEY_ID valueFrom: secretKeyRef: name: aws-creds key: awsAccessKey - name: AWS_SECRET_ACCESS_KEY valueFrom: secretKeyRef: name: aws-creds key: awsSecretAccessKey
Apply the changes to your Kafka Connect deployment.
Use
oc apply
:oc apply -f your-file
The environment variables are now available for use when developing your connectors.
Additional resources
-
For more information about external configuration in Kafka Connect, see Section C.72, “
ExternalConfiguration
schema reference”.
3.2.13.3. Mounting Secrets as volumes
You can create an OpenShift Secret, mount it as a volume to Kafka Connect, and then use it to configure a Kafka Connect connector.
Prerequisites
- A running Cluster Operator.
Procedure
Create a secret containing a properties file that defines the configuration options for your connector configuration. For example:
apiVersion: v1 kind: Secret metadata: name: mysecret type: Opaque stringData: connector.properties: |- dbUsername: my-user dbPassword: my-password
Create or edit the Kafka Connect resource. Configure the
FileConfigProvider
in theconfig
section and theexternalConfiguration
section of theKafkaConnect
orKafkaConnectS2I
custom resource to reference the secret. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... config: config.providers: file config.providers.file.class: org.apache.kafka.common.config.provider.FileConfigProvider #... externalConfiguration: volumes: - name: connector-config secret: secretName: mysecret
Apply the changes to your Kafka Connect deployment.
Use
oc apply
:oc apply -f your-file
Use the values from the mounted properties file in your JSON payload with connector configuration. For example:
{ "name":"my-connector", "config":{ "connector.class":"MyDbConnector", "tasks.max":"3", "database": "my-postgresql:5432" "username":"${file:/opt/kafka/external-configuration/connector-config/connector.properties:dbUsername}", "password":"${file:/opt/kafka/external-configuration/connector-config/connector.properties:dbPassword}", # ... } }
Additional resources
-
For more information about external configuration in Kafka Connect, see Section C.72, “
ExternalConfiguration
schema reference”.
3.2.14. List of resources created as part of Kafka Connect cluster
The following resources will created by the Cluster Operator in the OpenShift cluster:
- connect-cluster-name-connect
- Deployment which is in charge to create the Kafka Connect worker node pods.
- connect-cluster-name-connect-api
- Service which exposes the REST interface for managing the Kafka Connect cluster.
- connect-cluster-name-config
- ConfigMap which contains the Kafka Connect ancillary configuration and is mounted as a volume by the Kafka broker pods.
- connect-cluster-name-connect
- Pod Disruption Budget configured for the Kafka Connect worker nodes.
3.3. Kafka Connect cluster with Source2Image support
The full schema of the KafkaConnectS2I
resource is described in the Section C.78, “KafkaConnectS2I
schema reference”. All labels that are applied to the desired KafkaConnectS2I
resource will also be applied to the OpenShift resources making up the Kafka Connect cluster with Source2Image support. This provides a convenient mechanism for resources to be labeled as required.
3.3.1. Replicas
Kafka Connect clusters can run multiple of nodes. The number of nodes is defined in the KafkaConnect
and KafkaConnectS2I
resources. Running a Kafka Connect cluster with multiple nodes can provide better availability and scalability. However, when running Kafka Connect on OpenShift it is not absolutely necessary to run multiple nodes of Kafka Connect for high availability. If a node where Kafka Connect is deployed to crashes, OpenShift will automatically reschedule the Kafka Connect pod to a different node. However, running Kafka Connect with multiple nodes can provide faster failover times, because the other nodes will be up and running already.
3.3.1.1. Configuring the number of nodes
The number of Kafka Connect nodes is configured using the replicas
property in KafkaConnect.spec
and KafkaConnectS2I.spec
.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
replicas
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnectS2I metadata: name: my-cluster spec: # ... replicas: 3 # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.2. Bootstrap servers
A Kafka Connect cluster always works in combination with a Kafka cluster. A Kafka cluster is specified as a list of bootstrap servers. On OpenShift, the list must ideally contain the Kafka cluster bootstrap service named cluster-name-kafka-bootstrap
, and a port of 9092 for plain traffic or 9093 for encrypted traffic.
The list of bootstrap servers is configured in the bootstrapServers
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. The servers must be defined as a comma-separated list specifying one or more Kafka brokers, or a service pointing to Kafka brokers specified as a hostname:_port_
pairs.
When using Kafka Connect with a Kafka cluster not managed by AMQ Streams, you can specify the bootstrap servers list according to the configuration of the cluster.
3.3.2.1. Configuring bootstrap servers
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
bootstrapServers
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... bootstrapServers: my-cluster-kafka-bootstrap:9092 # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.3. Connecting to Kafka brokers using TLS
By default, Kafka Connect tries to connect to Kafka brokers using a plain text connection. If you prefer to use TLS, additional configuration is required.
3.3.3.1. TLS support in Kafka Connect
TLS support is configured in the tls
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. The tls
property contains a list of secrets with key names under which the certificates are stored. The certificates must be stored in X509 format.
An example showing TLS configuration with multiple certificates
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... tls: trustedCertificates: - secretName: my-secret certificate: ca.crt - secretName: my-other-secret certificate: certificate.crt # ...
When multiple certificates are stored in the same secret, it can be listed multiple times.
An example showing TLS configuration with multiple certificates from the same secret
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnectS2I metadata: name: my-cluster spec: # ... tls: trustedCertificates: - secretName: my-secret certificate: ca.crt - secretName: my-secret certificate: ca2.crt # ...
3.3.3.2. Configuring TLS in Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
-
If they exist, the name of the
Secret
for the certificate used for TLS Server Authentication, and the key under which the certificate is stored in theSecret
Procedure
(Optional) If they do not already exist, prepare the TLS certificate used in authentication in a file and create a
Secret
.NoteThe secrets created by the Cluster Operator for Kafka cluster may be used directly.
This can be done using
oc create
:oc create secret generic my-secret --from-file=my-file.crt
Edit the
tls
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... tls: trustedCertificates: - secretName: my-cluster-cluster-cert certificate: ca.crt # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.4. Connecting to Kafka brokers with Authentication
By default, Kafka Connect will try to connect to Kafka brokers without authentication. Authentication is enabled through the KafkaConnect
and KafkaConnectS2I
resources.
3.3.4.1. Authentication support in Kafka Connect
Authentication is configured through the authentication
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. The authentication
property specifies the type of the authentication mechanisms which should be used and additional configuration details depending on the mechanism. The supported authentication types are:
- TLS client authentication
- SASL-based authentication using the SCRAM-SHA-512 mechanism
- SASL-based authentication using the PLAIN mechanism
- OAuth 2.0 token based authentication
3.3.4.1.1. TLS Client Authentication
To use TLS client authentication, set the type
property to the value tls
. TLS client authentication uses a TLS certificate to authenticate. The certificate is specified in the certificateAndKey
property and is always loaded from an OpenShift secret. In the secret, the certificate must be stored in X509 format under two different keys: public and private.
TLS client authentication can be used only with TLS connections. For more details about TLS configuration in Kafka Connect see Section 3.3.3, “Connecting to Kafka brokers using TLS”.
An example TLS client authentication configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... authentication: type: tls certificateAndKey: secretName: my-secret certificate: public.crt key: private.key # ...
3.3.4.1.2. SASL based SCRAM-SHA-512 authentication
To configure Kafka Connect to use SASL-based SCRAM-SHA-512 authentication, set the type
property to scram-sha-512
. This authentication mechanism requires a username and password.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name of theSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example SASL based SCRAM-SHA-512 client authentication configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... authentication: type: scram-sha-512 username: my-connect-user passwordSecret: secretName: my-connect-user password: my-connect-password-key # ...
3.3.4.1.3. SASL based PLAIN authentication
To configure Kafka Connect to use SASL-based PLAIN authentication, set the type
property to plain
. This authentication mechanism requires a username and password.
The SASL PLAIN mechanism will transfer the username and password across the network in cleartext. Only use SASL PLAIN authentication if TLS encryption is enabled.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name of such aSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example showing SASL based PLAIN client authentication configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-cluster spec: # ... authentication: type: plain username: my-connect-user passwordSecret: secretName: my-connect-user password: my-connect-password-key # ...
3.3.4.2. Configuring TLS client authentication in Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
-
If they exist, the name of the
Secret
with the public and private keys used for TLS Client Authentication, and the keys under which they are stored in theSecret
Procedure
(Optional) If they do not already exist, prepare the keys used for authentication in a file and create the
Secret
.NoteSecrets created by the User Operator may be used.
This can be done using
oc create
:oc create secret generic my-secret --from-file=my-public.crt --from-file=my-private.key
Edit the
authentication
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... authentication: type: tls certificateAndKey: secretName: my-secret certificate: my-public.crt key: my-private.key # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.4.3. Configuring SCRAM-SHA-512 authentication in Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
- Username of the user which should be used for authentication
-
If they exist, the name of the
Secret
with the password used for authentication and the key under which the password is stored in theSecret
Procedure
(Optional) If they do not already exist, prepare a file with the password used in authentication and create the
Secret
.NoteSecrets created by the User Operator may be used.
This can be done using
oc create
:echo -n '<password>' > <my-password.txt> oc create secret generic <my-secret> --from-file=<my-password.txt>
Edit the
authentication
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... authentication: type: scram-sha-512 username: _<my-username>_ passwordSecret: secretName: _<my-secret>_ password: _<my-password.txt>_ # ...
Create or update the resource.
On OpenShift this can be done using
oc apply
:oc apply -f your-file
3.3.5. Kafka Connect configuration
AMQ Streams allows you to customize the configuration of Apache Kafka Connect nodes by editing certain options listed in Apache Kafka documentation.
Configuration options that cannot be configured relate to:
- Kafka cluster bootstrap address
- Security (Encryption, Authentication, and Authorization)
- Listener / REST interface configuration
- Plugin path configuration
These options are automatically configured by AMQ Streams.
3.3.5.1. Kafka Connect configuration
Kafka Connect is configured using the config
property in KafkaConnect.spec
and KafkaConnectS2I.spec
. This property contains the Kafka Connect configuration options as keys. The values can be one of the following JSON types:
- String
- Number
- Boolean
You can specify and configure the options listed in the Apache Kafka documentation with the exception of those options that are managed directly by AMQ Streams. Specifically, configuration options with keys equal to or starting with one of the following strings are forbidden:
-
ssl.
-
sasl.
-
security.
-
listeners
-
plugin.path
-
rest.
-
bootstrap.servers
When a forbidden option is present in the config
property, it is ignored and a warning message is printed to the Custer Operator log file. All other options are passed to Kafka Connect.
The Cluster Operator does not validate keys or values in the config
object provided. When an invalid configuration is provided, the Kafka Connect cluster might not start or might become unstable. In this circumstance, fix the configuration in the KafkaConnect.spec.config
or KafkaConnectS2I.spec.config
object, then the Cluster Operator can roll out the new configuration to all Kafka Connect nodes.
Certain options have default values:
-
group.id
with default valueconnect-cluster
-
offset.storage.topic
with default valueconnect-cluster-offsets
-
config.storage.topic
with default valueconnect-cluster-configs
-
status.storage.topic
with default valueconnect-cluster-status
-
key.converter
with default valueorg.apache.kafka.connect.json.JsonConverter
-
value.converter
with default valueorg.apache.kafka.connect.json.JsonConverter
These options are automatically configured in case they are not present in the KafkaConnect.spec.config
or KafkaConnectS2I.spec.config
properties.
Example Kafka Connect configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... config: group.id: my-connect-cluster offset.storage.topic: my-connect-cluster-offsets config.storage.topic: my-connect-cluster-configs status.storage.topic: my-connect-cluster-status key.converter: org.apache.kafka.connect.json.JsonConverter value.converter: org.apache.kafka.connect.json.JsonConverter key.converter.schemas.enable: true value.converter.schemas.enable: true config.storage.replication.factor: 3 offset.storage.replication.factor: 3 status.storage.replication.factor: 3 # ...
3.3.5.2. Kafka Connect configuration for multiple instances
If you are running multiple instances of Kafka Connect, pay attention to the default configuration of the following properties:
# ... group.id: connect-cluster 1 offset.storage.topic: connect-cluster-offsets 2 config.storage.topic: connect-cluster-configs 3 status.storage.topic: connect-cluster-status 4 # ...
Values for the three topics must be the same for all Kafka Connect instances with the same group.id
.
Unless you change the default settings, each Kafka Connect instance connecting to the same Kafka cluster is deployed with the same values. What happens, in effect, is all instances are coupled to run in a cluster and use the same topics.
If multiple Kafka Connect clusters try to use the same topics, Kafka Connect will not work as expected and generate errors.
If you wish to run multiple Kafka Connect instances, change the values of these properties for each instance.
3.3.5.3. Configuring Kafka Connect
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
config
property in theKafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... config: group.id: my-connect-cluster offset.storage.topic: my-connect-cluster-offsets config.storage.topic: my-connect-cluster-configs status.storage.topic: my-connect-cluster-status key.converter: org.apache.kafka.connect.json.JsonConverter value.converter: org.apache.kafka.connect.json.JsonConverter key.converter.schemas.enable: true value.converter.schemas.enable: true config.storage.replication.factor: 3 offset.storage.replication.factor: 3 status.storage.replication.factor: 3 # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.6. CPU and memory resources
For every deployed container, AMQ Streams allows you to request specific resources and define the maximum consumption of those resources.
AMQ Streams supports two types of resources:
- CPU
- Memory
AMQ Streams uses the OpenShift syntax for specifying CPU and memory resources.
3.3.6.1. Resource limits and requests
Resource limits and requests are configured using the resources
property in the following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
Additional resources
- For more information about managing computing resources on OpenShift, see Managing Compute Resources for Containers.
3.3.6.1.1. Resource requests
Requests specify the resources to reserve for a given container. Reserving the resources ensures that they are always available.
If the resource request is for more than the available free resources in the OpenShift cluster, the pod is not scheduled.
Resources requests are specified in the requests
property. Resources requests currently supported by AMQ Streams:
-
cpu
-
memory
A request may be configured for one or more supported resources.
Example resource request configuration with all resources
# ... resources: requests: cpu: 12 memory: 64Gi # ...
3.3.6.1.2. Resource limits
Limits specify the maximum resources that can be consumed by a given container. The limit is not reserved and might not always be available. A container can use the resources up to the limit only when they are available. Resource limits should be always higher than the resource requests.
Resource limits are specified in the limits
property. Resource limits currently supported by AMQ Streams:
-
cpu
-
memory
A resource may be configured for one or more supported limits.
Example resource limits configuration
# ... resources: limits: cpu: 12 memory: 64Gi # ...
3.3.6.1.3. Supported CPU formats
CPU requests and limits are supported in the following formats:
-
Number of CPU cores as integer (
5
CPU core) or decimal (2.5
CPU core). -
Number or millicpus / millicores (
100m
) where 1000 millicores is the same1
CPU core.
Example CPU units
# ... resources: requests: cpu: 500m limits: cpu: 2.5 # ...
The computing power of 1 CPU core may differ depending on the platform where OpenShift is deployed.
Additional resources
- For more information on CPU specification, see the Meaning of CPU.
3.3.6.1.4. Supported memory formats
Memory requests and limits are specified in megabytes, gigabytes, mebibytes, and gibibytes.
-
To specify memory in megabytes, use the
M
suffix. For example1000M
. -
To specify memory in gigabytes, use the
G
suffix. For example1G
. -
To specify memory in mebibytes, use the
Mi
suffix. For example1000Mi
. -
To specify memory in gibibytes, use the
Gi
suffix. For example1Gi
.
An example of using different memory units
# ... resources: requests: memory: 512Mi limits: memory: 2Gi # ...
Additional resources
- For more details about memory specification and additional supported units, see Meaning of memory.
3.3.6.2. Configuring resource requests and limits
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
resources
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... resources: requests: cpu: "8" memory: 64Gi limits: cpu: "12" memory: 128Gi # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema, see
Resources
schema reference.
3.3.7. Logging
This section provides information on loggers and how to configure log levels.
You can set the log levels by specifying the loggers and their levels directly (inline) or use a custom (external) config map.
3.3.7.1. Kafka Connect with Source2Image loggers
Kafka Connect with Source2Image support has its own configurable loggers:
-
connect.root.logger.level
-
log4j.logger.org.apache.zookeeper
-
log4j.logger.org.I0Itec.zkclient
-
log4j.logger.org.reflections
3.3.7.2. Specifying inline logging
Procedure
Edit the YAML file to specify the loggers and logging level for the required components.
For example, the logging level here is set to INFO:
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnectS2I spec: # ... logging: type: inline loggers: logger.name: "INFO" # ...
You can set the log level to INFO, ERROR, WARN, TRACE, DEBUG, FATAL or OFF.
For more information about the log levels, see the log4j manual.
Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
3.3.7.3. Specifying an external ConfigMap for logging
Procedure
Edit the YAML file to specify the name of the
ConfigMap
to use for the required components. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnectS2I spec: # ... logging: type: external name: customConfigMap # ...
Remember to place your custom ConfigMap under the
log4j.properties
orlog4j2.properties
key.Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
Garbage collector (GC) logging can also be enabled (or disabled). For more information on GC, see Section 3.1.17.1, “JVM configuration”
3.3.8. Healthchecks
Healthchecks are periodical tests which verify the health of an application. When a Healthcheck probe fails, OpenShift assumes that the application is not healthy and attempts to fix it.
OpenShift supports two types of Healthcheck probes:
- Liveness probes
- Readiness probes
For more details about the probes, see Configure Liveness and Readiness Probes. Both types of probes are used in AMQ Streams components.
Users can configure selected options for liveness and readiness probes.
3.3.8.1. Healthcheck configurations
Liveness and readiness probes can be configured using the livenessProbe
and readinessProbe
properties in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Both livenessProbe
and readinessProbe
support the following options:
-
initialDelaySeconds
-
timeoutSeconds
-
periodSeconds
-
successThreshold
-
failureThreshold
For more information about the livenessProbe
and readinessProbe
options, see Section C.34, “Probe
schema reference”.
An example of liveness and readiness probe configuration
# ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ...
3.3.8.2. Configuring healthchecks
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
livenessProbe
orreadinessProbe
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.9. Prometheus metrics
AMQ Streams supports Prometheus metrics using Prometheus JMX exporter to convert the JMX metrics supported by Apache Kafka and Zookeeper to Prometheus metrics. When metrics are enabled, they are exposed on port 9404.
For more information about configuring Prometheus and Grafana, see Metrics.
3.3.9.1. Metrics configuration
Prometheus metrics are enabled by configuring the metrics
property in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
When the metrics
property is not defined in the resource, the Prometheus metrics will be disabled. To enable Prometheus metrics export without any further configuration, you can set it to an empty object ({}
).
Example of enabling metrics without any further configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... metrics: {} # ... zookeeper: # ...
The metrics
property might contain additional configuration for the Prometheus JMX exporter.
Example of enabling metrics with additional Prometheus JMX Exporter configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... metrics: lowercaseOutputName: true rules: - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*><>Count" name: "kafka_server_$1_$2_total" - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*, topic=(.+)><>Count" name: "kafka_server_$1_$2_total" labels: topic: "$3" # ... zookeeper: # ...
3.3.9.2. Configuring Prometheus metrics
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
metrics
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... metrics: lowercaseOutputName: true # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.10. JVM Options
The following components of AMQ Streams run inside a Virtual Machine (VM):
- Apache Kafka
- Apache Zookeeper
- Apache Kafka Connect
- Apache Kafka Mirror Maker
- AMQ Streams Kafka Bridge
JVM configuration options optimize the performance for different platforms and architectures. AMQ Streams allows you to configure some of these options.
3.3.10.1. JVM configuration
JVM options can be configured using the jvmOptions
property in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Only a selected subset of available JVM options can be configured. The following options are supported:
-Xms and -Xmx
-Xms
configures the minimum initial allocation heap size when the JVM starts. -Xmx
configures the maximum heap size.
The units accepted by JVM settings such as -Xmx
and -Xms
are those accepted by the JDK java
binary in the corresponding image. Accordingly, 1g
or 1G
means 1,073,741,824 bytes, and Gi
is not a valid unit suffix. This is in contrast to the units used for memory requests and limits, which follow the OpenShift convention where 1G
means 1,000,000,000 bytes, and 1Gi
means 1,073,741,824 bytes
The default values used for -Xms
and -Xmx
depends on whether there is a memory request limit configured for the container:
- If there is a memory limit then the JVM’s minimum and maximum memory will be set to a value corresponding to the limit.
-
If there is no memory limit then the JVM’s minimum memory will be set to
128M
and the JVM’s maximum memory will not be defined. This allows for the JVM’s memory to grow as-needed, which is ideal for single node environments in test and development.
Setting -Xmx
explicitly requires some care:
-
The JVM’s overall memory usage will be approximately 4 × the maximum heap, as configured by
-Xmx
. -
If
-Xmx
is set without also setting an appropriate OpenShift memory limit, it is possible that the container will be killed should the OpenShift node experience memory pressure (from other Pods running on it). -
If
-Xmx
is set without also setting an appropriate OpenShift memory request, it is possible that the container will be scheduled to a node with insufficient memory. In this case, the container will not start but crash (immediately if-Xms
is set to-Xmx
, or some later time if not).
When setting -Xmx
explicitly, it is recommended to:
- set the memory request and the memory limit to the same value,
-
use a memory request that is at least 4.5 × the
-Xmx
, -
consider setting
-Xms
to the same value as-Xmx
.
Containers doing lots of disk I/O (such as Kafka broker containers) will need to leave some memory available for use as operating system page cache. On such containers, the requested memory should be significantly higher than the memory used by the JVM.
Example fragment configuring -Xmx
and -Xms
# ... jvmOptions: "-Xmx": "2g" "-Xms": "2g" # ...
In the above example, the JVM will use 2 GiB (=2,147,483,648 bytes) for its heap. Its total memory usage will be approximately 8GiB.
Setting the same value for initial (-Xms
) and maximum (-Xmx
) heap sizes avoids the JVM having to allocate memory after startup, at the cost of possibly allocating more heap than is really needed. For Kafka and Zookeeper pods such allocation could cause unwanted latency. For Kafka Connect avoiding over allocation may be the most important concern, especially in distributed mode where the effects of over-allocation will be multiplied by the number of consumers.
-server
-server
enables the server JVM. This option can be set to true or false.
Example fragment configuring -server
# ... jvmOptions: "-server": true # ...
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
-XX
-XX
object can be used for configuring advanced runtime options of a JVM. The -server
and -XX
options are used to configure the KAFKA_JVM_PERFORMANCE_OPTS
option of Apache Kafka.
Example showing the use of the -XX
object
jvmOptions: "-XX": "UseG1GC": true "MaxGCPauseMillis": 20 "InitiatingHeapOccupancyPercent": 35 "ExplicitGCInvokesConcurrent": true "UseParNewGC": false
The example configuration above will result in the following JVM options:
-XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -XX:-UseParNewGC
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
3.3.10.1.1. Garbage collector logging
The jvmOptions
section also allows you to enable and disable garbage collector (GC) logging. GC logging is enabled by default. To disable it, set the gcLoggingEnabled
property as follows:
Example of disabling GC logging
# ... jvmOptions: gcLoggingEnabled: false # ...
3.3.10.2. Configuring JVM options
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
jvmOptions
property in theKafka
,KafkaConnect
,KafkaConnectS2I
,KafkaMirrorMaker
, orKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... jvmOptions: "-Xmx": "8g" "-Xms": "8g" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.11. Container images
AMQ Streams allows you to configure container images which will be used for its components. Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such a case, you should either copy the AMQ Streams images or build them from the source. If the configured image is not compatible with AMQ Streams images, it might not work properly.
3.3.11.1. Container image configurations
Container image which should be used for given components can be specified using the image
property in:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
3.3.11.1.1. Configuring the Kafka.spec.kafka.image
property
The Kafka.spec.kafka.image
property functions differently from the others, because AMQ Streams supports multiple versions of Kafka, each requiring the own image. The STRIMZI_KAFKA_IMAGES
environment variable of the Cluster Operator configuration is used to provide a mapping between Kafka versions and the corresponding images. This is used in combination with the Kafka.spec.kafka.image
and Kafka.spec.kafka.version
properties as follows:
-
If neither
Kafka.spec.kafka.image
norKafka.spec.kafka.version
are given in the custom resource then theversion
will default to the Cluster Operator’s default Kafka version, and the image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
If
Kafka.spec.kafka.image
is given butKafka.spec.kafka.version
is not then the given image will be used and theversion
will be assumed to be the Cluster Operator’s default Kafka version. -
If
Kafka.spec.kafka.version
is given butKafka.spec.kafka.image
is not then image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
Both
Kafka.spec.kafka.version
andKafka.spec.kafka.image
are given the given image will be used, and it will be assumed to contain a Kafka broker with the given version.
It is best to provide just Kafka.spec.kafka.version
and leave the Kafka.spec.kafka.image
property unspecified. This reduces the chances of making a mistake in configuring the Kafka
resource. If you need to change the images used for different versions of Kafka, it is better to configure the Cluster Operator’s STRIMZI_KAFKA_IMAGES
environment variable.
3.3.11.1.2. Configuring the image
property in other resources
For the image
property in the other custom resources, the given value will be used during deployment. If the image
property is missing, the image
specified in the Cluster Operator configuration will be used. If the image
name is not defined in the Cluster Operator configuration, then the default value will be used.
For Kafka broker TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_KAFKA_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper nodes:
-
Container image specified in the
STRIMZI_DEFAULT_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper node TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Topic Operator:
-
Container image specified in the
STRIMZI_DEFAULT_TOPIC_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For User Operator:
-
Container image specified in the
STRIMZI_DEFAULT_USER_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For Entity Operator TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ENTITY_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect with Source2image support:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_S2I_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such case, you should either copy the AMQ Streams images or build them from source. In case the configured image is not compatible with AMQ Streams images, it might not work properly.
Example of container image configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
3.3.11.2. Configuring container images
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
image
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.12. Configuring pod scheduling
When two applications are scheduled to the same OpenShift node, both applications might use the same resources like disk I/O and impact performance. That can lead to performance degradation. Scheduling Kafka pods in a way that avoids sharing nodes with other critical workloads, using the right nodes or dedicated a set of nodes only for Kafka are the best ways how to avoid such problems.
3.3.12.1. Scheduling pods based on other applications
3.3.12.1.1. Avoid critical applications to share the node
Pod anti-affinity can be used to ensure that critical applications are never scheduled on the same disk. When running Kafka cluster, it is recommended to use pod anti-affinity to ensure that the Kafka brokers do not share the nodes with other workloads like databases.
3.3.12.1.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.3.12.1.3. Configuring pod anti-affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
affinity
property in the resource specifying the cluster deployment. Use labels to specify the pods which should not be scheduled on the same nodes. ThetopologyKey
should be set tokubernetes.io/hostname
to specify that the selected pods should not be scheduled on nodes with the same hostname. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: podAntiAffinity: requiredDuringSchedulingIgnoredDuringExecution: - labelSelector: matchExpressions: - key: application operator: In values: - postgresql - mongodb topologyKey: "kubernetes.io/hostname" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.12.2. Scheduling pods to specific nodes
3.3.12.2.1. Node scheduling
The OpenShift cluster usually consists of many different types of worker nodes. Some are optimized for CPU heavy workloads, some for memory, while other might be optimized for storage (fast local SSDs) or network. Using different nodes helps to optimize both costs and performance. To achieve the best possible performance, it is important to allow scheduling of AMQ Streams components to use the right nodes.
OpenShift uses node affinity to schedule workloads onto specific nodes. Node affinity allows you to create a scheduling constraint for the node on which the pod will be scheduled. The constraint is specified as a label selector. You can specify the label using either the built-in node label like beta.kubernetes.io/instance-type
or custom labels to select the right node.
3.3.12.2.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.3.12.2.3. Configuring node affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Label the nodes where AMQ Streams components should be scheduled.
This can be done using
oc label
:oc label node your-node node-type=fast-network
Alternatively, some of the existing labels might be reused.
Edit the
affinity
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: node-type operator: In values: - fast-network # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.12.3. Using dedicated nodes
3.3.12.3.1. Dedicated nodes
Cluster administrators can mark selected OpenShift nodes as tainted. Nodes with taints are excluded from regular scheduling and normal pods will not be scheduled to run on them. Only services which can tolerate the taint set on the node can be scheduled on it. The only other services running on such nodes will be system services such as log collectors or software defined networks.
Taints can be used to create dedicated nodes. Running Kafka and its components on dedicated nodes can have many advantages. There will be no other applications running on the same nodes which could cause disturbance or consume the resources needed for Kafka. That can lead to improved performance and stability.
To schedule Kafka pods on the dedicated nodes, configure node affinity and tolerations.
3.3.12.3.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.3.12.3.3. Tolerations
Tolerations can be configured using the tolerations
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The format of the tolerations
property follows the OpenShift specification. For more details, see the Kubernetes taints and tolerations.
3.3.12.3.4. Setting up dedicated nodes and scheduling pods on them
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
- Select the nodes which should be used as dedicated.
- Make sure there are no workloads scheduled on these nodes.
Set the taints on the selected nodes:
This can be done using
oc adm taint
:oc adm taint node your-node dedicated=Kafka:NoSchedule
Additionally, add a label to the selected nodes as well.
This can be done using
oc label
:oc label node your-node dedicated=Kafka
Edit the
affinity
andtolerations
properties in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: tolerations: - key: "dedicated" operator: "Equal" value: "Kafka" effect: "NoSchedule" affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: dedicated operator: In values: - Kafka # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.3.13. Using external configuration and secrets
Kafka Connect connectors are configured using an HTTP REST interface. The connector configuration is passed to Kafka Connect as part of an HTTP request and stored within Kafka itself.
Some parts of the configuration of a Kafka Connect connector can be externalized using ConfigMaps or Secrets. You can then reference the configuration values in HTTP REST commands (this keeps the configuration separate and more secure, if needed). This method applies especially to confidential data, such as usernames, passwords, or certificates.
ConfigMaps and Secrets are standard OpenShift resources used for storing of configurations and confidential data.
3.3.13.1. Storing connector configurations externally
You can mount ConfigMaps or Secrets into a Kafka Connect pod as volumes or environment variables. Volumes and environment variables are configured in the externalConfiguration
property in KafkaConnect.spec
and KafkaConnectS2I.spec
.
3.3.13.1.1. External configuration as environment variables
The env
property is used to specify one or more environment variables. These variables can contain a value from either a ConfigMap or a Secret.
The names of user-defined environment variables cannot start with KAFKA_
or STRIMZI_
.
To mount a value from a Secret to an environment variable, use the valueFrom
property and the secretKeyRef
as shown in the following example.
Example of an environment variable set to a value from a Secret
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: env: - name: MY_ENVIRONMENT_VARIABLE valueFrom: secretKeyRef: name: my-secret key: my-key
A common use case for mounting Secrets to environment variables is when your connector needs to communicate with Amazon AWS and needs to read the AWS_ACCESS_KEY_ID
and AWS_SECRET_ACCESS_KEY
environment variables with credentials.
To mount a value from a ConfigMap to an environment variable, use configMapKeyRef
in the valueFrom
property as shown in the following example.
Example of an environment variable set to a value from a ConfigMap
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: env: - name: MY_ENVIRONMENT_VARIABLE valueFrom: configMapKeyRef: name: my-config-map key: my-key
3.3.13.1.2. External configuration as volumes
You can also mount ConfigMaps or Secrets to a Kafka Connect pod as volumes. Using volumes instead of environment variables is useful in the following scenarios:
- Mounting truststores or keystores with TLS certificates
- Mounting a properties file that is used to configure Kafka Connect connectors
In the volumes
property of the externalConfiguration
resource, list the ConfigMaps or Secrets that will be mounted as volumes. Each volume must specify a name in the name
property and a reference to ConfigMap or Secret.
Example of volumes with external configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: volumes: - name: connector1 configMap: name: connector1-configuration - name: connector1-certificates secret: secretName: connector1-certificates
The volumes will be mounted inside the Kafka Connect containers in the path /opt/kafka/external-configuration/<volume-name>
. For example, the files from a volume named connector1
would appear in the directory /opt/kafka/external-configuration/connector1
.
The FileConfigProvider
has to be used to read the values from the mounted properties files in connector configurations.
3.3.13.2. Mounting Secrets as environment variables
You can create an OpenShift Secret and mount it to Kafka Connect as an environment variable.
Prerequisites
- A running Cluster Operator.
Procedure
Create a secret containing the information that will be mounted as an environment variable. For example:
apiVersion: v1 kind: Secret metadata: name: aws-creds type: Opaque data: awsAccessKey: QUtJQVhYWFhYWFhYWFhYWFg= awsSecretAccessKey: Ylhsd1lYTnpkMjl5WkE=
Create or edit the Kafka Connect resource. Configure the
externalConfiguration
section of theKafkaConnect
orKafkaConnectS2I
custom resource to reference the secret. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... externalConfiguration: env: - name: AWS_ACCESS_KEY_ID valueFrom: secretKeyRef: name: aws-creds key: awsAccessKey - name: AWS_SECRET_ACCESS_KEY valueFrom: secretKeyRef: name: aws-creds key: awsSecretAccessKey
Apply the changes to your Kafka Connect deployment.
Use
oc apply
:oc apply -f your-file
The environment variables are now available for use when developing your connectors.
Additional resources
-
For more information about external configuration in Kafka Connect, see Section C.72, “
ExternalConfiguration
schema reference”.
3.3.13.3. Mounting Secrets as volumes
You can create an OpenShift Secret, mount it as a volume to Kafka Connect, and then use it to configure a Kafka Connect connector.
Prerequisites
- A running Cluster Operator.
Procedure
Create a secret containing a properties file that defines the configuration options for your connector configuration. For example:
apiVersion: v1 kind: Secret metadata: name: mysecret type: Opaque stringData: connector.properties: |- dbUsername: my-user dbPassword: my-password
Create or edit the Kafka Connect resource. Configure the
FileConfigProvider
in theconfig
section and theexternalConfiguration
section of theKafkaConnect
orKafkaConnectS2I
custom resource to reference the secret. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect spec: # ... config: config.providers: file config.providers.file.class: org.apache.kafka.common.config.provider.FileConfigProvider #... externalConfiguration: volumes: - name: connector-config secret: secretName: mysecret
Apply the changes to your Kafka Connect deployment.
Use
oc apply
:oc apply -f your-file
Use the values from the mounted properties file in your JSON payload with connector configuration. For example:
{ "name":"my-connector", "config":{ "connector.class":"MyDbConnector", "tasks.max":"3", "database": "my-postgresql:5432" "username":"${file:/opt/kafka/external-configuration/connector-config/connector.properties:dbUsername}", "password":"${file:/opt/kafka/external-configuration/connector-config/connector.properties:dbPassword}", # ... } }
Additional resources
-
For more information about external configuration in Kafka Connect, see Section C.72, “
ExternalConfiguration
schema reference”.
3.3.14. List of resources created as part of Kafka Connect cluster with Source2Image support
The following resources will created by the Cluster Operator in the OpenShift cluster:
- connect-cluster-name-connect-source
- ImageStream which is used as the base image for the newly-built Docker images.
- connect-cluster-name-connect
- BuildConfig which is responsible for building the new Kafka Connect Docker images.
- connect-cluster-name-connect
- ImageStream where the newly built Docker images will be pushed.
- connect-cluster-name-connect
- DeploymentConfig which is in charge of creating the Kafka Connect worker node pods.
- connect-cluster-name-connect-api
- Service which exposes the REST interface for managing the Kafka Connect cluster.
- connect-cluster-name-config
- ConfigMap which contains the Kafka Connect ancillary configuration and is mounted as a volume by the Kafka broker pods.
- connect-cluster-name-connect
- Pod Disruption Budget configured for the Kafka Connect worker nodes.
3.3.15. Creating a container image using OpenShift builds and Source-to-Image
You can use OpenShift builds and the Source-to-Image (S2I) framework to create new container images. An OpenShift build takes a builder image with S2I support, together with source code and binaries provided by the user, and uses them to build a new container image. Once built, container images are stored in OpenShift’s local container image repository and are available for use in deployments.
A Kafka Connect builder image with S2I support is provided on the Red Hat Container Catalog as part of the registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
image. This S2I image takes your binaries (with plug-ins and connectors) and stores them in the /tmp/kafka-plugins/s2i
directory. It creates a new Kafka Connect image from this directory, which can then be used with the Kafka Connect deployment. When started using the enhanced image, Kafka Connect loads any third-party plug-ins from the /tmp/kafka-plugins/s2i
directory.
Procedure
On the command line, use the
oc apply
command to create and deploy a Kafka Connect S2I cluster:oc apply -f examples/kafka-connect/kafka-connect-s2i.yaml
Create a directory with Kafka Connect plug-ins:
$ tree ./my-plugins/ ./my-plugins/ ├── debezium-connector-mongodb │ ├── bson-3.4.2.jar │ ├── CHANGELOG.md │ ├── CONTRIBUTE.md │ ├── COPYRIGHT.txt │ ├── debezium-connector-mongodb-0.7.1.jar │ ├── debezium-core-0.7.1.jar │ ├── LICENSE.txt │ ├── mongodb-driver-3.4.2.jar │ ├── mongodb-driver-core-3.4.2.jar │ └── README.md ├── debezium-connector-mysql │ ├── CHANGELOG.md │ ├── CONTRIBUTE.md │ ├── COPYRIGHT.txt │ ├── debezium-connector-mysql-0.7.1.jar │ ├── debezium-core-0.7.1.jar │ ├── LICENSE.txt │ ├── mysql-binlog-connector-java-0.13.0.jar │ ├── mysql-connector-java-5.1.40.jar │ ├── README.md │ └── wkb-1.0.2.jar └── debezium-connector-postgres ├── CHANGELOG.md ├── CONTRIBUTE.md ├── COPYRIGHT.txt ├── debezium-connector-postgres-0.7.1.jar ├── debezium-core-0.7.1.jar ├── LICENSE.txt ├── postgresql-42.0.0.jar ├── protobuf-java-2.6.1.jar └── README.md
Use the
oc start-build
command to start a new build of the image using the prepared directory:oc start-build my-connect-cluster-connect --from-dir ./my-plugins/
NoteThe name of the build is the same as the name of the deployed Kafka Connect cluster.
- Once the build has finished, the new image is used automatically by the Kafka Connect deployment.
3.4. Kafka Mirror Maker configuration
This chapter describes how to configure the KafkaMirrorMaker
resource to support a Kafka Mirror Maker deployment in your cluster.
The following procedures show how the resource is configured:
Supported properties are also described in more detail for your reference:
The full schema of the KafkaMirrorMaker
resource is described in the KafkaMirrorMaker schema reference.
Labels applied to a KafkaMirrorMaker
resource are also applied to the OpenShift resources comprising Kafka Mirror Maker. This provides a convenient mechanism for resources to be labeled as required.
3.4.1. Configuring Kafka Mirror Maker
Use the properties of the KafkaMirrorMaker
resource to configure your Kafka Mirror Maker deployment.
You can configure access control for producers and consumers using TLS or SASL authentication. This procedure shows a configuration that uses TLS encryption and authentication on the consumer and producer side.
Prerequisites
- AMQ Streams and Kafka is deployed
- Source and target Kafka clusters are available
Procedure
Edit the
spec
properties for theKafkaMirrorMaker
resource.The properties you can configure are shown in this example configuration:
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaMirrorMaker metadata: name: my-mirror-maker spec: replicas: 3 1 consumer: bootstrapServers: my-source-cluster-kafka-bootstrap:9092 2 groupId: "my-group" 3 numStreams: 2 4 offsetCommitInterval: 120000 5 tls: 6 trustedCertificates: - secretName: my-source-cluster-ca-cert certificate: ca.crt authentication: 7 type: tls certificateAndKey: secretName: my-source-secret certificate: public.crt key: private.key config: 8 max.poll.records: 100 receive.buffer.bytes: 32768 producer: bootstrapServers: my-target-cluster-kafka-bootstrap:9092 abortOnSendFailure: false 9 tls: trustedCertificates: - secretName: my-target-cluster-ca-cert certificate: ca.crt authentication: type: tls certificateAndKey: secretName: my-target-secret certificate: public.crt key: private.key config: compression.type: gzip batch.size: 8192 whitelist: "my-topic|other-topic" 10 resources: 11 requests: cpu: "1" memory: 2Gi limits: cpu: "2" memory: 2Gi logging: 12 type: inline loggers: mirrormaker.root.logger: "INFO" readinessProbe: 13 initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 metrics: 14 lowercaseOutputName: true rules: - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*><>Count" name: "kafka_server_$1_$2_total" - pattern: "kafka.server<type=(.+), name=(.+)PerSec\\w*, topic=(.+)><>Count" name: "kafka_server_$1_$2_total" labels: topic: "$3" jvmOptions: 15 "-Xmx": "1g" "-Xms": "1g" image: my-org/my-image:latest 16 template: 17 pod: affinity: podAntiAffinity: requiredDuringSchedulingIgnoredDuringExecution: - labelSelector: matchExpressions: - key: application operator: In values: - postgresql - mongodb topologyKey: "kubernetes.io/hostname"
- 1
- The number of replica nodes.
- 2
- Bootstrap servers for consumer and producer.
- 3
- Group ID for the consumer.
- 4
- The number of consumer streams.
- 5
- The offset auto-commit interval in milliseconds.
- 6
- TLS encryption with key names under which TLS certificates are stored in X.509 format for consumer or producer. For more details see
KafkaMirrorMakerTls
schema reference. - 7
- Authentication for consumer or producer, using the TLS mechanism, as shown here, using OAuth bearer tokens, or a SASL-based SCRAM-SHA-512 or PLAIN mechanism.
- 8
- Kafka configuration options for consumer and producer.
- 9
- If set to
true
, Kafka Mirror Maker will exit and the container will restart following a send failure for a message. - 10
- Topics mirrored from source to target Kafka cluster.
- 11
- Requests for reservation of supported resources, currently
cpu
andmemory
, and limits to specify the maximum resources that can be consumed. - 12
- Specified loggers and log levels added directly (
inline
) or indirectly (external
) through a ConfigMap. A custom ConfigMap must be placed under thelog4j.properties
orlog4j2.properties
key. Mirror Maker has a single logger calledmirrormaker.root.logger
. You can set the log level to INFO, ERROR, WARN, TRACE, DEBUG, FATAL or OFF. - 13
- Healthchecks to know when to restart a container (liveness) and when a container can accept traffic (readiness).
- 14
- Prometheus metrics, which are enabled with configuration for the Prometheus JMX exporter in this example. You can enable metrics without further configuration using
metrics: {}
. - 15
- JVM configuration options to optimize performance for the Virtual Machine (VM) running Kafka Mirror Maker.
- 16
- ADVANCED OPTION: Container image configuration, which is recommended only in special situations.
- 17
- Template customization. Here a pod is scheduled based with anti-affinity, so the pod is not scheduled on nodes with the same hostname.
WarningWith the
abortOnSendFailure
property set tofalse
, the producer attempts to send the next message in a topic. The original message might be lost, as there is no attempt to resend a failed message.Create or update the resource:
oc apply -f <your-file>
3.4.2. Kafka Mirror Maker configuration properties
Use the spec
configuration properties of the KafkaMirrorMaker
resource to set up your Mirror Maker deployment.
Supported properties are described here for your reference.
3.4.2.1. Replicas
Use the replicas
property to configure replicas.
You can run multiple Mirror Maker replicas to provide better availability and scalability. When running Kafka Mirror Maker on OpenShift it is not absolutely necessary to run multiple replicas of the Kafka Mirror Maker for high availability. When the node where the Kafka Mirror Maker has deployed crashes, OpenShift will automatically reschedule the Kafka Mirror Maker pod to a different node. However, running Kafka Mirror Maker with multiple replicas can provide faster failover times as the other nodes will be up and running.
3.4.2.2. Bootstrap servers
Use the consumer.bootstrapServers
and producer.bootstrapServers
properties to configure lists of bootstrap servers for the consumer and producer.
Kafka Mirror Maker always works together with two Kafka clusters (source and target). The source and the target Kafka clusters are specified in the form of two lists of comma-separated list of <hostname>:<port>
pairs. Each comma-separated list contains one or more Kafka brokers or a Service
pointing to Kafka brokers specified as a <hostname>:<port>
pairs.
The bootstrap server lists can refer to Kafka clusters that do not need to be deployed in the same OpenShift cluster. They can even refer to a Kafka cluster not deployed by AMQ Streams, or deployed by AMQ Streams but on a different OpenShift cluster accessible outside.
If on the same OpenShift cluster, each list must ideally contain the Kafka cluster bootstrap service which is named <cluster-name>-kafka-bootstrap
and a port of 9092 for plain traffic or 9093 for encrypted traffic. If deployed by AMQ Streams but on different OpenShift clusters, the list content depends on the approach used for exposing the clusters (routes, nodeports or loadbalancers).
When using Kafka Mirror Maker with a Kafka cluster not managed by AMQ Streams, you can specify the bootstrap servers list according to the configuration of the given cluster.
3.4.2.3. Whitelist
Use the whitelist
property to configure a list of topics that Kafka Mirror Maker mirrors from the source to the target Kafka cluster.
The property allows any regular expression from the simplest case with a single topic name to complex patterns. For example, you can mirror topics A and B using "A|B" or all topics using "*". You can also pass multiple regular expressions separated by commas to the Kafka Mirror Maker.
3.4.2.4. Consumer group identifier
Use the consumer.groupId
property to configure a consumer group identifier for the consumer.
Kafka Mirror Maker uses a Kafka consumer to consume messages, behaving like any other Kafka consumer client. Messages consumed from the source Kafka cluster are mirrored to a target Kafka cluster. A group identifier is required, as the consumer needs to be part of a consumer group for the assignment of partitions.
3.4.2.5. Consumer streams
Use the consumer.numStreams
property to configure the number of streams for the consumer.
You can increase the throughput in mirroring topics by increasing the number of consumer threads. Consumer threads belong to the consumer group specified for Kafka Mirror Maker. Topic partitions are assigned across the consumer threads, which consume messages in parallel.
3.4.2.6. Offset auto-commit interval
Use the consumer.offsetCommitInterval
property to configure an offset auto-commit interval for the consumer.
You can specify the regular time interval at which an offset is committed after Kafka Mirror Maker has consumed data from the source Kafka cluster. The time interval is set in milliseconds, with a default value of 60,000.
3.4.2.7. Abort on message send failure
Use the producer.abortOnSendFailure
property to configure how to handle message send failure from the producer.
By default, if an error occurs when sending a message from Kafka Mirror Maker to a Kafka cluster:
- The Kafka Mirror Maker container is terminated in OpenShift.
- The container is then recreated.
If the abortOnSendFailure
option is set to false
, message sending errors are ignored.
3.4.2.8. Kafka producer and consumer
Use the consumer.config
and producer.config
properties to configure Kafka options for the consumer and producer.
The config
property contains the Kafka Mirror Maker consumer and producer configuration options as keys, with values set in one of the following JSON types:
- String
- Number
- Boolean
Exceptions
You can specify and configure standard Kafka consumer and producer options:
However, there are exceptions for options automatically configured and managed directly by AMQ Streams related to:
- Kafka cluster bootstrap address
- Security (encryption, authentication, and authorization)
- Consumer group identifier
Specifically, all configuration options with keys equal to or starting with one of the following strings are forbidden:
-
ssl.
-
sasl.
-
security.
-
bootstrap.servers
-
group.id
When a forbidden option is present in the config
property, it is ignored and a warning message is printed to the Custer Operator log file. All other options are passed to Kafka Mirror Maker.
The Cluster Operator does not validate keys or values in the provided config
object. When an invalid configuration is provided, the Kafka Mirror Maker might not start or might become unstable. In such cases, the configuration in the KafkaMirrorMaker.spec.consumer.config
or KafkaMirrorMaker.spec.producer.config
object should be fixed and the Cluster Operator will roll out the new configuration for Kafka Mirror Maker.
3.4.2.9. CPU and memory resources
Use the reources.requests
and resources.limits
properties to configure resource requests and limits.
For every deployed container, AMQ Streams allows you to request specific resources and define the maximum consumption of those resources.
AMQ Streams supports requests and limits for the following types of resources:
-
cpu
-
memory
AMQ Streams uses the OpenShift syntax for specifying these resources.
For more information about managing computing resources on OpenShift, see Managing Compute Resources for Containers.
Resource requests
Requests specify the resources to reserve for a given container. Reserving the resources ensures that they are always available.
If the resource request is for more than the available free resources in the OpenShift cluster, the pod is not scheduled.
A request may be configured for one or more supported resources.
Resource limits
Limits specify the maximum resources that can be consumed by a given container. The limit is not reserved and might not always be available. A container can use the resources up to the limit only when they are available. Resource limits should be always higher than the resource requests.
A resource may be configured for one or more supported limits.
Supported CPU formats
CPU requests and limits are supported in the following formats:
-
Number of CPU cores as integer (
5
CPU core) or decimal (2.5
CPU core). -
Number or millicpus / millicores (
100m
) where 1000 millicores is the same1
CPU core.
The computing power of 1 CPU core may differ depending on the platform where OpenShift is deployed.
For more information on CPU specification, see the Meaning of CPU.
Supported memory formats
Memory requests and limits are specified in megabytes, gigabytes, mebibytes, and gibibytes.
-
To specify memory in megabytes, use the
M
suffix. For example1000M
. -
To specify memory in gigabytes, use the
G
suffix. For example1G
. -
To specify memory in mebibytes, use the
Mi
suffix. For example1000Mi
. -
To specify memory in gibibytes, use the
Gi
suffix. For example1Gi
.
For more details about memory specification and additional supported units, see Meaning of memory.
3.4.2.10. Kafka Mirror Maker loggers
Kafka Mirror Maker has its own configurable logger:
-
mirrormaker.root.logger
Use the logging
property to configure loggers and logger levels.
You can set the log levels by specifying the logger and level directly (inline) or use a custom (external) ConfigMap.
Here we see examples of inline
and external
logging:
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaMirrorMaker spec: # ... logging: type: inline loggers: mirrormaker.root.logger: "INFO" # ...
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaMirrorMaker spec: # ... logging: type: external name: customConfigMap # ...
Additional resources
- Garbage collector (GC) logging can also be enabled (or disabled). For more information on GC, see Section 3.1.17.1, “JVM configuration”
- For more information about log levels, see the log4j manual.
3.4.2.11. Healthchecks
Use the livenessProbe
and readinessProbe
properties to configure healthcheck probes supported in AMQ Streams.
Healthchecks are periodical tests which verify the health of an application. When a Healthcheck probe fails, OpenShift assumes that the application is not healthy and attempts to fix it.
For more details about the probes, see Configure Liveness and Readiness Probes.
Both livenessProbe
and readinessProbe
support the following options:
-
initialDelaySeconds
-
timeoutSeconds
-
periodSeconds
-
successThreshold
-
failureThreshold
An example of liveness and readiness probe configuration
# ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ...
For more information about the livenessProbe
and readinessProbe
options, see Probe schema reference.
3.4.2.12. Prometheus metrics
Use the metrics
property to enable and configure Prometheus metrics.
The metrics
property can also contain additional configuration for the Prometheus JMX exporter. AMQ Streams supports Prometheus metrics using Prometheus JMX exporter to convert the JMX metrics supported by Apache Kafka and Zookeeper to Prometheus metrics.
To enable Prometheus metrics export without any further configuration, you can set it to an empty object ({}
).
When metrics are enabled, they are exposed on port 9404.
When the metrics
property is not defined in the resource, the Prometheus metrics are disabled.
For more information about configuring Prometheus and Grafana, see Metrics.
3.4.2.13. JVM Options
Use the jvmOptions
property to configure supported options for the JVM on which the component is running.
Supported JVM options help to optimize performance for different platforms and architectures.
For more information on the supported options, see JVM configuration.
3.4.2.14. Container images
Use the image
property to configure the container image used by the component.
Overriding container images is recommended only in special situations where you need to use a different container registry or a customized image.
For example, if your network does not allow access to the container repository used by AMQ Streams, you can copy the AMQ Streams images or build them from the source. However, if the configured image is not compatible with AMQ Streams images, it might not work properly.
A copy of the container image might also be customized and used for debugging.
For more information see Container image configurations.
3.4.3. List of resources created as part of Kafka Mirror Maker
The following resources are created by the Cluster Operator in the OpenShift cluster:
- <mirror-maker-name>-mirror-maker
- Deployment which is responsible for creating the Kafka Mirror Maker pods.
- <mirror-maker-name>-config
- ConfigMap which contains ancillary configuration for the the Kafka Mirror Maker, and is mounted as a volume by the Kafka broker pods.
- <mirror-maker-name>-mirror-maker
- Pod Disruption Budget configured for the Kafka Mirror Maker worker nodes.
3.5. Kafka Bridge configuration
The full schema of the KafkaBridge
resource is described in the Section C.102, “KafkaBridge
schema reference”. All labels that are applied to the desired KafkaBridge
resource will also be applied to the OpenShift resources making up the Kafka Bridge cluster. This provides a convenient mechanism for resources to be labeled as required.
3.5.1. Replicas
Kafka Bridge can run multiple nodes. The number of nodes is defined in the KafkaBridge
resource. Running a Kafka Bridge with multiple nodes can provide better availability and scalability. However, when running Kafka Bridge on OpenShift it is not absolutely necessary to run multiple nodes of Kafka Bridge for high availability.
If a node where Kafka Bridge is deployed to crashes, OpenShift will automatically reschedule the Kafka Bridge pod to a different node. In order to prevent issues arising when client consumer requests are processed by different Kafka Bridge instances, addressed-based routing must be employed to ensure that requests are routed to the right Kafka Bridge instance. Additionally, each independent Kafka Bridge instance must have a replica. A Kafka Bridge instance has its own state which is not shared with another instances.
3.5.1.1. Configuring the number of nodes
The number of Kafka Bridge nodes is configured using the replicas
property in KafkaBridge.spec
.
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
replicas
property in theKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... replicas: 3 # ...
Create or update the resource.
oc apply -f your-file
3.5.2. Bootstrap servers
A Kafka Bridge always works in combination with a Kafka cluster. A Kafka cluster is specified as a list of bootstrap servers. On OpenShift, the list must ideally contain the Kafka cluster bootstrap service named cluster-name-kafka-bootstrap
, and a port of 9092 for plain traffic or 9093 for encrypted traffic.
The list of bootstrap servers is configured in the bootstrapServers
property in KafkaBridge.kafka.spec
. The servers must be defined as a comma-separated list specifying one or more Kafka brokers, or a service pointing to Kafka brokers specified as a hostname:_port_
pairs.
When using Kafka Bridge with a Kafka cluster not managed by AMQ Streams, you can specify the bootstrap servers list according to the configuration of the cluster.
3.5.2.1. Configuring bootstrap servers
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
bootstrapServers
property in theKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... bootstrapServers: my-cluster-kafka-bootstrap:9092 # ...
Create or update the resource.
oc apply -f your-file
3.5.3. Connecting to Kafka brokers using TLS
By default, Kafka Bridge tries to connect to Kafka brokers using a plain text connection. If you prefer to use TLS, additional configuration is required.
3.5.3.1. TLS support for Kafka connection to the Kafka Bridge
TLS support for Kafka connection is configured in the tls
property in KafkaBridge.spec.kafka
. The tls
property contains a list of secrets with key names under which the certificates are stored. The certificates must be stored in X509 format.
An example showing TLS configuration with multiple certificates
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... tls: trustedCertificates: - secretName: my-secret certificate: ca.crt - secretName: my-other-secret certificate: certificate.crt # ...
When multiple certificates are stored in the same secret, it can be listed multiple times.
An example showing TLS configuration with multiple certificates from the same secret
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... tls: trustedCertificates: - secretName: my-secret certificate: ca.crt - secretName: my-secret certificate: ca2.crt # ...
3.5.3.2. Configuring TLS in Kafka Bridge
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
-
If they exist, the name of the
Secret
for the certificate used for TLS Server Authentication, and the key under which the certificate is stored in theSecret
Procedure
(Optional) If they do not already exist, prepare the TLS certificate used in authentication in a file and create a
Secret
.NoteThe secrets created by the Cluster Operator for Kafka cluster may be used directly.
oc create secret generic my-secret --from-file=my-file.crt
Edit the
tls
property in theKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... tls: trustedCertificates: - secretName: my-cluster-cluster-cert certificate: ca.crt # ...
Create or update the resource.
oc apply -f your-file
3.5.4. Connecting to Kafka brokers with Authentication
By default, Kafka Bridge will try to connect to Kafka brokers without authentication. Authentication is enabled through the KafkaBridge
resources.
3.5.4.1. Authentication support in Kafka Bridge
Authentication is configured through the authentication
property in KafkaBridge.spec.kafka
. The authentication
property specifies the type of the authentication mechanisms which should be used and additional configuration details depending on the mechanism. The currently supported authentication types are:
- TLS client authentication
- SASL-based authentication using the SCRAM-SHA-512 mechanism
- SASL-based authentication using the PLAIN mechanism
- OAuth 2.0 token based authentication
3.5.4.1.1. TLS Client Authentication
To use TLS client authentication, set the type
property to the value tls
. TLS client authentication uses a TLS certificate to authenticate. The certificate is specified in the certificateAndKey
property and is always loaded from an OpenShift secret. In the secret, the certificate must be stored in X509 format under two different keys: public and private.
TLS client authentication can be used only with TLS connections. For more details about TLS configuration in Kafka Bridge see Section 3.5.3, “Connecting to Kafka brokers using TLS”.
An example TLS client authentication configuration
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... authentication: type: tls certificateAndKey: secretName: my-secret certificate: public.crt key: private.key # ...
3.5.4.1.2. SCRAM-SHA-512 authentication
To configure Kafka Bridge to use SASL-based SCRAM-SHA-512 authentication, set the type
property to scram-sha-512
. This authentication mechanism requires a username and password.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name of theSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example SASL based SCRAM-SHA-512 client authentication configuration
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... authentication: type: scram-sha-512 username: my-bridge-user passwordSecret: secretName: my-bridge-user password: my-bridge-password-key # ...
3.5.4.1.3. SASL-based PLAIN authentication
To configure Kafka Bridge to use SASL-based PLAIN authentication, set the type
property to plain
. This authentication mechanism requires a username and password.
The SASL PLAIN mechanism will transfer the username and password across the network in cleartext. Only use SASL PLAIN authentication if TLS encryption is enabled.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name theSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example showing SASL based PLAIN client authentication configuration
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... authentication: type: plain username: my-bridge-user passwordSecret: secretName: my-bridge-user password: my-bridge-password-key # ...
3.5.4.2. Configuring TLS client authentication in Kafka Bridge
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
-
If they exist, the name of the
Secret
with the public and private keys used for TLS Client Authentication, and the keys under which they are stored in theSecret
Procedure
(Optional) If they do not already exist, prepare the keys used for authentication in a file and create the
Secret
.NoteSecrets created by the User Operator may be used.
oc create secret generic my-secret --from-file=my-public.crt --from-file=my-private.key
Edit the
authentication
property in theKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... authentication: type: tls certificateAndKey: secretName: my-secret certificate: my-public.crt key: my-private.key # ...
Create or update the resource.
oc apply -f your-file
3.5.4.3. Configuring SCRAM-SHA-512 authentication in Kafka Bridge
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
- Username of the user which should be used for authentication
-
If they exist, the name of the
Secret
with the password used for authentication and the key under which the password is stored in theSecret
Procedure
(Optional) If they do not already exist, prepare a file with the password used in authentication and create the
Secret
.NoteSecrets created by the User Operator may be used.
echo -n '<password>' > <my-password.txt> oc create secret generic <my-secret> --from-file=<my-password.txt>
Edit the
authentication
property in theKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... authentication: type: scram-sha-512 username: _<my-username>_ passwordSecret: secretName: _<my-secret>_ password: _<my-password.txt>_ # ...
Create or update the resource.
oc apply -f your-file
3.5.5. Kafka Bridge configuration
AMQ Streams allows you to customize the configuration of Apache Kafka Bridge nodes by editing certain options listed in Apache Kafka configuration documentation for consumers and Apache Kafka configuration documentation for producers.
Configuration options that can be configured relate to:
- Kafka cluster bootstrap address
- Security (Encryption, Authentication, and Authorization)
- Consumer configuration
- Producer configuration
- HTTP configuration
3.5.5.1. Kafka Bridge Consumer configuration
Kafka Bridge consumer is configured using the properties in KafkaBridge.spec.consumer
. This property contains the Kafka Bridge consumer configuration options as keys. The values can be one of the following JSON types:
- String
- Number
- Boolean
Users can specify and configure the options listed in the Apache Kafka configuration documentation for consumers with the exception of those options which are managed directly by AMQ Streams. Specifically, all configuration options with keys equal to or starting with one of the following strings are forbidden:
-
ssl.
-
sasl.
-
security.
-
bootstrap.servers
-
group.id
When one of the forbidden options is present in the config
property, it will be ignored and a warning message will be printed to the Custer Operator log file. All other options will be passed to Kafka
The Cluster Operator does not validate keys or values in the config
object provided. When an invalid configuration is provided, the Kafka Bridge cluster might not start or might become unstable. In this circumstance, fix the configuration in the KafkaBridge.spec.consumer.config
object, then the Cluster Operator can roll out the new configuration to all Kafka Bridge nodes.
Example Kafka Bridge consumer configuration
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... consumer: config: auto.offset.reset: earliest enable.auto.commit: true # ...
3.5.5.2. Kafka Bridge Producer configuration
Kafka Bridge producer is configured using the properties in KafkaBridge.spec.producer
. This property contains the Kafka Bridge producer configuration options as keys. The values can be one of the following JSON types:
- String
- Number
- Boolean
Users can specify and configure the options listed in the Apache Kafka configuration documentation for producers with the exception of those options which are managed directly by AMQ Streams. Specifically, all configuration options with keys equal to or starting with one of the following strings are forbidden:
-
ssl.
-
sasl.
-
security.
-
bootstrap.servers
The Cluster Operator does not validate keys or values in the config
object provided. When an invalid configuration is provided, the Kafka Bridge cluster might not start or might become unstable. In this circumstance, fix the configuration in the KafkaBridge.spec.producer.config
object, then the Cluster Operator can roll out the new configuration to all Kafka Bridge nodes.
Example Kafka Bridge producer configuration
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... producer: config: acks: 1 delivery.timeout.ms: 300000 # ...
3.5.5.3. Kafka Bridge HTTP configuration
Kafka Bridge HTTP configuration is set using the properties in KafkaBridge.spec.http
. This property contains the Kafka Bridge HTTP configuration options.
-
port
Example Kafka Bridge HTTP configuration
apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... http: port: 8080 # ...
3.5.5.4. Configuring Kafka Bridge
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
kafka
,http
,consumer
orproducer
property in theKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: my-bridge spec: # ... bootstrapServers: my-cluster-kafka:9092 http: port: 8080 consumer: config: auto.offset.reset: earliest producer: config: delivery.timeout.ms: 300000 # ...
Create or update the resource.
oc apply -f your-file
3.5.6. CPU and memory resources
For every deployed container, AMQ Streams allows you to request specific resources and define the maximum consumption of those resources.
AMQ Streams supports two types of resources:
- CPU
- Memory
AMQ Streams uses the OpenShift syntax for specifying CPU and memory resources.
3.5.6.1. Resource limits and requests
Resource limits and requests are configured using the resources
property in the following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
Additional resources
- For more information about managing computing resources on OpenShift, see Managing Compute Resources for Containers.
3.5.6.1.1. Resource requests
Requests specify the resources to reserve for a given container. Reserving the resources ensures that they are always available.
If the resource request is for more than the available free resources in the OpenShift cluster, the pod is not scheduled.
Resources requests are specified in the requests
property. Resources requests currently supported by AMQ Streams:
-
cpu
-
memory
A request may be configured for one or more supported resources.
Example resource request configuration with all resources
# ... resources: requests: cpu: 12 memory: 64Gi # ...
3.5.6.1.2. Resource limits
Limits specify the maximum resources that can be consumed by a given container. The limit is not reserved and might not always be available. A container can use the resources up to the limit only when they are available. Resource limits should be always higher than the resource requests.
Resource limits are specified in the limits
property. Resource limits currently supported by AMQ Streams:
-
cpu
-
memory
A resource may be configured for one or more supported limits.
Example resource limits configuration
# ... resources: limits: cpu: 12 memory: 64Gi # ...
3.5.6.1.3. Supported CPU formats
CPU requests and limits are supported in the following formats:
-
Number of CPU cores as integer (
5
CPU core) or decimal (2.5
CPU core). -
Number or millicpus / millicores (
100m
) where 1000 millicores is the same1
CPU core.
Example CPU units
# ... resources: requests: cpu: 500m limits: cpu: 2.5 # ...
The computing power of 1 CPU core may differ depending on the platform where OpenShift is deployed.
Additional resources
- For more information on CPU specification, see the Meaning of CPU.
3.5.6.1.4. Supported memory formats
Memory requests and limits are specified in megabytes, gigabytes, mebibytes, and gibibytes.
-
To specify memory in megabytes, use the
M
suffix. For example1000M
. -
To specify memory in gigabytes, use the
G
suffix. For example1G
. -
To specify memory in mebibytes, use the
Mi
suffix. For example1000Mi
. -
To specify memory in gibibytes, use the
Gi
suffix. For example1Gi
.
An example of using different memory units
# ... resources: requests: memory: 512Mi limits: memory: 2Gi # ...
Additional resources
- For more details about memory specification and additional supported units, see Meaning of memory.
3.5.6.2. Configuring resource requests and limits
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
resources
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... resources: requests: cpu: "8" memory: 64Gi limits: cpu: "12" memory: 128Gi # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema, see
Resources
schema reference.
3.5.7. Logging
This section provides information on loggers and how to configure log levels.
You can set the log levels by specifying the loggers and their levels directly (inline) or use a custom (external) config map.
3.5.7.1. Kafka Bridge loggers
Kafka Bridge has configurable loggers for each OpenAPI operation: Loggers are formatted as follows:
log4j.logger.http.openapi.operation.<operation-id>
Where <operation-id>
is the identifier of the specific operation. Following is the list of operations defined by the OpenAPI specification:
-
createConsumer
-
deleteConsumer
-
subscribe
-
unsubscribe
-
poll
-
assign
-
commit
-
send
-
sendToPartition
-
seekToBeginning
-
seekToEnd
-
seek
-
healthy
-
ready
-
openapi
3.5.7.2. Specifying inline logging
Procedure
Edit the YAML file to specify the loggers and logging level for the required components.
For example, the logging level here is set to INFO:
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaBridge spec: # ... logging: type: inline loggers: logger.name: "INFO" # ...
You can set the log level to INFO, ERROR, WARN, TRACE, DEBUG, FATAL or OFF.
For more information about the log levels, see the log4j manual.
Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
3.5.7.3. Specifying an external ConfigMap for logging
Procedure
Edit the YAML file to specify the name of the
ConfigMap
to use for the required components. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaBridge spec: # ... logging: type: external name: customConfigMap # ...
Remember to place your custom ConfigMap under the
log4j.properties
orlog4j2.properties
key.Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
Garbage collector (GC) logging can also be enabled (or disabled). For more information on GC, see Section 3.1.17.1, “JVM configuration”
3.5.8. JVM Options
The following components of AMQ Streams run inside a Virtual Machine (VM):
- Apache Kafka
- Apache Zookeeper
- Apache Kafka Connect
- Apache Kafka Mirror Maker
- AMQ Streams Kafka Bridge
JVM configuration options optimize the performance for different platforms and architectures. AMQ Streams allows you to configure some of these options.
3.5.8.1. JVM configuration
JVM options can be configured using the jvmOptions
property in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Only a selected subset of available JVM options can be configured. The following options are supported:
-Xms and -Xmx
-Xms
configures the minimum initial allocation heap size when the JVM starts. -Xmx
configures the maximum heap size.
The units accepted by JVM settings such as -Xmx
and -Xms
are those accepted by the JDK java
binary in the corresponding image. Accordingly, 1g
or 1G
means 1,073,741,824 bytes, and Gi
is not a valid unit suffix. This is in contrast to the units used for memory requests and limits, which follow the OpenShift convention where 1G
means 1,000,000,000 bytes, and 1Gi
means 1,073,741,824 bytes
The default values used for -Xms
and -Xmx
depends on whether there is a memory request limit configured for the container:
- If there is a memory limit then the JVM’s minimum and maximum memory will be set to a value corresponding to the limit.
-
If there is no memory limit then the JVM’s minimum memory will be set to
128M
and the JVM’s maximum memory will not be defined. This allows for the JVM’s memory to grow as-needed, which is ideal for single node environments in test and development.
Setting -Xmx
explicitly requires some care:
-
The JVM’s overall memory usage will be approximately 4 × the maximum heap, as configured by
-Xmx
. -
If
-Xmx
is set without also setting an appropriate OpenShift memory limit, it is possible that the container will be killed should the OpenShift node experience memory pressure (from other Pods running on it). -
If
-Xmx
is set without also setting an appropriate OpenShift memory request, it is possible that the container will be scheduled to a node with insufficient memory. In this case, the container will not start but crash (immediately if-Xms
is set to-Xmx
, or some later time if not).
When setting -Xmx
explicitly, it is recommended to:
- set the memory request and the memory limit to the same value,
-
use a memory request that is at least 4.5 × the
-Xmx
, -
consider setting
-Xms
to the same value as-Xmx
.
Containers doing lots of disk I/O (such as Kafka broker containers) will need to leave some memory available for use as operating system page cache. On such containers, the requested memory should be significantly higher than the memory used by the JVM.
Example fragment configuring -Xmx
and -Xms
# ... jvmOptions: "-Xmx": "2g" "-Xms": "2g" # ...
In the above example, the JVM will use 2 GiB (=2,147,483,648 bytes) for its heap. Its total memory usage will be approximately 8GiB.
Setting the same value for initial (-Xms
) and maximum (-Xmx
) heap sizes avoids the JVM having to allocate memory after startup, at the cost of possibly allocating more heap than is really needed. For Kafka and Zookeeper pods such allocation could cause unwanted latency. For Kafka Connect avoiding over allocation may be the most important concern, especially in distributed mode where the effects of over-allocation will be multiplied by the number of consumers.
-server
-server
enables the server JVM. This option can be set to true or false.
Example fragment configuring -server
# ... jvmOptions: "-server": true # ...
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
-XX
-XX
object can be used for configuring advanced runtime options of a JVM. The -server
and -XX
options are used to configure the KAFKA_JVM_PERFORMANCE_OPTS
option of Apache Kafka.
Example showing the use of the -XX
object
jvmOptions: "-XX": "UseG1GC": true "MaxGCPauseMillis": 20 "InitiatingHeapOccupancyPercent": 35 "ExplicitGCInvokesConcurrent": true "UseParNewGC": false
The example configuration above will result in the following JVM options:
-XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -XX:-UseParNewGC
When neither of the two options (-server
and -XX
) is specified, the default Apache Kafka configuration of KAFKA_JVM_PERFORMANCE_OPTS
will be used.
3.5.8.1.1. Garbage collector logging
The jvmOptions
section also allows you to enable and disable garbage collector (GC) logging. GC logging is enabled by default. To disable it, set the gcLoggingEnabled
property as follows:
Example of disabling GC logging
# ... jvmOptions: gcLoggingEnabled: false # ...
3.5.8.2. Configuring JVM options
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
jvmOptions
property in theKafka
,KafkaConnect
,KafkaConnectS2I
,KafkaMirrorMaker
, orKafkaBridge
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... jvmOptions: "-Xmx": "8g" "-Xms": "8g" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.5.9. Healthchecks
Healthchecks are periodical tests which verify the health of an application. When a Healthcheck probe fails, OpenShift assumes that the application is not healthy and attempts to fix it.
OpenShift supports two types of Healthcheck probes:
- Liveness probes
- Readiness probes
For more details about the probes, see Configure Liveness and Readiness Probes. Both types of probes are used in AMQ Streams components.
Users can configure selected options for liveness and readiness probes.
3.5.9.1. Healthcheck configurations
Liveness and readiness probes can be configured using the livenessProbe
and readinessProbe
properties in following resources:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.KafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMaker.spec
-
KafkaBridge.spec
Both livenessProbe
and readinessProbe
support the following options:
-
initialDelaySeconds
-
timeoutSeconds
-
periodSeconds
-
successThreshold
-
failureThreshold
For more information about the livenessProbe
and readinessProbe
options, see Section C.34, “Probe
schema reference”.
An example of liveness and readiness probe configuration
# ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ...
3.5.9.2. Configuring healthchecks
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
livenessProbe
orreadinessProbe
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... readinessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 livenessProbe: initialDelaySeconds: 15 timeoutSeconds: 5 # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.5.10. Container images
AMQ Streams allows you to configure container images which will be used for its components. Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such a case, you should either copy the AMQ Streams images or build them from the source. If the configured image is not compatible with AMQ Streams images, it might not work properly.
3.5.10.1. Container image configurations
Container image which should be used for given components can be specified using the image
property in:
-
Kafka.spec.kafka
-
Kafka.spec.kafka.tlsSidecar
-
Kafka.spec.zookeeper
-
Kafka.spec.zookeeper.tlsSidecar
-
Kafka.spec.entityOperator.topicOperator
-
Kafka.spec.entityOperator.userOperator
-
Kafka.spec.entityOperator.tlsSidecar
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaBridge.spec
3.5.10.1.1. Configuring the Kafka.spec.kafka.image
property
The Kafka.spec.kafka.image
property functions differently from the others, because AMQ Streams supports multiple versions of Kafka, each requiring the own image. The STRIMZI_KAFKA_IMAGES
environment variable of the Cluster Operator configuration is used to provide a mapping between Kafka versions and the corresponding images. This is used in combination with the Kafka.spec.kafka.image
and Kafka.spec.kafka.version
properties as follows:
-
If neither
Kafka.spec.kafka.image
norKafka.spec.kafka.version
are given in the custom resource then theversion
will default to the Cluster Operator’s default Kafka version, and the image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
If
Kafka.spec.kafka.image
is given butKafka.spec.kafka.version
is not then the given image will be used and theversion
will be assumed to be the Cluster Operator’s default Kafka version. -
If
Kafka.spec.kafka.version
is given butKafka.spec.kafka.image
is not then image will be the one corresponding to this version in theSTRIMZI_KAFKA_IMAGES
. -
Both
Kafka.spec.kafka.version
andKafka.spec.kafka.image
are given the given image will be used, and it will be assumed to contain a Kafka broker with the given version.
It is best to provide just Kafka.spec.kafka.version
and leave the Kafka.spec.kafka.image
property unspecified. This reduces the chances of making a mistake in configuring the Kafka
resource. If you need to change the images used for different versions of Kafka, it is better to configure the Cluster Operator’s STRIMZI_KAFKA_IMAGES
environment variable.
3.5.10.1.2. Configuring the image
property in other resources
For the image
property in the other custom resources, the given value will be used during deployment. If the image
property is missing, the image
specified in the Cluster Operator configuration will be used. If the image
name is not defined in the Cluster Operator configuration, then the default value will be used.
For Kafka broker TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_KAFKA_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper nodes:
-
Container image specified in the
STRIMZI_DEFAULT_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Zookeeper node TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ZOOKEEPER_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Topic Operator:
-
Container image specified in the
STRIMZI_DEFAULT_TOPIC_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For User Operator:
-
Container image specified in the
STRIMZI_DEFAULT_USER_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-operator:1.3.0
container image.
-
Container image specified in the
For Entity Operator TLS sidecar:
-
Container image specified in the
STRIMZI_DEFAULT_TLS_SIDECAR_ENTITY_OPERATOR_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
For Kafka Connect with Source2image support:
-
Container image specified in the
STRIMZI_DEFAULT_KAFKA_CONNECT_S2I_IMAGE
environment variable from the Cluster Operator configuration. -
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
container image.
-
Container image specified in the
Overriding container images is recommended only in special situations, where you need to use a different container registry. For example, because your network does not allow access to the container repository used by AMQ Streams. In such case, you should either copy the AMQ Streams images or build them from source. In case the configured image is not compatible with AMQ Streams images, it might not work properly.
Example of container image configuration
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
3.5.10.2. Configuring container images
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
image
property in theKafka
,KafkaConnect
orKafkaConnectS2I
resource. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: kafka: # ... image: my-org/my-image:latest # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.5.11. Configuring pod scheduling
When two applications are scheduled to the same OpenShift node, both applications might use the same resources like disk I/O and impact performance. That can lead to performance degradation. Scheduling Kafka pods in a way that avoids sharing nodes with other critical workloads, using the right nodes or dedicated a set of nodes only for Kafka are the best ways how to avoid such problems.
3.5.11.1. Scheduling pods based on other applications
3.5.11.1.1. Avoid critical applications to share the node
Pod anti-affinity can be used to ensure that critical applications are never scheduled on the same disk. When running Kafka cluster, it is recommended to use pod anti-affinity to ensure that the Kafka brokers do not share the nodes with other workloads like databases.
3.5.11.1.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.5.11.1.3. Configuring pod anti-affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Edit the
affinity
property in the resource specifying the cluster deployment. Use labels to specify the pods which should not be scheduled on the same nodes. ThetopologyKey
should be set tokubernetes.io/hostname
to specify that the selected pods should not be scheduled on nodes with the same hostname. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: podAntiAffinity: requiredDuringSchedulingIgnoredDuringExecution: - labelSelector: matchExpressions: - key: application operator: In values: - postgresql - mongodb topologyKey: "kubernetes.io/hostname" # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.5.11.2. Scheduling pods to specific nodes
3.5.11.2.1. Node scheduling
The OpenShift cluster usually consists of many different types of worker nodes. Some are optimized for CPU heavy workloads, some for memory, while other might be optimized for storage (fast local SSDs) or network. Using different nodes helps to optimize both costs and performance. To achieve the best possible performance, it is important to allow scheduling of AMQ Streams components to use the right nodes.
OpenShift uses node affinity to schedule workloads onto specific nodes. Node affinity allows you to create a scheduling constraint for the node on which the pod will be scheduled. The constraint is specified as a label selector. You can specify the label using either the built-in node label like beta.kubernetes.io/instance-type
or custom labels to select the right node.
3.5.11.2.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.5.11.2.3. Configuring node affinity in Kafka components
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
Label the nodes where AMQ Streams components should be scheduled.
This can be done using
oc label
:oc label node your-node node-type=fast-network
Alternatively, some of the existing labels might be reused.
Edit the
affinity
property in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: node-type operator: In values: - fast-network # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.5.11.3. Using dedicated nodes
3.5.11.3.1. Dedicated nodes
Cluster administrators can mark selected OpenShift nodes as tainted. Nodes with taints are excluded from regular scheduling and normal pods will not be scheduled to run on them. Only services which can tolerate the taint set on the node can be scheduled on it. The only other services running on such nodes will be system services such as log collectors or software defined networks.
Taints can be used to create dedicated nodes. Running Kafka and its components on dedicated nodes can have many advantages. There will be no other applications running on the same nodes which could cause disturbance or consume the resources needed for Kafka. That can lead to improved performance and stability.
To schedule Kafka pods on the dedicated nodes, configure node affinity and tolerations.
3.5.11.3.2. Affinity
Affinity can be configured using the affinity
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The affinity configuration can include different types of affinity:
- Pod affinity and anti-affinity
- Node affinity
The format of the affinity
property follows the OpenShift specification. For more details, see the Kubernetes node and pod affinity documentation.
3.5.11.3.3. Tolerations
Tolerations can be configured using the tolerations
property in following resources:
-
Kafka.spec.kafka.template.pod
-
Kafka.spec.zookeeper.template.pod
-
Kafka.spec.entityOperator.template.pod
-
KafkaConnect.spec.template.pod
-
KafkaConnectS2I.spec.template.pod
-
KafkaBridge.spec.template.pod
The format of the tolerations
property follows the OpenShift specification. For more details, see the Kubernetes taints and tolerations.
3.5.11.3.4. Setting up dedicated nodes and scheduling pods on them
Prerequisites
- An OpenShift cluster
- A running Cluster Operator
Procedure
- Select the nodes which should be used as dedicated.
- Make sure there are no workloads scheduled on these nodes.
Set the taints on the selected nodes:
This can be done using
oc adm taint
:oc adm taint node your-node dedicated=Kafka:NoSchedule
Additionally, add a label to the selected nodes as well.
This can be done using
oc label
:oc label node your-node dedicated=Kafka
Edit the
affinity
andtolerations
properties in the resource specifying the cluster deployment. For example:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: kafka: # ... template: pod: tolerations: - key: "dedicated" operator: "Equal" value: "Kafka" effect: "NoSchedule" affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - key: dedicated operator: In values: - Kafka # ... zookeeper: # ...
Create or update the resource.
This can be done using
oc apply
:oc apply -f your-file
3.5.12. List of resources created as part of Kafka Bridge cluster
The following resources are created by the Cluster Operator in the OpenShift cluster:
- bridge-cluster-name-bridge
- Deployment which is in charge to create the Kafka Bridge worker node pods.
- bridge-cluster-name-bridge-service
- Service which exposes the REST interface of the Kafka Bridge cluster.
- bridge-cluster-name-bridge-config
- ConfigMap which contains the Kafka Bridge ancillary configuration and is mounted as a volume by the Kafka broker pods.
- bridge-cluster-name-bridge
- Pod Disruption Budget configured for the Kafka Bridge worker nodes.
3.6. Using OAuth 2.0 token based authentication
AMQ Streams supports the use of OAuth 2.0 authentication using the SASL OAUTHBEARER mechanism.
OAuth 2.0 enables standardized token based authentication and authorization between applications, using a central authorization server to issue tokens that grant limited access to resources.
OAuth 2.0 is currently only supported for authentication, with no authorization support. However, OAuth 2.0 authentication can be used in conjunction with ACL-based Kafka authorization.
Using OAuth 2.0 token based authentication, application clients can access resources on application servers (called ‘resource servers’) without exposing account credentials. The client passes an access token as a means of authenticating, which application servers can also use to find more information about the level of access granted. The authorization server handles the granting of access and inquiries about access.
In the context of AMQ Streams:
- Kafka brokers act as resource servers
- Kafka clients act as resource clients
The brokers and clients communicate with the OAuth 2.0 authorization server, as necessary, to obtain or validate access tokens.
For a deployment of AMQ Streams, OAuth 2.0 integration provides:
- Server-side OAuth 2.0 support for Kafka brokers
- Client-side OAuth 2.0 support for Kafka Mirror Maker, Kafka Connect and the Kafka Bridge
Additional resources
3.6.1. OAuth 2.0 authentication mechanism
Support for OAuth 2.0 is based on the Kafka SASL OAUTHBEARER mechanism, which is used to establish authenticated sessions with a Kafka broker.
A Kafka client initiates a session with the Kafka broker using the SASL OAUTHBEARER mechanism for credentials exchange, where credentials take the form of an access token.
Kafka brokers and clients need to be configured to use OAuth 2.0.
Kafka broker configuration
The Kafka broker must be configured to validate the token received during session initiation. The recommended approach is to create a client definition in an authorization server with:
-
Client ID of
kafka-broker
- Client ID and secret as the authentication mechanism
Kafka client configuration
A Kafka client is configured with either:
- Credentials required to obtain a valid access token from an authorization server
- A valid long-lived access token, obtained using tools provided by an authorization server
Credentials are never sent to the Kafka broker. The only information ever sent to the Kafka broker is an access token. When a client obtains an access token, no further communication with the authorization server is needed.
The simplest mechanism, which requires no additional usage of authorization server tools, is authentication with a client ID and secret. Using a long-lived access token, or a long-lived refresh token, is more complex.
If you are using long-lived access tokens, you can set policy in the authorization server to increase the maximum lifetime of the token.
If the Kafka client is not configured with an access token directly, the client exchanges credentials for an access token during Kafka session initiation by contacting the authorization server. The Kafka client uses one of two mechanisms:
- Client id and secret
- Client id, refresh token, and (optionally) a secret
3.6.2. OAuth 2.0 client authentication flow
In this section, we explain and visualize the communication flow between Kafka client, Kafka broker, and authorization server during Kafka session initiation. The flow depends on the client and server configuration.
When a Kafka client sends an access token as credentials to a Kafka broker, the token needs to be validated.
Depending on the authorization server used, and the configuration options available, you may prefer to use:
- Fast local token validation based on JWT signature checking and local token introspection, without contacting the authorization server
- An OAuth 2.0 introspection endpoint provided by the authorization server
Using fast local token validation requires the authorization server to provide a JWKS endpoint with public certificates that are used to validate signatures on the tokens.
An authorization server might only allow the use of opaque access tokens, which means that local token validation is not possible.
Another option is to use an OAuth 2.0 introspection endpoint on the authorization server. Each time a Kafka broker connection is established, the broker sends the access token it receives to the authorization server, and a response confirming whether or not the token is valid is returned.
Kafka client credentials can also be configured for:
- Direct local access using a previously generated long-lived access token
- Contact with the authorization server for a new access token to be issued and sent to the Kafka broker
3.6.2.1. Example client authentication flows
Here you can see the communication flows, for different configurations of Kafka clients and brokers, during Kafka session authentication.
- Client using client ID and secret, with broker delegating validation to authorization server
- Client using client ID and secret, with broker performing fast local token validation
- Client using long-lived access token, with broker delegating validation to authorization server
- Client using long-lived access token, with broker performing fast local validation
Client using client ID and secret, with broker delegating validation to authorization server
- Kafka client requests access token from authorization server, using client ID and secret, and optionally a refresh token.
- Authorization server generates a new access token.
- Kafka client authenticates with the Kafka broker using the SASL OAUTHBEARER mechanism to pass the access token.
- Kafka broker validates the access token by calling a token introspection endpoint on authorization server, using its own client ID and secret.
- Kafka client session is established if the token is valid.
Client using client ID and secret, with broker performing fast local token validation
- Kafka client authenticates with authorization server from the token endpoint, using a client ID and secret, and optionally a refresh token.
- Authorization server generates a new access token.
- Kafka client authenticates with the Kafka broker using the SASL OAUTHBEARER mechanism to pass the access token.
- Kafka broker validates the access token locally using a JWT token signature check, and local token introspection.
Client using long-lived access token, with broker delegating validation to authorization server
- Kafka client authenticates with the Kafka broker using the SASL OAUTHBEARER mechanism to pass the long-lived access token.
- Kafka broker validates the access token by calling a token introspection endpoint on authorization server, using its own client ID and secret.
- Kafka client session is established if the token is valid.
Client using long-lived access token, with broker performing fast local validation
- Kafka client authenticates with the Kafka broker using the SASL OAUTHBEARER mechanism to pass the long-lived access token.
- Kafka broker validates the access token locally using JWT token signature check, and local token introspection.
Fast local JWT token signature validation is suitable only for short-lived tokens as there is no check with the authorization server if a token has been revoked. Token expiration is written into the token, but revocation can happen at any time, so cannot be accounted for without contacting the authorization server. Any issued token would be considered valid until it expires.
3.6.3. Configuring OAuth 2.0 authentication
OAuth 2.0 is used for interaction between Kafka clients and AMQ Streams components.
In order to use OAuth 2.0 for AMQ Streams, you must:
3.6.3.1. Configuring Red Hat Single Sign-On as an OAuth 2.0 authorization server
This procedure describes how to deploy Red Hat Single Sign-On as an authorization server and configure it for integration with AMQ Streams.
The authorization server provides a central point for authentication and authorization, and management of users, clients, and permissions. Red Hat Single Sign-On has a concept of realms where a realm represents a separate set of users, clients, permissions, and other configuration. You can use a default master realm, or create a new one. Each realm exposes its own OAuth 2.0 endpoints, which means that application clients and application servers all need to use the same realm.
To use OAuth 2.0 with AMQ Streams, you use a deployment of Red Hat Single Sign-On to create and manage authentication realms.
If you already have Red Hat Single Sign-On deployed, you can skip the deployment step and use your current deployment.
Before you begin
You will need to be familiar with using Red Hat Single Sign-On.
For deployment and administration instructions, see:
Prerequisites
- AMQ Streams and Kafka is running
For the Red Hat Single Sign-On deployment:
- Check the Red Hat Single Sign-On Supported Configurations
- Installation requires a user with a cluster-admin role, such as system:admin
Procedure
Deploy Red Hat Single Sign-On to your OpenShift cluster.
Check the progress of the deployment in your OpenShift web console.
Log in to the Red Hat Single Sign-On Admin Console to create the OAuth 2.0 policies for AMQ Streams.
Login details are provided when you deploy Red Hat Single Sign-On.
Create and enable a realm.
You can use an existing master realm.
- Adjust the session and token timeouts for the realm, if required.
-
Create a client called
kafka-broker
. From the Settings tab, set:
-
Access Type to
Confidential
-
Standard Flow Enabled to
OFF
to disable web login for this client -
Service Accounts Enabled to
ON
to allow this client to authenticate in its own name
-
Access Type to
- Click Save before continuing.
- From the Credentials tab, take a note of the secret for using in your AMQ Streams Kafka cluster configuration.
Repeat the client creation steps for any application client that will connect to your Kafka brokers.
Create a definition for each new client.
You will use the names as client IDs in your configuration.
What to do next
After deploying and configuring the authorization server, configure the Kafka brokers to use OAuth 2.0.
3.6.3.2. Configuring OAuth 2.0 support for Kafka brokers
This procedure describes how to configure Kafka brokers so that the broker listeners are enabled to use OAuth 2.0 authentication using an authorization server.
If the authorization server is using certificates signed by the trusted CA and matching the OAuth 2.0 server hostname, TLS connection works using the default settings. Otherwise, you have two connection options for your external listener configuration when delegating token validation to the authorization server:
- TLS connection to the authorization server with trusted certificates
- Direct connection using an introspection endpoint configuration
Both options are described in this procedure.
Before you start
For more information on the configuration and authentication of Kafka broker listeners, see:
Prerequisites
- AMQ Streams and Kafka are running
- An OAuth 2.0 authorization server is deployed
Procedure
Update the Kafka broker configuration (
Kafka.spec.kafka
) of yourKafka
resource in an editor.oc edit kafka my-cluster
Configure the Kafka broker
listeners
configuration.The configuration for each type of listener does not have to be the same, as they are independent.
For example:
#... authentication: type: oauth 1 validIssuerUri: <https://<authorization-server-address>/auth/realms/master> 2 jwksEndpointUri: <https://<authorization-server-address>/auth/realms/master/protocol/openid-connect/certs> 3 userNameClaim: preferred_username 4 #external configuration external: type: loadbalancer //Option 1 authentication: 5 type: oauth validIssuerUri: <https://<authorization-server-address>/auth/realms/external> jwksEndpointUri: <https://<authorization-server-address>/auth/realms/external/protocol/openid-connect/certs> userNameClaim: preferred_username tlsTrustedCertificates: 6 - secretName: oauth-server-cert certificate: ca.crt disableTlsHostnameVerification: true 7 //Option 2 authentication: 8 type: oauth validIssuerUri: <https://<authorization-server-address>/auth/realms/external> introspectionEndpointUri: <https://<authorization-server-address>/auth/realms/external/protocol/openid-connect/token/introspect> clientId: kafka-broker clientSecret: secretName: my-cluster-oauth key: clientSecret
- 1
- Listener type set to
oauth
. - 2
- URI of the token issuer used for authentication.
- 3
- URI of the JWKS certificate endpoint used for local JWT validation.
- 4
- The user name profile claim (or key) that contains the actual user name in the token. The user name is the principal used to identify the user. The
userNameClaim
value will depend on the authentication flow and the authorization server used. - 5
- OPTION 1: TLS connection to the authorization server.
- 6
- (Optional) Trusted certificates for TLS connection to the authorization server.
- 7
- Enable TLS hostname verification. Default is
false
. - 8
- OPTION 2: Introspection endpoint to connect directly to the authorization server.
- Save and exit the editor, then wait for rolling updates to complete.
Check the update in the logs or by watching the pod state transitions:
oc logs -f ${POD_NAME} -c ${CONTAINER_NAME} oc get po -w
The rolling update configures the brokers to use OAuth 2.0 authentication.
What to do next
3.6.3.3. Configuring Kafka Java clients to use OAuth 2.0
This procedure describes how to configure Kafka producer and consumer APIs to use OAuth 2.0 for interaction with Kafka brokers.
Add a client callback plugin to your pom.xml file, and configure the system properties.
Prerequisites
- AMQ Streams and Kafka are running
- An OAuth 2.0 authorization server is deployed and configured for OAuth access to Kafka brokers
- Kafka brokers are configured for OAuth 2.0
Procedure
Add the client library with OAuth 2.0 support to the
pom.xml
file for the Kafka client:<dependency> <groupId>io.strimzi</groupId> <artifactId>kafka-oauth-client</artifactId> <version>0.1.0.redhat-00002</version> </dependency>
Configure the system properties for the callback:
For example:
System.setProperty(ClientConfig.OAUTH_TOKEN_ENDPOINT_URI, “https://<authorization-server-address>/auth/realms/master/protocol/openid-connect/token”); 1 System.setProperty(ClientConfig.OAUTH_CLIENT_ID, "<client-name>"); 2 System.setProperty(ClientConfig.OAUTH_CLIENT_SECRET, "<client-secret>"); 3
Enable the SASL OAUTHBEARER mechanism on a TLS encrypted connection in the Kafka client configuration:
For example:
props.put("sasl.jaas.config", "org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule required;"); props.put("security.protocol", "SASL_SSL"); 1 props.put("sasl.mechanism", "OAUTHBEARER"); props.put("sasl.login.callback.handler.class", "io.strimzi.kafka.oauth.client.JaasClientOauthLoginCallbackHandler");
- 1
- Here we use
SASL_SSL
for use over TLS connections. UseSASL_PLAINTEXT
over unencrypted connections.
- Verify that the Kafka client can access the Kafka brokers.
What to do next
3.6.3.4. Configuring OAuth for Kafka components
This procedure describes how to configure Kafka components to use OAuth 2.0 authentication using an authorization server.
You can configure authentication for:
- Kafka Connect
- Kafka Mirror Maker
- Kafka Bridge
In this scenario, the Kafka component and the authorization server are running in the same cluster.
Prerequisites
- AMQ Streams and Kafka are running
- An OAuth 2.0 authorization server is deployed and configured for OAuth access to Kafka brokers
- Kafka brokers are configured for OAuth 2.0
Procedure
Create a client secret and mount it to the component as an environment variable.
For example, here we are creating a client
Secret
for the Kafka Bridge:apiVersion: kafka.strimzi.io/v1beta1 kind: Secret metadata: name: my-bridge-oauth type: Opaque data: clientSecret: MGQ1OTRmMzYtZTllZS00MDY2LWI5OGEtMTM5MzM2NjdlZjQw 1
- 1
- The
clientSecret
key must be in base64 format.
Create or edit the resource for the Kafka component so that OAuth 2.0 authentication is configured for the authentication property.
For example, here OAuth 2.0 is assigned to the Kafka Bridge client:
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaBridge metadata: name: my-bridge spec: # ... authentication: type: oauth 1 tokenEndpointUri: https://<authorization-server-address>/auth/realms/master/protocol/openid-connect/token 2 clientId: kafka-bridge clientSecret: secretName: my-bridge-oauth key: clientSecret tlsTrustedCertificates: 3 - secretName: oauth-server-cert certificate: tls.crt
Apply the changes to the deployment of your Kafka resource.
oc apply -f your-file
Check the update in the logs or by watching the pod state transitions:
oc logs -f ${POD_NAME} -c ${CONTAINER_NAME} oc get pod -w
The rolling updates configure the component for interaction with Kafka brokers using OAuth 2.0 authentication.
3.7. Customizing deployments
AMQ Streams creates several OpenShift resources, such as Deployments
, StatefulSets
, Pods
, and Services
, which are managed by OpenShift operators. Only the operator that is responsible for managing a particular OpenShift resource can change that resource. If you try to manually change an operator-managed OpenShift resource, the operator will revert your changes back.
However, changing an operator-managed OpenShift resource can be useful if you want to perform certain tasks, such as:
-
Adding custom labels or annotations that control how
Pods
are treated by Istio or other services; -
Managing how
Loadbalancer
-type Services are created by the cluster.
You can make these types of changes using the template
property in the AMQ Streams custom resources.
3.7.1. Template properties
You can use the template
property to configure aspects of the resource creation process. You can include it in the following resources and properties:
-
Kafka.spec.kafka
-
Kafka.spec.zookeeper
-
Kafka.spec.entityOperator
-
Kafka.spec.kafkaExporter
-
KafkaConnect.spec
-
KafkaConnectS2I.spec
-
KafkaMirrorMakerSpec
-
KafkaBridge.spec
In the following example, the template
property is used to modify the labels in a Kafka broker’s StatefulSet
:
apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster labels: app: my-cluster spec: kafka: # ... template: statefulset: metadata: labels: mylabel: myvalue # ...
3.7.1.1. Supported template properties for a Kafka cluster
statefulset
-
Configures the
StatefulSet
used by the Kafka broker. pod
-
Configures the Kafka broker
Pods
created by theStatefulSet
. bootstrapService
- Configures the bootstrap service used by clients running within OpenShift to connect to the Kafka broker.
brokersService
- Configures the headless service.
externalBootstrapService
- Configures the bootstrap service used by clients connecting to Kafka brokers from outside of OpenShift.
perPodService
- Configures the per-Pod services used by clients connecting to the Kafka broker from outside OpenShift to access individual brokers.
externalBootstrapRoute
-
Configures the bootstrap route used by clients connecting to the Kafka brokers from outside of OpenShift using OpenShift
Routes
. perPodRoute
-
Configures the per-Pod routes used by clients connecting to the Kafka broker from outside OpenShift to access individual brokers using OpenShift
Routes
. podDisruptionBudget
-
Configures the Pod Disruption Budget for Kafka broker
StatefulSet
. kafkaContainer
- Configures the container used to run the Kafka broker, including custom environment variables.
tlsSidecarContainer
- Configures the TLS sidecar container, including custom environment variables.
initContainer
- Configures the container used to initialize the brokers.
persistentVolumeClaim
-
Configures the metadata of the Kafka
PersistentVolumeClaims
.
Additional resources
3.7.1.2. Supported template properties for a Zookeeper cluster
statefulset
-
Configures the Zookeeper
StatefulSet
. pod
-
Configures the Zookeeper
Pods
created by theStatefulSet
. clientsService
- Configures the service used by clients to access Zookeeper.
nodesService
- Configures the headless service.
podDisruptionBudget
-
Configures the Pod Disruption Budget for Zookeeper
StatefulSet
. zookeeperContainer
- Configures the container used to run the Zookeeper Node, including custom environment variables.
tlsSidecarContainer
- Configures the TLS sidecar container, including custom environment variables.
persistentVolumeClaim
-
Configures the metadata of the Zookeeper
PersistentVolumeClaims
.
Additional resources
3.7.1.3. Supported template properties for Entity Operator
deployment
- Configures the Deployment used by the Entity Operator.
pod
-
Configures the Entity Operator
Pod
created by theDeployment
. topicOperatorContainer
- Configures the container used to run the Topic Operator, including custom environment variables.
userOperatorContainer
- Configures the container used to run the User Operator, including custom environment variables.
tlsSidecarContainer
- Configures the TLS sidecar container, including custom environment variables.
Additional resources
3.7.1.4. Supported template properties for Kafka Exporter
deployment
- Configures the Deployment used by Kafka Exporter.
pod
-
Configures the Kafka Exporter
Pod
created by theDeployment
. services
- Configures the Kafka Exporter services.
container
- Configures the container used to run Kafka Exporter, including custom environment variables.
Additional resources
3.7.1.5. Supported template properties for Kafka Connect and Kafka Connect with Source2Image support
deployment
-
Configures the Kafka Connect
Deployment
. pod
-
Configures the Kafka Connect
Pods
created by theDeployment
. apiService
- Configures the service used by the Kafka Connect REST API.
podDisruptionBudget
-
Configures the Pod Disruption Budget for Kafka Connect
Deployment
. connectContainer
- Configures the container used to run Kafka Connect, including custom environment variables.
Additional resources
3.7.1.6. Supported template properties for Kafka Mirror Maker
deployment
-
Configures the Kafka Mirror Maker
Deployment
. pod
-
Configures the Kafka Mirror Maker
Pods
created by theDeployment
. podDisruptionBudget
-
Configures the Pod Disruption Budget for Kafka Mirror Maker
Deployment
. mirrorMakerContainer
- Configures the container used to run Kafka Mirror Maker, including custom environment variables.
Additional resources
3.7.2. Labels and Annotations
For every resource, you can configure additional Labels
and Annotations
. Labels
and Annotations
are used to identify and organize resources, and are configured in the metadata
property.
For example:
# ... template: statefulset: metadata: labels: label1: value1 label2: value2 annotations: annotation1: value1 annotation2: value2 # ...
The labels
and annotations
fields can contain any labels or annotations that do not contain the reserved string strimzi.io
. Labels and annotations containing strimzi.io
are used internally by AMQ Streams and cannot be configured.
The metadata
property is not applicable to container templates, such as the kafkaContainer
.
3.7.3. Customizing Pods
In addition to Labels and Annotations, you can customize some other fields on Pods. These fields are described in the following table and affect how the Pod is created.
Field | Description |
---|---|
|
Defines the period of time, in seconds, by which the Pod must have terminated gracefully. After the grace period, the Pod and its containers are forcefully terminated (killed). The default value is NOTE: 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. |
| Defines a list of references to OpenShift Secrets that can be used for pulling container images from private repositories. For more information about how to create a Secret with the credentials, see Pull an Image from a Private Registry.
NOTE: When the |
| Configures pod-level security attributes for containers running as part of a given Pod. For more information about configuring SecurityContext, see Configure a Security Context for a Pod or Container. |
| Configures the name of the Priority Class which will be used for given a Pod. For more information about Priority Classes, see Pod Priority and Preemption. |
These fields are effective on each type of cluster (Kafka and Zookeeper; Kafka Connect and Kafka Connect with S2I support; and Kafka Mirror Maker).
The following example shows these customized fields on a template
property:
# ... template: pod: metadata: labels: label1: value1 imagePullSecrets: - name: my-docker-credentials securityContext: runAsUser: 1000001 fsGroup: 0 terminationGracePeriodSeconds: 120 # ...
Additional resources
-
For more information, see Section C.43, “
PodTemplate
schema reference”.
3.7.4. Customizing containers with environment variables
You can set custom environment variables for a container by using the relevant template
container property. The following table lists the AMQ Streams containers and the relevant template configuration property (defined under spec
) for each custom resource.
Table 3.1. Table Container environment variable properties
AMQ Streams Element | Container | Configuration property |
---|---|---|
Kafka | Kafka Broker |
|
Kafka | Kafka Broker TLS Sidecar |
|
Kafka | Kafka Initialization |
|
Kafka | Zookeeper Node |
|
Kafka | Zookeeper TLS Sidecar |
|
Kafka | Topic Operator |
|
Kafka | User Operator |
|
Kafka | Entity Operator TLS Sidecar |
|
KafkaConnect | Connect and ConnectS2I |
|
KafkaMirrorMaker | Mirror Maker |
|
KafkaBridge | Bridge |
|
The environment variables are defined under the env
property as a list of objects with name
and value
fields. The following example shows two custom environment variables set for the Kafka broker containers:
# ... kind: Kafka spec: kafka: template: kafkaContainer: env: - name: TEST_ENV_1 value: test.env.one - name: TEST_ENV_2 value: test.env.two # ...
Environment variables prefixed with KAFKA_
are internal to AMQ Streams and should be avoided. If you set a custom environment variable that is already in use by AMQ Streams, it is ignored and a warning is recorded in the log.
Additional resources
-
For more information, see Section C.45, “
ContainerTemplate
schema reference”.
3.7.5. Customizing the image pull policy
AMQ Streams allows you to customize the image pull policy for containers in all pods deployed by the Cluster Operator. The image pull policy is configured using the environment variable STRIMZI_IMAGE_PULL_POLICY
in the Cluster Operator deployment. The STRIMZI_IMAGE_PULL_POLICY
environment variable can be set to three different values:
Always
- Container images are pulled from the registry every time the pod is started or restarted.
IfNotPresent
- Container images are pulled from the registry only when they were not pulled before.
Never
- Container images are never pulled from the registry.
The image pull policy can be currently customized only for all Kafka, Kafka Connect, and Kafka Mirror Maker clusters at once. Changing the policy will result in a rolling update of all your Kafka, Kafka Connect, and Kafka Mirror Maker clusters.
Additional resources
- For more information about Cluster Operator configuration, see Section 4.1, “Cluster Operator”.
- For more information about Image Pull Policies, see Disruptions.
3.7.6. Customizing Pod Disruption Budgets
AMQ Streams creates a pod disruption budget for every new StatefulSet
or Deployment
. By default, these pod disruption budgets only allow a single pod to be unavailable at a given time by setting the maxUnavailable
value in the`PodDisruptionBudget.spec` resource to 1. You can change the amount of unavailable pods allowed by changing the default value of maxUnavailable
in the pod disruption budget template. This template applies to each type of cluster (Kafka and Zookeeper; Kafka Connect and Kafka Connect with S2I support; and Kafka Mirror Maker).
The following example shows customized podDisruptionBudget
fields on a template
property:
# ... template: podDisruptionBudget: metadata: labels: key1: label1 key2: label2 annotations: key1: label1 key2: label2 maxUnavailable: 1 # ...
Additional resources
-
For more information, see Section C.44, “
PodDisruptionBudgetTemplate
schema reference”. - The Disruptions chapter of the OpenShift documentation.
3.7.7. Customizing deployments
This procedure describes how to customize Labels
of a Kafka cluster.
Prerequisites
- An OpenShift cluster.
- A running Cluster Operator.
Procedure
Edit the
template
property in theKafka
,KafkaConnect
,KafkaConnectS2I
, orKafkaMirrorMaker
resource. For example, to modify the labels for the Kafka brokerStatefulSet
, use:apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster labels: app: my-cluster spec: kafka: # ... template: statefulset: metadata: labels: mylabel: myvalue # ...
Create or update the resource.
Use
oc apply
:oc apply -f your-file
Alternatively, use
oc edit
:oc edit Resource ClusterName
Chapter 4. Operators
4.1. Cluster Operator
4.1.1. Overview of the Cluster Operator component
AMQ Streams uses the Cluster Operator to deploy and manage clusters for:
- Kafka (including Zookeeper, Entity Operator and Kafka Exporter)
- Kafka Connect
- Kafka Mirror Maker
- Kafka Bridge
Custom resources are used to deploy the clusters.
For example, to deploy a Kafka cluster:
-
A
Kafka
resource with the cluster configuration is created within the OpenShift cluster. -
The Cluster Operator deploys a corresponding Kafka cluster, based on what is declared in the
Kafka
resource.
The Cluster Operator can also deploy (through Entity Operator configuration of the Kafka
resource):
-
A Topic Operator to provide operator-style topic management through
KafkaTopic
custom resources -
A User Operator to provide operator-style user management through
KafkaUser
custom resources
For more information on the configuration options supported by the Kafka
resource, see Section 3.1, “Kafka cluster configuration”.
On OpenShift, a Kafka Connect deployment can incorporate a Source2Image feature to provides a convenient way to include connectors.
Example architecture for the Cluster Operator
4.1.2. Watch options for a Cluster Operator deployment
When the Cluster Operator is running, it starts to watch for updates of Kafka resources.
Depending on the deployment, the Cluster Operator can watch Kafka resources from:
AMQ Streams provides example YAML files to make the deployment process easier.
The Cluster Operator watches the following resources:
-
Kafka
for the Kafka cluster. -
KafkaConnect
for the Kafka Connect cluster. -
KafkaConnectS2I
for the Kafka Connect cluster with Source2Image support. -
KafkaMirrorMaker
for the Kafka Mirror Maker instance. -
KafkaBridge
for the Kafka Bridge instance
When one of these resources is created in the OpenShift cluster, the operator gets the cluster description from the resource and starts creating a new cluster for the resource by creating the necessary OpenShift resources, such as StatefulSets, Services and ConfigMaps.
Each time a Kafka resource is updated, the operator performs corresponding updates on the OpenShift resources that make up the cluster for the resource.
Resources are either patched or deleted, and then recreated in order to make the cluster for the resource reflect the desired state of the cluster. This operation might cause a rolling update that might lead to service disruption.
When a resource is deleted, the operator undeploys the cluster and deletes all related OpenShift resources.
4.1.3. Deploying the Cluster Operator to watch a single namespace
Prerequisites
-
This procedure requires use of an OpenShift user account which is able to create
CustomResourceDefinitions
,ClusterRoles
andClusterRoleBindings
. Use of Role Base Access Control (RBAC) in the OpenShift cluster usually means that permission to create, edit, and delete these resources is limited to OpenShift cluster administrators, such assystem:admin
. Modify the installation files according to the namespace the Cluster Operator is going to be installed in.
On Linux, use:
sed -i 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
On MacOS, use:
sed -i '' 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
Procedure
Deploy the Cluster Operator:
oc apply -f install/cluster-operator -n my-namespace
4.1.4. Deploying the Cluster Operator to watch multiple namespaces
Prerequisites
-
This procedure requires use of an OpenShift user account which is able to create
CustomResourceDefinitions
,ClusterRoles
andClusterRoleBindings
. Use of Role Base Access Control (RBAC) in the OpenShift cluster usually means that permission to create, edit, and delete these resources is limited to OpenShift cluster administrators, such assystem:admin
. Edit the installation files according to the namespace the Cluster Operator is going to be installed in.
On Linux, use:
sed -i 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
On MacOS, use:
sed -i '' 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
Procedure
Edit the file
install/cluster-operator/050-Deployment-strimzi-cluster-operator.yaml
and in the environment variableSTRIMZI_NAMESPACE
list all the namespaces where Cluster Operator should watch for resources. For example:apiVersion: apps/v1 kind: Deployment spec: # ... template: spec: serviceAccountName: strimzi-cluster-operator containers: - name: strimzi-cluster-operator image: registry.redhat.io/amq7/amq-streams-operator:1.3.0 imagePullPolicy: IfNotPresent env: - name: STRIMZI_NAMESPACE value: watched-namespace-1,watched-namespace-2,watched-namespace-3
For all namespaces which should be watched by the Cluster Operator (
watched-namespace-1
,watched-namespace-2
,watched-namespace-3
in the above example), install theRoleBindings
. Replace thewatched-namespace
with the namespace used in the previous step.This can be done using
oc apply
:oc apply -f install/cluster-operator/020-RoleBinding-strimzi-cluster-operator.yaml -n watched-namespace oc apply -f install/cluster-operator/031-RoleBinding-strimzi-cluster-operator-entity-operator-delegation.yaml -n watched-namespace oc apply -f install/cluster-operator/032-RoleBinding-strimzi-cluster-operator-topic-operator-delegation.yaml -n watched-namespace
Deploy the Cluster Operator
This can be done using
oc apply
:oc apply -f install/cluster-operator -n my-namespace
4.1.5. Deploying the Cluster Operator to watch all namespaces
You can configure the Cluster Operator to watch AMQ Streams resources across all namespaces in your OpenShift cluster. When running in this mode, the Cluster Operator automatically manages clusters in any new namespaces that are created.
Prerequisites
-
This procedure requires use of an OpenShift user account which is able to create
CustomResourceDefinitions
,ClusterRoles
andClusterRoleBindings
. Use of Role Base Access Control (RBAC) in the OpenShift cluster usually means that permission to create, edit, and delete these resources is limited to OpenShift cluster administrators, such assystem:admin
. - Your OpenShift cluster is running.
Procedure
Configure the Cluster Operator to watch all namespaces:
-
Edit the
050-Deployment-strimzi-cluster-operator.yaml
file. Set the value of the
STRIMZI_NAMESPACE
environment variable to*
.apiVersion: apps/v1 kind: Deployment spec: # ... template: spec: # ... serviceAccountName: strimzi-cluster-operator containers: - name: strimzi-cluster-operator image: registry.redhat.io/amq7/amq-streams-operator:1.3.0 imagePullPolicy: IfNotPresent env: - name: STRIMZI_NAMESPACE value: "*" # ...
-
Edit the
Create
ClusterRoleBindings
that grant cluster-wide access to all namespaces to the Cluster Operator.Use the
oc create clusterrolebinding
command:oc create clusterrolebinding strimzi-cluster-operator-namespaced --clusterrole=strimzi-cluster-operator-namespaced --serviceaccount my-namespace:strimzi-cluster-operator oc create clusterrolebinding strimzi-cluster-operator-entity-operator-delegation --clusterrole=strimzi-entity-operator --serviceaccount my-namespace:strimzi-cluster-operator oc create clusterrolebinding strimzi-cluster-operator-topic-operator-delegation --clusterrole=strimzi-topic-operator --serviceaccount my-namespace:strimzi-cluster-operator
Replace
my-namespace
with the namespace in which you want to install the Cluster Operator.Deploy the Cluster Operator to your OpenShift cluster.
Use the
oc apply
command:oc apply -f install/cluster-operator -n my-namespace
4.1.6. Reconciliation
Although the operator reacts to all notifications about the desired cluster resources received from the OpenShift cluster, if the operator is not running, or if a notification is not received for any reason, the desired resources will get out of sync with the state of the running OpenShift cluster.
In order to handle failovers properly, a periodic reconciliation process is executed by the Cluster Operator so that it can compare the state of the desired resources with the current cluster deployments in order to have a consistent state across all of them. You can set the time interval for the periodic reconciliations using the [STRIMZI_FULL_RECONCILIATION_INTERVAL_MS] variable.
4.1.7. Cluster Operator Configuration
The Cluster Operator can be configured through the following supported environment variables:
STRIMZI_NAMESPACE
A comma-separated list of namespaces that the operator should operate in. When not set, set to empty string, or to
*
the Cluster Operator will operate in all namespaces. The Cluster Operator deployment might use the OpenShift Downward API to set this automatically to the namespace the Cluster Operator is deployed in. See the example below:env: - name: STRIMZI_NAMESPACE valueFrom: fieldRef: fieldPath: metadata.namespace
-
STRIMZI_FULL_RECONCILIATION_INTERVAL_MS
- Optional, default is 120000 ms. The interval between periodic reconciliations, in milliseconds.
STRIMZI_LOG_LEVEL
-
Optional, default
INFO
. The level for printing logging messages. The value can be set to:ERROR
,WARNING
,INFO
,DEBUG
, andTRACE
. STRIMZI_OPERATION_TIMEOUT_MS
- Optional, default 300000 ms. The timeout for internal operations, in milliseconds. This value should be increased when using AMQ Streams on clusters where regular OpenShift operations take longer than usual (because of slow downloading of Docker images, for example).
STRIMZI_KAFKA_IMAGES
-
Required. This provides a mapping from Kafka version to the corresponding Docker image containing a Kafka broker of that version. The required syntax is whitespace or comma separated
<version>=<image>
pairs. For example2.2.1=registry.redhat.io/amq7/amq-streams-kafka-22:1.3.0, 2.3.0=registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. This is used when aKafka.spec.kafka.version
property is specified but not theKafka.spec.kafka.image
, as described in Section 3.1.18, “Container images”. STRIMZI_DEFAULT_KAFKA_INIT_IMAGE
-
Optional, default
registry.redhat.io/amq7/amq-streams-operator:1.3.0
. The image name to use as default for the init container started before the broker for initial configuration work (that is, rack support), if no image is specified as thekafka-init-image
in the Section 3.1.18, “Container images”. STRIMZI_DEFAULT_TLS_SIDECAR_KAFKA_IMAGE
-
Optional, default
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. The image name to use as the default when deploying the sidecar container which provides TLS support for Kafka, if no image is specified as theKafka.spec.kafka.tlsSidecar.image
in the Section 3.1.18, “Container images”. STRIMZI_DEFAULT_ZOOKEEPER_IMAGE
-
Optional, default
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. The image name to use as the default when deploying Zookeeper, if no image is specified as theKafka.spec.zookeeper.image
in the Section 3.1.18, “Container images”. STRIMZI_DEFAULT_TLS_SIDECAR_ZOOKEEPER_IMAGE
-
Optional, default
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. The image name to use as the default when deploying the sidecar container which provides TLS support for Zookeeper, if no image is specified as theKafka.spec.zookeeper.tlsSidecar.image
in the Section 3.1.18, “Container images”. STRIMZI_KAFKA_CONNECT_IMAGES
-
Required. This provides a mapping from the Kafka version to the corresponding Docker image containing a Kafka connect of that version. The required syntax is whitespace or comma separated
<version>=<image>
pairs. For example2.2.1=registry.redhat.io/amq7/amq-streams-kafka-22:1.3.0, 2.3.0=registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. This is used when aKafkaConnect.spec.version
property is specified but not theKafkaConnect.spec.image
, as described in Section 3.2.11, “Container images”. STRIMZI_KAFKA_CONNECT_S2I_IMAGES
-
Required. This provides a mapping from the Kafka version to the corresponding Docker image containing a Kafka connect of that version. The required syntax is whitespace or comma separated
<version>=<image>
pairs. For example2.2.1=registry.redhat.io/amq7/amq-streams-kafka-22:1.3.0, 2.3.0=registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. This is used when aKafkaConnectS2I.spec.version
property is specified but not theKafkaConnectS2I.spec.image
, as described in Section 3.3.11, “Container images”. STRIMZI_KAFKA_MIRROR_MAKER_IMAGES
-
Required. This provides a mapping from the Kafka version to the corresponding Docker image containing a Kafka mirror maker of that version. The required syntax is whitespace or comma separated
<version>=<image>
pairs. For example2.2.1=registry.redhat.io/amq7/amq-streams-kafka-22:1.3.0, 2.3.0=registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. This is used when aKafkaMirrorMaker.spec.version
property is specified but not theKafkaMirrorMaker.spec.image
, as described in Section 3.4.2.14, “Container images”. STRIMZI_DEFAULT_TOPIC_OPERATOR_IMAGE
-
Optional, default
registry.redhat.io/amq7/amq-streams-operator:1.3.0
. The image name to use as the default when deploying the topic operator, if no image is specified as theKafka.spec.entityOperator.topicOperator.image
in the Section 3.1.18, “Container images” of theKafka
resource. STRIMZI_DEFAULT_USER_OPERATOR_IMAGE
-
Optional, default
registry.redhat.io/amq7/amq-streams-operator:1.3.0
. The image name to use as the default when deploying the user operator, if no image is specified as theKafka.spec.entityOperator.userOperator.image
in the Section 3.1.18, “Container images” of theKafka
resource. STRIMZI_DEFAULT_TLS_SIDECAR_ENTITY_OPERATOR_IMAGE
-
Optional, default
registry.redhat.io/amq7/amq-streams-kafka-23:1.3.0
. The image name to use as the default when deploying the sidecar container which provides TLS support for the Entity Operator, if no image is specified as theKafka.spec.entityOperator.tlsSidecar.image
in the Section 3.1.18, “Container images”. STRIMZI_IMAGE_PULL_POLICY
-
Optional. The
ImagePullPolicy
which will be applied to containers in all pods managed by AMQ Streams Cluster Operator. The valid values areAlways
,IfNotPresent
, andNever
. If not specified, the OpenShift defaults will be used. Changing the policy will result in a rolling update of all your Kafka, Kafka Connect, and Kafka Mirror Maker clusters. STRIMZI_IMAGE_PULL_SECRETS
-
Optional. A comma-separated list of
Secret
names. The secrets referenced here contain the credentials to the container registries where the container images are pulled from. The secrets are used in theimagePullSecrets
field for allPods
created by the Cluster Operator. Changing this list results in a rolling update of all your Kafka, Kafka Connect, and Kafka Mirror Maker clusters.
4.1.8. Role-Based Access Control (RBAC)
4.1.8.1. Provisioning Role-Based Access Control (RBAC) for the Cluster Operator
For the Cluster Operator to function it needs permission within the OpenShift cluster to interact with resources such as Kafka
, KafkaConnect
, and so on, as well as the managed resources, such as ConfigMaps
, Pods
, Deployments
, StatefulSets
, Services
, and so on. Such permission is described in terms of OpenShift role-based access control (RBAC) resources:
-
ServiceAccount
, -
Role
andClusterRole
, -
RoleBinding
andClusterRoleBinding
.
In addition to running under its own ServiceAccount
with a ClusterRoleBinding
, the Cluster Operator manages some RBAC resources for the components that need access to OpenShift resources.
OpenShift also includes privilege escalation protections that prevent components operating under one ServiceAccount
from granting other ServiceAccounts
privileges that the granting ServiceAccount
does not have. Because the Cluster Operator must be able to create the ClusterRoleBindings
, and RoleBindings
needed by resources it manages, the Cluster Operator must also have those same privileges.
4.1.8.2. Delegated privileges
When the Cluster Operator deploys resources for a desired Kafka
resource it also creates ServiceAccounts
, RoleBindings
, and ClusterRoleBindings
, as follows:
The Kafka broker pods use a
ServiceAccount
calledcluster-name-kafka
-
When the rack feature is used, the
strimzi-cluster-name-kafka-init
ClusterRoleBinding
is used to grant thisServiceAccount
access to the nodes within the cluster via aClusterRole
calledstrimzi-kafka-broker
- When the rack feature is not used no binding is created.
-
When the rack feature is used, the
-
The Zookeeper pods use the default
ServiceAccount
, as they do not need access to the OpenShift resources. The Topic Operator pod uses a
ServiceAccount
calledcluster-name-topic-operator
-
The Topic Operator produces OpenShift events with status information, so the
ServiceAccount
is bound to aClusterRole
calledstrimzi-topic-operator
which grants this access via thestrimzi-topic-operator-role-binding
RoleBinding
.
-
The Topic Operator produces OpenShift events with status information, so the
The pods for KafkaConnect
and KafkaConnectS2I
resources use the default ServiceAccount
, as they do not require access to the OpenShift resources.
4.1.8.3. ServiceAccount
The Cluster Operator is best run using a ServiceAccount
:
Example ServiceAccount
for the Cluster Operator
apiVersion: v1 kind: ServiceAccount metadata: name: strimzi-cluster-operator labels: app: strimzi
The Deployment
of the operator then needs to specify this in its spec.template.spec.serviceAccountName
:
Partial example of Deployment
for the Cluster Operator
apiVersion: apps/v1 kind: Deployment metadata: name: strimzi-cluster-operator labels: app: strimzi spec: replicas: 1 selector: matchLabels: name: strimzi-cluster-operator strimzi.io/kind: cluster-operator template: # ...
Note line 12, where the the strimzi-cluster-operator
ServiceAccount
is specified as the serviceAccountName
.
4.1.8.4. ClusterRoles
The Cluster Operator needs to operate using ClusterRoles
that gives access to the necessary resources. Depending on the OpenShift cluster setup, a cluster administrator might be needed to create the ClusterRoles
.
Cluster administrator rights are only needed for the creation of the ClusterRoles
. The Cluster Operator will not run under the cluster admin account.
The ClusterRoles
follow the principle of least privilege and contain only those privileges needed by the Cluster Operator to operate Kafka, Kafka Connect, and Zookeeper clusters. The first set of assigned privileges allow the Cluster Operator to manage OpenShift resources such as StatefulSets
, Deployments
, Pods
, and ConfigMaps
.
Cluster Operator uses ClusterRoles to grant permission at the namespace-scoped resources level and cluster-scoped resources level:
ClusterRole
with namespaced resources for the Cluster Operator
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: strimzi-cluster-operator-namespaced labels: app: strimzi rules: - apiGroups: - "" resources: - serviceaccounts verbs: - get - create - delete - patch - update - apiGroups: - rbac.authorization.k8s.io resources: - rolebindings verbs: - get - create - delete - patch - update - apiGroups: - "" resources: - configmaps verbs: - get - list - watch - create - delete - patch - update - apiGroups: - kafka.strimzi.io resources: - kafkas - kafkas/status - kafkaconnects - kafkaconnects/status - kafkaconnects2is - kafkaconnects2is/status - kafkamirrormakers - kafkamirrormakers/status - kafkabridges - kafkabridges/status verbs: - get - list - watch - create - delete - patch - update - apiGroups: - "" resources: - pods verbs: - get - list - watch - delete - apiGroups: - "" resources: - services verbs: - get - list - watch - create - delete - patch - update - apiGroups: - "" resources: - endpoints verbs: - get - list - watch - apiGroups: - extensions resources: - deployments - deployments/scale - replicasets verbs: - get - list - watch - create - delete - patch - update - apiGroups: - apps resources: - deployments - deployments/scale - deployments/status - statefulsets - replicasets verbs: - get - list - watch - create - delete - patch - update - apiGroups: - "" resources: - events verbs: - create - apiGroups: - extensions resources: - replicationcontrollers verbs: - get - list - watch - create - delete - patch - update - apiGroups: - apps.openshift.io resources: - deploymentconfigs - deploymentconfigs/scale - deploymentconfigs/status - deploymentconfigs/finalizers verbs: - get - list - watch - create - delete - patch - update - apiGroups: - build.openshift.io resources: - buildconfigs - builds verbs: - create - delete - get - list - patch - watch - update - apiGroups: - image.openshift.io resources: - imagestreams - imagestreams/status verbs: - create - delete - get - list - watch - patch - update - apiGroups: - "" resources: - replicationcontrollers verbs: - get - list - watch - create - delete - patch - update - apiGroups: - "" resources: - secrets verbs: - get - list - create - delete - patch - update - apiGroups: - extensions resources: - networkpolicies verbs: - get - list - watch - create - delete - patch - update - apiGroups: - networking.k8s.io resources: - networkpolicies verbs: - get - list - watch - create - delete - patch - update - apiGroups: - route.openshift.io resources: - routes - routes/custom-host verbs: - get - list - create - delete - patch - update - apiGroups: - "" resources: - persistentvolumeclaims verbs: - get - list - create - delete - patch - update - apiGroups: - policy resources: - poddisruptionbudgets verbs: - get - list - watch - create - delete - patch - update - apiGroups: - extensions resources: - ingresses verbs: - get - list - watch - create - delete - patch - update
The second includes the permissions needed for cluster-scoped resources.
ClusterRole
with cluster-scoped resources for the Cluster Operator
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: strimzi-cluster-operator-global labels: app: strimzi rules: - apiGroups: - rbac.authorization.k8s.io resources: - clusterrolebindings verbs: - get - create - delete - patch - update - watch - apiGroups: - storage.k8s.io resources: - storageclasses verbs: - get
The strimzi-kafka-broker
ClusterRole
represents the access needed by the init container in Kafka pods that is used for the rack feature. As described in the Delegated privileges section, this role is also needed by the Cluster Operator in order to be able to delegate this access.
ClusterRole
for the Cluster Operator allowing it to delegate access to OpenShift nodes to the Kafka broker pods
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: strimzi-kafka-broker labels: app: strimzi rules: - apiGroups: - "" resources: - nodes verbs: - get
The strimzi-topic-operator
ClusterRole
represents the access needed by the Topic Operator. As described in the Delegated privileges section, this role is also needed by the Cluster Operator in order to be able to delegate this access.
ClusterRole
for the Cluster Operator allowing it to delegate access to events to the Topic Operator
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: strimzi-entity-operator labels: app: strimzi rules: - apiGroups: - kafka.strimzi.io resources: - kafkatopics - kafkatopics/status verbs: - get - list - watch - create - patch - update - delete - apiGroups: - "" resources: - events verbs: - create - apiGroups: - kafka.strimzi.io resources: - kafkausers - kafkausers/status verbs: - get - list - watch - create - patch - update - delete - apiGroups: - "" resources: - secrets verbs: - get - list - create - patch - update - delete
4.1.8.5. ClusterRoleBindings
The operator needs ClusterRoleBindings
and RoleBindings
which associates its ClusterRole
with its ServiceAccount
: ClusterRoleBindings
are needed for ClusterRoles
containing cluster-scoped resources.
Example ClusterRoleBinding
for the Cluster Operator
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: strimzi-cluster-operator labels: app: strimzi subjects: - kind: ServiceAccount name: strimzi-cluster-operator namespace: myproject roleRef: kind: ClusterRole name: strimzi-cluster-operator-global apiGroup: rbac.authorization.k8s.io
ClusterRoleBindings
are also needed for the ClusterRoles
needed for delegation:
Examples RoleBinding
for the Cluster Operator
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: strimzi-cluster-operator-kafka-broker-delegation labels: app: strimzi subjects: - kind: ServiceAccount name: strimzi-cluster-operator namespace: myproject roleRef: kind: ClusterRole name: strimzi-kafka-broker apiGroup: rbac.authorization.k8s.io
ClusterRoles
containing only namespaced resources are bound using RoleBindings
only.
apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: name: strimzi-cluster-operator labels: app: strimzi subjects: - kind: ServiceAccount name: strimzi-cluster-operator namespace: myproject roleRef: kind: ClusterRole name: strimzi-cluster-operator-namespaced apiGroup: rbac.authorization.k8s.io
apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: name: strimzi-cluster-operator-entity-operator-delegation labels: app: strimzi subjects: - kind: ServiceAccount name: strimzi-cluster-operator namespace: myproject roleRef: kind: ClusterRole name: strimzi-entity-operator apiGroup: rbac.authorization.k8s.io
4.2. Topic Operator
4.2.1. Overview of the Topic Operator component
The Topic Operator provides a way of managing topics in a Kafka cluster via OpenShift resources.
Example architecture for the Topic Operator
The role of the Topic Operator is to keep a set of KafkaTopic
OpenShift resources describing Kafka topics in-sync with corresponding Kafka topics.
Specifically, if a KafkaTopic
is:
- Created, the operator will create the topic it describes
- Deleted, the operator will delete the topic it describes
- Changed, the operator will update the topic it describes
And also, in the other direction, if a topic is:
-
Created within the Kafka cluster, the operator will create a
KafkaTopic
describing it -
Deleted from the Kafka cluster, the operator will delete the
KafkaTopic
describing it -
Changed in the Kafka cluster, the operator will update the
KafkaTopic
describing it
This allows you to declare a KafkaTopic
as part of your application’s deployment and the Topic Operator will take care of creating the topic for you. Your application just needs to deal with producing or consuming from the necessary topics.
If the topic is reconfigured or reassigned to different Kafka nodes, the KafkaTopic
will always be up to date.
For more details about creating, modifying and deleting topics, see Chapter 5, Using the Topic Operator.
4.2.2. Identifying a Kafka cluster for topic handling
A KafkaTopic
resource includes a label that defines the appropriate name of the Kafka cluster (derived from the name of the Kafka
resource) to which it belongs.
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaTopic metadata: name: my-topic labels: strimzi.io/cluster: my-cluster
The label is used by the Topic Operator to identify the KafkaTopic
resource and create a new topic, and also in subsequent handling of the topic.
If the label does not match the Kafka cluster, the Topic Operator cannot identify the KafkaTopic
and the topic is not created.
4.2.3. Understanding the Topic Operator
A fundamental problem that the operator has to solve is that there is no single source of truth: Both the KafkaTopic
resource and the topic within Kafka can be modified independently of the operator. Complicating this, the Topic Operator might not always be able to observe changes at each end in real time (for example, the operator might be down).
To resolve this, the operator maintains its own private copy of the information about each topic. When a change happens either in the Kafka cluster, or in OpenShift, it looks at both the state of the other system and at its private copy in order to determine what needs to change to keep everything in sync. The same thing happens whenever the operator starts, and periodically while it is running.
For example, suppose the Topic Operator is not running, and a KafkaTopic
my-topic
gets created. When the operator starts it will lack a private copy of "my-topic", so it can infer that the KafkaTopic
has been created since it was last running. The operator will create the topic corresponding to "my-topic" and also store a private copy of the metadata for "my-topic".
The private copy allows the operator to cope with scenarios where the topic configuration gets changed both in Kafka and in OpenShift, so long as the changes are not incompatible (for example, both changing the same topic config key, but to different values). In the case of incompatible changes, the Kafka configuration wins, and the KafkaTopic
will be updated to reflect that.
The private copy is held in the same Zookeeper ensemble used by Kafka itself. This mitigates availability concerns, because if Zookeeper is not running then Kafka itself cannot run, so the operator will be no less available than it would even if it was stateless.
4.2.4. Deploying the Topic Operator using the Cluster Operator
This procedure describes how to deploy the Topic Operator using the Cluster Operator. If you want to use the Topic Operator with a Kafka cluster that is not managed by AMQ Streams, you must deploy the Topic Operator as a standalone component. For more information, see Section 4.2.6, “Deploying the standalone Topic Operator”.
Prerequisites
- A running Cluster Operator
-
A
Kafka
resource to be created or updated
Procedure
Ensure that the
Kafka.spec.entityOperator
object exists in theKafka
resource. This configures the Entity Operator.apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka metadata: name: my-cluster spec: #... entityOperator: topicOperator: {} userOperator: {}
-
Configure the Topic Operator using the fields described in Section C.52, “
EntityTopicOperatorSpec
schema reference”. Create or update the Kafka resource in OpenShift.
Use
oc apply
:oc apply -f your-file
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Entity Operator, see Section 3.1.11, “Entity Operator”.
-
For more information about the
Kafka.spec.entityOperator
object used to configure the Topic Operator when deployed by the Cluster Operator, see Section C.51, “EntityOperatorSpec
schema reference”.
4.2.5. Configuring the Topic Operator with resource requests and limits
You can allocate resources, such as CPU and memory, to the Topic Operator and set a limit on the amount of resources it can consume.
Prerequisites
- The Cluster Operator is running.
Procedure
Update the Kafka cluster configuration in an editor, as required:
Use
oc edit
:oc edit kafka my-cluster
In the
spec.entityOperator.topicOperator.resources
property in theKafka
resource, set the resource requests and limits for the Topic Operator.apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: # kafka and zookeeper sections... entityOperator: topicOperator: resources: request: cpu: "1" memory: 500Mi limit: cpu: "1" memory: 500Mi
Apply the new configuration to create or update the resource.
Use
oc apply
:oc apply -f kafka.yaml
Additional resources
-
For more information about the schema of the
resources
object, see Section C.36, “ResourceRequirements
schema reference”.
4.2.6. Deploying the standalone Topic Operator
Deploying the Topic Operator as a standalone component is more complicated than installing it using the Cluster Operator, but it is more flexible. For instance, it can operate with any Kafka cluster, not necessarily one deployed by the Cluster Operator.
Prerequisites
- An existing Kafka cluster for the Topic Operator to connect to.
Procedure
Edit the
install/topic-operator/05-Deployment-strimzi-topic-operator.yaml
resource. You will need to change the following-
The
STRIMZI_KAFKA_BOOTSTRAP_SERVERS
environment variable inDeployment.spec.template.spec.containers[0].env
should be set to a list of bootstrap brokers in your Kafka cluster, given as a comma-separated list ofhostname:port
pairs. -
The
STRIMZI_ZOOKEEPER_CONNECT
environment variable inDeployment.spec.template.spec.containers[0].env
should be set to a list of the Zookeeper nodes, given as a comma-separated list ofhostname:port
pairs. This should be the same Zookeeper cluster that your Kafka cluster is using. -
The
STRIMZI_NAMESPACE
environment variable inDeployment.spec.template.spec.containers[0].env
should be set to the OpenShift namespace in which you want the operator to watch forKafkaTopic
resources.
-
The
Deploy the Topic Operator.
This can be done using
oc apply
:oc apply -f install/topic-operator
Verify that the Topic Operator has been deployed successfully. This can be done using
oc describe
:oc describe deployment strimzi-topic-operator
The Topic Operator is deployed once the
Replicas:
entry shows1 available
.NoteThis could take some time if you have a slow connection to the OpenShift and the images have not been downloaded before.
Additional resources
- For more information about the environment variables used to configure the Topic Operator, see Section 4.2.7, “Topic Operator environment”.
- For more information about getting the Cluster Operator to deploy the Topic Operator for you, see Section 2.9.2, “Deploying the Topic Operator using the Cluster Operator”.
4.2.7. Topic Operator environment
When deployed standalone the Topic Operator can be configured using environment variables.
The Topic Operator should be configured using the Kafka.spec.entityOperator.topicOperator
property when deployed by the Cluster Operator.
STRIMZI_RESOURCE_LABELS
-
The label selector used to identify
KafkaTopics
to be managed by the operator. STRIMZI_ZOOKEEPER_SESSION_TIMEOUT_MS
-
The Zookeeper session timeout, in milliseconds. For example,
10000
. Default20000
(20 seconds). STRIMZI_KAFKA_BOOTSTRAP_SERVERS
- The list of Kafka bootstrap servers. This variable is mandatory.
STRIMZI_ZOOKEEPER_CONNECT
- The Zookeeper connection information. This variable is mandatory.
STRIMZI_FULL_RECONCILIATION_INTERVAL_MS
- The interval between periodic reconciliations, in milliseconds.
STRIMZI_TOPIC_METADATA_MAX_ATTEMPTS
-
The number of attempts at getting topic metadata from Kafka. The time between each attempt is defined as an exponential back-off. Consider increasing this value when topic creation could take more time due to the number of partitions or replicas. Default
6
. STRIMZI_LOG_LEVEL
-
The level for printing logging messages. The value can be set to:
ERROR
,WARNING
,INFO
,DEBUG
, andTRACE
. DefaultINFO
. STRIMZI_TLS_ENABLED
-
For enabling the TLS support so encrypting the communication with Kafka brokers. Default
true
. STRIMZI_TRUSTSTORE_LOCATION
-
The path to the truststore containing certificates for enabling TLS based communication. This variable is mandatory only if TLS is enabled through
STRIMZI_TLS_ENABLED
. STRIMZI_TRUSTSTORE_PASSWORD
-
The password for accessing the truststore defined by
STRIMZI_TRUSTSTORE_LOCATION
. This variable is mandatory only if TLS is enabled throughSTRIMZI_TLS_ENABLED
. STRIMZI_KEYSTORE_LOCATION
-
The path to the keystore containing private keys for enabling TLS based communication. This variable is mandatory only if TLS is enabled through
STRIMZI_TLS_ENABLED
. STRIMZI_KEYSTORE_PASSWORD
-
The password for accessing the keystore defined by
STRIMZI_KEYSTORE_LOCATION
. This variable is mandatory only if TLS is enabled throughSTRIMZI_TLS_ENABLED
.
4.3. User Operator
The User Operator manages Kafka users through custom resources.
4.3.1. Overview of the User Operator component
The User Operator manages Kafka users for a Kafka cluster by watching for KafkaUser
resources that describe Kafka users and ensuring that they are configured properly in the Kafka cluster. For example:
-
if a
KafkaUser
is created, the User Operator will create the user it describes -
if a
KafkaUser
is deleted, the User Operator will delete the user it describes -
if a
KafkaUser
is changed, the User Operator will update the user it describes
Unlike the Topic Operator, the User Operator does not sync any changes from the Kafka cluster with the OpenShift resources. Unlike the Kafka topics which might be created by applications directly in Kafka, it is not expected that the users will be managed directly in the Kafka cluster in parallel with the User Operator, so this should not be needed.
The User Operator allows you to declare a KafkaUser
as part of your application’s deployment. When the user is created, the user credentials will be created in a Secret
. Your application needs to use the user and its credentials for authentication and to produce or consume messages.
In addition to managing credentials for authentication, the User Operator also manages authorization rules by including a description of the user’s rights in the KafkaUser
declaration.
4.3.2. Identifying a Kafka cluster for user handling
A KafkaUser
resource includes a label that defines the appropriate name of the Kafka cluster (derived from the name of the Kafka
resource) to which it belongs.
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster
The label is used by the User Operator to identify the KafkaUser
resource and create a new user, and also in subsequent handling of the user.
If the label does not match the Kafka cluster, the User Operator cannot identify the kafkaUser
and the user is not created.
4.3.3. Deploying the User Operator using the Cluster Operator
Prerequisites
- A running Cluster Operator
-
A
Kafka
resource to be created or updated.
Procedure
-
Edit the
Kafka
resource ensuring it has aKafka.spec.entityOperator.userOperator
object that configures the User Operator how you want. Create or update the Kafka resource in OpenShift.
This can be done using
oc apply
:oc apply -f your-file
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
-
For more information about the
Kafka.spec.entityOperator
object used to configure the User Operator when deployed by the Cluster Operator, seeEntityOperatorSpec
schema reference.
4.3.4. Configuring the User Operator with resource requests and limits
You can allocate resources, such as CPU and memory, to the User Operator and set a limit on the amount of resources it can consume.
Prerequisites
- The Cluster Operator is running.
Procedure
Update the Kafka cluster configuration in an editor, as required:
oc edit kafka my-cluster
In the
spec.entityOperator.userOperator.resources
property in theKafka
resource, set the resource requests and limits for the User Operator.apiVersion: kafka.strimzi.io/v1beta1 kind: Kafka spec: # kafka and zookeeper sections... entityOperator: userOperator: resources: request: cpu: "1" memory: 500Mi limit: cpu: "1" memory: 500Mi
Save the file and exit the editor. The Cluster Operator will apply the changes automatically.
Additional resources
-
For more information about the schema of the
resources
object, see Section C.36, “ResourceRequirements
schema reference”.
4.3.5. Deploying the standalone User Operator
Deploying the User Operator as a standalone component is more complicated than installing it using the Cluster Operator, but it is more flexible. For instance, it can operate with any Kafka cluster, not only the one deployed by the Cluster Operator.
Prerequisites
- An existing Kafka cluster for the User Operator to connect to.
Procedure
Edit the
install/user-operator/05-Deployment-strimzi-user-operator.yaml
resource. You will need to change the following-
The
STRIMZI_CA_CERT_NAME
environment variable inDeployment.spec.template.spec.containers[0].env
should be set to point to an OpenShiftSecret
which should contain the public key of the Certificate Authority for signing new user certificates for TLS Client Authentication. TheSecret
should contain the public key of the Certificate Authority under the keyca.crt
. -
The
STRIMZI_CA_KEY_NAME
environment variable inDeployment.spec.template.spec.containers[0].env
should be set to point to an OpenShiftSecret
which should contain the private key of the Certificate Authority for signing new user certificates for TLS Client Authentication. TheSecret
should contain the private key of the Certificate Authority under the keyca.key
. -
The
STRIMZI_ZOOKEEPER_CONNECT
environment variable inDeployment.spec.template.spec.containers[0].env
should be set to a list of the Zookeeper nodes, given as a comma-separated list ofhostname:port
pairs. This should be the same Zookeeper cluster that your Kafka cluster is using. -
The
STRIMZI_NAMESPACE
environment variable inDeployment.spec.template.spec.containers[0].env
should be set to the OpenShift namespace in which you want the operator to watch forKafkaUser
resources.
-
The
Deploy the User Operator.
This can be done using
oc apply
:oc apply -f install/user-operator
Verify that the User Operator has been deployed successfully. This can be done using
oc describe
:oc describe deployment strimzi-user-operator
The User Operator is deployed once the
Replicas:
entry shows1 available
.NoteThis could take some time if you have a slow connection to the OpenShift and the images have not been downloaded before.
Additional resources
- For more information about getting the Cluster Operator to deploy the User Operator for you, see Section 2.10.2, “Deploying the User Operator using the Cluster Operator”.
Chapter 5. Using the Topic Operator
5.1. Topic Operator usage recommendations
When working with topics, be consistent and always operate on either KafkaTopic
resources or topics directly. Avoid routinely switching between both methods for a given topic.
Use topic names that reflect the nature of the topic, and remember that names cannot be changed later.
If creating a topic in Kafka, use a name that is a valid OpenShift resource name, otherwise the Topic Operator will need to create the corresponding KafkaTopic
with a name that conforms to the OpenShift rules.
Recommendations for identifiers and names in OpenShift are outlined in Identifiers and Names in OpenShift community article.
Kafka topic naming conventions
Kafka and OpenShift impose their own validation rules for the naming of topics in Kafka and KafkaTopic.metadata.name
respectively. There are valid names for each which are invalid in the other.
Using the spec.topicName property
, it is possible to create a valid topic in Kafka with a name that would be invalid for the KafkaTopic in OpenShift.
The spec.topicName
property inherits Kafka naming validation rules:
- The name must not be longer than 249 characters.
-
Valid characters for Kafka topics are ASCII alphanumerics,
.
,_
, and-
. -
The name cannot be
.
or..
, though.
can be used in a name, such asexampleTopic.
or.exampleTopic
.
spec.topicName
must not be changed.
For example:
kind: KafkaTopic metadata: name: topic-name-1 spec: topicName: topicName-1 # Upper case is invalid in OpenShift # ...
cannot be changed to
kind: KafkaTopic metadata: name: topic-name-1 spec: topicName: name-2 # ...
Some Kafka client applications, such as Kafka Streams, can create topics in Kafka programmatically. If those topics have names that are invalid OpenShift resource names, the Topic Operator gives them valid names based on the Kafka names. Invalid characters are replaced and a hash is appended to the name.
5.2. Creating a topic
This procedure describes how to create a Kafka topic using a KafkaTopic
OpenShift resource.
Prerequisites
- A running Kafka cluster.
- A running Topic Operator (typically deployed with the Entity Operator).
Procedure
Prepare a file containing the
KafkaTopic
to be createdAn example
KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaTopic metadata: name: orders labels: strimzi.io/cluster: my-cluster spec: partitions: 10 replicas: 2
NoteIt is recommended that the topic name given is a valid OpenShift resource name, as it is then not necessary to set the
KafkaTopic.spec.topicName
property. TheKafkaTopic.spec.topicName
cannot be changed after creation.NoteThe
KafkaTopic.spec.partitions
cannot be decreased.Create the
KafkaTopic
resource in OpenShift.This can be done using
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema for
KafkaTopics
, seeKafkaTopic
schema reference. - For more information about deploying a Kafka cluster using the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Topic Operator using the Cluster Operator, see Section 2.9.2, “Deploying the Topic Operator using the Cluster Operator”.
- For more information about deploying the standalone Topic Operator, see Section 4.2.6, “Deploying the standalone Topic Operator”.
5.3. Changing a topic
This procedure describes how to change the configuration of an existing Kafka topic by using a KafkaTopic
OpenShift resource.
Prerequisites
- A running Kafka cluster.
- A running Topic Operator (typically deployed with the Entity Operator).
-
An existing
KafkaTopic
to be changed.
Procedure
Prepare a file containing the desired
KafkaTopic
An example
KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaTopic metadata: name: orders labels: strimzi.io/cluster: my-cluster spec: partitions: 16 replicas: 2
TipYou can get the current version of the resource using
oc get kafkatopic orders -o yaml
.NoteChanging topic names using the
KafkaTopic.spec.topicName
variable and decreasing partition size using theKafkaTopic.spec.partitions
variable is not supported by Kafka.CautionIncreasing
spec.partitions
for topics with keys will change how records are partitioned, which can be particularly problematic when the topic uses semantic partitioning.Update the
KafkaTopic
resource in OpenShift.This can be done using
oc apply
:oc apply -f your-file
Additional resources
-
For more information about the schema for
KafkaTopics
, seeKafkaTopic
schema reference. - For more information about deploying a Kafka cluster, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Topic Operator using the Cluster Operator, see Section 2.9.2, “Deploying the Topic Operator using the Cluster Operator”.
- For more information about creating a topic using the Topic Operator, see Section 5.2, “Creating a topic”.
5.4. Deleting a topic
This procedure describes how to delete a Kafka topic using a KafkaTopic
OpenShift resource.
Prerequisites
- A running Kafka cluster.
- A running Topic Operator (typically deployed with the Entity Operator).
-
An existing
KafkaTopic
to be deleted. -
delete.topic.enable=true
(default)
The delete.topic.enable
property must be set to true
in Kafka.spec.kafka.config
. Otherwise, the steps outlined here will delete the KafkaTopic
resource, but the Kafka topic and its data will remain. After reconciliation by the Topic Operator, the custom resource is then recreated.
Procedure
Delete the
KafkaTopic
resource in OpenShift.This can be done using
oc delete
:oc delete kafkatopic your-topic-name
Additional resources
- For more information about deploying a Kafka cluster using the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Topic Operator using the Cluster Operator, see Section 2.9.2, “Deploying the Topic Operator using the Cluster Operator”.
- For more information about creating a topic using the Topic Operator, see Section 5.2, “Creating a topic”.
Chapter 6. Using the User Operator
The User Operator provides a way of managing Kafka users via OpenShift resources.
6.1. Overview of the User Operator component
The User Operator manages Kafka users for a Kafka cluster by watching for KafkaUser
resources that describe Kafka users and ensuring that they are configured properly in the Kafka cluster. For example:
-
if a
KafkaUser
is created, the User Operator will create the user it describes -
if a
KafkaUser
is deleted, the User Operator will delete the user it describes -
if a
KafkaUser
is changed, the User Operator will update the user it describes
Unlike the Topic Operator, the User Operator does not sync any changes from the Kafka cluster with the OpenShift resources. Unlike the Kafka topics which might be created by applications directly in Kafka, it is not expected that the users will be managed directly in the Kafka cluster in parallel with the User Operator, so this should not be needed.
The User Operator allows you to declare a KafkaUser
as part of your application’s deployment. When the user is created, the user credentials will be created in a Secret
. Your application needs to use the user and its credentials for authentication and to produce or consume messages.
In addition to managing credentials for authentication, the User Operator also manages authorization rules by including a description of the user’s rights in the KafkaUser
declaration.
6.2. Mutual TLS authentication
Mutual TLS authentication is always used for the communication between Kafka brokers and Zookeeper pods.
Mutual authentication or two-way authentication is when both the server and the client present certificates. AMQ Streams can configure Kafka to use TLS (Transport Layer Security) to provide encrypted communication between Kafka brokers and clients either with or without mutual authentication. When you configure mutual authentication, the broker authenticates the client and the client authenticates the broker.
TLS authentication is more commonly one-way, with one party authenticating the identity of another. For example, when HTTPS is used between a web browser and a web server, the server obtains proof of the identity of the browser.
6.2.1. When to use mutual TLS authentication for clients
Mutual TLS authentication is recommended for authenticating Kafka clients when:
- The client supports authentication using mutual TLS authentication
- It is necessary to use the TLS certificates rather than passwords
- You can reconfigure and restart client applications periodically so that they do not use expired certificates.
6.3. Creating a Kafka user with mutual TLS authentication
Prerequisites
- A running Kafka cluster configured with a listener using TLS authentication.
- A running User Operator (typically deployed with the Entity Operator).
Procedure
Prepare a YAML file containing the
KafkaUser
to be created.An example
KafkaUser
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster spec: authentication: type: tls authorization: type: simple acls: - resource: type: topic name: my-topic patternType: literal operation: Read - resource: type: topic name: my-topic patternType: literal operation: Describe - resource: type: group name: my-group patternType: literal operation: Read
Create the
KafkaUser
resource in OpenShift.This can be done using
oc apply
:oc apply -f your-file
-
Use the credentials from the secret
my-user
in your application
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about configuring a listener that authenticates using TLS see Section 3.1.6, “Kafka broker listeners”.
- For more information about deploying the Entity Operator, see Section 3.1.11, “Entity Operator”.
-
For more information about the
KafkaUser
object, seeKafkaUser
schema reference.
6.4. SCRAM-SHA authentication
SCRAM (Salted Challenge Response Authentication Mechanism) is an authentication protocol that can establish mutual authentication using passwords. AMQ Streams can configure Kafka to use SASL (Simple Authentication and Security Layer) SCRAM-SHA-512 to provide authentication on both unencrypted and TLS-encrypted client connections. TLS authentication is always used internally between Kafka brokers and Zookeeper nodes. When used with a TLS client connection, the TLS protocol provides encryption, but is not used for authentication.
The following properties of SCRAM make it safe to use SCRAM-SHA even on unencrypted connections:
- The passwords are not sent in the clear over the communication channel. Instead the client and the server are each challenged by the other to offer proof that they know the password of the authenticating user.
- The server and client each generate a new challenge for each authentication exchange. This means that the exchange is resilient against replay attacks.
6.4.1. Supported SCRAM credentials
AMQ Streams supports SCRAM-SHA-512 only. When a KafkaUser.spec.authentication.type
is configured with scram-sha-512
the User Operator will generate a random 12 character password consisting of upper and lowercase ASCII letters and numbers.
6.4.2. When to use SCRAM-SHA authentication for clients
SCRAM-SHA is recommended for authenticating Kafka clients when:
- The client supports authentication using SCRAM-SHA-512
- It is necessary to use passwords rather than the TLS certificates
- Authentication for unencrypted communication is required
6.5. Creating a Kafka user with SCRAM SHA authentication
Prerequisites
- A running Kafka cluster configured with a listener using SCRAM SHA authentication.
- A running User Operator (typically deployed with the Entity Operator).
Procedure
Prepare a YAML file containing the
KafkaUser
to be created.An example
KafkaUser
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster spec: authentication: type: scram-sha-512 authorization: type: simple acls: - resource: type: topic name: my-topic patternType: literal operation: Read - resource: type: topic name: my-topic patternType: literal operation: Describe - resource: type: group name: my-group patternType: literal operation: Read
Create the
KafkaUser
resource in OpenShift.This can be done using
oc apply
:oc apply -f your-file
-
Use the credentials from the secret
my-user
in your application
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about configuring a listener that authenticates using SCRAM SHA see Section 3.1.6, “Kafka broker listeners”.
- For more information about deploying the Entity Operator, see Section 3.1.11, “Entity Operator”.
-
For more information about the
KafkaUser
object, seeKafkaUser
schema reference.
6.6. Editing a Kafka user
This procedure describes how to change the configuration of an existing Kafka user by using a KafkaUser
OpenShift resource.
Prerequisites
- A running Kafka cluster.
- A running User Operator (typically deployed with the Entity Operator).
-
An existing
KafkaUser
to be changed.
Procedure
Prepare a YAML file containing the desired
KafkaUser
.An example
KafkaUser
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster spec: authentication: type: tls authorization: type: simple acls: - resource: type: topic name: my-topic patternType: literal operation: Read - resource: type: topic name: my-topic patternType: literal operation: Describe - resource: type: group name: my-group patternType: literal operation: Read
Update the
KafkaUser
resource in OpenShift.This can be done using
oc apply
:oc apply -f your-file
-
Use the updated credentials from the
my-user
secret in your application.
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
- For more information about deploying the Entity Operator, see Section 3.1.11, “Entity Operator”.
-
For more information about the
KafkaUser
object, seeKafkaUser
schema reference.
6.7. Deleting a Kafka user
This procedure describes how to delete a Kafka user created with KafkaUser
OpenShift resource.
Prerequisites
- A running Kafka cluster.
- A running User Operator (typically deployed with the Entity Operator).
-
An existing
KafkaUser
to be deleted.
Procedure
Delete the
KafkaUser
resource in OpenShift.This can be done using
oc delete
:oc delete kafkauser your-user-name
Additional resources
- For more information about deploying the Cluster Operator, see Section 2.3, “Cluster Operator”.
-
For more information about the
KafkaUser
object, seeKafkaUser
schema reference.
6.8. Kafka User resource
The KafkaUser
resource is used to declare a user with its authentication mechanism, authorization mechanism, and access rights.
6.8.1. Authentication
Authentication is configured using the authentication
property in KafkaUser.spec
. The authentication mechanism enabled for this user will be specified using the type
field. Currently, the only supported authentication mechanisms are the TLS Client Authentication mechanism and the SCRAM-SHA-512 mechanism.
When no authentication mechanism is specified, User Operator will not create the user or its credentials.
6.8.1.1. TLS Client Authentication
To use TLS client authentication, set the type
field to tls
.
An example of KafkaUser
with enabled TLS Client Authentication
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster spec: authentication: type: tls # ...
When the user is created by the User Operator, it will create a new secret with the same name as the KafkaUser
resource. The secret will contain a public and private key which should be used for the TLS Client Authentication. Bundled with them will be the public key of the client certification authority which was used to sign the user certificate. All keys will be in X509 format.
An example of the Secret
with user credentials
apiVersion: v1 kind: Secret metadata: name: my-user labels: strimzi.io/kind: KafkaUser strimzi.io/cluster: my-cluster type: Opaque data: ca.crt: # Public key of the Clients CA user.crt: # Public key of the user user.key: # Private key of the user
6.8.1.2. SCRAM-SHA-512 Authentication
To use SCRAM-SHA-512 authentication mechanism, set the type
field to scram-sha-512
.
An example of KafkaUser
with enabled SCRAM-SHA-512 authentication
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster spec: authentication: type: scram-sha-512 # ...
When the user is created by the User Operator, the User Operator will create a new secret with the same name as the KafkaUser
resource. The secret contains the generated password in the password
key, which is encoded with base64. In order to use the password it must be decoded.
An example of the Secret
with user credentials
apiVersion: v1 kind: Secret metadata: name: my-user labels: strimzi.io/kind: KafkaUser strimzi.io/cluster: my-cluster type: Opaque data: password: Z2VuZXJhdGVkcGFzc3dvcmQ= # Generated password
For decode the generated password:
echo "Z2VuZXJhdGVkcGFzc3dvcmQ=" | base64 --decode
6.8.2. Authorization
Authorization is configured using the authorization
property in KafkaUser.spec
. The authorization type enabled for a user is specified using the type
field. Currently, the only supported authorization type is simple authorization.
If no authorization is specified, the User Operator does not provision any access rights for the user.
6.8.2.1. Simple authorization
Simple authorization uses the default Kafka authorization plugin, SimpleAclAuthorizer
.
To use simple authorization, set the type
property to simple
in KafkaUser.spec
.
ACL rules
SimpleAclAuthorizer
uses ACL rules to manage access to Kafka brokers.
ACL rules grant access rights to the user, which you specify in the acls
property.
An AclRule
is specified as a set of properties:
resource
The
resource
property specifies the resource that the rule applies to.Simple authorization supports four resource types, which are specified in the
type
property:-
Topics (
topic
) -
Consumer Groups (
group
) -
Clusters (
cluster
) -
Transactional IDs (
transactionalId
)
For Topic, Group, and Transactional ID resources you can specify the name of the resource the rule applies to in the
name
property.Cluster type resources have no name.
A name is specified as a
literal
or aprefix
using thepatternType
property.-
Literal names are taken exactly as they are specified in the
name
field. -
Prefix names use the value from the
name
as a prefix, and will apply the rule to all resources with names starting with the value.
-
Topics (
type
The
type
property specifies the type of ACL rule,allow
ordeny
.The
type
field is optional. Iftype
is unspecified, the ACL rule is treated as anallow
rule.operation
The
operation
specifies the operation to allow or deny.The following operations are supported:
- Read
- Write
- Delete
- Alter
- Describe
- All
- IdempotentWrite
- ClusterAction
- Create
- AlterConfigs
- DescribeConfigs
Only certain operations work with each resource.
For more details about
SimpleAclAuthorizer
, ACLs and supported combinations of resources and operations, see Authorization and ACLs.host
The
host
property specifies a remote host from which the rule is allowed or denied.Use an asterisk (
*
) to allow or deny the operation from all hosts. Thehost
field is optional. Ifhost
is unspecified, the*
value is used by default.
For more information about the AclRule
object, see AclRule
schema reference.
An example KafkaUser
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster spec: # ... authorization: type: simple acls: - resource: type: topic name: my-topic patternType: literal operation: Read - resource: type: topic name: my-topic patternType: literal operation: Describe - resource: type: group name: my-group patternType: prefix operation: Read
6.8.2.2. Super user access to Kafka brokers
If a user is added to a list of super users in a Kafka broker configuration, the user is allowed unlimited access to the cluster regardless of any authorization constraints defined in ACLs.
For more information on configuring super users, see authentication and authorization of Kafka brokers.
6.8.3. Additional resources
-
For more information about the
KafkaUser
object, seeKafkaUser
schema reference. - For more information about the TLS Client Authentication, see Section 6.2, “Mutual TLS authentication”.
- For more information about the SASL SCRAM-SHA-512 authentication, see Section 6.4, “SCRAM-SHA authentication”.
Chapter 7. Kafka Bridge
This chapter provides an overview of the AMQ Streams Kafka Bridge and helps you get started using its REST API to interact with AMQ Streams. To try out the Kafka Bridge in your local environment, see the Section 7.2, “Kafka Bridge quickstart” later in this chapter.
Additional resources
- For information on how to deploy the Kafka Bridge, see Section 2.7, “Kafka Bridge” in the Getting started with AMQ Streams chapter.
- For detailed information on configuring the Kafka Bridge, see Section 3.5, “Kafka Bridge configuration” in the Deployment configuration chapter
- To view the API documentation, including example requests and responses, see the Kafka Bridge API reference on the Strimzi website.
7.1. Kafka Bridge overview
The AMQ Streams Kafka Bridge provides an API for integrating HTTP-based clients with a Kafka cluster running on OpenShift. The API enables such clients to produce and consume messages without the requirement to use the native Kafka protocol.
The API has two main resources — consumers
and topics
— that are exposed and made accessible through endpoints to interact with consumers and producers in your Kafka cluster. The resources relate only to the Kafka Bridge, not the consumers and producers connected directly to Kafka.
You can:
- Send messages to a topic.
- Create and delete consumers.
- Subscribe consumers to topics, so that they start receiving messages from those topics.
- Unsubscribe consumers from topics.
- Assign partitions to consumers.
- Retrieve messages from topics.
- Commit a list of consumer offsets.
- Seek on a partition, so that a consumer starts receiving messages from the first or last offset position, or a given offset position.
You deploy the Kafka Bridge into your OpenShift cluster by using the Cluster Operator. For deployment instructions, see Section 2.7.1, “Deploying Kafka Bridge to your OpenShift cluster”.
After the Kafka Bridge is deployed, the Cluster Operator creates a Deployment, Service, and Pod in your OpenShift cluster, each named strimzi-kafka-bridge
by default.
7.1.1. Supported clients for the Kafka Bridge
You can use the Kafka Bridge to integrate both internal and external HTTP client applications with your Kafka cluster.
- Internal clients are container-based HTTP clients running in the same OpenShift cluster as the Kafka Bridge itself.
- External clients are HTTP clients running outside the OpenShift cluster in which the Kafka Bridge is deployed and running.
HTTP internal and external client integration
Internal clients can access the Kafka Bridge on the host and port defined in the KafkaBridge
custom resource.
External clients can access the Kafka Bridge through an OpenShift Route, a loadbalancer service, or using an Ingress.
Additional resources
-
For more information on configuring the host and port for the
KafkaBridge
resource, see Section 3.5.5.3, “Kafka Bridge HTTP configuration”. - For more information on integrating external clients, see Section 7.1.3, “Accessing the Kafka Bridge outside of OpenShift”.
7.1.2. Securing the Kafka Bridge
AMQ Streams does not currently provide any encryption, authentication, or authorization for the Kafka Bridge. This means that requests sent from external clients to the Kafka Bridge are:
- Not encrypted, and must use HTTP rather than HTTPS
- Sent without authentication
However, you can secure the Kafka Bridge using other methods, such as:
- OpenShift Network Policies that define which pods can access the Kafka Bridge.
- Reverse proxies with authentication or authorization, for example, OAuth2 proxies.
- API Gateways.
- Ingress or OpenShift Routes with TLS termination.
The Kafka Bridge supports TLS encryption and TLS and SASL authentication when connecting to the Kafka Brokers. Within your OpenShift cluster, you can configure:
- TLS or SASL-based authentication between the Kafka Bridge and your Kafka cluster
- A TLS-encrypted connection between the Kafka Bridge and your Kafka cluster.
For more information, see Section 3.5.4.1, “Authentication support in Kafka Bridge”.
You can use ACLs in Kafka brokers to restrict the topics that can be consumed and produced using the Kafka Bridge.
7.1.3. Accessing the Kafka Bridge outside of OpenShift
After deployment, the AMQ Streams Kafka Bridge can only be accessed by applications running in the same OpenShift cluster. These applications use the kafka-bridge-name-bridge-service
Service to access the API.
If you want to make the Kafka Bridge accessible to applications running outside of the OpenShift cluster, you can expose it manually by using one of the following features:
- Services of types LoadBalancer or NodePort
- Ingress resources
- OpenShift Routes
If you decide to create Services, use the following labels in the selector
to configure the pods to which the service will route the traffic:
# ...
selector:
strimzi.io/cluster: kafka-bridge-name 1
strimzi.io/kind: KafkaBridge
#...
- 1
- Name of the Kafka Bridge custom resource in your OpenShift cluster.
7.1.4. Requests to the Kafka Bridge
Specify data formats and HTTP headers to ensure valid requests are submitted to the Kafka Bridge.
7.1.4.1. Content Type headers
API request and response bodies are always encoded as JSON.
When performing consumer operations,
POST
requests must provide the followingContent-Type
header if there is a non-empty body:Content-Type: application/vnd.kafka.v2+json
When performing producer operations,
POST
requests must provideContent-Type
headers specifying the desired embedded data format, eitherjson
orbinary
, as shown in the following table.Embedded data format Content-Type header JSON
Content-Type: application/vnd.kafka.json.v2+json
Binary
Content-Type: application/vnd.kafka.binary.v2+json
You set the embedded data format when creating a consumer using the consumers/groupid
endpoint—for more information, see the next section.
The Content-Type
must not be set if the POST
request has an empty body. An empty body can be used to create a consumer with the default values.
7.1.4.2. Embedded data format
The embedded data format is the format of the Kafka messages that are transmitted, over HTTP, from a producer to a consumer using the Kafka Bridge. Two embedded data formats are supported: JSON and binary.
When creating a consumer using the /consumers/groupid
endpoint, the POST
request body must specify an embedded data format of either JSON or binary. This is specified in the format
field, for example:
{
"name": "my-consumer",
"format": "binary", 1
...
}
- 1
- A binary embedded data format.
The embedded data format specified when creating a consumer must match the data format of the Kafka messages it will consume.
If you choose to specify a binary embedded data format, subsequent producer requests must provide the binary data in the request body as Base64-encoded strings. For example, when sending messages using the /topics/topicname
endpoint, records.value
must be encoded in Base64:
{ "records": [ { "key": "my-key", "value": "ZWR3YXJkdGhldGhyZWVsZWdnZWRjYXQ=" }, ] }
Producer requests must also provide a Content-Type
header that corresponds to the embedded data format, for example, Content-Type: application/vnd.kafka.binary.v2+json
.
7.1.4.3. Accept headers
After creating a consumer, all subsequent GET requests must provide an Accept
header in the following format:
Accept: application/vnd.kafka.embedded-data-format.v2+json
The embedded-data-format
is either json
or binary
.
For example, when retrieving records for a subscribed consumer using an embedded data format of JSON, include this Accept header:
Accept: application/vnd.kafka.json.v2+json
7.1.5. Configuring loggers for the Kafka Bridge
The AMQ Streams Kafka bridge allows you to set a different log level for each operation that is defined by the related OpenAPI specification.
Each operation has a corresponding API endpoint through which the bridge receives requests from HTTP clients. You can change the log level on each endpoint to produce more or less fine-grained logging information about the incoming and outgoing HTTP requests.
Loggers are defined in the log4j.properties
file, which has the following default configuration for healthy
and ready
endpoints:
log4j.logger.http.openapi.operation.healthy=WARN, out log4j.additivity.http.openapi.operation.healthy=false log4j.logger.http.openapi.operation.ready=WARN, out log4j.additivity.http.openapi.operation.ready=false
The log level of all other operations is set to INFO
by default. Loggers are formatted as follows:
log4j.logger.http.openapi.operation.<operation-id>
Where <operation-id>
is the identifier of the specific operation. Following is the list of operations defined by the OpenAPI specification:
-
createConsumer
-
deleteConsumer
-
subscribe
-
unsubscribe
-
poll
-
assign
-
commit
-
send
-
sendToPartition
-
seekToBeginning
-
seekToEnd
-
seek
-
healthy
-
ready
-
openapi
7.1.6. Kafka Bridge API resources
For the full list of REST API endpoints and descriptions, including example requests and responses, see the Kafka Bridge API reference on the Strimzi website.
7.2. Kafka Bridge quickstart
Use this quickstart to try out the AMQ Streams Kafka Bridge in your local development environment. You will learn how to:
- Deploy the Kafka Bridge to your OpenShift cluster
- Expose the Kafka Bridge service to your local machine by using port-forwarding
- Produce messages to topics and partitions in your Kafka cluster
- Create a Kafka Bridge consumer
- Perform basic consumer operations, such as subscribing the consumer to topics and retrieving the messages that you produced
In this quickstart, HTTP requests are formatted as curl commands that you can copy and paste to your terminal. Access to an OpenShift cluster is required; to run and manage a local OpenShift cluster, use a tool such as Minikube, CodeReady Containers, or MiniShift.
Ensure you have the prerequisites and then follow the tasks in the order provided in this chapter.
About data formats
In this quickstart, you will produce and consume messages in JSON format, not binary. For more information on the data formats and HTTP headers used in the example requests, see Section 7.1.4, “Requests to the Kafka Bridge”.
Prerequisites for the quickstart
- Cluster administrator access to a local or remote OpenShift cluster.
- AMQ Streams is installed.
- A running Kafka cluster, deployed by the Cluster Operator, in an OpenShift namespace.
- The Entity Operator is deployed and running as part of the Kafka cluster.
7.2.1. Deploying the Kafka Bridge to your OpenShift cluster
AMQ Streams includes a YAML example that specifies the configuration of the AMQ Streams Kafka Bridge. Make some minimal changes to this file and then deploy an instance of the Kafka Bridge to your OpenShift cluster.
Procedure
Edit the
examples/kafka-bridge/kafka-bridge.yaml
file.apiVersion: kafka.strimzi.io/v1alpha1 kind: KafkaBridge metadata: name: quickstart 1 spec: replicas: 1 bootstrapServers: <cluster-name>-kafka-bootstrap:9092 2 http: port: 8080
- 1
- When the Kafka Bridge is deployed,
-bridge
is appended to the name of the deployment and other related resources. In this example, the Kafka Bridge deployment is namedquickstart-bridge
and the accompanying Kafka Bridge service is namedquickstart-bridge-service
. - 2
- In the
bootstrapServers
property, enter the name of the Kafka cluster as the<cluster-name>
.
Deploy the Kafka Bridge to your OpenShift cluster:
oc apply -f examples/kafka-bridge/kafka-bridge.yaml
A
quickstart-bridge
deployment, service, and other related resources are created in your OpenShift cluster.Verify that the Kafka Bridge was successfully deployed:
oc get deployments
NAME READY UP-TO-DATE AVAILABLE AGE quickstart-bridge 1/1 1 1 34m my-cluster-connect 1/1 1 1 24h my-cluster-entity-operator 1/1 1 1 24h #...
What to do next
After deploying the Kafka Bridge to your OpenShift cluster, expose the Kafka Bridge service to your local machine.
Additional resources
- For more detailed information about configuring the Kafka Bridge, see Section 3.5, “Kafka Bridge configuration”.
7.2.2. Exposing the Kafka Bridge service to your local machine
Next, use port forwarding to expose the AMQ Streams Kafka Bridge service to your local machine on http://localhost:8080.
Port forwarding is only suitable for development and testing purposes.
Procedure
List the names of the pods in your OpenShift cluster:
oc get pods -o name pod/kafka-consumer # ... pod/quickstart-bridge-589d78784d-9jcnr pod/strimzi-cluster-operator-76bcf9bc76-8dnfm
Connect to the
quickstart-bridge
pod on port8080
:oc port-forward pod/quickstart-bridge-589d78784d-9jcnr 8080:8080 &
NoteIf port 8080 on your local machine is already in use, use an alternative HTTP port, such as
8008
.
API requests are now forwarded from port 8080 on your local machine to port 8080 in the Kafka Bridge pod.
7.2.3. Producing messages to topics and partitions
Next, produce messages to topics in JSON format by using the topics endpoint. You can specify destination partitions for messages in the request body, as shown here. The partitions endpoint provides an alternative method for specifying a single destination partition for all messages as a path parameter.
Procedure
In a text editor, create a YAML definition for a Kafka topic with three partitions.
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaTopic metadata: name: bridge-quickstart-topic labels: strimzi.io/cluster: <kafka-cluster-name> 1 spec: partitions: 3 2 replicas: 1 config: retention.ms: 7200000 segment.bytes: 1073741824
-
Save the file to the
examples/topic
directory asbridge-quickstart-topic.yaml
. Create the topic in your OpenShift cluster:
oc apply -f examples/topic/bridge-quickstart-topic.yaml
Using the Kafka Bridge, produce three messages to the topic you created:
curl -X POST \ http://localhost:8080/topics/bridge-quickstart-topic \ -H 'content-type: application/vnd.kafka.json.v2+json' \ -d '{ "records": [ { "key": "my-key", "value": "sales-lead-0001" }, { "value": "sales-lead-0002", "partition": 2 }, { "value": "sales-lead-0003" } ] }'
-
sales-lead-0001
is sent to a partition based on the hash of the key. -
sales-lead-0002
is sent directly to partition 2. -
sales-lead-0003
is sent to a partition in thebridge-quickstart-topic
topic using a round-robin method.
-
If the request is successful, the Kafka Bridge returns an
offsets
array, along with a200
code and acontent-type
header ofapplication/vnd.kafka.v2+json
. For each message, theoffsets
array describes:- The partition that the message was sent to
The current message offset of the partition
Example response
#... { "offsets":[ { "partition":0, "offset":0 }, { "partition":2, "offset":0 }, { "partition":0, "offset":1 } ] }
What to do next
After producing messages to topics and partitions, create a Kafka Bridge consumer.
Additional resources
- POST /topics/{topicname} in the API reference documentation.
- POST /topics/{topicname}/partitions/{partitionid} in the API reference documentation.
7.2.4. Creating a Kafka Bridge consumer
Before you can perform any consumer operations in the Kafka cluster, you must first create a consumer by using the consumers endpoint. The consumer is referred to as a Kafka Bridge consumer.
Procedure
Create a Kafka Bridge consumer in a new consumer group named
bridge-quickstart-consumer-group
:curl -X POST http://localhost:8080/consumers/bridge-quickstart-consumer-group \ -H 'content-type: application/vnd.kafka.v2+json' \ -d '{ "name": "bridge-quickstart-consumer", "auto.offset.reset": "earliest", "format": "json", "enable.auto.commit": false, "fetch.min.bytes": 512, "consumer.request.timeout.ms": 30000 }'
-
The consumer is named
bridge-quickstart-consumer
and the embedded data format is set asjson
. - Some basic configuration settings are defined.
The consumer will not commit offsets to the log automatically because the
enable.auto.commit
setting isfalse
. You will commit the offsets manually later in this quickstart.If the request is successful, the Kafka Bridge returns the consumer ID (
instance_id
) and base URL (base_uri
) in the response body, along with a200
code.Example response
#... { "instance_id": "bridge-quickstart-consumer", "base_uri":"http://<bridge-name>-bridge-service:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer" }
-
The consumer is named
-
Copy the base URL (
base_uri
) to use in the other consumer operations in this quickstart.
What to do next
Now that you have created a Kafka Bridge consumer, you can subscribe it to topics.
Additional resources
- POST /consumers/{groupid} in the API reference documentation.
7.2.5. Subscribing a Kafka Bridge consumer to topics
After you have created a Kafka Bridge consumer, subscribe it to one or more topics by using the subscription endpoint. Once subscribed, the consumer starts receiving all messages that are produced to the topic.
Procedure
Subscribe the consumer to the
bridge-quickstart-topic
topic that you created earlier, in Producing messages to topics and partitions:curl -X POST http://localhost:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer/subscription \ -H 'content-type: application/vnd.kafka.v2+json' \ -d '{ "topics": [ "bridge-quickstart-topic" ] }'
The
topics
array can contain a single topic (as shown here) or multiple topics. If you want to subscribe the consumer to multiple topics that match a regular expression, you can use thetopic_pattern
string instead of thetopics
array.If the request is successful, the Kafka Bridge returns a
204
(No Content) code only.
What to do next
After subscribing a Kafka Bridge consumer to topics, you can retrieve messages from the consumer.
Additional resources
- POST /consumers/{groupid}/instances/{name}/subscription in the API reference documentation.
7.2.6. Retrieving the latest messages from a Kafka Bridge consumer
Next, retrieve the latest messages from the Kafka Bridge consumer by requesting data from the records endpoint. In production, HTTP clients can call this endpoint repeatedly (in a loop).
Procedure
- Produce additional messages to the Kafka Bridge consumer, as described in Producing messages to topics and partitions.
Submit a
GET
request to therecords
endpoint:curl -X GET http://localhost:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer/records \ -H 'accept: application/vnd.kafka.json.v2+json'
After creating and subscribing to a Kafka Bridge consumer, a first GET request will return an empty response because the poll operation starts a rebalancing process to assign partitions.
Repeat step two to retrieve messages from the Kafka Bridge consumer.
The Kafka Bridge returns an array of messages — describing the topic name, key, value, partition, and offset — in the response body, along with a
200
code. Messages are retrieved from the latest offset by default.HTTP/1.1 200 OK content-type: application/vnd.kafka.json.v2+json #... [ { "topic":"bridge-quickstart-topic", "key":"my-key", "value":"sales-lead-0001", "partition":0, "offset":0 }, { "topic":"bridge-quickstart-topic", "key":null, "value":"sales-lead-0003", "partition":0, "offset":1 }, #...
NoteIf an empty response is returned, produce more records to the consumer as described in Producing messages to topics and partitions, and then try retrieving messages again.
What to do next
After retrieving messages from a Kafka Bridge consumer, try committing offsets to the log.
Additional resources
- GET /consumers/{groupid}/instances/{name}/records in the API reference documentation.
7.2.7. Commiting offsets to the log
Next, use the offsets endpoint to manually commit offsets to the log for all messages received by the Kafka Bridge consumer. This is required because the Kafka Bridge consumer that you created earlier, in Creating a Kafka Bridge consumer, was configured with the enable.auto.commit
setting as false
.
Procedure
Commit offsets to the log for the
bridge-quickstart-consumer
:curl -X POST http://localhost:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer/offsets
Because no request body is submitted, offsets are committed for all the records that have been received by the consumer. Alternatively, the request body can contain an array (OffsetCommitSeekList) that specifies the topics and partitions that you want to commit offsets for.
If the request is successful, the Kafka Bridge returns a
204
code only.
What to do next
After committing offsets to the log, try out the endpoints for seeking to offsets.
Additional resources
- POST /consumers/{groupid}/instances/{name}/offsets in the API reference documentation.
7.2.8. Seeking to offsets for a partition
Next, use the positions endpoints to configure the Kafka Bridge consumer to retrieve messages for a partition from a specific offset, and then from the latest offset. This is referred to in Apache Kafka as a seek operation.
Procedure
Seek to a specific offset for partition 0 of the
quickstart-bridge-topic
topic:curl -X POST http://localhost:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer/positions \ -H 'content-type: application/vnd.kafka.v2+json' \ -d '{ "offsets": [ { "topic": "bridge-quickstart-topic", "partition": 0, "offset": 2 } ] }'
If the request is successful, the Kafka Bridge returns a
204
code only.Submit a
GET
request to therecords
endpoint:curl -X GET http://localhost:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer/records \ -H 'accept: application/vnd.kafka.json.v2+json'
The Kafka Bridge returns messages from the offset that you seeked to.
Restore the default message retrieval behavior by seeking to the last offset for the same partition. This time, use the positions/end endpoint.
curl -X POST http://localhost:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer/positions/end \ -H 'content-type: application/vnd.kafka.v2+json' \ -d '{ "partitions": [ { "topic": "bridge-quickstart-topic", "partition": 0 } ] }'
If the request is successful, the Kafka Bridge returns another
204
code.
You can also use the positions/beginning endpoint to seek to the first offset for one or more partitions.
What to do next
In this quickstart, you have used the AMQ Streams Kafka Bridge to perform several common operations on a Kafka cluster. You can now delete the Kafka Bridge consumer that you created earlier.
Additional resources
- POST /consumers/{groupid}/instances/{name}/positions in the API reference documentation.
- POST /consumers/{groupid}/instances/{name}/positions/beginning in the API reference documentation.
- POST /consumers/{groupid}/instances/{name}/positions/end in the API reference documentation.
7.2.9. Deleting a Kafka Bridge consumer
Finally, delete the Kafa Bridge consumer that you used throughout this quickstart.
Procedure
Delete the Kafka Bridge consumer by sending a
DELETE
request to the instances endpoint.curl -X DELETE http://localhost:8080/consumers/bridge-quickstart-consumer-group/instances/bridge-quickstart-consumer
If the request is successful, the Kafka Bridge returns a
204
code only.
Additional resources
- DELETE /consumers/{groupid}/instances/{name} in the API reference documentation.
Chapter 8. Using the Kafka Bridge with 3scale
You can deploy and integrate Red Hat 3scale API Management with the AMQ Streams Kafka Bridge.
8.1. Using the Kafka Bridge with 3scale
With a plain deployment of the Kafka Bridge, there is no provision for authentication or authorization, and no support for a TLS encrypted connection to external clients.
3scale can secure the Kafka Bridge with TLS, and provide authentication and authorization. Integration with 3scale also means that additional features like metrics, rate limiting and billing are available.
With 3scale, you can use different types of authentication for requests from external clients wishing to access AMQ Streams. 3scale supports the following types of authentication:
- Standard API Keys
- Single randomized strings or hashes acting as an identifier and a secret token.
- Application Identifier and Key pairs
- Immutable identifier and mutable secret key strings.
- OpenID Connect
- Protocol for delegated authentication.
Using an existing 3scale deployment?
If you already have 3scale deployed to OpenShift and you wish to use it with the Kafka Bridge, ensure that you have the correct setup.
Setup is described in Section 8.2, “Deploying 3scale for the Kafka Bridge”.
8.1.1. Kafka Bridge service discovery
3scale is integrated using service discovery, which requires that 3scale is deployed to the same OpenShift cluster as AMQ Streams and the Kafka Bridge.
Your AMQ Streams Cluster Operator deployment must have the following environment variables set:
- STRIMZI_CUSTOM_KAFKA_BRIDGE_SERVICE_LABELS
- STRIMZI_CUSTOM_KAFKA_BRIDGE_SERVICE_ANNOTATIONS
When the Kafka Bridge is deployed, the service that exposes the REST interface of the Kafka Bridge uses the annotations and labels for discovery by 3scale.
-
A
discovery.3scale.net=true
label is used by 3scale to find a service. - Annotations provide information about the service.
You can check your configuration in the OpenShift console by navigating to Services for the Kafka Bridge instance. Under Annotations you will see the endpoint to the OpenAPI specification for the Kafka Bridge.
8.1.2. 3scale APIcast gateway policies
3scale is used in conjunction with 3scale APIcast, an API gateway deployed with 3scale that provides a single point of entry for the Kafka Bridge.
APIcast policies provide a mechanism to customize how the gateway operates. 3scale provides a set of standard policies for gateway configuration. You can also create your own policies.
For more information on APIcast policies, see Administering the API Gateway in the 3scale documentation.
APIcast policies for the Kafka Bridge
A sample policy configuration for 3scale integration with the Kafka Bridge is provided with the policies_config.json
file, which defines:
- Anonymous access
- Header modification
- Routing
- URL rewriting
Gateway policies are enabled or disabled through this file.
You can use this sample as a starting point for defining your own policies.
- Anonymous access
- The anonymous access policy exposes a service without authentication, providing default credentials (for anonymous access) when a HTTP client does not provide them. The policy is not mandatory and can be disabled or removed if authentication is always needed.
- Header modification
The header modification policy allows existing HTTP headers to be modified, or new headers added to requests or responses passing through the gateway. For 3scale integration, the policy adds headers to every request passing through the gateway from a HTTP client to the Kafka Bridge.
When the Kafka Bridge receives a request for creating a new consumer, it returns a JSON payload containing a
base_uri
field with the URI that the consumer must use for all the subsequent requests. For example:{ "instance_id": "consumer-1", "base_uri":"http://my-bridge:8080/consumers/my-group/instances/consumer1" }
When using APIcast, clients send all subsequent requests to the gateway and not to the Kafka Bridge directly. So the URI requires the gateway hostname, not the address of the Kafka Bridge behind the gateway.
Using header modification policies, headers are added to requests from the HTTP client so that the Kafka Bridge uses the gateway hostname.
For example, by applying a
Forwarded: host=my-gateway:80;proto=http
header, the Kafka Bridge delivers the following to the consumer.{ "instance_id": "consumer-1", "base_uri":"http://my-gateway:80/consumers/my-group/instances/consumer1" }
An
X-Forwarded-Path
header carries the original path contained in a request from the client to the gateway. This header is strictly related to the routing policy applied when a gateway supports more than one Kafka Bridge instance.- Routing
A routing policy is applied when there is more than one Kafka Bridge instance. Requests must be sent to the same Kafka Bridge instance where the consumer was initially created, so a request must specify a route for the gateway to forward a request to the appropriate Kafka Bridge instance.
A routing policy names each bridge instance, and routing is performed using the name. You specify the name in the
KafkaBridge
custom resource when you deploy the Kafka Bridge.For example, each request (using
X-Forwarded-Path
) from a consumer to:http://my-gateway:80/my-bridge-1/consumers/my-group/instances/consumer1
is forwarded to:
http://my-bridge-1-bridge-service:8080/consumers/my-group/instances/consumer1
URL rewriting policy removes the bridge name, as it is not used when forwarding the request from the gateway to the Kafka Bridge.
- URL rewriting
The URL rewiring policy ensures that a request to a specific Kafka Bridge instance from a client does not contain the bridge name when forwarding the request from the gateway to the Kafka Bridge.
The bridge name is not used in the endpoints exposed by the bridge.
8.1.3. TLS validation
You can set up APIcast for TLS validation, which requires a self-managed deployment of APIcast using a template. The apicast
service is exposed as a route.
You can also apply a TLS policy to the Kafka Bridge API.
For more information on TLS configuration, see Administering the API Gateway in the 3scale documentation.
8.1.4. 3scale documentation
The procedure to deploy 3scale for use with the Kafka Bridge assumes some understanding of 3scale.
For more information, refer to the 3scale product documentation:
8.2. Deploying 3scale for the Kafka Bridge
In order to use 3scale with the Kafka Bridge, you first deploy it and then configure it to discover the Kafka Bridge API.
You will also use 3scale APIcast and 3scale toolbox.
- APIcast is provided by 3scale as an NGINX-based API gateway for HTTP clients to connect to the Kafka Bridge API service.
- 3scale toolbox is a configuration tool that is used to import the OpenAPI specification for the Kafka Bridge service to 3scale.
In this scenario, you run AMQ Streams, Kafka, the Kafka Bridge and 3scale/APIcast in the same OpenShift cluster.
If you already have 3scale deployed in the same cluster as the Kafka Bridge, you can skip the deployment steps and use your current deployment.
Prerequisites
For the 3scale deployment:
- Check the Red Hat 3scale API Management supported configurations.
-
Installation requires a user with
cluster-admin
role, such assystem:admin
. You need access to the JSON files describing the:
-
Kafka Bridge OpenAPI specification (
openapiv2.json
) Header modification and routing policies for the Kafka Bridge (
policies_config.json
)Find the JSON files on GitHub.
-
Kafka Bridge OpenAPI specification (
Procedure
Deploy 3scale API Management to the OpenShift cluster.
Create a new project or use an existing project.
oc new-project my-project \ --description="description" --display-name="display_name"
Deploy 3scale.
Use the information provided in the Installing 3scale guide to deploy 3scale on OpenShift using a template or operator.
Whichever approach you use, make sure that you set the WILDCARD_DOMAIN parameter to the domain of your OpenShift cluster.
Make a note of the URLS and credentials presented for accessing the 3scale Admin Portal.
Grant authorization for 3scale to discover the Kafka Bridge service:
oc adm policy add-cluster-role-to-user view system:serviceaccount:my-project:amp
Verify that 3scale was successfully deployed to the Openshift cluster from the OpenShift console or CLI.
For example:
oc get deployment 3scale-operator
Set up 3scale toolbox.
- Use the information provided in the Operating 3scale guide to install 3scale toolbox.
Set environment variables to be able to interact with 3scale:
export REMOTE_NAME=strimzi-kafka-bridge 1 export SYSTEM_NAME=strimzi_http_bridge_for_apache_kafka 2 export TENANT=strimzi-kafka-bridge-admin 3 export PORTAL_ENDPOINT=$TENANT.3scale.net 4 export TOKEN=3scale access token 5
- 1
REMOTE_NAME
is the name assigned to the remote address of the 3scale Admin Portal.- 2
SYSTEM_NAME
is the name of the 3scale service/API created by importing the OpenAPI specification through the 3scale toolbox.- 3
TENANT
is the tenant name of the 3scale Admin Portal (that is,https://$TENANT.3scale.net
).- 4
PORTAL_ENDPOINT
is the endpoint running the 3scale Admin Portal.- 5
TOKEN
is the access token provided by the 3scale Admin Portal for interaction through the 3scale toolbox or HTTP requests.
Configure the remote web address of the 3scale toolbox:
3scale remote add $REMOTE_NAME https://$TOKEN@$PORTAL_ENDPOINT/
Now the endpoint address of the 3scale Admin portal does not need to be specified every time you run the toolbox.
Check that your Cluster Operator deployment has the labels and annotations properties required for the Kafka Bridge service to be discovered by 3scale.
#... env: - name: STRIMZI_CUSTOM_KAFKA_BRIDGE_SERVICE_LABELS value: | discovery.3scale.net=true - name: STRIMZI_CUSTOM_KAFKA_BRIDGE_SERVICE_ANNOTATIONS value: | discovery.3scale.net/scheme=http discovery.3scale.net/port=8080 discovery.3scale.net/path=/ discovery.3scale.net/description-path=/openapi #...
If not, add the properties through the OpenShift console or try redeploying the Cluster Operator and the Kafka Bridge.
Discover the Kafka Bridge API service through 3scale.
- Log in to the 3scale Admin portal using the credentials provided when 3scale was deployed.
- From the 3scale Admin Portal, navigate to New API → Import from OpenShift where you will see the Kafka Bridge service.
Click Create Service.
You may need to refresh the page to see the Kafka Bridge service.
Now you need to import the configuration for the service. You do this from an editor, but keep the portal open to check the imports are successful.
Edit the Host field in the OpenAPI specification (JSON file) to use the base URL of the Kafka Bridge service:
For example:
"host": "my-bridge-bridge-service.my-project.svc.cluster.local:8080"
Check the
host
URL includes the correct:- Kafka Bridge name (my-bridge)
- Project name (my-project)
- Port for the Kafka Bridge (8080)
Import the updated OpenAPI specification using the 3scale toolbox:
3scale import openapi -k -d $REMOTE_NAME openapiv2.json -t myproject-my-bridge-bridge-service
Import the header modification and routing policies for the service (JSON file).
Locate the ID for the service you created in 3scale.
Here we use the `jq` utility:
export SERVICE_ID=$(curl -k -s -X GET "https://$PORTAL_ENDPOINT/admin/api/services.json?access_token=$TOKEN" | jq ".services[] | select(.service.system_name | contains(\"$SYSTEM_NAME\")) | .service.id")
You need the ID when importing the policies.
Import the policies:
curl -k -X PUT "https://$PORTAL_ENDPOINT/admin/api/services/$SERVICE_ID/proxy/policies.json" --data "access_token=$TOKEN" --data-urlencode policies_config@policies_config.json
- From the 3scale Admin Portal, navigate to Integration → Configuration to check that the endpoints and policies for the Kafka Bridge service have loaded.
- Navigate to Applications → Create Application Plan to create an application plan.
Navigate to Audience → Developer → Applications → Create Application to create an application.
The application is required in order to obtain a user key for authentication.
(Production environment step) To make the API available to the production gateway, promote the configuration:
3scale proxy-config promote $REMOTE_NAME $SERVICE_ID
Use an API testing tool to verify you can access the Kafka Bridge through the APIcast gateway using a call to create a consumer, and the user key created for the application.
For example:
https//my-project-my-bridge-bridge-service-3scale-apicast-staging.example.com:443/consumers/my-group?user_key=3dfc188650101010ecd7fdc56098ce95
If a payload is returned from the Kafka Bridge, the consumer was created successfully.
{ "instance_id": "consumer1", "base uri": "https//my-project-my-bridge-bridge-service-3scale-apicast-staging.example.com:443/consumers/my-group/instances/consumer1" }
The base URI is the address that the client will use in subsequent requests.
Chapter 9. Introducing Metrics
This section describes how to monitor AMQ Streams Kafka, Zookeeper and Kafka Connect clusters using Prometheus to provide monitoring data for example Grafana dashboards.
In order to run the example Grafana dashboards, you must:
The resources referenced in this section are intended as a starting point for setting up monitoring, but they are provided as examples only. If you require further support on configuring and running Prometheus or Grafana in production, try reaching out to their respective communities.
Additional resources
- For more information about Prometheus, see the Prometheus documentation.
- For more information about Grafana, see the Grafana documentation.
- Apache Kafka Monitoring describes JMX metrics exposed by Apache Kafka.
- Zookeeper JMX describes JMX metrics exposed by Apache Zookeeper.
9.1. Example Metrics files
You can find the example metrics configuration files in the examples/metrics
directory.
metrics ├── grafana-install │ ├── grafana.yaml 1 ├── grafana-dashboards 2 │ ├── strimzi-kafka-connect.json │ ├── strimzi-kafka.json │ └── strimzi-zookeeper.json │ └── strimzi-kafka-exporter.json 3 ├── kafka-connect-metrics.yaml 4 ├── kafka-metrics.yaml 5 ├── prometheus-additional-properties │ └── prometheus-additional.yaml 6 ├── prometheus-alertmanager-config │ └── alert-manager-config.yaml 7 └── prometheus-install ├── alert-manager.yaml 8 ├── prometheus-rules.yaml 9 ├── prometheus.yaml 10 └── strimzi-service-monitor.yaml 11
- 1
- Installation file for the Grafana image
- 2
- Grafana dashboard configuration
- 3
- Grafana dashboard configuration specific to Kafka Exporter
- 4
- Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka Connect
- 5
- Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka and Zookeeper
- 6
- Configuration to add roles for service monitoring
- 7
- Hook definitions for sending notifications through Alertmanager
- 8
- Resources for deploying and configuring Alertmanager
- 9
- Alerting rules examples for use with Prometheus Alertmanager (deployed with Prometheus)
- 10
- Installation file for the Prometheus image
- 11
- Prometheus job definitions to scrape metrics data
9.2. Prometheus metrics
AMQ Streams uses the Prometheus JMX Exporter to expose JMX metrics from Kafka and Zookeeper using an HTTP endpoint, which is then scraped by the Prometheus server.
9.2.1. Prometheus metrics configuration
AMQ Streams provides example configuration files for Grafana.
Grafana dashboards are dependent on Prometheus JMX Exporter relabeling rules, which are defined for:
-
Kafka and Zookeeper as a
Kafka
resource configuration in the examplekafka-metrics.yaml
file -
Kafka Connect as
KafkaConnect
andKafkaConnectS2I
resources in the examplekafka-connect-metrics.yaml
file
A label is a name-value pair. Relabeling is the process of writing a label dynamically. For example, the value of a label may be derived from the name of a Kafka server and client ID.
We show metrics configuration using kafka-metrics.yaml
in this section, but the process is the same when configuring Kafka Connect using the kafka-connect-metrics.yaml
file.
Additional resources
For more information on the use of relabeling, see Configuration in the Prometheus documentation.
9.2.2. Prometheus metrics deployment options
To apply the example metrics configuration of relabeling rules to your Kafka cluster, do one of the following:
9.2.3. Copying Prometheus metrics configuration to a Kafka resource
To use Grafana dashboards for monitoring, you can copy the example metrics configuration to a Kafka
resource.
Procedure
Execute the following steps for each Kafka
resource in your deployment.
Update the
Kafka
resource in an editor.oc edit kafka my-cluster
-
Copy the example configuration in
kafka-metrics.yaml
to your ownKafka
resource definition. - Save the file, exit the editor and wait for the updated resource to be reconciled.
9.2.4. Deploying a Kafka cluster with Prometheus metrics configuration
To use Grafana dashboards for monitoring, you can deploy an example Kafka cluster with metrics configuration.
Procedure
Deploy the Kafka cluster with the metrics configuration:
oc apply -f kafka-metrics.yaml
9.3. Prometheus
Prometheus provides an open source set of components for systems monitoring and alert notification.
We describe here how you can use the CoreOS Prometheus Operator to run and manage a Prometheus server that is suitable for use in production environments, but with the correct configuration you can run any Prometheus server.
The Prometheus server configuration uses service discovery to discover the pods in the cluster from which it gets metrics. For this feature to work correctly, the service account used for running the Prometheus service pod must have access to the API server so it can retrieve the pod list.
For more information, see Discovering services.
9.3.1. Prometheus configuration
AMQ Streams provides example configuration files for the Prometheus server.
A Prometheus image is provided for deployment:
-
prometheus.yaml
Additional Prometheus-related configuration is also provided in the following files:
-
prometheus-additional.yaml
-
prometheus-rules.yaml
-
strimzi-service-monitor.yaml
For Prometheus to obtain monitoring data:
Then use the configuration files to:
Alerting rules
The prometheus-rules.yaml
file provides example alerting rule examples for use with Alertmanager.
9.3.2. Prometheus resources
When you apply the Prometheus configuration, the following resources are created in your OpenShift cluster and managed by the Prometheus Operator:
-
A
ClusterRole
that grants permissions to Prometheus to read the health endpoints exposed by the Kafka and Zookeeper pods, cAdvisor and the kubelet for container metrics. -
A
ServiceAccount
for the Prometheus pods to run under. -
A
ClusterRoleBinding
which binds theClusterRole
to theServiceAccount
. -
A
Deployment
to manage the Prometheus Operator pod. -
A
ServiceMonitor
to manage the configuration of the Prometheus pod. -
A
Prometheus
to manage the configuration of the Prometheus pod. -
A
PrometheusRule
to manage alerting rules for the Prometheus pod. -
A
Secret
to manage additional Prometheus settings. -
A
Service
to allow applications running in the cluster to connect to Prometheus (for example, Grafana using Prometheus as datasource).
9.3.3. Deploying the Prometheus Operator
To deploy the Prometheus Operator to your Kafka cluster, apply the YAML resource files from the Prometheus CoreOS repository.
Procedure
Download the resource files from the repository and replace the example
namespace
with your own:On Linux, use:
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-deployment.yaml | sed -e 's/namespace: .\*/namespace: my-namespace/' > prometheus-operator-deployment.yaml
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-cluster-role.yaml > prometheus-operator-cluster-role.yaml
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-cluster-role-binding.yaml | sed -e 's/namespace: .*/namespace: my-namespace/' > prometheus-operator-cluster-role-binding.yaml
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-service-account.yaml | sed -e 's/namespace: .*/namespace: my-namespace/' > prometheus-operator-service-account.yaml
On MacOS, use:
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-deployment.yaml | sed -e '' 's/namespace: .\*/namespace: my-namespace/' > prometheus-operator-deployment.yaml
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-cluster-role.yaml > prometheus-operator-cluster-role.yaml
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-cluster-role-binding.yaml | sed -e '' 's/namespace: .*/namespace: my-namespace/' > prometheus-operator-cluster-role-binding.yaml
curl -s https://raw.githubusercontent.com/coreos/prometheus-operator/master/example/rbac/prometheus-operator/prometheus-operator-service-account.yaml | sed -e '' 's/namespace: .*/namespace: my-namespace/' > prometheus-operator-service-account.yaml
NoteIf it is not required, you can manually remove the
spec.template.spec.securityContext
property from theprometheus-operator-deployment.yaml
file.Deploy the Prometheus Operator:
oc apply -f prometheus-operator-deployment.yaml oc apply -f prometheus-operator-cluster-role.yaml oc apply -f prometheus-operator-cluster-role-binding.yaml oc apply -f prometheus-operator-service-account.yaml
9.3.4. Deploying Prometheus
To deploy Prometheus to your Kafka cluster to obtain monitoring data, apply the example resource file for the Prometheus docker image and the YAML files for Prometheus-related resources.
The deployment process creates a ClusterRoleBinding
and discovers an Alertmanager instance in the namespace specified for the deployment.
By default, the Prometheus Operator only supports jobs that include an endpoints
role for service discovery. Targets are discovered and scraped for each endpoint port address. For endpoint discovery, the port address may be derived from service (role: service
) or pod (role: pod
) discovery.
Prerequisites
- Check the example alerting rules provided
Procedure
Modify the Prometheus installation file (
prometheus.yaml
) according to the namespace Prometheus is going to be installed in:On Linux, use:
sed -i 's/namespace: .*/namespace: my-namespace/' prometheus.yaml
On MacOS, use:
sed -i '' 's/namespace: .*/namespace: my-namespace/' prometheus.yaml
-
Edit the
ServiceMonitor
resource instrimzi-service-monitor.yaml
to define Prometheus jobs that will scrape the metrics data. To use another role:
Create a
Secret
resource:oc create secret generic additional-scrape-configs --from-file=prometheus-additional.yaml
-
Edit the
additionalScrapeConfigs
property in theprometheus.yaml
file to include the name of theSecret
and the YAML file (prometheus-additional.yaml
) that contains the additional configuration.
Edit the
prometheus-rules.yaml
file that creates sample alert notification rules:On Linux, use:
sed -i 's/namespace: .*/namespace: my-namespace/' prometheus-rules.yaml
On MacOS, use:
sed -i '' 's/namespace: .*/namespace: my-namespace/' prometheus-rules.yaml
Deploy the Prometheus resources:
oc apply -f strimzi-service-monitor.yaml oc apply -f prometheus-rules.yaml oc apply -f prometheus.yaml
9.4. Prometheus Alertmanager
Prometheus Alertmanager is a plugin for handling alerts and routing them to a notification service. Alertmanager supports an essential aspect of monitoring, which is to be notified of conditions that indicate potential issues based on alerting rules.
9.4.1. Alertmanager configuration
AMQ Streams provides example configuration files for Prometheus Alertmanager.
A configuration file defines the resources for deploying Alertmanager:
-
alert-manager.yaml
An additional configuration file provides the hook definitions for sending notifications from your Kafka cluster.
-
alert-manager-config.yaml
For Alertmanger to handle Prometheus alerts, use the configuration files to:
9.4.2. Alerting rules
Alerting rules provide notifications about specific conditions observed in the metrics. Rules are declared on the Prometheus server, but Prometheus Alertmanager is responsible for alert notifications.
Prometheus alerting rules describe conditions using PromQL expressions that are continuously evaluated.
When an alert expression becomes true, the condition is met and the Prometheus server sends alert data to the Alertmanager. Alertmanager then sends out a notification using the communication method configured for its deployment.
Alertmanager can be configured to use email, chat messages or other notification methods.
Additional resources
For more information about setting up alerting rules, see Configuration in the Prometheus documentation.
9.4.3. Alerting rule examples
Example alerting rules for Kafka and Zookeeper metrics are provided with AMQ Streams for use in a Prometheus deployment.
General points about the alerting rule definitions:
-
A
for
property is used with the rules to determine the period of time a condition must persist before an alert is triggered. -
A tick is a basic Zookeeper time unit, which is measured in milliseconds and configured using the
tickTime
parameter ofKafka.spec.zookeeper.config
. For example, if ZookeepertickTime=3000
, 3 ticks (3 x 3000) equals 9000 milliseconds. -
The availability of the
ZookeeperRunningOutOfSpace
metric and alert is dependent on the OpenShift configuration and storage implementation used. Storage implementations for certain platforms may not be able to supply the information on available space required for the metric to provide an alert.
Kafka alerting rules
UnderReplicatedPartitions
-
Gives the number of partitions for which the current broker is the lead replica but which have fewer replicas than the
min.insync.replicas
configured for their topic. This metric provides insights about brokers that host the follower replicas. Those followers are not keeping up with the leader. Reasons for this could include being (or having been) offline, and over-throttled interbroker replication. An alert is raised when this value is greater than zero, providing information on the under-replicated partitions for each broker. AbnormalControllerState
- Indicates whether the current broker is the controller for the cluster. The metric can be 0 or 1. During the life of a cluster, only one broker should be the controller and the cluster always needs to have an active controller. Having two or more brokers saying that they are controllers indicates a problem. If the condition persists, an alert is raised when the sum of all the values for this metric on all brokers is not equal to 1, meaning that there is no active controller (the sum is 0) or more than one controller (the sum is greater than 1).
UnderMinIsrPartitionCount
-
Indicates that the minimum number of in-sync replicas (ISRs) for a lead Kafka broker, specified using
min.insync.replicas
, that must acknowledge a write operation has not been reached. The metric defines the number of partitions that the broker leads for which the in-sync replicas count is less than the minimum in-sync. An alert is raised when this value is greater than zero, providing information on the partition count for each broker that did not achieve the minimum number of acknowledgments. OfflineLogDirectoryCount
- Indicates the number of log directories which are offline (for example, due to a hardware failure) so that the broker cannot store incoming messages anymore. An alert is raised when this value is greater than zero, providing information on the number of offline log directories for each broker.
KafkaRunningOutOfSpace
-
Indicates the remaining amount of disk space that can be used for writing data. An alert is raised when this value is lower than 5GiB, providing information on the disk that is running out of space for each persistent volume claim. The threshold value may be changed in
prometheus-rules.yaml
.
Zookeeper alerting rules
AvgRequestLatency
- Indicates the amount of time it takes for the server to respond to a client request. An alert is raised when this value is greater than 10 (ticks), providing the actual value of the average request latency for each server.
OutstandingRequests
- Indicates the number of queued requests in the server. This value goes up when the server receives more requests than it can process. An alert is raised when this value is greater than 10, providing the actual number of outstanding requests for each server.
ZookeeperRunningOutOfSpace
- Indicates the remaining amount of disk space that can be used for writing data to Zookeeper. An alert is raised when this value is lower than 5GiB., providing information on the disk that is running out of space for each persistent volume claim.
9.4.4. Deploying Alertmanager
To deploy Alertmanager, apply the example configuration files.
The sample configuration provided with AMQ Streams configures the Alertmanager to send notifications to a Slack channel.
The following resources are defined on deployment:
-
An
Alertmanager
to manage the Alertmanager pod. -
A
Secret
to manage the configuration of the Alertmanager. -
A
Service
to provide an easy to reference hostname for other services to connect to Alertmanager (such as Prometheus).
Procedure
Create a
Secret
resource from the Alertmanager configuration file (alert-manager-config.yaml
):oc create secret generic alertmanager-alertmanager --from-file=alert-manager-config.yaml
Update the
alert-manager-config.yaml
file to replace the:-
slack_api_url
property with the actual value of the Slack API URL related to the application for the Slack workspace -
channel
property with the actual Slack channel on which to send notifications
-
Deploy Alertmanager:
oc apply -f alert-manager.yaml
9.5. Grafana
Grafana provides visualizations of Prometheus metrics.
You can deploy and enable the example Grafana dashboards provided with AMQ Streams.
9.5.1. Grafana configuration
AMQ Streams provides example dashboard configuration files for Grafana.
A Grafana docker image is provided for deployment:
-
grafana.yaml
Example dashboards are also provided as JSON files:
-
strimzi-kafka.json
-
strimzi-kafka-connect.json
-
strimzi-zookeeper.json
The example dashboards are a good starting point for monitoring key metrics, but they do not represent all available metrics. You may need to modify the example dashboards or add other metrics, depending on your infrastructure.
For Grafana to present the dashboards, use the configuration files to:
9.5.2. Deploying Grafana
To deploy Grafana to provide visualizations of Prometheus metrics, apply the example configuration file.
Prerequisites
Procedure
Deploy Grafana:
oc apply -f grafana.yaml
- Enable the Grafana dashboards.
9.5.3. Enabling the example Grafana dashboards
Set up a Prometheus data source and example dashboards to enable Grafana for monitoring.
No alert notification rules are defined.
When accessing a dashboard, you can use the port-forward
command to forward traffic from the Grafana pod to the host.
For example, you can access the Grafana user interface by:
-
Running
oc port-forward grafana-1-fbl7s 3000:3000
-
Pointing a browser to
http://localhost:3000
The name of the Grafana pod is different for each user.
Procedure
Access the Grafana user interface using
admin/admin
credentials.On the initial view choose to reset the password.
Click the Add data source button.
Add Prometheus as a data source.
- Specify a name
- Add Prometheus as the type
- Specify the connection string to the Prometheus server (http://prometheus-operated:9090) in the URL field
Click Add to test the connection to the data source.
Click Dashboards, then Import to open the Import Dashboard window and import the example dashboards (or paste the JSON).
After importing the dashboards, the Grafana dashboard homepage presents Kafka and Zookeeper dashboards.
When the Prometheus server has been collecting metrics for a AMQ Streams cluster for some time, the dashboards are populated.
Figure 9.1. Kafka dashboard
Figure 9.2. Zookeeper dashboard
Chapter 10. Distributed tracing
This chapter outlines the support for distributed tracing in AMQ Streams, using Jaeger.
How you configure distributed tracing varies by AMQ Streams client and component.
- You instrument Kafka Producer, Consumer, and Streams API applications for distributed tracing using an OpenTracing client library. This involves adding instrumentation code to these clients, which monitors the execution of individual transactions in order to generate trace data.
- Distributed tracing support is built in to the Kafka Connect and Mirror Maker components of AMQ Streams. To configure these components for distributed tracing, you configure and update the relevant custom resources.
Before configuring distributed tracing in AMQ Streams clients and components, you must first initialize and configure a Jaeger tracer in the Kafka cluster, as described in Initializing a Jaeger tracer for Kafka clients.
Distributed tracing is not supported for Kafka brokers.
10.1. Overview of distributed tracing in AMQ Streams
Distributed tracing allows developers and system administrators to track the progress of transactions between applications (and services in a microservice architecture) in a distributed system. This information is useful for monitoring application performance and investigating issues with target systems and end-user applications.
In AMQ Streams and data streaming platforms in general, distributed tracing facilitates the end-to-end tracking of messages: from source systems to the Kafka cluster and then to target systems and applications.
As an aspect of system observability, distributed tracing complements the metrics that are available to view in Grafana dashboards and the available loggers for each component.
OpenTracing overview
Distributed tracing in AMQ Streams is implemented using the open source OpenTracing and Jaeger projects.
The OpenTracing specification defines APIs that developers can use to instrument applications for distributed tracing. It is independent from the tracing system.
When instrumented, applications generate traces for individual transactions. Traces are composed of spans, which define specific units of work.
To simplify the instrumentation of Kafka Producer, Consumer, and Streams API applications, AMQ Streams includes the OpenTracing Apache Kafka Client Instrumentation library.
The OpenTracing project is merging with the OpenCensus project. The new, combined project is named OpenTelemetry. OpenTelemetry will provide compatibility for applications that are instrumented using the OpenTracing APIs.
Jaeger overview
Jaeger, a tracing system, is an implementation of the OpenTracing APIs used for monitoring and troubleshooting microservices-based distributed systems. It consists of four main components and provides client libraries for instrumenting applications. You can use the Jaeger user interface to visualize, query, filter, and analyze trace data.
An example of a query in the Jaeger user interface
10.1.1. Distributed tracing support in AMQ Streams
In AMQ Streams, distributed tracing is supported in:
- Kafka Connect (including Kafka Connect with Source2Image support)
- Mirror Maker
You enable and configure distributed tracing for these components by setting template configuration properties in the relevant custom resource (for example, KafkaConnect
).
To enable distributed tracing in Kafka Producer, Consumer, and Streams API applications, you can instrument application code using the OpenTracing Apache Kafka Client Instrumentation library. When instrumented, these clients generate traces for messages (for example, when producing messages or writing offsets to the log).
Traces are sampled according to a sampling strategy and then visualized in the Jaeger user interface. This trace data is useful for monitoring the performance of your Kafka cluster and debugging issues with target systems and applications.
Outline of procedures
To set up distributed tracing for AMQ Streams, follow these procedures:
This chapter covers setting up distributed tracing for AMQ Streams clients and components only. Setting up distributed tracing for applications and systems beyond AMQ Streams is outside the scope of this chapter. To learn more about this subject, see the OpenTracing documentation and search for "inject and extract".
Before you start
Before you set up distributed tracing for AMQ Streams, it is helpful to understand:
- The basics of OpenTracing, including key concepts such as traces, spans, and tracers. Refer to the OpenTracing documentation.
- The components of the Jaeger architecure.
Prerequisites
- The Jaeger backend components are deployed to your OpenShift cluster. For deployment instructions, see the Jaeger deployment documentation.
10.2. Setting up tracing for Kafka clients
This section describes how to initialize a Jaeger tracer to allow you to instrument your client applications for distributed tracing.
10.2.1. Initializing a Jaeger tracer for Kafka clients
Configure and initialize a Jaeger tracer using a set of tracing environment variables.
Procedure
Perform the following steps for each client application.
Add Maven dependencies for Jaeger to the
pom.xml
file for the client application:<dependency> <groupId>io.jaegertracing</groupId> <artifactId>jaeger-client</artifactId> <version>1.0.0.redhat-00002</version> </dependency>
- Define the configuration of the Jaeger tracer using the tracing environment variables.
Create the Jaeger tracer from the environment variables that you defined in step two:
Tracer tracer = Configuration.fromEnv().getTracer();
NoteFor alternative ways to initialize a Jaeger tracer, see the Java OpenTracing library documentation.
Register the Jaeger tracer as a global tracer:
GlobalTracer.register(tracer);
A Jaeger tracer is now initialized for the client application to use.
10.2.2. Tracing environment variables
Use these environment variables when configuring a Jaeger tracer for Kafka clients.
The tracing environment variables are part of the Jaeger project and are subject to change. For the latest environment variables, see the Jaeger documentation.
Property | Required | Description |
---|---|---|
| Yes | The name of the Jaeger tracer service. |
| No |
The hostname for communicating with the |
| No |
The port used for communicating with the |
| No |
The traces endpoint. Only define this variable if the client application will bypass the |
| No | The authentication token to send to the endpoint as a bearer token. |
| No | The username to send to the endpoint if using basic authentication. |
| No | The password to send to the endpoint if using basic authentication. |
| No |
A comma-separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are |
| No | Indicates whether the reporter should also log the spans. |
| No | The reporter’s maximum queue size. |
| No | The reporter’s flush interval, in ms. Defines how frequently the Jaeger reporter flushes span batches. |
| No | The sampling strategy to use for client traces: Constant, Probabilistic, Rate Limiting, or Remote (the default type). To sample all traces, use the Constant sampling strategy with a parameter of 1. For more information, see the Jaeger documentation. |
| No | The sampler parameter (number). |
| No | The hostname and port to use if a Remote sampling strategy is selected. |
| No | A comma-separated list of tracer-level tags that are added to all reported spans.
The value can also refer to an environment variable using the format |
Additional resources
10.3. Instrumenting Kafka clients with tracers
This section describes how to instrument Kafka Producer, Consumer, and Streams API applications for distributed tracing.
10.3.1. Instrumenting Kafka Producers and Consumers for tracing
Use a Decorator pattern or Interceptors to instrument your Java Producer and Consumer application code for distributed tracing.
Procedure
Perform these steps in the application code of each Kafka Producer and Consumer application.
Add the Maven dependency for OpenTracing to the Producer or Consumer’s
pom.xml
file.<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-kafka-client</artifactId> <version>0.1.4.redhat-00002</version> </dependency>
Instrument your client application code using either a Decorator pattern or Interceptors.
If you prefer to use a Decorator pattern, use following example:
// Create an instance of the KafkaProducer: KafkaProducer<Integer, String> producer = new KafkaProducer<>(senderProps); // Create an instance of the TracingKafkaProducer: TracingKafkaProducer<Integer, String> tracingProducer = new TracingKafkaProducer<>(producer, tracer); // Send: tracingProducer.send(...); // Create an instance of the KafkaConsumer: KafkaConsumer<Integer, String> consumer = new KafkaConsumer<>(consumerProps); // Create an instance of the TracingKafkaConsumer: TracingKafkaConsumer<Integer, String> tracingConsumer = new TracingKafkaConsumer<>(consumer, tracer); // Subscribe: tracingConsumer.subscribe(Collections.singletonList("messages")); // Get messages: ConsumerRecords<Integer, String> records = tracingConsumer.poll(1000); // Retrieve SpanContext from polled record (consumer side): ConsumerRecord<Integer, String> record = ... SpanContext spanContext = TracingKafkaUtils.extractSpanContext(record.headers(), tracer);
If you prefer to use Interceptors, use the following example:
// Register the tracer with GlobalTracer: GlobalTracer.register(tracer); // Add the TracingProducerInterceptor to the sender properties: senderProps.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, TracingProducerInterceptor.class.getName()); // Create an instance of the KafkaProducer: KafkaProducer<Integer, String> producer = new KafkaProducer<>(senderProps); // Send: producer.send(...); // Add the TracingConsumerInterceptor to the consumer properties: consumerProps.put(ConsumerConfig.INTERCEPTOR_CLASSES_CONFIG, TracingConsumerInterceptor.class.getName()); // Create an instance of the KafkaConsumer: KafkaConsumer<Integer, String> consumer = new KafkaConsumer<>(consumerProps); // Subscribe: consumer.subscribe(Collections.singletonList("messages")); // Get messages: ConsumerRecords<Integer, String> records = consumer.poll(1000); // Retrieve the SpanContext from a polled message (consumer side): ConsumerRecord<Integer, String> record = ... SpanContext spanContext = TracingKafkaUtils.extractSpanContext(record.headers(), tracer);
10.3.1.1. Custom span names in a Decorator pattern
A span is a logical unit of work in Jaeger, with an operation name, start time, and duration.
If you use a Decorator pattern to instrument your Kafka Producer and Consumer applications, you can define custom span names by passing a BiFunction
object as an additional argument when creating the TracingKafkaProducer
and TracingKafkaConsumer
objects. The OpenTracing Apache Kafka Client Instrumentation library includes several built-in span names, which are described below.
Example: Using custom span names to instrument client application code in a Decorator pattern
// Create a BiFunction for the KafkaProducer that operates on (String operationName, ProducerRecord consumerRecord) and returns a String to be used as the name: BiFunction<String, ProducerRecord, String> producerSpanNameProvider = (operationName, producerRecord) -> "CUSTOM_PRODUCER_NAME"; // Create an instance of the KafkaProducer: KafkaProducer<Integer, String> producer = new KafkaProducer<>(senderProps); // Create an instance of the TracingKafkaProducer TracingKafkaProducer<Integer, String> tracingProducer = new TracingKafkaProducer<>(producer, tracer, producerSpanNameProvider); // Spans created by the tracingProducer will now have "CUSTOM_PRODUCER_NAME" as the span name. // Create a BiFunction for the KafkaConsumer that operates on (String operationName, ConsumerRecord consumerRecord) and returns a String to be used as the name: BiFunction<String, ConsumerRecord, String> consumerSpanNameProvider = (operationName, consumerRecord) -> operationName.toUpperCase(); // Create an instance of the KafkaConsumer: KafkaConsumer<Integer, String> consumer = new KafkaConsumer<>(consumerProps); // Create an instance of the TracingKafkaConsumer, passing in the consumerSpanNameProvider BiFunction: TracingKafkaConsumer<Integer, String> tracingConsumer = new TracingKafkaConsumer<>(consumer, tracer, consumerSpanNameProvider); // Spans created by the tracingConsumer will have the operation name as the span name, in upper-case. // "receive" -> "RECEIVE"
10.3.1.2. Built-in span names
When defining custom span names, you can use the following BiFunctions
in the ClientSpanNameProvider
class. If no spanNameProvider
is specified, CONSUMER_OPERATION_NAME
and PRODUCER_OPERATION_NAME
are used.
BiFunction | Description |
---|---|
|
Returns the |
|
Returns a String concatenation of |
|
Returns the name of the topic that the message was sent to or retrieved from in the format |
|
Returns a String concatenation of |
|
Returns the operation name and the topic name: |
|
Returns a String concatenation of |
10.3.2. Instrumenting Kafka Streams applications for tracing
This section describes how to instrument Kafka Streams API applications for distributed tracing.
Procedure
Perform the following steps for each Kafka Streams API application.
Add the
opentracing-kafka-streams
dependency to the pom.xml file for your Kafka Streams API application:<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-kafka-streams</artifactId> <version>0.1.4.redhat-00002</version> </dependency>
Create an instance of the
TracingKafkaClientSupplier
supplier interface:KafkaClientSupplier supplier = new TracingKafkaClientSupplier(tracer);
Provide the supplier interface to
KafkaStreams
:KafkaStreams streams = new KafkaStreams(builder.build(), new StreamsConfig(config), supplier); streams.start();
10.4. Setting up tracing for Mirror Maker and Kafka Connect
Distributed tracing is supported for Mirror Maker and Kafka Connect (including Kafka Connect with Source2Image support).
For Mirror Maker, messages are traced from the source cluster to the target cluster; the trace data records messages entering and leaving the Mirror Maker component.
Only messages produced and consumed by Kafka Connect itself are traced. To trace messages sent between Kafka Connect and external systems, you must configure tracing in the connectors for those systems. For more information, see Section 3.2, “Kafka Connect cluster configuration”.
10.4.1. Enabling tracing in Mirror Maker and Kafka Connect resources
Update the configuration of KafkaMirrorMaker
, KafkaConnect
, and KafkaConnectS2I
custom resources to specify and configure a Jaeger tracer service for each resource. Updating a tracing-enabled resource in your OpenShift cluster triggers two events:
- Interceptor classes are updated in the integrated consumers and producers in Mirror Maker or Kafka Connect.
- The tracing agent initializes a Jaeger tracer based on the tracing configuration defined in the resource.
Procedure
Perform these steps for each KafkaMirrorMaker
, KafkaConnect
, and KafkaConnectS2I
resource.
In the
spec.template
property, configure the Jaeger tracer service. For example:Jaeger tracer configuration for Kafka Connect
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaConnect metadata: name: my-connect-cluster spec: #... template: connectContainer: 1 env: - name: JAEGER_SERVICE_NAME value: my-jaeger-service - name: JAEGER_AGENT_HOST value: jaeger-agent-name - name: JAEGER_AGENT_PORT value: "6831" tracing: 2 type: jaeger #...
Jaeger tracer configuration for Mirror Maker
apiVersion: kafka.strimzi.io/v1beta1 kind: KafkaMirrorMaker metadata: name: my-mirror-maker spec: #... template: mirrorMakerContainer: env: - name: JAEGER_SERVICE_NAME value: my-jaeger-service - name: JAEGER_AGENT_HOST value: jaeger-agent-name - name: JAEGER_AGENT_PORT value: "6831" tracing: type: jaeger #...
- 1
- Use the tracing environment variables as template configuration properties.
- 2
- Set the
spec.tracing.type
property tojaeger
.
Create or update the resource:
oc apply -f your-file
Chapter 11. Kafka Exporter
Kafka Exporter is an open source project to enhance monitoring of Apache Kafka brokers and clients. Kafka Exporter is provided with AMQ Streams for deployment with a Kafka cluster to extract additional metrics data from Kafka brokers related to offsets, consumer groups, consumer lag, and topics.
The metrics data is used, for example, to help identify slow consumers.
Lag data is exposed as Prometheus metrics, which can then be presented in Grafana for analysis.
If you are already using Prometheus and Grafana for monitoring of built-in Kafka metrics, you can configure Prometheus to also scrape the Kafka Exporter Prometheus endpoint.
Additional resources
11.1. Consumer lag
Consumer lag indicates the difference in the rate of production and consumption of messages. Specifically, consumer lag for a given consumer group indicates the delay between the last message in the partition and the message being currently picked up by that consumer. The lag reflects the position of the consumer offset in relation to the end of the partition log.
This difference is sometimes referred to as the delta between the producer offset and consumer offset, the read and write positions in the Kafka broker topic partitions.
Suppose a topic streams 100 messages a second. A lag of 1000 messages between the producer offset (the topic partition head) and the last offset the consumer has read means a 10-second delay.
The importance of monitoring consumer lag
For applications that rely on the processing of (near) real-time data, it is critical to monitor consumer lag to check that it does not become too big. The greater the lag becomes, the further the process moves from the real-time processing objective.
Consumer lag, for example, might be a result of consuming too much old data that has not been purged, or through unplanned shutdowns.
Reducing consumer lag
Typical actions to reduce lag include:
- Scaling-up consumer groups by adding new consumers
- Increasing the retention time for a message to remain in a topic
- Adding more disk capacity to increase the message buffer
Actions to reduce consumer lag depend on the underlying infrastructure and the use cases AMQ Streams is supporting. For instance, a lagging consumer is less likely to benefit from the broker being able to service a fetch request from its disk cache. And in certain cases, it might be acceptable to automatically drop messages until a consumer has caught up.
11.2. Kafka Exporter alerting rule examples
If you performed the steps to introduce metrics to your deployment, you will already have your Kafka cluster configured to use the alert notification rules that support Kafka Exporter.
The rules for Kafka Exporter are defined in prometheus-rules.yaml
, and are deployed with Prometheus. For more information, see Prometheus.
The sample alert notification rules specific to Kafka Exporter are as follows:
UnderReplicatedPartition
- An alert to warn that a topic is under-replicated and the broker is not replicating to enough partitions. The default configuration is for an alert if there are one or more under-replicated partitions for a topic. The alert might signify that a Kafka instance is down or the Kafka cluster is overloaded. A planned restart of the Kafka broker may be required to restart the replication process.
TooLargeConsumerGroupLag
- An alert to warn that the lag on a consumer group is too large for a specific topic partition. The default configuration is 1000 records. A large lag might indicate that consumers are too slow and are falling behind the producers.
NoMessageForTooLong
- An alert to warn that a topic has not received messages for a period of time. The default configuration for the time period is 10 minutes. The delay might be a result of a configuration issue preventing a producer from publishing messages to the topic.
Adapt the default configuration of these rules according to your specific needs.
11.3. Kafka Exporter metrics
Lag information is exposed by Kafka Exporter as Prometheus metrics for presentation in Grafana.
Kafka Exporter exposes metrics data for brokers, topics and consumer groups.
The data extracted is described here.
Table 11.1. Broker metrics output
Name | Information |
---|---|
| Number of brokers in the Kafka cluster |
Table 11.2. Topic metrics output
Name | Information |
---|---|
| Number of partitions for a topic |
| Current topic partition offset for a broker |
| Oldest topic partition offset for a broker |
| Number of in-sync replicas for a topic partition |
| Leader broker ID of a topic partition |
|
Shows |
| Number of replicas for this topic partition |
|
Shows |
Table 11.3. Consumer group metrics output
Name | Information |
---|---|
| Current topic partition offset for a consumer group |
| Current approximate lag for a consumer group at a topic partition |
11.4. Enabling the Kafka Exporter Grafana dashboard
If you deployed Kafka Exporter with your Kafka cluster, you can enable Grafana to present the metrics data it exposes.
A Kafka Exporter dashboard is provided in the examples/metrics
directory as a JSON file:
-
strimzi-kafka-exporter.json
Prerequisites
This procedure assumes you already have access to the Grafana user interface and Prometheus has been added as a data source. If you are accessing the user interface for the first time, see Grafana.
Procedure
- Access the Grafana user interface.
Click Dashboards, then Import to open the Import Dashboard window and import the example Kafka Exporter dashboard (or paste the JSON).
When metrics data has been collected for some time, the Kafka Exporter charts are populated.
Kafka Exporter Grafana charts
From the metrics, you can create charts to display:
- Message in per second (from topics)
- Message in per minute (from topics)
- Lag by consumer group
- Messages consumed per minute (by consumer groups)
Use the Grafana charts to analyze lag and to check if actions to reduce lag are having an impact on an affected consumer group. If, for example, Kafka brokers are adjusted to reduce lag, the dashboard will show the Lag by consumer group chart going down and the Messages consumed per minute chart going up.
Chapter 12. Security
AMQ Streams supports encrypted communication between the Kafka and AMQ Streams components using the TLS protocol. Communication between Kafka brokers (interbroker communication), between Zookeeper nodes (internodal communication), and between these and the AMQ Streams operators is always encrypted. Communication between Kafka clients and Kafka brokers is encrypted according to how the cluster is configured. For the Kafka and AMQ Streams components, TLS certificates are also used for authentication.
The Cluster Operator automatically sets up TLS certificates to enable encryption and authentication within your cluster. It also sets up other TLS certificates if you want to enable encryption or TLS authentication between Kafka brokers and clients.
12.1. Certificate Authorities
To support encryption, each AMQ Streams component needs its own private keys and public key certificates. All component certificates are signed by a Certificate Authority (CA) called the cluster CA.
Similarly, each Kafka client application connecting using TLS client authentication needs private keys and certificates. The clients CA is used to sign the certificates for the Kafka clients.
12.1.1. CA certificates
Each CA has a self-signed public key certificate.
Kafka brokers are configured to trust certificates signed by either the clients CA or the cluster CA. Components to which clients do not need to connect, such as Zookeeper, only trust certificates signed by the cluster CA. Client applications that perform mutual TLS authentication have to trust the certificates signed by the cluster CA.
By default, AMQ Streams generates and renews CA certificates automatically. You can configure the management of CA certificates in the Kafka.spec.clusterCa
and Kafka.spec.clientsCa
objects.
12.2. Certificates and Secrets
AMQ Streams stores Certificate Authority (CA), component, and Kafka client private keys and certificates in Secrets
. All keys are 2048 bits in size.
CA certificate validity periods are expressed as a number of days after certificate generation. You can configure the validity period of cluster CA certificates in Kafka.spec.clusterCa.validityDays
and client CA certificates in Kafka.spec.clientsCa.validityDays
.
12.2.1. Cluster CA Secrets
Table 12.1. Cluster CA Secrets
managed by the Cluster Operator in <cluster>
Secret name | Field within Secret | Description |
---|---|---|
|
| The current private key for the cluster CA. |
|
| The current certificate for the cluster CA. |
|
|
Certificate for Kafka broker pod <num>. Signed by a current or former cluster CA private key in |
| Private key for Kafka broker pod <num>. | |
|
|
Certificate for Zookeeper node <num>. Signed by a current or former cluster CA private key in |
| Private key for Zookeeper pod <num>. | |
|
|
Certificate for TLS communication between the Entity Operator and Kafka or Zookeeper. Signed by a current or former cluster CA private key in |
| Private key for TLS communication between the Entity Operator and Kafka or Zookeeper |
The CA certificates in <cluster>-cluster-ca-cert
must be trusted by Kafka client applications so that they validate the Kafka broker certificates when connecting to Kafka brokers over TLS.
Only <cluster>-cluster-ca-cert
needs to be used by clients. All other Secrets
in the table above only need to be accessed by the AMQ Streams components. You can enforce this using OpenShift role-based access controls if necessary.
12.2.2. Client CA Secrets
Table 12.2. Clients CA Secrets
managed by the Cluster Operator in <cluster>
Secret name | Field within Secret | Description |
---|---|---|
|
| The current private key for the clients CA. |
|
| The current certificate for the clients CA. |
The certificates in <cluster>-clients-ca-cert
are those which the Kafka brokers trust.
<cluster>-cluster-ca
is used to sign certificates of client applications. It needs to be accessible to the AMQ Streams components and for administrative access if you are intending to issue application certificates without using the User Operator. You can enforce this using OpenShift role-based access controls if necessary.
12.2.3. User Secrets
Table 12.3. Secrets
managed by the User Operator
Secret name | Field within Secret | Description |
---|---|---|
|
| Certificate for the user, signed by the clients CA |
| Private key for the user |
12.3. Installing your own CA certificates
This procedure describes how to install your own CA certificates and private keys instead of using CA certificates and private keys generated by the Cluster Operator.
Prerequisites
- The Cluster Operator is running.
- A Kafka cluster is not yet deployed.
Your own X.509 certificates and keys in PEM format for the cluster CA or clients CA.
If you want to use a cluster or clients CA which is not a Root CA, you have to include the whole chain in the certificate file. The chain should be in the following order:
- The cluster or clients CA
- One or more intermediate CAs
- The root CA
- All CAs in the chain should be configured as a CA in the X509v3 Basic Constraints.
Procedure
Put your CA certificate in the corresponding
Secret
(<cluster>-cluster-ca-cert
for the cluster CA or<cluster>-clients-ca-cert
for the clients CA):Run the following commands:
# Delete any existing secret (ignore "Not Exists" errors) oc delete secret <ca-cert-secret> # Create and label the new one oc create secret generic <ca-cert-secret> --from-file=ca.crt=<ca-cert-file>
Put your CA key in the corresponding
Secret
(<cluster>-cluster-ca
for the cluster CA or<cluster>-clients-ca
for the clients CA) Run the following commands:# Delete the existing secret oc delete secret <ca-key-secret> # Create the new one oc create secret generic <ca-key-secret> --from-file=ca.key=<ca-key-file>
Label both
Secrets
with labelsstrimzi.io/kind=Kafka
andstrimzi.io/cluster=<my-cluster>
: Run the following commands:oc label secret <ca-cert-secret> strimzi.io/kind=Kafka strimzi.io/cluster=<my-cluster> oc label secret <ca-key-secret> strimzi.io/kind=Kafka strimzi.io/cluster=<my-cluster>
Create the
Kafka
resource for your cluster, configuring either theKafka.spec.clusterCa
or theKafka.spec.clientsCa
object to not use generated CAs:Example fragment
Kafka
resource configuring the cluster CA to use certificates you supply for yourselfkind: Kafka version: kafka.strimzi.io/v1beta1 spec: # ... clusterCa: generateCertificateAuthority: false
12.4. Certificate renewal
The cluster CA and clients CA certificates are only valid for a limited time period, known as the validity period. This is usually defined as a number of days since the certificate was generated. For auto-generated CA certificates, you can configure the validity period in Kafka.spec.clusterCa.validityDays
and Kafka.spec.clientsCa.validityDays
. The default validity period for both certificates is 365 days. Manually-installed CA certificates should have their own validity period defined.
When a CA certificate expires, components and clients which still trust that certificate will not accept TLS connections from peers whose certificate were signed by the CA private key. The components and clients need to trust the new CA certificate instead.
To allow the renewal of CA certificates without a loss of service, the Cluster Operator will initiate certificate renewal before the old CA certificates expire. You can configure the renewal period in Kafka.spec.clusterCa.renewalDays
and Kafka.spec.clientsCa.renewalDays
(both default to 30 days). The renewal period is measured backwards, from the expiry date of the current certificate.
Not Before Not After | | |<--------------- validityDays --------------->| <--- renewalDays --->|
The behavior of the Cluster Operator during the renewal period depends on whether the relevant setting is enabled, in either Kafka.spec.clusterCa.generateCertificateAuthority
or Kafka.spec.clientsCa.generateCertificateAuthority
.
12.4.1. Renewal process with generated CAs
The Cluster Operator performs the following process to renew CA certificates:
-
Generate a new CA certificate, but retaining the existing key. The new certificate replaces the old one with the name
ca.crt
within the correspondingSecret
. - Generate new client certificates (for Zookeeper nodes, Kafka brokers, and the Entity Operator). This is not strictly necessary because the signing key has not changed, but it keeps the validity period of the client certificate in sync with the CA certificate.
- Restart Zookeeper nodes so that they will trust the new CA certificate and use the new client certificates.
- Restart Kafka brokers so that they will trust the new CA certificate and use the new client certificates.
- Restart the Topic and User Operators so that they will trust the new CA certificate and use the new client certificates.
12.4.2. Client applications
The Cluster Operator is not aware of all the client applications using the Kafka cluster.
Depending on how your applications are configured, you might need take action to ensure they continue working after certificate renewal.
Consider the following important points to ensure that client applications continue working.
- When they connect to the cluster, client applications must trust the cluster CA certificate published in <cluster>-cluster-ca-cert.
-
When using the User Operator to provision client certificates, client applications must use the current
user.crt
anduser.key
published in their<user>
Secret
when they connect to the cluster. For workloads running inside the same OpenShift cluster this can be achieved by mounting the secrets as a volume and having the client Pods construct their key- and truststores from the current state of theSecrets
. For more details on this procedure, see Section 12.8, “Configuring internal clients to trust the cluster CA”. - When renewing client certificates, if you are provisioning client certificates and keys manually, you must generate new client certificates and ensure the new certificates are used by clients within the renewal period. Failure to do this by the end of the renewal period could result in client applications being unable to connect.
12.5. Renewing CA certificates manually
Unless the Kafka.spec.clusterCa.generateCertificateAuthority
and Kafka.spec.clientsCa.generateCertificateAuthority
objects are set to false
, the cluster and clients CA certificates will auto-renew at the start of their respective certificate renewal periods. You can manually renew one or both of these certificates before the certificate renewal period starts, if required for security reasons. A renewed certificate uses the same private key as the old certificate.
Prerequisites
- The Cluster Operator is running.
- A Kafka cluster in which CA certificates and private keys are installed.
Procedure
Apply the
strimzi.io/force-renew
annotation to theSecret
that contains the CA certificate that you want to renew.Certificate Secret Annotate command Cluster CA
<cluster-name>-cluster-ca-cert
oc annotate secret <cluster-name>-cluster-ca-cert strimzi.io/force-renew=true
Clients CA
<cluster-name>-clients-ca-cert
oc annotate secret <cluster-name>-clients-ca-cert strimzi.io/force-renew=true
At the next reconciliation the Cluster Operator will generate a new CA certificate for the Secret
that you annotated. If maintenance time windows are configured, the Cluster Operator will generate the new CA certificate at the first reconciliation within the next maintenance time window.
Client applications must reload the cluster and clients CA certificates that were renewed by the Cluster Operator.
12.6. Replacing private keys
You can replace the private keys used by the cluster CA and clients CA certificates. When a private key is replaced, the Cluster Operator generates a new CA certificate for the new private key.
Prerequisites
- The Cluster Operator is running.
- A Kafka cluster in which CA certificates and private keys are installed.
Procedure
Apply the
strimzi.io/force-replace
annotation to theSecret
that contains the private key that you want to renew.Private key for Secret Annotate command Cluster CA
<cluster-name>-cluster-ca
oc annotate secret <cluster-name>-cluster-ca strimzi.io/force-replace=true
Clients CA
<cluster-name>-clients-ca
oc annotate secret <cluster-name>-clients-ca strimzi.io/force-replace=true
At the next reconciliation the Cluster Operator will:
-
Generate a new private key for the
Secret
that you annotated - Generate a new CA certificate
If maintenance time windows are configured, the Cluster Operator will generate the new private key and CA certificate at the first reconciliation within the next maintenance time window.
Client applications must reload the cluster and clients CA certificates that were renewed by the Cluster Operator.
12.7. TLS connections
12.7.1. Zookeeper communication
Zookeeper does not support TLS itself. By deploying a TLS sidecar within every Zookeeper pod, the Cluster Operator is able to provide data encryption and authentication between Zookeeper nodes in a cluster. Zookeeper only communicates with the TLS sidecar over the loopback interface. The TLS sidecar then proxies all Zookeeper traffic, TLS decrypting data upon entry into a Zookeeper pod, and TLS encrypting data upon departure from a Zookeeper pod.
This TLS encrypting stunnel
proxy is instantiated from the spec.zookeeper.stunnelImage
specified in the Kafka resource.
12.7.2. Kafka interbroker communication
Communication between Kafka brokers is done through an internal listener on port 9091, which is encrypted by default and not accessible to Kafka clients.
Communication between Kafka brokers and Zookeeper nodes uses a TLS sidecar, as described above.
12.7.3. Topic and User Operators
Like the Cluster Operator, the Topic and User Operators each use a TLS sidecar when communicating with Zookeeper. The Topic Operator connects to Kafka brokers on port 9091.
12.7.4. Kafka Client connections
Encrypted communication between Kafka brokers and clients running within the same OpenShift cluster can be provided by configuring the spec.kafka.listeners.tls
listener, which listens on port 9093.
Encrypted communication between Kafka brokers and clients running outside the same OpenShift cluster can be provided by configuring the spec.kafka.listeners.external
listener (the port of the external
listener depends on its type).
Unencrypted client communication with brokers can be configured by spec.kafka.listeners.plain
, which listens on port 9092.
12.8. Configuring internal clients to trust the cluster CA
This procedure describes how to configure a Kafka client that resides inside the OpenShift cluster — connecting to the tls
listener on port 9093 — to trust the cluster CA certificate.
The easiest way to achieve this for an internal client is to use a volume mount to access the Secrets
containing the necessary certificates and keys.
Prerequisites
- The Cluster Operator is running.
-
A
Kafka
resource within the OpenShift cluster. - A Kafka client application inside the OpenShift cluster which will connect using TLS and needs to trust the cluster CA certificate.
Procedure
-
When defining the client
Pod
The Kafka client has to be configured to trust certificates signed by this CA. For the Java-based Kafka Producer, Consumer, and Streams APIs, you can do this by importing the CA certificate into the JVM’s truststore using the following
keytool
command:keytool -keystore client.truststore.jks -alias CARoot -import -file ca.crt
To configure the Kafka client, specify the following properties:
-
security.protocol: SSL
when using TLS for encryption (with or without TLS authentication), orsecurity.protocol: SASL_SSL
when using SCRAM-SHA authentication over TLS. -
ssl.truststore.location
: the truststore location where the certificates were imported. -
ssl.truststore.password
: the password for accessing the truststore. This property can be omitted if it is not needed by the truststore.
-
Additional resources
- For the procedure for configuring external clients to trust the cluster CA, see Section 12.9, “Configuring external clients to trust the cluster CA”
12.9. Configuring external clients to trust the cluster CA
This procedure describes how to configure a Kafka client that resides outside the OpenShift cluster – connecting to the external
listener on port 9094 – to trust the cluster CA certificate.
You can use the same procedure to configure clients inside OpenShift, which connect to the tls
listener on port 9093, but it is usually more convenient to access the Secrets
using a volume mount in the client Pod
.
Follow this procedure when setting up the client and during the renewal period, when the old clients CA certificate is replaced.
The <cluster-name>-cluster-ca-cert
Secret
will contain more than one CA certificate during CA certificate renewal. Clients must add all of them to their truststores.
Prerequisites
- The Cluster Operator is running.
-
A
Kafka
resource within the OpenShift cluster. - A Kafka client application outside the OpenShift cluster which will connect using TLS and needs to trust the cluster CA certificate.
Procedure
Extract the cluster CA certificate from the generated
<cluster-name>-cluster-ca-cert
Secret
.Run the following command to extract the certificates:
oc get secret <cluster-name>-cluster-ca-cert -o jsonpath='{.data.ca\.crt}' | base64 -d > ca.crt
The Kafka client has to be configured to trust certificates signed by this CA. For the Java-based Kafka Producer, Consumer, and Streams APIs, you can do this by importing the CA certificates into the JVM’s truststore using the following
keytool
command:keytool -keystore client.truststore.jks -alias CARoot -import -file ca.crt
To configure the Kafka client, specify the following properties:
-
security.protocol: SSL
when using TLS for encryption (with or without TLS authentication), orsecurity.protocol: SASL_SSL
when using SCRAM-SHA authentication over TLS. -
ssl.truststore.location
: the truststore location where the certificates were imported. -
ssl.truststore.password
: the password for accessing the truststore. This property can be omitted if it is not needed by the truststore.
-
Additional resources
- For the procedure for configuring internal clients to trust the cluster CA, see Section 12.8, “Configuring internal clients to trust the cluster CA”
Chapter 13. AMQ Streams and Kafka upgrades
AMQ Streams can be upgraded with no cluster downtime. Each version of AMQ Streams supports one or more versions of Apache Kafka: you can upgrade to a higher Kafka version as long as it is supported by your version of AMQ Streams. In some cases, you can also downgrade to a lower supported Kafka version.
Newer versions of AMQ Streams may support newer versions of Kafka, but you need to upgrade AMQ Streams before you can upgrade to a higher supported Kafka version.
13.1. Upgrade prerequisites
Before you begin the upgrade process, make sure that:
- AMQ Streams is installed. For instructions, see Chapter 2, Getting started with AMQ Streams.
- You are familiar with any upgrade changes described in the AMQ Streams 1.3 on Red Hat OpenShift Container Platform Release Notes.
13.2. Upgrade process
Upgrading AMQ Streams is a two-stage process. To upgrade brokers and clients without downtime, you must complete the upgrade procedures in the following order:
Update your Cluster Operator to the latest AMQ Streams version.
Upgrade all Kafka brokers and client applications to the latest Kafka version.
13.3. Kafka versions
AMQ Streams is based on a specific version of Apache Kafka.
AMQ Streams version | Kafka version |
---|---|
1.3 | 2.3.0 |
Kafka’s log message format version and inter-broker protocol version specify the log format version appended to messages and the version of protocol used in a cluster. As a result, the upgrade process involves making configuration changes to existing Kafka brokers and code changes to client applications (consumers and producers) to ensure the correct versions are used.
The following table shows the differences between Kafka versions:
Kafka version | Interbroker protocol version | Log message format version | Zookeeper version |
2.2.1 | 2.2 | 2.2 | 3.4.14 |
2.3.0 | 2.3 | 2.3 | 3.4.14 |
Although Kafka versions may use the same version of Zookeeper, it is recommended that you update your Zookeeper cluster to use the newest Zookeeper binaries before proceeding with the main AMQ Streams upgrade.
Message format version
When a producer sends a message to a Kafka broker, the message is encoded using a specific format. The format can change between Kafka releases, so messages include a version identifying which version of the format they were encoded with. You can configure a Kafka broker to convert messages from newer format versions to a given older format version before the broker appends the message to the log.
In Kafka, there are two different methods for setting the message format version:
-
The
log.message.format.version
property is set on Kafka brokers. -
The
message.format.version
property is set on topics.
The default value of message.format.version
for a topic is defined by the log.message.format.version
that is set on the Kafka broker. You can manually set the message.format.version
of a topic by modifying its topic configuration.
The upgrade tasks in this section assume that the message format version is defined by the log.message.format.version
.
13.4. Upgrading the Cluster Operator
The steps to upgrade your Cluster Operator deployment to use AMQ Streams 1.3 are outlined in this section.
The availability of Kafka clusters managed by the Cluster Operator is not affected by the upgrade operation.
Refer to the documentation supporting a specific version of AMQ Streams for information on how to upgrade to that version.
13.4.1. Upgrading the Cluster Operator to a later version
This procedure describes how to upgrade a Cluster Operator deployment to a later version.
Prerequisites
- An existing Cluster Operator deployment.
Procedure
Backup the existing Cluster Operator resources:
oc get all -l app=strimzi -o yaml > strimzi-backup.yaml
Update the Cluster Operator.
Modify the installation files according to the namespace the Cluster Operator is running in.
On Linux, use:
sed -i 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
On MacOS, use:
sed -i '' 's/namespace: .*/namespace: my-namespace/' install/cluster-operator/*RoleBinding*.yaml
If you modified one or more environment variables in your existing Cluster Operator
Deployment
, edit theinstall/cluster-operator/050-Deployment-cluster-operator.yaml
file to reflect the changes that you made in the new version of the Cluster Operator.When you have an updated configuration, deploy it along with the rest of the install resources:
oc apply -f install/cluster-operator
Wait for the rolling updates to complete.
Get the image for the Kafka pod to ensure the upgrade was successful:
oc get po my-cluster-kafka-0 -o jsonpath='{.spec.containers[0].image}'
The image tag shows the new AMQ Streams version followed by the Kafka version. For example,
<New AMQ Streams version>-kafka-<Current Kafka version>
.Update existing resources to handle deprecated custom resource properties.
You now have an updated Cluster Operator, but the version of Kafka running in the cluster it manages is unchanged.
What to do next
Following the Cluster Operator upgrade, you can perform a Kafka upgrade.
13.5. Upgrading Kafka
After you have upgraded your Cluster Operator, you can upgrade your brokers to a higher supported version of Kafka.
Kafka upgrades are performed using the Cluster Operator. How the Cluster Operator performs an upgrade depends on the differences between versions of:
- Interbroker protocol
- Log message format
- Zookeeper
When the versions are the same for the current and target Kafka version, as is typically the case for a patch level upgrade, the Cluster Operator can upgrade through a single rolling update of the Kafka brokers.
When one or more of these versions differ, the Cluster Operator requires two or three rolling updates of the Kafka brokers to perform the upgrade.
Additional resources
13.5.1. Kafka version and image mappings
When upgrading Kafka, consider your settings for the STRIMZI_KAFKA_IMAGES
and Kafka.spec.kafka.version
properties.
-
Each
Kafka
resource can be configured with aKafka.spec.kafka.version
. The Cluster Operator’s
STRIMZI_KAFKA_IMAGES
environment variable provides a mapping between the Kafka version and the image to be used when that version is requested in a givenKafka
resource.-
If
Kafka.spec.kafka.image
is not configured, the default image for the given version is used. -
If
Kafka.spec.kafka.image
is configured, the default image is overridden.
-
If
The Cluster Operator cannot validate that an image actually contains a Kafka broker of the expected version. Take care to ensure that the given image corresponds to the given Kafka version.
13.5.2. Strategies for upgrading clients
The best approach to upgrading your client applications (including Kafka Connect connectors) depends on your particular circumstances.
Consuming applications need to receive messages in a message format that they understand. You can ensure that this is the case in one of two ways:
- By upgrading all the consumers for a topic before upgrading any of the producers.
- By having the brokers down-convert messages to an older format.
Using broker down-conversion puts extra load on the brokers, so it is not ideal to rely on down-conversion for all topics for a prolonged period of time. For brokers to perform optimally they should not be down converting messages at all.
Broker down-conversion is configured in two ways:
-
The topic-level
message.format.version
configures it for a single topic. -
The broker-level
log.message.format.version
is the default for topics that do not have the topic-levelmessage.format.version
configured.
Messages published to a topic in a new-version format will be visible to consumers, because brokers perform down-conversion when they receive messages from producers, not when they are sent to consumers.
There are a number of strategies you can use to upgrade your clients:
- Consumers first
- Upgrade all the consuming applications.
-
Change the broker-level
log.message.format.version
to the new version. Upgrade all the producing applications.
This strategy is straightforward, and avoids any broker down-conversion. However, it assumes that all consumers in your organization can be upgraded in a coordinated way, and it does not work for applications that are both consumers and producers. There is also a risk that, if there is a problem with the upgraded clients, new-format messages might get added to the message log so that you cannot revert to the previous consumer version.
- Per-topic consumers first
For each topic:
- Upgrade all the consuming applications.
-
Change the topic-level
message.format.version
to the new version. Upgrade all the producing applications.
This strategy avoids any broker down-conversion, and means you can proceed on a topic-by-topic basis. It does not work for applications that are both consumers and producers of the same topic. Again, it has the risk that, if there is a problem with the upgraded clients, new-format messages might get added to the message log.
- Per-topic consumers first, with down conversion
For each topic:
-
Change the topic-level
message.format.version
to the old version (or rely on the topic defaulting to the broker-levellog.message.format.version
). - Upgrade all the consuming and producing applications.
- Verify that the upgraded applications function correctly.
Change the topic-level
message.format.version
to the new version.This strategy requires broker down-conversion, but the load on the brokers is minimized because it is only required for a single topic (or small group of topics) at a time. It also works for applications that are both consumers and producers of the same topic. This approach ensures that the upgraded producers and consumers are working correctly before you commit to using the new message format version.
The main drawback of this approach is that it can be complicated to manage in a cluster with many topics and applications.
-
Change the topic-level
Other strategies for upgrading client applications are also possible.
It is also possible to apply multiple strategies. For example, for the first few applications and topics the "per-topic consumers first, with down conversion" strategy can be used. When this has proved successful another, more efficient strategy can be considered acceptable to use instead.
13.5.3. Upgrading Kafka brokers and client applications
This procedure describes how to upgrade a AMQ Streams Kafka cluster to a higher version of Kafka.
Prerequisites
For the Kafka
resource to be upgraded, check:
- The Cluster Operator, which supports both versions of Kafka, is up and running.
-
The
Kafka.spec.kafka.config
does not contain options that are not supported in the version of Kafka that you are upgrading to. Whether the
log.message.format.version
for the current Kafka version needs to be updated for the new version.
Procedure
Update the Kafka cluster configuration in an editor, as required:
oc edit kafka my-cluster
If the
log.message.format.version
of the current Kafka version is the same as that of the new Kafka version, proceed to the next step.Otherwise, ensure that
Kafka.spec.kafka.config
has thelog.message.format.version
configured to the default for the current version.For example, if upgrading from Kafka 2.2.1:
kind: Kafka spec: # ... kafka: version: 2.2.1 config: log.message.format.version: "2.2" # ...
If the
log.message.format.version
is unset, set it to the current version.NoteThe value of
log.message.format.version
must be a string to prevent it from being interpreted as a floating point number.Change the
Kafka.spec.kafka.version
to specify the new version (leaving thelog.message.format.version
as the current version).For example, if upgrading from Kafka 2.2.1 to 2.3.0:
apiVersion: v1alpha1 kind: Kafka spec: # ... kafka: version: 2.3.0 1 config: log.message.format.version: "2.2" 2 # ...
If the image for the Kafka version is different from the image defined in
STRIMZI_KAFKA_IMAGES
for the Cluster Operator, updateKafka.spec.kafka.image
.
Save and exit the editor, then wait for rolling updates to complete.
Check the update in the logs or by watching the pod state transitions:
oc logs -f <cluster-operator-pod-name> | grep -E "Kafka version upgrade from [0-9.]+ to [0-9.]+, phase ([0-9]+) of \1 completed"
oc get po -w
If the current and new versions of Kafka have different interbroker protocol versions, check the Cluster Operator logs for an
INFO
level message:Reconciliation #<num>(watch) Kafka(<namespace>/<name>): Kafka version upgrade from <from-version> to <to-version>, phase 2 of 2 completed
Alternatively, if the current and new versions of Kafka have the same interbroker protocol version, check for:
Reconciliation #<num>(watch) Kafka(<namespace>/<name>): Kafka version upgrade from <from-version> to <to-version>, phase 1 of 1 completed
The rolling updates:
- Ensure each pod is using the broker binaries for the new version of Kafka
Configure the brokers to send messages using the interbroker protocol of the new version of Kafka
NoteClients are still using the old version, so brokers will convert messages to the old version before sending them to the clients. To minimize this additional load, updates the clients as quickly as possible.
Depending on your chosen strategy for upgrading clients, upgrade all client applications to use the new version of the client binaries.
See Section 13.5.2, “Strategies for upgrading clients”
WarningYou cannot downgrade after completing this step. If you need to revert the update at this point, follow the procedure Section 13.6.2, “Downgrading Kafka brokers and client applications”.
If required, set the version property for Kafka Connect and Mirror Maker as the new version of Kafka:
-
For Kafka Connect, update
KafkaConnect.spec.version
-
For MIrror Maker, update
KafkaMirrorMaker.spec.version
-
For Kafka Connect, update
If the
log.message.format.version
identified in step 1 is the same as the new version proceed to the next step.Otherwise change the
log.message.format.version
inKafka.spec.kafka.config
to the default version for the new version of Kafka now being used.For example, if upgrading to 2.3.0:
apiVersion: v1alpha1 kind: Kafka spec: # ... kafka: version: 2.3.0 config: log.message.format.version: "2.3" # ...
Wait for the Cluster Operator to update the cluster.
The Kafka cluster and clients are now using the new Kafka version.
Additional resources
- See Section 13.6.2, “Downgrading Kafka brokers and client applications” for the procedure to downgrade a AMQ Streams Kafka cluster from one version to a lower version.
13.6. Downgrading Kafka
Kafka version downgrades are performed using the Cluster Operator.
Whether and how the Cluster Operator performs a downgrade depends on the differences between versions of:
- Interbroker protocol
- Log message format
- Zookeeper
13.6.1. Target downgrade version
How the Cluster Operator handles a downgrade operation depends on the log.message.format.version
.
-
If the target downgrade version of Kafka has the same
log.message.format.version
as the current version, the Cluster Operator downgrades by performing a single rolling restart of the brokers. If the target downgrade version of Kafka has a different
log.message.format.version
, downgrading is only possible if the running cluster has always hadlog.message.format.version
set to the version used by the downgraded version.This is typically only the case if the upgrade procedure was aborted before the
log.message.format.version
was changed. In this case, the downgrade requires:- Two rolling restarts of the brokers if the interbroker protocol of the two versions is different
- A single rolling restart if they are the same
13.6.2. Downgrading Kafka brokers and client applications
This procedure describes how you can downgrade a AMQ Streams Kafka cluster to a lower (previous) version of Kafka, such as downgrading from 2.3.0 to 2.2.1.
Downgrading is not possible if the new version has ever used a log.message.format.version
that is not supported by the previous version, including when the default value for log.message.format.version
is used. For example, this resource can be downgraded to Kafka version 2.2.1 because the log.message.format.version
has not been changed:
apiVersion: v1alpha1 kind: Kafka spec: # ... kafka: version: 2.3.0 config: log.message.format.version: "2.2" # ...
The downgrade would not be possible if the log.message.format.version
was set at "2.3"
or a value was absent (so that the parameter took the default value for a 2.3.0 broker of 2.3).
Prerequisites
For the Kafka
resource to be downgraded, check:
- The Cluster Operator, which supports both versions of Kafka, is up and running.
-
The
Kafka.spec.kafka.config
does not contain options that are not supported in the version of Kafka you are downgrading to. -
The
Kafka.spec.kafka.config
has alog.message.format.version
that is supported by the version being downgraded to.
Procedure
Update the Kafka cluster configuration in an editor, as required:
Use
oc edit
:oc edit kafka my-cluster
Change the
Kafka.spec.kafka.version
to specify the previous version.For example, if downgrading from Kafka 2.3.0 to 2.2.1:
apiVersion: v1alpha1 kind: Kafka spec: # ... kafka: version: 2.2.1 1 config: log.message.format.version: "2.2" 2 # ...
NoteYou must format the value of
log.message.format.version
as a string to prevent it from being interpreted as a floating point number.If the image for the Kafka version is different from the image defined in
STRIMZI_KAFKA_IMAGES
for the Cluster Operator, updateKafka.spec.kafka.image
.
Save and exit the editor, then wait for rolling updates to complete.
Check the update in the logs or by watching the pod state transitions:
oc logs -f <cluster-operator-pod-name> | grep -E "Kafka version downgrade from [0-9.]+ to [0-9.]+, phase ([0-9]+) of \1 completed"
oc get po -w
If the previous and current versions of Kafka have different interbroker protocol versions, check the Cluster Operator logs for an
INFO
level message:Reconciliation #<num>(watch) Kafka(<namespace>/<name>): Kafka version downgrade from <from-version> to <to-version>, phase 2 of 2 completed
Alternatively, if the previous and current versions of Kafka have the same interbroker protocol version, check for:
Reconciliation #<num>(watch) Kafka(<namespace>/<name>): Kafka version downgrade from <from-version> to <to-version>, phase 1 of 1 completed
Downgrade all client applications (consumers) to use the previous version of the client binaries.
The Kafka cluster and clients are now using the previous Kafka version.
Chapter 14. AMQ Streams resource upgrades
For this release of AMQ Streams, resources that use the API version kafka.strimzi.io/v1alpha1
must be updated to use kafka.strimzi.io/v1beta1
.
The kafka.strimzi.io/v1alpha1
API version is deprecated.
This section describes the upgrade steps for the resources.
The upgrade of resources must be performed after upgrading the Cluster Operator, so the Cluster Operator can understand the resources.
What if the resource upgrade does not take effect?
If the upgrade does not take effect, a warning is given in the logs on reconciliation to indicate that the resource cannot be updated until the apiVersion
is updated.
To trigger the update, make a cosmetic change to the custom resource, such as adding an annotation.
Example annotation:
metadata: # ... annotations: upgrade: "Upgraded to kafka.strimzi.io/v1beta1"
14.1. Upgrading Kafka resources
Prerequisites
-
A Cluster Operator supporting the
v1beta1
API version is up and running.
Procedure
Execute the following steps for each Kafka
resource in your deployment.
Update the
Kafka
resource in an editor.oc edit kafka my-cluster
Replace:
apiVersion: kafka.strimzi.io/v1alpha1
with:
apiVersion:kafka.strimzi.io/v1beta1
If the
Kafka
resource has:Kafka.spec.topicOperator
Replace it with:
Kafka.spec.entityOperator.topicOperator
For example, replace:
spec: # ... topicOperator: {}
with:
spec: # ... entityOperator: topicOperator: {}
If present, move:
Kafka.spec.entityOperator.affinity
Kafka.spec.entityOperator.tolerations
to:
Kafka.spec.entityOperator.template.pod.affinity
Kafka.spec.entityOperator.template.pod.tolerations
For example, move:
spec: # ... entityOperator: affinity {} tolerations {}
to:
spec: # ... entityOperator: template: pod: affinity {} tolerations {}
If present, move:
Kafka.spec.kafka.affinity
Kafka.spec.kafka.tolerations
to:
Kafka.spec.kafka.template.pod.affinity
Kafka.spec.kafka.template.pod.tolerations
For example, move:
spec: # ... kafka: affinity {} tolerations {}
to:
spec: # ... kafka: template: pod: affinity {} tolerations {}
If present, move:
Kafka.spec.zookeeper.affinity
Kafka.spec.zookeeper.tolerations
to:
Kafka.spec.zookeeper.template.pod.affinity
Kafka.spec.zookeeper.template.pod.tolerations
For example, move:
spec: # ... zookeeper: affinity {} tolerations {}
to:
spec: # ... zookeeper: template: pod: affinity {} tolerations {}
- Save the file, exit the editor and wait for the updated resource to be reconciled.
14.2. Upgrading Kafka Connect resources
Prerequisites
-
A Cluster Operator supporting the
v1beta1
API version is up and running.
Procedure
Execute the following steps for each KafkaConnect
resource in your deployment.
Update the
KafkaConnect
resource in an editor.oc edit kafkaconnect my-connect
Replace:
apiVersion: kafka.strimzi.io/v1alpha1
with:
apiVersion:kafka.strimzi.io/v1beta1
If present, move:
KafkaConnect.spec.affinity
KafkaConnect.spec.tolerations
to:
KafkaConnect.spec.template.pod.affinity
KafkaConnect.spec.template.pod.tolerations
For example, move:
spec: # ... affinity {} tolerations {}
to:
spec: # ... template: pod: affinity {} tolerations {}
- Save the file, exit the editor and wait for the updated resource to be reconciled.
14.3. Upgrading Kafka Connect S2I resources
Prerequisites
-
A Cluster Operator supporting the
v1beta1
API version is up and running.
Procedure
Execute the following steps for each KafkaConnectS2I
resource in your deployment.
Update the
KafkaConnectS2I
resource in an editor.oc edit kafkaconnects2i my-connect
Replace:
apiVersion: kafka.strimzi.io/v1alpha1
with:
apiVersion:kafka.strimzi.io/v1beta1
If present, move:
KafkaConnectS2I.spec.affinity
KafkaConnectS2I.spec.tolerations
to:
KafkaConnectS2I.spec.template.pod.affinity
KafkaConnectS2I.spec.template.pod.tolerations
For example, move:
spec: # ... affinity {} tolerations {}
to:
spec: # ... template: pod: affinity {} tolerations {}
- Save the file, exit the editor and wait for the updated resource to be reconciled.
14.4. Upgrading Kafka Mirror Maker resources
Prerequisites
-
A Cluster Operator supporting the
v1beta1
API version is up and running.
Procedure
Execute the following steps for each KafkaMirrorMaker
resource in your deployment.
Update the
KafkaMirrorMaker
resource in an editor.oc edit kafkamirrormaker my-connect
Replace:
apiVersion: kafka.strimzi.io/v1alpha1
with:
apiVersion:kafka.strimzi.io/v1beta1
If present, move:
KafkaConnectMirrorMaker.spec.affinity
KafkaConnectMirrorMaker.spec.tolerations
to:
KafkaConnectMirrorMaker.spec.template.pod.affinity
KafkaConnectMirrorMaker.spec.template.pod.tolerations
For example, move:
spec: # ... affinity {} tolerations {}
to:
spec: # ... template: pod: affinity {} tolerations {}
- Save the file, exit the editor and wait for the updated resource to be reconciled.
14.5. Upgrading Kafka Topic resources
Prerequisites
-
A Topic Operator supporting the
v1beta1
API version is up and running.
Procedure
Execute the following steps for each KafkaTopic
resource in your deployment.
Update the
KafkaTopic
resource in an editor.oc edit kafkatopic my-topic
Replace:
apiVersion: kafka.strimzi.io/v1alpha1
with:
apiVersion:kafka.strimzi.io/v1beta1
- Save the file, exit the editor and wait for the updated resource to be reconciled.
14.6. Upgrading Kafka User resources
Prerequisites
-
A User Operator supporting the
v1beta1
API version is up and running.
Procedure
Execute the following steps for each KafkaUser
resource in your deployment.
Update the
KafkaUser
resource in an editor.oc edit kafkauser my-user
Replace:
apiVersion: kafka.strimzi.io/v1alpha1
with:
apiVersion:kafka.strimzi.io/v1beta1
- Save the file, exit the editor and wait for the updated resource to be reconciled.
Chapter 15. Uninstalling AMQ Streams
This procedure describes how to uninstall AMQ Streams and remove resources related to the deployment.
Prerequisites
In order to perform this procedure, identify resources created specifically for a deployment and referenced from the AMQ Streams resource.
Such resources include:
- Secrets (Custom CAs and certificates, Kafka Connect secrets, and other Kafka secrets)
-
Logging
ConfigMaps
(of typeexternal
)
These are resources referenced by Kafka
, KafkaConnect
, KafkaConnectS2I
, KafkaMirrorMaker
, or KafkaBridge
configuration.
Procedure
Delete the Cluster Operator
Deployment
, relatedCustomResourceDefinitions
, andRBAC
resources:oc delete -f install/cluster-operator
WarningDeleting
CustomResourceDefinitions
results in the garbage collection of the corresponding custom resources (Kafka
,KafkaConnect
,KafkaConnectS2I
,KafkaMirrorMaker
, orKafkaBridge
) and the resources dependent on them (Deployments, StatefulSets, and other dependent resources).- Delete the resources you identified in the prerequisites.
Chapter 16. Checking the status of a custom resource
This procedure describes how to find the status of a custom resource.
Prerequisites
- An OpenShift cluster.
- The Cluster Operator is running.
Procedure
Specify the custom resource and use the
-o jsonpath
option to apply a standard JSONPath expression to select thestatus
property:oc get kafka <kafka_resource_name> -o jsonpath='{.status}'
This expression returns all the status information for the specified custom resource. You can use dot notation, such as
status.listeners
orstatus.observedGeneration
, to fine-tune the status information you wish to see.
Additional resources
- Section 2.2.2, “AMQ Streams custom resource status”
- For more information about using JSONPath, see JSONPath support.
Appendix A. Configurable loggers
Logging allows you to diagnose error and performance issues for AMQ Streams.
The following logger implementations are used in AMQ Streams:
-
log4j
logger for Kafka and Zookeeper -
log4j2
logger for Topic Operator, User Operator, and other components
AMQ Streams components have their own configurable loggers.
Appendix B. Frequently Asked Questions
B.1. Cluster Operator
B.1.1. Why do I need cluster admin privileges to install AMQ Streams?
To install AMQ Streams, you must have the ability to create Custom Resource Definitions (CRDs). CRDs instruct OpenShift about resources that are specific to AMQ Streams, such as Kafka, KafkaConnect, and so on. Because CRDs are a cluster-scoped resource rather than being scoped to a particular OpenShift namespace, they typically require cluster admin privileges to install.
In addition, you must also have the ability to create ClusterRoles and ClusterRoleBindings. Like CRDs, these are cluster-scoped resources that typically require cluster admin privileges.
The cluster administrator can inspect all the resources being installed (in the /install/
directory) to assure themselves that the ClusterRoles
do not grant unnecessary privileges. For more information about why the Cluster Operator installation resources grant the ability to create ClusterRoleBindings
see the following question.
After installation, the Cluster Operator will run as a regular Deployment
; any non-admin user with privileges to access the Deployment
can configure it.
By default, normal users will not have the privileges necessary to manipulate the custom resources, such as Kafka
, KafkaConnect
and so on, which the Cluster Operator deals with. These privileges can be granted using normal RBAC resources by the cluster administrator. See this procedure for more details of how to do this.
B.1.2. Why does the Cluster Operator require the ability to create ClusterRoleBindings
? Is that not a security risk?
OpenShift has built-in privilege escalation prevention. That means that the Cluster Operator cannot grant privileges it does not have itself. Which in turn means that the Cluster Operator needs to have the privileges necessary for all the components it orchestrates.
In the context of this question there are two places where the Cluster Operator needs to create bindings to ClusterRoleBindings
to ServiceAccounts
:
-
The Topic Operator and User Operator need to be able to manipulate
KafkaTopics
andKafkaUsers
, respectively. The Cluster Operator therefore needs to be able to grant them this access, which it does by creating aRole
andRoleBinding
. For this reason the Cluster Operator itself needs to be able to createRoles
andRoleBindings
in the namespace that those operators will run in. However, because of the privilege escalation prevention, the Cluster Operator cannot grant privileges it does not have itself (in particular it cannot grant such privileges in namespace it cannot access). -
When using rack-aware partition assignment, AMQ Streams needs to be able to discover the failure domain (for example, the Availability Zone in AWS) of the node on which a broker pod is assigned. To do this the broker pod needs to be able to get information about the
Node
it is running on. ANode
is a cluster-scoped resource, so access to it can only be granted via aClusterRoleBinding
(not a namespace-scopedRoleBinding
). Therefore the Cluster Operator needs to be able to createClusterRoleBindings
. But again, because of privilege escalation prevention, the Cluster Operator cannot grant privileges it does not have itself (so it cannot, for example, create aClusterRoleBinding
to aClusterRole
to grant privileges that the Cluster Operator does not not already have).
B.1.3. Why can standard OpenShift users not create the custom resource (Kafka
, KafkaTopic
, and so on)?
Because, when they installed AMQ Streams, the OpenShift cluster administrator did not grant the necessary privileges to standard users.
See this FAQ answer for more details.
B.1.4. Log contains warnings about failing to acquire lock
For each cluster, the Cluster Operator always executes only one operation at a time. The Cluster Operator uses locks to make sure that there are never two parallel operations running for the same cluster. In case an operation requires more time to complete, other operations will wait until it is completed and the lock is released.
- INFO
- Examples of cluster operations are cluster creation, rolling update, scale down or scale up and so on.
If the wait for the lock takes too long, the operation times out and the following warning message will be printed to the log:
2018-03-04 17:09:24 WARNING AbstractClusterOperations:290 - Failed to acquire lock for kafka cluster lock::kafka::myproject::my-cluster
Depending on the exact configuration of STRIMZI_FULL_RECONCILIATION_INTERVAL_MS
and STRIMZI_OPERATION_TIMEOUT_MS
, this warning message may appear regularly without indicating any problems. The operations which time out will be picked up by the next periodic reconciliation. It will try to acquire the lock again and execute.
Should this message appear periodically even in situations when there should be no other operations running for a given cluster, it might indicate that due to some error the lock was not properly released. In such cases it is recommended to restart the Cluster Operator.
B.1.5. Hostname verification fails when connecting to NodePorts using TLS
Currently, off-cluster access using NodePorts with TLS encryption enabled does not support TLS hostname verification. As a result, the clients that verify the hostname will fail to connect. For example, the Java client will fail with the following exception:
Caused by: java.security.cert.CertificateException: No subject alternative names matching IP address 168.72.15.231 found at sun.security.util.HostnameChecker.matchIP(HostnameChecker.java:168) at sun.security.util.HostnameChecker.match(HostnameChecker.java:94) at sun.security.ssl.X509TrustManagerImpl.checkIdentity(X509TrustManagerImpl.java:455) at sun.security.ssl.X509TrustManagerImpl.checkIdentity(X509TrustManagerImpl.java:436) at sun.security.ssl.X509TrustManagerImpl.checkTrusted(X509TrustManagerImpl.java:252) at sun.security.ssl.X509TrustManagerImpl.checkServerTrusted(X509TrustManagerImpl.java:136) at sun.security.ssl.ClientHandshaker.serverCertificate(ClientHandshaker.java:1501) ... 17 more
To connect, you must disable hostname verification. In the Java client, you can do this by setting the configuration option ssl.endpoint.identification.algorithm
to an empty string.
When configuring the client using a properties file, you can do it this way:
ssl.endpoint.identification.algorithm=
When configuring the client directly in Java, set the configuration option to an empty string:
props.put("ssl.endpoint.identification.algorithm", "");
Appendix C. Custom Resource API Reference
C.1. Kafka
schema reference
Property | Description |
---|---|
spec | The specification of the Kafka and Zookeeper clusters, and Topic Operator. |
status | The status of the Kafka and Zookeeper clusters, and Topic Operator. |
C.2. KafkaSpec
schema reference
Used in: Kafka
Property | Description |
---|---|
kafka | Configuration of the Kafka cluster. |
zookeeper | Configuration of the Zookeeper cluster. |
topicOperator |
The property |
entityOperator | Configuration of the Entity Operator. |
clusterCa | Configuration of the cluster certificate authority. |
clientsCa | Configuration of the clients certificate authority. |
kafkaExporter | Configuration of the Kafka Exporter. Kafka Exporter can provide additional metrics, for example lag of consumer group at topic/partition. |
maintenanceTimeWindows | A list of time windows for maintenance tasks (that is, certificates renewal). Each time window is defined by a cron expression. |
string array |
C.3. 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 |
string | |
storage |
Storage configuration (disk). Cannot be updated. The type depends on the value of the |
listeners | Configures listeners of Kafka brokers. |
authorization |
Authorization configuration for Kafka brokers. The type depends on the value of the |
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 |
brokerRackInitImage |
The image of the init container used for initializing the |
string | |
affinity |
The property |
tolerations |
The property |
Toleration array | |
livenessProbe | Pod liveness checking. |
readinessProbe | Pod readiness checking. |
jvmOptions | JVM Options for pods. |
resources | CPU and memory resources to reserve (limits and requests). |
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 |
tlsSidecar | TLS sidecar configuration. |
template |
Template for Kafka cluster resources. The template allows users to specify how are the |
version | The kafka broker version. Defaults to 2.3.0. Consult the user documentation to understand the process required to upgrade or downgrade the version. |
string |
C.4. 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 | |
sizeLimit | When type=ephemeral, defines the total amount of local storage required for this EmptyDir volume (for example 1Gi). |
string | |
type |
Must be |
string |
C.5. 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 |
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 |
C.6. 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 |
C.7. 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 |
string | |
volumes | List of volumes as Storage objects representing the JBOD disks array. |
C.8. KafkaListeners
schema reference
Used in: KafkaClusterSpec
Property | Description |
---|---|
plain | Configures plain listener on port 9092. |
tls | Configures TLS listener on port 9093. |
external |
Configures external listener on port 9094. The type depends on the value of the |
|
C.9. 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 |
| |
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 |
C.10. 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
, KafkaListenerAuthenticationOAuth
. It must have the value tls
for the type KafkaListenerAuthenticationTls
.
Property | Description |
---|---|
type |
Must be |
string |
C.11. 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
, KafkaListenerAuthenticationOAuth
. It must have the value scram-sha-512
for the type KafkaListenerAuthenticationScramSha512
.
Property | Description |
---|---|
type |
Must be |
string |
C.12. KafkaListenerAuthenticationOAuth
schema reference
Used in: KafkaListenerExternalIngress
, KafkaListenerExternalLoadBalancer
, KafkaListenerExternalNodePort
, KafkaListenerExternalRoute
, KafkaListenerPlain
, KafkaListenerTls
The type
property is a discriminator that distinguishes the use of the type KafkaListenerAuthenticationOAuth
from KafkaListenerAuthenticationTls
, KafkaListenerAuthenticationScramSha512
. It must have the value oauth
for the type KafkaListenerAuthenticationOAuth
.
Property | Description |
---|---|
clientId | OAuth Client ID which the Kafka broker can use to authenticate against the authorization server and use the introspect endpoint URI. |
string | |
clientSecret | Link to OpenShift Secret containing the OAuth client secret which the Kafka broker can use to authenticate against the authorization server and use the introspect endpoint URI. |
disableTlsHostnameVerification |
Enable or disable TLS hostname verification. Default value is |
boolean | |
introspectionEndpointUri | URI of the token introspection endpoint which can be used to validate opaque non-JWT tokens. |
string | |
jwksEndpointUri | URI of the JWKS certificate endpoint, which can be used for local JWT validation. |
string | |
jwksExpirySeconds |
Configures how often are the JWKS certificates considered valid. The expiry interval has to be at least 60 seconds longer then the refresh interval specified in |
integer | |
jwksRefreshSeconds |
Configures how often are the JWKS certificates refreshed. The refresh interval has to be at least 60 seconds shorter then the expiry interval specified in |
integer | |
tlsTrustedCertificates | Trusted certificates for TLS connection to the OAuth server. |
| |
type |
Must be |
string | |
userNameClaim |
Name of the claim from the authentication token which will be used as the user principal. Defaults to |
string | |
validIssuerUri | URI of the token issuer used for authentication. |
string |
C.13. GenericSecretSource
schema reference
Used in: KafkaClientAuthenticationOAuth
, KafkaListenerAuthenticationOAuth
Property | Description |
---|---|
key | The key under which the secret value is stored in the OpenShift Secret. |
string | |
secretName | The name of the OpenShift Secret containing the secret value. |
string |
C.14. CertSecretSource
schema reference
Used in: KafkaBridgeTls
, KafkaClientAuthenticationOAuth
, KafkaConnectTls
, KafkaListenerAuthenticationOAuth
, KafkaMirrorMakerTls
Property | Description |
---|---|
certificate | The name of the file certificate in the Secret. |
string | |
secretName | The name of the Secret containing the certificate. |
string |
C.15. KafkaListenerTls
schema reference
Used in: KafkaListeners
Property | Description |
---|---|
authentication |
Authentication configuration for this listener. The type depends on the value of the |
| |
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 |
C.16. 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 |
string | |
authentication |
Authentication configuration for Kafka brokers. The type depends on the value of the |
| |
overrides | Overrides for external bootstrap and broker services and externally advertised addresses. |
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 |
C.17. RouteListenerOverride
schema reference
Used in: KafkaListenerExternalRoute
Property | Description |
---|---|
bootstrap | External bootstrap service configuration. |
brokers | External broker services configuration. |
C.18. 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 |
string |
C.19. 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' |
string | |
advertisedPort |
The port number which will be used in the brokers' |
integer | |
host |
Host for the broker route. This field will be used in the |
string |
C.20. 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 |
string | |
authentication |
Authentication configuration for Kafka brokers. The type depends on the value of the |
| |
overrides | Overrides for external bootstrap and broker services and externally advertised addresses. |
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 |
boolean |
C.21. LoadBalancerListenerOverride
schema reference
Used in: KafkaListenerExternalLoadBalancer
Property | Description |
---|---|
bootstrap | External bootstrap service configuration. |
brokers | External broker services configuration. |
C.22. 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 |
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 |
string |
C.23. 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' |
string | |
advertisedPort |
The port number which will be used in the brokers' |
integer | |
dnsAnnotations |
Annotations that will be added to the |
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 |
string |
C.24. 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 |
string | |
authentication |
Authentication configuration for Kafka brokers. The type depends on the value of the |
| |
overrides | Overrides for external bootstrap and broker services and externally advertised addresses. |
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 |
boolean |
C.25. NodePortListenerOverride
schema reference
Used in: KafkaListenerExternalNodePort
Property | Description |
---|---|
bootstrap | External bootstrap service configuration. |
brokers | External broker services configuration. |
C.26. 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 |
map | |
nodePort | Node port for the bootstrap service. |
integer |
C.27. 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' |
string | |
advertisedPort |
The port number which will be used in the brokers' |
integer | |
nodePort | Node port for the broker service. |
integer | |
dnsAnnotations |
Annotations that will be added to the |
map |
C.28. 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 |
string | |
authentication |
Authentication configuration for Kafka brokers. The type depends on the value of the |
| |
class |
Configures the |
string | |
configuration | Overrides for external bootstrap and broker services and externally advertised addresses. |
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 |
C.29. IngressListenerConfiguration
schema reference
Used in: KafkaListenerExternalIngress
Property | Description |
---|---|
bootstrap | External bootstrap ingress configuration. |
brokers | External broker ingress configuration. |
C.30. 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 |
map | |
host | Host for the bootstrap route. This field will be used in the Ingress resource. |
string |
C.31. 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' |
string | |
advertisedPort |
The port number which will be used in the 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 |
map |
C.32. 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 |
string | |
superUsers | List of super users. Should contain list of user principals which should get unlimited access rights. |
string array |
C.33. Rack
schema reference
Used in: KafkaClusterSpec
Property | Description |
---|---|
topologyKey |
A key that matches labels assigned to the OpenShift cluster nodes. The value of the label is used to set the broker’s |
string |
C.34. 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 |
C.35. 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 |
C.36. ResourceRequirements
schema reference
Used in: EntityTopicOperatorSpec
, EntityUserOperatorSpec
, KafkaBridgeSpec
, KafkaClusterSpec
, KafkaConnectS2ISpec
, KafkaConnectSpec
, KafkaExporterSpec
, KafkaMirrorMakerSpec
, TlsSidecar
, TopicOperatorSpec
, ZookeeperClusterSpec
Property | Description |
---|---|
limits | |
map | |
requests | |
map |
C.37. 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 |
string | |
loggers | A Map from logger name to logger level. |
map |
C.38. 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 |
string | |
name |
The name of the |
string |
C.39. TlsSidecar
schema reference
Used in: EntityOperatorSpec
, KafkaClusterSpec
, TopicOperatorSpec
, ZookeeperClusterSpec
Property | Description |
---|---|
image | The docker image for the container. |
string | |
livenessProbe | Pod liveness checking. |
logLevel |
The log level for the TLS sidecar. Default value is |
string (one of [emerg, debug, crit, err, alert, warning, notice, info]) | |
readinessProbe | Pod readiness checking. |
resources | CPU and memory resources to reserve (limits and requests). |
C.40. KafkaClusterTemplate
schema reference
Used in: KafkaClusterSpec
Property | Description |
---|---|
statefulset |
Template for Kafka |
pod |
Template for Kafka |
bootstrapService |
Template for Kafka bootstrap |
brokersService |
Template for Kafka broker |
externalBootstrapService |
Template for Kafka external bootstrap |
perPodService |
Template for Kafka per-pod |
externalBootstrapRoute |
Template for Kafka external bootstrap |
perPodRoute |
Template for Kafka per-pod |
externalBootstrapIngress |
Template for Kafka external bootstrap |
perPodIngress |
Template for Kafka per-pod |
persistentVolumeClaim |
Template for all Kafka |
podDisruptionBudget |
Template for Kafka |
kafkaContainer | Template for the Kafka broker container. |
tlsSidecarContainer | Template for the Kafka broker TLS sidecar container. |
initContainer | Template for the Kafka init container. |
C.41. ResourceTemplate
schema reference
Used in: EntityOperatorTemplate
, KafkaBridgeTemplate
, KafkaClusterTemplate
, KafkaConnectTemplate
, KafkaExporterTemplate
, KafkaMirrorMakerTemplate
, ZookeeperClusterTemplate
Property | Description |
---|---|
metadata | Metadata which should be applied to the resource. |
C.42. 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 |
map | |
annotations |
Annotations which should be added to the resource template. Can be applied to different resources such as |
map |
C.43. PodTemplate
schema reference
Used in: EntityOperatorTemplate
, KafkaBridgeTemplate
, KafkaClusterTemplate
, KafkaConnectTemplate
, KafkaExporterTemplate
, KafkaMirrorMakerTemplate
, ZookeeperClusterTemplate
Property | Description |
---|---|
metadata | Metadata applied to the resource. |
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. |
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. |
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 |
C.44. PodDisruptionBudgetTemplate
schema reference
Used in: KafkaBridgeTemplate
, KafkaClusterTemplate
, KafkaConnectTemplate
, KafkaMirrorMakerTemplate
, ZookeeperClusterTemplate
Property | Description |
---|---|
metadata |
Metadata to apply to the |
maxUnavailable |
Maximum number of unavailable pods to allow automatic Pod eviction. A Pod eviction is allowed when the |
integer |
C.45. ContainerTemplate
schema reference
Used in: EntityOperatorTemplate
, KafkaBridgeTemplate
, KafkaClusterTemplate
, KafkaConnectTemplate
, KafkaExporterTemplate
, KafkaMirrorMakerTemplate
, ZookeeperClusterTemplate
Property | Description |
---|---|
env | Environment variables which should be applied to the container. |
|
C.46. ContainerEnvVar
schema reference
Used in: ContainerTemplate
Property | Description |
---|---|
name | The environment variable key. |
string | |
value | The environment variable value. |
string |
C.47. 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 |
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 |
tolerations |
The property |
Toleration array | |
livenessProbe | Pod liveness checking. |
readinessProbe | Pod readiness checking. |
jvmOptions | JVM Options for pods. |
resources | CPU and memory resources to reserve (limits and requests). |
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 |
tlsSidecar | TLS sidecar configuration. |
template |
Template for Zookeeper cluster resources. The template allows users to specify how are the |
C.48. ZookeeperClusterTemplate
schema reference
Used in: ZookeeperClusterSpec
Property | Description |
---|---|
statefulset |
Template for Zookeeper |
pod |
Template for Zookeeper |
clientService |
Template for Zookeeper client |
nodesService |
Template for Zookeeper nodes |
persistentVolumeClaim |
Template for all Zookeeper |
podDisruptionBudget |
Template for Zookeeper |
zookeeperContainer | Template for the Zookeeper container. |
tlsSidecarContainer | Template for the Kafka broker TLS sidecar container. |
C.49. 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. |
resources | CPU and memory resources to reserve (limits and requests). |
topicMetadataMaxAttempts | The number of attempts at getting topic metadata. |
integer | |
tlsSidecar | TLS sidecar configuration. |
logging |
Logging configuration. The type depends on the value of the |
jvmOptions | JVM Options for pods. |
livenessProbe | Pod liveness checking. |
readinessProbe | Pod readiness checking. |
C.50. EntityOperatorJvmOptions
schema reference
Used in: EntityTopicOperatorSpec
, EntityUserOperatorSpec
, TopicOperatorSpec
Property | Description |
---|---|
gcLoggingEnabled | Specifies whether the Garbage Collection logging is enabled. The default is true. |
boolean |
C.51. EntityOperatorSpec
schema reference
Used in: KafkaSpec
Property | Description |
---|---|
topicOperator | Configuration of the Topic Operator. |
userOperator | Configuration of the User Operator. |
affinity |
The property |
tolerations |
The property |
Toleration array | |
tlsSidecar | TLS sidecar configuration. |
template |
Template for Entity Operator resources. The template allows users to specify how is the |
C.52. 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. |
readinessProbe | Pod readiness checking. |
resources | CPU and memory resources to reserve (limits and requests). |
topicMetadataMaxAttempts | The number of attempts at getting topic metadata. |
integer | |
logging |
Logging configuration. The type depends on the value of the |
jvmOptions | JVM Options for pods. |
C.53. 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. |
readinessProbe | Pod readiness checking. |
resources | CPU and memory resources to reserve (limits and requests). |
logging |
Logging configuration. The type depends on the value of the |
jvmOptions | JVM Options for pods. |
C.54. EntityOperatorTemplate
schema reference
Used in: EntityOperatorSpec
Property | Description |
---|---|
deployment |
Template for Entity Operator |
pod |
Template for Entity Operator |
tlsSidecarContainer | Template for the Entity Operator TLS sidecar container. |
topicOperatorContainer | Template for the Entity Topic Operator container. |
userOperatorContainer | Template for the Entity User Operator container. |
C.55. 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 |
integer | |
certificateExpirationPolicy |
How should CA certificate expiration be handled when |
string (one of [replace-key, renew-certificate]) |
C.56. 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). |
logging |
Only log messages with the given severity or above. Valid levels: [ |
string | |
enableSaramaLogging | Enable Sarama logging, a Go client library used by the Kafka Exporter. |
boolean | |
template | Customization of deployment templates and pods. |
livenessProbe | Pod liveness check. |
readinessProbe | Pod readiness check. |
C.57. KafkaExporterTemplate
schema reference
Used in: KafkaExporterSpec
Property | Description |
---|---|
deployment |
Template for Kafka Exporter |
pod |
Template for Kafka Exporter |
service |
Template for Kafka Exporter |
container | Template for the Kafka Exporter container. |
C.58. KafkaStatus
schema reference
Used in: Kafka
Property | Description |
---|---|
conditions | List of status conditions. |
| |
observedGeneration | The generation of the CRD that was last reconciled by the operator. |
integer | |
listeners | Addresses of the internal and external listeners. |
|
C.59. 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 |
C.60. ListenerStatus
schema reference
Used in: KafkaStatus
Property | Description |
---|---|
type |
The type of the listener. Can be one of the following three types: |
string | |
addresses | A list of the addresses for this listener. |
|
C.61. 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 |
C.62. KafkaConnect
schema reference
Property | Description |
---|---|
spec | The specification of the Kafka Connect cluster. |
status | The status of the Kafka Connect cluster. |
C.63. 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. |
readinessProbe | Pod readiness checking. |
jvmOptions | JVM Options for pods. |
affinity |
The property |
tolerations |
The property |
Toleration array | |
logging |
Logging configuration for Kafka Connect. The type depends on the value of the |
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 |
template |
Template for Kafka Connect and Kafka Connect S2I resources. The template allows users to specify how is the |
authentication |
Authentication configuration for Kafka Connect. The type depends on the value of the |
| |
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. |
resources | CPU and memory resources to reserve (limits and requests). |
tls | TLS configuration. |
version | The Kafka Connect version. Defaults to 2.3.0. Consult the user documentation to understand the process required to upgrade or downgrade the version. |
string |
C.64. 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 |
string |
C.65. KafkaConnectTemplate
schema reference
Used in: KafkaConnectS2ISpec
, KafkaConnectSpec
Property | Description |
---|---|
deployment |
Template for Kafka Connect |
pod |
Template for Kafka Connect |
apiService |
Template for Kafka Connect API |
connectContainer | Template for the Kafka Connect container. |
podDisruptionBudget |
Template for Kafka Connect |
C.66. KafkaClientAuthenticationTls
schema reference
Used in: KafkaBridgeSpec
, KafkaConnectS2ISpec
, KafkaConnectSpec
, KafkaMirrorMakerConsumerSpec
, KafkaMirrorMakerProducerSpec
To use TLS client authentication, set the type
property to the value tls
. TLS client authentication uses a TLS certificate to authenticate. The certificate is specified in the certificateAndKey
property and is always loaded from an OpenShift secret. In the secret, the certificate must be stored in X509 format under two different keys: public and private.
TLS client authentication can only be used with TLS connections.
An example TLS client authentication configuration
authentication: type: tls certificateAndKey: secretName: my-secret certificate: public.crt key: private.key
The type
property is a discriminator that distinguishes the use of the type KafkaClientAuthenticationTls
from KafkaClientAuthenticationScramSha512
, KafkaClientAuthenticationPlain
, KafkaClientAuthenticationOAuth
. It must have the value tls
for the type KafkaClientAuthenticationTls
.
Property | Description |
---|---|
certificateAndKey |
Reference to the |
type |
Must be |
string |
C.67. CertAndKeySecretSource
schema reference
Used in: KafkaClientAuthenticationTls
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 |
C.68. KafkaClientAuthenticationScramSha512
schema reference
Used in: KafkaBridgeSpec
, KafkaConnectS2ISpec
, KafkaConnectSpec
, KafkaMirrorMakerConsumerSpec
, KafkaMirrorMakerProducerSpec
To configure SASL-based SCRAM-SHA-512 authentication, set the type
property to scram-sha-512
. The SCRAM-SHA-512 authentication mechanism requires a username and password.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name of theSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example SASL based SCRAM-SHA-512 client authentication configuration
authentication: type: scram-sha-512 username: my-connect passwordSecret: secretName: my-connect password: password
The type
property is a discriminator that distinguishes the use of the type KafkaClientAuthenticationScramSha512
from KafkaClientAuthenticationTls
, KafkaClientAuthenticationPlain
, KafkaClientAuthenticationOAuth
. It must have the value scram-sha-512
for the type KafkaClientAuthenticationScramSha512
.
Property | Description |
---|---|
passwordSecret |
Reference to the |
type |
Must be |
string | |
username | Username used for the authentication. |
string |
C.69. PasswordSecretSource
schema reference
Used in: KafkaClientAuthenticationPlain
, KafkaClientAuthenticationScramSha512
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 |
C.70. KafkaClientAuthenticationPlain
schema reference
Used in: KafkaBridgeSpec
, KafkaConnectS2ISpec
, KafkaConnectSpec
, KafkaMirrorMakerConsumerSpec
, KafkaMirrorMakerProducerSpec
To configure SASL-based PLAIN authentication, set the type
property to plain
. SASL PLAIN authentication mechanism requires a username and password.
The SASL PLAIN mechanism will transfer the username and password across the network in cleartext. Only use SASL PLAIN authentication if TLS encryption is enabled.
-
Specify the username in the
username
property. -
In the
passwordSecret
property, specify a link to aSecret
containing the password. ThesecretName
property contains the name of such aSecret
and thepassword
property contains the name of the key under which the password is stored inside theSecret
.
Do not specify the actual password in the password
field.
An example SASL based PLAIN client authentication configuration
authentication: type: plain username: my-connect passwordSecret: secretName: my-connect password: password
The type
property is a discriminator that distinguishes the use of the type KafkaClientAuthenticationPlain
from KafkaClientAuthenticationTls
, KafkaClientAuthenticationScramSha512
, KafkaClientAuthenticationOAuth
. It must have the value plain
for the type KafkaClientAuthenticationPlain
.
Property | Description |
---|---|
passwordSecret |
Reference to the |
type |
Must be |
string | |
username | Username used for the authentication. |
string |
C.71. KafkaClientAuthenticationOAuth
schema reference
Used in: KafkaBridgeSpec
, KafkaConnectS2ISpec
, KafkaConnectSpec
, KafkaMirrorMakerConsumerSpec
, KafkaMirrorMakerProducerSpec
To use OAuth client authentication, set the type
property to the value oauth
. OAuth authentication can be configured using:
- Client ID and secret
- Client ID and refresh token
- Access token
- TLS
Client ID and secret
You can configure the address of your authorization server in the tokenEndpointUri
property together with the client ID and client secret used in authentication. The OAuth client will connect to the OAuth server, authenticate using the client ID and secret and get an access token which it will use to authenticate with the Kafka broker. In the clientSecret
property, specify a link to a Secret
containing the client secret.
An example of OAuth client authentication using client ID and client secret
authentication: type: oauth tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token clientId: my-client-id clientSecret: secretName: my-client-oauth-secret key: client-secret
Client ID and refresh token
You can configure the address of your OAuth server in the tokenEndpointUri
property together with the OAuth client ID and refresh token. The OAuth client will connect to the OAuth server, authenticate using the client ID and refresh token and get an access token which it will use to authenticate with the Kafka broker. In the refreshToken
property, specify a link to a Secret
containing the refresh token.
An example of OAuth client authentication using client ID and refresh token
authentication: type: oauth tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token clientId: my-client-id refreshToken: secretName: my-refresh-token-secret key: refresh-token
Access token
You can configure the access token used for authentication with the Kafka broker directly. In this case, you do not specify the tokenEndpointUri
. In the accessToken
property, specify a link to a Secret
containing the access token.
An example of OAuth client authentication using only an access token
authentication: type: oauth accessToken: secretName: my-access-token-secret key: access-token
TLS
Accessing the OAuth server using the HTTPS protocol does not require any additional configuration as long as the TLS certificates used by it are signed by a trusted certification authority and its hostname is listed in the certificate.
If your OAuth server is using certificates which are self-signed or are signed by a certification authority which is not trusted, you can configure a list of trusted certificates in the custom resoruce. The tlsTrustedCertificates
property contains a list of secrets with key names under which the certificates are stored. The certificates must be stored in X509 format.
An example of TLS certificates provided
authentication: type: oauth tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token clientId: my-client-id refreshToken: secretName: my-refresh-token-secret key: refresh-token tlsTrustedCertificates: - secretName: oauth-server-ca certificate: tls.crt
The OAuth client will by default verify that the hostname of your OAuth server matches either the certificate subject or one of the alternative DNS names. If it is not required, you can disable the hostname verification.
An example of disabled TLS hostname verification
authentication: type: oauth tokenEndpointUri: https://sso.myproject.svc:8443/auth/realms/internal/protocol/openid-connect/token clientId: my-client-id refreshToken: secretName: my-refresh-token-secret key: refresh-token disableTlsHostnameVerification: true
The type
property is a discriminator that distinguishes the use of the type KafkaClientAuthenticationOAuth
from KafkaClientAuthenticationTls
, KafkaClientAuthenticationScramSha512
, KafkaClientAuthenticationPlain
. It must have the value oauth
for the type KafkaClientAuthenticationOAuth
.
Property | Description |
---|---|
accessToken | Link to OpenShift Secret containing the access token which was obtained from the authorization server. |
clientId | OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI. |
string | |
clientSecret | Link to OpenShift Secret containing the OAuth client secret which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI. |
disableTlsHostnameVerification |
Enable or disable TLS hostname verification. Default value is |
boolean | |
refreshToken | Link to OpenShift Secret containing the refresh token which can be used to obtain access token from the authorization server. |
tlsTrustedCertificates | Trusted certificates for TLS connection to the OAuth server. |
| |
tokenEndpointUri | Authorization server token endpoint URI. |
string | |
type |
Must be |
string |
C.72. 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. |
| |
volumes | Allows to pass data from Secret or ConfigMap to the Kafka Connect pods as volumes. |
C.73. 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 |
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. |
C.74. ExternalConfigurationEnvVarSource
schema reference
Used in: ExternalConfigurationEnv
Property | Description |
---|---|
configMapKeyRef | Refernce to a key in a ConfigMap. See external documentation of core/v1 configmapkeyselector. |
secretKeyRef | Reference to a key in a Secret. See external documentation of core/v1 secretkeyselector. |
C.75. 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. |
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. |
C.76. KafkaConnectTls
schema reference
Used in: KafkaConnectS2ISpec
, KafkaConnectSpec
Property | Description |
---|---|
trustedCertificates | Trusted certificates for TLS connection. |
|
C.77. KafkaConnectStatus
schema reference
Used in: KafkaConnect
Property | Description |
---|---|
conditions | List of status conditions. |
| |
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 |
C.78. KafkaConnectS2I
schema reference
Property | Description |
---|---|
spec | The specification of the Kafka Connect Source-to-Image (S2I) cluster. |
status | The status of the Kafka Connect Source-to-Image (S2I) cluster. |
C.79. 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. |
readinessProbe | Pod readiness checking. |
jvmOptions | JVM Options for pods. |
affinity |
The property |
logging |
Logging configuration for Kafka Connect. The type depends on the value of the |
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 |
authentication |
Authentication configuration for Kafka Connect. The type depends on the value of the |
| |
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. |
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). |
tls | TLS configuration. |
tolerations |
The property |
Toleration array | |
tracing |
The configuration of tracing in Kafka Connect. The type depends on the value of the |
version | The Kafka Connect version. Defaults to 2.3.0. Consult the user documentation to understand the process required to upgrade or downgrade the version. |
string |
C.80. KafkaConnectS2Istatus
schema reference
Used in: KafkaConnectS2I
Property | Description |
---|---|
conditions | List of status conditions. |
| |
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 |
C.81. KafkaTopic
schema reference
Property | Description |
---|---|
spec | The specification of the topic. |
status | The status of the topic. |
C.82. 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 OpenShift resource name. |
string |
C.83. KafkaTopicStatus
schema reference
Used in: KafkaTopic
Property | Description |
---|---|
conditions | List of status conditions. |
| |
observedGeneration | The generation of the CRD that was last reconciled by the operator. |
integer |
C.84. KafkaUser
schema reference
Property | Description |
---|---|
spec | The specification of the user. |
status | The status of the Kafka User. |
C.85. KafkaUserSpec
schema reference
Used in: KafkaUser
Property | Description |
---|---|
authentication |
Authentication mechanism enabled for this Kafka user. The type depends on the value of the |
| |
authorization |
Authorization rules for this Kafka user. The type depends on the value of the |
C.86. 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 |
string |
C.87. 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 |
string |
C.88. 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 |
string | |
acls | List of ACL rules which should be applied to this user. |
|
C.89. 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 |
| |
type |
The type of the rule. Currently the only supported type is |
string (one of [allow, deny]) |
C.90. 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 |
string | |
name |
Name of resource for which given ACL rule applies. Can be combined with |
string | |
patternType |
Describes the pattern used in the resource field. The supported types are |
string (one of [prefix, literal]) |
C.91. 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 |
string | |
name |
Name of resource for which given ACL rule applies. Can be combined with |
string | |
patternType |
Describes the pattern used in the resource field. The supported types are |
string (one of [prefix, literal]) |
C.92. 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 |
string |
C.93. 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 |
string | |
name |
Name of resource for which given ACL rule applies. Can be combined with |
string | |
patternType |
Describes the pattern used in the resource field. The supported types are |
string (one of [prefix, literal]) |
C.94. KafkaUserStatus
schema reference
Used in: KafkaUser
Property | Description |
---|---|
conditions | List of status conditions. |
| |
observedGeneration | The generation of the CRD that was last reconciled by the operator. |
integer | |
username | Username. |
string | |
secret |
The name of |
string |
C.95. KafkaMirrorMaker
schema reference
Property | Description |
---|---|
spec | The specification of Kafka Mirror Maker. |
status | The status of Kafka Mirror Maker. |
C.96. KafkaMirrorMakerSpec
schema reference
Used in: KafkaMirrorMaker
Property | Description |
---|---|
replicas |
The number of pods in the |
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 |
string | |
consumer | Configuration of source cluster. |
producer | Configuration of target cluster. |
resources | CPU and memory resources to reserve (limits and requests). |
affinity |
The property |
tolerations |
The property |
Toleration array | |
jvmOptions | JVM Options for pods. |
logging |
Logging configuration for Mirror Maker. The type depends on the value of the |
metrics | The Prometheus JMX Exporter configuration. See JMX Exporter documentation 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 |
template |
Template to specify how Kafka Mirror Maker resources, |
livenessProbe | Pod liveness checking. |
readinessProbe | Pod readiness checking. |
version | The Kafka Mirror Maker version. Defaults to 2.3.0. Consult the documentation to understand the process required to upgrade or downgrade the version. |
string |
C.97. 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 |
| |
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. |
C.98. KafkaMirrorMakerTls
schema reference
Used in: KafkaMirrorMakerConsumerSpec
, KafkaMirrorMakerProducerSpec
Use the tls
property to configure TLS encryption. Provide a list of secrets with key names under which the certificates are stored in X.509 format.
An example TLS encryption configuration
tls: trustedCertificates: - secretName: my-cluster-cluster-ca-cert certificate: ca.crt
Property | Description |
---|---|
trustedCertificates | Trusted certificates for TLS connection. |
|
C.99. 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 |
boolean | |
authentication |
Authentication configuration for connecting to the cluster. The type depends on the value of the |
| |
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. |
C.100. KafkaMirrorMakerTemplate
schema reference
Used in: KafkaMirrorMakerSpec
Property | Description |
---|---|
deployment |
Template for Kafka Mirror Maker |
pod |
Template for Kafka Mirror Maker |
mirrorMakerContainer | Template for Kafka Mirror Maker container. |
podDisruptionBudget |
Template for Kafka Mirror Maker |
C.101. KafkaMirrorMakerStatus
schema reference
Used in: KafkaMirrorMaker
Property | Description |
---|---|
conditions | List of status conditions. |
| |
observedGeneration | The generation of the CRD that was last reconciled by the operator. |
integer |
C.102. KafkaBridge
schema reference
Property | Description |
---|---|
spec | The specification of the Kafka Bridge. |
status | The status of the Kafka Bridge. |
C.103. KafkaBridgeSpec
schema reference
Used in: KafkaBridge
Property | Description |
---|---|
replicas |
The number of pods in the |
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. |
authentication |
Authentication configuration for connecting to the cluster. The type depends on the value of the |
| |
http | The HTTP related configuration. |
consumer | Kafka consumer related configuration. |
producer | Kafka producer related configuration. |
resources | CPU and memory resources to reserve (limits and requests). |
jvmOptions | Currently not supported JVM Options for pods. |
logging |
Logging configuration for Kafka Bridge. The type depends on the value of the |
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. |
readinessProbe | Pod readiness checking. |
template |
Template for Kafka Bridge resources. The template allows users to specify how is the |
C.104. KafkaBridgeTls
schema reference
Used in: KafkaBridgeSpec
Property | Description |
---|---|
trustedCertificates | Trusted certificates for TLS connection. |
|
C.105. KafkaBridgeHttpConfig
schema reference
Used in: KafkaBridgeSpec
Property | Description |
---|---|
port | The port which is the server listening on. |
integer |
C.106. 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 |
C.107. 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 |
C.108. KafkaBridgeTemplate
schema reference
Used in: KafkaBridgeSpec
Property | Description |
---|---|
deployment |
Template for Kafka Bridge |
pod |
Template for Kafka Bridge |
apiService |
Template for Kafka Bridge API |
bridgeContainer | Template for the Kafka Bridge container. |
podDisruptionBudget |
Template for Kafka Bridge |
C.109. KafkaBridgeStatus
schema reference
Used in: KafkaBridge
Property | Description |
---|---|
conditions | List of status conditions. |
| |
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 |
Appendix D. Using Your Subscription
AMQ Streams is provided through a software subscription. To manage your subscriptions, access your account at the Red Hat Customer Portal.
Accessing Your Account
- Go to access.redhat.com.
- If you do not already have an account, create one.
- Log in to your account.
Activating a Subscription
- Go to access.redhat.com.
- Navigate to My Subscriptions.
- Navigate to Activate a subscription and enter your 16-digit activation number.
Downloading Zip and Tar Files
To access zip or tar files, use the customer portal to find the relevant files for download. If you are using RPM packages, this step is not required.
- Open a browser and log in to the Red Hat Customer Portal Product Downloads page at access.redhat.com/downloads.
- Locate the Red Hat AMQ Streams entries in the JBOSS INTEGRATION AND AUTOMATION category.
- Select the desired AMQ Streams product. The Software Downloads page opens.
- Click the Download link for your component.
Revised on 2019-11-25 08:00:53 UTC