health operators

Perform a health check on operator namespace resources. This command includes checks on cluster service versions, catalog sources, subscriptions, deployments and pods. You must log in to the Red Hat OpenShift Container Platform as a cluster administrator to use this command.

Extended description

The operators command provides details about cluster resources. The following information is provided:
  • Detailed information about cluster service versions, catalog source namespaces, subscriptions, install plans, operator groups, namespace scopes.
  • Availability of cluster deployments, StatefulSets, pods, persistent volume claims, and operand requests.
  • ConfigMap information for the cpd-operators namespace.
  • Details about installed services.

Prerequisites

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.
Verify the config file.

A Kubernetes config file must be at either ~/.kube/config or ~/auth/kubeconfig for this command to work. The config file must have the target cluster as the current context.

Syntax

cpd-cli health operators \
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS} \
--operator_ns=<operator-namespace-list> \
[--save] \
[--verbose]

Arguments

The command has no arguments.

Options

Table 1: Command options
Option Description
--control_plane_ns The Cloud Pak for Data control plane namespace.
Status
Required.
Syntax
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS}
Default value
${PROJECT_CPD_INST_OPERANDS}
Valid values
The Cloud Pak for Data control plane namespace.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--log-level The command log level.
Status
Optional.
Syntax
--log-level=debug|trace
Default value
No default.
Valid values
debug
Debug messages are written to the log.
trace
Trace messages are written to the log.
--operator_ns A comma-separated list of operator namespaces.
Status
Required.
Syntax
--operator_ns=<operator-namespace-list>
Default value
<operator-namespace-list>
Valid values
A comma-separated list of operator namespaces.
--save Save output, resource YAML files, and pod container logs 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

Examples

Note: The following examples use the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For more information, see Setting up installation environment variables.

Perform a health check on operator namespace resources. This command includes checks on cluster service versions, catalog sources, subscriptions, deployments and pods. You must log in to the Red Hat OpenShift Container Platform as a cluster administrator to use this command.

cpd-cli health operators \
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS}

Example 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...]
Example verbose output.


############################################################################

                             OPERATOR RESOURCES
                             
############################################################################

                                    
CLUSTER SERVICE VERSIONS INFORMATION
NAMESPACE            NAME               DISPLAY           VERSION	REPLACES              PHASE    
cpd-operators                       	cloud-native-postgresql.v1.18.7            	EDB Postgres for Kubernetes         	1.18.7 	cloud-native-postgresql.v1.18.6	Succeeded
cpd-operators                       	cpd-platform-operator.v5.0.0               	Cloud Pak for Data Platform Operator	5.0.0  	                               	Succeeded
cpd-operators                       	ibm-cert-manager-operator.v4.2.1           	IBM Cert Manager                    	4.2.1  	                               	Succeeded
cpd-operators                       	ibm-common-service-operator.v4.3.0         	IBM Cloud Pak foundational services 	4.3.0  	                               	Succeeded
cpd-operators                       	ibm-commonui-operator.v4.3.0               	Ibm Common UI                       	4.3.0  	                               	Succeeded
cpd-operators                       	ibm-iam-operator.v4.3.0                    	IBM IM Operator                     	4.3.0  	                               	Succeeded
cpd-operators                       	ibm-mongodb-operator.v4.2.1                	IBM MongoDB Operator                	4.2.1  	                               	Succeeded
cpd-operators                       	ibm-namespace-scope-operator.v4.2.1        	IBM NamespaceScope Operator         	4.2.1  	                               	Succeeded
cpd-operators                       	ibm-zen-operator.v5.1.0                    	IBM Zen Service                     	5.1.0  	                               	Succeeded
cpd-operators                       	operand-deployment-lifecycle-manager.v4.2.1	Operand Deployment Lifecycle Manager	4.2.1  	                               	Succeeded
                          
CATALOG SOURCE INFORMATION
NAMESPACE                 	NAME                           	DISPLAY                           	TYPE	PUBLISHER	LAST OBSERVED STATE	ADDRESS                                                
cpd-operators             	cloud-native-postgresql-catalog	ibm-cloud-native-postgresql-4.18.0	grpc	IBM      	READY              	cloud-native-postgresql-catalog.cpd-operators.svc:50051
cpd-operators             	cpd-platform                   	ibm-cp-datacore-4.0.0             	grpc	IBM      	READY              	cpd-platform.cpd-operators.svc:50051                   
cpd-operators             	opencloud-operators            	ibm-cp-common-services-4.3.0      	grpc	IBM      	READY              	opencloud-operators.cpd-operators.svc:50051            
                        
