OpenShift Cluster Manager 2021

Managing clusters

Using Red Hat OpenShift Cluster Manager to work with your OpenShift clusters

Last Updated: 2021-11-12

OpenShift Cluster Manager 2021 Managing clusters
Using Red Hat OpenShift Cluster Manager to work with your OpenShift clusters
Legal Notice
Copyright © 2021 Red Hat, Inc.

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons
Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is
available at
http://creativecommons.org/licenses/by-sa/3.0/
. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must
provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,
Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift,
Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States
and other countries.

Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.

Java ® is a registered trademark of Oracle and/or its affiliates.

XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States
and/or other countries.

MySQL ® is a registered trademark of MySQL AB in the United States, the European Union and
other countries.

Node.js ® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the
official Joyent Node.js open source or commercial project.

The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marks
or trademarks/service marks of the OpenStack Foundation, in the United States and other
countries and are used with the OpenStack Foundation's permission. We are not affiliated with,
endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Abstract
This guide provides instructions for using Red Hat OpenShift Cluster Manager to work with your
OpenShift Container Platform and OpenShift Dedicated clusters. OpenShift Cluster Manager
allows you to create, subscribe, and manage different types of OpenShift clusters from a single user
interface.
 Table of Contents

Table of Contents
.CHAPTER
. . . . . . . . . . 1.. .WHAT
. . . . . . .IS
. . RED
. . . . . HAT
. . . . .OPENSHIFT
. . . . . . . . . . . . .CLUSTER
. . . . . . . . . . MANAGER?
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3. . . . . . . . . . . . .
1.1. GETTING STARTED WITH OPENSHIFT CLUSTER MANAGER 3
1.2. WHAT IS THE DIFFERENCE BETWEEN OPENSHIFT CONTAINER PLATFORM AND OPENSHIFT
DEDICATED? 3
1.3. USING OPENSHIFT CLUSTER MANAGER WITH OPENSHIFT CONTAINER PLATFORM 4
1.4. USING OPENSHIFT CLUSTER MANAGER WITH OPENSHIFT DEDICATED 4
1.5. USING OPENSHIFT CLUSTER MANAGER WITH RED HAT HYBRID CLOUD CONSOLE 5
1.6. USING ADD-ON SERVICES ON YOUR MANAGED OPENSHIFT CLUSTERS 5

.CHAPTER
. . . . . . . . . . 2.
. . MANAGING
. . . . . . . . . . . . .THE
. . . . .CLUSTER
. . . . . . . . . . LIFECYCLE
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7. . . . . . . . . . . . .
2.1. CREATING CLUSTERS 7
2.1.1. Creating an OpenShift Container Platform cluster 7
2.1.2. Creating an OpenShift Dedicated cluster 8
2.1.2.1. Creating an OpenShift Dedicated cluster with an annual subscription 9
2.1.2.2. Creating an OpenShift Dedicated cluster with an on-demand subscription 10
2.1.2.3. Creating an OpenShift Dedicated cluster with a free trial Red Hat subscription 13
2.2. DELETING CLUSTERS 14
2.2.1. Removing an OpenShift Container Platform cluster from OpenShift Cluster Manager 15
2.2.2. Deleting an OpenShift Dedicated cluster from OpenShift Cluster Manager 15
2.2.3. Viewing archived and deleted clusters 16

.CHAPTER
. . . . . . . . . . 3.
. . CLUSTER
. . . . . . . . . . .SUBSCRIPTIONS
. . . . . . . . . . . . . . . . . .AND
. . . . .REGISTRATION
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
..............
3.1. CONFIGURING OPENSHIFT CONTAINER PLATFORM CLUSTER SUBSCRIPTIONS 18
3.1.1. OpenShift Container Platform cluster subscription settings 20
3.2. MANAGING OPENSHIFT DEDICATED CLUSTER SUBSCRIPTIONS 21
3.2.1. Upgrading an OpenShift Dedicated trial cluster to a fully supported cluster 22
3.3. REGISTERING OPENSHIFT CONTAINER PLATFORM CLUSTERS TO OPENSHIFT CLUSTER MANAGER
24
3.3.1. Verifying your OpenShift Container Platform cluster is registered and subscribed 24
3.3.2. Registering disconnected clusters 25

. . . . . . . . . . . 4.
CHAPTER . . .MANAGING
. . . . . . . . . . . . YOUR
. . . . . . .CLUSTERS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
..............
4.1. VIEWING CLUSTER INFORMATION 28
4.1.1. Determining your cluster ID 28
4.2. RENAMING YOUR CLUSTER 29
4.3. TRANSFERRING CLUSTER OWNERSHIP 30
4.4. MANAGING YOUR ADD-ON SERVICES 31
4.5. DOWNLOADING COMMAND LINE (CLI) TOOLS 32
4.6. DOWNLOADING AND UPDATING PULL SECRETS 32
4.6.1. Downloading the pull secret from OpenShift Cluster Manager 32
4.6.2. Updating the global pull secret 33
4.7. DOWNLOADING THE OPENSHIFT CLUSTER MANAGER API TOKEN 34

.CHAPTER
. . . . . . . . . . 5.
. . CONFIGURING
. . . . . . . . . . . . . . . . ACCESS
. . . . . . . . . .TO
. . . CLUSTERS
. . . . . . . . . . . .IN
. . .OPENSHIFT
. . . . . . . . . . . . CLUSTER
. . . . . . . . . . .MANAGER
. . . . . . . . . . . . . . . . . . . . . . . . . . . .36
..............
5.1. USER ACCESS CONCEPTS IN OPENSHIFT CLUSTER MANAGER 36
5.2. CONFIGURING USER ACCESS TO CLUSTERS IN OPENSHIFT CLUSTER MANAGER 37
5.2.1. Viewing user roles and access on a cluster 37
5.2.2. Granting Cluster Editor access to a cluster 37
5.2.3. Revoking Cluster Editor access from an OpenShift cluster 38

.CHAPTER
. . . . . . . . . . 6.
. . .GETTING
. . . . . . . . . .SUPPORT
. . . . . . . . . . .FOR
. . . . .YOUR
. . . . . . CLUSTERS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
..............
6.1. OPENSHIFT CONTAINER PLATFORM SUPPORT 39
6.2. OPENSHIFT DEDICATED SUPPORT 39

1
OpenShift Cluster Manager 2021 Managing clusters

2
 CHAPTER 1. WHAT IS RED HAT OPENSHIFT CLUSTER MANAGER?

CHAPTER 1. WHAT IS RED HAT OPENSHIFT CLUSTER

MANAGER?
Red Hat OpenShift Cluster Manager is a managed service on Red Hat Hybrid Cloud Console where you
can install, operate and upgrade your Red Hat OpenShift 4 clusters. OpenShift Cluster Manager
provides the links and steps to install OpenShift Container Platform clusters and is responsible for
managing both OpenShift Container Platform clusters after self-installation and OpenShift Dedicated
clusters.

From OpenShift Cluster Manager, you can work with all of your organization’s OpenShift Container
Platform and managed OpenShift clusters from a single dashboard.

From OpenShift Cluster Manager, you can:

View high level cluster information

Create new clusters

Configure Red Hat subscription services on your clusters

Manage your clusters using other services on Red Hat Hybrid Cloud Console .

Monitor clusters for problems

Access the cluster admin console

1.1. GETTING STARTED WITH OPENSHIFT CLUSTER MANAGER

To access OpenShift Cluster Manager, go to https://console.redhat.com/openshift/.

To start using OpenShift Cluster Manager, you will need:

A Red Hat login

A supported web browser. For details about web browser requirements, see the Browser
Support link at the bottom of the Red Hat Hybrid Cloud Console landing page.

Additional resources
You can find documentation for these related products and services here:

OpenShift Container Platform documentation

OpenShift Dedicated documentation

Subscriptions documentation

Red Hat Insights for OpenShift (Remote health monitoring with connected clusters)
documentation

1.2. WHAT IS THE DIFFERENCE BETWEEN OPENSHIFT CONTAINER

PLATFORM AND OPENSHIFT DEDICATED?
OpenShift Container Platform clusters are self-managed and run on-premises or on a cloud provider.
OpenShift Dedicated clusters are managed by Red Hat and run on a cloud provider.

3
OpenShift Cluster Manager 2021 Managing clusters

OpenShift Container Platform is a self-managed hybrid cloud platform. With OpenShift Container
Platform, you can create your clusters on any private or public cloud or bare metal, using your own
infrastructure.

