Registering an IBM Software Hub cluster with IBM Software Hub Control Center

After you install IBM Software Hub Control Center (Control Center), you must register the cluster where IBM Software Hub is installed so that Control Center can get cluster capacity information from the cluster.

Who needs to complete this task?

Cluster administrator A cluster administrator with sufficient privileges to get cluster capacity information must complete this task.

When do you need to complete this task?

One-time setup You must complete this task after you install Control Center.

Before you begin

Before you can register the IBM Software Hub cluster, you must create an OAuth client for Control Center. For more information, see Setting up an OAuth client for IBM Software Hub Control Center.

Ensure that you have the following information about the OAuth client:
  • The client ID
  • The client secret.
In addition, to complete this task, you must have the following information about the IBM Software Hub cluster:
  • The API address of the cluster

    You can obtain the cluster API address from the home page of the Red Hat® OpenShift® Container Platform web console.

  • The oauth-openshift route of the cluster
    You can obtain the route by running the following command on the cluster:
    oc get routes oauth-openshift -n openshift-authentication

Procedure

  1. Log in to IBM Software Hub Control Center.
  2. From the navigation, click Configurations and settings.
  3. Click Clusters. Then, click Register cluster.
  4. Click the edit icon (Edit icon.).
  5. Provide the following information:
    1. Provide a display name for the IBM Software Hub cluster.
      The display name is used to identify the cluster in the Control Center web client.
    2. Enter a description for the cluster.
    3. Enter the API address of the cluster.

      Ensure that you enter the address with the format: https://api.<domain-name>:<port-number>. The default port number is 6443.

    4. Enter the oauth-openshift route for the cluster.

      Ensure that you enter the address with the format: https://oauth-openshift.apps.<domain-name>.

    5. Enter the client ID of the OAuth client that you created for Control Center.
    6. Enter the secret from the OAuth client that you created for Control Center.
  6. Click Save.
  7. When prompted, enter your OpenShift username and password for the cluster where IBM Software Hub is installed.
  8. On the Authorize Access page, click Allow selected permissions to give Control Center the cluster-reader role.

What to do next

Best practice: If you want to enable Control Center to automatically get cluster capacity data, install the privileged monitoring service on the cluster where the IBM Software Hub instances that you want to manage are installed. For more information: Installing privileged monitors for an instance of IBM Software Hub.

If you do not install the privileged monitoring service, you must periodically re-authenticate Control Center.

In addition, you must re-authenticate Control Center when you add or remove nodes from the cluster.

Now that you've registered the cluster with Control Center, you can create accounts. For more information, see Creating accounts in IBM Software Hub Control Center.