health service-functionality

Run scaled-down versions of end-user workflows to assess the operational capabilities of services. To list supported services, run the service-functionality list command.

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.

Attention:

If either of the following services are installed on the instance of IBM Software Hub where you plan to run the service-functionality command, you must ensure that you have an existing service instance before you run the service-functionality command:

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 \
--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 run service functionality checks.
Status
Optional.
Syntax
--services=<comma-separated-list-of-service-keys>
Default value
No default.

If you omit this option, the service functionality checks are run on all of the installed services that have service functionality checks.

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

* When you run the service-functionality command for services marked with an asterisk, the command automatically creates a service instance to run the functionality check. The service instance is automatically cleaned up after the functionality check is complete.

For Planning Analytics, the service instance is created and cleaned up only if there is no existing service instance. If a service instance already exists, the functionality check runs in the existing service instance.

Examples

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

Sample output:

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

                       SERVICE FUNCTIONALITY CHECKS

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

Each check may take many minutes to complete.

Starting parallel check(s) for: Common Core Services, IBM Knowledge Catalog


Common Core Services - Check Report

CCS Execution
Create a project, List all projects, Create DataAsset
[SUCCESS...]

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

IBM Knowledge Catalog - Check Report

Metadata enrichment
Load business terms and run metadata enrichment
[SUCCESS...]

Cleanup
Clean up check artifacts
[SUCCESS...]
Verbose run IBM Knowledge Catalog is installed
cpd-cli health service-functionality \
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS} \
--profile=${CPD_PROFILE_NAME} \
--verbose

Sample output:

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

                       SERVICE FUNCTIONALITY CHECKS

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

Each check may take many minutes to complete.

 == Starting parallel check(s) for: Common Core Services, IBM Knowledge Catalog

COMMON CORE SERVICES CCS EXECUTION:

DESCRIPTION                        	ACTION                                                                	RESPONSE      	MESSAGE
Success: Create Project            	POST /transactional/v2/projects                                       	201 Created   	Created project: sfc_ccs_test_project, id:
                                   	                                                                      	              	2ffdb708-d48f-4f11-983c-1c9a305afd40
Success: Get all projects          	GET /v2/projects                                                      	200 OK        	List of Projects: ["sfc_ccs_test_project"]
Success: Upload data-asset file    	PUT /v2/asset_files/data_asset/sfc-sample-data-asset.json             	201 Created   	Sample Data File "sfc-sample-data-asset.json" uploaded as a Data Asset
Success: Create data-asset         	POST /v2/data_assets                                                  	201 Created
Success: Get created data-asset    	GET /v2/data_assets/ddf88299-f734-487d-bfdb-eeb1b2ed9f03              	200 OK        	Name of the created asset: sfc-sample-data-asset.json


COMMON CORE SERVICES CLEAN UP:

DESCRIPTION                        	ACTION                                                                	RESPONSE      	MESSAGE
Success: Delete DataAsset          	DELETE /v2/asset_files/data_asset/sfc-sample-data-asset.json          	204 No Content	Deleted Data Asset: sfc-sample-data-asset.json
Success: Delete Project            	DELETE /transactional/v2/projects/2ffdb708-d48f-4f11-983c-1c9a305afd40	204 No Content	Deleted Project: sfc_ccs_test_project

IBM KNOWLEDGE CATALOG METADATA ENRICHMENT:

DESCRIPTION                               	ACTION                                                                   	RESPONSE      	MESSAGE
Success: Get current user account ID      	GET /usermgmt/v1/user/currentUserInfo                                    	200 OK
Success: Create Category                  	POST /v3/categories                                                      	201 Created   	Category: sfc_test_category, id: 665ea11e-32e6-491a-95bc-d9401a4095dd
Success: Import Business Terms            	POST /v3/governance_artifact_types/glossary_term/import                  	200 OK        	Terms added to category: sfc_test_category
Success: Get publish terms task           	GET /v3/workflow_user_tasks                                              	200 OK
Success: Publish Business terms           	POST /v3/workflow_user_tasks/4ec9caa1-b7f6-11ef-8c4d-0a580afe1129/actions	204 No Content
Success: Verify published terms           	POST /v3/search                                                          	200 OK        	4 terms published
Success: Create Project                   	POST /transactional/v2/projects                                          	201 Created   	Project: sfc_test_project, id: 2f88beec-95e2-45d1-8234-e663af754db8
Success: Create Catalog                   	POST /v2/catalogs                                                        	201 Created   	Catalog: sfc_test_catalog, id: 21b3888b-43c3-437a-9c99-2f420aa0c5f5
Success: Upload Metadata Import CSV       	PUT /v2/asset_files/data_asset/TEST_clients.csv                          	201 Created
Success: Create Metadata Import asset     	POST /v2/data_assets                                                     	201 Created
Success: Set Metadata Enrichment config   	PUT /v2/metadata_enrichment/metadata_enrichment_area/settings            	200 OK
Success: Run data enrichment              	POST /v2/metadata_enrichment/metadata_enrichment_area                    	201 Created   	Enrichment job id: 376a4446-9329-45f8-b74d-eb284050c7d8
Success: Confirm enrichment job completed 	GET /v2/jobs/376a4446-9329-45f8-b74d-eb284050c7d8/runs                   	200 OK
Success: Verfiy data enrichment           	GET /v2/data_assets/2b68b72b-cf4c-4e89-9519-0ee67f29b493                 	200 OK        	2 business terms enriched


IBM KNOWLEDGE CATALOG CLEANUP:

DESCRIPTION                               	ACTION                                                                   	RESPONSE      	MESSAGE
Success: Delete Business Terms            	POST /v3/governance_artifact_types/glossary_term/delete                  	204 No Content	4 terms deleted
Success: Delete Category                  	DELETE /v3/categories/665ea11e-32e6-491a-95bc-d9401a4095dd               	200 OK        	Deleted category: sfc_test_category
Success: Delete Catalog                   	DELETE /v2/catalogs/21b3888b-43c3-437a-9c99-2f420aa0c5f5                 	204 No Content	Deleted project: sfc_test_catalog
Success: Delete Project                   	DELETE /transactional/v2/projects/2f88beec-95e2-45d1-8234-e663af754db8   	204 No Content	Deleted project: sfc_test_project

***



Common Core Services - Check Report

CCS Execution
Create a project, List all projects, Create DataAsset
[SUCCESS...]

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

IBM Knowledge Catalog - Check Report

Metadata enrichment
Load business terms and run metadata enrichment
[SUCCESS...]

Cleanup
Clean up check artifacts
[SUCCESS...]