OpenShift Dedicated is a fully managed service for Red Hat OpenShift, which uses Amazon Web
Services (AWS) or Google Cloud Platform. With OpenShift Dedicated, you can run your clusters on Red
Hat’s managed cloud account, or on your own AWS or Google Cloud Platform (GCP) cloud provider
account. OpenShift Dedicated clusters are referred to as managed clusters.

OpenShift Cluster Manager allows you to create and manage your OpenShift Container Platform and
OpenShift Dedicated clusters from one dashboard.

Additional resources

See https://www.openshift.com/products to learn more about OpenShift products.

See OpenShift deployment methods for more information about the different types of
OpenShift deployments.

1.3. USING OPENSHIFT CLUSTER MANAGER WITH OPENSHIFT

CONTAINER PLATFORM
OpenShift Cluster Manager provides a user interface to create OpenShift Container Platform clusters
and subscribe the clusters to Red Hat for support.

OpenShift Cluster Manager provides the installer and instructions to create clusters on each supported
environment for OpenShift Container Platform.

You can then view and manage your OpenShift Container Platform clusters in OpenShift Cluster
Manager, or log into the OpenShift Container Platform web console to access and configure your
clusters.

Additional resources

For more information on using OpenShift Container Platform, see the OpenShift Container
Platform documentation.

1.4. USING OPENSHIFT CLUSTER MANAGER WITH OPENSHIFT

DEDICATED
OpenShift Cluster Manager provides a user interface to create, view and manage your OpenShift
Dedicated clusters.

OpenShift Dedicated clusters are managed by Red Hat and are known as managed clusters. You can
create OpenShift Dedicated clusters on AWS or Google Cloud Platform, using either Red Hat’s
managed cloud account or your own cloud provider account. When using your own cloud provider
account, this billing model is referred to as Customer Cloud Subscription (CCS) in OpenShift Cluster
Manager.

Additional resources

For more information on using OpenShift Dedicated and accessing your clusters, see the
OpenShift Dedicated documentation.

4
 CHAPTER 1. WHAT IS RED HAT OPENSHIFT CLUSTER MANAGER?

1.5. USING OPENSHIFT CLUSTER MANAGER WITH RED HAT HYBRID

CLOUD CONSOLE
OpenShift Cluster Manager is integrated with other services hosted on Red Hat Hybrid Cloud Console ,
which you can use to gain deeper understanding and manage your OpenShift clusters:

Red Hat Insights for OpenShiftmonitors the health of your OpenShift Container Platform
clusters and helps you identify, prioritize, and resolve risks to security, performance, availability,
and stability. You can access Red Hat Insights for OpenShift by selecting an OpenShift
Container Platform cluster in OpenShift Cluster Manager, then viewing the Insights Advisor tab
for that cluster.

Subscriptions allows you to monitor your usage and subscription information for your OpenShift
clusters.

Cost management aggregates and displays the costs of your OpenShift deployment and
infrastructure across bare-metal servers, virtual machines, private clouds and public cloud
infrastructure, including AWS and Microsoft Azure.

You need a Red Hat account to access OpenShift Cluster Manager and Red Hat Hybrid Cloud Console .
You can then deploy an OpenShift cluster in OpenShift Cluster Manager.

Additional resources

See Remote health monitoring with connected clusters for information about Red Hat Insights
for OpenShift.

Subscriptions documentation

Cost management documentation

See the Red Hat Hybrid Cloud Console documentation for more information about using Red
Hat Hybrid Cloud Console and its services.

Sign up for a free Red Hat account at https://www.redhat.com/wapps/ugc/register.html.

1.6. USING ADD-ON SERVICES ON YOUR MANAGED OPENSHIFT

CLUSTERS
Add-ons are additional services that you can install to your existing managed OpenShift clusters to
enhance cluster capabilities.

You can install and manage add-on services from a cluster’s Add-ons tab in OpenShift Cluster Manager.

Depending on the add-on service, you may need additional Red Hat subscriptions or quota to use it. See
the documentation for the add-on to learn more about the requirements and for instructions for using
the add-on.

To learn about add-ons for OpenShift Dedicated, see Add-on services available for OpenShift
Dedicated.

To learn about add-ons for Red Hat OpenShift Service on AWS (ROSA), see Add-on services
available for Red Hat OpenShift Service on AWS.

Additional resources

5
OpenShift Cluster Manager 2021 Managing clusters

To add a service to your OpenShift Dedicated cluster, see Add-on Services in the OpenShift
Dedicated documentation.

6
 CHAPTER 2. MANAGING THE CLUSTER LIFECYCLE

CHAPTER 2. MANAGING THE CLUSTER LIFECYCLE

You can use Red Hat OpenShift Cluster Manager to create and delete OpenShift clusters, and manage
the cluster lifecycle.

2.1. CREATING CLUSTERS

2.1.1. Creating an OpenShift Container Platform cluster

OpenShift Container Platform clusters run on your own infrastructure. Using OpenShift Container
Platform, you can create your clusters on a private or public cloud, or on bare metal, using the
command-line installer.

Create your cluster using OpenShift Cluster Manager and the installer for your environment or cloud
account.

After provisioning your cluster, configure your Red Hat subscription to get support for your cluster. See
Subscribing an OpenShift Container Platform cluster for instructions and to learn more about
subscription types available for clusters.

Prerequisites

A Red Hat login

Your own on-premises infrastructure. For example, a platform such as Red Hat Virtualization or
Red Hat OpenStack; a cloud provider such as AWS; or a bare-metal Linux machine.

Procedure

1. Go to OpenShift Cluster Manager and click Create cluster.

2. Select the location where you want to install your cluster: in the public cloud (Cloud > Run it
yourself), in your datacenter ( Datacenter), or on your laptop ( Sandbox).

3. Download the provided openshift-install program.

4. Download the pull secret.

IMPORTANT

Do not share your pull secret. The pull secret should be treated like a password.

5. Follow the instructions provided in the OpenShift Cluster Manager user interface to create your
OpenShift cluster.

By default, your cluster automatically registers to the OpenShift Cluster Manager service the first time
your cluster boots after installation and is connected to the Telemetry service. The cluster is registered
with a 60-day evaluation subscription which does not include Red Hat support.

Verification steps

After your cluster is provisioned, you can view it in the Clusters list in OpenShift Cluster
Manager.

7
OpenShift Cluster Manager 2021 Managing clusters

Next steps
After creating your OpenShift Container Platform cluster, you can use OpenShift Cluster Manager to:

Configure your Red Hat subscription to get support for your cluster from the Edit subscriptions
settings menu. You can subscribe your OpenShift Container Platform clusters to an annual Red
Hat subscription or an on-demand subscription from the Red Hat Marketplace.

See Configuring OpenShift Container Platform cluster subscriptions for instructions and more
information about subscription types for clusters.

View health monitoring data, recommendations from Insights, and Telemetry metrics for your
cluster from the cluster details page.

Contact Red Hat Support in case of any issues.

Additional resources

See the OpenShift Container Platform installation documentation for information about
configuring and working with your clusters.

Learn more about OpenShift health monitoring with Telemetry and the Insights Operator in
Remote health monitoring with connected clusters .

2.1.2. Creating an OpenShift Dedicated cluster

OpenShift Dedicated clusters are managed by Red Hat and provisioned on Amazon Web Services or
Google Cloud Platform. They are referred to as managed clusters.

You can create an OpenShift Dedicated cluster on your own AWS or Google Cloud Platform cloud
provider (Customer Cloud Subscription), or use Red Hat’s fully-managed cloud to run your OpenShift
Dedicated clusters.

Create your OpenShift Dedicated clusters in OpenShift Cluster Manager using your Red Hat
subscriptions. These clusters are automatically subscribed to a Red Hat subscription type of your choice
and come with Premium-level support.

You can use one of the following types of Red Hat subscriptions to create OpenShift Dedicated
clusters:

Annual: A subscription providing a fixed capacity of resources, pre-purchased from Red Hat.
Cluster provisioning is based on available quota. Quota is allocated from your Red Hat
subscriptions and is required to scale up a cluster.

On-demand: A subscription allowing flexible usage, billed through the Red Hat Marketplace.
When you enable an on-demand subscription in Red Hat Marketplace, you set resource limits for
your services to control usage automatically.

OpenShift Dedicated trial: You can try OpenShift Dedicated for 60 days free of charge with a
trial Red Hat subscription. You can upgrade your cluster to a paid Red Hat subscription at any
time. See About the OpenShift Dedicated Trial for more details.

You can view your quota and resource limits alongside cluster usage, based on your active OpenShift
Dedicated clusters, from the Subscriptions menu in OpenShift Cluster Manager.

