Skip to content

Commit 5ef5cea

Browse files
EricPonvelleEricPonvelle
authored
Merge pull request #39178 from EricPonvelle/OSDOCS-2461_New-OCM-Book
OSDOCS-2461: Created a new book covering the OpenShift Cluster Manager.
2 parents 6a80337 + 8fa0dbd commit 5ef5cea

13 files changed

+194
-0
lines changed

‎_topic_maps/_topic_map.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,13 @@ Topics:
426426
- Name: Converting a connected cluster to a disconnected cluster
427427
File: connected-to-disconnected
428428
---
429+
Name: Red Hat OpenShift Cluster Manager (OCM)
430+
Dir: ocm
431+
Distros: openshift-dedicated
432+
Topics:
433+
- Name: Red Hat OpenShift Cluster Manager overview
434+
File: ocm-overview
435+
---
429436
Name: Updating clusters
430437
Dir: updating
431438
Distros: openshift-origin,openshift-enterprise

‎modules/ocm-accesscontrol-tab.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-accesscontrol-tab_{context}"]
6+
= Access control tab
7+
8+
The **Access control** tab allows the cluster owner to set up an identity provider, grant elevated permissions, and grant roles to other users.
9+
10+
.Prerequisites
11+
12+
* You must be the cluster owner or have the correct permissions to grant roles on the cluster.
13+
14+
.Procedure
15+
16+
. Select the **Grant role** button.
17+
. Enter the Red Hat account login for the user that you wish to grant a role on the cluster.
18+
. Select the **Grant role** button on the dialog box.
19+
. The dialog box closes, and the selected user shows the "Cluster Editor" access.

‎modules/ocm-accessing.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="accessing-ocm_{context}"]
6+
= Accessing the Red Hat OpenShift Cluster Manager (OCM)
7+
8+
You can access OCM with your configured OpenShift account.
9+
10+
.Prerequisites
11+
12+
* You have an account that is part of an OpenShift organization.
13+
* If you are creating a cluster, your organization has specified quota.
14+
15+
.Procedure
16+
17+
* Log in to the link:https://console.redhat.com/openshift[OCM web console] using your login credentials.

‎modules/ocm-addons-tab.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-addons-tab_{context}"]
6+
= Add-ons tab
7+
8+
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.

‎modules/ocm-insightsadvisor-tab.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-insightsadvisor-tab_{context}"]
6+
= Insights Advisor tab
7+
8+
The **Insights Advisor** tab uses the Remote Health functionality of the OpenShift Container Platform to identify and mitigate risks to security, performance, availability, and stability. See link:https://docs.openshift.com/container-platform/latest/support/getting-support.html[Using Insights to identify issues with your cluster] in the {OCP} documentation.

‎modules/ocm-machinepools-tab.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-machinepools-tab_{context}"]
6+
= Machine pools tab
7+
8+
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.
9+
10+
Selecting the **More options** > **Scale** opens the "Edit node count" dialog. In this dialog, you can change the node count per availability zone. If autoscaling is enabled, you can also set the range for autoscaling.

‎modules/ocm-networking-tab.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-networking-tab_{context}"]
6+
= Networking tab
7+
8+
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 each of them.
9+
10+
[NOTE]
11+
====
12+
For Security Token Service (STS) installations, these options cannot be changed.
13+
====
14+
15+
[IMPORTANT]
16+
====
17+
{OCM} does not support the networking tab for {GCP} clusters unless the organization has the `capability.organization.create_gcp_non_ccs_cluster` permission attached.
18+
====

‎modules/ocm-overview-tab.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-overview-tab_{context}"]
6+
= Overview tab
7+
8+
The **Overview** tab provides information about how your cluster was configured:
9+
10+
* **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.
11+
* **Type** shows the OpenShift version that the cluster is using.
12+
* **Region** is the server region.
13+
* **Provider** shows which cloud provider that the cluster was built upon.
14+
* **Availability** shows which type of availability zone that the cluster uses, either single or multizone.
15+
* **Version** is the OpenShift version that is installed on the cluster. If there is an update available, you can update from this field.
16+
* **Created at** shows the date and time that the cluster was created.
17+
* **Owner** identifies who created the cluster and has owner rights.
18+
* **Subscription type** shows the subscription model that was selected on creation.
19+
* **Infrastructure type** is the type of account that the cluster uses.
20+
* **Status** displays the current status of the cluster.
21+
* **Total vCPU** shows the total available virtual CPU for this cluster.
22+
* **Total memory** shows the total available memory for this cluster.
23+
* **Load balancers**
24+
* **Persistent storage** displays the amount of storage that is available on this cluster.
25+
* **Nodes** shows the actual and desired nodes on the cluster. These numbers might not match due to cluster scaling.
26+
* **Network** field shows the address and prefixes for network connectivity.
27+
* **Resource usage** section of the tab displays the resources in use with a graph.
28+
* **Advisor recommendations** section gives insight in relation to security, performance, availability, and stablility. This section requires the use of remote health functionality. See link:https://docs.openshift.com/container-platform/4.9/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.html[Using Insights to identify issues with your cluster].
29+
* **Cluster history** section shows everything that has been done with the cluster including creation and when a new version is identified.

‎modules/ocm-settings-tab.adoc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-settings-tab_{context}"]
6+
= Settings tab
7+
8+
The **Settings** tab provides a few options for the cluster owner:
9+
10+
* **Monitoring**, which is enabled by default, allows for reporting done on user-defined actions. See link:https://docs.openshift.com/rosa/monitoring/osd-understanding-the-monitoring-stack.html[Understanding the monitoring stack].
11+
* **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.
12+
* **Node draining** sets the duration that protected workloads are respected during updates. When this duration has passed, the node is forcibly removed.
13+
* **Update status** shows the current version and if there are any updates available.

‎modules/ocm-support-tab.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// ocm/ocm-overview.adoc
4+
5+
[id="ocm-support-tab_{context}"]
6+
= Support tab
7+
8+
The **Support** tab allows you to add individuals that should receive notifications about this cluster. Also from this tab, users can open a support case ticket should technical support be required.

0 commit comments

Comments
 (0)