Skip to content

Commit a066401

Browse files
authored
Merge pull request #75897 from mletalie/OSDOCS-9279
[OSDOCS-9279]Arbitrary policies attached to ROSA roles
2 parents 941fd9b + 3d69edf commit a066401

File tree

5 files changed

+79
-3
lines changed

5 files changed

+79
-3
lines changed

cli_reference/rosa_cli/rosa-manage-objects-cli.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc::[]
1010
Managing objects with the {product-title} (ROSA) CLI, `rosa`, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.
1111

1212
[NOTE]
13-
====
13+
====
1414
To access a cluster that is accessible only over an HTTP proxy server, you can set the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables. These environment variables are respected by the `rosa` CLI so that all communication with the cluster goes through the HTTP proxy.
1515
====
1616

@@ -31,3 +31,4 @@ include::modules/rosa-install-uninstall-addon.adoc[leveloffset=+1]
3131
include::modules/rosa-list-objects.adoc[leveloffset=+1]
3232
include::modules/rosa-revoke-objects.adoc[leveloffset=+1]
3333
include::modules/rosa-upgrade-cluster-cli.adoc[leveloffset=+1]
34+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa-sts-about-iam-resources.adoc
4+
5+
[id="rosa-aws-customer-managed-policies_{context}"]
6+
= Customer-managed policies
7+
{product-title} (ROSA) users are able to attach customer-managed policies to the IAM roles required to run and maintain ROSA clusters. This capability is not uncommon with AWS IAM roles.
8+
The ability to attach these policies to ROSA-specific IAM roles extends a ROSA cluster’s permission capabilities; for example, as a way to allow cluster components to access additional AWS resources that are otherwise not part of the ROSA-specific IAM policies.
9+
10+
To ensure that any critical customer applications that rely on customer-managed policies are not modified in any way during cluster or role upgrades, ROSA utilizes the `ListAttachedRolesPolicies` permission to retrieve the list of permission policies from roles and the `ListRolePolicies` permission to retrieve the list of policies from ROSA-specific roles. This information ensures that customer-managed policies are not impacted during cluster events, and allows Red Hat SREs to monitor both ROSA and customer-managed policies attached to ROSA-specific IAM roles, enhancing their ability to troubleshoot any cluster issues more effectively.
11+
12+
[WARNING]
13+
====
14+
Attaching permission boundary policies to IAM roles that restrict ROSA-specific policies is not supported, as these policies could interrupt the functionality of the basic permissions necessary to successfully run and maintain your ROSA cluster. There are prepared permissions boundary policies for the ROSA (classic architecture) installer role. See the Additional resources section for more information.
15+
====
16+
17+
[role="_additional-resources"]
18+
.Additional resources
19+
20+
* xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-aws-requirements-attaching-boundary-policy_rosa-sts-about-iam-resources[Permission boundaries for the installer role]
21+
* link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html[Permissions boundaries for IAM entities]

modules/rosa-list-objects.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -683,8 +683,12 @@ $ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
683683

684684
|--profile
685685
|Specifies an AWS profile (string) from your credentials file.
686+
687+
|--get-role-policy-bindings
688+
|Lists the policies that are attached to the STS roles assigned to the cluster.
686689
|===
687690

691+
688692
.Example
689693
Describe a cluster named `mycluster`.
690694
[source,terminal]
@@ -724,7 +728,9 @@ a| Optional. Specifies the name of the `KubeletConfig` object to describe.
724728
// Required.
725729
// endif::openshift-rosa-hcp[]
726730

727-
|-o, --output string
731+
|-o, --output string
732+
733+
|-o, --output string
728734
|The output format. You can specify either `json` or `yaml`.
729735

730736
|===

modules/rosa-upgrade-cluster-cli.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,52 @@ $ rosa delete upgrade --cluster=<cluster_name> <machinepool_name>
192192
|Specifies an AWS profile (string) from your credentials file.
193193
|===
194194

195+
[id="rosa-upgrade-roles_{context}"]
196+
== upgrade roles
197+
Upgrades roles configured on a cluster.
198+
199+
200+
.Syntax
201+
[source,terminal]
202+
----
203+
$ rosa upgrade roles --cluster=<cluster_id>
204+
----
205+
206+
.Arguments
207+
[cols="30,70"]
208+
|===
209+
|Option |Definition
210+
211+
|--cluster
212+
|Required: The name or ID (string) of the cluster.
213+
|===
214+
215+
.Optional arguments inherited from parent commands
216+
[cols="30,70"]
217+
|===
218+
|Option |Definition
219+
220+
|--help
221+
|Shows help for this command.
222+
223+
|--debug
224+
|Enables debug mode.
225+
226+
|--profile
227+
|Specifies an AWS profile (string) from your credentials file.
228+
|===
229+
230+
.Example
231+
Upgrade roles on a cluster named `mycluster`.
232+
[source,terminal]
233+
----
234+
$ rosa upgrade roles --cluster=mycluster
235+
----
236+
237+
238+
239+
240+
195241
// .Example
196242
// Delete a machine pool named `mymachinepool` on a cluster named `mycluster`.
197243
// [source,terminal]

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,6 @@ include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+3]
105105
[discrete]
106106
include::modules/rosa-sts-byo-oidc-options.adoc[leveloffset=+3]
107107

108-
include::modules/rosa-aws-scp.adoc[leveloffset=+1]
108+
include::modules/rosa-aws-scp.adoc[leveloffset=+1]
109+
110+
include::modules/rosa-aws-customer-managed-policies.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)