OpenShift Support
RedHat OpenShift is a container platform built upon and extending the Kubernetes functionality.
The Microgateway OpenShift support provides the following, in the same way as the Kubernetes support does:
Liveliness check to support Kubernetes pod lifecycle. This helps in verifying whether the
Microgateway container is up and responding. You can perform the liveliness check by checking the alive file of
Microgateway.
Readiness check to support Kubernetes pod lifecycle. This helps in verifying whether the
Microgateway container is ready to serve requests.
For details on pod lifecycle, see Kubernetes documentation.
Prometheus metrics to support monitoring of the
Microgateway pods.
Microgateway exposes metrics in the Prometheus format. The Prometheus based monitoring provides information relevant for the
Microgateway operation. You use the metrics endpoint
/rest/microgateway/metrics to gather the required metrics. The metrics gathered are of two types; the server-level metrics and API-level metrics. For details about the server-level metrics and API-level metrics collected, see
Prometheus Microgateway Metrics.
In addition, the Docker images built from the Dockerfiles created by the Microgateway CLI createDockerFile command are ready to be deployed on OpenShift. The only exception to this is the sidecar pattern where Microgateway is injected into an existing Docker image representing a native service. The Microgateway Dockerfile only ensures that the Microgateway installation inside the Docker image is prepared for OpenShift. This means that the Docker image with the native service has to be ready for OpenShift as a prerequisite. For details about how to prepare a Docker image for OpenShift, see the Creating images section in
Docker documentation at
https://docs.okd.io/.
If you cannot modify the Docker image with the native service, for example, if the image comes from a third party, OpenShift provides the option to run such an image with a service account that has specific permissions.
To run a sidecar Docker image, which cannot be modified by a native service, use the OpenShift oc command line tool to perform the following steps with the built-in sagadmin user:
1. Create a new service account named runassagadmin .
oc create serviceaccount runassagadmin
2. Assign the permission to the service account runassagadmin to use the built-in user of the Docker image.
oc adm policy add-scc-to-user anyuid -z runassagadmin
Note:
You must have OpenShift administrator privileges to perform this step.
3. In the yaml configuration file for Microgateway, set the field spec.template.spec.serviceAccountName to runassagadmin.