health

Query the health of your Red Hat OpenShift cluster and IBM Software Hub.

Tip: Schedule to run your service-functionality health checks when the cluster has sufficient resources. Running the service-functionality health checks can temporarily create service instances and use resources.

Extended description

The cpd-cli health commands perform health checks on your IBM® Software Hub deployment on a Red Hat® OpenShift® cluster. You can also run a combination of commands as one command by using cpd-cli health runcommand. For example, the cluster, nodes, operators, and operands commands can be invoked together.

Health checks are important for IBM Software Hub installation, Day 2 operations, and also for regular maintenance. You can use the output from the cpd-cli health commands when you provide information to IBM Support.

When should you use health commands?

The health of your Red Hat OpenShift cluster, storage, and services (for upgrade), are prerequisites for any IBM Software Hub installation or upgrade success. The prerequisites check can help to ensure the readiness for your IBM Software Hub platform to proceed with an installation or upgrade.

  1. Before you install IBM Software Hub, you can run the cluster and nodes commands to validate the health of your Red Hat OpenShift cluster.

    You can also run the storage-validation and storage-performance commands to validate the health of your storage.

    These commands do not require a IBM Software Hub installation.

  2. After you install IBM Software Hub, you can run the operators and operands commands to check the basic health of your IBM Software Hub installation.

  3. Before you upgrade IBM Software Hub, IBM Software Hub, you can run the cluster and nodes commands to validate the health of your cluster.

  4. After you upgrade IBM Software Hub, you can run the operators and operands commands to check the basic health of your IBM Software Hub upgrade.

You can use any of the cpd-cli health commands to perform regular health checks or to provide more information when you open a case with IBM Support.

Ensure system stability.
Health checks monitor the IBM Software Hub platform and services, Red Hat OpenShift and storage to ensure that the system is functioning correctly and to identify any potential issues.
Maintain system performance.
Regular health checks can help to ensure that IBM Software Hub continues to perform optimally by detecting and addressing any performance bottlenecks. Administrators can maintain historical records to support requests for resource increases.
Improve reliability.
By monitoring the health of IBM Software Hub, you can proactively identify and resolve issues that might potentially cause downtime or data loss.
Include detailed health check results and diagnostics when you troubleshoot issues.
The health commands can also be run in conjunction with the diag commands to provide health information to IBM Support. You can use the --save option of the health commands and the --output of the gather-diagnostics command to generate files.

Prerequisites

Download cpd-cli.
Before you run any cpd-cli commands, ensure that you downloaded the cpd-cli 14.2.2 command-line utility. For more information, see Installing the IBM Software Hub command-line interface (cpd-cli).
Log in to the cluster.
Log in to Red Hat OpenShift Container Platform as a cluster administrator.
${OC_LOGIN}
Remember: OC_LOGIN is an alias for the oc login command.

Required permissions

The health command requires cluster administrator or similar roles. Health checks can be performed on certain resources or skipped depending on the permissions of the user.

Commands