Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ocm-accesscontrol-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ocm-accesscontrol-tab_{context}"]
= Access control tab

[role="_abstract"]
The **Access control** tab allows the cluster owner to set up an identity provider, grant elevated permissions, and grant roles to other users.

[id="ocm-accesscontrol-tab-identity-providers_{context}"]
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-accessing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="accessing-ocm_{context}"]
= Accessing {cluster-manager-first}

[role="_abstract"]
You can access {cluster-manager} with your configured OpenShift account.

.Prerequisites
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-addons-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ocm-addons-tab_{context}"]
= Add-ons tab

[role="_abstract"]
ifdef::openshift-rosa[]
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.
endif::openshift-rosa[]
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-cluster-history-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@
[id="ocm-cluster-history-tab_{context}"]
= Cluster history tab

[role="_abstract"]
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.
19 changes: 19 additions & 0 deletions modules/ocm-cluster-tabs.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Module included in the following assemblies:
//
// ocm/ocm-overview.adoc

:_mod-docs-content-type: CONCEPT
[id="ocm-cluster-tabs_{context}"]
= Cluster tabs

[role="_abstract"]
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
17 changes: 17 additions & 0 deletions modules/ocm-general-actions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Module included in the following assemblies:
//
// ocm/ocm-overview.adoc

:_mod-docs-content-type: REFERENCE
[id="ocm-general-actions_{context}"]
= General actions

[role="_abstract"]
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, edit the machine pools, and delete the cluster.
ifdef::openshift-rosa[]
You may also transfer the cluster's ownership to another user.
endif::openshift-rosa[]
* **Refresh** icon forces a refresh of the cluster.
1 change: 1 addition & 0 deletions modules/ocm-machinepools-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ocm-machinepools-tab_{context}"]
= Machine pools tab

[role="_abstract"]
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 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.
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-networking-tab-adding-ingress.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="ocm-networking-tab-adding-ingress_{context}"]
= Adding a network Ingress to your {product-title} cluster

[role="_abstract"]
You can add a network Ingress to your cluster from the {cluster-manager-url} web UI.

.Prerequisites
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-networking-tab-concept.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="ocm-networking-tab_{context}"]
= Networking tab

[role="_abstract"]
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.

ifdef::openshift-rosa-hcp[]
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-overview-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ocm-overview-tab_{context}"]
= Overview tab

[role="_abstract"]
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.
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-settings-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ocm-settings-tab_{context}"]
= Settings tab

[role="_abstract"]
The **Settings** tab provides a few options for the cluster owner:

ifdef::openshift-rosa[]
Expand Down
1 change: 1 addition & 0 deletions modules/ocm-support-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ocm-support-tab_{context}"]
= Support tab

[role="_abstract"]
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.
ifdef::openshift-dedicated,openshift-rosa[]
For the steps to add a notification contact, see _Adding cluster notification contacts_.
Expand Down
28 changes: 4 additions & 24 deletions ocm/ocm-overview.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
:_mod-docs-content-type: ASSEMBLY
[id="ocm-overview"]
= Red Hat OpenShift Cluster Manager

include::_attributes/attributes-openshift-dedicated.adoc[]
:context: ocm-overview
toc::[]

[role="_abstract"]
{cluster-manager-first} 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.

{cluster-manager} guides you to install {OCP}, {rosa-classic-title}, {hcp-title-first}, and {dedicated} clusters. It is also responsible for both {OCP} clusters after self-installation as well as your {rosa-classic-title}, {hcp-title-first}, and {dedicated} clusters.
Expand All @@ -28,31 +30,9 @@ For more information about {cluster-manager}, see the entire link:https://docs.r

include::modules/ocm-accessing.adoc[leveloffset=+1]

[id="ocm-general-actions"]
== 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, edit the machine pools, and delete the cluster.
ifdef::openshift-rosa[]
You may also transfer the cluster's ownership to another user.
endif::openshift-rosa[]
* **Refresh** icon forces a refresh of the cluster.

[id="ocm-cluster-tabs"]
== Cluster tabs

Selecting an active, installed cluster shows tabs associated with that cluster. The following tabs display after the cluster's installation completes:
include::modules/ocm-general-actions.adoc[leveloffset=+1]

* Overview
* Access control
* Add-ons
* Cluster history
* Networking
* Machine pools
* Support
* Settings
include::modules/ocm-cluster-tabs.adoc[leveloffset=+1]

include::modules/ocm-overview-tab.adoc[leveloffset=+2]
include::modules/ocm-accesscontrol-tab.adoc[leveloffset=+2]
Expand Down