IMPORTANT
8
 CHAPTER 2. MANAGING THE CLUSTER LIFECYCLE

IMPORTANT

You must select the subscription type when creating the cluster. You cannot change the
subscription type on an existing OpenShift Dedicated cluster, with the exception of
upgrading a trial subscription. To create a new cluster, see Creating an OpenShift
Dedicated cluster.

Additional resources

Learn more about creating an OpenShift Dedicated cluster in Creating your cluster in the
OpenShift Dedicated documentation.

For more information about subscription types, see Managing OpenShift Dedicated cluster
subscriptions.

Learn more about Red Hat Marketplace subscriptions.

Learn more about trying OpenShift Dedicated in About the OpenShift Dedicated Trial.

2.1.2.1. Creating an OpenShift Dedicated cluster with an annual subscription

You can create an OpenShift Dedicated cluster using a annual (fixed capacity) Red Hat subscription on
your own AWS or Google Cloud Platform cloud provider (Customer Cloud Subscription), or use Red
Hat’s fully-managed cloud to run your OpenShift Dedicated clusters.

This is the traditional Red Hat subscription type and support is pre-purchased from Red Hat and billed
annually. Cluster provisioning is based on available quota. Quota is allocated from Red Hat subscriptions
and is required to scale up a cluster.

To use an on-demand (flexible usage) subscription for your cluster, see Section 2.1.2.2, “Creating an
OpenShift Dedicated cluster with an on-demand subscription”.

IMPORTANT

You cannot change a cluster’s subscription type after the cluster is created.

Prerequisites

A Red Hat account.

An active Red Hat OpenShift Dedicated subscription with sufficient quota to create a cluster.
Check your available quota from Subscriptions > Dedicated (Annual) .

If you are creating a cluster on your own AWS or Google Cloud (Customer Cloud Subscription),
you must configure your cloud account before creating your cluster. See Requirements for
Customer Cloud Subscriptions for instructions.

Procedure

1. From OpenShift Cluster Manager, click Create cluster.

2. From the Cloud tab next to OpenShift Dedicated, click Create cluster. You can also view your
available quota from this screen before creating your cluster.

3. Select your infrastructure provider to run your cluster on: AWS or Google Cloud.

9
OpenShift Cluster Manager 2021 Managing clusters

4. Select Annual as your Subscription type.

IMPORTANT

You cannot change the subscription type after the cluster is created.

5. Select your Infrastructure type:

Standard deploys your cluster in cloud provider accounts owned by Red Hat. For this
option, Red Hat handles all billing and management for your cluster.

Customer cloud subscription uses your own cloud account, where you control billing and
Red Hat manages the cluster for you. You must configure your cloud account before
creating your cluster. See Requirements for Customer Cloud Subscriptions for instructions.

6. Configure basic cluster settings.

NOTE

See the OpenShift Dedicated documentation for more information about

configuring your cluster’s settings.

7. Click Create cluster to provision your cluster.

Verification

While your cluster is being provisioned, you can view it in the Clusters list on OpenShift Cluster
Manager. The cluster will show its Status as Ready when provisioning is complete.

Next steps
After creating your OpenShift Dedicated cluster and its status is Ready, you can:

Configure an Identity Provider to set up user access. See Authentication in the OpenShift
Dedicated documentation.

Configure privileged dedicated-admin and cluster-admin (also referred to as cluster owner)

users for your cluster. Learn more about OpenShift Dedicated roles in the Authentication guide.

Scale your OpenShift Dedicated cluster up or down, if you have purchased the necessary
subscriptions to do so. See Scaling your cluster for instructions.

Install add-ons to expand your cluster’s capabilities.

View a summary of your cluster’s usage and quota in Subscriptions > Dedicated (Annual) .

Additional resources

Learn more about creating an OpenShift Dedicated cluster in Creating your cluster in the
OpenShift Dedicated documentation.

Learn more about subscription types in Managing OpenShift Dedicated cluster subscriptions .

2.1.2.2. Creating an OpenShift Dedicated cluster with an on-demand subscription

You can use the On-demand subscription type to create an OpenShift Dedicated cluster that is billed
10
 CHAPTER 2. MANAGING THE CLUSTER LIFECYCLE

You can use the On-demand subscription type to create an OpenShift Dedicated cluster that is billed
by usage. Billing is post-paid and handled by the Red Hat Marketplace.

When you enable an on-demand subscription in Red Hat Marketplace, you set resource limits for your
services to control maximum usage automatically.

This option allows the flexibility to scale your cluster up and down as needed, and to be billed
accordingly. You can track usage by cluster in Subscriptions > Dedicated (On-Demand) .

To use an annual (fixed capacity) subscription for your cluster, see Section 2.1.2.1, “Creating an
OpenShift Dedicated cluster with an annual subscription”.

IMPORTANT

You cannot change a cluster’s subscription type after the cluster is created.

Prerequisites

A Red Hat account.

An active OpenShift Dedicated on-demand subscription enabled from the Red Hat Marketplace
with resource limits configured.

Check your resource limits from the Subscriptions > Dedicated (On-Demand Limits) area in
OpenShift Cluster Manager. If no resource limits display, go to Red Hat Marketplace to
enable your OpenShift Dedicated on-demand subscription.

Your own AWS or Google Cloud account, configured as described in Requirements for
Customer Cloud Subscriptions.

Procedure

1. From OpenShift Cluster Manager, click Create cluster.

2. From the Cloud tab next to OpenShift Dedicated, click Create cluster. You can also view your
available quota from this screen before creating your cluster.

3. Select your infrastructure provider to run your cluster on: AWS or Google Cloud.

4. Select On-demand as your Subscription type.

NOTE

If On-demand is not available as an option, follow the prompts in the OpenShift

Cluster Manager user interface to enable an account and link your billing
information in the Red Hat Marketplace . You can also verify whether on-demand
billing (Red Hat Marketplace subscriptions) is configured from the Subscriptions
> Dedicated (On-Demand Limits) in OpenShift Cluster Manager.

You cannot change the subscription type after the cluster is created.

5. Select Customer cloud subscription as your Infrastructure type. This is required for the on-
demand subscription option.

NOTE
11
OpenShift Cluster Manager 2021 Managing clusters

NOTE

The Customer cloud subscription option uses your own cloud account, where
you control billing and Red Hat manages the cluster for you. You must configure
your cloud account before creating your cluster. See Requirements for Customer
Cloud Subscriptions for instructions.

6. Enter your cloud account details.

7. Configure basic cluster settings or select the default settings.

NOTE

See the OpenShift Dedicated documentation for more information about

configuring your cluster’s settings.

8. Click Create cluster to provision your cluster.

Verification

While your cluster is being provisioned, you can view it in the Clusters list on OpenShift Cluster
Manager. The cluster will show its Status as Ready when provisioning is complete.

Next steps
After creating your OpenShift Dedicated cluster and its status is Ready, you can:

Configure an Identity Provider to set up user access. See Authentication in the OpenShift
Dedicated documentation.

Configure privileged dedicated-admin and cluster-admin (also referred to as cluster owner)

users for your cluster. Learn more about OpenShift Dedicated roles in the Authentication guide.

Scale your OpenShift Dedicated cluster up or down, if you have purchased the necessary
subscriptions to do so. See Scaling your cluster for instructions.

Install add-ons to expand your cluster’s capabilities.

View a summary of your cluster’s usage in Subscriptions > Dedicated (On-Demand) .

View a summary of your cluster’s resource limits in Subscriptions > Dedicated (On-Demand
Limits).

Additional resources

Learn more about creating an OpenShift Dedicated cluster in Creating your cluster in the
OpenShift Dedicated documentation.

Learn more about subscription types in Managing OpenShift Dedicated cluster subscriptions .

Learn more about on-demand subscriptions and billing in the Red Hat Marketplace
documentation.

Learn more about subscriptions in the Subscriptions documentation.

12
 CHAPTER 2. MANAGING THE CLUSTER LIFECYCLE

2.1.2.3. Creating an OpenShift Dedicated cluster with a free trial Red Hat subscription

You can try OpenShift Dedicated free of charge for 60 days by using a trial Red Hat subscription.

OpenShift Dedicated trial clusters are provided without an uptime service level agreement (SLA) and
are self-supported.

To use a free trial subscription for your cluster, you need to use your own AWS or Google Cloud account
(Customer Cloud Subscription) to provide the infrastructure.

At any time before the 60-day trial is finished, you can upgrade your cluster with your own Red Hat
subscription details to continue using OpenShift Dedicated. At the end of the 60-day trial period, if you
have not upgraded the trial cluster, your OpenShift Dedicated trial cluster and all installed add-on
services are marked for permanent deletion.

