Skip to content

Commit 4ca5d1f

Browse files
committed
OSDOCS-4379: Add ROSA quickstart guide
1 parent 939ee5a commit 4ca5d1f

28 files changed

+547
-44
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
99
:cluster-manager-first: Red Hat OpenShift Cluster Manager
1010
:cluster-manager: OpenShift Cluster Manager
11-
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
11+
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console]
1212
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
13+
:hybrid-console: Red Hat Hybrid Cloud Console
14+
:hybrid-console-second: Hybrid Cloud Console
1315
:AWS: Amazon Web Services (AWS)
1416
:GCP: Google Cloud Platform (GCP)
1517
:kebab: image:kebab.png[title="Options menu"]

_attributes/common-attributes.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,11 @@ endif::openshift-origin[]
3737
:ai-version: 2.3
3838
:cluster-manager-first: Red Hat OpenShift Cluster Manager
3939
:cluster-manager: OpenShift Cluster Manager
40-
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
40+
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console]
4141
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
4242
:insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor]
4343
:hybrid-console: Red Hat Hybrid Cloud Console
44+
:hybrid-console-second: Hybrid Cloud Console
4445
:rh-storage-first: Red Hat OpenShift Data Foundation
4546
:rh-storage: OpenShift Data Foundation
4647
:rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)

_topic_maps/_topic_map_rosa.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,12 @@ Name: Getting started
7878
Dir: rosa_getting_started
7979
Distros: openshift-rosa
8080
Topics:
81+
- Name: ROSA quickstart guide
82+
File: rosa-quickstart
83+
- Name: Comprehensive guide to getting started with ROSA
84+
File: rosa-getting-started
8185
- Name: Understanding the ROSA with STS deployment workflow
8286
File: rosa-sts-getting-started-workflow
83-
- Name: Getting started with ROSA
84-
File: rosa-getting-started
8587
---
8688
Name: Prepare your environment
8789
Dir: rosa_planning

modules/deploy-app.adoc

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,33 @@
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
44
// * osd_getting_started/osd-getting-started.adoc
5+
// * rosa_getting_started/quickstart.adoc
56

67
:_content-type: PROCEDURE
78
[id="deploy-app_{context}"]
89
= Deploying an application from the Developer Catalog
910

11+
ifeval::["{context}" == "rosa-getting-started"]
12+
:getting-started:
13+
endif::[]
14+
ifeval::["{context}" == "rosa-quickstart"]
15+
:quickstart:
16+
endif::[]
17+
1018
From the {product-title} web console, you can deploy a test application from the Developer Catalog and expose it with a route.
1119

20+
ifndef::quickstart[]
1221
.Prerequisites
1322

1423
* You logged in to {cluster-manager-url}.
1524
* You created an {product-title} cluster.
1625
* You configured an identity provider for your cluster.
1726
* You added your user account to the configured identity provider.
27+
endif::[]
1828
1929
.Procedure
2030

21-
. From {cluster-manager}, click *Open console*.
31+
. From the {cluster-manager} {hybrid-console-second}, click *Open console*.
2232

2333
. In the *Administrator* perspective, select *Home* -> *Projects* -> *Create Project*.
2434

@@ -64,3 +74,10 @@ Welcome to your Node.js application on OpenShift
6474
. Optional: Delete the application and clean up the resources that you created:
6575
.. In the *Administrator* perspective, navigate to *Home* -> *Projects*.
6676
.. Click the action menu for your project and select *Delete Project*.
77+
78+
ifeval::["{context}" == "rosa-getting-started"]
79+
:getting-started:
80+
endif::[]
81+
ifeval::["{context}" == "rosa-quickstart"]
82+
:quickstart:
83+
endif::[]

modules/rosa-getting-started-access-cluster-web-console.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
4+
// * rosa_getting_started/quickstart.adoc
45

56
:_content-type: PROCEDURE
67
[id="rosa-getting-started-access-cluster-web-console_{context}"]
78
= Accessing a cluster through the web console
89

10+
ifeval::["{context}" == "rosa-getting-started"]
11+
:getting-started:
12+
endif::[]
13+
ifeval::["{context}" == "rosa-quickstart"]
14+
:quickstart:
15+
endif::[]
16+
917
After you have created a cluster administrator user or added a user to your configured identity provider, you can log into your {product-title} (ROSA) cluster through the web console.
1018

19+
ifdef::getting-started[]
1120
.Prerequisites
1221

