mirror of
https://github.com/ToolJet/ToolJet
synced 2026-05-24 01:18:23 +00:00
Merge pull request #10570 from ToolJet/docs/update-eks-setup
[docs:] Add kubernetes eks setup
This commit is contained in:
Adish M
GitHub
commit
938c5f1fc0
7 changed files with 163 additions and 0 deletions
53
docs/docs/setup/kubernetes-eks.md
Normal file
53
docs/docs/setup/kubernetes-eks.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
id: kubernetes-eks
|
||||
title: Kubernetes (EKS)
|
||||
---
|
||||
|
||||
Follow the steps below to deploy ToolJet on an EKS Kubernetes cluster.
|
||||
|
||||
:::info
|
||||
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](https://docs.tooljet.com/docs/setup/system-requirements#database-software)
|
||||
:::
|
||||
|
||||
1. Create an EKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html).
|
||||
|
||||
2. 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](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
|
||||
3. Create a Kubernetes service to publish the Kubernetes deployment that you have created. We have a [template](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/service.yaml) for exposing the ToolJet server as a service using an AWS Load Balancer.
|
||||
|
||||
**Example:**
|
||||
- [Application load balancing on Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html)
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration.
|
||||
|
||||
1. 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](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/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 at least 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.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
|
@ -60,6 +60,7 @@ const sidebars = {
|
|||
'setup/kubernetes',
|
||||
'setup/kubernetes-gke',
|
||||
'setup/kubernetes-aks',
|
||||
'setup/kubernetes-eks',
|
||||
'setup/azure-container',
|
||||
'setup/google-cloud-run',
|
||||
'setup/client',
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@ export const DocsCard = ({ label, imgSrc, link, height = 40, width = 40, title }
|
|||
Kubernetes: "Deploy ToolJet on a Kubernetes cluster",
|
||||
"Kubernetes (GKE)": "Deploy ToolJet on a GKE Kubernetes cluster",
|
||||
"Kubernetes (AKS)": "Deploy ToolJet on a AKS Kubernetes cluster",
|
||||
"Kubernetes (EKS)": "Deploy ToolJet on a EKS Kubernetes cluster",
|
||||
"Azure container apps": "Deploy ToolJet on a Azure Container Apps",
|
||||
"Google Cloud Run": "Deploy ToolJet on Cloud Run with GCloud CLI",
|
||||
"Deploying ToolJet client": "Deploy ToolJet Client on static website hosting services",
|
||||
|
|
|
|||
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
id: kubernetes-eks
|
||||
title: Kubernetes (EKS)
|
||||
---
|
||||
|
||||
Follow the steps below to deploy ToolJet on an EKS Kubernetes cluster.
|
||||
|
||||
:::info
|
||||
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](https://docs.tooljet.com/docs/setup/system-requirements#database-software)
|
||||
:::
|
||||
|
||||
1. Create an EKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html).
|
||||
|
||||
2. 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](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
|
||||
3. Create a Kubernetes service to publish the Kubernetes deployment that you have created. We have a [template](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/service.yaml) for exposing the ToolJet server as a service using an AWS Load Balancer.
|
||||
|
||||
**Example:**
|
||||
- [Application load balancing on Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html)
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration.
|
||||
|
||||
1. 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](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/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 at least 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.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
53
docs/versioned_docs/version-2.65.0/setup/kubernetes-eks.md
Normal file
53
docs/versioned_docs/version-2.65.0/setup/kubernetes-eks.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
id: kubernetes-eks
|
||||
title: Kubernetes (EKS)
|
||||
---
|
||||
|
||||
Follow the steps below to deploy ToolJet on an EKS Kubernetes cluster.
|
||||
|
||||
:::info
|
||||
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](https://docs.tooljet.com/docs/setup/system-requirements#database-software)
|
||||
:::
|
||||
|
||||
1. Create an EKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html).
|
||||
|
||||
2. 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](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
|
||||
3. Create a Kubernetes service to publish the Kubernetes deployment that you have created. We have a [template](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/service.yaml) for exposing the ToolJet server as a service using an AWS Load Balancer.
|
||||
|
||||
**Example:**
|
||||
- [Application load balancing on Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html)
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration.
|
||||
|
||||
1. 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](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/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 at least 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.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
|
@ -50,6 +50,7 @@
|
|||
"setup/kubernetes",
|
||||
"setup/kubernetes-gke",
|
||||
"setup/kubernetes-aks",
|
||||
"setup/kubernetes-eks",
|
||||
"setup/azure-container",
|
||||
"setup/google-cloud-run",
|
||||
"setup/client",
|
||||
|
|
|
|||
|
|
@ -50,6 +50,7 @@
|
|||
"setup/kubernetes",
|
||||
"setup/kubernetes-gke",
|
||||
"setup/kubernetes-aks",
|
||||
"setup/kubernetes-eks",
|
||||
"setup/azure-container",
|
||||
"setup/google-cloud-run",
|
||||
"setup/client",
|
||||
|
|
|
|||
Loading…
Reference in a new issue