Getting the status of installed components

A Red Hat® OpenShift® project administrator can run the cpd-cli manage get-cr-status command to determine the status of the IBM Cloud Pak® for Data components that are installed in a project (namespace).

Before you begin

You must run this task from a client workstation that has cpd-cli and oc installed. For details, see Setting up a client workstation.
Best practice: You can run the commands in this task exactly as written if you set up environment variables. For instructions, see Setting up installation environment variables.

Ensure that you source the environment variables before you run the commands in this task.

About this task

If you have multiple deployments of Cloud Pak for Data on your cluster, you can run this command against each project where Cloud Pak for Data components are installed.

Procedure

  1. Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example: 
    cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
    Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.
  2. Run the following command to get the status of all of the custom resources in the project: 
    cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE}
    For each component, the output of the command includes the following information:
    • The status from the custom resource
    • The version of the component
    • The timestamp when the custom resource was created
    The output has the following format:
    component,CR-kind,CR-name,status,version,creationtimestamp

    The following table provides more information about the statuses for each custom resource:

    Component Description Statuses
    factsheet AI Factsheets service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    analyticsengine Analytics Engine Powered by Apache Spark service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    bigsql Db2® Big SQL service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    ccs Common core services (automatically installed dependency)
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    cde Cognos® Dashboards service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    cognos_analytics Cognos Analytics service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    cpd_platform Cloud Pak for Data platform (required component)
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    cpfs IBM Cloud Pak foundational services (required component) Not applicable. The only IBM Cloud Pak foundational services component running in the instance namespace is zen.
    replication Data Replication service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    datagate Db2 Data Gate service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    datastage_ent DataStage® Enterprise service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    datastage_ent_plus DataStage Enterprise Plus service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    db2aaservice Db2 as a service (automatically installed dependency)
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    db2oltp Db2 service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    db2u Db2U (automatically installed dependency) This component doesn't support the cpd-cli manage get-cr-status command.
    db2wh Db2 Warehouse service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    dmc Db2 Data Management Console service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    dods Decision Optimization service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    dp Data Privacy service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    datarefinery Data Refinery service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    dv Watson™ Query service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    edb_cp4d EDB Postgres service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    hee Execution Engine for Apache Hadoop service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    iis InfoSphere® Information Server (automatically installed dependency)
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    informix Automatically installed component for the Informix® service (informix_cp4d)
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    informix_cp4d Informix service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    mantaflow Optional component for the Watson Knowledge Catalog service (wkc)

    Automatically installed if you enable the advanced metadata import feature.
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    match360 IBM® Match 360 with Watson service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    mongodb Automatically installed component for the MongoDB service (mongodb_cp4d) Not applicable. This component does not have any custom resources in the instance namespace.
    mongodb_cp4d MongoDB service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    openpages OpenPages® service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    openpages_instance An OpenPages service instance
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    openscale Watson OpenScale service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    planning_analytics Planning Analytics service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    postgresql Automatically installed component for the EDB Postgres service (edb_cp4d) Not applicable. This component does not have any custom resources in the instance namespace.
    productmaster Product Master service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    rstudio RStudio® Server Runtimes service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    scheduler Scheduling service (recommended component)
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    spss SPSS® Modeler service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    voice_gateway Voice Gateway service
    Not ready
    Ready
    The component is running and ready to use.
    watson_assistant Watson Assistant service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    watson_discovery Watson Discovery service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    watson_ks Watson Knowledge Studio service This component doesn't support the cpd-cli manage get-cr-status command.
    watson_speech Watson Speech services
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    Quiesced
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    wkc Watson Knowledge Catalog service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    wml Watson Machine Learning service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    wml_accelerator Watson Machine Learning Accelerator service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    wml_accelerator_instance Watson Machine Learning Accelerator service instance
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    shutdown
    The component is shut down and is not available to use. All of the pods associated with the service are stopped. You must restart the service if you want to use it.
    shutdownError
    The component was not properly shut down. Check the operator logs for errors.
    shutdownInProgress
    The component is being shut down and is not available to use. All of the pods associated with the service are being stopped.
    ws_pipelines Watson Pipelines service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InProgress
    The component is being installed or updated and is not available to use.
    ws Watson Studio service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    ws_runtimes Watson Studio Runtimes service
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.
    zen Cloud Pak for Data control plane
    Completed
    The component is running and ready to use.
    Failed
    The component failed. Check the operator logs for errors.
    InMaintenance
    The component is undergoing maintenance and is temporarily unavailable. The service will be automatically brought back up after maintenance is complete.
    InProgress
    The component is being installed or updated and is not available to use.