Chapter 4. Upgrading AMQ Broker on OpenShift Container Platform

Procedure

1. In the deploy/crs directory of the Operator archive that you downloaded and extracted during your initial installation, open the broker_v2alpha1_activemqartemis_cr.yaml Custom Resource (CR).

2. Edit the image element to specify the latest AMQ Broker 7.5 container image, as shown below.

   image: registry.redhat.io/amq7/amq-broker:7.5

3. Apply the CR change.

   $ oc apply -f deploy/crs/broker_v2alpha1_activemqartemis_cr.yaml

   When you apply the CR change, each broker Pod in your deployment shuts down and then restarts using the new broker container image. If you have multiple brokers in your deployment, only one broker Pod shuts down and restarts at a time.

Procedure

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

   $ oc login -u system:admin

2. Log in to the project in which you want to upgrade the Operator.

   $ oc project <project_name>

3. In the deploy directory of the Operator archive that you downloaded and extracted during your original installation, open the operator.yaml file.

4. Update the spec.containers.image attribute to specify the full path to the latest Operator image for AMQ Broker 7.5 in the Red Hat Container Registry.

   spec:
       template:
           spec:
               containers:
                   image: registry.redhat.io/amq7/amq-broker-rhel7-operator:0.9

5. When you have updated the spec.containers.image attribute, apply the changes.

   $ oc apply -f deploy/operator.yaml

   OpenShift updates your project to use the latest Operator version. The upgrade has no effect on your running broker Pods.

Procedure

1. Navigate to the OpenShift Container Platform web console and log in.
2. Click the project in which you want to upgrade a non-persistent broker deployment.

3. Select the Deployment Config (DC) corresponding to your broker deployment.

   1. In OpenShift Container Platform 4.1, click Workloads Deployment Configs.
   2. In OpenShift Container Platform 3.11, click Applications Deployments. Within your broker deployment, click the Configuration tab.

4. From the Actions menu, click Edit Deployment Config (OpenShift Container Platform 4.1) or Edit YAML (OpenShift Container Platform 3.11).

   The YAML tab of the Deployment Config opens, with the .yaml file in an editable mode.

5. Edit the image attribute to specify the latest AMQ Broker 7.5 container image, registry.redhat.io/amq7/amq-broker:7.5.

6. Add the imagePullSecrets attribute to specify the image pull secret associated with the account used for authentication in the Red Hat Container Registry.

   Changes based on the previous two steps are shown in the example below:

   ...
   spec:
       containers:
           image: 'registry.redhat.io/amq7/amq-broker:7.5'
   ..
   imagePullSecrets:
     - name: {PULL-SECRET-NAME}

   Note

   In AMQ Broker, container image tags increment by 1 for each new version of the container image added to the Red Hat image registry, for example, 7.5-1, 7.5-2, and so on. If you specify a tag name without a final digit (7.5, for example), this tag is known as a floating tag. When you specify a floating tag, OpenShift Container Platform automatically identifies the most recent available image (that is, the image tag with the highest final number) and uses this image to upgrade your broker deployment.

7. Click Save.

   If a newer broker image than the one currently installed is available in the Red Hat Container Registry, OpenShift Container Platform upgrades your broker deployment. To do this, OpenShift Container Platform stops the existing broker Pod and then starts a new Pod that uses the new image.

Procedure

1. Navigate to the OpenShift Container Platform web console and log in.
2. Click the project in which you want to upgrade a persistent broker deployment.

3. Select the StatefulSet (SS) corresponding to your broker deployment.

   1. In OpenShift Container Platform 4.1, click Workloads Stateful Sets.
   2. In OpenShift Container Platform 3.11, click Applications Stateful Sets.

4. From the Actions menu, click Edit Stateful Set (OpenShift Container Platform 4.1) or Edit YAML (OpenShift Container Platform 3.11).

   The YAML tab of the StatefulSet opens, with the .yaml file in an editable mode.

5. To prepare your broker deployment for upgrade, scale the deployment down to zero brokers.

   1. If the replicas attribute is currently set to 1 or greater, set it to 0.
   2. Click Save.
6. When all broker Pods have shut down, edit the Stateful Set .yaml file again. Edit the image attribute to specify the latest AMQ Broker 7.5 container image, registry.redhat.io/amq7/amq-broker:7.5.

7. Add the imagePullSecrets attribute to specify the image pull secret associated with the account used for authentication in the Red Hat Container Registry.

   Changes based on the previous two steps are shown in the example below:

   ...
   spec:
       containers:
           image: 'registry.redhat.io/amq7/amq-broker:7.5'
   ..
   imagePullSecrets:
     - name: {PULL-SECRET-NAME}

8. Set the replicas attribute back to the original value.

9. Click Save.

   If a newer broker image than the one currently installed is available in the Red Hat Container Registry, OpenShift Container Platform upgrades your broker deployment. To do this, OpenShift Container Platform restarts the broker Pod.