Procedure

1. In your web browser, navigate to the AMQ Broker Software Downloads page.
2. In the Version drop-down box, select 7.4.6.

3. Next to AMQ Broker 7.4.6 Operator Installation and Example Files, click Download.

   Download of the amq-broker-operator-7.4.6-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 /broker/operator.

   sudo mv amq-broker-operator-7.4.6-ocp-install-examples.zip /broker/operator

5. In your chosen installation directory, extract the contents of the archive. For example:

   cd /broker/operator
   sudo unzip amq-broker-operator-7.4.6-ocp-install-examples.zip

6. Log in to OpenShift Container Platform as a cluster administrator. For example:

   $ oc login -u system:admin

7. 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>

8. Specify a service account to use with the Operator.

   1. In the deploy directory of the Operator archive that you extracted, open the service_account.yaml file.
   2. Ensure that the kind element is set to ServiceAccount.
   3. In the metadata section, assign a custom name to the service account, or use the default name. The default name is amq-broker-operator.

   4. Create the service account in your project.

      $ oc create -f deploy/service_account.yaml

9. Specify a role name for the Operator.

   1. Open the role.yaml file. This file specifies the resources that the Operator can use and modify.
   2. Ensure that the kind element is set to Role.
   3. In the metadata section, assign a custom name to the role, or use the default name. The default name is amq-broker-operator.

   4. Create the role in your project.

      $ oc create -f deploy/role.yaml

10. Specify 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.

    1. Open the role_binding.yaml file. Ensure that the name values for ServiceAccount and Role match those specified in the service_account.yaml and role.yaml files. For example:

       metadata:
           name: amq-broker-operator
       subjects:
           kind: ServiceAccount
           name: amq-broker-operator
       roleRef:
           kind: Role
           name: amq-broker-operator

    2. Create the role binding in your project.

       $ oc create -f deploy/role_binding.yaml

Procedure

1. In the OpenShift Container Platform web console, open the project in which you want your broker deployment.

   If you created a new project, it is currently empty. Observe that there are no deployments, StatefulSets, Pods, Services, or Routes.

2. If you deployed an earlier version of the AMQ Broker Operator in the project, remove the main broker Custom Resource (CR) from the project. Deleting the main CR removes the existing broker deployment in the project. For example:

   oc delete -f deploy/crs/broker_v1alpha1_activemqartemis_cr.yaml.

3. If you deployed an earlier version of the AMQ Broker Operator in the project, delete this Operator instance. For example:

   $ oc delete -f deploy/operator.yaml

4. If you deployed Custom Resource Definitions (CRDs) in your OpenShift cluster for an earlier version of the AMQ Broker Operator, remove these CRDs from the cluster. For example:

   oc delete -f deploy/crds/broker_v1alpha1_activemqartemis_crd.yaml
   oc delete -f deploy/crds/broker_v1alpha1_activemqartemisaddress_crd.yaml
   oc delete -f deploy/crds/broker_v1alpha1_activemqartemisscaledown_crd.yaml

5. Deploy the CRDs that are included in the deploy/crds directory of the Operator archive that you downloaded and extracted. You must install the latest CRDs in your OpenShift cluster before deploying and starting the Operator.

   1. Deploy the main broker CRD.

      $ oc create -f deploy/crds/broker_v2alpha1_activemqartemis_crd.yaml

   2. Deploy the addressing CRD.

      $ oc create -f deploy/crds/broker_v2alpha1_activemqartemisaddress_crd.yaml

   3. Deploy the scaledown controller CRD.

      $ oc create -f deploy/crds/broker_v2alpha1_activemqartemisscaledown_crd.yaml

6. Link the pull secret associated with the account used for authentication in the Red Hat Container Registry 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 Broker Operator. To do this, click Administration → Service Accounts. Specify the pull secret associated with the account that you use for authentication in the Red Hat Container Registry.

7. In the deploy directory of the Operator archive that you downloaded and extracted, open the operator.yaml file. Update spec.containers.image with the full path to the image for the latest LTS version of the Operator for AMQ Broker 7.4 in the Red Hat Container Registry.

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

