Amazon EFS CSI Driver

Overview

Amazon Elastic File System (Amazon EFS) provides serverless, fully elastic file storage so that you can share file data without provisioning or managing storage capacity and performance.

S3 Files is a shared file system that connects any AWS compute directly with your data in Amazon S3. It provides fast, direct access to all of your S3 data as files with full file system semantics and low-latency performance, without your data ever leaving S3. That means file-based applications, agents, and teams can access and work with S3 data as a file system using the tools they already depend on.

The Amazon EFS Container Storage Interface (CSI) driver allows Kubernetes clusters running on AWS to mount Amazon EFS and Amazon S3 file systems starting with version 3.0.0 or above as persistent volumes. The client includes a mount helper program that simplifies mounting Amazon EFS and Amazon S3 file systems and enables Amazon CloudWatch metrics to monitor your file system's mount status.

Note: The latest release version may not include the most recent code changes in master branch. Please check the changelog for updates included in the corresponding release versions.

Features

Amazon EFS CSI driver supports dynamic provisioning and static provisioning.

• Static provisioning - Amazon EFS file system or Amazon S3 file system needs to be created manually first, then it can be mounted inside a container as a persistent volume (PV) using the driver.
• Dynamic provisioning - Uses a persistent volume claim (PVC) to dynamically provision a persistent volume (PV). On creating a PVC, Kubernetes requests an Amazon EFS or Amazon S3 file system to create an access point in a file system which will be used to mount the PV.
• Mount options - Mount options can be specified in the persistent volume (PV) or storage class for dynamic provisioning to define how the volume should be mounted.
• Encryption of data in transit - Amazon EFS and Amazon S3 file systems are mounted with encryption in transit enabled by default in the master branch version of the driver.
• Cross account mount (Amazon EFS only) - Amazon EFS file systems from different AWS accounts can be mounted from an Amazon EKS cluster, with three provisioning modes: efs-utils DNS resolution (crossaccount=true), pinned-AZ mount target (az parameter), and a per-node AZ→IP map for AZ resilience without DNS prerequisites. See the cross-account mount example and parameters reference.
• Multiarch - Amazon EFS CSI driver image is now multiarch on ECR

The following CSI interfaces are implemented:

• Controller Service: CreateVolume, DeleteVolume, ControllerGetCapabilities, ValidateVolumeCapabilities
• Node Service: NodePublishVolume, NodeUnpublishVolume, NodeGetCapabilities, NodeGetInfo, NodeGetId, NodeGetVolumeStats
• Identity Service: GetPluginInfo, GetPluginCapabilities, Probe

Note When using static provisioning with an Amazon S3 file system, the volumeHandle in your PersistentVolume must include the s3files: prefix (e.g., s3files:fs-01234567890abcdef0).

Note Amazon EFS volumeHandles do not need a filesystem-type prefix. The driver accepts both fs-01234567890abcdef0 and efs:fs-01234567890abcdef0, and emits the un-prefixed form for dynamically provisioned volumes so that handles stay usable by consumers predating the typed format. Driver versions v3.0.0 through v3.4.2 emitted efs:-prefixed handles instead. Because spec.csi.volumeHandle is immutable, a PersistentVolume provisioned by one of those versions keeps its prefix and has to be recreated to take the un-prefixed form.

Note Do not install amazon-efs-utils directly on EKS worker nodes. The EFS CSI driver already packages efs-utils within its containers and manages the mount process. Installing efs-utils at the node level can cause unexpected mount behavior.

Note Amazon EFS and S3 Files are fully elastic and scalable file systems which automatically scale up or down based on usage, so there is no need to manage capacity. The actual storage capacity value in persistent volume and persistent volume claim is a placeholder value that must be specified (required by Kubernetes) but is not actually used. You can specify any valid value for the capacity.

For detailed parameter explanations, see the parameters documentation.

Releases

The EFS CSI Driver follows semantic versioning. The version MAJOR.MINOR.PATCH will be bumped following the rules below after v2.2.0:

• Significant breaking changes will be released as a MAJOR update.
• New features will be released as a MINOR update.
• Bug or vulnerability fixes will be released as a PATCH update.

Latest ECR Image

Note
You can find previous efs-csi-driver versions' images from here

Documentation

• Parameters/Features
• Driver Installation
• Driver Upgrade
• Driver Uninstallation
• Kubernetes Examples
• Fips Support
• Compatibility Matrix
• Frequently Asked Questions
• Design Doc
• Development and Contributing