AWS Documentation » Amazon EKS » User Guide » Storage » Storage Classes

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Storage Classes

Amazon EKS clusters that were created prior to Kubernetes version 1.11 were not created with any storage classes. You must define storage classes for your cluster to use and you should define a default storage class for your persistent volume claims. For more information, see Storage Classes in the Kubernetes documentation.

Note

This topic uses the in-tree Amazon EBS storage provisioner. For Kubernetes 1.14 and above clusters, the Amazon EBS CSI Driver is available for managing storage. The existing in-tree Amazon EBS plugin is still supported, but by using a CSI driver, you benefit from the decoupling of Kubernetes upstream release cycle and CSI driver release cycle. Eventually, the in-tree plugin will be deprecated in favor of the CSI driver.

To create an AWS storage class for your Amazon EKS cluster

1. Create an AWS storage class manifest file for your storage class. The gp2-storage-class.yaml example below defines a storage class called gp2 that uses the Amazon EBS gp2 volume type.

   For more information about the options available for AWS storage classes, see AWS EBS in the Kubernetes documentation.

   kind: StorageClass
   apiVersion: storage.k8s.io/v1
   metadata:
     name: gp2
     annotations:
       storageclass.kubernetes.io/is-default-class: "true"
   provisioner: kubernetes.io/aws-ebs
   parameters:
     type: gp2
     fsType: ext4 

2. Use kubectl to create the storage class from the manifest file.

   kubectl create -f gp2-storage-class.yaml

   Output:

   storageclass "gp2" created

To define a default storage class

1. List the existing storage classes for your cluster. A storage class must be defined before you can set it as a default.

   kubectl get storageclass

   Output:

   NAME      PROVISIONER             AGE
   gp2       kubernetes.io/aws-ebs   8m

2. Choose a storage class and set it as your default by setting the storageclass.kubernetes.io/is-default-class=true annotation.

   kubectl patch storageclass gp2 -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'

   Output:

   storageclass "gp2" patched

3. Verify that the storage class is now set as default.

   kubectl get storageclass

   Output:

   gp2 (default)   kubernetes.io/aws-ebs   12m