SUBSCRIPTION INFORMATION
NAMESPACE               	NAME                                    	PACKAGE                     	SOURCE                         	CHANNEL	INSTALLED CSV                              
cpd-operators           	cloud-native-postgresql                 	cloud-native-postgresql     	cloud-native-postgresql-catalog	stable 	cloud-native-postgresql.v1.18.7            
cpd-operators           	cpd-operator                            	cpd-platform-operator       	cpd-platform                   	v5.0   	cpd-platform-operator.v5.0.0               
cpd-operators           	ibm-common-service-operator             	ibm-common-service-operator 	opencloud-operators            	v4.3   	ibm-common-service-operator.v4.3.0         
cpd-operators           	ibm-idp-config-ui-operator              	ibm-commonui-operator-app   	opencloud-operators            	v4.3   	ibm-commonui-operator.v4.3.0               
cpd-operators           	ibm-im-mongodb-operator                 	ibm-mongodb-operator-app    	opencloud-operators            	v4.2   	ibm-mongodb-operator.v4.2.1                
cpd-operators           	ibm-im-operator                         	ibm-iam-operator            	opencloud-operators            	v4.3   	ibm-iam-operator.v4.3.0                    
cpd-operators           	ibm-namespace-scope-operator            	ibm-namespace-scope-operator	opencloud-operators            	v4.2   	ibm-namespace-scope-operator.v4.2.1        
cpd-operators           	ibm-platformui-operator                 	ibm-zen-operator            	opencloud-operators            	v4.3   	ibm-zen-operator.v5.1.0                    
cpd-operators           	operand-deployment-lifecycle-manager-app	ibm-odlm                    	opencloud-operators            	v4.2   	operand-deployment-lifecycle-manager.v4.2.1
                        
INSTALL PLAN INFORMATION
NAMESPACE               	NAME         	CSV                            	APPROVAL 	APPROVED
cpd-operators           	install-26v2b	ibm-mongodb-operator.v4.2.1    	Automatic	true    
cpd-operators           	install-7nxhq	cloud-native-postgresql.v1.18.7	Automatic	true    
cpd-operators           	install-rnpck	ibm-zen-operator.v5.1.0        	Automatic	true    
cpd-operators           	install-tkd5d	cpd-platform-operator.v5.0.0   	Automatic	true    
cpd-operators           	install-x9bd6	ibm-zen-operator.v5.1.0        	Automatic	true    
                          
OPERATOR GROUP INFORMATION
NAMESPACE                 	NAME          
cpd-operators             	common-service
                            
NAMESPACE SCOPES INFORMATION
NAMESPACE                   	NAME          
cpd-operators               	common-service
                      
DEPLOYMENT INFORMATION
NAMESPACE             	NAME                                         	READY	UP-TO-DATE	AVAILABLE	AGE
cpd-operators         	cpd-platform-operator-manager                	1    	1         	1        	9h 
cpd-operators         	ibm-common-service-operator                  	1    	1         	1        	7h 
cpd-operators         	ibm-commonui-operator                        	1    	1         	1        	10h
cpd-operators         	ibm-iam-operator                             		1    	1         	1        	10h
cpd-operators         	ibm-mongodb-operator                         	1    	1         	1        	10h
cpd-operators         	ibm-namespace-scope-operator                 	1    	1         	1        	7h 
cpd-operators         	ibm-zen-operator                             		1    	1         	1        	10h
cpd-operators         	meta-api-deploy                              		1    	1         	1        	10h
cpd-operators         	operand-deployment-lifecycle-manager         1    	1         	1        	7h 
cpd-operators         	postgresql-operator-controller-manager-1-18-71    	1         	1        	10h
                                                               
STATEFUL SET INFORMATION                                       
NAMESPACE                                       NAME	READY	AVAILABLE	AGE
[INFO...] Could not find stateful sets for namespace cpd-operators, continuing with other namespaces if applicable. 
                
