manage detach-cpd-instance

Detach the Cloud Pak for Data instance from the shared operators so that you can migrate the instance to a private topology.

Required role
Cluster administrator To run this command, you must be a cluster administrator.

Extended description

You must run this command before you upgrade to IBM Cloud Pak® for Data Version 4.7. This command applies to the following scenarios:
  • Upgrade from Version 4.5 to Version 4.8
  • Upgrade from Version 4.6 to Version 4.8

You can also run this command if you want to install IBM Cloud Pak for Data Version 4.7 alongside an existing instance of IBM Cloud Pak for Data Version 4.5 or 4.6.

Restriction: To run this command, IBM Cloud Pak foundational services must at Version 3.20.0 or later. Version 3.20.0 was included in Cloud Pak for Data Version 4.5.2.
To check the version of IBM Cloud Pak foundational services that is installed on your cluster, run:
oc get csv -A | grep ibm-common-services-operator

If the command returns ibm-common-service-operator.v3.19.0, you must run the upgrade-cpfs command before you run the detach-cpd-instance command.

This command detaches the Cloud Pak for Data instance from the shared operators so that you can migrate the instance to a private topology. When you detach the instance from the shared operators, the operators stop watching the custom resources in:

  • The project where the control plane is installed.
  • The projects that are tethered to the project where the control plane is installed.
The first time that you run the command, the command moves the following IBM Cloud Pak foundational services components to a separate control namespace on the cluster:
  • Certificate manager
  • License Service

If you run the command multiple times on the same cluster, this step is skipped.

Syntax

cpd-cli manage detach-cpd-instance \
--cpfs_operator_ns=<project-name> \
--control_ns=<project-name> \
[--cpd_instance_ns=<project-name>] \
[--additional_ns=<comma-separated-list-of-project-names>] \
[--specialized_operator_ns=<project-name>]

Arguments

The detach-cpd-instance command has no arguments.

Options

Option Description
--additional_ns A list of projects that are tethered to the Cloud Pak for Data control plane.

You must detach an instance of Cloud Pak for Data from the shared operators before you upgrade to Cloud Pak for Data Version 4.7. The instance includes any projects that are tethered to the Cloud Pak for Data control plane.

It is recommended that you detach one instance at a time and upgrade each instance separately.

Specify the projects that are tethered to the Cloud Pak for Data control plane. The shared operators will stop watching these projects.

Status
Optional.
You can omit this option if:
  • There are no projects tethered to the Cloud Pak for Data control plane.
  • You want to move the Certificate manager and the License Service to the control namespace without detaching any instances from the shared operators. For example, you might want to install new instances of Cloud Pak for Data Version 4.7 and leave existing instances at an earlier release.
Syntax
--additional_ns=<comma-separated-list-of-project-names>
Default value
No default. User defined.
Valid values
A list of projects that are tethered to the Cloud Pak for Data control plane.

Specify only the projects that are tethered to the project that you specify for the --cpd_instance_ns option.
--control_ns The project where you want to move the IBM Cloud Pak foundational services Cert Manager and License Service.

This project is called the control namespace.

Status
Required.
Syntax
--control_ns=<project-name>
Default value
No default. User defined.
Valid values
The project where you want to move the IBM Cloud Pak foundational services Cert Manager and License Service.
--cpd_instance_ns The project (namespace) where IBM Cloud Pak for Data is installed.

You must detach an instance of Cloud Pak for Data from the shared operators before you upgrade to Cloud Pak for Data Version 4.7.

It is recommended that you detach one instance at a time and upgrade each instance separately.

Specify the project where the control plane is installed. The shared operators will stop watching this project.

Status
Optional.

You can omit this option if you want to move the Certificate manager and the License Service to the control namespace without detaching any instances from the shared operators. For example, you might want to install new instances of Cloud Pak for Data Version 4.7 and leave existing instances at an earlier release.

Syntax
--cpd_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
The project (namespace) where IBM Cloud Pak for Data is installed.
--cpfs_operator_ns The project where the shared IBM Cloud Pak foundational services operators are installed.
Status
Required.
Syntax
--cpfs_operator_ns=<project-name>
Default value
No default.
Valid values
The project where the shared IBM Cloud Pak foundational services operators are installed.
--specialized_operator_ns Specialized installations only. The project where the shared Cloud Pak for Data operators are installed.
Status
Required if the shared Cloud Pak for Data operators are installed in a different project than the shared IBM Cloud Pak foundational services operators.
Syntax
--specialized_operator_ns=<project-name>
Default value
No default.
Valid values
The name of the project where the shared Cloud Pak for Data operators are installed.

Table 1: Command options

Examples

Note: The following example uses 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 details, see Best practice: Setting up installation environment variables.

Detach an instance of Cloud Pak for Data from the shared operators
For an express installation, where all operators are installed in the same project:
cpd-cli manage detach-cpd-instance \
--cpfs_operator_ns=${PROJECT_CPFS_OPS} \
--control_ns=${PROJECT_CS_CONTROL} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE}
For a specialized installation, where the IBM Cloud Pak for Data operators are installed in a different project than the IBM Cloud Pak foundational services operators:
cpd-cli manage detach-cpd-instance \
--cpfs_operator_ns=${PROJECT_CPFS_OPS} \
--control_ns=${PROJECT_CS_CONTROL} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE}
--specialized_operator_ns=${PROJECT_CPD_OPS}
Detach an instance of Cloud Pak for Data with tethered projects from the shared operators
For an express installation, where all operators are installed in the same project:
cpd-cli manage detach-cpd-instance \
--cpfs_operator_ns=${PROJECT_CPFS_OPS} \
--control_ns=${PROJECT_CS_CONTROL} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--additional_ns=${PROJECT_CPD_INSTANCE_TETHERED_LIST}
For a specialized installation, where the IBM Cloud Pak for Data operators are installed in a different project than the IBM Cloud Pak foundational services operators:
cpd-cli manage detach-cpd-instance \
--cpfs_operator_ns=${PROJECT_CPFS_OPS} \
--control_ns=${PROJECT_CS_CONTROL} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--additional_ns=${PROJECT_CPD_INSTANCE_TETHERED_LIST}
--specialized_operator_ns=${PROJECT_CPD_OPS}
Move the Certificate manager and License Service to the control namespace without detaching any instances of Cloud Pak for Data from the shared operators
cpd-cli manage detach-cpd-instance \
--cpfs_operator_ns=${PROJECT_CPFS_OPS} \
--control_ns=${PROJECT_CS_CONTROL} \