Tethering projects to the IBM Software Hub control plane

You can use tethered projects to isolate service instances or workloads from the rest of your IBM Software Hub deployment. After you install IBM Software Hub, you can tether projects to the IBM Software Hub 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 in a restricted network
  • You are not here. Preparing to run installs from a private container registry
  • You are not here. Preparing the cluster for IBM Software Hub
  • You are not here. Preparing to install an instance of IBM Software Hub
  • You are here icon. Installing an instance of IBM Software Hub
  • You are not here. Setting up the control plane
  • You are not here. Installing solutions and services
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 IBM Software Hub.
    • Tether additional projects to an instance of IBM Software Hub

Before you begin

Complete the following tasks for the projects that you plan to tether to the IBM Software Hub control plane:

  1. Apply the required permissions to the projects (namespaces for an instance of IBM Software Hub.
    • If you run the authorize-instance-topology command, specify the project that you want to tether in the --additional_ns option.
    • If you run the show-minimum-rbac command, apply the role and role binding to the project that you want to tether.

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

  2. Creating image pull secrets for an instance of IBM Software Hub.

    Ensure that you create the pull secret in the project that you want to tether. This task ensures that any software that is deployed in the project can pull the required images.

  3. Installing the required components for an instance of IBM Software Hub.

    When you run the install-components command, specify the project that you want to tether in the --tethered_instance_ns option.

    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 IBM Software Hub control plane but is otherwise isolated from the control plane and the other services and workloads that are running in the main IBM Software Hub project. For more information, see Supported project (namespace) configurations.

Procedure

  1. Log the cpd-cli in to the Red Hat® OpenShift® Container Platform cluster: 
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  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.