Debugging cluster add-ons

Virtual Private Cloud Classic infrastructure

As you use Red Hat® OpenShift® on IBM Cloud®, consider these techniques for troubleshooting managed add-ons, such as HPCS Router.

You can check the health state and status of a cluster add-on by running the following command.

ibmcloud oc cluster addon ls -c <cluster_name_or_ID>

Example output

Name            Version   Health State   Health Status
debug-tool      2.0.0     normal         Addon Ready

The Health State reflects the lifecycle of the add-on components. Each state is described in the following table.

Add-on health states
Add-on health state	Description
`critical`	The add-on is not ready to be used for one of the following reasons: Some or all the add-on components are unhealthy. The add-on failed to deploy. The add-on might be at an unsupported version. Check the Health Status field for more information.
`normal`	The add-on is successfully deployed. Check the status to verify that the add-on is `Ready` or to see if an update is available.
`pending`	Some or all components of the add-on are currently deploying. Wait for the state to become `normal` before working with your add-on.
`updating`	The add-on is updating and is not ready to be used. Check the Health Status field for the version that the add-on is updating to.
`warning`	The add-on might not function properly due to cluster limitations. Check the Health Status field for more information.

The Health Status provides details of what add-on operation is in progress. Each status is described in the following table.

Add-on health statuses
Status code	Add-on health status	Description
H1500	`Addon Ready`	The add-on is successfully deployed and is healthy.
H1501, H1502, H1503	`Addon Not Ready`	Some or all the add-on components are unhealthy. Check whether all add-on component pods are running. Satellite clusters: Also see Why doesn't my cluster add-on work?.
H1504, H1505, H1506, H1507, H1508	`Failure determining health status.`	The add-on health can't be determined. Open a support case. In the description, include the error code from the health status.
H1509	`Addon Unsupported`	The add-on runs an unsupported version, or the add-on version is unsupported for your cluster version. Update your add-on to the latest version.
H1510	`Cluster resources low, not enough workers in Ready state.`	The add-on is not ready to be used for one of the following reasons: The cluster does not meet the size criteria for the add-on. Worker nodes in your cluster are not in a `Normal` state. Review the worker nodes' state and status.
	`Enabling`	The add-on is currently deploying to the cluster. Note that the add-on might take up to 15 minutes to install.
H1512	`Addon daemonset might not be available on all Ready nodes.`	For the static route add-on: The static route operator `DaemonSet` is not available on any worker nodes, which prevents you from applying static route resources. Your worker nodes can't run the static route operator `DaemonSet` for the following reasons: One or more worker nodes reached their resource limits. One or more worker nodes are running the maximum number of pods per worker node.