To find out more and sign up for a managed OpenShift trial subscription, go to About the OpenShift
Dedicated Trial or Try OpenShift.

Prerequisites

A Red Hat account.

An OpenShift Dedicated trial subscription enabled. See About the OpenShift Dedicated Trial
for details.

Your own AWS or Google Cloud account, configured as described in Requirements for
Customer Cloud Subscriptions.

Procedure

1. From OpenShift Cluster Manager, click Create cluster.

2. From the Cloud tab next to Red Hat OpenShift Dedicated Trial, click Create trial cluster. You
can also view your available quota from this screen before creating your cluster.

3. Select your infrastructure provider to run your cluster on: AWS or Google Cloud.

In the next screen, Free trial (upgradeable) will be automatically selected as your
Subscription type, and Customer cloud subscription will be automatically selected as your
Infrastructure type.

NOTE

If Free trial (upgradeable) is not available as an option, follow the

prompts in the user interface to enable your Red Hat account.

Customer cloud subscription uses your own cloud account, where you
control billing and Red Hat manages the cluster for you. You must
configure your cloud account before creating your cluster. See
Requirements for Customer Cloud Subscriptions for instructions.

4. Enter the required details for your AWS account or Google Cloud Platform service account.

5. Configure basic cluster settings.

NOTE
13
OpenShift Cluster Manager 2021 Managing clusters

NOTE

See the OpenShift Dedicated documentation for more information about

configuring your cluster’s settings.

6. Click Create cluster to provision your cluster.

Verification

While your cluster is being provisioned, you can view it in the Clusters list on OpenShift Cluster
Manager. The cluster will show its Status as Ready when provisioning is complete.

See the cluster overview page to view the expiry date of the trial subscription and other details. This
information also shows on the Clusters list in the Created column.

Next steps
After creating your OpenShift Dedicated cluster and its status is Ready, you can:

Configure an Identity Provider to set up user access. See Authentication in the OpenShift
Dedicated documentation.

Configure privileged dedicated-admin and cluster-admin (also referred to as cluster owner)

users for your cluster. Learn more about OpenShift Dedicated roles in the Authentication guide.

Scale your OpenShift Dedicated cluster up or down, if you have purchased the necessary
subscriptions to do so. See Scaling your cluster for instructions.

Install add-ons to expand your cluster’s capabilities.

View a summary of your cluster’s usage and quota in Subscriptions > Dedicated (Annual) .

IMPORTANT

Before your 60-day trial expires, upgrade your cluster to a paid fully-supported Red Hat
subscription to continue using your cluster. See Upgrading an OpenShift Dedicated trial
cluster to a fully supported cluster.

Additional resources

For more details about OpenShift Dedicated trial clusters, see:

Try OpenShift

About the OpenShift Dedicated Trial

Learn more about creating an OpenShift Dedicated cluster in Creating your cluster in the
OpenShift Dedicated documentation.

Learn more about subscription types in Managing OpenShift Dedicated cluster subscriptions .

Learn more about Red Hat OpenShift Dedicated .

2.2. DELETING CLUSTERS

2.2.1. Removing an OpenShift Container Platform cluster from OpenShift Cluster

14
 CHAPTER 2. MANAGING THE CLUSTER LIFECYCLE

2.2.1. Removing an OpenShift Container Platform cluster from OpenShift Cluster

Manager
You can archive an OpenShift Container Platform cluster to delete it from OpenShift Cluster Manager.
Archiving a cluster removes it from subscription management and from the cluster list in OpenShift
Cluster Manager.

You cannot delete an OpenShift Container Platform cluster from your infrastructure using OpenShift
Cluster Manager.

NOTE

To fully delete an OpenShift Container Platform cluster, see the instructions for
destroying a cluster on your infrastructure type in the OpenShift Container Platform
Installing documentation.

Prerequisites

A Red Hat login

An OpenShift Container Platform cluster

Procedure

1. In OpenShift Cluster Manager select the cluster you want to archive.

2. Click (more options) > Archive cluster to open the archiving dialog.

3. Click Archive cluster to confirm.

Verification
When archiving is complete, your cluster will no longer appear in the Clusters list in OpenShift Cluster
Manager.

You can view all archived clusters in the Cluster Archives list in OpenShift Cluster Manager.

NOTE

You can restore an OpenShift Container Platform cluster from the archive by locating it
in https://console.redhat.com/openshift/archived and clicking Unarchive next to the
cluster. It will appear in the Clusters list after it is unarchived.

Additional resources

See Installing in the OpenShift Container Platform documentation for the commands to destroy
a cluster.

2.2.2. Deleting an OpenShift Dedicated cluster from OpenShift Cluster Manager

You can delete OpenShift Dedicated clusters using OpenShift Cluster Manager.

Prerequisites

15
OpenShift Cluster Manager 2021 Managing clusters

A Red Hat login

An OpenShift Dedicated cluster

Procedure

1. In OpenShift Cluster Manager select the cluster you want to delete.

2. Click (more options) > Delete cluster to open the Delete cluster dialog.


WARNING

This action cannot be undone. It will uninstall the cluster, and all data will be
deleted.

3. Confirm you want to delete the cluster by typing the cluster name in the dialog field and click
Delete.

Verification

Your cluster will show Uninstalling in the Status column on the Clusters page.

While the cluster deletion is in progress, you can view Uninstallation logs by opening the cluster
details Overview page.

When the deletion is complete, your cluster will no longer appear in the Clusters list in OpenShift
Cluster Manager.

You can view your deleted clusters from the Clusters list by clicking (more options) > View cluster
archives.

2.2.3. Viewing archived and deleted clusters

You can view all deleted and archived OpenShift clusters from the Cluster Archives list in OpenShift
Cluster Manager.

OpenShift Dedicated clusters can be fully deleted in OpenShift Cluster Manager, while OpenShift
Container Platform clusters can only be archived. Archiving an OpenShift Container Platform cluster
removes it from the OpenShift Cluster Manager cluster list and from subscription management.

Prerequisites

A Red Hat login

Procedure

Click Cluster Archives to view a list of deleted and archived clusters in OpenShift Cluster
Manager.

16
 CHAPTER 2. MANAGING THE CLUSTER LIFECYCLE

NOTE

You can restore an OpenShift Container Platform cluster from the archive by finding the
cluster in https://console.redhat.com/openshift/archived and clicking Unarchive next to
the cluster. It will appear in the Clusters list after it is unarchived.

Additional resources

See Installing in the OpenShift Container Platform documentation for the commands to fully
delete (destroy) a cluster.

17
OpenShift Cluster Manager 2021 Managing clusters

CHAPTER 3. CLUSTER SUBSCRIPTIONS AND REGISTRATION

To use all Red Hat OpenShift functionality, your clusters must be registered to Red Hat OpenShift
Cluster Manager and entitled to Red Hat subscription management.

After you create a cluster, it is automatically registered to OpenShift Cluster Manager and subscribed to
a Red Hat subscription where you can access Red Hat support and updates.

OpenShift Container Platform clusters are automatically entitled to a limited 60-day Red Hat
evaluation subscription when created. To upgrade your OpenShift Container Platform cluster to
your own Red Hat subscription, see Section 3.1, “Configuring OpenShift Container Platform
cluster subscriptions”.

To create an OpenShift Dedicated cluster, you must enter your Red Hat subscription details at
creation. You can use your own Red Hat subscription when creating an OpenShift Dedicated
cluster, or try OpenShift Dedicated using a 60-day trial subscription to be upgraded later. To
configure the subscription settings on your OpenShift Dedicated clusters, see Section 3.2,
“Managing OpenShift Dedicated cluster subscriptions”.

Additional resources

To check subscription usage for your OpenShift Container Platform clusters, go to

Subscriptions > Container Platform . Learn more in the Subscriptions documentation.

Occasionally, an OpenShift Container Platform cluster does not automatically register to

OpenShift Cluster Manager or a disconnected cluster needs re-registering. See Section 3.3,
“Registering OpenShift Container Platform clusters to OpenShift Cluster Manager”.

To verify the registration and subscription status of your OpenShift Container Platform clusters,
see Section 3.3.1, “Verifying your OpenShift Container Platform cluster is registered and
subscribed”.

3.1. CONFIGURING OPENSHIFT CONTAINER PLATFORM CLUSTER