8. Deploy the Operator.

   $ oc create -f deploy/operator.yaml

   In your OpenShift project, the amq-broker-operator image that you deployed starts in a new Pod.

   The information on the Events tab of the new Pod confirms that OpenShift has deployed the Operator image you specified, assigned a new container to a node in your OpenShift cluster, and started the new container.

   In addition, if you click the Logs tab within the Pod, the output should include lines resembling the following:

   ...
   {"level":"info","ts":1553619035.8302743,"logger":"kubebuilder.controller","msg":"Starting Controller","controller":"activemqartemisaddress-controller"}
   {"level":"info","ts":1553619035.830541,"logger":"kubebuilder.controller","msg":"Starting Controller","controller":"activemqartemis-controller"}
   {"level":"info","ts":1553619035.9306898,"logger":"kubebuilder.controller","msg":"Starting workers","controller":"activemqartemisaddress-controller","worker count":1}
   {"level":"info","ts":1553619035.9311671,"logger":"kubebuilder.controller","msg":"Starting workers","controller":"activemqartemis-controller","worker count":1}

   The preceding output confirms that the newly-deployed Operator is communicating with Kubernetes, that the controllers for the broker and addressing are running, and that these controllers have started some workers.

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. In the acceptors element, add a named acceptor. Typically, you also specify a minimal set of attributes such as the protocols to be used by the acceptor and the port on the broker Pod to expose for those protocols. An example is shown below.

   spec:
   ...
     acceptors:
     - name: amqp_acceptor
       protocols: amqp
       port: 5672
       sslEnabled: false
   ...

   The preceding example shows configuration of a simple AMQP acceptor. The acceptor exposes port 5672 to AMQP clients.

Procedure

1. Generate a self-signed certificate for the broker keystore.

   $ keytool -genkey -alias broker -keyalg RSA -keystore broker.ks

2. Export the certificate, so that it can be shared with clients.

   $ keytool -export -alias broker -keystore broker.ks -file broker_cert

3. Generate a self-signed certificate for the client keystore.

   $ keytool -genkey -alias client -keyalg RSA -keystore client.ks

4. Create a client truststore that imports the broker certificate.

   $ keytool -import -alias broker -keystore client.ts -file broker_cert

5. Use the broker keystore file to create a secret to store the SSL credentials, as shown in the example below.

   $ oc secrets new ex-aao-amqp-secret broker.ks client.ts

6. Add the secret to the service account that you created when installing the Operator, as shown in the example below.

   $ oc secrets add sa/amq-broker-operator secret/ex-aao-amqp-secret

Procedure

1. In the deploy/crs directory of the Operator archive that you downloaded and extracted, open the broker_v2alpha1_activemqartemis_cr.yaml Custom Resource file.
2. For a minimally-sized clustered deployment, ensure that the value of deploymentPlan.size is 2.

3. At the command line, apply the change:

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

   In the OpenShift Container Platform web console, a second Pod starts in your project, for the additional broker that you specified in your CR. By default, the two brokers running in your project are clustered.