1322
* You have an AWS account.
1423
* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
1524
* You logged in to your Red Hat account by using the `rosa` CLI.
1625
* You created a ROSA cluster.
1726
* You have created a cluster administrator user or added your user account to the configured identity provider.
27+
endif::[]
1828
1929
.Procedure
2030

@@ -36,3 +46,10 @@ Console URL: https://console-openshift-console.apps.example-clust
3646
+
3747
* If you created a `cluster-admin` user, log in by using the provided credentials.
3848
* If you configured an identity provider for your cluster, select the identity provider name in the *Log in with...* dialog and complete any authorization requests that are presented by your provider.
49+
50+
ifeval::["{context}" == "rosa-getting-started"]
51+
:getting-started:
52+
endif::[]
53+
ifeval::["{context}" == "rosa-quickstart"]
54+
:quickstart:
55+
endif::[]

modules/rosa-getting-started-configure-an-idp-and-grant-access.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
4+
// * rosa_getting_started/quickstart.adoc
45

56
[id="rosa-getting-started-configure-an-idp-and-grant-access_{context}"]
67
= Configuring an identity provider and granting cluster access

modules/rosa-getting-started-configure-an-idp.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
4+
// * rosa_getting_started/quickstart.adoc
45

56
:_content-type: PROCEDURE
67
[id="rosa-getting-started-configure-an-idp_{context}"]
78
= Configuring an identity provider
89

10+
ifeval::["{context}" == "rosa-getting-started"]
11+
:getting-started:
12+
endif::[]
13+
ifeval::["{context}" == "rosa-quickstart"]
14+
:quickstart:
15+
endif::[]
16+
917
You can configure different identity provider types for your {product-title} (ROSA) cluster. Supported types include GitHub, GitHub Enterprise, GitLab, Google, LDAP, OpenID Connect and HTPasswd identity providers.
1018

1119
[IMPORTANT]
@@ -15,13 +23,15 @@ The HTPasswd identity provider option is included only to enable the creation of
1523

1624
The following procedure configures a GitHub identity provider as an example.
1725

26+
ifdef::getting-started[]
1827
.Prerequisites
1928

2029
* You have an AWS account.
2130
* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
2231
* You logged in to your Red Hat account by using the `rosa` CLI.
2332
* You created a ROSA cluster.
2433
* You have a GitHub user account.
34+
endif::[]
2535
2636
.Procedure
2737

@@ -97,3 +107,10 @@ $ rosa list idps --cluster=<cluster_name>
97107
NAME TYPE AUTH URL
98108
github-1 GitHub https://oauth-openshift.apps.<cluster_name>.<random_string>.p1.openshiftapps.com/oauth2callback/github-1
99109
----
110+
111+
ifeval::["{context}" == "rosa-getting-started"]
112+
:getting-started:
113+
endif::[]
114+
ifeval::["{context}" == "rosa-quickstart"]
115+
:quickstart:
116+
endif::[]

modules/rosa-getting-started-create-cluster-admin-user.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,34 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
4+
// * rosa_getting_started/quickstart.adoc
45

56
:_content-type: PROCEDURE
67
[id="rosa-getting-started-create-cluster-admin-user_{context}"]
78
= Creating a cluster administrator user for quick cluster access
89

10+
ifeval::["{context}" == "rosa-getting-started"]
11+
:getting-started:
12+
endif::[]
13+
ifeval::["{context}" == "rosa-quickstart"]
14+
:quickstart:
15+
endif::[]
16+
917
Before configuring an identity provider, you can create a user with `cluster-admin` privileges for immediate access to your {product-title} (ROSA) cluster.
1018

1119
[NOTE]
1220
====
1321
The cluster administrator user is useful when you need quick access to a newly deployed cluster. However, consider configuring an identity provider and granting cluster administrator privileges to the identity provider users as required. For more information about setting up an identity provider for your ROSA cluster, see _Configuring an identity provider and granting cluster access_.
1422
====
1523

24+
ifdef::getting-started[]
1625
.Prerequisites
1726

1827
* You have an AWS account.
1928
* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
2029
* You logged in to your Red Hat account by using the `rosa` CLI.
2130
* You created a ROSA cluster.
31+
endif::[]
2232
2333
.Procedure
2434