PODS INFORMATION
NAMESPACE       	NAME                                                           	READY	PHASE    	RESTARTS	AGE	CPU_REQUEST	CPU_LIMIT	CPU_USAGE	CPU_USAGE_%	MEMORY_REQUEST	MEMORY_LIMIT	MEMORY_USAGE	MEMORY_USAGE_%
cpd-operators   	010d5e725a9ae183b7fe7ed91b77f16a5a3535105cafc4de06daacc041c75ml	0/1  	Succeeded	0       	7h 	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	0ce0cef3028a8b8740eb6c633a7b8adee31c5cfe3fd7f9a56f7d07fa91hwkd7	0/1  	Succeeded	0       	10h	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	260a050ed5fd9f19c40d0e0e9850c3fd2145fb9d54bcfc29a08cacc5144cvrs	0/1  	Succeeded	0       	7h 	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	3a2264d2e7a09b9de734c49f534a979a0e0d0f2dde402396255a3136cckk4qf	0/1  	Succeeded	0       	10h	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	5ebe31e3dcbc27a2ac7cf4370675da68e623207ce130e73594a06a20dbmp478	0/1  	Succeeded	0       	10h	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	a2b29a3cf69b451d567694698f29e10299502c94edbac2adf0866ce36dzmvck	0/1  	Succeeded	0       	7h 	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	c328aaa28a153afc8d2766acc4c73f81cf5e98aa2dc24fa9d94f28661cpcdv5	0/1  	Succeeded	0       	10h	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	ca668b00fa1c534ffad38b93834aa18244b707c9b147e57cc928d66eaepb58c	0/1  	Succeeded	0       	10h	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	cloud-native-postgresql-catalog-nw4b4                          	1/1  	Running  	0       	7h 	0 mCPU     	10 mCPU  	2 mCPU   	0.00 %     	50 MiB        	0 MiB       	62 MiB      	0.00 %        
cpd-operators   	cpd-platform-operator-manager-6fd69d9bcc-vdglc                 	1/1  	Running  	0       	9h 	500 mCPU   	100 mCPU 	0 mCPU   	0.00 %     	256 MiB       	1024 MiB    	206 MiB     	20.12 %       
cpd-operators   	cpd-platform-xln7z                                             	1/1  	Running  	0       	9h 	0 mCPU     	10 mCPU  	3 mCPU   	0.00 %     	50 MiB        	0 MiB       	34 MiB      	0.00 %        
cpd-operators   	create-postgres-license-config-7xnp9                           	0/1  	Succeeded	0       	10h	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	df7707049dd889e184f3d6ba440823b559a2e5569bc9b3e4216f90efeap9s2w	0/1  	Succeeded	0       	9h 	0          	0        	0        	0          	0             	0           	0           	0             
cpd-operators   	ibm-common-service-operator-6cb4b7d6d9-9pdf4                   	1/1  	Running  	0       	7h 	500 mCPU   	100 mCPU 	3 mCPU   	0.60 %     	200 MiB       	512 MiB     	39 MiB      	7.62 %        
cpd-operators   	ibm-commonui-operator-687f6f4d69-fqpb6                         	1/1  	Running  	0       	10h	40 mCPU    	10 mCPU  	1 mCPU   	2.50 %     	25 MiB        	150 MiB     	38 MiB      	25.33 %       
cpd-operators   	ibm-iam-operator-7dd565d9f7-q88zp                              	1/1  	Running  	1       	10h	25 mCPU    	10 mCPU  	1 mCPU   	4.00 %     	80 MiB        	320 MiB     	49 MiB      	15.31 %       
cpd-operators   	ibm-mongodb-operator-6788bf6d98-b9q6n                          	1/1  	Running  	0       	10h	40 mCPU    	40 mCPU  	0 mCPU   	0.00 %     	200 MiB       	200 MiB     	35 MiB      	17.50 %       
cpd-operators   	ibm-namespace-scope-operator-b84c799d5-kjdcj                   	1/1  	Running  	0       	7h 	500 mCPU   		100 mCPU 	0 mCPU   	0.00 %     	200 MiB       	512 MiB     	26 MiB      	5.08 %        
cpd-operators   	ibm-zen-operator-fd56bb9b4-l82qn                               	1/1  	Running  	0       	10h	500 mCPU   	100 mCPU 	1 mCPU   	0.20 %     	256 MiB       	2048 MiB    	378 MiB     	18.46 %       
cpd-operators   	meta-api-deploy-6f9d9fbdb7-8dhff                               	1/1  	Running  	0       	10h	500 mCPU   	100 mCPU 	1 mCPU   	0.20 %     	256 MiB       	1024 MiB    	113 MiB     	11.04 %       
cpd-operators   	opencloud-operators-fqg7b                                      	1/1  	Running  	0       	7h 	0 mCPU     	10 mCPU  	3 mCPU   	0.00 %     	50 MiB        	0 MiB       	49 MiB      	0.00 %        
cpd-operators   	operand-deployment-lifecycle-manager-79c497b5d7-pwhdx          	1/1  	Running  	0       	7h 	500 mCPU   	200 mCPU 	0 mCPU   	0.00 %     	200 MiB       	512 MiB     	33 MiB      	6.45 %        
cpd-operators   	postgresql-operator-controller-manager-1-18-7-678bf6d8cd-shm6x 	1/1  	Running  	0       	10h	1100 mCPU  	500 mCPU 	3 mCPU   	0.27 %     	200 MiB       	1024 MiB    	47 MiB      	4.59 %        
cpd-operators   	setup-job-lgp7s                                                	0/1  	Succeeded	0       	10h	0          	0        	0        	0          	0             	0           	0           	0             
                                                               
