Skip to content

Commit bdbba28

Browse files
authored
Merge pull request #59650 from smunje1/OSDOCS-5793
OSDOCS-5793
2 parents dd38cb1 + 4b5b005 commit bdbba28

23 files changed

+56
-59
lines changed

modules/dynamic-provisioning-available-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ ifndef::openshift-dedicated,openshift-rosa[]
2828
|Once installed, the OpenStack Manila CSI Driver Operator and ManilaDriver automatically create the required storage classes for all available Manila share types needed for dynamic provisioning.
2929
endif::openshift-dedicated,openshift-rosa[]
3030

31-
|AWS Elastic Block Store (EBS)
31+
|Amazon Elastic Block Store (Amazon EBS)
3232
|`kubernetes.io/aws-ebs`
3333
|For dynamic provisioning when using multiple clusters in different zones,
3434
tag each node with `Key=kubernetes.io/cluster/<cluster_name>,Value=<cluster_id>`

modules/dynamic-provisioning-storage-class-definition.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ The following resource shows the parameters and default values that you
1212
use to configure a storage class. This example uses the AWS
1313
ElasticBlockStore (EBS) object definition.
1414

15-
1615
.Sample `StorageClass` definition
1716
[source,yaml]
1817
----

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
[id="efs-sts_{context}"]
99
= Configuring AWS EFS CSI Driver Operator with Secure Token Service
1010

11-
This procedure explains how to configure the AWS EFS CSI Driver Operator with {product-title} on AWS Secure Token Service (STS).
11+
This procedure explains how to configure the link:https://github.com/openshift/aws-efs-csi-driver-operator[AWS EFS CSI Driver Operator] (a Red Hat operator) with {product-title} on AWS Secure Token Service (STS).
1212

13-
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.
13+
Perform this procedure before you have installed the AWS EFS CSI Operator, but not yet installed the link:https://github.com/openshift/aws-efs-csi-driver[AWS EFS CSI driver] as part of the _Installing the AWS EFS CSI Driver Operator_ procedure.
1414

1515
[IMPORTANT]
1616
====

modules/persistent-storage-csi-dynamic-provisioning-aws-efs.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55

66
:_content-type: PROCEDURE
77
[id="csi-dynamic-provisioning-aws-efs_{context}"]
8-
= Dynamic provisioning for AWS EFS
8+
= Dynamic provisioning for Amazon Elastic File Storage
99

1010
[role="_abstract"]
11-
The AWS EFS CSI Driver supports a different form of dynamic provisioning than other CSI drivers. It provisions new PVs as subdirectories of a pre-existing EFS volume. The PVs are independent of each other. However, they all share the same EFS volume. When the volume is deleted, all PVs provisioned out of it are deleted too.
11+
The link:https://github.com/openshift/aws-efs-csi-driver[AWS EFS CSI driver] supports a different form of dynamic provisioning than other CSI drivers. It provisions new PVs as subdirectories of a pre-existing EFS volume. The PVs are independent of each other. However, they all share the same EFS volume. When the volume is deleted, all PVs provisioned out of it are deleted too.
1212
The EFS CSI driver creates an AWS Access Point for each such subdirectory. Due to AWS AccessPoint limits, you can only dynamically provision 1000 PVs from a single `StorageClass`/EFS volume.
1313

1414
[IMPORTANT]
@@ -22,7 +22,7 @@ Using monitoring of EFS volume sizes in AWS is strongly recommended.
2222

2323
.Prerequisites
2424

25-
* You have created AWS EFS volumes.
25+
* You have created Amazon Elastic File Storage (Amazon EFS) volumes.
2626
* You have created the AWS EFS storage class.
2727
2828
.Procedure

modules/persistent-storage-csi-efs-driver-install.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
= Installing the {FeatureName} CSI Driver
99

1010
ifdef::openshift-rosa[]
11-
After installing the {FeatureName} CSI Driver Operator and configuring it with STS, you install the {FeatureName} CSI Driver.
11+
After installing the link:https://github.com/openshift/aws-efs-csi-driver-operator[{FeatureName} CSI Driver Operator] (a Red Hat operator) and configuring it with STS, you install the link:https://github.com/openshift/aws-efs-csi-driver[{FeatureName} CSI driver].
1212
endif::openshift-rosa[]
1313
ifdef::openshift-dedicated[]
1414
After installing the {FeatureName} CSI Driver Operator, you install the {FeatureName} CSI Driver.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
// * storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc
66

