Skip to content

Commit 8a31c10

Browse files
committed
Updated OCM-role requirements throughout the ROSA docs
1 parent 8b91c0e commit 8a31c10

14 files changed

Lines changed: 29 additions & 9 deletions

modules/rosa-sts-about-ocm-role.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Some considerations for your `ocm-role` IAM resource are:
1212

1313
* Only one `ocm-role` IAM role can be linked per Red{nbsp}Hat organization; however, you can have any number of `ocm-role` IAM roles per AWS account. The web UI requires that only one of these roles can be linked at a time.
1414
* Any user in a Red{nbsp}Hat organization may create and link an `ocm-role` IAM resource.
15+
* You must create an `ocm-role` before you can create a {product-title} cluster.
1516
* Only the Red{nbsp}Hat Organization Administrator can unlink an `ocm-role` IAM resource. This limitation is to protect other Red{nbsp}Hat organization members from disturbing the interface capabilities of other users.
1617
+
1718
[NOTE]
@@ -21,7 +22,7 @@ If you just created a Red{nbsp}Hat account that is not part of an existing organ
2122
+
2223
* See "Understanding the {cluster-manager} role" in the Additional resources of this section for a list of the AWS permissions policies for the basic and admin `ocm-role` IAM resources.
2324
24-
Using the ROSA CLI (`rosa`), you can link your IAM resource when you create it.
25+
Using the {rosa-cli-first}, you can link your IAM resource when you create it.
2526

2627
[NOTE]
2728
====

modules/rosa-sts-ocm-role-creation.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
[role="_abstract"]
1111
You create your `ocm-role` IAM roles by using the {rosa-cli-first}.
1212

13+
[IMPORTANT]
14+
====
15+
You must create the `ocm-role` IAM role before you can create your {product-title} cluster.
16+
====
17+
1318
.Prerequisites
1419

1520
* You have an AWS account.

modules/rosa-sts-understanding-ocm-role.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="rosa-sts-understanding-ocm-role_{context}"]
77
= Understanding the {cluster-manager} role
88

9-
Creating ROSA clusters in {cluster-manager-url} require an `ocm-role` IAM role. The basic `ocm-role` IAM role permissions let you to perform cluster maintenance within {cluster-manager}. To automatically create the operator roles and OpenID Connect (OIDC) provider, you must add the `--admin` option to the `rosa create` command. This command creates an `ocm-role` resource with additional permissions needed for administrative tasks.
9+
Creating {product-title} clusters in {cluster-manager-url} require an `ocm-role` IAM role. The basic `ocm-role` IAM role permissions let you to perform cluster maintenance within {cluster-manager}. To automatically create the operator roles and OpenID Connect (OIDC) provider, you must add the `--admin` option to the `rosa create` command. This command creates an `ocm-role` resource with additional permissions needed for administrative tasks.
1010

1111
[NOTE]
1212
====

rosa_architecture/rosa-sts-about-iam-resources.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ toc::[]
1818

1919
[role="_abstract"]
2020
ifndef::openshift-rosa-hcp[]
21-
To deploy a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS),
21+
To deploy a {product-title} cluster that uses the AWS Security Token Service (STS),
2222
endif::openshift-rosa-hcp[]
2323
ifdef::openshift-rosa-hcp[]
2424
{hcp-title-first} uses the AWS Security Token Service (STS) to provide temporary, limited-permission credentials for your cluster. This means that before you deploy your cluster,
@@ -38,7 +38,7 @@ and compute functionality. This includes account-wide Operator policies.
3838
3939
This document provides reference information about the IAM resources that you must deploy
4040
ifdef::openshift-rosa[]
41-
when you create a ROSA cluster that uses STS.
41+
when you create a {product-title} cluster that uses STS.
4242
endif::openshift-rosa[]
4343
ifdef::openshift-rosa-hcp[]
4444
when you create a {hcp-title} cluster.
@@ -58,12 +58,12 @@ endif::openshift-rosa-hcp[]
5858
[id="rosa-sts-ocm-roles-and-permissions_{context}"]
5959
== {cluster-manager} roles and permissions
6060

61-
If you create ROSA clusters by using {cluster-manager-url}, you must have the following AWS IAM roles linked to your AWS account to create and manage the clusters. For more information, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account].
61+
If you create {product-title} clusters by using {cluster-manager-url}, you must have the following AWS IAM roles linked to your AWS account to create and manage the clusters. For more information, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account].
6262

6363
These AWS IAM roles are as follows:
6464

65-
* The ROSA user role (`user-role`) is an AWS role used by Red{nbsp}Hat to verify the customer's AWS identity. This role has no additional permissions, and the role has a trust relationship with the Red{nbsp}Hat installer account.
66-
* An `ocm-role` resource grants the required permissions for installation of ROSA clusters in {cluster-manager}. You can apply basic or administrative permissions to the `ocm-role` resource. If you create an administrative `ocm-role` resource, {cluster-manager} can create the needed AWS Operator roles and OpenID Connect (OIDC) provider. This IAM role also creates a trust relationship with the Red{nbsp}Hat installer account as well.
65+
* The {product-title} user role (`user-role`) is an AWS role used by Red{nbsp}Hat to verify the customer's AWS identity. This role has no additional permissions, and the role has a trust relationship with the Red{nbsp}Hat installer account.
66+
* An `ocm-role` resource grants the required permissions for installation of {product-title} clusters in {cluster-manager}. You can apply basic or administrative permissions to the `ocm-role` resource. If you create an administrative `ocm-role` resource, {cluster-manager} can create the needed AWS Operator roles and OpenID Connect (OIDC) provider. This IAM role also creates a trust relationship with the Red{nbsp}Hat installer account as well.
6767
+
6868
[NOTE]
6969
====
@@ -136,7 +136,7 @@ endif::openshift-rosa[]
136136
[id="rosa-sts-oidc-provider-requirements-for-operators_{context}"]
137137
== Open ID Connect (OIDC) requirements for Operator authentication
138138

