From 7c14328344e7da045f16164f4060a6a6c7a48ecc Mon Sep 17 00:00:00 2001 From: Satyajeet Munje Date: Mon, 14 Aug 2023 12:02:21 +0530 Subject: [PATCH] OSDOCS-5793 --- .../dynamic-provisioning-available-plugins.adoc | 2 +- ...ic-provisioning-storage-class-definition.adoc | 1 - modules/osd-persistent-storage-csi-efs-sts.adoc | 4 ++-- ...storage-csi-dynamic-provisioning-aws-efs.adoc | 6 +++--- ...ersistent-storage-csi-efs-driver-install.adoc | 2 +- modules/persistent-storage-csi-efs-security.adoc | 4 ++-- .../persistent-storage-csi-efs-static-pv.adoc | 6 +++--- ...rsistent-storage-csi-efs-troubleshooting.adoc | 6 +++--- ...sistent-storage-csi-olm-operator-install.adoc | 4 ++-- ...stent-storage-csi-olm-operator-uninstall.adoc | 4 ++-- ...nt-storage-efs-csi-driver-operator-setup.adoc | 4 ++-- modules/rosa-aws-provisioned.adoc | 4 ++-- modules/rosa-policy-shared-responsibility.adoc | 12 +++++------- modules/rosa-sdpolicy-am-regions-az.adoc | 2 +- modules/rosa-sdpolicy-storage.adoc | 6 +++--- modules/storage-create-storage-class.adoc | 2 +- .../storage-persistent-storage-block-volume.adoc | 4 ++-- .../storage-persistent-storage-lifecycle.adoc | 2 +- modules/storage-persistent-storage-pv.adoc | 2 +- ...torage-persistent-storage-reclaim-manual.adoc | 2 +- .../osd-persistent-storage-aws-efs-csi.adoc | 14 +++++++------- .../persistent-storage-csi-ebs.adoc | 16 ++++++++-------- .../persistent-storage-aws.adoc | 6 +++--- 23 files changed, 56 insertions(+), 59 deletions(-) diff --git a/modules/dynamic-provisioning-available-plugins.adoc b/modules/dynamic-provisioning-available-plugins.adoc index 9b6559429b36..6db5dbc1a299 100644 --- a/modules/dynamic-provisioning-available-plugins.adoc +++ b/modules/dynamic-provisioning-available-plugins.adoc @@ -28,7 +28,7 @@ ifndef::openshift-dedicated,openshift-rosa[] |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. endif::openshift-dedicated,openshift-rosa[] -|AWS Elastic Block Store (EBS) +|Amazon Elastic Block Store (Amazon EBS) |`kubernetes.io/aws-ebs` |For dynamic provisioning when using multiple clusters in different zones, tag each node with `Key=kubernetes.io/cluster/,Value=` diff --git a/modules/dynamic-provisioning-storage-class-definition.adoc b/modules/dynamic-provisioning-storage-class-definition.adoc index 436a78ed6962..5a4508d16e69 100644 --- a/modules/dynamic-provisioning-storage-class-definition.adoc +++ b/modules/dynamic-provisioning-storage-class-definition.adoc @@ -12,7 +12,6 @@ The following resource shows the parameters and default values that you use to configure a storage class. This example uses the AWS ElasticBlockStore (EBS) object definition. - .Sample `StorageClass` definition [source,yaml] ---- diff --git a/modules/osd-persistent-storage-csi-efs-sts.adoc b/modules/osd-persistent-storage-csi-efs-sts.adoc index 59b0f343e3b0..a1dfe0398677 100644 --- a/modules/osd-persistent-storage-csi-efs-sts.adoc +++ b/modules/osd-persistent-storage-csi-efs-sts.adoc @@ -8,9 +8,9 @@ [id="efs-sts_{context}"] = Configuring AWS EFS CSI Driver Operator with Secure Token Service -This procedure explains how to configure the AWS EFS CSI Driver Operator with {product-title} on AWS Secure Token Service (STS). +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). -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. +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. [IMPORTANT] ==== diff --git a/modules/persistent-storage-csi-dynamic-provisioning-aws-efs.adoc b/modules/persistent-storage-csi-dynamic-provisioning-aws-efs.adoc index 0173bbcf117c..83b8edd6a3eb 100644 --- a/modules/persistent-storage-csi-dynamic-provisioning-aws-efs.adoc +++ b/modules/persistent-storage-csi-dynamic-provisioning-aws-efs.adoc @@ -5,10 +5,10 @@ :_content-type: PROCEDURE [id="csi-dynamic-provisioning-aws-efs_{context}"] -= Dynamic provisioning for AWS EFS += Dynamic provisioning for Amazon Elastic File Storage [role="_abstract"] -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. +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. 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. [IMPORTANT] @@ -22,7 +22,7 @@ Using monitoring of EFS volume sizes in AWS is strongly recommended. .Prerequisites -* You have created AWS EFS volumes. +* You have created Amazon Elastic File Storage (Amazon EFS) volumes. * You have created the AWS EFS storage class. .Procedure diff --git a/modules/persistent-storage-csi-efs-driver-install.adoc b/modules/persistent-storage-csi-efs-driver-install.adoc index 57011261dac2..d1aaf0c95a93 100644 --- a/modules/persistent-storage-csi-efs-driver-install.adoc +++ b/modules/persistent-storage-csi-efs-driver-install.adoc @@ -8,7 +8,7 @@ = Installing the {FeatureName} CSI Driver ifdef::openshift-rosa[] -After installing the {FeatureName} CSI Driver Operator and configuring it with STS, you install the {FeatureName} CSI Driver. +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]. endif::openshift-rosa[] ifdef::openshift-dedicated[] After installing the {FeatureName} CSI Driver Operator, you install the {FeatureName} CSI Driver. diff --git a/modules/persistent-storage-csi-efs-security.adoc b/modules/persistent-storage-csi-efs-security.adoc index 9e56771096bc..b8bbd3d98a70 100644 --- a/modules/persistent-storage-csi-efs-security.adoc +++ b/modules/persistent-storage-csi-efs-security.adoc @@ -5,9 +5,9 @@ // * storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc [id="efs-security_{context}"] -= AWS EFS security += Amazon Elastic File Storage security -The following information is important for AWS EFS security. +The following information is important for Amazon Elastic File Storage (Amazon EFS) security. 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. diff --git a/modules/persistent-storage-csi-efs-static-pv.adoc b/modules/persistent-storage-csi-efs-static-pv.adoc index f16c125abf3e..5d7660733d04 100644 --- a/modules/persistent-storage-csi-efs-static-pv.adoc +++ b/modules/persistent-storage-csi-efs-static-pv.adoc @@ -6,13 +6,13 @@ :_content-type: PROCEDURE [id="efs-create-static-pv_{context}"] -= Creating static PVs with AWS EFS += Creating static PVs with Amazon Elastic File Storage -It is possible to use an AWS EFS volume as a single PV without any dynamic provisioning. The whole volume is mounted to pods. +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. .Prerequisites -* You have created AWS EFS volumes. +* You have created Amazon EFS volumes. .Procedure diff --git a/modules/persistent-storage-csi-efs-troubleshooting.adoc b/modules/persistent-storage-csi-efs-troubleshooting.adoc index 6dd7ae303a1c..f4aabef4c888 100644 --- a/modules/persistent-storage-csi-efs-troubleshooting.adoc +++ b/modules/persistent-storage-csi-efs-troubleshooting.adoc @@ -5,9 +5,9 @@ // * storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc [id="efs-troubleshooting_{context}"] -= AWS EFS troubleshooting += Amazon Elastic File Storage troubleshooting -The following information provides guidance on how to troubleshoot issues with AWS EFS: +The following information provides guidance on how to troubleshoot issues with Amazon Elastic File Storage (Amazon EFS): * The AWS EFS Operator and CSI driver run in namespace `openshift-cluster-csi-drivers`. @@ -43,7 +43,7 @@ $ oc describe pod ---- <1> Warning message indicating volume not mounted. + -This error is frequently caused by AWS dropping packets between an {product-title} node and AWS EFS. +This error is frequently caused by AWS dropping packets between an {product-title} node and Amazon EFS. + Check that the following are correct: + diff --git a/modules/persistent-storage-csi-olm-operator-install.adoc b/modules/persistent-storage-csi-olm-operator-install.adoc index da7eb466a526..0bbf794f1f18 100644 --- a/modules/persistent-storage-csi-olm-operator-install.adoc +++ b/modules/persistent-storage-csi-olm-operator-install.adoc @@ -7,7 +7,7 @@ [id="persistent-storage-csi-olm-operator-install_{context}"] = Installing the {FeatureName} CSI Driver Operator -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. +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. .Prerequisites * Access to the {product-title} web console. @@ -27,7 +27,7 @@ To install the {FeatureName} CSI Driver Operator from the web console: + [IMPORTANT] ==== -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. +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. ==== .. On the *{FeatureName} CSI Driver Operator* page, click *Install*. diff --git a/modules/persistent-storage-csi-olm-operator-uninstall.adoc b/modules/persistent-storage-csi-olm-operator-uninstall.adoc index 5284ed0b2227..2f6061add13a 100644 --- a/modules/persistent-storage-csi-olm-operator-uninstall.adoc +++ b/modules/persistent-storage-csi-olm-operator-uninstall.adoc @@ -8,7 +8,7 @@ [id="persistent-storage-csi-olm-operator-uninstall_{context}"] = Uninstalling the {FeatureName} CSI Driver Operator -All EFS PVs are inaccessible after uninstalling the AWS EFS CSI Driver Operator. +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). .Prerequisites * Access to the {product-title} web console. @@ -26,7 +26,7 @@ To uninstall the {FeatureName} CSI Driver Operator from the web console: .. 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*. -. Uninstall the {FeatureName} CSI Driver: +. Uninstall the https://github.com/openshift/aws-efs-csi-driver[{FeatureName} CSI driver]: + [NOTE] ==== diff --git a/modules/persistent-storage-efs-csi-driver-operator-setup.adoc b/modules/persistent-storage-efs-csi-driver-operator-setup.adoc index b8604eb648cf..ccfc4dc8e56e 100644 --- a/modules/persistent-storage-efs-csi-driver-operator-setup.adoc +++ b/modules/persistent-storage-efs-csi-driver-operator-setup.adoc @@ -7,10 +7,10 @@ [id="persistent-storage-efs-csi-driver-operator-setup_{context}"] = Setting up the {FeatureName} CSI Driver Operator -. Install the {FeatureName} CSI Driver Operator. +. Install the link:https://github.com/openshift/aws-efs-csi-driver-operator[{FeatureName} CSI Driver Operator] (a Red Hat operator). ifdef::openshift-rosa[] -. If you are using {FeatureName} with AWS Secure Token Service (STS), configure the {FeatureName} CSI Driver with STS. +. 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. endif::openshift-rosa[] . Install the {FeatureName} CSI Driver. diff --git a/modules/rosa-aws-provisioned.adoc b/modules/rosa-aws-provisioned.adoc index d8f432e2d5bc..a9b3b3526fe8 100644 --- a/modules/rosa-aws-provisioned.adoc +++ b/modules/rosa-aws-provisioned.adoc @@ -23,9 +23,9 @@ Instance types can vary for control plane and infrastructure nodes, depending on For further guidance on worker node counts, see the information about initial planning considerations in the "Limits and scalability" topic listed in the "Additional resources" section of this page. [id="rosa-ebs-storage_{context}"] -== AWS Elastic Block Store (EBS) storage +== Amazon Elastic Block Store storage -Amazon EBS block storage is used for both local node storage and persistent volume storage. +Amazon Elastic Block Store (Amazon EBS) block storage is used for both local node storage and persistent volume storage. Volume requirements for each EC2 instance: diff --git a/modules/rosa-policy-shared-responsibility.adoc b/modules/rosa-policy-shared-responsibility.adoc index b1d7b2294855..eafd05abb372 100644 --- a/modules/rosa-policy-shared-responsibility.adoc +++ b/modules/rosa-policy-shared-responsibility.adoc @@ -41,7 +41,7 @@ security threats. |Virtual storage management |**Red Hat** -- Monitor Amazon EBS volumes used for cluster nodes, and Amazon S3 buckets used for the ROSA service’s built-in container image +- Monitor Amazon Elastic Block Store (Amazon EBS) volumes used for cluster nodes, and Amazon S3 buckets used for the ROSA service’s built-in container image registry. Respond to alerts. |- Monitor health of application data. - If customer managed AWS KMS keys are @@ -180,8 +180,7 @@ machine pool using the OpenShift Cluster Manager or the ROSA CLI (`rosa`). - Regularly prune image registry resources in Amazon S3 to optimize Amazon S3 usage and cluster performance. -| - Optionally configure the Amazon EBS CSI driver or the Amazon -EFS CSI driver to provision persistent volumes on the cluster. +| - Optionally configure the link:https://github.com/openshift/aws-ebs-csi-driver[AWS EBS CSI driver] or the https://github.com/openshift/aws-efs-csi-driver[AWS EFS CSI driver] to provision persistent volumes on the cluster. |AWS software (public AWS services) |**AWS** @@ -392,8 +391,7 @@ potential issues and security threats. **Compute:** Secure Amazon EC2, used for ROSA control plane, infrastructure, and worker nodes. For more information, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/infrastructure-security.html[ Infrastructure security in Amazon EC2] in the Amazon EC2 User Guide. -**Storage:** Secure Amazon Elastic Block Store (EBS), -used for ROSA control plane, infrastructure, and worker node volumes, as well as Kubernetes persistent volumes. For more information, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html[Data protection in Amazon EC2] in the Amazon EC2 User Guide. +**Storage:** Secure Amazon EBS, used for ROSA control plane, infrastructure, and worker node volumes, as well as Kubernetes persistent volumes. For more information, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html[Data protection in Amazon EC2] in the Amazon EC2 User Guide. **Storage:** Provide AWS KMS, which ROSA uses to encrypt control plane, infrastructure, and worker node volumes and persistent volumes. For more information, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html[Amazon EBS encryption] in the Amazon EC2 User Guide. @@ -498,11 +496,11 @@ availability. - Provision persistent volumes using the -Amazon EBS CSI +AWS EBS CSI driver to enable volume snapshots. -- Create CSI volume snapshots of Amazon +- Create CSI volume snapshots of AWS EBS persistent volumes. |Hardware/AWS global infrastructure |**AWS** diff --git a/modules/rosa-sdpolicy-am-regions-az.adoc b/modules/rosa-sdpolicy-am-regions-az.adoc index a4876c77af9d..aec2b3db6af2 100644 --- a/modules/rosa-sdpolicy-am-regions-az.adoc +++ b/modules/rosa-sdpolicy-am-regions-az.adoc @@ -40,7 +40,7 @@ The following AWS regions are supported by Red Hat OpenShift 4 and are supported Multiple availability zone clusters can only be deployed in regions with at least 3 availability zones. For more information, see the link:https://aws.amazon.com/about-aws/global-infrastructure/regions_az/[Regions and Availability Zones] section in the AWS documentation. -Each new {product-title} cluster is installed within an installer-created or preexisting Virtual Private Cloud (VPC) in a single region, with the option to deploy into a single availability zone (Single-AZ) or across multiple availability zones (Multi-AZ). This provides cluster-level network and resource isolation, and enables cloud-provider VPC settings, such as VPN connections and VPC Peering. Persistent volumes (PVs) are backed by AWS Elastic Block Storage (EBS), and are specific to the availability zone in which they are provisioned. Persistent volume claims (PVCs) do not bind to a volume until the associated pod resource is assigned into a specific availability zone to prevent unschedulable pods. Availability zone-specific resources are only usable by resources in the same availability zone. +Each new {product-title} cluster is installed within an installer-created or preexisting Virtual Private Cloud (VPC) in a single region, with the option to deploy into a single availability zone (Single-AZ) or across multiple availability zones (Multi-AZ). This provides cluster-level network and resource isolation, and enables cloud-provider VPC settings, such as VPN connections and VPC Peering. Persistent volumes (PVs) are backed by Amazon Elastic Block Storage (Amazon EBS), and are specific to the availability zone in which they are provisioned. Persistent volume claims (PVCs) do not bind to a volume until the associated pod resource is assigned into a specific availability zone to prevent unschedulable pods. Availability zone-specific resources are only usable by resources in the same availability zone. [WARNING] ==== diff --git a/modules/rosa-sdpolicy-storage.adoc b/modules/rosa-sdpolicy-storage.adoc index fafc5def1ff4..3c8da805911b 100644 --- a/modules/rosa-sdpolicy-storage.adoc +++ b/modules/rosa-sdpolicy-storage.adoc @@ -11,7 +11,7 @@ This section provides information about the service definition for {product-titl [id="rosa-sdpolicy-encrytpted-at-rest-storage_{context}"] == Encrypted-at-rest OS and node storage -Control plane, infrastructure, and worker nodes use encrypted-at-rest AWS Elastic Block Store (EBS) storage. +Control plane, infrastructure, and worker nodes use encrypted-at-rest Amazon Elastic Block Store (Amazon EBS) storage. [id="rosa-sdpolicy-encrytpted-at-rest-pv_{context}"] == Encrypted-at-rest PV @@ -19,7 +19,7 @@ EBS volumes that are used for PVs are encrypted-at-rest by default. [id="rosa-sdpolicy-block-storage_{context}"] == Block storage (RWO) -Persistent volumes (PVs) are backed by AWS EBS, which is Read-Write-Once. +Persistent volumes (PVs) are backed by Amazon Elastic Block Store (Amazon EBS), which is Read-Write-Once. PVs can be attached only to a single node at a time and are specific to the availability zone in which they were provisioned. However, PVs can be attached to any node in the availability zone. @@ -27,4 +27,4 @@ Each cloud provider has its own limits for how many PVs can be attached to a sin == Shared Storage (RWX) -The AWS CSI Driver can be used to provide RWX support for {product-title}. A community Operator is provided to simplify setup. See link:https://access.redhat.com/articles/5025181[AWS EFS Setup for OpenShift Dedicated and Red Hat OpenShift Service on AWS] for details. +The AWS CSI Driver can be used to provide RWX support for {product-title}. A community Operator is provided to simplify setup. See link:https://access.redhat.com/articles/5025181[Amazon Elastic File Storage Setup for OpenShift Dedicated and Red Hat OpenShift Service on AWS] for details. diff --git a/modules/storage-create-storage-class.adoc b/modules/storage-create-storage-class.adoc index 47ffd27d51c1..c42f0daa891d 100644 --- a/modules/storage-create-storage-class.adoc +++ b/modules/storage-create-storage-class.adoc @@ -19,7 +19,7 @@ usages. By defining a storage class, users can obtain dynamically provisioned persistent volumes. ifeval::["{Provisioner}" == "efs.csi.aws.com"] -The _AWS EFS CSI Driver Operator_, after being installed, does not create a storage class by default. However, you can manually create the AWS EFS storage class. +The _link:https://github.com/openshift/aws-efs-csi-driver-operator[AWS EFS CSI Driver Operator] (a Red Hat operator)_, after being installed, does not create a storage class by default. However, you can manually create the AWS EFS storage class. endif::[] diff --git a/modules/storage-persistent-storage-block-volume.adoc b/modules/storage-persistent-storage-block-volume.adoc index 054cea7bb65a..a9f05b0e6c57 100644 --- a/modules/storage-persistent-storage-block-volume.adoc +++ b/modules/storage-persistent-storage-block-volume.adoc @@ -28,8 +28,8 @@ The following table displays which volume plugins support block volumes. |=== |Volume Plugin |Manually provisioned |Dynamically provisioned |Fully supported |AliCloud Disk | ✅ | ✅ | ✅ -|AWS EBS | ✅ | ✅ | ✅ -|AWS EFS | | | +|Amazon Elastic Block Store (Amazon EBS) | ✅ | ✅ | ✅ +|Amazon Elastic File Storage (Amazon EFS) | | | ifndef::openshift-dedicated,openshift-rosa[] |Azure Disk | ✅ | ✅ | ✅ |Azure File | | | diff --git a/modules/storage-persistent-storage-lifecycle.adoc b/modules/storage-persistent-storage-lifecycle.adoc index 7297ea8a0fe5..b2f7d6b6933f 100644 --- a/modules/storage-persistent-storage-lifecycle.adoc +++ b/modules/storage-persistent-storage-lifecycle.adoc @@ -109,7 +109,7 @@ functionality. * `Delete` reclaim policy deletes both the `PersistentVolume` object from {product-title} and the associated storage asset in external -infrastructure, such as AWS EBS or VMware vSphere. +infrastructure, such as Amazon Elastic Block Store (Amazon EBS) or VMware vSphere. [NOTE] ==== diff --git a/modules/storage-persistent-storage-pv.adoc b/modules/storage-persistent-storage-pv.adoc index b98538fc2bc4..b824b9932f70 100644 --- a/modules/storage-persistent-storage-pv.adoc +++ b/modules/storage-persistent-storage-pv.adoc @@ -173,7 +173,7 @@ endif::[] [.small] -- 1. ReadWriteOnce (RWO) volumes cannot be mounted on multiple nodes. If a node fails, the system does not allow the attached RWO volume to be mounted on a new node because it is already assigned to the failed node. If you encounter a multi-attach error message as a result, force delete the pod on a shutdown or crashed node to avoid data loss in critical workloads, such as when dynamic persistent volumes are attached. -2. Use a recreate deployment strategy for pods that rely on AWS EBS. +2. Use a recreate deployment strategy for pods that rely on Amazon EBS. ifndef::openshift-dedicated,openshift-rosa[] 3. If the underlying vSphere environment supports the vSAN file service, then the vSphere Container Storage Interface (CSI) Driver Operator installed by {product-title} supports provisioning of ReadWriteMany (RWX) volumes. If you do not have vSAN file service configured, and you request RWX, the volume fails to get created and an error is logged. For more information, see "Using Container Storage Interface" -> "VMware vSphere CSI Driver Operator". diff --git a/modules/storage-persistent-storage-reclaim-manual.adoc b/modules/storage-persistent-storage-reclaim-manual.adoc index 7c11c96a06d2..e8132a570509 100644 --- a/modules/storage-persistent-storage-reclaim-manual.adoc +++ b/modules/storage-persistent-storage-reclaim-manual.adoc @@ -33,7 +33,7 @@ ifdef::openshift-dedicated[] The associated storage asset in the external infrastructure, such as an AWS EBS or GCE PD volume, still exists after the PV is deleted. endif::openshift-dedicated[] ifdef::openshift-rosa[] -The associated storage asset in the external infrastructure, such as an AWS EBS volume, still exists after the PV is deleted. +The associated storage asset in the external infrastructure, such as an Amazon Elastic Block Store (Amazon EBS) volume, still exists after the PV is deleted. endif::openshift-rosa[] . Clean up the data on the associated storage asset. diff --git a/storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc b/storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc index c609ef9b2caa..092e56638ff1 100644 --- a/storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc +++ b/storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc @@ -9,12 +9,12 @@ toc::[] [IMPORTANT] ==== -This procedure is specific to the Amazon Web Services Elastic File System (AWS EFS) CSI Driver Operator, which is only applicable for {product-title} 4.10 and later versions. +This procedure is specific to the link:https://github.com/openshift/aws-efs-csi-driver-operator[AWS EFS CSI Driver Operator] (a Red Hat operator), which is only applicable for {product-title} 4.10 and later versions. ==== == Overview -{product-title} is capable of provisioning persistent volumes (PVs) using the Container Storage Interface (CSI) driver for AWS Elastic File Service (EFS). +{product-title} is capable of provisioning persistent volumes (PVs) using the link:https://github.com/openshift/aws-efs-csi-driver[AWS EFS CSI driver]. Familiarity with link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html-single/storage/index#persistent-storage-overview_understanding-persistent-storage[persistent storage] and link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html-single/storage/index#persistent-storage-csi[configuring CSI volumes] is recommended when working with a CSI Operator and driver. @@ -28,7 +28,7 @@ This eliminates the need for cluster administrators to pre-provision storage. [NOTE] ==== -AWS EFS only supports regional volumes, not zonal volumes. +Amazon Elastic File Storage (Amazon EFS) only supports regional volumes, not zonal volumes. ==== include::modules/persistent-storage-csi-about.adoc[leveloffset=+1] @@ -39,7 +39,7 @@ include::modules/persistent-storage-efs-csi-driver-operator-setup.adoc[leveloffs include::modules/persistent-storage-csi-olm-operator-install.adoc[leveloffset=+2] .Next steps ifdef::openshift-rosa[] -* 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/osd-persistent-storage-aws-efs-csi.adoc#efs-sts_osd-persistent-storage-aws-efs-csi[Configuring {FeatureName} CSI Driver with STS]. +* If you are using Amazon EFS with AWS Secure Token Service (STS), you must configure the {FeatureName} CSI driver with STS. For more information, see xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#efs-sts_osd-persistent-storage-aws-efs-csi[Configuring {FeatureName} CSI Driver with STS]. endif::openshift-rosa[] ifdef::openshift-dedicated[] * xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#persistent-storage-csi-efs-driver-install_osd-persistent-storage-aws-efs-csi[Installing the {FeatureName} CSI Driver] @@ -65,17 +65,17 @@ include::modules/storage-create-storage-class-cli.adoc[leveloffset=+2] include::modules/persistent-storage-csi-efs-create-volume.adoc[leveloffset=+1] include::modules/persistent-storage-csi-dynamic-provisioning-aws-efs.adoc[leveloffset=+1] -If you have problems setting up dynamic provisioning, see xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#efs-troubleshooting_osd-persistent-storage-aws-efs-csi[{FeatureName} troubleshooting]. +If you have problems setting up dynamic provisioning, see xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#efs-troubleshooting_osd-persistent-storage-aws-efs-csi[Amazon Elastic File Storage troubleshooting]. [role="_additional-resources"] .Additional resources -* xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#efs-create-volume_osd-persistent-storage-aws-efs-csi[Creating and configuring access to {FeatureName} volume(s)] +* xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#efs-create-volume_osd-persistent-storage-aws-efs-csi[Creating and configuring access to Amazon EFS volume(s)] * xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#storage-create-storage-class_osd-persistent-storage-aws-efs-csi[Creating the {FeatureName} storage class] // Undefine {StorageClass} attribute, so that any mistakes are easily spotted :!StorageClass: include::modules/persistent-storage-csi-efs-static-pv.adoc[leveloffset=+1] -If you have problems setting up static PVs, see xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#efs-troubleshooting_osd-persistent-storage-aws-efs-csi[{FeatureName} troubleshooting]. +If you have problems setting up static PVs, see xref:../../storage/container_storage_interface/osd-persistent-storage-aws-efs-csi.adoc#efs-troubleshooting_osd-persistent-storage-aws-efs-csi[Amazon Elastic File Storage troubleshooting]. include::modules/persistent-storage-csi-efs-security.adoc[leveloffset=+1] diff --git a/storage/container_storage_interface/persistent-storage-csi-ebs.adoc b/storage/container_storage_interface/persistent-storage-csi-ebs.adoc index d6edbc58bd3d..6a3198ae4abb 100644 --- a/storage/container_storage_interface/persistent-storage-csi-ebs.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-ebs.adoc @@ -8,13 +8,13 @@ toc::[] == Overview -{product-title} is capable of provisioning persistent volumes (PVs) using the Container Storage Interface (CSI) driver for AWS Elastic Block Store (EBS). +{product-title} is capable of provisioning persistent volumes (PVs) using the link:https://github.com/openshift/aws-ebs-csi-driver[AWS EBS CSI driver]. Familiarity with xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] and xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[configuring CSI volumes] is recommended when working with a Container Storage Interface (CSI) Operator and driver. -To create CSI-provisioned PVs that mount to AWS EBS storage assets, {product-title} installs the AWS EBS CSI Driver Operator and the AWS EBS CSI driver by default in the `openshift-cluster-csi-drivers` namespace. +To create CSI-provisioned PVs that mount to AWS EBS storage assets, {product-title} installs the link:https://github.com/openshift/aws-ebs-csi-driver-operator[AWS EBS CSI Driver Operator] (a Red Hat operator) and the AWS EBS CSI driver by default in the `openshift-cluster-csi-drivers` namespace. -* The _AWS EBS CSI Driver Operator_ provides a StorageClass by default that you can use to create PVCs. You can disable this default storage class if desired (see xref:../../storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc#persistent-storage-csi-sc-manage[Managing the default storage class]). You also have the option to create the AWS EBS StorageClass as described in xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using AWS Elastic Block Store]. +* The _AWS EBS CSI Driver Operator_ provides a StorageClass by default that you can use to create PVCs. You can disable this default storage class if desired (see xref:../../storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc#persistent-storage-csi-sc-manage[Managing the default storage class]). You also have the option to create the AWS EBS StorageClass as described in xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using Amazon Elastic Block Store]. * The _AWS EBS CSI driver_ enables you to create and mount AWS EBS PVs. @@ -29,10 +29,10 @@ include::modules/persistent-storage-csi-about.adoc[leveloffset=+1] [IMPORTANT] ==== -{product-title} defaults to using the CSI plugin to provision AWS EBS storage. +{product-title} defaults to using the CSI plugin to provision Amazon Elastic Block Store (Amazon EBS) storage. ==== -For information about dynamically provisioning AWS EBS persistent volumes in {product-title}, see xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using AWS Elastic Block Store]. +For information about dynamically provisioning AWS EBS persistent volumes in {product-title}, see xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using Amazon Elastic Block Store]. ifndef::openshift-rosa,openshift-dedicated[] include::modules/persistent-storage-byok.adoc[leveloffset=+1] @@ -42,10 +42,10 @@ include::modules/persistent-storage-byok.adoc[leveloffset=+1] If there is no encrypted key defined in the storage class, only set `encrypted: "true"` in the storage class. The AWS EBS CSI driver uses the AWS managed alias/aws/ebs, which is created by Amazon EBS automatically in each region by default to encrypt provisioned storage volumes. In addition, the managed storage classes all have the `encrypted: "true"` setting. ==== -For information about installing with user-managed encryption for AWS EBS, see xref:../../installing/installing_aws/installing-aws-customizations.adoc#installation-configuration-parameters_installing-aws-customizations[Installation configuration parameters]. +For information about installing with user-managed encryption for Amazon EBS, see xref:../../installing/installing_aws/installing-aws-customizations.adoc#installation-configuration-parameters_installing-aws-customizations[Installation configuration parameters]. endif::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] -== Additional resources -* xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using AWS Elastic Block Store] +.Additional resources +* xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using Amazon Elastic Block Store] * xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes] diff --git a/storage/persistent_storage/persistent-storage-aws.adoc b/storage/persistent_storage/persistent-storage-aws.adoc index e73692771885..e281e1776a78 100644 --- a/storage/persistent_storage/persistent-storage-aws.adoc +++ b/storage/persistent_storage/persistent-storage-aws.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] ifdef::openshift-rosa,openshift-dedicated[] -{product-title} clusters are prebuilt with four storage classes that use AWS Elastic Block Store (EBS) volumes. These storage classes are ready to use and some familiarity with Kubernetes and AWS is assumed. +{product-title} clusters are prebuilt with four storage classes that use Amazon Elastic Block Store (Amazon EBS) volumes. These storage classes are ready to use and some familiarity with Kubernetes and AWS is assumed. Following are the four prebuilt storage classes: [options="header"] @@ -29,7 +29,7 @@ The gp3 storage class is set as default; however, you can select any of the stor endif::openshift-rosa,openshift-dedicated[] ifndef::openshift-rosa,openshift-dedicated[] -{product-title} supports AWS Elastic Block Store volumes (EBS). +{product-title} supports Amazon Elastic Block Store (EBS) volumes. You can provision your {product-title} cluster with persistent storage by using link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html[Amazon EC2]. endif::openshift-rosa,openshift-dedicated[] @@ -38,7 +38,7 @@ You can dynamically provision Amazon EBS volumes. Persistent volumes are not bound to a single project or namespace; they can be shared across the {product-title} cluster. Persistent volume claims are specific to a project or namespace and can be requested by users. You can define a KMS key to encrypt container-persistent volumes on AWS. -By default, newly created clusters using {product-title} version 4.10 and later use gp3 storage and the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver. +By default, newly created clusters using {product-title} version 4.10 and later use gp3 storage and the link:https://github.com/openshift/aws-ebs-csi-driver[AWS EBS CSI driver]. [IMPORTANT] ====