4. Open the Logs tab of each Pod. The logs show that OpenShift has established a cluster connection bridge on each broker. Specifically, the log output includes a line like the following:

   targetConnector=ServerLocatorImpl (identity=(Cluster-connection-bridge::ClusterConnectionBridge@6f13fb88

Procedure

1. Deploy the addressing CRD.

   $ oc create -f deploy/crds/broker_v2alpha1_activemqartemisaddress_crd.yaml

2. An example CR file, broker_v2alpha1_activemqartemisaddress_cr.yaml, was included in the Operator archive that you downloaded and extracted. The example Custom Resource includes the following:

   spec:
     # Add fields here
     spec:
       addressName: myAddress0
       queueName: myQueue0
       routingType: anycast

   With your broker cluster already already deployed and running via the Operator, use the example Custom Resource to create an address on every running broker in your cluster.

   $ oc create -f deploy/crs/broker_v2alpha1_activemqartemisaddress_cr.yaml

   Deploying the example CR creates an address myAddress0 with a queue named myQueue0 that has an anycast routing type. This address is created on every running broker.

   Note

   To create multiple addresses and/or queues in your broker cluster, you need to create separate CR files and deploy them individually, specifying new address and/or queue names in each case.

   Note

   If you add brokers to your cluster after deploying the addressing CR, the new brokers will not have the address you previously created. In this case, you need to delete the addresses and redeploy the addressing CR.

3. To delete queues created from the example CR, use the following command:

   $ oc delete -f deploy/crs/broker_v2alpha1_activemqartemisaddress_cr.yaml

Procedure

1. In your web browser, navigate to the AMQ Broker Software Downloads page.
2. In the Version drop-down box, select, 7.4.6.

3. Next to AMQ Broker 7.4.6 Operator Installation and Example Files, click Download.

   Download of the amq-broker-operator-7.4.6-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 /broker/operator.

   sudo mv amq-broker-operator-7.4.6-ocp-install-examples.zip /broker/operator

5. In your chosen installation directory, extract the contents of the archive. For example:

   cd /broker/operator
   unzip amq-broker-operator-7.4.6-ocp-install-examples.zip

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

   $ oc login -u system:admin

7. Deploy the AMQ Broker Operator source bundle from the deploy directory of the Operator archive that you downloaded and extracted.

   $ oc create -f deploy/catalog_resources/courier/amq-broker-operatorsource.yaml

   After a few minutes, the AMQ Broker Operator is available in the OperatorHub section of the OpenShift Container Platform web console.

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-74-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	The username the client uses
   AMQ_PASSWORD	AMQ Password	password	The password the client uses with the username

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 LTS. Click Search.
   3. In the search results, click AMQ Broker LTS. The amq7/amq-broker-lts-rhel7 repository opens, with the latest image tag automatically selected.
   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 specify the broker container 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 reference the broker container image and pull secret in the broker-amq deployment configuration 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-lts-rhel7:7.4'
          ..
          imagePullSecrets:
            - name: {PULL-SECRET-NAME}

   6. Click Save.

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

   $ oc import-image amq7/amq-broker-lts-rhel7:7.4 --from=registry.redhat.io/amq7/amq-broker-lts-rhel7 --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>

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 broker container image in the Long Term Support (LTS) image stream.

   ...
   spec:
       containers:
             image: 'registry.redhat.io/amq7/amq-broker-lts-rhel7:7.4'

   Note

   If you specify a tag format such as 7.4 for the image attribute (rather than a tag with a specific version identifier, such as 7.4-6), this tag format is known as a floating tag. When you specify a floating tag, OpenShift Container Platform automatically identifies the most recent available image in the specified repository and uses this image to upgrade your broker deployment.

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

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

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 broker container image in the LTS image stream.

   ...
   spec:
       containers:
             image: 'registry.redhat.io/amq7/amq-broker-lts-rhel7:7.4'

   Note

   If you specify a tag format such as 7.4 for the image attribute (rather than a tag with a specific version identifier, such as 7.4-6), this tag format is known as a floating tag. When you specify a floating tag, OpenShift Container Platform automatically identifies the most recent available image in the specified repository and uses this image to upgrade your broker deployment.

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

   ...
   spec:
       containers:
             image: 'registry.redhat.io/amq7/amq-broker-lts-rhel7:7.4'
   ..
   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.

Procedure

1. Navigate to the OpenShift web console and log in.
2. Select the amq-demo project space.
3. Click Add to Project > Browse Catalog to list all of the default image streams and templates.
4. Use the Filter search bar to limit the list to those that match amq. You might need to click See all to show the desired application template.
5. Select the amq-broker-74-ssl template which is labeled Red Hat AMQ Broker 7.4 (Ephemeral, with SSL).

6. Set the following values in the configuration and click Create.

   Table 8.1. Example 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	The username the client uses
   AMQ_PASSWORD	AMQ Password	password	The password the client uses with the username
   AMQ_TRUSTSTORE	Trust Store Filename	broker.ts	The SSL truststore file name
   AMQ_TRUSTSTORE_PASSWORD	Truststore Password	password	The password used when creating the Truststore
   AMQ_KEYSTORE	AMQ Keystore Filename	broker.ks	The SSL keystore file name
   AMQ_KEYSTORE_PASSWORD	AMQ Keystore Password	password	The password used when creating the Keystore

Procedure

1. Click Deployments in the OpenShift Container Platform web console.
2. Click the broker-amq deployment.
3. Click Deploy to deploy the application.

4. Click the broker Pod and then click the Logs tab to verify the state of the broker.

   If 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, edit your deployment configuration to reference the correct broker image name and the image pull secret name associated with the account used for authentication in the Red Hat Container Registry. Then, you can import the broker image and start the broker. To do this, complete steps similar to those in Deploy and start the broker application.

Procedure

1. Click Services → broker-amq-tcp-ssl
2. Click Actions → Create route
3. To display the TLS parameters, select the Secure route check box .
4. From the TLS Termination drop-down menu, choose Passthrough. This selection relays all communication to AMQ Broker without the OpenShift router decrypting and resending it.

5. To view the Route, click Routes. For example:

   https://broker-amq-tcp-amq-demo.router.default.svc.cluster.local

Procedure

1. Navigate to the OpenShift web console and log in.
2. Select the amq-demo project space.
3. Click Add to Project → Browse catalog to list all of the default image streams and templates.
4. Use the Filter search bar to limit the list to those that match amq. You might need to click See all to show the desired application template.
5. Select the amq-broker-74-persistence-ssl template, which is labelled Red Hat AMQ Broker 7.4 (Persistence, with SSL).

6. Set the following values in the configuration and click create.

   Table 8.2. Example 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.
   VOLUME_CAPACITY	AMQ Volume Size	1Gi	The persistent volume size created for the journal
   AMQ_USER	AMQ Username	amq-demo-user	The username the client uses
   AMQ_PASSWORD	AMQ Password	password	The password the client uses with the username
   AMQ_TRUSTSTORE	Trust Store Filename	broker.ts	The SSL truststore file name
   AMQ_TRUSTSTORE_PASSWORD	Truststore Password	password	The password used when creating the Truststore
   AMQ_KEYSTORE	AMQ Keystore Filename	broker.ks	The SSL keystore file name
   AMQ_KEYSTORE_PASSWORD	AMQ Keystore Password	password	The password used when creating the Keystore

Procedure

1. Click Stateful Sets in the OpenShift Container Platform web console.
2. Click the broker-amq deployment.
3. Click Deploy to deploy the application.

4. Click the broker Pod and then click the Logs tab to verify the state of the broker. You should see the queue created via the template.

   If the broker logs have not loaded, and the Pod status shows ErrImagePull or ImagePullBackOff, your configuration was not able to directly pull the specified broker image from the Red Hat Container Registry. In this case, edit your deployment configuration to reference the correct broker image name and the image pull secret name associated with the account used for authentication in the Red Hat Container Registry. Then, you can import the broker image and start the broker. To do this, complete steps similar to those in Deploy and start the broker application.

5. Click the Terminal tab to access a shell where you can use the CLI to send some messages.

   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>

6. Now scale down the broker using the oc command.

   $ oc scale statefulset broker-amq --replicas=0
   statefulset "broker-amq" scaled

   You can use the console to check that the Pod count is 0

7. Now scale the broker back up to 1.

   $ oc scale statefulset broker-amq --replicas=1
   statefulset "broker-amq" scaled

8. Consume the messages again by using the terminal. For example:

   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

Procedure

1. Click Services → broker-amq-tcp-ssl.
2. Click Actions → Create a route.
3. To display the TLS parameters, select the Secure route check box.
4. From the TLS Termination drop-down menu, choose Passthrough. This selection relays all communication to AMQ Broker without the OpenShift router decrypting and resending it.

5. To view the route, click Routes. For example:

   https://broker-amq-tcp-amq-demo.router.default.svc.cluster.local

Procedure

1. Navigate to the OpenShift web console and log in.
2. Select the amq-demo project space.
3. Click Add to Project > Browse catalog to list all of the default image streams and templates
4. Use the Filter search bar to limit the list to those that match amq. Click See all to show the desired application template.
5. Select the amq-broker-74-persistence-clustered template which is labeled Red Hat AMQ Broker 7.4 (no SSL, clustered).

6. Set the following values in the configuration and click create.

   Table 8.3. Example 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.
   VOLUME_CAPACITY	AMQ Volume Size	1Gi	The persistent volume size created for the journal
   AMQ_CLUSTERED	Clustered	true	This needs to be true to ensure the brokers cluster
   AMQ_CLUSTER_USER	cluster user	generated	The username the brokers use to connect with each other
   AMQ_CLUSTER_PASSWORD	cluster password	generated	The password the brokers use to connect with each other
   AMQ_USER	AMQ Username	amq-demo-user	The username the client uses
   AMQ_PASSWORD	AMQ Password	password	The password the client uses with the username

Procedure

1. Click Stateful Sets in the OpenShift Container Platform web console.
2. Click the broker-amq deployment.

3. Click Deploy to deploy the application.

   Note

   The default number of replicas for a clustered template is 0. You should not see any Pods.

4. Scale up the Pods to three to create a cluster of brokers.

   $ oc scale statefulset broker-amq --replicas=3
   statefulset "broker-amq" scaled

5. Check that there are three Pods running.

   $ oc get pods
   NAME           READY     STATUS    RESTARTS   AGE
   broker-amq-0   1/1       Running   0          33m
   broker-amq-1   1/1       Running   0          33m
   broker-amq-2   1/1       Running   0          29m

6. If the Pod status shows ErrImagePull or ImagePullBackOff, your deployment was not able to directly pull the specified broker image from the Red Hat Container Registry. In this case, edit your Stateful Set to reference the correct broker image name and the image pull secret name associated with the account used for authentication in the Red Hat Container Registry. Then, you can import the broker image and start the brokers. To do this, complete steps similar to those in Deploy and start the broker application.

7. Verify that the brokers have clustered with the new Pod by checking the logs.

   $ oc logs broker-amq-2

   This shows the logs of the new broker and an entry for a clustered bridge created between the brokers:

   2018-08-29 07:43:55,779 INFO  [org.apache.activemq.artemis.core.server] AMQ221027: Bridge ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl (identity=(Cluster-connection-bridge::ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]]::ClusterConnectionImpl@806813022[nodeUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c, connector=TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-108, address=, server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c])) [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]] is connected

