Skip to main content

Kubernetes (k8s)

This page provides steps to install Appsmith on a Kubernetes cluster using the Helm package manager.

How To Deploy Appsmith On Kubernetes

System requirements​

  • At least 15 GB of free storage space.
  • 4 GB of RAM.

Prerequisites​

  1. Install Helm package manager on your local machine. See the official Helm documentation for your operating system.
  2. Install and configure kubectl to interact with your Kubernetes cluster. Follow the below guides available on the official Kubernetes documentation for instructions on how to install kubectl on your specific operating system:
  3. Set up a Kubernetes cluster and persistent volume on your preferred platform for hosting the Kubernetes cluster. If you are hosting the Kubernetes cluster on AWS-EKS, see Set up Kubernetes cluster on AWS-EKS
  4. Whitelist cs.appsmith.com in your firewall or security group’s outbound rules to ensure proper connectivity to required services.
caution

A persistent volume configuration is required on the Kubernetes cluster before proceeding with the Appsmith installation.

Install Appsmith​

Follow these steps to install Appsmith:

  1. Create a folder named appsmith on your machine for deployment and data storage. Then, navigate to this folder using the cd command.

  1. Add the Appsmith chart repository with:

    helm repo add appsmith-ee https://helm-ee.appsmith.com

  2. Load the Appsmith chart repository with:

    helm repo update

  3. Generate the values.yaml file with:

    helm show values appsmith-ee/appsmith  > values.yaml

  4. Run the below command to deploy Appsmith:

    helm install appsmith-ee appsmith-ee/appsmith -n appsmith-ee --create-namespace -f values.yaml

  5. Get pod name with:

    kubectl get pods -n appsmith-ee

    The above command displays the status of the pods. Proceed to the next step once the pod status is shown as RUNNING.

  6. To access and verify the installation locally, use the below command that forwards the port 8080 to port 80:

    kubectl --namespace appsmith-ee port-forward appsmith-ee-0 8080:80

In the above command, appsmith-ee-0 is the Appsmith pod name.

  1. Open http://localhost:8080 and wait for the server to come up. This can take up to 5 minutes. Once the server is up and running, you can access Appsmith at http://localhost:8080.

  2. Fill in your details to create an administrator account.

  3. Once you've created an account, you can either start with the free plan or activate your instance with a license key. If you want to generate a license key, sign up on customer.appsmith.com to create one, and then proceed to activate your instance using the newly generated license key.

For high availability and scalability configuration, see the Configure High Availability and Scalability guide. To expose Appsmith installation on the internet, see the Expose K8s to Internet guide.

Install Appsmith Community​

To install the Appsmith open source edition (Appsmith Community):

  1. Use the open source helm chart by running the below command which adds the Appsmith chart repository:
helm repo add appsmith https://helm.appsmith.com
  1. Replace appsmith-ee with appsmith in the commands on this page.

Post-installation configuration​

Once you have completed the installation process, consider performing the tasks below to configure and manage your Appsmith instance, enhancing its security and performance, specifically if it's intended for production use.


Set Up High Availability (HA)

Configure high availability and scalability for your Appsmith deployment on Kubernetes to ensure uninterrupted access to your applications.

Expose K8s to Internet

Configure your Appsmith Kubernetes installation to be accessible from the internet, enabling remote access and usage.

Configure Single Sign-on (SSO)

Enable SSO to allow users to log in using your identity provider. Appsmith supports multiple SSO providers through SAML and OpenID protocols.

Configure Email Service

Set up an email service to enable Appsmith to send notifications and alerts. You can use providers such as AWS SES, Gmail, or others.

Troubleshooting​

If you are facing issues during deployment, refer to the guide on troubleshooting deployment errors. If you continue to face issues, contact the support team using the chat widget at the bottom right of this page.

See also​