manage setup-tethered-ns

Important: IBM Cloud Pak® for Data Version 4.6 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.6 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Tether a project (namespace) to the project where the IBM Cloud Pak for Data control plane is installed.

Extended description

A tethered project (namespace) is a project that is associated or linked with the project where the Cloud Pak for Data control plane is installed. You can deploy a service instance or workload to a tethered project.

Important: You must run the setup-tethered-ns command before you can create a service instance or deploy a workload in a tethered project.
When you tether a project to the ${PROJECT_CPD_INSTANCE} project, the cpd-cli manage setup-tethered-ns command:
  • Updates the appropriate instances of the IBM NamespaceScope Operator to enable the operators to watch the tethered project.
  • Updates the ZenService custom resource in the ${PROJECT_CPD_INSTANCE} project to add the ${PROJECT_TETHERED} project to the tetheredNamespaces entry.

    This enables the Cloud Pak for Data control plane to monitor and manage the workloads in the tethered project.

The software or workload in the tethered project is managed by Cloud Pak for Data control plane but is otherwise isolated from the control plane and the other services and workloads that are running in the main Cloud Pak for Data project. For more information, see Supported project (namespace) configurations.

Restriction: Not all services support running workloads or service instances in tethered projects. For details, see Multitenancy support.

Syntax

cpd-cli manage setup-tethered-ns \
--cpd_instance_ns=<project-name> \
--tethered_instance_ns=${PROJECT_CPD_INSTANCE} \
[--remove=true|false]
[--preview=true|false] \
[-v][-vv][-vvv]

Arguments

The setup-instance-ns command has no arguments.

Options

Option Description
--cpd_instance_ns The project (namespace) where IBM Cloud Pak for Data is installed.
Status
Required.
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.
--preview Preview the commands that run when you issue this CLI command.

The command issues a series of oc commands. You can optionally see the list of oc commands that are associated with the command.

The oc commands are saved to the preview.sh file in the cpd-cli-workspace/olm-utils-workspace/work directory.

Status
Optional.
Syntax
--preview=true|false
Default value
false

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

Valid values
false
Run the commands to apply the changes to your cluster.
true
Preview the commands without running them.

You can optionally copy the oc commands from the output and run them yourself. However, this method is not recommended. When you run the commands manually, you do not have access to the additional helper scripts that are included in the underlying Ansible® playbook.
--remove Specify whether to tether or untether the project from the project where the IBM Cloud Pak for Data control plane is installed.
Status
Optional.
Syntax
--remove=true|false
Default value
false

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

Valid values
false
Tether the project to the project where the Cloud Pak for Data control plane is installed.
true
Untether the project from the project where the Cloud Pak for Data control plane is installed.
Important: If you untether a project, the control plane cannot manage any services that are deployed in the project.
--tethered_instance_ns This option can be used to specify either:
  • A project (namespace) that is tethered to the project where IBM Cloud Pak for Data is installed.
  • A project (namespace) that you want to tether to the project where IBM Cloud Pak for Data is installed.
Status
Required.
Syntax
--tethered_instance_ns=${PROJECT_CPD_INSTANCE}
Default value
No default. User-defined.
Valid values
  • A project (namespace) that is tethered to the project where IBM Cloud Pak for Data is installed.
  • A project (namespace) that you want to tether to the project where IBM Cloud Pak for Data is installed.

    If you have the appropriate permissions to create projects on the cluster, the command will automatically create the project if it does not exist.

    If you don't have sufficient permissions to create projects, you must specify an existing project.
-v
-vv
-vvv
 Display verbose output.

Options are listed from least verbose to the most verbose.

Status
Optional.
Syntax
Verbose output
-v
Very verbose output
-vv
Most verbose output
-vvv
Default value
Not applicable.
Valid values
Not applicable.

Examples

Note: The following example uses the recommended installation environment variables.

Use a script to create environment variables with the correct values for your environment. For details, see Best practice: Setting up install variables.

Tether a project to the specified project
cpd-cli manage setup-tethered-ns \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--tethered_instance_ns=${PROJECT_TETHERED}
Preview the oc commands to tether a project to the specified project
cpd-cli manage setup-tethered-ns \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--tethered_instance_ns=${PROJECT_TETHERED} \
--preview=true
Untether a project from the specified project
cpd-cli manage setup-tethered-ns \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--tethered_instance_ns=${PROJECT_TETHERED} \
--remove=true