Skip to content

OSDOCS-18265: Vale DITA fixes for OSD storage #109019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AedinC merged 1 commit into from
Mar 27, 2026
+10 −7
Merged

OSDOCS-18265: Vale DITA fixes for OSD storage #109019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions modules/sd-persistent-storage-csi-efs-sts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="efs-sts_{context}"]
= Obtaining a role Amazon Resource Name for Security Token Service

[role="_abstract"]
This procedure explains how to obtain a role Amazon Resource Name (ARN) to configure the AWS EFS CSI Driver Operator with {product-title} on AWS Security Token Service (STS).

[IMPORTANT]
Expand Down Expand Up @@ -66,7 +67,6 @@ Perform this procedure before you install the AWS EFS CSI Driver Operator (see _

. Create an IAM trust JSON file with the following content:
+
--
[source,json]
----
{
Expand All @@ -75,12 +75,12 @@ Perform this procedure before you install the AWS EFS CSI Driver Operator (see _
{
"Effect": "Allow",
"Principal": {
"Federated": "arn:aws:iam::<your_aws_account_ID>:oidc-provider/<openshift_oidc_provider>" <1>
"Federated": "arn:aws:iam::<your_aws_account_ID>:oidc-provider/<openshift_oidc_provider>"
},
"Action": "sts:AssumeRoleWithWebIdentity",
"Condition": {
"StringEquals": {
"<openshift_oidc_provider>:sub": [ <2>
"<openshift_oidc_provider>:sub": [
"system:serviceaccount:openshift-cluster-csi-drivers:aws-efs-csi-driver-operator",
"system:serviceaccount:openshift-cluster-csi-drivers:aws-efs-csi-driver-controller-sa"
]
Expand All @@ -90,7 +90,11 @@ Perform this procedure before you install the AWS EFS CSI Driver Operator (see _
]
}
----
<1> Specify your AWS account ID and the OpenShift OIDC provider endpoint.
+
--
where:

`Statement.Principal.Federated`:: Specifies your AWS account ID and the OpenShift OIDC provider endpoint.
+
Obtain your AWS account ID by running the following command:
+
Expand Down Expand Up @@ -121,7 +125,7 @@ $ openshift_oidc_provider=`oc get authentication.config.openshift.io cluster \
----
endif::openshift-dedicated[]

<2> Specify the OpenShift OIDC endpoint again.
`Statement.Condition.StringEquals[0]`:: Specify the OpenShift OIDC endpoint again.
--

. Create the IAM role:
Expand Down Expand Up @@ -169,10 +173,9 @@ stringData:
credentials: |-
[default]
sts_regional_endpoints = regional
role_arn = <role_ARN> <1>
role_arn = <role_ARN>
web_identity_token_file = /var/run/secrets/openshift/serviceaccount/token
----
<1> Replace `role_ARN` with the output you saved while creating the role.
Copy link
Copy Markdown
Contributor

@otikhomi otikhomi Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to confirm that this callout can be deleted entirely and doesn't need to be replaced?

Copy link
Copy Markdown
Contributor

@EricPonvelle EricPonvelle Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's pretty self-evident for users so, I am cool with dropping this explanation.

Copy link
Copy Markdown
Contributor Author

@bhardesty bhardesty Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I've been fixing callouts, I've just been deleting any that are self-explanatory.

However, in this case, this callout was in a commented-out section of text. Vale still flags it even though it's commented-out. So I just deleted the callout entirely so Vale would stop complaining.


. Create the secret:
+
Expand Down