[OpenShift Container Platform][MQ 9.4.0 Jun 2024][Amazon EKS][MQ 9.4.0 Jun 2024]

Stopping a queue manager (mq.ibm.com/stop)

Stop a queue manager by adding an annotation to the queue manager definition.

About this task

Queue managers created by the IBM MQ Operator have an associated StatefulSet. This StatefulSet declares the number of Pods to be deployed for a given queue manager availability type through the '.replicas' field. This takes the value of 1 (Single Instance), 2 (Multi Instance) or 3 (NativeHA).

Note: Manually changing the value in the '.replicas' field prevents the queue manager from functioning correctly.

In some cases you might want to stop your queue manager so that the StatefulSet has a replica count of 0 and no Pods are deployed. Examples of when you might want to do this include during maintenance or a backup procedure.

Note: Because there are no queue manager Pods deployed when the queue manager is stopped, you and your applications will not be able to access the queue manager until it is started again.

Procedure

  • To stop your queue manager, add the following annotation to the queue manager definition under the '.metadata.annotations' section. 
    apiVersion: mq.ibm.com/v1beta1
kind: QueueManager
metadata:
  name: my-qm
  annotations:
    "mq.ibm.com/stop" : "true"
  • To restart the queue manager and return it to its correct number of replicas, remove the annotation from the queue manager or set its value to 'false'.