Procedure

1. Choose import YAML/JSON from Add to Project drop down

2. Enter the following and click create:

   apiVersion: v1
   kind: Route
   metadata:
     labels:
       app: broker-amq
       application: broker-amq
     name: console-jolokia
   spec:
     port:
       targetPort: console-jolokia
     to:
       kind: Service
       name: broker-amq-headless
       weight: 100
     wildcardPolicy: Subdomain
     host: star.broker-amq-headless.amq-demo.svc

   Note

   The host: star.broker-amq-headless.amq-demo.svc configuration is the hostname used for each Pod in the broker. The star is replaced by the Pod name, so if the Pod name is broker-amq-0 , the hostname is broker-amq-0.broker-amq-headless.amq-demo.svc

3. Add entries into the /etc/hosts file to map the route names onto the IP address of the OpenShift cluster. For example, if you have three Pods, then add entries as shown below.

   10.0.0.1 broker-amq-0.broker-amq-headless.amq-demo.svc
   10.0.0.1 broker-amq-1.broker-amq-headless.amq-demo.svc
   10.0.0.1 broker-amq-2.broker-amq-headless.amq-demo.svc

4. Navigate to the console using the address http://broker-amq-0.broker-amq-headless.amq-demo.svc in a browser.

Procedure

1. Navigate to the OpenShift web console and log in.
2. Select the amq-demo project space.
3. Click Add to Project > Browse catalog to list all of the default image streams and templates.
4. Use the Filter search bar to limit the list to those that match amq. Click See all to show the desired application template.
5. Select the amq-broker-74-persistence-clustered-ssl template which is labeled Red Hat AMQ Broker 7.4 (SSL, clustered).

