IBM Cloud Docs
Registering clusters with Satellite Config

Registering clusters with Satellite Config

Clusters that you create in your Satellite Location are automatically registered with Satellite Config. You can also manually register other clusters in the public cloud or your existing Red Hat OpenShift on IBM Cloud clusters with Satellite Config. Follow the steps to run the registration script in your cluster to set up the Satellite Config components and make the cluster visible in Satellite.

After you complete these steps, the cluster can be added to a cluster group in your location and subscribed to Satellite configurations. However, you must still use Red Hat OpenShift on IBM Cloud to manage the worker nodes for these clusters.

  1. Find the cluster in the public cloud that you want to attach to Satellite Config. To list available clusters, run the ibmcloud oc cluster ls command or go to the Red Hat OpenShift cluster dashboard.

    Do not manually register clusters that you created in a Satellite Location. These clusters are automatically registered with Satellite Config. Registering them again manually might cause issues in your Location or cluster.

  2. From the Satellite Clusters dashboard, click Register cluster.

  3. Enter the name of your cluster and click Register cluster. Registering a cluster creates an entry in the Satellite Config ConfigMap. However, your cluster cannot be subscribed to a Satellite configuration until you install the Satellite Config agent in your cluster.

  4. Copy the command that is displayed to you.

  5. Log in to your Red Hat OpenShift cluster and run the command in your cluster. The command creates the razeedeploy project, custom resource definitions, and RBAC policies on your cluster that are required to make your cluster visible to Satellite Config.

    Example output

    namespace/razeedeploy created
    serviceaccount/razeedeploy-sa created
    clusterrole.rbac.authorization.k8s.io/razeedeploy-admin-cr created
    clusterrolebinding.rbac.authorization.k8s.io/razeedeploy-rb created
    job.batch/razeedeploy-job created
    
  6. Verify that all pods in the razeedeploy project are in a Running state.

    oc get pods -n razeedeploy
    

    Example output

    NAME                                                  READY     STATUS      RESTARTS   AGE
    clustersubscription-c9cfb6f8b-7p5sw            1/1     Running     0          41m
    encryptedresource-controller-5c68f9746-vhdsk   1/1     Running     0          41m
    mustachetemplate-controller-5f9b554f69-f22v5   1/1     Running     0          41m
    razeedeploy-job-2wbd7                          0/1     Completed   0          47m
    remoteresource-controller-56bbfd6db6-mpngf     1/1     Running     0          41m
    watch-keeper-5d4dd9f56b-bt6jz                  1/1     Running     0          3m41s
    
  7. Verify your cluster's status on the Satellite Clusters dashboard.

  8. Optional: Select your cluster to view the Kubernetes resources that are deployed to the cluster.