health

Query the health of your Red Hat OpenShift cluster and the Cloud Pak for Data platform.

Extended description

The cpd-cli health commands perform health checks on your Cloud Pak for Data 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 Cloud Pak for Data 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 Cloud Pak for Data installation or upgrade success. The prerequisites check can help to ensure the readiness for your Cloud Pak for Data platform to proceed with an installation or upgrade.

  1. Before you install Cloud Pak for Data, 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 Cloud Pak for Data installation.

  2. After you install Cloud Pak for Data, you can run the operators and operands commands to check the basic health of your Cloud Pak for Data installation.

  3. Before you upgrade Cloud Pak for Data, Cloud Pak for Data, you can run the cluster and nodes commands to validate the health of your cluster.

  4. After you upgrade Cloud Pak for Data, you can run the operators and operands commands to check the basic health of your Cloud Pak for Data 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 Cloud Pak for Data 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 Cloud Pak for Data 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 Cloud Pak for Data, 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 13.1.5 command-line utility for your operating system and Cloud Pak for Data edition. For more information, see Installing the Cloud Pak for Data 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