6. Set the following values in the configuration and click create.

   Table 8.4. Example 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.
   VOLUME_CAPACITY	AMQ Volume Size	1Gi	The persistent volume size created for the journal
   AMQ_CLUSTERED	Clustered	true	This needs to be true to ensure the brokers cluster
   AMQ_CLUSTER_USER	cluster user	generated	The username the brokers use to connect with each other
   AMQ_CLUSTER_PASSWORD	cluster password	generated	The password the brokers use to connect with each other
   AMQ_USER	AMQ Username	amq-demo-user	The username the client uses
   AMQ_PASSWORD	AMQ Password	password	The password the client uses with the username
   AMQ_TRUSTSTORE	Trust Store Filename	broker.ts	The SSL truststore file name
   AMQ_TRUSTSTORE_PASSWORD	Truststore Password	password	The password used when creating the Truststore
   AMQ_KEYSTORE	AMQ Keystore Filename	broker.ks	The SSL keystore file name
   AMQ_KEYSTORE_PASSWORD	AMQ Keystore Password	password	The password used when creating the Keystore

Procedure

1. Click Stateful Sets in the OpenShift Container Platform web console.
2. Click the broker-amq deployment.

3. Click Deploy to deploy the application.

   Note

   The default number of replicas for a clustered template is 0, so you will not see any Pods.

4. Scale up the Pods to three to create a cluster of brokers.

   $ oc scale statefulset broker-amq --replicas=3
   statefulset "broker-amq" scaled

