ToolJet/docs/versioned_docs/version-2.0.0-beta/setup/kubernetes-aks.md
Akshay 7335a0c303
Chore: k8s v2 revision (#5122)
* revise postgrest setups as optional

* add quotes

* update docs

* update comment

* move docs to v2 version

* update docs

* revert unrelated changes

* update postgrest host placeholder
2023-01-02 13:10:17 +05:30

2.6 KiB

id title
kubernetes-aks 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.

  2. Create k8s deployment

     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.

:::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 inorder expose it via a service load balancer as mentioned in the doc. You can refer service.yaml.

     curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/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.

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

ToolJet Database

If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please follow the instructions here for additional environment variables configuration to be done.

  1. Setup PostgREST server

     kubectl apply -f https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/kubernetes/GKE/postgrest.yaml
    
  2. Update ToolJet deployment with the appropriate env variables here and apply the changes.