Skip to content

Commit a8470f4

Browse files
authored
Merge pull request #63414 from lpettyjo/OSDOCS-7073
OSDOCS#7073:Support standard STS config
2 parents 9e1dc54 + 0503cd6 commit a8470f4

File tree

4 files changed

+53
-32
lines changed

4 files changed

+53
-32
lines changed

modules/persistent-storage-csi-efs-sts.adoc

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,27 @@
44

55
:_content-type: PROCEDURE
66
[id="efs-sts_{context}"]
7-
= Configuring AWS EFS CSI Driver Operator with Security Token Service
7+
= Obtaining a role Amazon Resource Name for Security Token Service
88

9-
This procedure explains how to configure the AWS EFS CSI Driver Operator with {product-title} on AWS Security Token Service (STS).
10-
11-
Perform this procedure before you have installed the AWS EFS CSI Operator, but not yet installed the AWS EFS CSI driver as part of the _Installing the AWS EFS CSI Driver Operator_ procedure.
9+
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).
1210

1311
[IMPORTANT]
1412
====
15-
If you perform this procedure after installing the driver and creating volumes, your volumes will fail to mount into pods.
13+
Perform this procedure before you install the AWS EFS CSI Driver Operator (see _Installing the AWS EFS CSI Driver Operator_ procedure).
1614
====
1715

1816
.Prerequisites
1917

20-
* You have access to the cluster as a user with the cluster-admin role.
18+
* Access to the cluster as a user with the cluster-admin role.
2119
* AWS account credentials
22-
* You have installed the AWS EFS CSI Operator.
2320
2421
.Procedure
2522

26-
To configure the AWS EFS CSI Driver Operator with STS:
23+
You can obtain the ARN role in multiple ways. The following procedure shows one method that uses the same concept and CCO utility (`ccoctl`) binary tool as cluster installation.
24+
25+
To obtain a role ARN for configuring AWS EFS CSI Driver Operator using STS:
2726

28-
. Extract the CCO utility (`ccoctl`) binary from the {product-title} release image, which you used to install the cluster with STS. For more information, see "Configuring the Cloud Credential Operator utility".
27+
. Extract the `ccoctl` from the {product-title} release image, which you used to install the cluster with STS. For more information, see "Configuring the Cloud Credential Operator utility".
2928

3029
. Create and save an EFS `CredentialsRequest` YAML file, such as shown in the following example, and then place it in the `credrequests` directory:
3130
+
@@ -85,23 +84,30 @@ $ ccoctl aws create-iam-roles --name my-aws-efs --credentials-requests-dir credr
8584
2022/03/21 06:24:45 Updated Role policy for Role my-aws-efs-openshift-cluster-csi-drivers-aws-efs-cloud-
8685
----
8786
88-
. Create the AWS EFS cloud credentials and secret:
89-
+
90-
[source,terminal]
91-
----
92-
$ oc create -f <path_to_ccoctl_output_dir>/manifests/openshift-cluster-csi-drivers-aws-efs-cloud-credentials-credentials.yaml
93-
----
94-
+
95-
.Example
87+
. Copy the role ARN from the first line of the _Example output_ in the preceding step. The role ARN is between "Role" and "created". In this example, the role ARN is "arn:aws:iam::123456789012:role/my-aws-efs -openshift-cluster-csi-drivers-aws-efs-cloud".
9688
+
97-
[source,terminal]
98-
----
99-
$ oc create -f /manifests/openshift-cluster-csi-drivers-aws-efs-cloud-credentials-credentials.yaml
100-
----
101-
+
102-
.Example output
103-
+
104-
[source,terminal]
105-
----
106-
secret/aws-efs-cloud-credentials created
107-
----
89+
You will need the role ARN when you install the AWS EFS CSI Driver Operator.
90+
91+
.Next steps
92+
93+
//??the below step not needed for 4.14? ???
94+
//. Create the AWS EFS cloud credentials and secret:
95+
//+
96+
//[source, terminal]
97+
//----
98+
//$ oc create -f <path_to_ccoctl_output_dir>/manifests/openshift-cluster-csi-drivers-aws-efs-cloud-credentials-credentials.yaml
99+
//----
100+
//+
101+
//.Example
102+
//+
103+
//[source, terminal]
104+
//----
105+
//$ oc create -f /manifests/openshift-cluster-csi-drivers-aws-efs-cloud-credentials-credentials.yaml
106+
//----
107+
//+
108+
//.Example output
109+
//+
110+
//[source, terminal]
111+
//----
112+
//secret/aws-efs-cloud-credentials created
113+
//----

