Tethering projects to the IBM Cloud Pak for Data control plane

You can use tethered projects to isolate service instances or workloads from the rest of your IBM Cloud Pak for Data deployment. After you install Cloud Pak for Data, you can tether projects to the Cloud Pak for Data control plane.

Installation phase
You are not here. Setting up a client workstation
You are not here. Setting up a cluster
You are not here. Collecting required information
You are not here. Preparing to run installs from a private container registry
You are not here. Preparing the cluster for Cloud Pak for Data
You are not here. Preparing to install an instance of Cloud Pak for Data
You are here icon. Installing an instance of Cloud Pak for Data
Who needs to complete this task?

Instance administrator An instance administrator can complete this task.

When do you need to complete this task?

This task is optional.

  • Skip this task if you don't plan to deploy any service instances or workloads in tethered projects.
  • Complete this task only if you want to deploy service instances or workloads in tethered projects.
    Repeat as needed Repeat this task if you need to:
    • Tether projects to a new instance of Cloud Pak for Data.
    • Tether additional projects to an instance of Cloud Pak for Data

Before you begin

The projects that you plan to tether to the Cloud Pak for Data control plane, must be included as additional projects option (--additional_ns) when you complete the following tasks:

  1. Applying the required permissions to the projects (namespaces) for an instance of IBM Cloud Pak for Data.

    You must specify this project when you run the authorize-instance-topology command.

    This task ensures that the project where the operators are installed can watch the tethered projects.

  2. Installing the IBM Cloud Pak foundational services for Cloud Pak for Data

    You must specify this project when you run the setup-instance-topology command.

    This task ensures that the tethered projects are added to the NamespaceScope operator ConfigMap, which tells the operators to manage the operands in the tethered projects.

Best practice: You can run the commands in this task exactly as written if you set up environment variables. For instructions, see Setting up installation environment variables.

Ensure that you source the environment variables before you run the commands in this task.

About this task

The software or workload in the tethered project is managed by the 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.

Procedure

  1. Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example: 
    cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
    Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.
  2. Tether a project to the control plane.
    Tip: Before you run this command against your cluster, you can preview the oc commands that this command will issue on your behalf by running the command with the --preview=true option.

    The oc commands are saved to the preview.sh file in the work directory.

    cpd-cli manage setup-tethered-ns \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}

    Repeat this step for each project that you want to tether to the control plane.

What to do next

Ensure that you complete the Post-installation setup (Day 1 operations).

If you did not install any services when you installed the control plane, ensure that you install the services that you want to use. See the instructions for installing each service individually in Services.