Monitoring the API Connect cluster on OpenShift

Monitor the status of the API Connect cluster on OpenShift using either the command line or the OpenShift web console.

Note: For information on viewing the Postgres disk status, see Monitoring Postgres disk usage on OpenShift.

Monitoring the API Connect cluster using the command line

Individual subsystem installations: Run the oc get command on each subsystem CR:

Management:

oc get mgmt

NAME             READY   STATUS    VERSION    RECONCILED VERSION   MESSAGE               AGE
small-ocp-mgmt   18/18   Running   10.0.8.0   10.0.8.0-258         Management is ready   53d

Portal

oc get ptl

NAME            READY   STATUS    VERSION    RECONCILED VERSION   MESSAGE          AGE
small-ocp-ptl   4/4     Running   10.0.8.0   10.0.8.0-258         Serving 1 site   53d

Analytics

oc get a7s

NAME            READY   STATUS    VERSION    RECONCILED VERSION   AGE
small-ocp-a7s   7/7     Running   10.0.8.0   10.0.8.0-258         53d

Gateway

oc get gw


NAME           READY   STATUS    VERSION    RECONCILED VERSION   AGE
small-ocp-gw   2/2     Running   10.0.8.0   10.0.8.0-258         53d

Top-level CR installations: Run the following command to display the status of the API Connect cluster:

oc get apiconnectcluster -n <APIC_namespace>

The response looks like the following example:

NAME         READY   STATUS   VERSION        RECONCILED VERSION   AGE
production   7/7     Ready    10.0.8.0   10.0.8.0-3323    24h

The following list explains the values in the response:

NAME: Name of the API Connect cluster or subsystem instance.
READY: Current number of components that are running / Expected number of components that should be running.
STATUS: Current status of API Connect or the subsystem.
If the status says Warning, then run oc describe <CR> and check for more details in the Status sections.
VERSION: API Connect version specified in the CR's spec.version setting.
RECONCILED VERSION: Current API Connect version.
AGE: Age of the CR.

Monitoring the API Connect cluster using the OpenShift web console

Start the OpenShift web console.
Click Installed operators.
Locate the namespace (project) where you installed API Connect:
- If you installed the API Connect operator in all namespaces, select openshift-operators
- if you installed the API Connect operator in a single namespace, select specific project
Select the IBM API Connect operator.
Select All instances for an overview of all operands in your API Connect namespace.
If you have a top-level CR installation, then click API Connect Cluster.
1. On the API Connect Clusters page, check the Status column.
  The status should display "Ready" as in the following image:
2. Click the instance name (in the example, the instance name is production to display the status overview page.
  The overview page displays high-level information about your deployment, as in the following image:
  
  Also on the overview page, the "Conditions" section displays the list of possible service conditions, as in the following image:
  
  A healthy deployment displays "True" for the "Ready" status.
  
  During a fresh install, an upgrade or a day-2 operation (such as a Management backup S3 configuration change), the apiconnectcluster CR status might change to a different state depending on the action, but ultimately it should always reach the Ready status.