ホーム
製品
Streams for Apache Kafka
2.8
Deploying and Managing Streams for Apache Kafka on OpenShift
7.2. Deploying the Cluster Operator

7.2. Deploying the Cluster Operator

The first step for any deployment of Streams for Apache Kafka is to install the Cluster Operator, which is responsible for deploying and managing Kafka clusters within an OpenShift cluster. A single command applies all the installation files in the install/cluster-operator folder: oc apply -f ./install/cluster-operator.

The command sets up everything you need to be able to create and manage a Kafka deployment, including the following resources:

Cluster Operator (Deployment, ConfigMap)
Streams for Apache Kafka CRDs (CustomResourceDefinition)
RBAC resources (ClusterRole, ClusterRoleBinding, RoleBinding)
Service account (ServiceAccount)

Cluster-scoped resources like CustomResourceDefinition, ClusterRole, and ClusterRoleBinding require administrator privileges for installation. Prior to installation, it’s advisable to review the ClusterRole specifications to ensure they do not grant unnecessary privileges.

After installation, the Cluster Operator runs as a regular Deployment to watch for updates of Kafka resources. Any standard (non-admin) OpenShift user with privileges to access the Deployment can configure it. A cluster administrator can also grant standard users the privileges necessary to manage Streams for Apache Kafka custom resources.

By default, a single replica of the Cluster Operator is deployed. You can add replicas with leader election so that additional Cluster Operators are on standby in case of disruption. For more information, see 「Running multiple Cluster Operator replicas with leader election」.

7.2.1. Specifying the namespaces the Cluster Operator watches
リンクのコピー

The Cluster Operator watches for updates in the namespaces where the Kafka resources are deployed. When you deploy the Cluster Operator, you specify which namespaces to watch in the OpenShift cluster. You can specify the following namespaces:

A single selected namespace (the same namespace containing the Cluster Operator)
Multiple selected namespaces
All namespaces in the cluster

Watching multiple selected namespaces has the most impact on performance due to increased processing overhead. To optimize performance for namespace monitoring, it is generally recommended to either watch a single namespace or monitor the entire cluster. Watching a single namespace allows for focused monitoring of namespace-specific resources, while monitoring all namespaces provides a comprehensive view of the cluster’s resources across all namespaces.

The Cluster Operator watches for changes to the following resources:

Kafka for the Kafka cluster.
KafkaConnect for the Kafka Connect cluster.
KafkaConnector for creating and managing connectors in a Kafka Connect cluster.
KafkaMirrorMaker for the Kafka MirrorMaker instance.
KafkaMirrorMaker2 for the Kafka MirrorMaker 2 instance.
KafkaBridge for the Kafka Bridge instance.
KafkaRebalance for the Cruise Control optimization requests.

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 Deployments, Pods, 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.

注記

While the Cluster Operator can watch one, multiple, or all namespaces in an OpenShift cluster, the Topic Operator and User Operator watch for KafkaTopic and KafkaUser resources in a single namespace. For more information, see 「Watching Streams for Apache Kafka resources in OpenShift namespaces」.

7.2.2. Deploying the Cluster Operator to watch a single namespace
リンクのコピー

This procedure shows how to deploy the Cluster Operator to watch Streams for Apache Kafka resources in a single namespace in your OpenShift cluster.

Prerequisites

You need an account with permission to create and manage CustomResourceDefinition and RBAC (ClusterRole, and RoleBinding) resources.

Procedure

Edit the Streams for Apache Kafka installation files to use the namespace the Cluster Operator is going to be installed into.
For example, in this procedure the Cluster Operator is installed into the namespace my-cluster-operator-namespace.
On Linux, use:
```
sed -i 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml
```
On MacOS, use:
```
sed -i '' 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml
```

Deploy the Cluster Operator:

oc create -f install/cluster-operator -n my-cluster-operator-namespace

Check the status of the deployment:
```
oc get deployments -n my-cluster-operator-namespace
```
Output shows the deployment name and readiness
```
NAME                      READY  UP-TO-DATE  AVAILABLE
strimzi-cluster-operator  1/1    1           1
```
READY shows the number of replicas that are ready/expected. The deployment is successful when the AVAILABLE output shows 1.

7.2.3. Deploying the Cluster Operator to watch multiple namespaces
リンクのコピー

This procedure shows how to deploy the Cluster Operator to watch Streams for Apache Kafka resources across multiple namespaces in your OpenShift cluster.

Prerequisites

You need an account with permission to create and manage CustomResourceDefinition and RBAC (ClusterRole, and RoleBinding) resources.

Procedure

Edit the Streams for Apache Kafka installation files to use the namespace the Cluster Operator is going to be installed into.
For example, in this procedure the Cluster Operator is installed into the namespace my-cluster-operator-namespace.
On Linux, use:
```
sed -i 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml
```
On MacOS, use:
```
sed -i '' 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml
```

