Chapter 2. Installing Operators for Red Hat Integration components

Operators for Red Hat Integration automate the deployment and management of Red Hat Integration components on an OpenShift Container Platform. Use the Red Hat Integration Operator to install and upgrade the Operators. Red Hat Integration Operator installs the current version of each Operator, and performs automatic updates when new versions are available.

2.1. Installing Integration Operators

When installed on an Openshift Container Platform cluster, the Red Hat Integration Operator provides a CRD (Custom Resource Definition) called Installation. The CRD triggers the installation of the Operators for Red Hat Integration components.

Create an instance of the Installation CRD to install the Operators.

Operators available for installation:

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

Prerequisites

Procedure

  1. Navigate to Installed Operators and click Red Hat Integration to display the Operator Details page.
  2. From Provided APIs, click Create Instance for the Installation resource.

    The full set of Red Hat Integration Operators available for installation is displayed on the Create Installation page.

    All Operators are enabled for installation by default. The default installation mode and namespace where the Operator is installed depends on the Operator. The Operator creates the namespaces. If a namespace is not specified, the openshift-operators namespace is used for cluster-wide installation.

    The configuration for each Operator is encapsulated in the spec property of the Installation custom resource.

    Table 2.1. Default Operator installation modes for Red Hat Integration components

    Operator nameCRD spec propertyDefault Installation modeDefault namespace

    3scale

    3scale-installation

    namespace

    rhi-3scale

    3scale APIcast

    3scale-apicast-installation

    namespace

    rhi-3scale-apicast

    AMQ Broker

    amq-broker-installation

    namespace

    rhi-amq-broker

    AMQ Interconnect

    amq-interconnect-installation

    namespace

    rhi-amq-interconnect

    AMQ Streams

    amq-streams-installation

    cluster

    openshift-operators

    Camel K

    camel-k-installation

    cluster

    openshift-operators

    (Fuse) API Designer

    api-designer-installation

    namespace

    rhi-api-designer

    Fuse Console

    fuse-console-installation

    namespace

    rhi-fuse-console

    Fuse Online

    fuse-online-installation

    namespace

    rhi-fuse-online

    Service Registry

    service-registry-installation

    namespace

    rhi-service-registry

  3. Optional: Configure the installation specification from the form or YAML views before you perform the installation.

    You can:

    • Include or exclude Operators from installation.
    • Change the namespace names specified for the Operators.
    • Switch the camel-k-installation and amq-streams-installation Operators to namespace mode, which then requires a namespace to be specified too.

      Example configuration for the Installation CRD

      # …
      kind: Installation
      spec
        3scale-apicast-installation:
          enabled: false 1
          mode: namespace
          namespace: rhi-3scale-apicast
        amq-streams-installation:
          enabled: true
          mode: namespace 2
          namespace: rhi-streams 3

      1
      Set the enabled property for the Operator to false to exclude the Operator from installation if you do not plan to use the component.
      2
      Set the installation mode to namespace from cluster to specify installation to a specific namespace.
      3
      Add or modify a namespace name to install to.
  4. Click Create to start the installation of the enabled Operators.

    Wait until the status changes to Succeeded.

  5. Click rhi-installation to check that all enabled Operators have been installed.
  6. Navigate to Installed Operators to see the list of installed Operators and the namespaces they were deployed to, as well as their versions.

Additional resources

For more information on the Operators provided with Red Hat Integration components, see:

2.2. Upgrading Integration Operators

Upgrades to the Red Hat Integration Operator also upgrade the Operators for the Red Hat Integration components it has installed.

Upgrade approval strategy is set to automatic by default for the Operators installed by the Integration Operator. When a new version of the Red Hat Integration Operator is deployed for the current update channel, the installed Operators are upgraded to use the latest version applicable to each Operator automatically. You can change the approval strategy to manual for the Red Hat Integration Operator, but the strategy for the Operators it installs is always automatic.

When the update channel changes, such as for a major release, use the Operator Lifecycle Manager (OLM) to change the channel name for the Red Hat Integration Operator. You can also change the default update channels for the installed Operators.

The update channels in a subscription can differ between Operators, but generally follow a standard naming convention:

  • A (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 X.x channel contains the minor and micro release updates for a major release, where X is the major release version number.
  • An 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.
Note

Take care to choose an update channel for an Operator that corresponds to a supported version of the OpenShift Container Platform. For example, if you are using an unsupported version of the OpenShift Container Platform, installing an Operator from a 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 Container Platform release.

Depending on your chosen upgrade strategy, following the channel update either:

  • An automatic upgrade is initiated
  • A manual upgrade then requires approval before the installation begins

Additional resources

Revised on 2021-03-12 18:20:10 UTC