Chapter 7. Red Hat Integration Operators

Red Hat Integration provides Operators to automate the deployment of Red Hat Integration components on OpenShift. You can use the Red Hat Integration Operator to manage multiple component Operators. Alternatively, you can manage each component Operator individually. This section introduces Operators and provides links to detailed information on how to use Operators to deploy Red Hat Integration components.

7.1. What Operators are

Operators are a method of packaging, deploying, and managing a Kubernetes application. They take human operational knowledge and encode it into software that is more easily shared with consumers to automate common or complex tasks.

In OpenShift Container Platform 4.x, the Operator Lifecycle Manager (OLM) helps users install, update, and generally manage the life cycle of all Operators and their associated services running across their clusters. It is part of the Operator Framework, an open source toolkit designed to manage Kubernetes native applications (Operators) in an effective, automated, and scalable way.

The OLM runs by default in OpenShift Container Platform 4.x, which aids cluster administrators in installing, upgrading, and granting access to Operators running on their cluster. The OpenShift Container Platform web console provides management screens for cluster administrators to install Operators, as well as grant specific projects access to use the catalog of Operators available on the cluster.

OperatorHub is the graphical interface that OpenShift cluster administrators use to discover, install, and upgrade Operators. With one click, these Operators can be pulled from OperatorHub, installed on the cluster, and managed by the OLM, ready for engineering teams to self-service manage the software in development, test, and production environments.

Additional resources

7.2. Red Hat Integration Operator

You can use Red Hat Integration Operator 1.2 to install and upgrade multiple Red Hat Integration component Operators:

  • 3scale
  • 3scale APIcast
  • AMQ Broker
  • AMQ Interconnect
  • AMQ Streams
  • API Designer
  • Camel K
  • Fuse Console
  • Fuse Online
  • Service Registry

7.2.1. Supported components

Before installing the Operators using Red Hat Integration Operator 1.2, check the updates in the Release Notes of the components. The Release Notes for the supported version describe any additional upgrade requirements.

AMQ Streams new API version

Red Hat Integration Operator 1.1 installed the Operator for AMQ Streams 1.7. Red Hat Integration Operator 1.2 installs the Operator for AMQ Streams 1.8.

You must upgrade your custom resources to use API version v1beta2 before upgrading to AMQ Streams version 1.8.

AMQ Streams 1.7 introduced the v1beta2 API version, which updates the schemas of the AMQ Streams custom resources. Older API versions are now deprecated. After you have upgraded to AMQ Streams 1.7, and before you upgrade to AMQ Streams 1.8, you must upgrade your custom resources to use API version v1beta2.

If you are upgrading from an AMQ Streams version prior to version 1.7:

  1. Upgrade to AMQ Streams 1.7
  2. Convert the custom resources to v1beta2
  3. Upgrade to AMQ Streams 1.8

For more information, refer to the following documentation:

Warning

Upgrade of the AMQ Streams Operator to version 1.8 will fail in clusters if custom resources and CRDs haven’t been converted to version v1beta2. The upgrade will be stuck on Pending. If this happens, do the following:

  1. Perform the steps described in the Red Hat Solution, Forever pending cluster operator upgrade.
  2. Scale the Integration Operator to zero, and then back to one, to trigger an installation of the AMQ Streams Operator 1.8

Service Registry 2.0 migration

Red Hat Integration Operator installs Red Hat Integration - Service Registry 2.0.

Service Registry 2.0 does not replace Service Registry 1.x installations, which need to be manually uninstalled.

For information on migrating from Service Registry version 1.x to 2.0, see the Service Registry 2.0 release notes.

7.2.2. Upgrading the AMQ Broker Operator

AMQ Broker now uses a new operator called AMQ Broker for RHEL 8 (Multiarch). Red Hat Integration Operator cannot make an automatic upgrade to the new Operator from the old one.

Instead, you need to perform the following steps to switch to the new Operator.

  1. Log in to the OpenShift Container Platform web console as a cluster administrator.

  2. Temporarily disable the AMQ Broker Operator in the Installation custom resource.

    1. In the left navigation menu, click Operators → Installed Operators.
    2. Click the Red Hat Integration Operator → Installation tab → rhi-installation → YAML tab.
    3. Locate the amq-broker-installation field and set the enabled property to false.

  3. Delete the main custom resource instance for the broker deployment in your project. This action deletes the broker deployment.

    1. In the left navigation menu, click Administration → Custom Resource Definitions.
    2. On the Custom Resource Definitions page, click the ActiveMQArtemis CRD.
    3. Click the Instances tab.
    4. Locate the custom resource instance that corresponds to your project namespace.
    5. For your custom resource instance, click the More Options icon (three vertical dots) on the right-hand side.
    6. Select Delete ActiveMQArtemis.

  4. Uninstall the existing AMQ Broker Operator from your project.

    1. In the left navigation menu, click Operators → Installed Operators.
    2. From the Project drop-down menu at the top of the page, select the project in which you want to uninstall the Operator.
    3. Locate the Red Hat Integration - AMQ Broker instance that you want to uninstall.
    4. For your Operator instance, click the More Options icon (three vertical dots) on the right-hand side.
    5. Select Uninstall Operator.
    6. On the confirmation dialog box, click Uninstall.
  5. Re-enable the AMQ Broker Operator in the Installation custom resource. Optionally, also change the mode to 'cluster'. This action will trigger the installation of the AMQ Broker for RHEL 8 (Multiarch) operator.

  6. To recreate your previous broker deployment, create a new custom resource YAML file to match the purpose of your original custom resource and apply it.

    You can base the new custom resource configuration on the sample broker_activemqartemis_cr.yaml file. For more information, refer to Deploying a basic broker instance.

7.2.3. Support life cycle

To remain in a supported configuration, you must deploy the latest Red Hat Integration Operator version. Each Red Hat Integration Operator release version is only supported for 3 months.

7.2.4. Fixed issues

The following table lists the fixed issues that were affecting Red Hat Integration Operator 1.2. The issues related to OpenShift Container Platform 4.7 and were fixed in the OpenShift Container Platform 4.7.24 bug fix update.

Issue NumberDescription

ENTMQST-3047

AMQ Streams Operator 1.7.2 is blocking the installation of other operators.

BZ-1981832

OLM fails with 'ResolutionFailed' found multiple channel heads.

BZ-1989712

OLM fails with 'ResolutionFailed' found multiple channel heads due to deprecated inner channel entry.

Additional resources

7.3. Red Hat Integration component Operators

You can install and upgrade each Red Hat Integration component Operator individually, for example, using the 3scale Operator, the Camel K Operator, and so on.

7.3.1. 3scale Operators

7.3.2. AMQ Operators

7.3.3. Camel K Operator

7.3.4. Fuse Operators

7.3.5. Service Registry Operator

Additional resources