mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
121 lines
6.2 KiB
Plaintext
121 lines
6.2 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="persistent-storage-csi-aws-efs"]
|
|
= AWS Elastic File Service CSI Driver Operator
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: persistent-storage-csi-aws-efs
|
|
|
|
toc::[]
|
|
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
[IMPORTANT]
|
|
====
|
|
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.
|
|
====
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
== Overview
|
|
|
|
{product-title} is capable of provisioning persistent volumes (PVs) using the Container Storage Interface (CSI) driver for AWS Elastic File Service (EFS).
|
|
|
|
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 CSI Operator and driver.
|
|
|
|
After installing the AWS EFS CSI Driver Operator, {product-title} installs the AWS EFS CSI Operator and the AWS EFS CSI driver by default in the `openshift-cluster-csi-drivers` namespace. This allows the AWS EFS CSI Driver Operator to create CSI-provisioned PVs that mount to AWS EFS assets.
|
|
|
|
* The _AWS EFS CSI Driver Operator_, after being installed, does not create a storage class by default to use to create persistent volume claims (PVCs). However, you can manually create the AWS EFS `StorageClass`.
|
|
The AWS EFS CSI Driver Operator supports dynamic volume provisioning by allowing storage volumes to be created on-demand.
|
|
This eliminates the need for cluster administrators to pre-provision storage.
|
|
|
|
* The _AWS EFS CSI driver_ enables you to create and mount AWS EFS PVs.
|
|
|
|
include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
|
|
|
|
:FeatureName: AWS EFS
|
|
include::modules/persistent-storage-efs-csi-driver-operator-setup.adoc[leveloffset=+1]
|
|
|
|
// Obtaining a role ARN (OCP)
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
include::modules/persistent-storage-csi-efs-sts.adoc[leveloffset=+2]
|
|
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// Obtaining a role ARN (OSD and ROSA)
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
include::modules/sd-persistent-storage-csi-efs-sts.adoc[leveloffset=+2]
|
|
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
.Next steps
|
|
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].
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* 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]
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[Configuring the Cloud Credential Operator utility]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* 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]
|
|
|
|
include::modules/persistent-storage-csi-olm-operator-install.adoc[leveloffset=+2]
|
|
|
|
.Next steps
|
|
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].
|
|
|
|
include::modules/persistent-storage-csi-efs-driver-install.adoc[leveloffset=+2]
|
|
|
|
:StorageClass: AWS EFS
|
|
:Provisioner: efs.csi.aws.com
|
|
include::modules/storage-create-storage-class.adoc[leveloffset=+1]
|
|
|
|
include::modules/storage-create-storage-class-console.adoc[leveloffset=+2]
|
|
|
|
include::modules/storage-create-storage-class-cli.adoc[leveloffset=+2]
|
|
|
|
include::modules/persistent-storage-csi-efs-cross-account.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* link:https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-output-format.html[Setting the output format in the AWS CLI]
|
|
|
|
== One Zone file systems
|
|
|
|
include::modules/persistent-storage-csi-efs-one-zone-overview.adoc[leveloffset=+2]
|
|
|
|
include::modules/persistent-storage-csi-efs-one-zone-procedure.adoc[leveloffset=+2]
|
|
|
|
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/persistent-storage-csi-aws-efs.adoc#efs-troubleshooting_persistent-storage-csi-aws-efs[AWS EFS troubleshooting].
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#storage-create-storage-class_persistent-storage-csi-aws-efs[Creating the AWS EFS 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/persistent-storage-csi-aws-efs.adoc#efs-troubleshooting_persistent-storage-csi-aws-efs[AWS EFS troubleshooting].
|
|
|
|
include::modules/persistent-storage-csi-efs-security.adoc[leveloffset=+1]
|
|
|
|
== AWS EFS storage CSI usage metrics
|
|
include::modules/persistent-storage-csi-efs-metrics-overview.adoc[leveloffset=+2]
|
|
|
|
//:FeatureName: AWS EFS usage metrics
|
|
// Commenting this out for now because we anticipate GA status.
|
|
// include::snippets/technology-preview.adoc[leveloffset=+2]
|
|
|
|
include::modules/persistent-storage-csi-efs-metrics-procedure-gui.adoc[leveloffset=+2]
|
|
|
|
include::modules/persistent-storage-csi-efs-metrics-procedure-cli.adoc[leveloffset=+2]
|
|
|
|
include::modules/persistent-storage-csi-efs-troubleshooting.adoc[leveloffset=+1]
|
|
|
|
:FeatureName: AWS EFS
|
|
include::modules/persistent-storage-csi-olm-operator-uninstall.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
== Additional resources
|
|
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]
|