Chapter 3. Adding the Red Hat Integration - AMQ Interconnect

The Red Hat Integration - AMQ Interconnect creates and manages AMQ Interconnect router networks in OpenShift Container Platform. This Operator must be installed separately for each project that uses it.

The options for installing the Operator are:

Note

Installing an Operator requires administrator-level privileges for your OpenShift cluster.

3.1. Installing the Operator using the CLI

The procedures in this section show how to use the OpenShift command-line interface (CLI) to install and deploy the latest version of the Red Hat Integration - AMQ Interconnect in a given OpenShift project.

3.1.1. Getting the Operator code

This procedure shows how to access and prepare the code you need to install the latest version of the Operator for AMQ Interconnect 1.10.

Procedure

  1. In your web browser, navigate to the Software Downloads page for AMQ Interconnect releases.
  2. Ensure that the value of the Version drop-down list is set to 1.10 and the Releases tab is selected.
  3. Next to AMQ Interconnect 1.10.0 Operator Installation and Example Files, click Download.

    Download of the amq-interconnect-operator-1.10.0-ocp-install-examples.zip compressed archive automatically begins.

  4. When the download has completed, move the archive to your chosen installation directory. The following example moves the archive to a directory called ~/router/operator.

    $ mkdir ~/router
    $ mv amq-interconnect-operator-1.10.0-ocp-install-examples.zip ~/router
  5. In your chosen installation directory, extract the contents of the archive. For example:

    $ cd ~/router
    $ unzip amq-interconnect-operator-1.10.0-ocp-install-examples.zip
  6. Switch to the directory that was created when you extracted the archive. For example:

    $ cd operator
  7. Log in to OpenShift Container Platform as a cluster administrator. For example:

    $ oc login -u system:admin
  8. Specify the project in which you want to install the Operator. You can create a new project or switch to an existing one.

    1. Create a new project:

      $ oc new-project <project-name>
    2. Or, switch to an existing project:

      $ oc project <project-name>
  9. Create a service account to use with the Operator.

    $ oc create -f deploy/service_account.yaml
  10. Create a role for the Operator.

    $ oc create -f deploy/role.yaml
  11. Create a role binding for the Operator. The role binding binds the previously-created service account to the Operator role, based on the names you specified.

    $ oc create -f deploy/role_binding.yaml

In the procedure that follows, you deploy the Operator in your project.

3.1.2. Deploying the Operator using the CLI

The procedure in this section shows how to use the OpenShift command-line interface (CLI) to deploy the latest version of the Operator for AMQ Interconnect 1.10 in your OpenShift project.

Prerequisites

Procedure

  1. In the OpenShift command-line interface (CLI), log in to OpenShift Container Platform as a cluster administrator. For example:

    $ oc login -u system:admin
  2. Switch to the project that you previously prepared for the Operator deployment. For example:

    $ oc project <project-name>
  3. Switch to the directory that was created when you previously extracted the Operator installation archive. For example:

    $ cd ~/router/operator/qdr-operator-1.10-ocp-install-examples
  4. Deploy the CRD that is included with the Operator. You must install the CRD in your OpenShift cluster before deploying and starting the Operator.

    $ oc create -f deploy/crds/interconnectedcloud_v1alpha1_interconnect_crd.yaml
  5. Link the pull secret associated with the account used for authentication in the Red Hat Ecosystem Catalog with the default, deployer, and builder service accounts for your OpenShift project.

    $ oc secrets link --for=pull default <secret-name>
    $ oc secrets link --for=pull deployer <secret-name>
    $ oc secrets link --for=pull builder <secret-name>
    Note

    In OpenShift Container Platform 4.1 or later, you can also use the web console to associate a pull secret with a project in which you want to deploy container images such as the AMQ Interconnect Operator. To do this, click AdministrationService Accounts. Specify the pull secret associated with the account that you use for authentication in the Red Hat Container Registry.

  6. Deploy the Operator.

    $ oc create -f deploy/operator.yaml
  7. Verify that the Operator is running:

    $ oc get pods -l name=qdr-operator

    If the output does not report the pod is running, use the following command to determine the issue that prevented it from running:

    $ oc describe pod -l name=qdr-operator
  8. Verify that the CRD is registered in the cluster and review the CRD details:

    $ oc get crd
    $ oc describe crd interconnects.interconnectedcloud.github.io
Note

It is recommended that you deploy only a single instance of the AMQ Interconnect Operator in a given OpenShift project. Setting the replicas element of your Operator deployment to a value greater than 1, or deploying the Operator more than once in the same project is not recommended.

Additional resources

3.2. Installing the Operator using the Operator Lifecycle Manager

The procedures in this section show how to use the OperatorHub to install and deploy the latest version of the Red Hat Integration - AMQ Interconnect in a given OpenShift project.

In OpenShift Container Platform 4.1 and later, the Operator Lifecycle Manager (OLM) helps users install, update, and generally manage the lifecycle 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.

Prerequisites

  • Access to an OpenShift Container Platform 4.5 or 4.6 cluster using a cluster-admin account.
  • Red Hat Integration - AMQ Certificate Manager Operator is installed in the OpenShift Container Platform cluster if required.

Procedure

  1. In the OpenShift Container Platform web console, navigate to OperatorsOperatorHub.
  2. Choose Red Hat Integration - AMQ Interconnect from the list of available Operators, and then click Install.
  3. On the Operator Installation page, select the namespace into which you want to install the Operator, and then click Install.

    The Installed Operators page appears displaying the status of the Operator installation.

  4. Verify that the AMQ Interconnect Operator is displayed and wait until the Status changes to Succeeded.
  5. If the installation is not successful, troubleshoot the error:

    1. Click Red Hat Integration - AMQ Interconnect on the Installed Operators page.
    2. Select the Subscription tab and view any failures or errors.