Shutting down services

Run the following command to shut down the AI Factsheets service:

cpd-cli manage shutdown \
--components=factsheet \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=true

Run the following command to shut down the Analytics Engine powered by Apache Spark service:

cpd-cli manage shutdown \
--components=analyticsengine \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Shut down any Cognos Analytics service instances before you shut down the service.

You can also use the web client to shut down Cognos Analytics as long as there are no service instances currently running.

1. Run the following command to list all of the Cognos Analytics service instances on the cluster:

   oc get caserviceinstance --all-namespaces

   Identify the service instances that are associated with the instance of Cognos Analytics that you want to shut down.

2. For each service instance that is associated with the instance of Cognos Analytics that you want to shut down, run the following command to shut down the service instance.
   Each time that you run the command, replace the following values:

   • Replace <instance-id> with the appropriate ID from the list of service instances.
   • Replace <instance-namespace> with the namespace where the service instance is deployed.

   oc patch caserviceinstance <instance-id> \
   --namespace <instance-namespace> \
   --patch '{"spec":{"shutdown":"true"}}' \
   --type=merge

3. Run the following command to shut down the Cognos Analytics service:

   cpd-cli manage shutdown \
   --components=cognos_analytics \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

   Note: You can also run the cpd-cli manage shutdown command with the --force option set to true to shut down all instances and the service.

Run the following command to shut down the Cognos Dashboards service:

cpd-cli manage shutdown \
--components=dashboard \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=true

Shut down the Data Gate service instances before you shut down the service.

1. Run the following command to list all of the service instances in the project where Data Gate is installed:

   oc get datagateinstanceservices --namespace ${PROJECT_CPD_INST_OPERANDS}

2. For each service instance, run the following command to shut down the Data Gate service instance.

   Each time that you run the command, replace <instance-id> with the appropriate ID from the list of service instances.

   export DATAGATE_INSTANCE_ID=<instance-id>
   
   cpd-cli manage shutdown --components=datagate_instance --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} --extra-vars=cr_name=${DATAGATE_INSTANCE_ID} --extra-vars='{"override_components_meta":{"datagate_instance":{"cr_apply_support":"true"}}}'

3. Run the following command to shut down the Data Gate service:

   cpd-cli manage shutdown \
   --components=datagate \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the Data Product Hub service:

cpd-cli manage shutdown \
--components=dataproduct \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the cpd-cli manage list-dependents command to determine which components have a dependency on Data Refinery. When you shut down those components, use the --include_dependency option to also shut down Data Refinery and any other dependencies.

1. If your deployment has instances of DataStage running on remote physical locations, you must shut them down manually.
   1. Log in to Red Hat OpenShift Container Platform as a user with sufficient permissions to complete the task.

      ${REMOTE_OC_LOGIN}

      Remember: REMOTE_OC_LOGIN is an alias for the oc login command when you are connecting to a remote cluster.
   2. Run the following command to shut down the instances of DataStage:

      oc -n ${REMOTE_PROJECT_MANAGEMENT} \
      get pxruntime | awk 'NR>1 { print $1 }' | xargs -I % \
      oc -n ${REMOTE_PROJECT_MANAGEMENT} \
      patch pxruntime % \
      --type=merge -p '{"spec":{"shutdown": true}}'
      

   3. After you shut down the DataStage instances on the remote cluster, log the cpd-cli in to the cluster where the primary instance of IBM Software Hub is installed.

      ${CPDM_OC_LOGIN}

      Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
   4. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster:
2. Run the following command to shut down the DataStage service on the primary cluster:

   cpd-cli manage shutdown \
   --components=datastage_ent \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --include_dependency=true

   To shut down DataStage Enterprise Plus, set the --components option to datastage_ent_plus.

Shut down the Data Virtualization service instance before you shut down the service.

1. Shut down the Data Virtualization service instance:
   1. Set the INSTANCE_PROJECT to the project where the service instance exists:
      • If the service instance is in the operands project, run:

        export INSTANCE_PROJECT=${PROJECT_CPD_INST_OPERANDS}

      • If the service instance is in a tethered project, run:

        export INSTANCE_PROJECT=${PROJECT_CPD_INSTANCE_TETHERED}

        Important: If multiple tethered projects are associated with this instance of IBM Software Hub, make sure that the ${PROJECT_CPD_INSTANCE_TETHERED} environment variable is set to the correct project name before you run the export command:

        echo $PROJECT_CPD_INSTANCE_TETHERED

   2. Run the following command to shut down the Data Virtualization service instance:

      oc patch bigsql db2u-dv \
      --namespace ${INSTANCE_PROJECT} \
      --patch '{"spec": {"shutdown": "true"}}' \
      --type=merge

      Note: If you run this command with the true option, you might still interrupt workloads. Running queries might fail before the graceful shutdown deadline. Ensure that workloads are complete before you shut down the service instance.
