health service-functionality cleanup

Remove all artifacts that were created by the service-functionality checks. Run this command when service-functionality checks were interrupted or failed.

Important: You cannot run any service-functionality commands as part of the runcommand command.

Prerequisites

Create a profile to use the cpd-cli management commands.

Pulling the required image from a private container registry

The ibm-service-functionality image is automatically mirrored when you mirror the IBM Software Hub images to your private container registry.

Before you run the cpd-cli health service-functionality command, you must authorize the client runtime environment on your workstation to pull the ibm-service-functionality image from the private container registry:

  1. Ensure that Docker or Podman is running on the client workstation.
  2. Source your installation environment variables script.
  3. Authenticate to your private container registry:
    • Docker
      docker login ${PRIVATE_REGISTRY_LOCATION} \
-u ${PRIVATE_REGISTRY_PULL_USER} \
-p ${PRIVATE_REGISTRY_PULL_PASSWORD}
    • Podman
      podman login ${PRIVATE_REGISTRY_LOCATION} \
-u ${PRIVATE_REGISTRY_PULL_USER} \
-p ${PRIVATE_REGISTRY_PULL_PASSWORD}

To use the ibm-service-functionality image from your private container registry, you must specify the following options when you run the cpd-cli health service-functionality command:

  • --image-prefix
  • --image-tag

For example:

cpd-cli health service-functionality \
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS} \
--profile=${CPD_PROFILE_NAME} \
--image-prefix=${PRIVATE_REGISTRY_LOCATION} \
--image-tag=${VERSION}.${IMAGE_ARCH}

Syntax

cpd-cli health service-functionality cleanup \
--control_plane_ns=<project-cpd-inst-operands> \
--profile=<cpd-profile-name> \
[--image-prefix=<image-registry-prefix>] \
[--image-tag=<image-tag> \
[--log-level=debug|trace] \
[--save] \
[--services=<comma-separated-list-of-service-keys>] \
[--verbose]

Arguments

The command has no arguments.

Options

Table 1: Command options
Option Description
--control_plane_ns

-c

 The project where the IBM Software Hub control plane is installed.
Status
Required.
Syntax
--control_plane_ns=<project-cpd-inst-operands>
Default value
No default.
Valid values
The project where the IBM Software Hub control plane is installed.
--image-prefix Specify the registry that the image should be pulled from.
Status
Required if your cluster pulls images from a private container registry.
Syntax
--image-prefix=<image-registry-prefix>
Default value
icr.io/cpopen/cpd

If you omit this option, the default value is used.

Valid values
IBM Entitled Registry
icr.io/cpopen/cpd
Private container registry
${PRIVATE_REGISTRY_LOCATION}
--image-tag Specify the tag that identifies the image in the repository.

The tag must exist on the ibm-service-functionality image in the repository that you specified for the --image-prefix option.

Status
Required if your cluster pulls images from a private container registry.
Syntax
--image-tag=<image-tag>
Default value
No default.
Valid values
The value depends on which image you want to pull.
Tip: If you mirrored the images to a private container registry using the --arch flag, use the single-arch image.
Multi-arch image
${VERSION}
Single-arch image
${VERSION}.IMAGE_ARCH
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--services Specify the service or services for which you want to remove the artifacts that were created by the service-functionality checks.
Status
Optional.
Syntax
--services=<comma-separated-list-of-service-keys>
Default value
No default.

If you omit this option, all of the artifacts associated with the service functionality checks are removed.

Valid values
You can specify individual values or a comma-separated list of values.
Service Value to specify
AI Factsheets wkc-fact-sheet
Common core services ccs
Data Product Hub dataproduct
Data Refinery

5.2.1 and later

 rshaper
DataStage datastage
Db2 db2oltp
Decision Optimization do
IBM Knowledge Catalog wkc
IBM Knowledge Catalog Premium ikc_premium
IBM Knowledge Catalog Standard ikc_standard
IBM Match 360 mdm
OpenPages openpages
Orchestration Pipelines ws-pipelines
Planning Analytics pa
Product Master productmaster
RStudio® Server Runtimes rstudio
SPSS Modeler spss-modeler
Synthetic Data Generator unreal-data
Watson Discovery discovery
Watson Machine Learning wml
Watson OpenScale aios
Watson Speech to Text speech-to-text
Watson Studio ws
Watson Text to Speech text-to-speech
watsonx.ai™ watsonx_ai
watsonx Assistant assistant
watsonx Code Assistant™ code-assistant
watsonx Code Assistant for Red Hat® Ansible® Lightspeed code-assistant-ansible
watsonx Code Assistant for Z Agentic

5.2.2 and later

 code-assistant-z-agents
watsonx.data™ watsonx-data
Table 2: Global options
Option Description

--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.
--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.

Standard run when only IBM Knowledge Catalog is installed
cpd-cli health service-functionality cleanup \
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS} \
--profile=${CPD_PROFILE_NAME}

Sample output:

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

                   SERVICE FUNCTIONALITY CHECK - CLEANUP

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

Common Core Services - cleanup in progress
IBM Knowledge Catalog - cleanup in progress



Common Core Services - Check Report

Clean Up
Clean up check artifacts
[SUCCESS...]

IBM Knowledge Catalog - Check Report

Cleanup
Clean up check artifacts
[SUCCESS...]