OpenShift Container Platform cluster registration

To monitor cluster health and receive recommendations from Red Hat Lightspeed advisor, you must register an OpenShift Container Platform cluster to OpenShift Cluster Manager and have an active Red Hat subscription.

By default, every OpenShift Container Platform cluster automatically registers to OpenShift Cluster Manager the first time the cluster boots after installation.

OpenShift Container Platform clusters report health and usage data to Red Hat through Telemetry and the Red Hat Lightspeed operator when registered in OpenShift Cluster Manager. These are referred to as connected clusters.

Occasionally an OpenShift Container Platform cluster does not automatically register to the OpenShift Cluster Manager service (referred to as a disconnected cluster), for example if:

  • the cluster was created in an air-gapped environment and cannot reach OpenShift Cluster Manager to inform OpenShift Cluster Manager it has been created
  • you disabled the Telemeter client
  • your cluster cannot connect to api.openshift.com

In this situation, you can register a disconnected cluster to OpenShift Cluster Manager manually using the OpenShift Cluster Manager cluster registration page, linked in Additional resources. You can also enter your Red Hat subscription details on that page to subscribe your cluster to Red Hat support.

After an OpenShift Container Platform cluster is registered and subscribed, you can monitor your subscription capacity and usage on the Container Platform subscriptions page, linked in Additional resources.

Verify your OpenShift Container Platform cluster registration and subscription
Copy link

In OpenShift Cluster Manager, you can verify that your OpenShift Container Platform cluster is registered and has a Red Hat subscription.

Before you begin
Copy link

  • A Red Hat login
  • An OpenShift Container Platform cluster
  • The Cluster Owner or Cluster Editor role on the cluster, or Organization Administrator privileges in your Red Hat account, if you want to edit subscription settings

About this task
Copy link

OpenShift Container Platform clusters register with OpenShift Cluster Manager automatically by sending Telemetry, the cluster health and usage data that the Telemeter Client reports to Red Hat. A registered cluster is a connected cluster. If Telemetry is disabled or blocked on your network, you must register your cluster manually.

Procedure
Copy link

  1. On the Clusters page, find your cluster.

    If your cluster doesn't display in the list, register it. For instructions, see Register disconnected clusters.

  2. Check the cluster's Status column:
    • Ready: The cluster is connected and sending Telemetry to OpenShift Cluster Manager.
    • Disconnected: The cluster isn't sending Telemetry, usually because it runs on a private network or has Telemetry disabled.
    • Stale: The cluster is connected but hasn't sent Telemetry recently.
  3. Check the cluster's Created column to see its subscription status:
    • A date: The cluster has a Red Hat subscription and receives support and updates.
    • A countdown, such as 59 days left: The cluster has a temporary evaluation subscription. To attach your own Red Hat subscription, select Edit subscription settings from the cluster's overflow menu.
    • Evaluation expired: The cluster has no Red Hat subscription. To add one, select Edit subscription settings from the cluster's overflow menu.

What to do next
Copy link

If your cluster has no subscription, or you need to update its settings, see Configure OpenShift Container Platform cluster subscriptions.

Register disconnected clusters
Copy link

You can register disconnected OpenShift Container Platform clusters with OpenShift Cluster Manager to monitor cluster health and get alerts and recommendations from the Red Hat Lightspeed advisor service.

Before you begin
Copy link

  • An OpenShift Container Platform cluster
  • A Red Hat subscription
  • The Cluster Owner or Cluster Editor role on the cluster, or Organization Administrator privileges in your Red Hat account

About this task
Copy link

A disconnected cluster can't report to Red Hat automatically, so you register it manually by entering its details in OpenShift Cluster Manager.

To change the subscription settings of a cluster that you already registered, go to the Clusters page, open the overflow menu for the cluster, and select Edit subscription settings.

Procedure
Copy link

  1. On the Clusters page, click Register cluster.
    The Register disconnected cluster page opens.
  2. In Cluster ID, enter the ID of the cluster you want to register, for example, 00000c9e-f75e-44e4-86e1-ebf60ec0b000.

    You can find the cluster ID in the OpenShift Container Platform web console.

  3. In Display name, enter a name to identify the cluster in OpenShift Cluster Manager.

    This name displays in the cluster list for your organization.

  4. In Web console URL, enter the URL you use to log in to the web console of the cluster.
  5. To subscribe your cluster to Red Hat support, enter your Red Hat subscription details in Subscription settings:
    1. Select the Service level agreement (SLA) for the cluster.
    2. Select your Support type.
    3. In Cluster usage, select how you intend to use the cluster.
    4. In Subscription units, select the unit that your subscription uses: cores or vCPUs, or sockets.
    5. Enter the number of compute cores or sockets that your cluster uses, not counting control plane nodes.
  6. Click Register cluster.

Results
Copy link

To verify the registration and subscription:

  1. On the Clusters page, confirm that your cluster is listed, and click its name.
  2. On the Overview tab, check the Subscription settings section for the values you entered.
  3. In Subscription Services, go to Subscriptions Usage and confirm that it shows subscription information for your cluster.

Register disconnected clusters using ocm-cli
Copy link

You can use the ocm-cli tool to register and subscribe multiple disconnected OpenShift Container Platform clusters at one time, so that you can monitor cluster health and get recommendations from the Red Hat Lightspeed advisor service.

Before you begin
Copy link

  • An OpenShift Container Platform cluster
  • A Red Hat subscription
  • Organization Administrator privileges in your Red Hat account, or cluster owner privileges on the cluster
  • The ocm-cli tool, installed by following the instructions in the ocm-cli GitHub repository
  • Your OpenShift Cluster Manager offline access token, from the OpenShift Cluster Manager API token page

About this task
Copy link

Registering many disconnected clusters one at a time can take a long time and lead to errors or subscription issues. With the ocm-cli tool, you can register and subscribe multiple disconnected clusters at one time instead of using the OpenShift Cluster Manager UI.

Procedure
Copy link

  1. Log in to OpenShift Cluster Manager with your offline access token: 
    $ ocm login --token=eyJ...

    The ocm login command uses the token to request OpenID access and refresh tokens from sso.redhat.com, and saves them to the .ocm.json file in your home directory for future use.

  2. Register the cluster with OpenShift Cluster Manager by using its cluster UUID, as in this example. The display_name and console_url fields are optional. 
    $ ocm post /api/accounts_mgmt/v1/subscriptions << EOF
{
  "cluster_uuid": "00ce5da0-750d-43cc-a537-bd1f1f98e111",
  "plan_id": "OCP",
  "status": "Disconnected",
  "display_name": "test_cluster1",
  "console_url": "http://example.com"
}
EOF
  3. Note the id value in the API response, for example, 1oiFfXJaoQqbbnnThUj7ZvttkfI. This value is the subscription ID for the cluster in OpenShift Cluster Manager.
  4. Attach a Red Hat subscription to the cluster, as in this example. Replace <ocm_subscription_id> with the id value from the previous step, and enter values that match your Red Hat subscription: 
    $ ocm patch /api/accounts_mgmt/v1/subscriptions/<ocm_subscription_id> << EOF
{
    "support_level": "Standard",
    "service_level": "L1-L3",
    "usage": "Production",
    "system_units": "Cores/vCPU",
    "cpu_total": 8,
    "socket_total": 1
}
EOF

Results
Copy link

To verify the registration and subscription:

  1. In OpenShift Cluster Manager, click your cluster in the Clusters list.
  2. On the Overview tab, check the Subscription settings section for the values you configured.
  3. In Subscription Services, go to Subscriptions Usage and confirm that it shows subscription information for your cluster.