2. Run the following command to shut down the Data Virtualization service:

   cpd-cli manage shutdown \
   --components=dv \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --include_dependency=true

   When you set the --include_dependency option to true, the following dependent components also are shut down:
   • Cloud Native PostgreSQL (postgresql)
   • Common core services (ccs)
   • Db2U (db2u)
   • OpenSearch (opencontent_opensearch)
   • Redis (ibm_redis_cp)

   You can include the --tethered_instance_ns=<project-name> argument to shut down an instance in a tethered project.

Before you can shut down the Db2 service, you must shut down all instances..

1. Run the following command to retrieve a list of your instances:

   oc get db2ucluster,db2uinstance

   The command finds instances that are Db2uInstance or Db2uCluster custom resources and returns the full object name, for example, db2uinstance.db2u.databases.ibm.com/db2uinstance-sample. Find the instances that you want to shut down.

2. Shut down each instance by using the following commands.
   1. Export the full object name of your instance as an environment variable:

      export INSTANCE=<instance_id>

      For example, export INSTANCE=db2uinstance.db2u.databases.ibm.com/db2uinstance-sample

   2. Shut down the instance:

      oc patch ${INSTANCE} \
      --namespace ${PROJECT_CPD_INST_OPERANDS} \
      --type=merge \
      --patch '{"metadata":  {"annotations": {"db2u.databases.ibm.com/maintenance-shutdown":  "true"}}}'

   3. Run the following command to check your instances shut down:

      oc get db2ucluster,db2uinstance

      The instances show Ready status under STATE and Shutdown status under MAINTENANCESTATE when they shut down, for example:

      NAME                                                      STATE   MAINTENANCESTATE   AGE
      db2uinstance.db2u.databases.ibm.com/db2uinstance-sample          Ready   Shutdown           23d

   4. Check that the engine pod and the etcd pod have been terminated.
3. When all instances are shut down, run the following command to shut down the Db2 service:

   cpd-cli manage shutdown \
   --components=db2oltp \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --include_dependency=true

   When you set the --include_dependency option to true, the following dependent component also is shut down:
   • Db2U

   You can also forcibly shut down the service and all running instances by including --force=true when you run the cpd-cli manage shutdown command.

   Note: Shutting down the service might take some time. The amount of time can depend on many factors, such as the number Db2U deployments. You can use the oc get db2ucluster,db2uinstance command to check the state for the instances.

Shut down the Db2 Big SQL service instances before you shut down the service.

1. Run the following command to get the list of Db2 Big SQL service instance IDs:

   oc get cm \
   --namespace ${PROJECT_CPD_INST_OPERANDS} \
   -l component=db2bigsql \
   -o custom-columns="Instance Id:{.data.instance_id}, \
   InstanceName:{.data.instance_name}, \
   Created:{.metadata.creationTimestamp}"

2. For each service instance, run the following command to shut down the Db2 Big SQL service instance.

   Each time that you run the command, replace <instance-id> with the appropriate ID from the list of service instances.

   oc patch bigsql bigsql-<instance-id> \
   --namespace ${PROJECT_CPD_INST_OPERANDS} \
   --patch '{"spec":{"shutdown":"true"}}' \
   --type=merge

   Note: If you run this command with the true option, you might still interrupt workloads. Running queries might fail before the graceful shutdown deadline. Ensure that workloads are complete before you shut down the service instance.
3. Run the following command to shut down the Db2 Big SQL service:

   cpd-cli manage shutdown \
   --components=bigsql \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --include_dependency=true

   When you set the --include_dependency option to true, the following dependent component also is shut down:
   • Db2U

Before you can shut down the Db2 Warehouse service, you must shut down all instances.

1. Run the following command to retrieve a list of your instances:

   oc get db2ucluster,db2uinstance

   The command finds instances that are Db2uInstance or Db2uCluster custom resources and returns the full object name, for example, db2uinstance.db2u.databases.ibm.com/db2uinstance-sample. Find the instances that you want to shut down.

