Installation overview

Get started with installing Cloudera Streams Messaging - Kubernetes Operator. Learn about available installation methods, the installation artifacts, and where these artifacts are hosted.

Installing Cloudera Streams Messaging - Kubernetes Operator involves installing Strimzi and Cloudera Surveyor for Apache Kafka. Strimzi enables the deployment and management of Kafka and Kafka Connect clusters on Kubernetes, while Cloudera Surveyor is a UI application designed for monitoring and managing Kafka clusters.

Both Strimzi and Cloudera Surveyor can be installed using Helm. The two components are independent and if you are installing with Helm, you can choose to install only Strimzi or only Cloudera Surveyor. Whether you choose to install one or both components depends on your use case and operational objectives. Cloudera recommends installing both.

If you are on OpenShift, you can choose to install from OperatorHub as well. However, note that Cloudera Surveyor is not available for installation from OperatorHub. An installation from OperatorHub will only install Strimzi.

Installation artifacts and artifact locations

Cloudera Streams Messaging - Kubernetes Operator ships with various installation artifacts. These artifacts are hosted at two locations, the Cloudera Docker registry and the Cloudera Archive.

Both the Cloudera Docker registry and the Cloudera Archive require Cloudera credentials (username and password) for access. Credentials are provided to you as part of your license and subscription agreement. You can access both the registry and the archive using the same credentials.

Cloudera Docker registry – container.repository.cloudera.com

The Docker registry hosts the Helm chart as well as all Docker images used for installation. This includes Strimzi and Kafka, as well as Cloudera Surveyor artifacts.

Table 1. Strimzi and Kafka artifacts on the Cloudera Docker registry
Artifact	Location	Description
Strimzi Docker image	`container.repository.cloudera.com/cloudera/kafka-operator:0.45.0.1.4.0-b199`	Docker image used for deploying Strimzi and its components.
Kafka Docker image	`container.repository.cloudera.com/cloudera/kafka:0.45.0.1.4.0-199-kafka-3.9.0.1.4`	Docker image used for deploying Kafka and related components.
Strimzi Cluster Operator Helm chart	`oci://container.repository.cloudera.com/cloudera-helm/csm-operator/strimzi-kafka-operator:1.4.0-b199`	Helm chart used to install the Strimzi Cluster Operator with `helm install`.

Table 2. Cloudera Surveyor artifacts on the Cloudera Docker registry
Artifact	Location	Description
Cloudera Surveyor server Docker image	`container.repository.cloudera.com/cloudera/surveyor:0.1.0.1.4.0-b199`	Docker image used for deploying Cloudera Surveyor.
Cloudera Surveyor UI application Docker image	`container.repository.cloudera.com/cloudera/surveyor-app:0.1.0.1.4.0-b199`	Docker image used for deploying Cloudera Surveyor.
Cloudera Surveyor Helm chart	`oci://container.repository.cloudera.com/cloudera-helm/csm-operator/surveyor:1.4.0-b199`	Helm chart used to install Cloudera Surveyor with `helm-install`.

Cloudera Archive – archive.cloudera.com/p/csm-operator/

The Cloudera Archive hosts various installation artifacts including Helm charts, configuration examples, a YAML file containing all CRDs, diagnostic tools, and the maven artifacts.

Accessing the Cloudera Archive and the artifacts it hosts is not necessary to complete installation. All artifacts on the archive are supplemental resources. The following table collects the Cloudera Streams Messaging - Kubernetes Operator directories located in the archive with an overview of what artifacts they contain and how you can use them.

Table 3. Cloudera Streams Messaging - Kubernetes Operator directories on the Cloudera Archive
Archive Directory	Description
https://archive.cloudera.com/p/csm-operator/1.4/charts/	The charts directory contains the Helm charts for both Strimzi and Cloudera Surveyor. These are the same charts that are available on the Docker registry. Cloudera recommends that whenever possible you install with the charts hosted on the registry. The charts on the archive are provided in case you cannot access the registry or want to download the chart using a browser.
https://archive.cloudera.com/p/csm-operator/1.4/examples/	The examples directory includes various examples of resource configuration files. You can use these to quickly deploy Kafka and other components in Kubernetes following installation.
https://archive.cloudera.com/p/csm-operator/1.4/install/	The install directory contains a single YAML file that collects all Strimzi Cluster Operator CRDs. The purpose of this file is twofold. One, the CRDs are rich in comments. Reviewing them can help you better understand how Kafka is deployed and managed with Strimzi in Cloudera Streams Messaging - Kubernetes Operator. It is a supplemental resource to the documentation. Two, this file is used to upgrade CRDs during upgrades. The CRDs are also included in the Strimzi Cluster Operator Helm chart, and Helm will automatically install the necessary CRDs to Kubernetes. You do not need to install them separately with the file hosted on the archive.
https://archive.cloudera.com/p/csm-operator/1.4/maven-repository/	The maven artifacts can be used to develop your own applications or tools for use with Cloudera Streams Messaging - Kubernetes Operator.
https://archive.cloudera.com/p/csm-operator/1.4/tools/	The tools directory contains command line tools that you use to collect diagnostic information and to troubleshoot cluster issues.