Skip to main content
Version: 3.1.0-Beta 🚧

Deploying ToolJet on Kubernetes (AKS)

info

You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using Azure Database for PostgreSQL since this guide is for deploying using AKS.

Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.

  1. Create an AKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned on the Azure's documentation.

  2. Create k8s deployment

      curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/pre-release/kubernetes/AKS/deployment.yaml

Make sure to edit the environment variables in the deployment.yaml. We advise to use secrets to setup sensitive information. You can check out the available options here.

info

For the setup, ToolJet requires:

    • TOOLJET_DB
    • TOOLJET_DB_HOST
    • TOOLJET_DB_USER
    • TOOLJET_DB_PASS
    • PG_HOST
    • PG_DB
    • PG_USER
    • PG_PASS
    • SECRET_KEY_BASE
    • LOCKBOX_KEY

Read environment variables reference

info

If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that NODE_EXTRA_CA_CERTS environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.

  1. Create k8s service and reserve a static IP and expose it via a service load balancer as mentioned in the doc. You can refer service.yaml.

     curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/pre-release/kubernetes/AKS/service.yaml

  2. Apply YAML configs

     kubectl apply -f deployment.yaml, service.yaml

You will be able to access your ToolJet installation once the pods and services running.

ToolJet Database​

To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please follow the instructions here.

  1. Setup PostgREST server

      kubectl apply -f https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/AKS/postgrest.yaml

  2. Update ToolJet deployment with the appropriate env variables here and apply the changes.

Workflows​

ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.

Create workflow deployment:

kubectl apply -f https://tooljet-deployments.s3.us-west-1.amazonaws.com/pre-release/kubernetes/workflow-deployment.yaml

Note: Ensure that the worker deployment uses the same image as the ToolJet application deployment to maintain compatibility. Additionally, the variables below need to be a part of tooljet-deployment.

ENABLE_WORKFLOW_SCHEDULING=true TOOLJET_WORKFLOWS_TEMPORAL_NAMESPACE=default TEMPORAL_SERVER_ADDRESS=<Temporal_Server_Address>

Upgrading to the Latest LTS Version​

New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the ToolJet Docker Hub page. The LTS tags follow a naming convention with the prefix LTS- followed by the version number, for example tooljet/tooljet:ee-lts-latest.

If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.

Prerequisites for Upgrading to the Latest LTS Version:​

  • It is crucial to perform a comprehensive backup of your database before starting the upgrade process to prevent data loss.

  • Users on versions earlier than v2.23.0-ee2.10.2 must first upgrade to this version before proceeding to the LTS version.

If you have any questions feel free to join our Slack Community or send us an email at [email protected].