@@ -48,6 +58,7 @@ I: It may take up to a minute for the account to become active.
4858
It might take approximately one minute for the `cluster-admin` user to become active.
4959
====
5060
61+
ifdef::getting-started[]
5162
. Log in to the cluster through the CLI:
5263
.. Run the command provided in the output of the preceding step to log in:
5364
+
@@ -68,3 +79,22 @@ $ oc whoami
6879
----
6980
cluster-admin
7081
----
82+
endif::[]
83+
84+
85+
ifdef::quickstart[]
86+
87+
. Log in to the cluster through the {cluster-manager} {hybrid-console-second}:
88+
.. Navigate to {cluster-manager-url} and select your cluster.
89+
.. In your cluster, click *Open console*.
90+
.. Under the _Log in with..._ prompt, click *Cluster-Admin*.
91+
.. Enter your credentials.
92+
.. Click *Log in*.
93+
endif::[]
94+
95+
ifeval::["{context}" == "rosa-getting-started"]
96+
:getting-started:
97+
endif::[]
98+
ifeval::["{context}" == "rosa-quickstart"]
99+
:quickstart:
100+
endif::[]

modules/rosa-getting-started-deleting-a-cluster.adoc

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
4+
// * rosa_getting_started/quickstart.adoc
45

56
:_content-type: PROCEDURE
67
[id="rosa-getting-started-deleting-a-cluster_{context}"]
78
= Deleting a ROSA cluster and the AWS STS resources
89

10+
ifeval::["{context}" == "rosa-getting-started"]
11+
:getting-started:
12+
endif::[]
13+
ifeval::["{context}" == "rosa-quickstart"]
14+
:quickstart:
15+
endif::[]
16+
917
You can delete a ROSA cluster that uses the AWS Security Token Service (STS) by using the ROSA CLI (`rosa`). You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console.
1018

1119
[IMPORTANT]
1220
====
1321
Account-wide IAM roles and policies might be used by other ROSA clusters in the same AWS account. You must only remove the resources if they are not required by other clusters.
1422
====
1523

24+
ifdef::getting-started[]
1625
.Prerequisites
1726

1827
* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
1928
* You logged in to your Red Hat account by using the `rosa` CLI.
2029
* You created a ROSA cluster.
30+
endif::[]
2131
2232
.Procedure
2333

@@ -56,20 +66,27 @@ $ rosa delete operator-roles -c <cluster_id> --mode auto <1>
5666

5767
. Delete the account-wide roles:
5868
+
69+
[IMPORTANT]
70+
====
71+
Account-wide IAM roles and policies might be used by other ROSA clusters in the same AWS account. You must only remove the resources if they are not required by other clusters.
72+
====
73+
+
5974
[source,terminal]
6075
----
6176
$ rosa delete account-roles --prefix <prefix> --mode auto <1>
6277
----
6378
<1> You must include the `--<prefix>` argument. Replace `<prefix>` with the prefix of the account-wide roles to delete. If you did not specify a custom prefix when you created the account-wide roles, specify the default prefix, `ManagedOpenShift`.
64-
+
65-
[IMPORTANT]
66-
====
67-
Account-wide IAM roles and policies might be used by other ROSA clusters in the same AWS account. You must only remove the resources if they are not required by other clusters.
68-
====
6979

7080
. Delete the account-wide inline and Operator IAM policies that you created for ROSA deployments that use STS:
7181
.. Log in to the link:https://console.aws.amazon.com/iamv2/home#/home[AWS IAM Console].
7282
.. Navigate to *Access management* -> *Policies* and select the checkbox for one of the account-wide policies.
7383
.. With the policy selected, click on *Actions* -> *Delete* to open the delete policy dialog.
7484
.. Enter the policy name to confirm the deletion and select *Delete* to delete the policy.
7585
.. Repeat this step to delete each of the account-wide inline and Operator policies for the cluster.
86+
87+
ifeval::["{context}" == "rosa-getting-started"]
88+
:getting-started:
89+
endif::[]
90+
ifeval::["{context}" == "rosa-quickstart"]
91+
:quickstart:
92+
endif::[]

modules/rosa-getting-started-enable-rosa.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
4+
// * rosa_getting_started/rosa-getting-started.adoc
45

56
:_content-type: PROCEDURE
67
[id="rosa-getting-started-enable-rosa_{context}"]
@@ -21,4 +22,4 @@ Consider using a dedicated AWS account to run production clusters. If you are us
2122

2223
. Sign in to the https://console.aws.amazon.com/rosa/home[AWS Management Console].
2324

24-
. Enable ROSA in your AWS account by navigating to the link:https://console.aws.amazon.com/rosa/home[ROSA service] and selecting *Enable OpenShift*.
25+
. Activate ROSA in your AWS account by navigating to the link:https://console.aws.amazon.com/rosa/home[ROSA service] and selecting *Enable OpenShift*.

0 commit comments

Comments
 (0)