Shared storage ¶

This file provides examples on how a Kubernetes cluster and helm deployment can be configured to utilize an AWS EFS backed filesystem.

Static provisioning ¶

An example detailing how an existing EFS filesystem can be created and consumed using static provisioning.

Prerequisites ¶

1. EFS CSI driver is installed within the k8s cluster.
2. A physical EFS filesystem has been provisioned

Additional details on static EFS provisioning can be found here

You can confirm that the EFS CSI driver has been installed by running:

kubectl get csidriver

NAME              ATTACHREQUIRED   PODINFOONMOUNT   MODES        AGE
efs.csi.aws.com   false            false            Persistent   5d3h

Provisioning ¶

1. Create a Persistent Volume
2. Create a Persistent Volume Claim
3. Update values.yaml to utilise Persistent Volume Claim

1. Create Persistent Volume ¶

Create a persistent volume for the pre-provisioned EFS filesystem by providing the <efs-id>. The EFS id can be identified using the CLI command below with the appropriate region

aws efs describe-file-systems --query "FileSystems[*].FileSystemId" --region ap-southeast-2

apiVersion: v1
kind: PersistentVolume
metadata:
  name: my-shared-vol-pv
spec:
  capacity:
    storage: 1Gi
  volumeMode: Filesystem
  accessModes:
    - ReadWriteMany
  storageClassName: efs-pv
  persistentVolumeReclaimPolicy: Retain
  mountOptions:
    - rw
    - lookupcache=pos
    - noatime
    - intr
    - _netdev
  csi:
    driver: efs.csi.aws.com
    volumeHandle: <efs-id>

2. Create Persistent Volume Claim ¶

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: my-shared-vol-pvc
spec:
  accessModes:
    - ReadWriteMany
  storageClassName: efs-pv
  volumeMode: Filesystem
  volumeName: my-shared-vol-pv
  resources:
    requests:
      storage: 1Gi

3. Update values.yaml ¶

Update the sharedHome claimName value within values.yaml to the name of the Persistent Volume Claim created in step 2 above

volumes:
  sharedHome:
    customVolume:
      persistentVolumeClaim:
        claimName: "my-shared-vol-pvc"

Resources ¶

Some useful resources on provisioning shared storage with the AWS CSI Driver:

• Amazon EFS CSI driver
• Introducing Amazon EFS CSI dynamic provisioning