mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-21 21:47:17 +00:00
67 lines
No EOL
2.9 KiB
Markdown
67 lines
No EOL
2.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.
|
|
:::
|
|
|
|
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
|
|
|
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://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/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](https://docs.tooljet.com/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 inorder 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://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/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.
|
|
|
|
If you want to seed the database with a sample user, please SSH into a pod and run:
|
|
|
|
`npm run db:seed:prod --prefix server`
|
|
|
|
This seeds the database with a default user with the following credentials:
|
|
|
|
**email**: `dev@tooljet.io`
|
|
|
|
**password**: `password`
|
|
|
|
## Upgrading to the Latest Version
|
|
|
|
The latest version includes architectural changes and, hence, comes with new migrations.
|
|
|
|
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 Version:
|
|
|
|
- It is **crucial to perform a comprehensive backup of your database** before starting the upgrade process to prevent data loss.
|
|
|
|
- Ensure that your current version is v2.23.0-ee2.10.2 before upgrading.
|
|
|
|
- Users on versions earlier than v2.23.0-ee2.10.2 must first upgrade to this version before proceeding to the latest version.
|
|
|
|
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**. |