Deploying a queue manager onto a Red Hat OpenShift Container Platform cluster

This example deploys a "quick start" queue manager, which uses ephemeral (non-persistent) storage, and turns off IBM® MQ security. Messages are not persisted across restarts of the queue manager. You can adjust the configuration to change many queue manager settings.

About this task

This task offers 3 options for deploying a queue manager onto OpenShift®:

Deploy a queue manager with the OpenShift console.
Deploy a queue manager with the OpenShift CLI.
Deploy a queue manager with the IBM Cloud Pak® for Integration Platform UI.

Procedure

Option 1: Deploy a queue manager with the OpenShift console.
1. Deploy a queue manager.
  1. Log in to the OpenShift console with your Red Hat® OpenShift Container Platform cluster administrator credentials.
  2. Change Project to the namespace where you installed the IBM MQ Operator. Select the namespace from the Project drop-down list.
  3. In the navigation pane, click Operators > Installed Operators.
  4. In the list on the Installed Operators panel, find and click IBM MQ.
  5. Click on the Queue Manager tab.
  6. Click on the Create QueueManager button. The instance creation panel is displayed, and offers two methods for configuring the resource; the Form view and the YAML view. The Form view is selected by default.
2. Configure the queue manager.
  Step 2 Option 1: Configure in the Form view.
  The Form view opens a form that you can use to view or modify the resource configuration.
  1. Next to License, click the arrow to expand the license acceptance section.
  2. Set License accept to true if you accept the license agreement.
  3. Click the arrow to open the drop-down list, and select a license. IBM MQ is available under several different licenses. For more information on the valid licenses, see Licensing reference for mq.ibm.com/v1beta1. You must accept the license to deploy a queue manager.
  4. Click Create. The list of queue managers in the current project (namespace) is now displayed. The new QueueManager should be in a Pending state.
  Step 2 Option 2: Configure in the YAML view.
  The YAML view opens an editor containing an example YAML file for a QueueManager. Update the values in the file by following the steps below.
  1. Change metadata.namespace to your project (namespace) name.
  2. Change the value of spec.license.license to the license string that matches your requirements. See Licensing reference for mq.ibm.com/v1beta1 for the license details.
  3. Change spec.license.accept to true if you accept the license agreement.
  4. Click Create. The list of queue managers in the current project (namespace) is now displayed. The new QueueManager should be in a Pending state.
3. Verify queue manager creation.
  You can verify that you've created a Queue Manager by completing the following steps:
  1. Ensure that you're in the namespace that you created your IBM MQ Operator in.
  2. From the Home screen, click Operators > Installed Operators, then select the installed IBM MQ Operator that you created the queue manager for.
  3. Click on the Queue Manager tab. The creation is complete when the QueueManager status is Running.
Option 2: Deploy a queue manager with the OpenShift CLI.
1. Create a QueueManager YAML file
  For example, to install a basic queue manager in IBM Cloud Pak for Integration, create the file "mq-quickstart.yaml" with the following contents:
```
apiVersion: mq.ibm.com/v1beta1
kind: QueueManager
metadata:
  name: quickstart-cp4i
spec:
  version: 9.3.5.1-r2
  license:
    accept: false
    license: L-VTPK-22YZPK
    use: NonProduction
  web:
    enabled: true
  queueManager:
    name: "QUICKSTART"
    storage:
      queueManager:
        type: ephemeral
```
  Important: If you accept the license agreement, change accept: false to accept: true. See Licensing reference for mq.ibm.com/v1beta1 for details on the license.
  This example also includes a web server deployed with the queue manager, with the web console enabled with Single Sign-On within IBM Cloud Pak for Integration. From IBM Cloud Pak for Integration 2023.4.1, for Single Sign-On to work, you will first need to install other IBM Cloud Pak for Integration components.
  To install a basic queue manager independently of IBM Cloud Pak for Integration, create the file "mq-quickstart.yaml" with the following contents:
```
apiVersion: mq.ibm.com/v1beta1
kind: QueueManager
metadata:
  name: quickstart
spec:
  version: 9.3.5.1-r2
  license:
    accept: false
    license: L-AMRD-XH6P3Q
  web:
    enabled: true
  queueManager:
    name: "QUICKSTART"
    storage:
      queueManager:
        type: ephemeral
```
  Important:If you accept the MQ license agreement, change accept: false to accept: true. See Licensing reference for mq.ibm.com/v1beta1 for details on the license.
2. Create the QueueManager object.
```
oc apply -f mq-quickstart.yaml
```
3. Verify queue manager creation.
  Verify that you've created a queue manager by completing the following steps:
  1. Validate the deployment:
```
oc describe queuemanager <QueueManagerResourceName>
```
  2. Check the status:
```
oc describe queuemanager quickstart
```
Option 3: Deploy a queue manager with the IBM Cloud Pak for Integration Platform UI.
1. In a browser, launch the IBM Cloud Pak for Integration Platform UI.
2. In the IBM Cloud Pak for Integration Platform UI, click Create instance.
3. Select Messaging, then click Next.
  
  The instance creation panel is displayed, and offers two methods for configuring the resource; the Form view and the YAML view. The Form view is selected by default.
4. In the Details section, check or update the Name field, and specify the Namespace in which to create the queue manager instance.
5. If you accept the IBM Cloud Pak for Integration license agreement, change License acceptance to On.
  
  See Licensing reference for mq.ibm.com/v1beta1 for details on the license. You must accept the license to deploy a queue manager.
6. In the Queue Manager section, check or update the Name of the underlying queue manager. In older versions of the IBM Cloud Pak for Integration Platform UI, use the Queue Manager Config section.
  By default, the name of the queue manager used by IBM MQ client applications is the same as the name of the QueueManager, but with any invalid characters (such as hyphens) removed.
7. Click Create
  The list of queue managers in the current project (namespace) is now displayed. The new QueueManager should have a status of Pending
8. Verify queue manager creation.
  The creation is complete when the QueueManager status is Running.