Kubernetes (EKS)
Follow the steps below to deploy ToolJet on an EKS Kubernetes cluster.
You should set up a PostgreSQL database manually to be used by ToolJet. We recommend using an RDS PostgreSQL database. You can find the system requirements here
-
Create an EKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned in the AWS documentation.
-
Create a k8s Deployment:
The file below is just a template and might not suit production environments. You should download the file and configure parameters such as the replica count and environment variables according to your needs.
kubectl apply -f https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/deployment.yaml
Make sure to edit the environment variables in the deployment.yaml
. We advise using secrets to set up sensitive information. You can check out the available options here.
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
- Create a Kubernetes service to publish the Kubernetes deployment that you have created. We have a template for exposing the ToolJet server as a service using an AWS Load Balancer.
Example:
ToolJet Database
To use ToolJet Database, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please follow the instructions here.
- Set up PostgREST server
kubectl apply -f https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/kubernetes/postgrest.yaml
Update ToolJet deployment with the appropriate env variables here and apply the changes.
Upgrading to the Latest LTS Version
New LTS versions are released every 3-5 months with an end-of-life of at least 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].