OSDOCS-4379: Add ROSA quickstart guide

adellape · Oct 27, 2022 · 4ca5d1f · 4ca5d1f
1 parent 939ee5a
commit 4ca5d1f
Show file tree

Hide file tree

Showing 28 changed files with 547 additions and 44 deletions.
diff --git a/_attributes/attributes-openshift-dedicated.adoc b/_attributes/attributes-openshift-dedicated.adoc
@@ -8,8 +8,10 @@
 :op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
 :cluster-manager-first: Red Hat OpenShift Cluster Manager
 :cluster-manager: OpenShift Cluster Manager
-:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
+:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console]
 :cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
+:hybrid-console: Red Hat Hybrid Cloud Console
+:hybrid-console-second: Hybrid Cloud Console
 :AWS: Amazon Web Services (AWS)
 :GCP: Google Cloud Platform (GCP)
 :kebab: image:kebab.png[title="Options menu"]

diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc
@@ -37,10 +37,11 @@ endif::openshift-origin[]
 :ai-version: 2.3
 :cluster-manager-first: Red Hat OpenShift Cluster Manager
 :cluster-manager: OpenShift Cluster Manager
-:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
+:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console]
 :cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
 :insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor]
 :hybrid-console: Red Hat Hybrid Cloud Console
+:hybrid-console-second: Hybrid Cloud Console
 :rh-storage-first: Red Hat OpenShift Data Foundation
 :rh-storage: OpenShift Data Foundation
 :rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)

diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -78,10 +78,12 @@ Name: Getting started
 Dir: rosa_getting_started
 Distros: openshift-rosa
 Topics:
+- Name: ROSA quickstart guide
+  File: rosa-quickstart
+- Name: Comprehensive guide to getting started with ROSA
+  File: rosa-getting-started
 - Name: Understanding the ROSA with STS deployment workflow
   File: rosa-sts-getting-started-workflow
-- Name: Getting started with ROSA
-  File: rosa-getting-started
 ---
 Name: Prepare your environment
 Dir: rosa_planning

diff --git a/modules/deploy-app.adoc b/modules/deploy-app.adoc
@@ -2,23 +2,33 @@
 //
 // * rosa_getting_started/rosa-getting-started.adoc
 // * osd_getting_started/osd-getting-started.adoc
+// * rosa_getting_started/quickstart.adoc
 
 :_content-type: PROCEDURE
 [id="deploy-app_{context}"]
 = Deploying an application from the Developer Catalog
 
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
+
 From the {product-title} web console, you can deploy a test application from the Developer Catalog and expose it with a route.
 
+ifndef::quickstart[]
 .Prerequisites
 
 * You logged in to {cluster-manager-url}.
 * You created an {product-title} cluster.
 * You configured an identity provider for your cluster.
 * You added your user account to the configured identity provider.
+endif::[]
 
 .Procedure
 
-. From {cluster-manager}, click *Open console*.
+. From the {cluster-manager} {hybrid-console-second}, click *Open console*.
 
 . In the *Administrator* perspective, select *Home* -> *Projects* -> *Create Project*.
 
@@ -64,3 +74,10 @@ Welcome to your Node.js application on OpenShift
 . Optional: Delete the application and clean up the resources that you created:
 .. In the *Administrator* perspective, navigate to *Home* -> *Projects*.
 .. Click the action menu for your project and select *Delete Project*.
+
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
diff --git a/modules/rosa-getting-started-access-cluster-web-console.adoc b/modules/rosa-getting-started-access-cluster-web-console.adoc
@@ -1,20 +1,30 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/quickstart.adoc
 
 :_content-type: PROCEDURE
 [id="rosa-getting-started-access-cluster-web-console_{context}"]
 = Accessing a cluster through the web console
 
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
+
 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.
 
+ifdef::getting-started[]
 .Prerequisites
 
 * You have an AWS account.
 * You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
 * You logged in to your Red Hat account by using the `rosa` CLI.
 * You created a ROSA cluster.
 * You have created a cluster administrator user or added your user account to the configured identity provider.
