Installing shared cluster components for IBM Software Hub

Before you install IBM Software Hub, you must install the IBM Cloud Pak foundational services License Service and the IBM Software Hub scheduling service.

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 here icon. Preparing the cluster for IBM Software Hub
  • You are not here. Preparing to install an instance of IBM Software Hub
  • You are not here. 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?

Cluster administrator A cluster administrator must complete this task.

You can optionally give another user the minimum role-based access control to install the scheduling service. However, this method requires additional planning and maintenance and is not recommended for typical installations. For more information, see Giving a user the minimum RBAC to install the scheduling service.

When do you need to complete this task?

One-time setup You must complete this task before you install IBM Software Hub for the first time.

Before you begin

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 following components are cluster-wide components, which means that they are installed once and shared by all instances of IBM Software Hub on the cluster.
Cluster-wide component Notes
IBM Certificate manager Deprecated The IBM Cloud Pak foundational services Certificate manager is deprecated.

Install the Red Hat® OpenShift® Container Platform cert-manager Operator instead.

Important: If the Red Hat OpenShift Container Platform cert-manager Operator (or another certificate manager) is not installed, the IBM Certificate manager is automatically installed or upgraded when you run the apply-cluster-components command.
License Service The IBM Cloud Pak foundational services License Service is required.

You are required to keep a record of the size of your deployments to report to IBM as requested. If you are using Container Licensing, you can use the License Service to measure your usage.
Scheduling service The scheduling service is required if you plan to use:
  • The quota enforcement feature in IBM Software Hub
  • The node scoring feature for pod placement
  • Deep learning experiment builder in the Watson Machine Learning service
  • Priority scheduling and co-scheduling in the Analytics Engine powered by Apache Spark service
  • Remote physical locations

    If you plan to use remote physical locations, you must install the scheduling service on the primary cluster and on the remote cluster where you plan to create the remote physical location.

If none of these scenarios applies to you, the scheduling service is optional but strongly recommended.

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. Install the License Service:
    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 apply-cluster-components \
--release=${VERSION} \
--license_acceptance=true \
--licensing_ns=${PROJECT_LICENSE_SERVICE}
    Wait for the cpd-cli to return the following message before proceeding to the next step:
    [SUCCESS]... The apply-cluster-components command ran successfully.
  3. 5.2.0 This step applies only to IBM Software Hub Version 5.2.0. If you are installing a later 5.2 refresh, skip this step. If you plan to install the scheduling service and your cluster is running Red Hat OpenShift Container Platform Version 4.18.14 or later, run the following commands to create the required cluster role bindings for the scheduling service:
    1. Create the ibm-cpd-scheduling-system-kube-scheduler cluster role binding: 
      oc create clusterrolebinding ibm-cpd-scheduling-system-kube-scheduler \
--clusterrole=system:kube-scheduler \
--serviceaccount=${PROJECT_SCHEDULING_SERVICE}:ibm-cpd-scheduling-operator
    2. Create the ibm-cpd-scheduling-system-volume-scheduler cluster role binding: 
      oc create clusterrolebinding ibm-cpd-scheduling-system-volume-scheduler \
--clusterrole=system:volume-scheduler \
--serviceaccount=${PROJECT_SCHEDULING_SERVICE}:ibm-cpd-scheduling-operator
  4. Install the scheduling service:
    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 apply-scheduler \
--release=${VERSION} \
--license_acceptance=true \
--scheduler_ns=${PROJECT_SCHEDULING_SERVICE}
    Wait for the cpd-cli to return the following message before proceeding to the next step:
    [SUCCESS]... The apply-scheduler command ran successfully.

What to do next

Now that you've installed the shared cluster components, you're ready to complete Configuring persistent storage for IBM Software Hub.