Chapter 3. Deploying AMQ Broker on OpenShift Container Platform using Application Templates

Procedure

1. Log in to the amq-demo project space, or another, existing project in which you want to deploy a broker.

   $ oc login -u <USER_NAME>
   $ oc project <PROJECT_NAME>

2. Create a new broker application, based on the template for a basic broker. The broker created by this template is ephemeral and does not support SSL.

   $ oc new-app --template=amq-broker-75-basic \
      -p AMQ_PROTOCOL=openwire,amqp,stomp,mqtt,hornetq \
      -p AMQ_QUEUES=demoQueue \
      -p AMQ_ADDRESSES=demoTopic \
      -p AMQ_USER=amq-demo-user \
      -p AMQ_PASSWORD=password \

   The basic broker application template sets the environment variables shown in the following table.

   Table 3.1. Basic broker application template

   Environment variable	Display Name	Value	Description
   AMQ_PROTOCOL	AMQ Protocols	openwire,amqp,stomp,mqtt,hornetq	The protocols to be accepted by the broker
   AMQ_QUEUES	Queues	demoQueue	Creates an anycast queue called demoQueue
   AMQ_ADDRESSES	Addresses	demoTopic	Creates an address (or topic) called demoTopic. By default, this address has no assigned routing type.
   AMQ_USER	AMQ Username	amq-demo-user	User name that the client uses to connect to the broker
   AMQ_PASSWORD	AMQ Password	password	Password that the client uses with the user name to connect to the broker

Procedure

1. Click Deployments in the OpenShift Container Platform web console.
2. Click the broker-amq application.

3. Click Deploy.

   Note

   If the application does not deploy, you can check the configuration by clicking the Events tab. If something is incorrect, edit the deployment configuration by clicking the Actions button.

4. After you deploy the broker application, inspect the current state of the broker Pod.

   1. Click Deployment Configs.

   2. Click the broker-amq Pod and then click the Logs tab to verify the state of the broker. You should see the queue previously created via the application template.

      If the logs show that:

      • The broker is running, skip to step 9 of this procedure.
      • The broker logs have not loaded, and the Pod status shows ErrImagePull or ImagePullBackOff, your deployment configuration was not able to directly pull the specified broker image from the Red Hat Container Registry. In this case, continue to step 5 of this procedure.

5. To prepare the Pod for installation of the broker container image, scale the number of running brokers to 0.

   1. Click Deployment Configs broker-amq.
   2. Click Actions Edit Deployment Configs.
   3. In the deployment config .yaml file, set the value of the replicas attribute to 0.
   4. Click Save.
   5. The pod restarts, with zero broker instances running.

6. Install the latest broker container image.

   1. In your web browser, navigate to the Red Hat Container Catalog.
   2. In the search box, enter AMQ Broker. Click Search.

   3. Choose an image repository based on the information in the following table.

      Platform	Container image name	Repository name
      OpenShift Container Platform	AMQ Broker	amq7/amq-broker
      OpenShift Container Platform on IBM Z	AMQ Broker on OpenJ9 11	amq7/amq-broker-openj9-11-rhel8

      For example, for the OpenShift Container Platform broker container image, click AMQ Broker. The amq7/amq-broker repository opens, with the most recent image version automatically selected. If you want to change to an earlier image version, click the Tags tab and choose another version tag.

   4. Click the Get This Image tab.

   5. Under Authentication with registry tokens, review the on-page instructions in the Using OpenShift secrets section. The instructions describe how to add references to the broker image and the image pull secret name associated with the account used for authentication in the Red Hat Container Registry to your Pod deployment configuration file.

      For example, to pull the latest version of the OpenShift Container Platform broker container image for a deployment configuration called broker-amq in the amq-demo project namespace, include lines that look like the following:

      apiVersion: apps.openshift.io/v1
      kind: DeploymentConfig
      ..
      metadata:
        name: broker-amq
        namespace: amq-demo
      ..
        spec:
          containers:
              name: broker-amq
              image: 'registry.redhat.io/amq7/amq-broker:7.5'
          ..
          imagePullSecrets:
            - name: {PULL-SECRET-NAME}

      Note

      To use the latest version of the broker container image for OpenShift Container Platform on IBM Z, specify the image attribute as registry.redhat.io/amq7/amq-broker-openj9-11-rhel8:7.5.

   6. Click Save.

7. Import the latest broker image version to your project namespace. For example:

   $ oc import-image amq7/amq-broker:7.5 --from=registry.redhat.io/amq7/amq-broker --confirm

8. Edit the broker-amq deployment config again, as previously described. Set the value of the replicas attribute back to its original value.

   The broker Pod restarts, with all running brokers referencing the new broker image.

9. Click the Terminal tab to access a shell where you can start the broker and use the CLI to test sending and consuming messages.

   sh-4.2$ ./broker/bin/artemis run
   sh-4.2$ ./broker/bin/artemis producer --destination queue://demoQueue
   Producer ActiveMQQueue[demoQueue], thread=0 Started to calculate elapsed time ...
   
   Producer ActiveMQQueue[demoQueue], thread=0 Produced: 1000 messages
   Producer ActiveMQQueue[demoQueue], thread=0 Elapsed time in second : 4 s
   Producer ActiveMQQueue[demoQueue], thread=0 Elapsed time in milli second : 4584 milli seconds
   sh-4.2$ ./broker/bin/artemis consumer --destination queue://demoQueue
   Consumer:: filter = null
   Consumer ActiveMQQueue[demoQueue], thread=0 wait until 1000 messages are consumed
   Received 1000
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumed: 1000 messages
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumer thread finished

   Alternatively, use the OpenShift client to access the shell using the Pod name, as shown in the following example.

   // Get the Pod names and internal IP Addresses
   $ oc get pods -o wide
   
   // Access a broker Pod by name
   $ oc rsh <broker-pod-name>