Preparing to install an instance of IBM Software Hub

Before you can install IBM Software Hub, you must create and configure the projects for an instance of IBM Software Hub.

Who needs to complete this task?
Cluster administrator A cluster administrator must complete the appropriate tasks to prepare to install an instance of IBM Software Hub on the cluster.
When do you need to complete this task?
Repeat as needed The tasks in this section must be completed at least one time. However, you can repeat them to install multiple instances of IBM Software Hub.

About this task

At a minimum, an instance of IBM Software Hub has two projects (namespaces) where the IBM Software Hub software is installed: the operators project and the operands project.

You can optionally tether one or more projects to the operands project.

Operators project
The project where the operators are installed.

In installation and administration commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

What are operators?

  • An operator is a custom Kubernetes controller. A controller implements a control loop that continually watches the state of specific objects on your cluster and makes adjustments as needed to ensure that the objects are running as expected.

  • Each component of IBM Software Hub includes an operator that is responsible for managing that component. For example, the control plane has a dedicated operator, and each service has a dedicated operator.

  • Each instance of IBM Software Hub has its own set of operators. All the operators in this project must be installed at the same release. For example, all the operators must be installed at Version 5.2.2.

Install the operators for the services that you plan to install in the operands project. Each operator monitors the appropriate operands in the operands project.

Operands project
The project where the IBM Software Hubcontrol plane and services are installed.

In installation and administration commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

The operators monitor the operands to ensure that they are running as expected.

Each instance of IBM Software Hub has its own set of operands. The operands in this project must be installed at the same release as the operators in the operators project.

Tethered projects
A project where you can deploy workload or service instances. Tethered projects are optional.
Tethered projects are identified by the following environment variables:
  • In installation and administration commands, the ${PROJECT_CPD_INSTANCE_TETHERED} environment variable refers to a single tethered project that is associated with an instance of IBM Software Hub.
  • In installation and administration commands, the ${PROJECT_CPD_INSTANCE_TETHERED_LIST} environment variable refers to a list of tethered projects that are associated with an instance of IBM Software Hub.

The IBM Software Hubcontrol plane manages the software in the tethered project. However, the software is otherwise isolated from the control plane and the other services and workloads that are running in the operands project.

Before you install an instance of IBM Software Hub, you must ensure that the projects exist and have the necessary roles and role bindings.

Procedure

Complete the appropriate tasks for your environment.