+endif::[]
 
 .Procedure
 
@@ -36,3 +46,10 @@ Console URL:                https://console-openshift-console.apps.example-clust
 +
 * If you created a `cluster-admin` user, log in by using the provided credentials.
 * 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.
+
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
diff --git a/modules/rosa-getting-started-configure-an-idp-and-grant-access.adoc b/modules/rosa-getting-started-configure-an-idp-and-grant-access.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/quickstart.adoc
 
 [id="rosa-getting-started-configure-an-idp-and-grant-access_{context}"]
 = Configuring an identity provider and granting cluster access

diff --git a/modules/rosa-getting-started-configure-an-idp.adoc b/modules/rosa-getting-started-configure-an-idp.adoc
@@ -1,11 +1,19 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/quickstart.adoc
 
 :_content-type: PROCEDURE
 [id="rosa-getting-started-configure-an-idp_{context}"]
 = Configuring an identity provider
 
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
+
 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.
 
 [IMPORTANT]
@@ -15,13 +23,15 @@ The HTPasswd identity provider option is included only to enable the creation of
 
 The following procedure configures a GitHub identity provider as an example.
 
+ifdef::getting-started[]
 .Prerequisites
 
 * You have an AWS account.
 * You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
 * You logged in to your Red Hat account by using the `rosa` CLI.
 * You created a ROSA cluster.
 * You have a GitHub user account.
+endif::[]
 
 .Procedure
 
@@ -97,3 +107,10 @@ $ rosa list idps --cluster=<cluster_name>
 NAME        TYPE      AUTH URL
 github-1    GitHub    https://oauth-openshift.apps.<cluster_name>.<random_string>.p1.openshiftapps.com/oauth2callback/github-1
 ----
+
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
diff --git a/modules/rosa-getting-started-create-cluster-admin-user.adoc b/modules/rosa-getting-started-create-cluster-admin-user.adoc
@@ -1,24 +1,34 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/quickstart.adoc
 
 :_content-type: PROCEDURE
 [id="rosa-getting-started-create-cluster-admin-user_{context}"]
 = Creating a cluster administrator user for quick cluster access
 
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
+
 Before configuring an identity provider, you can create a user with `cluster-admin` privileges for immediate access to your {product-title} (ROSA) cluster.
 
 [NOTE]
 ====
 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_.
 ====
 
+ifdef::getting-started[]
 .Prerequisites
 
 * You have an AWS account.
 * You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
 * You logged in to your Red Hat account by using the `rosa` CLI.
 * You created a ROSA cluster.
+endif::[]
 
 .Procedure
 
@@ -48,6 +58,7 @@ I: It may take up to a minute for the account to become active.
 It might take approximately one minute for the `cluster-admin` user to become active.
 ====
 
+ifdef::getting-started[]
 . Log in to the cluster through the CLI:
 .. Run the command provided in the output of the preceding step to log in:
 +
@@ -68,3 +79,22 @@ $ oc whoami
 ----
 cluster-admin
 ----
+endif::[]
+
+
+ifdef::quickstart[]
+
+. Log in to the cluster through the {cluster-manager} {hybrid-console-second}:
+.. Navigate to {cluster-manager-url} and select your cluster.
+.. In your cluster, click *Open console*.
+.. Under the _Log in with..._ prompt, click *Cluster-Admin*.
+.. Enter your credentials.
+.. Click *Log in*.
+endif::[]
+
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
diff --git a/modules/rosa-getting-started-deleting-a-cluster.adoc b/modules/rosa-getting-started-deleting-a-cluster.adoc
@@ -1,23 +1,33 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/quickstart.adoc
 
 :_content-type: PROCEDURE
 [id="rosa-getting-started-deleting-a-cluster_{context}"]
 = Deleting a ROSA cluster and the AWS STS resources
 
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
+
 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.
 
 [IMPORTANT]
 ====
 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.
 ====
 
+ifdef::getting-started[]
 .Prerequisites
 
 * You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
 * You logged in to your Red Hat account by using the `rosa` CLI.
 * You created a ROSA cluster.
