Skip to content

Commit 89545c8

Browse files
committed
OSDOCS-3613: Add STS snippet
1 parent 6c89acd commit 89545c8

15 files changed

+42
-1
lines changed

rosa_architecture/rosa-understanding.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ You receive OpenShift updates with new feature releases and a shared, common sou
1919
[id="rosa-understanding-credential-modes_{context}"]
2020
== Credential modes
2121

22-
There are two supported credential modes for ROSA clusters. One uses the AWS Secure Token Service (STS), which is recommended, and the other uses Identity Access Management (IAM) roles.
22+
include::snippets/rosa-sts.adoc[]
23+
24+
There are two supported credential modes for ROSA clusters. One uses the AWS Security Token Service (STS), which is recommended, and the other uses Identity Access Management (IAM) roles.
2325

2426
[id="rosa-understanding-aws-sts_{context}"]
2527
=== ROSA with STS
@@ -30,6 +32,12 @@ You can use the `rosa` CLI to create the IAM role, policy, and identity provider
3032

3133
AWS STS aligns with principles of least privilege and secure practices in cloud service resource management. The `rosa` CLI manages the STS credentials that are assigned for unique tasks and takes action upon AWS resources as part of OpenShift functionality. One limitation of using STS is that roles must be created for each ROSA cluster.
3234

35+
The STS credential mode is more secure because:
36+
37+
- It supports an explicit and limited set of roles and policies that you create ahead of time, and tracks every permission asked for and every role used.
38+
- The service is limited to the set permissions.
39+
- When the service is run, it obtains credentials that expire in one hour, so there is no need to rotate or revoke credentials. The expiration also reduces the risks of credentials leaking and being reused.
40+
3341
A listing of the account-wide and per-cluster roles is provided in xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources for ROSA clusters that use STS].
3442

3543
[id="rosa-understanding-aws-without-sts_{context}"]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-accessing-cluster.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ As a best practice, access your {product-title} (ROSA) cluster using an identity
1010

1111
This document describes how to access a cluster and set up an IDP using the `rosa` CLI. Alternatively, you can set up an IDP account using {cluster-manager} console.
1212

13+
include::snippets/rosa-sts.adoc[]
14+
1315
include::modules/rosa-accessing-your-cluster-quick.adoc[leveloffset=+1]
1416

1517
include::modules/rosa-accessing-your-cluster.adoc[leveloffset=+1]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ toc::[]
1111

1212
You must ensure that the prerequisites are met before installing ROSA. This requirements document does not apply to AWS Security Token Service (STS). If you are using STS, see the xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-prereqs_rosa-sts-aws-prereqs[STS-specific requirements].
1313

14+
include::snippets/rosa-sts.adoc[]
15+
1416
include::modules/rosa-aws-understand.adoc[leveloffset=+1]
1517
include::modules/rosa-aws-requirements.adoc[leveloffset=+1]
1618
include::modules/rosa-aws-procedure.adoc[leveloffset=+1]

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
After you complete the AWS prerequisites, configure your AWS account and enable the {product-title} (ROSA) service.
1010

11+
include::snippets/rosa-sts.adoc[]
12+
1113
include::modules/rosa-configuring-aws-account.adoc[leveloffset=+1]
1214

1315
[id="next-steps_rosa-config-aws-account"]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-config-identity-providers.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ After your {product-title} (ROSA) cluster is created, you must configure identit
1010

1111
The following topics describe how to configure an identity provider using {cluster-manager} console. Alternatively, you can use the `rosa` CLI to create an identity provider and access the cluster.
1212

13+
include::snippets/rosa-sts.adoc[]
14+
1315
include::modules/understanding-idp.adoc[leveloffset=+1]
1416
include::modules/config-github-idp.adoc[leveloffset=+1]
1517
include::modules/config-gitlab-idp.adoc[leveloffset=+1]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-creating-cluster.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ After you set up your environment and install {product-title} (ROSA), create a c
1010

1111
This document describes how to set up a ROSA cluster. Alternatively, you can create a ROSA cluster with AWS PrivateLink.
1212

13+
include::snippets/rosa-sts.adoc[]
14+
1315
include::modules/rosa-creating-cluster.adoc[leveloffset=+1]
1416

1517
== Next steps

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-deleting-access-cluster.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
Delete access to a {product-title} (ROSA) cluster using the `rosa` command-line.
1010

11+
include::snippets/rosa-sts.adoc[]
12+
1113
include::modules/rosa-delete-dedicated-admins.adoc[leveloffset=+1]
1214

1315
include::modules/rosa-delete-cluster-admins.adoc[leveloffset=+1]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-deleting-cluster.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
Delete a {product-title} (ROSA) cluster using the `rosa` command-line.
1010

11+
include::snippets/rosa-sts.adoc[]
12+
1113
[id="prerequisites_rosa-deleting-cluster"]
1214
== Prerequisites
1315

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Before you create a {product-title} (ROSA) cluster that uses the AWS Security To
1010

1111
This document provides an overview of the ROSA with STS deployment workflow stages and refers to detailed resources for each stage.
1212

13+
include::snippets/rosa-sts.adoc[]
14+
1315
[id="rosa-overview-of-the-deployment-workflow"]
1416
== Overview of the ROSA deployment workflow
1517

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ toc::[]
88

99
After you configure your AWS account, install {product-title} (ROSA).
1010

11+
12+
include::snippets/rosa-sts.adoc[]
13+
1114
include::modules/rosa-installing.adoc[leveloffset=+1]
1215

1316
[id="next-steps_rosa-installing-rosa"]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-quickstart.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
66

77
toc::[]
88

9+
include::snippets/rosa-sts.adoc[]
10+
911
include::modules/rosa-quickstart-instructions.adoc[leveloffset=+1]
1012

1113
[role="_additional-resources"]

rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-required-aws-service-quotas.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
Review this list of the required Amazon Web Service (AWS) service quotas that are required to run an {product-title} cluster.
1010

11+
include::snippets/rosa-sts.adoc[]
12+
1113
include::modules/rosa-required-aws-service-quotas.adoc[leveloffset=+1]
1214

1315
== Next steps

rosa_planning/rosa-sts-aws-prereqs.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ toc::[]
99

1010
{product-title} (ROSA) provides a model that allows Red Hat to deploy clusters into a customer’s existing Amazon Web Service (AWS) account.
1111

12+
include::snippets/rosa-sts.adoc[]
13+
1214
Ensure that the following AWS prerequisites are met before installing ROSA with STS.
1315

1416
include::modules/rosa-aws-understand.adoc[leveloffset=+1]

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
After you meet the AWS prerequisites, set up your environment and install {product-title} (ROSA).
1010

11+
include::snippets/rosa-sts.adoc[]
12+
1113
include::modules/rosa-sts-setting-up-environment.adoc[leveloffset=+1]
1214

1315
[id="next-steps_rosa-sts-setting-up-environment"]

snippets/rosa-sts.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
//The STS credential method has been identified as the path forward for installing and interacting with ROSA clusters. This snippet is intended to guide users in using the STS credential mode.
2+
3+
[TIP]
4+
====
5+
AWS Security Token Service (STS) is the recommended credential mode for installing and interacting with clusters on Red Hat OpenShift Service on AWS (ROSA) because it provides enhanced security.
6+
====

0 commit comments

Comments
 (0)