Skip to content

Commit 2a0d149

Browse files
authored
Merge pull request #71722 from AedinC/OSDOCS-8830
/lgtm, merging OSDOCS#8830:Updated OCM and HCC attributes and references to them in ROSA docs
2 parents feceba5 + 44e07ea commit 2a0d149

8 files changed

+30
-21
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@
99
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
1010
:cluster-manager-first: Red Hat OpenShift Cluster Manager
1111
:cluster-manager: OpenShift Cluster Manager
12-
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console]
13-
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
12+
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
13+
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from Red Hat OpenShift Cluster Manager]
1414
:hybrid-console: Red Hat Hybrid Cloud Console
1515
:hybrid-console-second: Hybrid Cloud Console
16+
:hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console]
1617
:AWS: Amazon Web Services (AWS)
1718
:GCP: Google Cloud Platform (GCP)
1819
:product-registry: OpenShift image registry

_attributes/common-attributes.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,12 @@ endif::openshift-origin[]
3636
:ai-full: Assisted Installer
3737
:cluster-manager-first: Red Hat OpenShift Cluster Manager
3838
:cluster-manager: OpenShift Cluster Manager
39-
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console]
40-
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
39+
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
40+
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from Red Hat OpenShift Cluster Manager]
4141
:insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor]
4242
:hybrid-console: Red Hat Hybrid Cloud Console
4343
:hybrid-console-second: Hybrid Cloud Console
44+
:hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console]
4445
// OADP attributes
4546
:oadp-first: OpenShift API for Data Protection (OADP)
4647
:oadp-full: OpenShift API for Data Protection

modules/deploy-app.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,21 @@ From the {product-title} web console, you can deploy a test application from the
2020
ifndef::quickstart[]
2121
.Prerequisites
2222

23-
* You logged in to {cluster-manager-url}.
24-
* You created an {product-title} cluster.
23+
* You logged in to the {hybrid-console-url}.
24+
* You created a {product-title} cluster.
2525
* You configured an identity provider for your cluster.
2626
* You added your user account to the configured identity provider.
2727
endif::[]
2828
2929
.Procedure
3030

31-
. From the {cluster-manager} {hybrid-console-second}, click *Open console*.
31+
. Go to the *Clusters* page in {cluster-manager-url}.
32+
33+
. Click the options icon (⋮) next to the cluster you want to view.
34+
35+
. Click *Open console*.
36+
37+
. Your cluster console opens in a new browser window. Login to your Red Hat account with your configured identity provider credentials.
3238

3339
. In the *Administrator* perspective, select *Home* -> *Projects* -> *Create Project*.
3440

@@ -57,7 +63,7 @@ You might need to click *Clear All Filters* to display the *Node.js* option.
5763

5864
. Click *Create* to deploy the application. It will take a few minutes for the pods to deploy.
5965

60-
. Optional: Check the status of the pods in the *Topology* pane by selecting your *nodejs* app and reviewing its sidebar. You must wait for the `nodejs` build to complete and for the `nodejs` pod to be in a *Running* state before continuing.
66+
. Optional: Check the status of the pods in the *Topology* pane by selecting your *Node.js* app and reviewing its sidebar. You must wait for the `nodejs` build to complete and for the `nodejs` pod to be in a *Running* state before continuing.
6167

6268
. When the deployment is complete, click the route URL for the application, which has a format similar to the following:
6369
+

modules/rosa-sts-associating-your-aws-account.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ifeval::["{context}" == "rosa-sts-creating-a-cluster-quickly"]
2020
:rosa-standalone:
2121
endif::[]
2222

23-
Before using the {cluster-manager-first} {hybrid-console-second} to create
23+
Before using {cluster-manager-first} on the {hybrid-console-url} to create
2424
ifdef::rosa-hcp[]
2525
{hcp-title} clusters
2626
endif::rosa-hcp[]
@@ -99,7 +99,7 @@ $ rosa create ocm-role
9999
+
100100
Select the default values at the prompts to quickly create and link the role.
101101
+
102-
. Create a user role and link it to your {cluster-manager} user account:
102+
. Create a user role and link it to your Red Hat user account:
103103
+
104104
[source,terminal]
105105
----

modules/rosa-sts-creating-a-cluster-using-defaults-ocm.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="rosa-sts-creating-a-cluster-using-defaults-ocm_{context}"]
8-
= Creating a cluster with the default options using {cluster-manager} {hybrid-console-second}
8+
= Creating a cluster with the default options using {cluster-manager}
99

1010
ifeval::["{context}" == "rosa-sts-creating-a-cluster-quickly"]
1111
:quick-install:
@@ -14,7 +14,7 @@ ifeval::["{context}" == "rosa-quickstart"]
1414
:quickstart:
1515
endif::[]
1616

17-
When using the {cluster-manager-first} {hybrid-console-second} to create a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS), you can select the default options to create the cluster quickly. You can also use the admin {cluster-manager} IAM role to enable automatic deployment of the cluster-specific Operator roles and the OpenID Connect (OIDC) provider.
17+
When using {cluster-manager-first} on the {hybrid-console-url} to create a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS), you can select the default options to create the cluster quickly. You can also use the admin {cluster-manager} IAM role to enable automatic deployment of the cluster-specific Operator roles and the OpenID Connect (OIDC) provider.
1818

1919
ifdef::quick-install[]
2020
.Prerequisites
@@ -43,15 +43,15 @@ If your AWS account ID is not listed, check that you have successfully associate
4343

4444
. Click *Next*.
4545

46-
. On the *Cluster details* page, provide a *Cluster name*. Leave the default values in the remaining fields and click *Next*.
46+
. On the *Cluster details* page, enter a *Cluster name*. Leave the default values in the remaining fields and click *Next*.
4747