77
[id="efs-security_{context}"]
8-
= AWS EFS security
8+
= Amazon Elastic File Storage security
99

10-
The following information is important for AWS EFS security.
10+
The following information is important for Amazon Elastic File Storage (Amazon EFS) security.
1111

1212
When using access points, for example, by using dynamic provisioning as described earlier, Amazon automatically replaces GIDs on files with the GID of the access point. In addition, EFS considers the user ID, group ID, and secondary group IDs of the access point when evaluating file system permissions. EFS ignores the NFS client's IDs. For more information about access points, see https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html.
1313

modules/persistent-storage-csi-efs-static-pv.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
:_content-type: PROCEDURE
88
[id="efs-create-static-pv_{context}"]
9-
= Creating static PVs with AWS EFS
9+
= Creating static PVs with Amazon Elastic File Storage
1010

11-
It is possible to use an AWS EFS volume as a single PV without any dynamic provisioning. The whole volume is mounted to pods.
11+
It is possible to use an Amazon Elastic File Storage (Amazon EFS) volume as a single PV without any dynamic provisioning. The whole volume is mounted to pods.
1212

1313
.Prerequisites
1414

15-
* You have created AWS EFS volumes.
15+
* You have created Amazon EFS volumes.
1616
1717
.Procedure
1818

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
// * storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc
66

77
[id="efs-troubleshooting_{context}"]
8-
= AWS EFS troubleshooting
8+
= Amazon Elastic File Storage troubleshooting
99

10-
The following information provides guidance on how to troubleshoot issues with AWS EFS:
10+
The following information provides guidance on how to troubleshoot issues with Amazon Elastic File Storage (Amazon EFS):
1111

1212
* The AWS EFS Operator and CSI driver run in namespace `openshift-cluster-csi-drivers`.
1313

@@ -43,7 +43,7 @@ $ oc describe pod
4343
----
4444
<1> Warning message indicating volume not mounted.
4545
+
46-
This error is frequently caused by AWS dropping packets between an {product-title} node and AWS EFS.
46+
This error is frequently caused by AWS dropping packets between an {product-title} node and Amazon EFS.
4747
+
4848
Check that the following are correct:
4949
+

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[id="persistent-storage-csi-olm-operator-install_{context}"]
88
= Installing the {FeatureName} CSI Driver Operator
99

10-
The {FeatureName} CSI Driver Operator is not installed in {product-title} by default. Use the following procedure to install and configure the {FeatureName} CSI Driver Operator in your cluster.
10+
The link:https://github.com/openshift/aws-efs-csi-driver-operator[AWS EFS CSI Driver Operator] (a Red Hat operator) is not installed in {product-title} by default. Use the following procedure to install and configure the {FeatureName} CSI Driver Operator in your cluster.
1111

1212
.Prerequisites
1313
* Access to the {product-title} web console.
@@ -27,7 +27,7 @@ To install the {FeatureName} CSI Driver Operator from the web console:
2727
+
2828
[IMPORTANT]
2929
====
30-
Be sure to select the *AWS EFS CSI Driver Operator* and not the *AWS EFS Operator*. The *AWS EFS Operator* is a community Operator and is not supported by Red Hat.
30+
Be sure to select the *{FeatureName} CSI Driver Operator* and not the *{FeatureName} Operator*. The *{FeatureName} Operator* is a community Operator and is not supported by Red Hat.
3131
====
3232

3333
.. On the *{FeatureName} CSI Driver Operator* page, click *Install*.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[id="persistent-storage-csi-olm-operator-uninstall_{context}"]
99
= Uninstalling the {FeatureName} CSI Driver Operator
1010

11-
All EFS PVs are inaccessible after uninstalling the AWS EFS CSI Driver Operator.
11+
All EFS PVs are inaccessible after uninstalling the link:https://github.com/openshift/aws-efs-csi-driver-operator[AWS EFS CSI Driver Operator] (a Red Hat operator).
1212

1313
.Prerequisites
1414
* Access to the {product-title} web console.
@@ -26,7 +26,7 @@ To uninstall the {FeatureName} CSI Driver Operator from the web console:
2626

2727
.. Select each PVC that is in use by the {FeatureName} CSI Driver Operator, click the drop-down menu on the far right of the PVC, and then click *Delete PersistentVolumeClaims*.
2828

29-
. Uninstall the {FeatureName} CSI Driver:
29+
. Uninstall the https://github.com/openshift/aws-efs-csi-driver[{FeatureName} CSI driver]:
3030
+
3131
[NOTE]
3232
====

0 commit comments

Comments
 (0)