2. Shut down each instance by using the following commands.
   1. Export the full object name of your instance as an environment variable:

      export INSTANCE=<instance_id>

      For example, export INSTANCE=db2uinstance.db2u.databases.ibm.com/db2uinstance-sample

   2. Shut down the instance:

      oc patch ${INSTANCE} \
      -n ${PROJECT_CPD_INST_OPERANDS} \
      --type=merge \
      --patch '{"metadata":  {"annotations": {"db2u.databases.ibm.com/maintenance-shutdown":  "true"}}}'

   3. Run the following command to check your instances shut down:

      oc get db2ucluster,db2uinstance

      The instances show Ready status under STATE and Shutdown status under MAINTENANCESTATE when they shut down, for example:

      NAME                                                      STATE   MAINTENANCESTATE   AGE
      db2uinstance.db2u.databases.ibm.com/db2uinstance-sample          Ready   Shutdown           23d

   4. Check that the engine pod and the etcd pod have been terminated.
3. When all instances are shut down, run the following command to shut down the Db2 Warehouse service:

   cpd-cli manage shutdown \
   --components=db2wh \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --include_dependency=true

   When you set the --include_dependency option to true, the following dependent component also is shut down:
   • Db2U

   You can also forcibly shut down the service and all running instances by including --force=true when you run the cpd-cli manage shutdown command.

   Note: Shutting down the service might take some time. The amount of time can depend on many factors, such as the number Db2U deployments. You can use the oc get db2ucluster,db2uinstance command to check the state for the instances.

Run the following command to shut down the Decision Optimization service:

cpd-cli manage shutdown \
--components=dods \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the Execution Engine for Apache Hadoop service:

cpd-cli manage shutdown \
--components=hee \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the Unstructured Data Integration service:

cpd-cli manage shutdown \
--components=udp \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the IBM Knowledge Catalog service:

cpd-cli manage shutdown \
--components=wkc \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the IBM Knowledge Catalog Standard service:

cpd-cli manage shutdown \
--components=ikc_standard \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the IBM Knowledge Catalog Premium service:

cpd-cli manage shutdown \
--components=ikc_premium \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the IBM Manta Data Lineage service:

cpd-cli manage shutdown \
--components=datalineage \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the IBM Master Data Management service:

cpd-cli manage shutdown \
--components=match360 \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the IBM StreamSets service:

cpd-cli manage shutdown \
--components=streamsets \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the Informix service:

cpd-cli manage shutdown \
--components=informix_cp4d \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=true

You can shut down either a specific OpenPages instance, or the OpenPages service and all OpenPages instances.

• If you want to shut down a specific OpenPages instance, run the following command:
  Note: Use --extra-vars=cr_name=${OPENPAGES_INSTANCE_NAME} in the command only when you need to specify the instance name because the service instances does not use the default name.

  cpd-cli manage shutdown \
  --components=openpages_instance \
  --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
  --extra-vars='{"override_components_meta":{"openpages_instance":{"skip_shutdown_check":false}}}' \
  --extra-vars=cr_name=${OPENPAGES_INSTANCE_NAME}

• If you want to shut down both the OpenPages service and all OpenPages instances, run the following command:

  cpd-cli manage shutdown \
  --components=openpages \
  --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
  --force=true \
  --extra-vars=cr_name=${OPENPAGES_SERVICE_CR_NAME}

Run the following command to shut down the Orchestration Pipelines service:

cpd-cli manage shutdown \
--components=ws_pipelines \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=true

Shut down any Planning Analytics service instances before you shut down the service.

1. Run the following command to list all of the Planning Analytics service instances on the cluster:

   oc get paserviceinstance --all-namespaces

   Identify the service instances that are associated with the instance of Planning Analytics that you want to shut down.

2. For each service instance that is associated with the instance of Planning Analytics that you want to shut down, run the following command to shut down the service instance.
   Each time that you run the command, replace the following values:

   • Replace <instance-id> with the appropriate ID from the list of service instances.
   • Replace <instance-namespace> with the namespace where the service instance is deployed.

   oc patch paserviceinstance <instance-id> \
   --namespace <instance-namespace> \
   --type=merge \
   --patch '{"spec":{"shutdown":"true"}}'

3. Run the following command to shut down the Planning Analytics service:

   cpd-cli manage shutdown \
   --components=planning_analytics \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

   Note: You can also run the cpd-cli manage shutdown command with the --force option set to true to shut down all instances and the service.

Run the following command to shut down the Product Master service:

cpd-cli manage shutdown \
--components=productmaster_instance \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the RStudio® Server Runtimes service:

cpd-cli manage shutdown \
--components=rstudio \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the Synthetic Data Generator service:

cpd-cli manage shutdown \
--components=syntheticdata \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=true

