Skip to content

Commit 13c8811

Browse files
authored
Merge pull request #46339 from pneedle-rh/osdocs-3022-removing-permission-verifications-for-sts
OSDOCS-3022 - Removing permission verification reference in STS
2 parents 1f05e5d + 658d7ce commit 13c8811

File tree

7 files changed

+30
-22
lines changed

7 files changed

+30
-22
lines changed

modules/rosa-configure.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
[id="rosa-configure_{context}"]
77
= Configuring the rosa CLI
88

9-
109
Use the following commands to configure the `rosa` CLI.
1110

1211
[id="rosa-login_{context}"]
@@ -101,14 +100,19 @@ $ rosa logout [arguments]
101100
[id="rosa-verify-permissions_{context}"]
102101
== verify permissions
103102

104-
Verify that the AWS permissions required to create a `rosa` cluster are configured correctly.
103+
Verify that the AWS permissions required to create a ROSA cluster are configured correctly:
105104

106105
.Syntax
107106
[source,terminal]
108107
----
109108
$ rosa verify permissions [arguments]
110109
----
111110

111+
[NOTE]
112+
====
113+
This command verifies permissions only for clusters that do not use the AWS Security Token Service (STS).
114+
====
115+
112116
.Optional arguments inherited from parent commands
113117
[cols="30,70"]
114118
|===

modules/rosa-installing.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55

66

77
:_content-type: PROCEDURE
8-
[id="rosa-installing_{context}"]
9-
= Installing ROSA
8+
[id="rosa-installing-and-configuring-the-rosa-cli_{context}"]
9+
= Installing and configuring the ROSA CLI
1010

11-
Complete the following steps to install ROSA before creating a cluster.
11+
Install and configure the ROSA CLI (`rosa`). You can also install the OpenShift CLI (`oc`) and verify if the required AWS resource quotas are available by using the ROSA CLI.
1212

1313
.Prerequisites
1414

@@ -92,6 +92,11 @@ $ rosa verify permissions
9292
I: Validating SCP policies...
9393
I: AWS SCP policies ok
9494
----
95+
+
96+
[NOTE]
97+
====
98+
This command verifies permissions only for ROSA clusters that do not use the AWS Security Token Service (STS).
99+
====
95100

96101
. Log in to your Red Hat account with `rosa`.
97102
+

modules/rosa-sts-setting-up-environment.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
= Setting up the environment for STS
55

6-
Complete the following steps to set up your environment before creating your cluster using AWS security token Service (STS).
6+
Before you create a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS), complete the following steps to set up your environment.
77

88
.Prerequisites
99

@@ -18,7 +18,7 @@ It is recommended to use a dedicated AWS account to run production clusters. If
1818
+
1919
If you are using AWS Organizations and you need to have a service control policy (SCP) applied to the AWS account you plan to use, these policies must not be more restrictive than the roles and policies required by the cluster.
2020
+
21-
. Enable the ROSA service in the AWS Console.
21+
. Enable the ROSA service in the AWS Management Console.
2222
.. Sign in to your link:https://console.aws.amazon.com/rosa/home[AWS account].
2323
.. To enable ROSA, go to the link:https://console.aws.amazon.com/rosa/[ROSA service] and select *Enable OpenShift*.
2424

@@ -49,7 +49,7 @@ The ROSA service evaluates regions in the following priority order:
4949
$ aws sts get-caller-identity
5050
----
5151
+
52-
. Install the latest version of `rosa`, the {product-title} command-line interface (CLI).
52+
. Install the latest version of the ROSA CLI (`rosa`).
5353
.. Download the link:https://access.redhat.com/products/red-hat-openshift-service-aws/[latest release] of the `rosa` CLI for your operating system.
5454
.. Optional: Rename the file you downloaded to `rosa` and make the file executable. This documentation uses `rosa` to refer to the executable file.
5555
+
@@ -138,7 +138,7 @@ To login to your Red Hat account, get an offline access token at https://console
138138
I: Logged in as '<rh-rosa-user>' on 'https://api.openshift.com'
139139
----
140140

141-
. Verify that your AWS account has the necessary quota to deploy an {product-title} cluster.
141+
. Verify that your AWS account has the necessary quota to deploy a ROSA cluster.
142142
+
143143
[source,terminal]
144144
----
@@ -157,9 +157,9 @@ I: AWS quota ok
157157
Sometimes your AWS quota varies by region. If you receive any errors, try a different region.
158158
====
159159
+
160-
If you need to increase your quota, go to your link:https://aws.amazon.com/console/[AWS console], and request a quota increase for the service that failed.
160+
If you need to increase your quota, go to the link:https://aws.amazon.com/console/[AWS Management Console] and request a quota increase for the service that failed.
161161
+
162-
After both the permissions and quota checks pass, proceed to the next step.
162+
After the quota check succeeds, proceed to the next step.
163163
+
164164
. Prepare your AWS account for cluster deployment:
165165
+