PERSISTENT VOLUME CLAIMS INFORMATION                           
NAME                                                           	STATUS	VOLUME	CAPACITY	ACCESS MODES	STORAGE CLASS	AGE
[INFO...] Could not find PVC for namespace                     
cpd-operators, continuing with other namespaces if applicable. 
                           
OPERAND REQUEST INFORMATION
NAMESPACE                  	NAME                  	PHASE  
cpd-operators              	im-service            	Running
cpd-operators              	zen-ca-operand-request	Running
cpd-operators              	zen-service           	Running
                     
CONFIGMAP INFORMATION
NAMESPACE            	NAME                                                           	DATA
cpd-operators        	010d5e725a9ae183b7fe7ed91b77f16a5a3535105cafc4de06daacc04159ecb	0   
cpd-operators        	0ce0cef3028a8b8740eb6c633a7b8adee31c5cfe3fd7f9a56f7d07fa91b1883	0   
cpd-operators        	260a050ed5fd9f19c40d0e0e9850c3fd2145fb9d54bcfc29a08cacc514df65f	0   
cpd-operators        	3a2264d2e7a09b9de734c49f534a979a0e0d0f2dde402396255a3136cc9d4bc	0   
cpd-operators        	5ebe31e3dcbc27a2ac7cf4370675da68e623207ce130e73594a06a20db63c1c	0   
cpd-operators        	a2b29a3cf69b451d567694698f29e10299502c94edbac2adf0866ce36d5788b	0   
cpd-operators        	c328aaa28a153afc8d2766acc4c73f81cf5e98aa2dc24fa9d94f28661c5ee7c	0   
cpd-operators        	ca668b00fa1c534ffad38b93834aa18244b707c9b147e57cc928d66eae15a51	0   
cpd-operators        	cloud-native-postgresql-image-list                             	5   
cpd-operators        	df7707049dd889e184f3d6ba440823b559a2e5569bc9b3e4216f90efea14a84	0   
cpd-operators        	ibm-bedrock-version                                            	1   
cpd-operators        	ibm-cpp-config                                                 	3   
cpd-operators        	ibm-iam-bindinfo-ibmcloud-cluster-info                         	10  
cpd-operators        	ibm-iam-bindinfo-oauth-client-map                              	4   
cpd-operators        	ibm-iam-bindinfo-platform-auth-idp                             	81  
cpd-operators        	ibm-iam-operator-lock                                          	0   
cpd-operators        	kube-root-ca.crt                                               	1   
cpd-operators        	namespace-scope                                                	1   
cpd-operators        	openshift-service-ca.crt                                       	1   
cpd-operators        	postgresql-operator-default-monitoring                         	1   
               
SVC INFORMATION
NAMESPACE      	NAME                                                    	TYPE     	CLUSTERIP     	PORT 
cpd-operators  	cloud-native-postgresql-catalog                         	ClusterIP	172.30.68.147 	50051
cpd-operators  	cpd-platform                                            	ClusterIP	172.30.172.104	50051
cpd-operators  	cpd-platform-operator-controller-manager-metrics-service	ClusterIP	172.30.174.144	8443 
cpd-operators  	ibm-common-service-operator-service                     	ClusterIP	172.30.74.237 	443  
cpd-operators  	meta-api-svc                                            	ClusterIP	172.30.123.205	4444 
cpd-operators  	opencloud-operators                                     	ClusterIP	172.30.196.163	50051
cpd-operators  	postgresql-operator-controller-manager-1-18-7-service   	ClusterIP	172.30.251.28 	443  
cpd-operators  	postgresql-operator-webhook-service                     	ClusterIP	172.30.70.74  	443  
cpd-operators  	webhook-service                                         	ClusterIP	172.30.154.95 	443  
                             
COMMON SERVICES INFORMATION: 
NAMESPACE                    	NAME          	PHASE    
cpd-operators                	common-service	Succeeded