Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
    2. history bug_report picture_as_pdf
×

Red Hat OpenShift Cluster Manager

edit

Red Hat OpenShift Cluster Manager is a managed service where you can install, modify, operate, and upgrade your Red Hat OpenShift clusters. This service allows you to work with all of your organization’s clusters from a single dashboard.

OpenShift Cluster Manager guides you to install OpenShift Container Platform, Red Hat OpenShift Service on AWS (ROSA), and OpenShift Dedicated clusters. It is also responsible for managing both OpenShift Container Platform clusters after self-installation as well as your ROSA and OpenShift Dedicated clusters.

You can use OpenShift Cluster Manager to do the following actions:

  • Create clusters

  • View cluster details and metrics

  • Manage your clusters with tasks such as scaling, changing node labels, networking, authentication

  • Manage access control

  • Monitor clusters

  • Schedule upgrades

For more information about OpenShift Cluster Manager, see the entire OpenShift Cluster Manager documentation.

edit

Accessing Red Hat OpenShift Cluster Manager

You can access OpenShift Cluster Manager with your configured OpenShift account.

Prerequisites

  • You have an account that is part of an OpenShift organization.

  • If you are creating a cluster, your organization has specified quota.

Procedure
edit

General actions

On the top right of the cluster page, there are some actions that a user can perform on the entire cluster:

  • Open console launches a web console so that the cluster owner can issue commands to the cluster.

  • Actions drop-down menu allows the cluster owner to rename the display name of the cluster, change the amount of load balancers and persistent storage on the cluster, if applicable, manually set the node count, and delete the cluster.

  • Refresh icon forces a refresh of the cluster.

Cluster tabs

Selecting an active, installed cluster shows tabs associated with that cluster. The following tabs display after the cluster’s installation completes:

  • Overview

  • Access control

  • Add-ons

  • Cluster history

  • Networking

  • Machine pools

  • Support

  • Settings

edit

Overview tab

The Overview tab provides information about how the cluster was configured:

  • Cluster ID is the unique identification for the created cluster. This ID can be used when issuing commands to the cluster from the command line.

  • Domain prefix is the prefix that is used throughout the cluster. The default value is the cluster’s name.

  • Type shows the OpenShift version that the cluster is using.

  • Region is the server region.

  • Availability shows which type of availability zone that the cluster uses, either single or multizone.

  • Version is the OpenShift version that is installed on the cluster. If there is an update available, you can update from this field.

  • Created at shows the date and time that the cluster was created.

  • Owner identifies who created the cluster and has owner rights.

  • Delete Protection: <status> shows whether or not the cluster’s delete protection is enabled.

  • Status displays the current status of the cluster.

  • Total vCPU shows the total available virtual CPU for this cluster.

  • Total memory shows the total available memory for this cluster.

  • Infrastructure AWS account displays the AWS account that is responsible for cluster creation and maintenance.

  • Additional encryption field shows any applicable additional encryption options.

  • Nodes shows the actual and desired nodes on the cluster. These numbers might not match due to cluster scaling.

  • Cluster autoscaling field shows whether or not you have enabled autoscaling on the cluster.

  • Instance Metadata Service (IMDS) field shows your selected instance metadata service for the cluster.

  • Network field shows the address and prefixes for network connectivity.

  • OIDC configuration field shows the Open ID Connect configuration for the cluster.

  • Resource usage section of the tab displays the resources in use with a graph.

  • Advisor recommendations section gives insight in relation to security, performance, availability, and stability. This section requires the use of remote health functionality. See Using Insights to identify issues with the cluster in the Additional resources section.

Additional resources
edit

Access control tab

The Access control tab allows the cluster owner to set up an identity provider, grant elevated permissions, and grant roles to other users.

Prerequisites

  • You must be the cluster owner or have the correct permissions to grant roles on the cluster.

Procedure

  1. Select the Grant role button.

  2. Enter the Red Hat account login for the user that you wish to grant a role on the cluster.

  3. Select the Grant role button on the dialog box.

  4. The dialog box closes, and the selected user shows the "Cluster Editor" access.

edit

Add-ons tab

The Add-ons tab displays all of the optional add-ons that can be added to the cluster. Select the desired add-on, and then select Install below the description for the add-on that displays.

edit

Cluster history tab

The Cluster history tab shows every change to the cluster from creation onward for each version. You can specify date ranges for your cluster history and use filters to search based on the description of the notification, the severity of the notification, the type of notification, and which role logged it. You may download your cluster history as a JSON or CSV file.

edit

Networking tab

The Networking tab provides a control plane API endpoint as well as the default application router. Both the control plane API endpoint and the default application router can be made private by selecting the respective box below label. If applicable, you can also find your virtual private cloud (VPC) details on this tab.

Select the Edit application ingress button to edit the existing application ingress. You can change your application ingress to private or public by checking or unchecking the "Make router private" checkbox.

For Security Token Service (STS) installations, these options cannot be changed. STS installations also do not allow you to change privacy nor allow you to add an additional router.
edit

Machine pools tab

The Machine pools tab allows the cluster owner to create new machine pools if there is enough available quota, or edit an existing machine pool.

Selecting the kebab > Edit option opens the "Edit machine pool" dialog. In this dialog, you can change the node count per availability zone, edit node labels and taints, and view any associated AWS security groups.

Select the Edit cluster autoscaling button to specify your autoscaling strategy.

edit

Support tab

In the Support tab, you can add notification contacts for individuals that should receive cluster notifications. The username or email address that you provide must relate to a user account in the Red Hat organization where the cluster is deployed. For the steps to add a notification contact, see Adding cluster notification contacts.

Also from this tab, you can open a support case to request technical support for your cluster.

edit

Settings tab

The Settings tab provides a few options for the cluster owner:

  • Monitoring, which is enabled by default, allows for reporting done on user-defined actions. See Understanding the monitoring stack.

  • Update strategy allows you to determine if the cluster automatically updates on a certain day of the week at a specified time or if all updates are scheduled manually.

  • Node draining sets the duration that protected workloads are respected during updates. When this duration has passed, the node is forcibly removed.

  • Update status shows the current version and if there are any updates available.

Additional resources