What is Appsmith, and How to Deploy It in an Enterprise Data Stack?

Deployment Runbook

Step 1 — Confirm cluster access

Run:

export KUBECONFIG=/path/to/customer-kubeconfig
export KUBE_CONTEXT=<customer-context>

kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" config current-context
kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" get nodes
kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" get namespace hyperplane-appsmith || kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" create namespace hyperplane-appsmith


Step 2 — Clone the Shakudo chart

Run:

git clone --depth=1 --branch <release-branch> <https://github.com/devsentient/monorepo.git> /tmp/monorepo
cd /tmp/monorepo/stack-components/appsmith/helm
helm dependency update .


Step 3 — Create required secrets

Run:

kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" create secret generic appsmith-secrets -n hyperplane-appsmith --from-literal=APPSMITH_ENCRYPTION_PASSWORD='<strong-password>' --from-literal=APPSMITH_ENCRYPTION_SALT='<strong-salt>'


Step 4 — Prepare values.yaml

Run:

cat > /tmp/appsmith-values.yaml <<'EOF_VALUES'
appsmith:
 image:
   tag: <approved-version>
 applicationConfig:
   APPSMITH_SIGNUP_DISABLED: "true"
   APPSMITH_DISABLE_TELEMETRY: "true"
   APPSMITH_ENCRYPTION_PASSWORD: "<from-secret>"
   APPSMITH_ENCRYPTION_SALT: "<from-secret>"
   APPSMITH_CUSTOM_DOMAIN: "https://appsmith.<customer-domain>"
 persistence:
   enabled: true
   size: 20Gi
 resources:
   requests:
     cpu: 500m
     memory: 1Gi
   limits:
     cpu: 2
     memory: 4Gi
EOF_VALUES


Step 5 — Deploy or upgrade

Run:

helm --kubeconfig "$KUBECONFIG" --kube-context "$KUBE_CONTEXT" upgrade --install appsmith /tmp/monorepo/stack-components/appsmith/helm \\
 --namespace hyperplane-appsmith \\
 --create-namespace \\
 --values /tmp/appsmith-values.yaml \\
 --timeout 15m \\
 --wait


Step 6 — Validate Kubernetes resources

Run:

helm --kubeconfig "$KUBECONFIG" --kube-context "$KUBE_CONTEXT" status appsmith -n hyperplane-appsmith
kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" get pods,svc,pvc,ingress,virtualservice -n hyperplane-appsmith
kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" get events -n hyperplane-appsmith --sort-by=.lastTimestamp | tail -n 60
kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" logs -n hyperplane-appsmith -l app.kubernetes.io/instance=appsmith --tail=100


Step 7 — Smoke test the service

Run:

kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" port-forward -n hyperplane-appsmith svc/appsmith 8080:80

# In another terminal:
curl -I <http://localhost:8080>


Rollback

Run:

‍
helm --kubeconfig "$KUBECONFIG" --kube-context "$KUBE_CONTEXT" history appsmith -n hyperplane-appsmith
helm --kubeconfig "$KUBECONFIG" --kube-context "$KUBE_CONTEXT" rollback appsmith <REVISION> -n hyperplane-appsmith
kubectl --kubeconfig "$KUBECONFIG" --context "$KUBE_CONTEXT" rollout status deployment/appsmith -n hyperplane-appsmith || true