mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 22:17:55 +00:00
467b102e98
* [docs]: Slack URL Update * add script, fix ul error, fix title case nav bar * [docs]: Text Area Component * discard Text Area Component
89 lines
3.9 KiB
Markdown
89 lines
3.9 KiB
Markdown
---
|
|
id: kubernetes-aks
|
|
title: Kubernetes (AKS)
|
|
---
|
|
|
|
# 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](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal).
|
|
|
|
2. Create k8s deployment
|
|
|
|
```bash
|
|
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/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](/docs/setup/env-vars).
|
|
|
|
:::info
|
|
For the setup, ToolJet requires:
|
|
|
|
<ul>
|
|
- **TOOLJET_DB**
|
|
- **TOOLJET_DB_HOST**
|
|
- **TOOLJET_DB_USER**
|
|
- **TOOLJET_DB_PASS**
|
|
- **PG_HOST**
|
|
- **PG_DB**
|
|
- **PG_USER**
|
|
- **PG_PASS**
|
|
- **SECRET_KEY_BASE**
|
|
- **LOCKBOX_KEY**
|
|
</ul>
|
|
<br/>
|
|
Read **[environment variables reference](/docs/setup/env-vars)**
|
|
:::
|
|
|
|
:::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.
|
|
:::
|
|
|
|
3. Create k8s service and reserve a static IP and expose it via a service load balancer as mentioned in the [doc](https://docs.microsoft.com/en-us/azure/aks/static-ip). You can refer `service.yaml`.
|
|
|
|
```bash
|
|
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/AKS/service.yaml
|
|
```
|
|
|
|
4. Apply YAML configs
|
|
|
|
```bash
|
|
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 the ToolJet Database, you need to set up and deploy a PostgREST server, which facilitates querying the database. Detailed setup instructions are available [here](/docs/tooljet-db/tooljet-database).
|
|
|
|
Starting with ToolJet 3.0, deploying the ToolJet Database is mandatory to avoid migration issues. Refer to the documentation below for details on the new major version, including breaking changes and required adjustments for your applications.
|
|
|
|
- [ToolJet 3.0 Migration Guide for Self-Hosted Versions](./upgrade-to-v3.md)
|
|
|
|
1. Setup PostgREST server
|
|
|
|
```bash
|
|
kubectl apply -f https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/GKE/postgrest.yaml
|
|
```
|
|
|
|
2. Update ToolJet deployment with the appropriate env variables [here](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/GKE/deployment.yaml) 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 atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) 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](https://join.slack.com/t/tooljet/shared_invite/zt-2rk4w42t0-ZV_KJcWU9VL1BBEjnSHLCA) or send us an email at hello@tooljet.com._
|