health operators command

Check the health of operator namespace resources. This command includes checks on cluster service versions, catalog sources, subscriptions, deployments, and pods.

Prerequisites

  • Log in to Red Hat® OpenShift® Container Platform as a cluster administrator.
  • Verify the configuration file.
    Important: A Kubernetes configuration file must be at either ~/.kube/config or ~/auth/kubeconfig for this command to work. The file must have the target cluster as the current context.

Syntax and command options

The following example shows the syntax that you must use when you run the operators command:

guardcenter-cli health operators \
--control_plane_ns=<instance-controlplane> \
--operator_ns=<operator-namespace-list> \
[--save] \
[--verbose]
Configure the following command options when you run the operators command:
Table 1. operators command options
Option Description
--control_plane_ns The Guardium Data Security Center SaaS control plane namespace.
Status
Required
Syntax
--control_plane_ns=
Default value
${PROJECT_GSP_INST_OPERANDS}
Valid values
The Guardium Data Security Center SaaS control plane namespace.

--help

-h

Display command help.
Status
Optional
Syntax
--help
Default value
Not applicable
Valid values
Not applicabl
--log-level The command log level.
Status
Optional
Syntax
--log-level=debug|trace
Default value
Not applicable
Valid values
debug - debug messages are written to the log.
trace - trace messages are written to the log.
--operator_ns Enter a comma-separated list of operator namespaces.
Status
Required
Syntax
--operator_ns=
Default value
Not applicable
Valid values
Any comma-separated list of operator namespaces.
--save Save the output and resource YAML files to the local file system.
Status
Optional
Syntax
--save
Default value
false
Valid values
true
false
--verbose Display detailed information about resources in table format.
Status
Optional
Syntax
--verbose
Default value
false
Valid values
true
false

Example

The following command example checks the operator in a specific control plane namespace:
cpd-cli health operators \
--control_plane_ns=<control-plane-namespace>
The following example shows a successful output:
Pod Healthcheck
[SUCCESS...]

Pod Usage Healthcheck
[SUCCESS...]

Cluster Service Versions Healthcheck
[SUCCESS...]

Catalog Source Healthcheck
[SUCCESS...]

Install Plan Healthcheck
[SUCCESS...]

Subscriptions Healthcheck
[SUCCESS...]

Persistent Volume Claim Healthcheck
[SKIP...]

Deployment Healthcheck
[SUCCESS...]

Namespace Scopes Healthcheck
[SUCCESS...]

Stateful set Healthcheck
[SKIP...]

Common Services Healthcheck
[SUCCESS...]

Custom Resource Healthcheck
[SKIP...]