Chapter 4. Deploying AMQ Streams from the OperatorHub

Use the Red Hat Integration - AMQ Streams Operator to deploy AMQ Streams from the OperatorHub.

The procedures in this section show how to:

4.1. Using the Red Hat Integration Operator to install the AMQ Streams Operator

The Red Hat Integration Operator allows you to choose and install the Operators that manage your Red Hat Integration components. If you have more than one Red Hat Integration subscription, you can use the Red Hat Integration Operator to install and update the AMQ Streams Operator, as well as the Operators for all subscribed Red Hat Integration components.

As with the AMQ Streams Operator, you can use the Operator Lifecycle Manager (OLM) to install the Red Hat Integration Operator on an OpenShift Container Platform (OCP) cluster from the OperatorHub in the OCP console.

Additional resources

For more information on installing and using the Red Hat Integration Operator, see Installing the Red Hat Integration Operator on OpenShift.

4.2. Deploying the AMQ Streams Operator from the OperatorHub

You can deploy the Cluster Operator to your OpenShift cluster by installing the AMQ Streams Operator from the OperatorHub.

Warning

Make sure you use the appropriate update channel. If you are on a supported version of the OpenShift, installing AMQ Streams from the default stable channel is safe. However, if you are using a version of the OpenShift that is unsupported, installing AMQ Streams from the stable channel is unsafe, especially when automatic updates are enabled, as the cluster will receive automatic updates with new components that are unsupported by the OpenShift release.

Prerequisites

  • The Red Hat Operators OperatorSource is enabled in your OpenShift cluster. If you can see Red Hat Operators in the OperatorHub, the correct OperatorSource is enabled. For more information, see the Operators guide.
  • Installation requires a user with sufficient privileges to install Operators from the OperatorHub.

Procedure

  1. In the OpenShift web console, click Operators > OperatorHub.
  2. Search or browse for the AMQ Streams Operator, in the Streaming & Messaging category.
  3. Click the Red Hat Integration - AMQ Streams Operator tile and then, in the sidebar on the right, click Install.
  4. On the Create Operator Subscription screen, choose from the following installation and update options:

    • Update Channel: Choose the update channel for the AMQ Streams Operator.

      • The (default) stable channel contains all the latest updates and releases, including major, minor, and micro releases, which are assumed to be well tested and stable.
      • An amq-streams-X.x channel contains the minor and micro release updates for a major release, where X is the major release version number.
      • An amq-streams-X.Y.x channel contains the micro release updates for a minor release, where X is the major release version number and Y is the minor release version number.
    • Installation Mode: Choose to install the AMQ Streams Operator to all namespaces in the cluster (the default option) or a specific namespace. It is good practice to use namespaces to separate functions. We recommend that you dedicate a specific namespace to the Kafka cluster and other AMQ Streams components.
    • Approval Strategy: By default, the AMQ Streams Operator is automatically upgraded to the latest AMQ Streams version by the Operator Lifecycle Manager (OLM). Optionally, select Manual if you want to manually approve future upgrades. For more information, see the Operators guide in the OpenShift documentation.
  5. Click Subscribe; the AMQ Streams Operator is installed to your OpenShift cluster.

    The AMQ Streams Operator deploys the Cluster Operator, CRDs, and role-based access control (RBAC) resources to the selected namespace, or to all namespaces.

  6. On the Installed Operators screen, check the progress of the installation. The AMQ Streams Operator is ready to use when its status changes to InstallSucceeded.

Next, you can use the AMQ Streams Operator to deploy the Kafka components, starting with a Kafka cluster.

4.3. Deploying Kafka components using the AMQ Streams Operator

When installed on an Openshift Container Platform, the AMQ Streams Operator makes Kafka components available for installation from the user interface.

Kafka components available for installation:

  • Kafka
  • Kafka Connect
  • Kafka Connect Source to Image (S2I)
  • Kafka MirrorMaker
  • Kafka MirrorMaker 2
  • Kafka Topic
  • Kafka User
  • Kafka Bridge
  • Kafka Connector
  • Kafka Rebalance

Prerequisites

Procedure

  1. Navigate to Installed Operators and click Red Hat Integration - AMQ Streams Operator to display the Operator details page.
  2. From Provided APIs, click Create Instance for the Kafka component you wish to install.

    The default configuration for each component is encapsulated in a CRD spec property.

  3. (Optional) Configure the installation specification from the form or YAML views before you perform the installation.
  4. Click Create to start the installation of the selected component.

    Wait until the status changes to Succeeded.