+endif::[]
 
 .Procedure
 
@@ -56,20 +66,27 @@ $ rosa delete operator-roles -c <cluster_id> --mode auto <1>
 
 . Delete the account-wide roles:
 +
+[IMPORTANT]
+====
+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.
+====
++
 [source,terminal]
 ----
 $ rosa delete account-roles --prefix <prefix> --mode auto <1>
 ----
 <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`.
-+
-[IMPORTANT]
-====
-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.
-====
 
 . Delete the account-wide inline and Operator IAM policies that you created for ROSA deployments that use STS:
 .. Log in to the link:https://console.aws.amazon.com/iamv2/home#/home[AWS IAM Console].
 .. Navigate to *Access management* -> *Policies* and select the checkbox for one of the account-wide policies.
 .. With the policy selected, click on *Actions* -> *Delete* to open the delete policy dialog.
 .. Enter the policy name to confirm the deletion and select *Delete* to delete the policy.
 .. Repeat this step to delete each of the account-wide inline and Operator policies for the cluster.
+
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
diff --git a/modules/rosa-getting-started-enable-rosa.adoc b/modules/rosa-getting-started-enable-rosa.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/rosa-getting-started.adoc
 
 :_content-type: PROCEDURE
 [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
 
 . Sign in to the https://console.aws.amazon.com/rosa/home[AWS Management Console].
 
-. Enable ROSA in your AWS account by navigating to the link:https://console.aws.amazon.com/rosa/home[ROSA service] and selecting *Enable OpenShift*.
+. Activate ROSA in your AWS account by navigating to the link:https://console.aws.amazon.com/rosa/home[ROSA service] and selecting *Enable OpenShift*.
diff --git a/modules/rosa-getting-started-environment-setup.adoc b/modules/rosa-getting-started-environment-setup.adoc
@@ -1,16 +1,17 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/rosa-quickstart.adoc
 
 [id="rosa-getting-started-environment-setup_{context}"]
 = Setting up the environment
 
 Before you create a {product-title} (ROSA) cluster, you must set up your environment by completing the following tasks:
 
-* Enable ROSA in your AWS account
-* Install and configure the required CLI tools
-* Verify the configuration of the CLI tools
-* Verify that the AWS Elastic Load Balancing (ELB) service role exists
-* Verify that the required AWS resource quotas are available
+* Enable ROSA in your AWS account.
+* Install and configure the required command line interface (CLI) tools.
+* Verify the configuration of the CLI tools.
+* Verify that the AWS Elastic Load Balancing (ELB) service role exists.
+* Verify that the required AWS resource quotas are available.
 
 You can follow the procedures in this section to complete these setup requirements.
diff --git a/modules/rosa-getting-started-grant-admin-privileges.adoc b/modules/rosa-getting-started-grant-admin-privileges.adoc
@@ -1,20 +1,30 @@
 // Module included in the following assemblies:
 //
 // * rosa_getting_started/rosa-getting-started.adoc
+// * rosa_getting_started/quickstart.adoc
 
 :_content-type: PROCEDURE
 [id="rosa-getting-started-grant-admin-privileges_{context}"]
 = Granting administrator privileges to a user
 
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]
+
 After you have added a user to your configured identity provider, you can grant the user `cluster-admin` or `dedicated-admin` privileges for your {product-title} (ROSA) cluster.
 
+ifdef::getting-started[]
 .Prerequisites
 
 * You have an AWS account.
 * You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
 * You logged in to your Red Hat account by using the `rosa` CLI.
 * You created a ROSA cluster.
 * You have configured a GitHub identity provider for your cluster and added identity provider users.
+endif::[]
 
 .Procedure
 
@@ -72,3 +82,10 @@ $ rosa list users --cluster=<cluster_name>
 ID                 GROUPS
 <idp_user_name>    dedicated-admins
 ----
+
+ifeval::["{context}" == "rosa-getting-started"]
+:getting-started:
+endif::[]
+ifeval::["{context}" == "rosa-quickstart"]
+:quickstart:
+endif::[]