SUBSCRIPTIONS
By default, your OpenShift Container Platform cluster automatically registers to the OpenShift Cluster
Manager service (https://console.redhat.com/openshift/) after it is created, and is subscribed to limited
60-day Red Hat evaluation subscription for access to Red Hat support and updates.

To avoid downtime on your cluster, you must edit the cluster subscription settings in OpenShift Cluster
Manager to use your own Red Hat subscription before your evaluation subscription expires.

You can use one of the following Red Hat subscription types to support your OpenShift Container
Platform clusters:

Annual: A subscription providing a fixed capacity of resources, pre-purchased from Red Hat.

On-demand: This subscription allows flexible usage and is billed through the Red Hat
Marketplace. Your clusters must be connected to Telemetry in OpenShift Cluster Manager to
use this subscription type.
When you enable an on-demand subscription in Red Hat Marketplace, you set resource limits for
your services to control usage automatically.

You can view your active OpenShift Container Platform subscriptions from the Subscriptions area in
OpenShift Cluster Manager.

18
 CHAPTER 3. CLUSTER SUBSCRIPTIONS AND REGISTRATION

NOTE

If you disabled telemetry or your cluster cannot connect to api.openshift.com, you can
alternatively complete the Red Hat registration process online at
https://console.redhat.com/openshift/register. See Registering disconnected clusters
for more information.

Prerequisites

An OpenShift Container Platform cluster

A Red Hat annual subscription or an OpenShift Container Platform on-demand subscription

enabled from the Red Hat Marketplace with resource limits configured.

Check your resource limits from the Subscriptions area in OpenShift Cluster Manager. If no
resource limits display, enable on-demand subscriptions in Red Hat Marketplace.

Organization Administrator or cluster owner privileges:

Organization Administrator is access granted to your Red Hat account.

Cluster owner privileges are granted within your cluster.

Procedure

1. View an OpenShift Container Platform cluster in OpenShift Cluster Manager.

2. Click Actions > Edit subscription settings. You can also access this from the Subscription
settings section of the cluster Overview page.

3. Select your Subscription type:

Annual to use your Red Hat fixed capacity subscription

On-demand to use your Red Hat Marketplace flexible usage subscription

IMPORTANT

If On-demand is not available as an option, contact Red Hat Sales to enable

an account and link your billing information in the Red Hat Marketplace. You
can also verify whether on-demand billing is enabled if Marketplace shows
as Enabled in the Subscriptions area under OpenShift Container Platform.

After setting your subscription type, you cannot change a cluster’s

subscription type from on-demand to an annual subscription.

4. If you selected Annual, select the options that apply to your Red Hat subscription in the dialog.
See OpenShift Container Platform cluster subscription settings for more details about the
available settings. If your cluster is disconnected, the subscription type will be automatically set
to Annual. For On-demand, all other settings are pre-configured.

5. Click Save settings.

It may take up to two hours for these settings to update for your cluster in the Subscriptions summary
and Red Hat Subscription Management after making changes to your Red Hat subscription in the Red
Hat Customer Portal.

19
OpenShift Cluster Manager 2021 Managing clusters

Verification steps
View your cluster’s subscription status and usage in Subscriptions > Container Platform .

Additional resources

For more details about Subscriptions, see the Subscriptions documentation.

Learn more about remote health monitoring with Telemetry and the Insights Operator in the
OpenShift Container Platform documentation .

For more information about on-demand subscriptions and billing, see the Red Hat Marketplace
documentation.

3.1.1. OpenShift Container Platform cluster subscription settings

To ensure you get the correct level of support for your OpenShift Container Platform clusters, configure
your cluster subscription settings in OpenShift Cluster Manager to align with the values for your Red Hat
subscription.

For OpenShift Dedicated subscriptions, no configuration is needed after choosing your subscription
type.

NOTE

To find more details about your subscriptions, view your Subscriptions Inventory in the
Red Hat Customer Portal.

To change the support type of an OpenShift Container Platform cluster after it has been initialized on

Red Hat OpenShift Cluster Manager, click (more options) > Edit subscription settings for a
cluster.

The following options are available for OpenShift Container Platform clusters:

Table 3.1. Subscription settings

Subscription setting Options Summary More information

Subscription type What type of Contact Red Hat Sales

Annual: Fixed
subscription are you to enable on-demand
capacity
subscription using for this cluster? subscriptions from the
from Red Hat Red Hat Marketplace for
OpenShift Container
On-demand: Platform clusters.
Flexible usage
billed through
the Red Hat
Marketplace

20
 CHAPTER 3. CLUSTER SUBSCRIPTIONS AND REGISTRATION

Subscription setting Options Summary More information

Service level agreement How is this cluster The hours of coverage,

Premium
(SLA) supported? support ticket response
Standard times, and other terms
that are defined by the
Self-Support Service Level
60-day Agreement (SLA). See
evaluation Production Support
Terms of Service.

Support type Which team do you If you purchased the

Red Hat
contact for primary subscription through
support (L1-
L3) support? Red Hat, select L1-L3.

Partner
support (L3)

Cluster usage How do you intend to Are you using this

Production
use this cluster? cluster to run production
Development/ workloads or for internal
Test development or other
projects?
Disaster
Recovery

Subscription units How is usage measured Defines how the product

Cores/vCPUs
for your subscription? was sold and how its
Sockets usage will be measured.
How usage is measured
for your subscription.

3.2. MANAGING OPENSHIFT DEDICATED CLUSTER SUBSCRIPTIONS

OpenShift Cluster Manager allows you to create OpenShift Dedicated clusters using your Red Hat
subscriptions. These clusters are managed by Red Hat and come with Premium-level support. You must
enter your subscription details when creating an OpenShift Dedicated cluster.

You can use one of the following types of Red Hat subscriptions to create OpenShift Dedicated
clusters:

Annual: A subscription providing a fixed capacity of resources, pre-purchased from Red Hat.
Cluster provisioning is based on available quota. Quota is allocated from your Red Hat
subscriptions and is required to scale up a cluster.

On-demand: A subscription allowing flexible usage, billed through the Red Hat Marketplace.
When you enable an on-demand subscription in Red Hat Marketplace , you set resource limits
for your services to control usage automatically.

OpenShift Dedicated trial: You can try OpenShift Dedicated for 60 days free of charge with a

21
OpenShift Cluster Manager 2021 Managing clusters

OpenShift Dedicated trial: You can try OpenShift Dedicated for 60 days free of charge with a
trial Red Hat subscription. You can upgrade your cluster to a paid Red Hat subscription at any
time. See About the OpenShift Dedicated Trial for more details.

You can view your quota and resource limits, based on your active OpenShift Dedicated clusters, from
the Subscriptions menu in OpenShift Cluster Manager.

IMPORTANT

You must select the subscription type when creating the cluster. You cannot change the
subscription type on an existing OpenShift Dedicated cluster, with the exception of
upgrading a trial subscription. To create a new cluster, see Creating an OpenShift
Dedicated cluster.

Prerequisites

A Red Hat account.

An active Red Hat OpenShift Dedicated subscription with sufficient quota to create a cluster.
See https://www.openshift.com/products/dedicated/ for more information.

Procedure

To view a summary of all subscriptions for OpenShift Dedicated purchased by your organization
or granted by Red Hat, go to OpenShift Cluster Manager and click Subscriptions. The summary
also shows how much of your quota and resource limits have been used by your OpenShift
Dedicated clusters, broken down by subscription type.

For Red Hat annual subscriptions, you can check your usage and quota in Subscriptions >
Dedicated (Annual). You can also find out more about your subscription details in the Red
Hat Customer Portal and purchase more quota if desired.

NOTE

It may take up to two hours for your cluster’s subscription status to update in
OpenShift Cluster Manager after making changes in the Red Hat Customer
Portal.

For Red Hat Marketplace on-demand subscriptions, you can check your total usage and
usage by cluster in Subscriptions > Dedicated (On-Demand) . You can view your resource
limits in Subscriptions > Dedicated (On-Demand Limits) . You can also view the total usage
for your on-demand OpenShift Dedicated clusters in Red Hat Marketplace.
For information about billing for on-demand subscriptions, see Pay as you go products in
the Red Hat Marketplace documentation.

For trial subscriptions, follow the prompts to upgrade your cluster to a paid Red Hat
subscription before your trial finishes. See About the OpenShift Dedicated Trial for more
details.

3.2.1. Upgrading an OpenShift Dedicated trial cluster to a fully supported cluster

You can upgrade your OpenShift Dedicated (OSD) trial cluster at any time after starting the free trial.

You may choose to upgrade your trial cluster before the trial conclusion if you want to run production

22
 CHAPTER 3. CLUSTER SUBSCRIPTIONS AND REGISTRATION

You may choose to upgrade your trial cluster before the trial conclusion if you want to run production
services or use features that are not included in the free trial, such as autoscaling, specific add-on
services, and quota increases.

IMPORTANT

The OpenShift Dedicated free trial ends when you delete your cluster or after 60 days,
whichever happens first. At that time, your OpenShift Dedicated trial cluster and all
installed add-on services are marked for permanent deletion.

If you upgrade the cluster before the trial is over, you can continue using the resources you created
during the trial without interruption.

Prerequisites

An OpenShift Dedicated cluster using a trial subscription

A Red Hat account

A Red Hat subscription for OpenShift Dedicated

Organization Administrator or cluster owner privileges:

Organization Administrator is access granted to your Red Hat account.

Cluster owner privileges are granted within your cluster.

Procedure

1. Go to the Clusters list in OpenShift Cluster Manager.

2. Find your OpenShift Dedicated trial cluster, labeled OSD Trial in the Cluster Type column.

3. Click Upgrade from trial and follow the instructions to upgrade your cluster.

NOTE

If the Upgrade from trial option does not appear, the reasons could include the following:

You do not have the permissions needed to upgrade this cluster to a fully
supported cluster. You must be an Organization Administrator on the Red Hat
account or the cluster owner to upgrade the account.

This cluster account is already upgraded to a fully supported OpenShift

Dedicated cluster.

Verification steps

Find your OpenShift Dedicated cluster in the Clusters list in OpenShift Cluster Manager. The
Cluster type will no longer be listed as OSD Trial.

Additional resources

For more information about subscription types for OpenShift Dedicated clusters, see Managing
OpenShift Dedicated cluster subscriptions.

23
OpenShift Cluster Manager 2021 Managing clusters

For more details about OpenShift Dedicated trial clusters, see:

About the OpenShift Dedicated Trial

Try OpenShift

3.3. REGISTERING OPENSHIFT CONTAINER PLATFORM CLUSTERS

TO OPENSHIFT CLUSTER MANAGER
To monitor the health of your OpenShift Container Platform clusters and receive alerts, updates, and
recommendations from Red Hat Insights, your clusters must be registered to OpenShift Cluster
Manager and subscribed to a 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 Insights 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 from
https://console.redhat.com/openshift/register. You can also enter your Red Hat subscription details
from here to entitle your cluster to Red Hat support.

After an OpenShift Container Platform cluster is registered and subscribed, you can then monitor your
subscription capacity and usage in Subscriptions > Container Platform .

3.3.1. Verifying your OpenShift Container Platform cluster is registered and

subscribed
You can verify that your OpenShift Container Platform cluster is registered to OpenShift Cluster
Manager and subscribed to a Red Hat subscription from OpenShift Cluster Manager.

A OpenShift Container Platform cluster that is registered on OpenShift Cluster Manager is referred to
as a connected cluster. In rare cases, for example, if Telemetry is disabled or blocked on the user’s
network, the cluster cannot be registered automatically and you must manually register the cluster to
OpenShift Cluster Manager.

Prerequisites

An OpenShift Container Platform cluster

A Red Hat subscription

Procedure
1. Go to the Clusters list in OpenShift Cluster Manager and locate your OpenShift Container
24
 CHAPTER 3. CLUSTER SUBSCRIPTIONS AND REGISTRATION

1. Go to the Clusters list in OpenShift Cluster Manager and locate your OpenShift Container
Platform cluster.

NOTE

If your cluster does not appear in the Clusters list, you need to register your
cluster. See Registering disconnected clusters for instructions.

2. Review the Status column for the cluster:

If the Status is Ready, it is connected to OpenShift Cluster Manager and reporting

Telemetry data. No manual registration is required.

If the Status is Disconnected, it is not sending Telemetry data to OpenShift Cluster

Manager. This is due to the cluster being installed on a private network, or having Telemetry
disabled.

If the Status is Stale, your cluster is connected but has not sent Telemetry data to
OpenShift Cluster Manager recently.

3. Review the Created column for the cluster to see the cluster subscription status:

A date: Your cluster is subscribed to a Red Hat subscription and is receiving support and
updates.

60-day evaluation: Your cluster is subscribed to Red Hat support with a temporary
evaluation subscription. Configure the cluster to access Red Hat support with your own Red

Hat subscription by clicking (more options) > Edit subscription settings.

Evaluation expired: Your cluster is not subscribed to Red Hat support. Configure your

subscription details for the cluster by clicking (more options) > Edit subscription
settings.

NOTE

You can also check the cluster’s subscription settings from the cluster
Overview page.

Next steps

If your cluster is not registered (a disconnected cluster) to OpenShift Cluster Manager, register
it with the steps in Registering disconnected clusters.

If your cluster is not subscribed to a Red Hat subscription or you need to update your
subscription settings, see Configuring OpenShift Container Platform cluster subscriptions .

3.3.2. Registering disconnected clusters

To monitor the health of your OpenShift Container Platform clusters and receive alerts, updates, and
recommendations from Red Hat Insights, your clusters must be registered to OpenShift Cluster
Manager. If your cluster does not appear on the Clusters list in OpenShift Cluster Manager, you need to
register it.

NOTE
25
OpenShift Cluster Manager 2021 Managing clusters

NOTE

If your cluster is already registered to OpenShift Cluster Manager and you only want to

edit subscription settings for your cluster, click (more options) > Edit subscription
settings, or configure your subscription settings from the cluster details page. See
Configuring OpenShift Container Platform cluster subscriptions for details.

Prerequisites

An OpenShift Container Platform cluster

A Red Hat subscription

Organization Administrator or cluster owner privileges:

Organization Administrator is access granted to your Red Hat account.

Cluster owner privileges are granted within your cluster.

Procedure
To register a disconnected cluster, create a profile for your cluster manually in OpenShift Cluster
Manager:

1. Go to the Clusters list in OpenShift Cluster Manager.

2. At the top of the Clusters list, click (more options) > Register cluster to open the
Register disconnected cluster page.

3. Enter the Cluster ID for the cluster you want to register. For example, 00000c9e-f75e-44e4-
86e1-ebf60ec0b000.

NOTE

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

4. Enter the Display name for the cluster. This can be any name that you want to identify the
cluster by in OpenShift Cluster Manager. You can find your cluster by this name in the cluster list
for your organization.

5. Enter the Web console URL for the cluster. This is the URL to log into your OpenShift
Container Platform cluster web console.

6. To subscribe your cluster to Red Hat support, enter your Red Hat subscription details in
Subscription settings:

a. Select the support type for the cluster.

b. Specify how you intend to use the cluster.

c. Select your service level.

d. Specify the unit your subscription is measured in (cores/vCPUs or sockets).

26
 CHAPTER 3. CLUSTER SUBSCRIPTIONS AND REGISTRATION

7. Click Register cluster to confirm registration and subscription.

Your cluster is now registered to OpenShift Cluster Manager and subscribed to Red Hat support.

Verification steps

1. Find your cluster displayed in the Clusters list in OpenShift Cluster Manager.

2. The subscription configuration displays in the Subscription settings section. This can now be
edited.

3. Go to Subscriptions > Container Platform to verify you can view subscription information about
your clusters, including capacity and subscription usage.

Additional resources

Red Hat Insights for OpenShift (Remote health monitoring with connected clusters)
documentation

OpenShift Container Platform documentation

Subscriptions documentation

27
OpenShift Cluster Manager 2021 Managing clusters

CHAPTER 4. MANAGING YOUR CLUSTERS

In Red Hat OpenShift Cluster Manager, you can view your Red Hat OpenShift clusters and perform
various cluster management tasks.

4.1. VIEWING CLUSTER INFORMATION

The OpenShift Cluster Manager Clusters list shows details for all OpenShift Container Platform and
OpenShift Dedicated clusters in your organization. From here, you can select a cluster to review its
settings, check usage, solve issues, and perform other management tasks.

Procedure

Click a cluster from the list to view more details about it, including:

The Overview page shows resource usage and basic facts about the cluster

The cluster history shows what has happened on this cluster: for example, when it was
registered and entitled to a Red Hat subscription

The Monitoring tab shows the health of your OpenShift Container Platform cluster and
uses the Telemetry service to report the cluster’s status in OpenShift Cluster Manager. The
Monitoring area shows critical alerts, for example if a cluster operator is failing. This area
also shows resource usage.

Additional resources

See Remote health monitoring with connected clusters in the OpenShift Container Platform
documentation for more about monitoring your clusters in OpenShift Cluster Manager.

4.1.1. Determining your cluster ID

Every OpenShift cluster is assigned an ID (in the form of a UUID) when created, but each cluster also has
an internal cluster identifier used by OpenShift Cluster Manager. The internal cluster identifier can be
changed to a human-readable name OpenShift Cluster Manager if desired.

You can find this information in OpenShift Cluster Manager, via the command line, or in the OpenShift
web console.

Additionally, when OpenShift Container Platform clusters register to OpenShift Cluster Manager, the
only identifying information may be the cluster UUID. If multiple OCP clusters have been registered at
the same time, it may be necessary to use the cluster UUID to tell them apart.

Prerequisites

An OpenShift Container Platform 4.x cluster

Procedure
There are several ways to view your cluster ID:

Your clusters are listed by ID in OpenShift Cluster Manager in the Clusters area.
From here, you can also search for a cluster by name or ID, and filter by cluster type, OpenShift
Container Platform (OCP), OpenShift Dedicated (OSD), or Red Hat OpenShift Service on
AWS (ROSA).

28
 CHAPTER 4. MANAGING YOUR CLUSTERS

To rename your cluster to a human-readable name, see See Section 4.2, “Renaming your cluster”.

You can also get your OpenShift cluster ID by running the following command locally or on the
cluster itself (after logging into the cluster using oc login):

$ oc get clusterversion <version> -o jsonpath='{.spec.clusterID}{"\n"}'

You can also find your OpenShift cluster ID in the OpenShift Container Platform web console if
you are logged in as an administrator:

In the details pane on the Home/Dashboards page

On the Administration/Cluster Settings page

4.2. RENAMING YOUR CLUSTER

You can give your connected cluster a human-readable name instead of a cluster UUID to make it easier
to reference when contacting Red Hat Support or opening a support case, or when reviewing the list of
clusters in OpenShift Cluster Manager.

When created, every OpenShift cluster is assigned a 36-character UUID string as a name to
differentiate it from other clusters. However, as the UUID can be difficult to search or reference, Red
Hat recommends providing a custom name for the cluster to simplify locating resources and managing
your OpenShift environment.

Prerequisites

An OpenShift Container Platform 4.x or OpenShift Dedicated cluster

You must have a Red Hat account with Organization Administrator access or be the creator or
owner of the cluster you want to edit.

NOTE

Organization administrators can edit the display name of all clusters within their
organization, and cluster creators or owners of a cluster can change the name of any
clusters they created.

Procedure

1. Go to the Clusters list in OpenShift Cluster Manager.

2. Click (more options) next to the cluster you want to rename.

3. Click Edit display name and enter a name for the cluster.

4. Click Edit to save the new name.

NOTE

You can also rename a cluster from its details page from the Actions menu > Edit display
name.

29
OpenShift Cluster Manager 2021 Managing clusters

The new cluster name shows in the clusters list on OpenShift Cluster Manager.

Additional resources

See Section 4.1.1, “Determining your cluster ID” for details about finding your cluster ID.

4.3. TRANSFERRING CLUSTER OWNERSHIP

You can transfer ownership of an OpenShift Container Platform cluster to another user in your
organization or a different organization using OpenShift Cluster Manager.

For example, if you created an OpenShift Container Platform cluster using one Red Hat account but
want to move the cluster to a different Red Hat account to register it to the associated subscription, you
need to transfer cluster ownership to that user. You can transfer ownership of connected or
disconnected clusters.

Connected clusters

To transfer ownership of a connected cluster, initiate the transfer, then change the cluster’s pull secret.
You must change the cluster pull secret within five days of initiating the transfer, or you need to restart
the transfer procedure.

The transfer is complete when OpenShift Cluster Manager receives Telemetry data from the cluster
with the new pull secret.

Disconnected clusters

To transfer ownership of a disconnected cluster, you only need to initiate the transfer; no pull secret is
required.

Prerequisites

An OpenShift Container Platform cluster

Organization Administrator or cluster owner privileges:

Organization Administrator is access granted to your Red Hat account.

Cluster owner privileges are granted within your cluster.

The pull secret associated with the Red Hat account you want to transfer the cluster to. The pull
secret is not required to transfer ownership of a disconnected cluster.

Procedure

1. Download your pull secret from the Downloads page under Tokens. (This is not required for
disconnected clusters.)

IMPORTANT

Do not share your pull secret. The pull secret should be treated like a password.

2. Initiate the transfer:

a. In OpenShift Cluster Manager, select the cluster that you want to transfer.

30
 CHAPTER 4. MANAGING YOUR CLUSTERS

b. Click Actions > Transfer cluster ownership from at the top of the cluster’s page.

c. Click Initiate transfer to confirm this action.

IMPORTANT

You must change the cluster’s pull secret within five days of initiating the
transfer and register the cluster with the new Red Hat account or the transfer
will be cancelled. You can also cancel the ownership transfer anytime before
the pull secret has been changed by clicking Actions > Cancel ownership
transfer.

If you are transferring ownership of a disconnected cluster, the transfer is complete when
the new Red Hat account is registered with the same cluster UUID. If your cluster is
connected to Telemetry, continue to the next step.

3. Change the cluster pull secret:

a. Log into OpenShift Cluster Manager as the cluster owner or Organization Administrator
that will take ownership of the cluster.

b. As the new cluster owner, change the pull secret by executing the following command using
the pull secret you downloaded from OpenShift Cluster Manager:

# oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=pull-

secret.txt

c. If a secret is not already created, run the following to create the secret:

# oc create secret generic pull-secret -n openshift-config --

type=kubernetes.io/dockerconfigjson --from-
file=.dockerconfigjson=/path/to/downloaded/pull-secret

Verification steps
You can verify the transfer was successful by checking:

The cluster Overview:

In Details, the Owner has been updated.

In Cluster history, details of the transfer appear.

If the cluster was transferred to a different organization, the cluster now appears in the new Red
Hat account’s clusters list, and has been removed from the previous Red Hat account’s clusters
list.

Additional resources

See Using image pull secrets in the OpenShift Container Platform documentation.

4.4. MANAGING YOUR ADD-ON SERVICES

From OpenShift Cluster Manager, you can manage the add-ons installed on your clusters. Add-ons are
services that you can install to enhance the capability of your managed OpenShift clusters.

31
OpenShift Cluster Manager 2021 Managing clusters

To access your add-ons and find information about them, navigate to your cluster’s Add-ons tab in
OpenShift Cluster Manager, and select the add-on.

Additional resources

To add a service to your OpenShift Dedicated cluster or manage your existing add-ons, see
Add-on Services in the OpenShift Dedicated documentation.

To add a service to your Red Hat OpenShift Service on AWS (ROSA) cluster or manage your
existing add-ons, see Add-on Services in the Red Hat OpenShift Service on AWS
documentation.

To learn about add-ons for OpenShift Dedicated, see Add-on services available for OpenShift
Dedicated.

To learn about add-ons for Red Hat OpenShift Service on AWS (ROSA), see Add-on services
available for Red Hat OpenShift Service on AWS.

4.5. DOWNLOADING COMMAND LINE (CLI) TOOLS

The Downloads page in OpenShift Cluster Manager provides a single place to download CLI tools and
find your authentication tokens to manage OpenShift.

The Downloads page includes command line tools such as:

Command-line interface (CLI) tools to manage and work with OpenShift from your terminal

Developer tools to simplify the use of Kubernetes

OpenShift installers to create OpenShift Container Platform and CodeReady Containers

clusters.

Procedure

1. Go to Downloads and find the resource you want to download.

2. (Optional) Expand the tool or token description to learn more about the download and see links
to related documentation.

3. Specify the operating system and architecture you are using in the OS type and Architecture
type dropdowns, and click Download.

Additional resources

See Downloading and updating pull secrets for more details about using pull secrets.

4.6. DOWNLOADING AND UPDATING PULL SECRETS

4.6.1. Downloading the pull secret from OpenShift Cluster Manager

An image pull secret provides authentication for the cluster to access services and registries which serve
the container images for OpenShift components. Every individual user gets a single pull secret
generated. The pull secret is used when installing an OpenShift Container Platform cluster.

32
 CHAPTER 4. MANAGING YOUR CLUSTERS

Prerequisites

A Red Hat account

Procedure

1. Go to Downloads and find your pull secret in the Tokens category.

Click Copy to copy your pull secret to the clipboard.

Click Download to download your pull secret as a .txt file.

IMPORTANT

Do not share your pull secret. The pull secret should be treated like a password.

You can now use your pull secret to create an OpenShift Container Platform cluster or transfer cluster
ownership.

Additional resources

See Using image pull secrets in the OpenShift Container Platform documentation.

4.6.2. Updating the global pull secret

You can update the global pull secret for your cluster.


WARNING

Cluster resources must adjust to the new pull secret, which can temporarily limit the
usability of the cluster.

Updating the global pull secret causes the Machine Config Operator to drain the nodes, apply the
change, and uncordon the nodes.

NOTE

As of OpenShift Container Platform 4.7, changes to the global pull secret no longer
trigger a reboot.

Prerequisites

An OpenShift Container Platform cluster

A new or modified pull secret file to upload. You can download your pull secret from Downloads
in OpenShift Cluster Manager.

Access to the cluster as a user with cluster owner privileges.

Procedure

33
OpenShift Cluster Manager 2021 Managing clusters

Procedure

1. Go to Downloads and find your pull secret in the Tokens category.

2. Click Download to download your pull secret as a .txt file.

IMPORTANT

Do not share your pull secret. The pull secret should be treated like a password.

3. Update the global pull secret for your cluster, replacing the pull secret you downloaded in the
following command:

oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=pull-secret.txt

1

1 Provide the path to the new pull secret file.

This begins updates to all nodes in the cluster, which can take some time depending on the size of your
cluster. During this time, nodes are drained and pods are rescheduled on the remaining nodes.

4.7. DOWNLOADING THE OPENSHIFT CLUSTER MANAGER API

TOKEN
Use your OpenShift Cluster Manager API token to authenticate against your OpenShift Cluster
Manager account.

The API token is required to connect to OpenShift Cluster Manager to use the rosa CLI and ocm-cli
command line tools. You can use the same token with both services.

For security, tokens are hidden from display in OpenShift Cluster Manager by default. You can access
your API token on the OpenShift Cluster Manager Downloads page, then view or copy it to use in the
command line.

For information about using the rosa CLI, see the rosa CLI documentation.

For more information about ocm-cli, see Using the ocm-cli to manage your clusters in
OpenShift Cluster Manager.

NOTE

The ocm-cli tool is currently Development Preview.

A release that is provided as Development Preview is provided to a limited set of

customers for their evaluation of an early version of the product and collection of
feedback back to the product development teams. Development Preview releases are
not supported in production environments.

Prerequisites

A Red Hat account

Procedure

34
 CHAPTER 4. MANAGING YOUR CLUSTERS

1. Go to Downloads and find the OpenShift Cluster Manager API Token row under Tokens.

2. Click View API token to go to the OpenShift Cluster Manager API Token page.

3. Click Load token to display your token. By default, the token is hidden from display.

4. Click (Copy to clipboard) to copy your token to use in a terminal.

You can also revoke access to existing tokens from this page.

Additional resources

See Using the ocm-cli to manage your clusters in OpenShift Cluster Manager .

35
OpenShift Cluster Manager 2021 Managing clusters

CHAPTER 5. CONFIGURING ACCESS TO CLUSTERS IN

OPENSHIFT CLUSTER MANAGER
OpenShift Cluster Manager allows you to view and manage the OpenShift clusters in your organization
from one dashboard.

Viewing and editing access to clusters in OpenShift Cluster Manager is controlled by your Red Hat
account configuration (generally by organization) and by role bindings configured in OpenShift Cluster
Manager.

Your role in your organization, as well as the roles you have been assigned on a cluster, determine how
you can manage a cluster, for example:

Viewing the list of clusters in your organization, including your cluster and clusters created by
other users

Viewing a cluster’s details, such as the cluster overview, subscription settings, history, and
Cluster Owner

Editing a cluster’s details, such as subscription settings, cluster display name, machine pools, and
add-on services

5.1. USER ACCESS CONCEPTS IN OPENSHIFT CLUSTER MANAGER

Organization

An organization is defined in your Red Hat account. An organization can have many users, who each have
a login to access Red Hat resources such as Red Hat Hybrid Cloud Console and the Red Hat Customer
Portal.

In OpenShift Cluster Manager, users can view all clusters created within their organization by default.

Organization Administrator

Each organization has one or more Organization Administrator users.

This is the highest permission level in an organization, and the only role that can manage user access
and permissions within a Red Hat account. Organization Administrators can access and edit any cluster
in the organization, as well as configure user roles on clusters in OpenShift Cluster Manager.

For more information about Red Hat account roles, see Roles and Permissions for Red Hat Customer
Portal and How To Create and Manage Users .

Cluster Owner

The user that creates an OpenShift cluster is the Cluster Owner. This user can perform any action on
the cluster and view all details about the cluster in OpenShift Cluster Manager.

Cluster Owners can allow other users in the same organization to manage and perform actions on their
cluster by granting them the Cluster Editor role.

Organization Administrators have the same access to clusters as Cluster Owners.

Cluster Editor

The Cluster Editor role allows you to edit, manage, and delete that cluster, similar to Cluster Owner. The

36
 CHAPTER 5. CONFIGURING ACCESS TO CLUSTERS IN OPENSHIFT CLUSTER MANAGER

The Cluster Editor role allows you to edit, manage, and delete that cluster, similar to Cluster Owner. The
one exception is that a Cluster Editor cannot grant roles on a cluster to other users. Only a Cluster
Owner or an Organization Administrator in the Red Hat account can configure role bindings on clusters.

5.2. CONFIGURING USER ACCESS TO CLUSTERS IN OPENSHIFT

CLUSTER MANAGER

5.2.1. Viewing user roles and access on a cluster

You can view a list of users with assigned roles on a cluster from the OCM Roles and Access screen.

If you are an Organization Administrator in the Red Hat account or the Cluster Owner, you can also edit
the users and their access to the cluster from this screen. Other users can only view information about
users and roles on a cluster.

Prerequisites

An existing OpenShift cluster in your organization

Procedure

1. Select your cluster from the Clusters list.

2. Click Access Control > OCM Roles and Access to see a list of users with assigned roles to
access the cluster.

5.2.2. Granting Cluster Editor access to a cluster

After you create an OpenShift cluster, you can grant Cluster Editor access to other users on your cluster.
This enables members of your team to manage the cluster without being an Organization Administrator
in the Red Hat account.

Prerequisites

An existing OpenShift cluster

You must be the Cluster Owner on the cluster, or Organization Administrator in your Red Hat
account

The user you want to grant access to must be in your organization

Procedure
To grant the Cluster Editor role to a user in your organization:

1. Select your cluster from the Clusters list.

2. Click Access Control > OCM Roles and Access.

3. Click Grant role. The Cluster Editor role is pre-selected.

4. Enter the Red Hat login for the user.

5. Click Grant role to confirm the role assignment.

37
OpenShift Cluster Manager 2021 Managing clusters

Verification
The user is listed on the OCM Roles and Access screen with the Cluster Editor role assigned, and will
be able to edit the cluster.

5.2.3. Revoking Cluster Editor access from an OpenShift cluster

You can revoke a user’s permissions to edit a cluster if you are the Cluster Owner or Organization
Administrator.

Prerequisites

An existing OpenShift cluster

You must be the Cluster Owner on the cluster, or Organization Administrator in your Red Hat
account

A user in your organization with Cluster Editor access on the cluster

Procedure
To revoke Cluster Editor access from a user:

1. Select your cluster from the Clusters list.

2. Click Access Control > OCM Roles and Access.

3. Click (more options) next to the user on the list, then Delete.

4. Click Confirm.

Verification
The user is not displayed in the users list in OCM Roles and Access, and will no longer be able to edit
the cluster.

38
 CHAPTER 6. GETTING SUPPORT FOR YOUR CLUSTERS

CHAPTER 6. GETTING SUPPORT FOR YOUR CLUSTERS

6.1. OPENSHIFT CONTAINER PLATFORM SUPPORT

For help with your Red Hat OpenShift Container Platform clusters, contact Red Hat support.

From here, you can:

Open a new support case. Also see Submitting a support case in the OpenShift Container
Platform documentation for instructions.

View your open support cases: https://access.redhat.com/support/cases/#/case/list

Open a live chat with support engineers

Call or email a Red Hat support expert

Additional resources

See Getting support in the OpenShift Container Platform documentation for more information.

6.2. OPENSHIFT DEDICATED SUPPORT

For questions about your existing Red Hat OpenShift Dedicated installation, contact Red Hat support.

From here, you can:

Open a new support case: https://access.redhat.com/support/cases/#/case/

View open support cases: https://access.redhat.com/support/cases/#/case/list

Open a live chat with support engineers

Call or email a Red Hat support expert

See Support in the OpenShift Dedicated documentation for more information.

39