Merge pull request #63 from matrober-uk/openshift

Samples and instructions for monitoring in OpenShift

Author: ibmmqmet

cp4i/README.md

@@ -0,0 +1,87 @@
+# Monitoring metrics in Cloud Pak for Integration
+This directory contains sample files that show how to deploy the Prometheus
+monitor to expose queue metrics for a queue manager running in a Cloud Pak for
+Integration deployment on Red Hat OpenShift.
+
+The MQ Certified Container that comes in the Cloud Pak for Integration
+emits a range of [queue manager (server) scope metrics](https://www.ibm.com/docs/en/ibm-mq/9.2?topic=containers-metrics-published-by-mq-certified) but does not currently offer an option to
+publish information about queues or topics, so use of an additional Prometheus monitor pod as
+shown below allows queue (and topic) metrics to be published to Prometheus for consumption
+by OpenShift monitoring tools.
+
+The steps to do this are as follows;
+
+```
+# Build the Prometheus monitor container as normal
+cd mq-metric-samples/scripts
+./buildRuntime.sh mq_prometheus
+
+# Tag and push the Docker image to the container registry used by your OpenShift cluster
+docker tag mq-metric-prometheus:5.2.0 your.repo/your-namespace/mq-metric-prometheus:1.0
+docker push your.repo/your-namespace/mq-metric-prometheus:1.0
+
+# Create a ConfigMap and Secret to configure the settings that you wish to apply to your monitor.
+# Update these to suit your requirements
+oc create configmap metrics-configuration \
+    --from-literal=IBMMQ_CONNECTION_QUEUEMANAGER='QM1' \
+    --from-literal=IBMMQ_CONNECTION_CONNNAME='quickstart-cp4i-ibm-mq(1414)' \
+    --from-literal=IBMMQ_CONNECTION_CHANNEL='SYSTEM.DEF.SVRCONN' \
+    --from-literal=IBMMQ_OBJECTS_QUEUES='*,!SYSTEM.*,!AMQ.*' \
+    --from-literal=IBMMQ_OBJECTS_SUBSCRIPTIONS='!$SYS*' \
+    --from-literal=IBMMQ_OBJECTS_TOPICS='!*' \
+    --from-literal=IBMMQ_GLOBAL_USEPUBLICATIONS=false \
+    --from-literal=IBMMQ_GLOBAL_USEOBJECTSTATUS=true \
+    --from-literal=IBMMQ_GLOBAL_CONFIGURATIONFILE='' \
+    --from-literal=IBMMQ_GLOBAL_LOGLEVEL=INFO
+
+oc create secret generic metrics-credentials \
+    --from-literal=IBMMQ_CONNECTION_USER='dummyuser' \
+    --from-literal=IBMMQ_CONNECTION_PASSWORD='dummypassword'
+
+
+
+# Use the samples in this directory to deploy the Prometheus container to OpenShift
+cd mq-metric-samples/cp4i
+
+# Create a new ServiceAccount that will ensure the metrics pod is
+# deployed using the most secure Restricted SCC
+oc apply -f sa-pod-deployer.yaml
+
+# Update the spec.containers.image attribute in metrics-pod.yaml to match
+# your container registry and image name using a text editor
+vi metrics-pod.yaml
+
+# Deploy the metrics pod using the service account
+oc apply -f ./metrics-pod.yaml --as=my-service-account
+
+# Create a Service object that exposes the metrics pod so that it can
+# be discovered by monitoring tools that are looking for Prometheus endpoints
+#
+# Note that the spec.selector.app matches the metadata.labels.app property
+# defined in metrics-pod.yaml
+oc apply -f ./metrics-service.yaml
+```
+
+
+Once the metrics pod is deployed you can see it in action by looking at the logs
+for the pod, and the "IBMMQ Collect" statements showing that the metrics are being
+scraped by the Prometheus agent running in your OpenShift cluster.
+```
+oc logs mq-metric-prometheus
+
+
+IBM MQ metrics exporter for Prometheus monitoring
+Build         : 20210410-173628 
+Commit Level  : 3dd2c0d
+Build Platform: Darwin/
+
+time="2021-04-13T20:12:52Z" level=info msg="Trying to connect as client using ConnName: quickstart-cp4i-ibm-mq(1414), Channel: SYSTEM.DEF.SVRCONN"
+time="2021-04-13T20:12:52Z" level=info msg="Connected to queue manager  QM1"
+time="2021-04-13T20:12:52Z" level=info msg="IBMMQ Describe started"
+time="2021-04-13T20:12:52Z" level=info msg="Platform is UNIX"
+time="2021-04-13T20:12:52Z" level=info msg="Listening on http address :9157"
+time="2021-04-13T20:12:55Z" level=info msg="IBMMQ Collect started 14000001720300"
+time="2021-04-13T20:12:55Z" level=info msg="Collection time = 0 secs"
+time="2021-04-13T20:13:55Z" level=info msg="IBMMQ Collect started 14000003035700"
+time="2021-04-13T20:13:55Z" level=info msg="Collection time = 0 secs"
+```

cp4i/metrics-pod.yaml

@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: mq-metric-prometheus
+  labels:
+    app: mq-metric-prometheus-app
+spec:
+  containers:
+    - name: mq-metric-prometheus
+      image: uk.icr.io/my-icr-namespace/mq-metric-prometheus:1.0
+      envFrom:
+      - configMapRef:
+          name: metrics-configuration
+      - secretRef:
+          name: metrics-credentials
+  restartPolicy: OnFailure
+  imagePullSecrets:
+    - name: all-icr-io

cp4i/metrics-service.yaml

@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: mq-metric-prometheus-service
+  annotations:
+    prometheus.io/scrape: 'true'
+    prometheus.io/port: '9157'
+  labels:
+    app: mq-metric-prometheus
+spec:
+  ports:
+  - name: metrics
+    port: 9157
+    targetPort: 9157
+    protocol: TCP
+  selector:
+    app: mq-metric-prometheus-app
+  type: ClusterIP

cp4i/sa-pod-deployer.yaml

@@ -0,0 +1,25 @@
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: my-service-account
+---
+kind: Role
+apiVersion: rbac.authorization.k8s.io/v1
+metadata:
+  name: pod-interactions
+rules:
+  - apiGroups: [""]
+    resources: ["pods", "pods/exec"]
+    verbs: ["get", "list", "delete", "patch", "create"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: RoleBinding
+metadata:
+  name: pod-interactions
+subjects:
+  - kind: User
+    name: my-service-account
+roleRef:
+  kind: Role
+  name: pod-interactions
+  apiGroup: rbac.authorization.k8s.io