139-
For ROSA installations that use STS, you must create a cluster-specific OIDC provider that is used by the cluster Operators to authenticate or create your own OIDC configuration for your own OIDC provider.
139+
For {product-title} installations that use STS, you must create a cluster-specific OIDC provider that is used by the cluster Operators to authenticate or create your own OIDC configuration for your own OIDC provider.
140140

141141
include::modules/rosa-sts-oidc-provider-command.adoc[leveloffset=+2]
142142

rosa_hcp/rosa-hcp-aws-private-creating-cluster.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ toc::[]
99
[role="_abstract"]
1010
For {product-title} workloads that do not require public internet access, you can create a private cluster.
1111

12+
include::modules/rosa-sts-ocm-role-creation.adoc[leveloffset=+1]
1213
include::modules/rosa-hcp-aws-private-create-cluster.adoc[leveloffset=+1]
1314
include::modules/rosa-hcp-aws-private-security-groups.adoc[leveloffset=+1]
1415
include::modules/rosa-additional-principals-overview.adoc[leveloffset=+1]

rosa_hcp/rosa-hcp-cluster-no-cni.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ If you choose to use your own CNI for {product-title} clusters, it is strongly r
2929

3030
* Ensure that you have a configured xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-creating-vpc_rosa-hcp-sts-creating-a-cluster-quickly[virtual private cloud] (VPC).
3131

32+
include::modules/rosa-sts-ocm-role-creation.adoc[leveloffset=+1]
33+
3234
include::modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+1]
3335

3436
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+1]

rosa_hcp/rosa-hcp-creating-cluster-with-aws-kms-key.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ include::modules/rosa-hcp-vpc-subnet-tagging.adoc[leveloffset=+3]
5858
* link:https://developer.hashicorp.com/terraform[HashiCorp Terraform documentation]
5959
* link:https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/deploy/subnet_discovery/[Subnet Auto Discovery]
6060

61+
include::modules/rosa-sts-ocm-role-creation.adoc[leveloffset=+2]
62+
6163
include::modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+2]
6264

6365
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+2]

rosa_hcp/rosa-hcp-egress-zero-install.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ include::modules/rosa-glossary-disconnected.adoc[leveloffset=+1]
4343

4444
include::modules/rosa-hcp-set-environment-variables.adoc[leveloffset=+1]
4545

46-
include::modules/rosa-hcp-egress-zero-install-creating.adoc[leveloffset=+2]
46+
include::modules/rosa-hcp-egress-zero-install-creating.adoc[leveloffset=+1]
4747

4848
[role="_additional-resources"]
4949
.Additional resources
@@ -98,6 +98,8 @@ include::modules/vpc-troubleshooting.adoc[leveloffset=+2]
9898
* xref:../support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc#rosa-troubleshooting-installations-hcp[Troubleshooting {product-title} cluster installations]
9999
* xref:../support/getting-support.adoc#getting-support[Getting support for Red{nbsp}Hat OpenShift Service on AWS]
100100

101+
include::modules/rosa-sts-ocm-role-creation.adoc[leveloffset=+1]
102+
101103
include::modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+1]
102104

103105
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+1]

rosa_hcp/rosa-hcp-quickstart-guide.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ include::modules/rosa-hcp-vpc-subnet-tagging.adoc[leveloffset=+3]
5353
* link:https://developer.hashicorp.com/terraform[HashiCorp Terraform documentation]
5454
* link:https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/deploy/subnet_discovery/[Subnet Auto Discovery]
5555
56+
include::modules/rosa-sts-ocm-role-creation.adoc[leveloffset=+1]
5657
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+1]
5758
include::modules/rosa-operator-config.adoc[leveloffset=+1]
5859
include::modules/rosa-hcp-sts-creating-a-cluster-cli.adoc[leveloffset=+1]

rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ To create a {product-title} cluster, you must have completed the following steps
3232

3333
* xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-creating-vpc_rosa-hcp-sts-creating-a-cluster-quickly[Configured virtual private cloud (VPC)]
3434
* Created xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-account-wide-sts-roles-and-policies_rosa-hcp-sts-creating-a-cluster-quickly[Account-wide roles]
35+
* Created the xref:../rosa_planning/rosa-hcp-prepare-iam-roles-resources.adoc#rosa-sts-ocm-roles-and-permissions-iam-basic-role_prepare-role-resources[ocm-role IAM role]
3536
* Created an xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-sts-byo-oidc_rosa-hcp-sts-creating-a-cluster-quickly[OIDC configuration]
3637
* Created xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-operator-config_rosa-hcp-sts-creating-a-cluster-quickly[Operator roles]
3738

0 commit comments

Comments
 (0)