The health check tool verifies the overall health of the Cloud Pak for Data (CPD) Platform and its various components. This tool can be the first step for troubleshooting CPD issues. If you are experiencing any problem with CPD platform, you should run the health check to diagnose possible problems. This tool checks overall CPD platform for detect any possible underlying issues, which impacting your regular operation.
This section targets OpenShift and CPD platform specific checks.
| Validation | Details |
|---|---|
| Nodes status | Validate nodes in ready state |
| Nodes CPU utilization | Flag nodes where CPU usage higher than 80% |
| Nodes memory utilization | Flag nodes where memory usage higher than 80% |
| Time difference between nodes | Validate time difference between nodes not more than 400 ms |
| Nodes memory status | Identify nodes with memory pressure |
| Nodes disk status | Identify nodes with disk pressure |
| Nodes pid status | Identify nodes with PID pressure |
| Deployments status | Validate deployments are healthy |
| Statefulset status | Validate statefulsts are healthy |
| Replicasets status | Validate all replicasets available |
| Daemonsets status | Validate all daemonsets available |
| Routes status | CPD and Openshift console routes accessible |
| Openshift certificates status | Validate certificate signing requests in approve state |
| Openshift ETCD status | All ETCD members are available |
| Persistent volume status | Validate PVs in bound state |
| Persistent volume claims status | Validate PVCs in bound state |
| Pods status | Validate PODs in running state |
| High CPU consuming pods | List top 15 CPU consumed pods |
| High memory consuming pods | List top 15 memory consumed pods |
| High numner of restarted pods | List top 15 pods that restarted |
This section targets most common services e.g., WKC, WML, DV, DataStage etc.
- Components check
- Application check
- Logs or event check
| Validation | Details |
|---|---|
| Portworx pods | All portworx-api pods running |
| Portworx nodes | All Portworx nodes up |
| Portworx volumes | All Portworx volumes up |
| Validation | Details |
|---|---|
| DV pods | All DV pods are exist |
| DV statefulsets | All DV statefulsets are exist |
| DV deployments | All DV deployments are exist |
| DV services | All DV services are exist |
| DV internal database | BIGSQL instance is running |
-
Use any Linux machine with OpenShift client (oc) installed that can connect to the CPD cluster.
-
Clone git repository:
git clone https://github.com/IBM-ICP4D/cpd-health-check-v3.git
- Go to to
Install_Precheck_CPD_v3directory:
cd cpd-health-check-v3
- Login to OpenShift with an user having cluster-admin role:
oc login <OpenShift Console URL> -u <username> -p <password>
- Run the script:
./health_check.sh
The health check tool will direct result outputs to screen, you can view same results in /tmp/HealthCheckResult. Excerpt from a health check results:
