Skip to main content

Set up Kubernetes Cluster on AWS-EKS

This page provides steps to set up a Kubernetes Cluster with the persistent volume on AWS-EKS.


Ensure you have access to the AWS Command Line Interface (CLI). Use the following command to verify whether you can access information related to your account and ARN. This verification confirms that you can connect to and access your Amazon account using the CLI.

  aws sts get-caller-identity

Create and configure cluster

Follow these steps to create a KubeConfig and define a storage class that automatically generates a persistent volume during installation of Appsmith.

  1. Create KubeConfig with:

    aws eks update-kubeconfig --region ap-south-1 --name CLUSTER_NAME  --profile <PROFILE_NAME>

    In the above command, add the profile name that has access to the AWS-EKS cluster to the --profile parameter.

  2. Test your Kubernetes configuration with:

    kubectl cluster-info

    The above command provides a summary of the current cluster configuration, including the Kubernetes master and other cluster information.

  3. Define a storage class:

    • If your Kubernetes version is prior to 1.23, execute the following command:

      kubectl apply -f - <<EOF
      kind: StorageClass
      name: gp2
    • If your Kubernetes version is 1.23 or later, follow these steps:

      1. Create an IAM role by following the official Amazon documentation on Creating the Amazon EBS CSI driver IAM role.

      2. Add the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver chart repository:

        helm repo add aws-ebs-csi-driver
      3. Update the Amazon EBS CSI driver repository:

        helm repo update
      4. Install the Amazon EBS CSI driver:

        helm upgrade --install aws-ebs-csi-driver --namespace kube-system aws-ebs-csi-driver aws-ebs-csi-driver
      5. Verify the installation of the Amazon EBS CSI driver:

        kubectl get pods -n kube-system -l

Next steps


If you are facing issues contact the support team using the chat widget at the bottom right of this page.