5. Check that there are three Pods running.

   $ oc get pods
   NAME           READY     STATUS    RESTARTS   AGE
   broker-amq-0   1/1       Running   0          33m
   broker-amq-1   1/1       Running   0          33m
   broker-amq-2   1/1       Running   0          29m

6. If the Pod status shows ErrImagePull or ImagePullBackOff, your deployment was not able to directly pull the specified broker image from the Red Hat Container Registry. In this case, edit your Stateful Set to reference the correct broker image name and the image pull secret name associated with the account used for authentication in the Red Hat Container Registry. Then, you can import the broker image and start the brokers. To do this, complete steps similar to those in Deploy and start the broker application.

7. Verify the brokers have clustered with the new Pod by checking the logs.

   $ oc logs broker-amq-2

   This shows all the logs of the new broker and an entry for a clustered bridge created between the brokers, for example:

   2018-08-29 07:43:55,779 INFO  [org.apache.activemq.artemis.core.server] AMQ221027: Bridge ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl (identity=(Cluster-connection-bridge::ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]]::ClusterConnectionImpl@806813022[nodeUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c, connector=TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-108, address=, server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c])) [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]] is connected

Procedure

1. Create a regular Service for each Pod in the cluster, using a StatefulSet selector to select between Pods. To do this, deploy a Service template, in .yaml format, that looks like the following:

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       description: 'Service for the management console of broker pod XXXX'
     labels:
       app: application2
       application: application2
       template: amq-broker-74-persistence-clustered-ssl
     name: amq2-amq-console-XXXX
     namespace: amq74-p-c-ssl-2
   spec:
     ports:
       - name: console-jolokia
         port: 8161
         protocol: TCP
         targetPort: 8161
     selector:
       deploymentConfig: application2-amq
       statefulset.kubernetes.io/pod-name: application2-amq-XXXX
     type: ClusterIP

   In the preceding template, replace XXXX with the ordinal value of the broker Pod you want to associate with the Service. For example, to associate the Service with the first Pod in the cluster, set XXXX to 0. To associate the Service with the second Pod, set XXXX to 1, and so on.

   Save and deploy an instance of the template for each broker Pod in your cluster.

   Note

   In the example template shown above, the selector is uses the Kubernetes-defined Pod name.

2. Create a Route for each broker Pod, so that the AMQ Broker management console can connect to the Pod using SSL.

   Click Routes → Create Route.

   The Edit Route page opens.

   1. In the Services drop-down menu, select the previously created broker Service that you want to associate the Route with, for example, amq2-amq-console-0.
   2. Set Target Port to 8161, to enable access for the AMQ Broker management console.

   3. To display the TLS parameters, select the Secure route check box.

      1. From the TLS Termination drop-down menu, choose Passthrough.

         This selection relays all communication to AMQ Broker without the OpenShift router decrypting and resending it.

   4. Click Create.

      When you create a Route associated with one of broker Pods, the resulting .yaml file includes lines that look like the following:

      spec:
        host: amq2-amq-console-0-amq74-p-c-ssl-2.apps-ocp311.example.com
        port:
          targetPort: console-jolokia
        tls:
          termination: passthrough
        to:
          kind: Service
          name: amq2-amq-console-0
          weight: 100
        wildcardPolicy: None

3. To access the management console for a specific broker instance, copy the host URL shown above to a web browser.

Procedure

1. Navigate to the OpenShift web console and log in.
2. Select the amq-demo project space.
3. Click Add to Project > Browse catalog to list all of the default image streams and templates.
4. Use the Filter search bar to limit results to those that match amq. Click See all to show the desired application template.
5. Select the amq-broker-74-custom template which is labeled Red Hat AMQ Broker 7.4(Ephemeral, no SSL).

6. In the configuration, update broker.xml with the custom configuration you would like to use. Click Create.

   Note

   Use a text editor to create the broker’s XML configuration. Then, cut and paste confguration details into the broker.xml field.

   Note

   OpenShift Container Platform does not use a ConfigMap object to store the custom configuration that you specify in the broker.xml field, as is common for many applications deployed on this platform. Instead, OpenShift temporarily stores the specified configuration in an environment variable, before transferring the configuration to a standalone file when the broker container starts.

Procedure

1. Click Deployments in the OpenShift Container Platform web console.
2. Click the broker-amq deployment
3. Click Deploy to deploy the application.

Procedure

1. Add an entry into your /etc/hosts file to map the route name onto the IP address of the OpenShift cluster:

   10.0.0.1 broker-amq-tcp-amq-demo.router.default.svc.cluster.local