Run the following command to shut down the Watson Machine Learning service:

cpd-cli manage shutdown \
--components=wml \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=true

Run the following command to shut down the Watson OpenScale service.

cpd-cli manage shutdown \
--components=openscale \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the Watson Speech services:

cpd-cli manage shutdown \
--components=watson_speech \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

The following dependent components are also shut down when you shut down Watson Speech services:

• Cloud Native PostgreSQL (postgresql)
• Watson Gateway (watson_gateway)

Watson Studio is a dependent component of Watson Studio Runtimes.

Run the following command to shut them down together:

cpd-cli manage shutdown \
--components=ws,ws_runtimes \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the watsonx.ai™ service:

cpd-cli manage shutdown \
--components=watsonx_ai \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=false \
--force=true

If Watson Studio Runtimes fails to shutdown, it might be caused by the graceful shutdown that Watson Studio Runtimes uses. You can use --force=true to force Watson Studio Runtimes to shut down.

Run the following command to shut down the watsonx Assistant service:

cpd-cli manage shutdown \
--components=watson_assistant \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the watsonx Code Assistant™ service:

cpd-cli manage shutdown \
--components=wca \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=true

Run the following command to shut down the watsonx Code Assistant for Red Hat Ansible® Lightspeed service:

cpd-cli manage shutdown \
--components=wca_ansible \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=false

Run the following command to shut down the watsonx Code Assistant for Z Understand service:

cpd-cli manage shutdown \
--components=wca_z_cg \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

To shut down the watsonx.data™ service, you must shut down wxdAddon, which provides the watsonx.data service.

When the watsonx.data service is shutdown, the PostgreSQL server process stops. However, the PostgreSQL pods that are associated with the watsonx.data instance remain in Running state.

1. Run the following command to shut down the service (the wxdAddon component):

   cpd-cli manage shutdown \
   --components=watsonx_data \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the watsonx.data intelligence service:

cpd-cli manage shutdown \
--components=watsonx_dataintelligence \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--include_dependency=false

Run the following command to shut down the watsonx.data Premium service:

cpd-cli manage shutdown \
--components=watsonx_data_premium \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the watsonx.governance™ service:

cpd-cli manage shutdown \
--components=watsonx_governance \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the watsonx Orchestrate service.

cpd-cli manage shutdown \
--components=watsonx_orchestrate \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

Run the following command to shut down the control plane:

cpd-cli manage shutdown \
--components=cpd_platform \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}

If you installed the Scheduling service, you must shut it down after you shut down all other services and the control plane, and you must restart it before you restart the control plane and any other services.

1. Run the following command to shut down the scheduling service:

   oc patch Scheduling ibm-cpd-scheduler \
   --namespace ${PROJECT_SCHEDULING_SERVICE} \
   --type=merge \
   --patch '{"spec": {"shutdown": "true"}}'

2. After you shut down the scheduling service, delete any pending pods that are waiting to be scheduled by the scheduling service. When the pods restart, they are scheduled by the default OpenShift scheduler.
   1. Run the following command to see which projects have pods that are under the control of the scheduling service:

      oc get po -A --no-headers | while read namespace name ready status misc; do
        schedulerName=`oc get po -n$namespace $name -o=jsonpath="{.spec.schedulerName}"`
        if [ "$schedulerName" == "ibm-cpd-scheduler" -a "$status" == "Pending" ]; then
          echo "$namespace"
        fi
      done | sort -u

      The command returns a list of projects.

   2. For each project returned by the preceding command, complete the following steps:
      1. Change to the project:

         oc project project-name

      2. Run the command to list the pending pods in the project that are still under the control of the scheduling service:

         oc get po --no-headers | while read name ready status misc; do
          schedulerName=`oc get po $name -o=jsonpath='{.spec.schedulerName}'`
          if [ "$schedulerName" == "ibm-cpd-scheduler" -a $status == "Pending" ]; then
           echo "Pod $name is pending, and schedulerName is set to ibm-cpd-scheduler"
          fi
         done

         The command returns a list of pods. If the command does not return any pods, there are no pending pods that need to be restarted in this project.

      3. Run the following command to delete the pods:

         oc get po --no-headers | while read name ready status misc; do
          schedulerName=`oc get po $name -o=jsonpath='{.spec.schedulerName}'`
          if [ "$schedulerName" == "ibm-cpd-scheduler" -a $status == "Pending" ]; then
           oc delete po $name
          fi
         done

      4. Repeat the preceding steps for each project that was returned in the output for step 1.