/mq-pvc-tool

A tool for inspecting the Persistent Volume Claims associated with Queue Manager pods on OpenShift

Primary LanguageShellApache License 2.0Apache-2.0

MQ PVC Inspector tool

This tool is designed to be used with MQ on Red Hat OpenShift Container Platform or Kubernetes. The tool enables errors and other information to be gathered from the PVCs of a Queue Manager in the case where the Queue Manager pod cannot be directly accessed. This could be due to a CrashLoopBackoff, Error or some other cause. This tool is designed for use with Queue Managers deployed by the MQ Operator.

In OpenShift a Queue Manager can have multiple pods associated with it, and each of those pods can have multiple PVCs. This tool will mount the PVCs associated with all Queue Manager pods of a Queue Manager deployment to a set of PVC inspector pods. By mounting the PVCs to the inspector pods the files can be accessed within the inspector pods.

Running the tool

  1. To use the tool simply run:./pvc-tool.sh <queue-manager name> <queue-manager namespace>

    Between 1 and 3 PVC inspector pods will be created. Each inspector pod corresponds to each of the queue manager pods and their files.

  2. To access the files run: oc rsh <pvc-inspector-pod-name>

    The pod contains a folder for each of the PVCs that have been mounted. Its name is the same as that of the PVC.

  3. To cleanup the PVC inspector pods simply run: oc delete pods -l tool=mq-pvc-inspector

    This will delete all PVC inspector pods. It will cause no change to the queue manager or PVCs themselves.

Suggestions on applying the tool to Queue Manager pods not deployed by the MQ Operator

This tool has been created for use with Queue Managers deployed by the MQ Operator. In order to use this tool without the MQ Operator the file pvc-tool.sh needs to be modified. Currently the pods associated with a given Queue Manager are identified with the label 'app.kubernetes.io/instance=$1'. Where $1 is the Queue Manager name. If you create or already have a common label across your Queue Manager pods then the aforementioned label can be replaced with your custom label.

Issues and contributions

For issues relating to this tool, please use the GitHub issue tracker associated with this repository. If you do submit a Pull Request related to this tool, please indicate in the Pull Request that you accept and agree to be bound by the terms of the Developer's Certificate of Origin.

Copyright

© Copyright IBM Corporation 2022