modules/persistent-storage-csi-olm-operator-install.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,14 @@ Be sure to select the *{FeatureName} CSI Driver Operator* and not the *{FeatureN
3434

3535
.. On the *Install Operator* page, ensure that:
3636
+
37+
ifdef::openshift-rosa,openshift-enterprise[]
38+
* If you are using {FeatureName} with AWS Secure Token Service (STS), in the *role ARN* field, enter the ARN role copied from the last step of the _Obtaining a role Amazon Resource Name for Security Token Service_ procedure.
39+
endif::[]
3740
* *All namespaces on the cluster (default)* is selected.
3841
* *Installed Namespace* is set to *openshift-cluster-csi-drivers*.
3942

4043
.. Click *Install*.
4144
+
4245
After the installation finishes, the {FeatureName} CSI Operator is listed in the *Installed Operators* section of the web console.
46+
47+
.Next steps

modules/persistent-storage-efs-csi-driver-operator-setup.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ ifdef::openshift-rosa[]
1313
. If you are using Amazon Elastic File Storage (Amazon EFS) with AWS Secure Token Service (STS), configure the https://github.com/openshift/aws-efs-csi-driver[{FeatureName} CSI driver] with STS.
1414
endif::openshift-rosa[]
1515

16+
ifdef::openshift-rosa,openshift-enterprise[]
17+
. If you are using {FeatureName} with AWS Secure Token Service (STS), obtain a role Amazon Resource Name (ARN) for STS. This is required for installing the {FeatureName} CSI Driver Operator.
18+
endif::[]
19+
20+
. Install the {FeatureName} CSI Driver Operator.
21+
1622
. Install the {FeatureName} CSI Driver.

storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,20 @@ include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
3232
:FeatureName: AWS EFS
3333
include::modules/persistent-storage-efs-csi-driver-operator-setup.adoc[leveloffset=+1]
3434

35-
include::modules/persistent-storage-csi-olm-operator-install.adoc[leveloffset=+2]
36-
.Next steps
37-
* If you are using {FeatureName} with AWS Secure Token Service (STS), you must configure the {FeatureName} CSI Driver with STS. For more information, see xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#efs-sts_persistent-storage-csi-aws-efs[Configuring AWS EFS CSI Driver with STS].
38-
35+
ifdef::openshift-rosa,openshift-enterprise[]
3936
include::modules/persistent-storage-csi-efs-sts.adoc[leveloffset=+2]
37+
38+
xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#persistent-storage-csi-olm-operator-install_persistent-storage-csi-aws-efs[Install the AWS EFS CSI Driver Operator].
4039
[role="_additional-resources"]
4140
.Additional resources
4241
* xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#persistent-storage-csi-olm-operator-install_persistent-storage-csi-aws-efs[Installing the AWS EFS CSI Driver Operator]
4342
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[Configuring the Cloud Credential Operator utility]
4443
* xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#persistent-storage-csi-efs-driver-install_persistent-storage-csi-aws-efs[Installing the {FeatureName} CSI Driver]
44+
endif::[]
45+
46+
include::modules/persistent-storage-csi-olm-operator-install.adoc[leveloffset=+2]
47+
48+
xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#persistent-storage-csi-efs-driver-install_persistent-storage-csi-aws-efs[Install the AWS EFS CSI Driver].
4549

4650
include::modules/persistent-storage-csi-efs-driver-install.adoc[leveloffset=+2]
4751

0 commit comments

Comments
 (0)