Edit the install/cluster-operator/060-Deployment-strimzi-cluster-operator.yaml file to add a list of all the namespaces the Cluster Operator will watch to the STRIMZI_NAMESPACE environment variable.

For example, in this procedure the Cluster Operator will watch the namespaces watched-namespace-1, watched-namespace-2, watched-namespace-3.

apiVersion: apps/v1
kind: Deployment
spec:
  # ...
  template:
    spec:
      serviceAccountName: strimzi-cluster-operator
      containers:
      - name: strimzi-cluster-operator
        image: registry.redhat.io/amq-streams/strimzi-rhel9-operator:2.8.0
        imagePullPolicy: IfNotPresent
        env:
        - name: STRIMZI_NAMESPACE
          value: watched-namespace-1,watched-namespace-2,watched-namespace-3

For each namespace listed, install the RoleBindings.

In this example, we replace watched-namespace in these commands with the namespaces listed in the previous step, repeating them for watched-namespace-1, watched-namespace-2, watched-namespace-3:

oc create -f install/cluster-operator/020-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
oc create -f install/cluster-operator/023-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
oc create -f install/cluster-operator/031-RoleBinding-strimzi-cluster-operator-entity-operator-delegation.yaml -n <watched_namespace>

Deploy the Cluster Operator:

oc create -f install/cluster-operator -n my-cluster-operator-namespace

Check the status of the deployment:
```
oc get deployments -n my-cluster-operator-namespace
```
Output shows the deployment name and readiness
```
NAME                      READY  UP-TO-DATE  AVAILABLE
strimzi-cluster-operator  1/1    1           1
```
READY shows the number of replicas that are ready/expected. The deployment is successful when the AVAILABLE output shows 1.

7.2.4. Deploying the Cluster Operator to watch all namespaces
リンクのコピー

This procedure shows how to deploy the Cluster Operator to watch Streams for Apache Kafka 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

You need an account with permission to create and manage CustomResourceDefinition and RBAC (ClusterRole, and RoleBinding) resources.

Procedure

Edit the Streams for Apache Kafka installation files to use the namespace the Cluster Operator is going to be installed into.
For example, in this procedure the Cluster Operator is installed into the namespace my-cluster-operator-namespace.
On Linux, use:
```
sed -i 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml
```
On MacOS, use:
```
sed -i '' 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml
```

Edit the install/cluster-operator/060-Deployment-strimzi-cluster-operator.yaml file to 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/amq-streams/strimzi-rhel9-operator:2.8.0
        imagePullPolicy: IfNotPresent
        env:
        - name: STRIMZI_NAMESPACE
          value: "*"
        # ...

Create ClusterRoleBindings that grant cluster-wide access for all namespaces to the Cluster Operator.

oc create clusterrolebinding strimzi-cluster-operator-namespaced --clusterrole=strimzi-cluster-operator-namespaced --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator
oc create clusterrolebinding strimzi-cluster-operator-watched --clusterrole=strimzi-cluster-operator-watched --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator
oc create clusterrolebinding strimzi-cluster-operator-entity-operator-delegation --clusterrole=strimzi-entity-operator --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator

Deploy the Cluster Operator to your OpenShift cluster.

oc create -f install/cluster-operator -n my-cluster-operator-namespace

Check the status of the deployment:
```
oc get deployments -n my-cluster-operator-namespace
```
Output shows the deployment name and readiness
```
NAME                      READY  UP-TO-DATE  AVAILABLE
strimzi-cluster-operator  1/1    1           1
```
READY shows the number of replicas that are ready/expected. The deployment is successful when the AVAILABLE output shows 1.

7.2. Deploying the Cluster Operator

7.2.1. Specifying the namespaces the Cluster Operator watches
リンクのコピー

7.2.2. Deploying the Cluster Operator to watch a single namespace
リンクのコピー

7.2.3. Deploying the Cluster Operator to watch multiple namespaces
リンクのコピー

7.2.4. Deploying the Cluster Operator to watch all namespaces
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

会社概要

多様性を受け入れるオープンソースの強化

Red Hat ドキュメントについて

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

7.2. Deploying the Cluster Operator

7.2.1. Specifying the namespaces the Cluster Operator watchesリンクのコピーリンクがクリップボードにコピーされました!

7.2.2. Deploying the Cluster Operator to watch a single namespaceリンクのコピーリンクがクリップボードにコピーされました!

7.2.3. Deploying the Cluster Operator to watch multiple namespacesリンクのコピーリンクがクリップボードにコピーされました!

7.2.4. Deploying the Cluster Operator to watch all namespacesリンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

会社概要

多様性を受け入れるオープンソースの強化

Red Hat ドキュメントについて

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

7.2.1. Specifying the namespaces the Cluster Operator watches
リンクのコピー

7.2.2. Deploying the Cluster Operator to watch a single namespace
リンクのコピー

7.2.3. Deploying the Cluster Operator to watch multiple namespaces
リンクのコピー

7.2.4. Deploying the Cluster Operator to watch all namespaces
リンクのコピー