Skip to content

Commit e6464fe

Browse files
authored
Merge pull request #84429 from EricPonvelle/OSDOCS-11832_OCM-port
[OSDOCS-11832] OCM book for HCP topic map
2 parents 1963238 + c462649 commit e6464fe

10 files changed

+76
-29
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,17 @@ Topics:
206206
- Name: Creating ROSA with HCP clusters with external authentication
207207
File: rosa-hcp-sts-creating-a-cluster-ext-auth
208208
---
209+
Name: Red Hat OpenShift Cluster Manager
210+
Dir: ocm
211+
Distros: openshift-rosa-hcp
212+
Topics:
213+
- Name: Red Hat OpenShift Cluster Manager
214+
File: ocm-overview
215+
# - Name: Red Hat OpenShift Cluster Manager
216+
# File: ocm-overview
217+
# - Name: Using the OpenShift web console
218+
# File: rosa-using-openshift-console
219+
---
209220
Name: Cluster administration
210221
Dir: rosa_cluster_admin
211222
Distros: openshift-rosa-hcp

modules/ocm-addons-tab.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,9 @@
55
[id="ocm-addons-tab_{context}"]
66
= Add-ons tab
77

8+
ifdef::openshift-rosa[]
89
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.
10+
endif::openshift-rosa[]
11+
ifdef::openshift-rosa-hcp[]
12+
The Add-ons tab is not currently supported on hosted control plane clusters.
13+
endif::openshift-rosa-hcp[]

modules/ocm-cluster-history-tab.adoc

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

modules/ocm-cluster-history.adoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

modules/ocm-machinepools-tab.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
[id="ocm-machinepools-tab_{context}"]
66
= Machine pools tab
77

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.
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.
99

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.
10+
Selecting the image:kebab.png[title=Other options] > **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.
11+
12+
ifdef::openshift-rosa[]
13+
Select the **Edit cluster autoscaling** button to specify your autoscaling strategy.
14+
endif::openshift-rosa[]

modules/ocm-networking-tab-concept.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@
55
[id="ocm-networking-tab_{context}"]
66
= Networking tab
77

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.
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 label. If applicable, you can also find your virtual private cloud (VPC) details on this tab.
99

10+
ifdef::openshift-rosa-hcp[]
11+
You can change your application ingress to private or public by selecting the **Edit application ingress** button then checking or unchecking the "Make router private" checkbox.
12+
endif::openshift-rosa-hcp[]
1013
ifdef::openshift-rosa[]
14+
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.
15+
1116
[IMPORTANT]
1217
====
1318
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.
1419
====
1520
endif::openshift-rosa[]
16-
17-
ifndef::openshift-rosa[]
21+
ifndef::openshift-rosa,openshift-rosa-hcp[]
1822
[IMPORTANT]
1923
====
2024
{cluster-manager-first} does not support the networking tab for a Google Cloud Platform (GCP), non-CCS cluster running in a Red Hat GCP project.
2125
====
22-
endif::openshift-rosa[]
26+
endif::openshift-rosa,openshift-rosa-hcp[]

modules/ocm-overview-tab.adoc

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,45 @@
22
//
33
// ocm/ocm-overview.adoc
44

5-
:_mod-docs-content-type: CONCEPT
5+
:_mod-docs-content-type: REFERENCE
66
[id="ocm-overview-tab_{context}"]
77
= Overview tab
88

9-
The **Overview** tab provides information about how your cluster was configured:
9+
The **Overview** tab provides information about how the cluster was configured:
1010