4848
. To deploy a cluster quickly, leave the default options in the *Cluster settings*, *Networking*, *Cluster roles and policies*, and *Cluster updates* pages and click *Next* on each page.
4949

5050
. On the *Review your ROSA cluster* page, review the summary of your selections and click *Create cluster* to start the installation.
5151

5252
.Verification
5353

54-
* You can monitor the progress of the installation in the *Overview* page for your cluster. You can view the installation logs on the same page. Your cluster is ready when the *Status* in the *Details* section of the page is listed as *Ready*.
54+
* You can check the progress of the installation in the *Overview* page for your cluster. You can view the installation logs on the same page. Your cluster is ready when the *Status* in the *Details* section of the page is listed as *Ready*.
5555
+
5656
[NOTE]
5757
====

modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ endif::rosa-hcp[]
123123
+
124124
[NOTE]
125125
====
126-
For installations using the {cluster-manager} {hybrid-console-second}, the `auto` mode requires an admin-privileged {cluster-manager} role.
126+
For installations that use {cluster-manager} on the {hybrid-console-second}, the `auto` mode requires an admin-privileged {cluster-manager} role.
127127
====
128128
ifdef::rosa-terraform[]
129129
* Default Operator role prefix: `rosa-<6-digit-alphanumeric-string>`

modules/rosa-sts-understanding-aws-account-association.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ endif::[]
2424
[id="rosa-sts-understanding-aws-account-association_{context}"]
2525
= Understanding AWS account association
2626

27-
Before you can use the {cluster-manager-first} {hybrid-console-second} to create
27+
Before you can use {cluster-manager-first} on the {hybrid-console-url} to create
2828
ifdef::rosa-hcp[]
2929
{hcp-title}
3030
endif::rosa-hcp[]
@@ -35,7 +35,7 @@ clusters that use the AWS Security Token Service (STS), you must associate your
3535

3636
{cluster-manager} role:: Create an {cluster-manager} IAM role and link it to your Red Hat organization.
3737
+
38-
You can apply basic or administrative permissions to the {cluster-manager} role. The basic permissions enable cluster maintenance using the {cluster-manager} {hybrid-console-second}. The administrative permissions enable automatic deployment of the cluster-specific Operator roles and the OpenID Connect (OIDC) provider using the {cluster-manager} {hybrid-console-second}.
38+
You can apply basic or administrative permissions to the {cluster-manager} role. The basic permissions enable cluster maintenance using {cluster-manager}. The administrative permissions enable automatic deployment of the cluster-specific Operator roles and the OpenID Connect (OIDC) provider using {cluster-manager}.
3939
ifdef::quick-install[]
4040
+
4141
You can use the administrative permissions with the {cluster-manager} role to deploy a cluster quickly.

rosa_getting_started/rosa-quickstart-guide-ui.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="rosa-quickstart-guide-ui"]
3-
= {product-title} quickstart guide
3+
= {product-title} quick start guide
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: rosa-quickstart-guide-ui
66

77
toc::[]
88

99
[NOTE]
1010
====
11-
If you are looking for a comprehensive getting started guide for ROSA, see xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Comprehensive guide to getting started with {product-title}]. For additional information on ROSA installation, see link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing Red Hat OpenShift Service on AWS (ROSA) interactive walkthrough].
11+
If you are looking for a comprehensive getting started guide for {product-title} (ROSA), see xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Comprehensive guide to getting started with {product-title}]. For additional information on ROSA installation, see link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing Red Hat OpenShift Service on AWS (ROSA) interactive walkthrough].
1212
====
1313

14-
Follow this guide to quickly create a {product-title} (ROSA) cluster using the {cluster-manager-first} {hybrid-console-second}, grant user access, deploy your first application, and learn how to revoke user access and delete your cluster.
14+
Follow this guide to quickly create a {product-title} (ROSA) cluster using {cluster-manager-first} on the {hybrid-console-url}, grant user access, deploy your first application, and learn how to revoke user access and delete your cluster.
1515

1616
The procedures in this document enable you to create a cluster that uses AWS Security Token Service (STS). For more information about using AWS STS with ROSA clusters, see xref:../rosa_architecture/rosa-understanding.adoc#rosa-understanding-aws-sts_rosa-understanding[Using the AWS Security Token Service].
1717

@@ -47,7 +47,8 @@ include::modules/rosa-getting-started-install-configure-cli-tools.adoc[leveloffs
4747
[id="rosa-quickstart-creating-a-cluster"]
4848
== Creating a ROSA cluster with AWS STS using the default auto mode
4949

50-
The procedures in this document use the `auto` modes in the {cluster-manager} {hybrid-console-second} to immediately create the required Identity and Access Management (IAM) resources using the current AWS account. The required resources include the account-wide IAM roles and policies, cluster-specific Operator roles and policies, and OpenID Connect (OIDC) identity provider.
50+
{cluster-manager-first} is a managed service on the {hybrid-console-url} 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.
51+
The procedures in this document use the `auto` modes in {cluster-manager} to immediately create the required Identity and Access Management (IAM) resources using the current AWS account. The required resources include the account-wide IAM roles and policies, cluster-specific Operator roles and policies, and OpenID Connect (OIDC) identity provider.
5152

5253
//This content is pulled from rosa-sts-creating-a-cluster-quickly-ocm.adoc
5354
When using the {cluster-manager} {hybrid-console-second} to create a {product-title} (ROSA) cluster that uses the STS, you can select the default options to create the cluster quickly.

0 commit comments

Comments
 (0)