modules/rosa-troubleshooting-installing.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ $ rosa logs uninstall --cluster=<cluster_name>
3636
$ rosa logs uninstall --cluster=<cluster_name> --watch
3737
----
3838

39-
[id="rosa-faq-verify-SCP_{context}"]
40-
== Verify your Amazon Web Services (AWS) account permissions
39+
[id="rosa-faq-verify-permissions-for-clusters-without-sts_{context}"]
40+
== Verify your AWS account permissions for clusters without STS
4141

42-
Run the following command to verify your AWS account has the correct permissions:
42+
Run the following command to verify if your AWS account has the correct permissions. This command verifies permissions only for clusters that do not use the AWS Security Token Service (STS):
4343

4444
[source,terminal]
4545
----

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-config-aws-account.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ include::modules/rosa-configuring-aws-account.adoc[leveloffset=+1]
1515
[id="next-steps_rosa-config-aws-account"]
1616
== Next steps
1717

18-
* xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc#rosa-installing-rosa[Install ROSA]
18+
* xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc#rosa-installing-cli[Installing the ROSA CLI]
1919

2020
[id="additional-resources_rosa-config-aws-account"]
2121
[role="_additional-resources"]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-getting-started-workflow.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can follow the workflow stages outlined in this section to set up and access
2020
. xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#prerequisites[Perform the AWS prerequisites]. To deploy a ROSA cluster, your AWS account must meet the prerequisite requirements.
2121
. xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-required-aws-service-quotas.adoc#rosa-required-aws-service-quotas[Review the required AWS service quotas]. To prepare for your cluster deployment, review the AWS service quotas that are required to run a ROSA cluster.
2222
. xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-config-aws-account.adoc#rosa-config-aws-account[Configure your AWS account]. Before you create a ROSA cluster, you must enable ROSA in your AWS account, install and configure the AWS CLI (`aws`) tool, and verify the AWS CLI tool configuration.
23-
. xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc#rosa-installing-rosa[Install the ROSA and OpenShift CLI tools and verify the AWS servce quotas]. Install and configure the ROSA CLI (`aws`) and the OpenShift CLI (`oc`). You can verify if the required AWS resource quotas are available by using the ROSA CLI.
23+
. xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc#rosa-installing-cli[Install the ROSA and OpenShift CLI tools and verify the AWS servce quotas]. Install and configure the ROSA CLI (`rosa`) and the OpenShift CLI (`oc`). You can verify if the required AWS resource quotas are available by using the ROSA CLI.
2424
. xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-creating-cluster.adoc#rosa-creating-cluster[Create a ROSA cluster] or xref:../../rosa_install_access_delete_clusters/rosa-aws-privatelink-creating-cluster.adoc#rosa-aws-privatelink-creating-cluster[Create a ROSA cluster using AWS PrivateLink]. Use the ROSA CLI (`rosa`) to create a cluster. You can optionally create a ROSA cluster with AWS PrivateLink.
2525
. xref:../../rosa_install_access_delete_clusters/rosa-sts-accessing-cluster.adoc#rosa-sts-accessing-cluster[Access a cluster]. You can configure an identity provider and grant cluster administrator privileges to the identity provider users as required. You can also access a newly deployed cluster quickly by configuring a `cluster-admin` user.
2626
. xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-deleting-access-cluster.adoc#rosa-deleting-access-cluster[Revoke access to a ROSA cluster for a user]. You can revoke access to a ROSA cluster from a user by using the ROSA CLI or the web console.

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
:_content-type: ASSEMBLY
2-
[id="rosa-installing-rosa"]
2+
[id="rosa-installing-cli"]
33
= Installing the ROSA CLI
44
include::_attributes/attributes-openshift-dedicated.adoc[]
5-
:context: rosa-installing-rosa
5+
:context: rosa-installing-cli
66

77
toc::[]
88

9-
After you configure your AWS account, install {product-title} (ROSA).
10-
9+
After you configure your AWS account, install and configure the ROSA CLI (`rosa`).
1110

1211
include::snippets/rosa-sts.adoc[]
1312

1413
include::modules/rosa-installing.adoc[leveloffset=+1]
1514

16-
[id="next-steps_rosa-installing-rosa"]
15+
[id="next-steps_rosa-installing-cli"]
1716
== Next steps
1817

1918
* xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-creating-cluster.adoc#rosa-creating-cluster[Create a ROSA cluster] or xref:../../rosa_install_access_delete_clusters/rosa-aws-privatelink-creating-cluster.adoc#rosa-aws-privatelink-creating-cluster[Create an AWS PrivateLink cluster on ROSA].
2019

21-
[id="additional-resources_rosa-installing-rosa"]
20+
[id="additional-resources_rosa-installing-cli"]
2221
[role="_additional-resources"]
2322
== Additional resources
2423

0 commit comments

Comments
 (0)