2. Update the jndi.properties configuration file to use the route, truststore and keystore created previously, for example:

   connectionfactory.myFactoryLookup = amqps://broker-amq-tcp-amq-demo.router.default.svc.cluster.local:8443?transport.keyStoreLocation=<keystore-path>client.ks&transport.keyStorePassword=password&transport.trustStoreLocation=<truststore-path>/client.ts&transport.trustStorePassword=password&transport.verifyHost=false

3. Update the jndi.properties configuration file to use the queue created earlier.

   queue.myDestinationLookup = demoQueue

4. Execute the sender client to send a text message.

5. Execute the receiver client to receive the text message. You should see:

   Received message: Message Text!

Procedure

1. Choose import YAML/JSON from Add to Project drop down

2. Enter the following and click create.

   apiVersion: v1
   kind: Route
   metadata:
     labels:
       app: broker-amq
       application: broker-amq
     name: tcp-ssl
   spec:
     port:
       targetPort: ow-multi-ssl
     tls:
       termination: passthrough
     to:
       kind: Service
       name: broker-amq-headless
       weight: 100
     wildcardPolicy: Subdomain
     host: star.broker-ssl-amq-headless.amq-demo.svc

   Note

   The important configuration here is the wildcard policy of Subdomain. This allows each broker to be accessible through its own hostname.

Procedure

1. Add entries into the /etc/hosts file to map the route name onto the actual IP addresses of the brokers:

   10.0.0.1 broker-amq-0.broker-ssl-amq-headless.amq-demo.svc broker-amq-1.broker-ssl-amq-headless.amq-demo.svc broker-amq-2.broker-ssl-amq-headless.amq-demo.svc

2. Update the jndi.properties configuration file to use the route, truststore, and keystore created previously, for example:

   connectionfactory.myFactoryLookup = amqps://broker-amq-0.broker-ssl-amq-headless.amq-demo.svc:443?transport.keyStoreLocation=/home/ataylor/projects/jboss-amq-7-broker-openshift-image/client.ks&transport.keyStorePassword=password&transport.trustStoreLocation=/home/ataylor/projects/jboss-amq-7-broker-openshift-image/client.ts&transport.trustStorePassword=password&transport.verifyHost=false

3. Update the jndi.properties configuration file to use the queue created earlier.

   queue.myDestinationLookup = demoQueue

4. Execute the sender client code to send a text message.

5. Execute the receiver client code to receive the text message. You should see:

   Received message: Message Text!

Procedure

1. Choose import YAML/JSON from Add to Project drop down.

2. Enter the following and click create.

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       description: The broker's OpenWire port.
       service.alpha.openshift.io/dependencies: >-
         [{"name": "broker-amq-amqp", "kind": "Service"},{"name":
         "broker-amq-mqtt", "kind": "Service"},{"name": "broker-amq-stomp", "kind":
         "Service"}]
     creationTimestamp: '2018-08-29T14:46:33Z'
     labels:
       application: broker
       template: amq-broker-74-statefulset-clustered
     name: broker-external-tcp
     namespace: amq-demo
     resourceVersion: '2450312'
     selfLink: /api/v1/namespaces/amq-demo/services/broker-amq-tcp
     uid: 52631fa0-ab9a-11e8-9380-c280f77be0d0
   spec:
     externalTrafficPolicy: Cluster
     ports:
      -  nodePort: 30001
         port: 61616
         protocol: TCP
         targetPort: 61616
     selector:
       deploymentConfig: broker-amq
     sessionAffinity: None
     type: NodePort
   status:
     loadBalancer: {}

   Note

   The NodePort configuration is important. The NodePort is the port in which the client will access the brokers and the type is NodePort.

Procedure

1. In a terminal create a consumer and attach it to the IP address where OpenShift is running.

   artemis consumer --url tcp://<IP_ADDRESS>:30001 --message-count 100 --destination queue://demoQueue

2. Repeat step 1 twice to start another two consumers.

   Note

   You should now have three consumers load balanced across the three brokers.

3. Create a producer to send messages.

   artemis producer --url tcp://<IP_ADDRESS>:30001 --message-count 300 --destination queue://demoQueue

4. Verify each consumer receives messages.

   Consumer:: filter = null
   Consumer ActiveMQQueue[demoQueue], thread=0 wait until 100 messages are consumed
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumed: 100 messages
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumer thread finished