Skip to content

Commit 772a486

Browse files
committed
OSDOCS-3371: Add roles and managed policy reference
1 parent 104a7af commit 772a486

File tree

4 files changed

+83
-0
lines changed

4 files changed

+83
-0
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -692,6 +692,8 @@ Topics:
692692
File: using-service-accounts-as-oauth-client
693693
- Name: Assuming an AWS IAM role for a service account
694694
File: assuming-an-aws-iam-role-for-a-service-account
695+
- Name: Roles and AWS managed policy reference
696+
File: rosa-managed-policy-reference
695697
- Name: Scoping tokens
696698
File: tokens-scoping
697699
- Name: Using bound service account tokens

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,8 @@ Topics:
525525
File: using-service-accounts-as-oauth-client
526526
- Name: Assuming an AWS IAM role for a service account
527527
File: assuming-an-aws-iam-role-for-a-service-account
528+
- Name: Roles and AWS managed policy reference
529+
File: rosa-managed-policy-reference
528530
- Name: Scoping tokens
529531
File: tokens-scoping
530532
- Name: Using bound service account tokens
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="rosa-aws-managed-policy-reference"]
3+
= AWS roles and managed policy reference
4+
include::_attributes/common-attributes.adoc[]
5+
:context: rosa-aws-managed-policy-reference
6+
7+
toc::[]
8+
9+
The roles and policies used by {product-title} (ROSA)
10+
can be divided into account-wide roles and policies and Operator roles and policies.
11+
12+
The policies determine the allowed actions for each of the roles.
13+
ifdef::openshift-rosa[]
14+
See xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources] for more details about the individual roles and policies. See xref:../rosa_planning/rosa-sts-ocm-role.adoc#rosa-sts-ocm-role[ROSA IAM role resource] for more details about trust policies.
15+
endif::openshift-rosa[]
16+
ifdef::openshift-rosa-hcp[]
17+
See xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources] for more details about the individual roles and policies. See xref:../rosa_planning/rosa-hcp-prepare-iam-roles-resources.adoc#rosa-hcp-prepare-iam-roles-resources[Required IAM roles and resources] for more details on preparing these resources in your cluster.
18+
endif::openshift-rosa-hcp[]
19+
20+
link:https://docs.aws.amazon.com/rosa/latest/userguide/security-iam-awsmanpol.html[AWS managed policies] are created and administered by AWS. The permissions defined within the AWS managed policies cannot be changed. They are used as part of the AWS STS security process that you can use to assign permissions to users, groups, and roles.
21+
22+
[NOTE]
23+
====
24+
If the permissions defined in an AWS managed policy are updated by AWS, the update will apply to all users, groups, and roles related to the policy.
25+
====
26+
27+
include::modules/rosa-roles-and-policies.adoc[leveloffset=+1]

modules/rosa-roles-and-policies.adoc

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * authentication/rosa-hcp-aws-managed-policy-reference.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="rosa-roles-and-policies_{context}"]
7+
= ROSA roles and AWS managed policies
8+
9+
.Account-wide roles
10+
11+
ifdef::openshift-rosa-hcp[]
12+
* `<prefix>-HCP-ROSA-Worker-Role`
13+
* `<prefix>-HCP-ROSA-Support-Role`
14+
* `<prefix>-HCP-ROSA-Installer-Role`
15+
endif::openshift-rosa-hcp[]
16+
17+
ifdef::openshift-rosa[]
18+
* `<prefix>-ROSA-Worker-Role`
19+
* `<prefix>-ROSA-Support-Role`
20+
* `<prefix>-ROSA-Installer-Role`
21+
endif::openshift-rosa[]
22+
23+
.Account-wide AWS-managed policies
24+
25+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAInstallerPolicy.html[ROSAInstallerPolicy]
26+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAWorkerInstancePolicy.html[ROSAWorkerInstancePolicy]
27+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSASRESupportPolicy.html[ROSASRESupportPolicy]
28+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAIngressOperatorPolicy.html[ROSAIngressOperatorPolicy]
29+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAAmazonEBSCSIDriverOperatorPolicy.html[ROSAAmazonEBSCSIDriverOperatorPolicy]
30+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSACloudNetworkConfigOperatorPolicy.html[ROSACloudNetworkConfigOperatorPolicy]
31+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAControlPlaneOperatorPolicy.html[ROSAControlPlaneOperatorPolicy]
32+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAImageRegistryOperatorPolicy.html[ROSAImageRegistryOperatorPolicy]
33+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAKMSProviderPolicy.html[ROSAKMSProviderPolicy]
34+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAKubeControllerPolicy.html[ROSAKubeControllerPolicy]
35+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSAManageSubscription.html[ROSAManageSubscription]
36+
* link:https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ROSANodePoolManagementPolicy.html[ROSANodePoolManagementPolicy]
37+
38+
.Operator roles are:
39+
40+
Certain policies are used by the cluster Operator roles, listed below. The Operator roles are created in a second step because they are dependent on an existing cluster name and cannot be created at the same time as the account-wide roles.
41+
42+
* <operator_role_prefix>-openshift-cluster-csi-drivers-ebs-cloud-credentials
43+
* <operator_role_prefix>-openshift-cloud-network-config-controller-cloud-credentials
44+
* <operator_role_prefix>-openshift-machine-api-aws-cloud-credentials
45+
* <operator_role_prefix>-openshift-cloud-credential-operator-cloud-credentials
46+
* <operator_role_prefix>-openshift-image-registry-installer-cloud-credentials
47+
* <operator_role_prefix>-openshift-ingress-operator-cloud-crede
48+
49+
[NOTE]
50+
====
51+
Trust policies are created for each account-wide role and each Operator role.
52+
====

0 commit comments

Comments
 (0)