1111
* **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.
12+
* **Domain prefix** is the prefix that is used throughout the cluster. The default value is the cluster's name.
1213
* **Type** shows the OpenShift version that the cluster is using.
14+
ifndef::openshift-rosa[]
15+
* **Control plane type** is the architecture type of the cluster. The field only displays if the cluster uses a hosted control plane architecture.
16+
endif::openshift-rosa[]
1317
* **Region** is the server region.
14-
* **Provider** shows which cloud provider that the cluster was built upon.
1518
* **Availability** shows which type of availability zone that the cluster uses, either single or multizone.
1619
* **Version** is the OpenShift version that is installed on the cluster. If there is an update available, you can update from this field.
1720
* **Created at** shows the date and time that the cluster was created.
1821
* **Owner** identifies who created the cluster and has owner rights.
19-
* **Subscription type** shows the subscription model that was selected on creation.
20-
* **Infrastructure type** is the type of account that the cluster uses.
22+
* **Delete Protection: <status>** shows whether or not the cluster's delete protection is enabled.
23+
ifdef::openshift-rosa-hcp[]
24+
* **Status** displays the current status of the control plane and machine pools of the cluster.
25+
endif::openshift-rosa-hcp[]
26+
ifdef::openshift-rosa[]
2127
* **Status** displays the current status of the cluster.
28+
endif::openshift-rosa[]
2229
* **Total vCPU** shows the total available virtual CPU for this cluster.
2330
* **Total memory** shows the total available memory for this cluster.
24-
* **Load balancers**
25-
* **Persistent storage** displays the amount of storage that is available on this cluster.
31+
* **Infrastructure AWS account** displays the AWS account that is responsible for cluster creation and maintenance.
32+
ifdef::openshift-rosa-hcp[]
33+
* **Billing marketplace account** displays the AWS account that is used for billing purposes.
34+
endif::openshift-rosa-hcp[]
35+
ifdef::openshift-rosa[]
36+
* **Additional encryption** field shows any applicable additional encryption options.
37+
endif::openshift-rosa[]
2638
* **Nodes** shows the actual and desired nodes on the cluster. These numbers might not match due to cluster scaling.
39+
ifdef::openshift-rosa[]
40+
* **Cluster autoscaling** field shows whether or not you have enabled autoscaling on the cluster.
41+
* **Instance Metadata Service (IMDS)** field shows your selected instance metadata service for the cluster.
42+
endif::openshift-rosa[]
2743
* **Network** field shows the address and prefixes for network connectivity.
44+
* **OIDC configuration** field shows the Open ID Connect configuration for the cluster.
2845
* **Resource usage** section of the tab displays the resources in use with a graph.
29-
* **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 your cluster_ in the _Additional resources_ section.
30-
* **Cluster history** section shows everything that has been done with the cluster including creation and when a new version is identified.
46+
* **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.

modules/ocm-settings-tab.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22
//
33
// ocm/ocm-overview.adoc
44

5+
:_mod-docs-content-type: REFERENCE
56
[id="ocm-settings-tab_{context}"]
67
= Settings tab
78

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

11+
ifdef::openshift-rosa[]
1012
* **Monitoring**, which is enabled by default, allows for reporting done on user-defined actions. See link:https://docs.openshift.com/rosa/observability/monitoring/monitoring-overview.html#understanding-the-monitoring-stack_monitoring-overview.html[Understanding the monitoring stack].
13+
endif::openshift-rosa[]
1114
* **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.
15+
ifdef::openshift-rosa[]
1216
* **Node draining** sets the duration that protected workloads are respected during updates. When this duration has passed, the node is forcibly removed.
17+
endif::openshift-rosa[]
1318
* **Update status** shows the current version and if there are any updates available.

modules/ocm-support-tab.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// ocm/ocm-overview.adoc
44

5+
:_mod-docs-content-type: REFERENCE
56
[id="ocm-support-tab_{context}"]
67
= Support tab
78

ocm/ocm-overview.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,27 +39,28 @@ Selecting an active, installed cluster shows tabs associated with that cluster.
3939
* Overview
4040
* Access control
4141
* Add-ons
42+
* Cluster history
4243
* Networking
43-
* Insights Advisor
4444
* Machine pools
4545
* Support
4646
* Settings
4747

4848
include::modules/ocm-overview-tab.adoc[leveloffset=+2]
4949

50+
ifndef::openshift-rosa-hcp[]
5051
[role="_additional-resources"]
5152
.Additional resources
5253

5354
* xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster]
55+
endif::openshift-rosa-hcp[]
5456

5557
include::modules/ocm-accesscontrol-tab.adoc[leveloffset=+2]
5658
include::modules/ocm-addons-tab.adoc[leveloffset=+2]
57-
include::modules/ocm-cluster-history.adoc[leveloffset=+2]
59+
include::modules/ocm-cluster-history-tab.adoc[leveloffset=+2]
5860
include::modules/ocm-networking-tab-concept.adoc[leveloffset=+2]
59-
ifndef::openshift-rosa[]
61+
ifndef::openshift-rosa,openshift-rosa-hcp[]
6062
include::modules/ocm-networking-tab-adding-ingress.adoc[leveloffset=+3]
61-
endif::openshift-rosa[]
62-
include::modules/ocm-insightsadvisor-tab.adoc[leveloffset=+2]
63+
endif::openshift-rosa,openshift-rosa-hcp[]
6364
include::modules/ocm-machinepools-tab.adoc[leveloffset=+2]
6465
include::modules/ocm-support-tab.adoc[leveloffset=+2]
6566
include::modules/ocm-settings-tab.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)