Skip to content

Commit

Permalink
OSDOCS-5793
Browse files Browse the repository at this point in the history
  • Loading branch information
smunje1 authored and openshift-cherrypick-robot committed Aug 16, 2023
1 parent fedfd32 commit 7c14328
Show file tree
Hide file tree
Showing 23 changed files with 56 additions and 59 deletions.
2 changes: 1 addition & 1 deletion modules/dynamic-provisioning-available-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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/<cluster_name>,Value=<cluster_id>`
Expand Down
1 change: 0 additions & 1 deletion modules/dynamic-provisioning-storage-class-definition.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
4 changes: 2 additions & 2 deletions modules/osd-persistent-storage-csi-efs-sts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion modules/persistent-storage-csi-efs-driver-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions modules/persistent-storage-csi-efs-security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions modules/persistent-storage-csi-efs-static-pv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions modules/persistent-storage-csi-efs-troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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:
+
Expand Down
4 changes: 2 additions & 2 deletions modules/persistent-storage-csi-olm-operator-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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*.
Expand Down
4 changes: 2 additions & 2 deletions modules/persistent-storage-csi-olm-operator-uninstall.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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]
====
Expand Down
4 changes: 2 additions & 2 deletions modules/persistent-storage-efs-csi-driver-operator-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions modules/rosa-aws-provisioned.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
12 changes: 5 additions & 7 deletions modules/rosa-policy-shared-responsibility.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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**
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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**
Expand Down
2 changes: 1 addition & 1 deletion modules/rosa-sdpolicy-am-regions-az.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
6 changes: 3 additions & 3 deletions modules/rosa-sdpolicy-storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ 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
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.

Each cloud provider has its own limits for how many PVs can be attached to a single node. See link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/volume_limits.html#instance-type-volume-limits[AWS instance type limits] for details.

== 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.
2 changes: 1 addition & 1 deletion modules/storage-create-storage-class.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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::[]


Expand Down
4 changes: 2 additions & 2 deletions modules/storage-persistent-storage-block-volume.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 | | |
Expand Down
2 changes: 1 addition & 1 deletion modules/storage-persistent-storage-lifecycle.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
2 changes: 1 addition & 1 deletion modules/storage-persistent-storage-pv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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".
Expand Down
2 changes: 1 addition & 1 deletion modules/storage-persistent-storage-reclaim-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit 7c14328

Please sign in to comment.