Deploy a sample application - Amazon EKS
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Help improve this page

Want to contribute to this user guide? Scroll to the bottom of this page and select Edit this page on GitHub. Your contributions will help make our user guide better for everyone.

Deploy a sample application

You can test the CSI driver functionality with a sample application. This topic shows one example, but you can also do the following:

  • Deploy a sample application that uses the external snapshotter to create volume snapshots. For more information, see Volume Snapshots on GitHub.

  • Deploy a sample application that uses volume resizing. For more information, see Volume Resizing on GitHub.

This procedure uses the Dynamic volume provisioning example from the Amazon EBS Container Storage Interface (CSI) driver GitHub repository to consume a dynamically provisioned Amazon EBS volume.

  1. Clone the Amazon EBS Container Storage Interface (CSI) driver GitHub repository to your local system.

    git clone
  2. Navigate to the dynamic-provisioning example directory.

    cd aws-ebs-csi-driver/examples/kubernetes/dynamic-provisioning/
  3. (Optional) The manifests/storageclass.yaml file provisions gp2 Amazon EBS volumes by default. To use gp3 volumes instead, add type: gp3 to manifests/storageclass.yaml.

    echo "parameters: type: gp3" >> manifests/storageclass.yaml
  4. Deploy the ebs-sc storage class, ebs-claim persistent volume claim, and app sample application from the manifests directory.

    kubectl apply -f manifests/
  5. Describe the ebs-sc storage class.

    kubectl describe storageclass ebs-sc

    An example output is as follows.

    Name:            ebs-sc
    IsDefaultClass:  No
    Parameters:            <none>
    AllowVolumeExpansion:  <unset>
    MountOptions:          <none>
    ReclaimPolicy:         Delete
    VolumeBindingMode:     WaitForFirstConsumer
    Events:                <none>

    The storage class uses the WaitForFirstConsumer volume binding mode. This means that volumes aren't dynamically provisioned until a Pod makes a persistent volume claim. For more information, see Volume Binding Mode in the Kubernetes documentation.

  6. Watch the Pods in the default namespace. After a few minutes, the app Pod's status changes to Running.

    kubectl get pods --watch

    Enter Ctrl+C to return to a shell prompt.

  7. List the persistent volumes in the default namespace. Look for a persistent volume with the default/ebs-claim claim.

    kubectl get pv

    An example output is as follows.

    NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE pvc-37717cd6-d0dc-11e9-b17f-06fad4858a5a 4Gi RWO Delete Bound default/ebs-claim ebs-sc 30s
  8. Describe the persistent volume. Replace pvc-37717cd6-d0dc-11e9-b17f-06fad4858a5a with the value from the output in the previous step.

    kubectl describe pv pvc-37717cd6-d0dc-11e9-b17f-06fad4858a5a

    An example output is as follows.

    Name:              pvc-37717cd6-d0dc-11e9-b17f-06fad4858a5a
    Labels:            <none>
    Finalizers:        [ external-attacher/ebs-csi-aws-com]
    StorageClass:      ebs-sc
    Status:            Bound
    Claim:             default/ebs-claim
    Reclaim Policy:    Delete
    Access Modes:      RWO
    VolumeMode:        Filesystem
    Capacity:          4Gi
    Node Affinity:
      Required Terms:
        Term 0: in [region-code]
        Type:              CSI (a Container Storage Interface (CSI) volume source)
        VolumeHandle:      vol-0d651e157c6d93445
        ReadOnly:          false
    Events:                <none>

    The Amazon EBS volume ID is the value for VolumeHandle in the previous output.

  9. Verify that the Pod is writing data to the volume.

    kubectl exec -it app -- cat /data/out.txt

    An example output is as follows.

    Wed May 5 16:17:03 UTC 2021
    Wed May 5 16:17:08 UTC 2021
    Wed May 5 16:17:13 UTC 2021
    Wed May 5 16:17:18 UTC 2021
  10. After you're done, delete the resources for this sample application.

    kubectl delete -f manifests/