diff --git a/docs/static/img/cloud-run/google-cloud-run-setup-V3.png b/docs/static/img/cloud-run/google-cloud-run-setup-V3.png new file mode 100644 index 0000000000..69165088b9 Binary files /dev/null and b/docs/static/img/cloud-run/google-cloud-run-setup-V3.png differ diff --git a/docs/static/img/cloud-run/ingress-auth-V3.png b/docs/static/img/cloud-run/ingress-auth-V3.png new file mode 100644 index 0000000000..015ef8a1ce Binary files /dev/null and b/docs/static/img/cloud-run/ingress-auth-V3.png differ diff --git a/docs/static/img/cloud-run/postgrest-container.png b/docs/static/img/cloud-run/postgrest-container.png new file mode 100644 index 0000000000..713c59ccb3 Binary files /dev/null and b/docs/static/img/cloud-run/postgrest-container.png differ diff --git a/docs/static/img/cloud-run/postgrest-environment-variables.png b/docs/static/img/cloud-run/postgrest-environment-variables.png new file mode 100644 index 0000000000..f987b7cf82 Binary files /dev/null and b/docs/static/img/cloud-run/postgrest-environment-variables.png differ diff --git a/docs/static/img/cloud-run/redis-container.png b/docs/static/img/cloud-run/redis-container.png new file mode 100644 index 0000000000..00d664eb70 Binary files /dev/null and b/docs/static/img/cloud-run/redis-container.png differ diff --git a/docs/versioned_docs/version-3.0.0-LTS/setup/google-cloud-run.md b/docs/versioned_docs/version-3.0.0-LTS/setup/google-cloud-run.md index 145fa5cf78..1184135894 100644 --- a/docs/versioned_docs/version-3.0.0-LTS/setup/google-cloud-run.md +++ b/docs/versioned_docs/version-3.0.0-LTS/setup/google-cloud-run.md @@ -6,44 +6,77 @@ title: Google Cloud Run # Deploying ToolJet on Google Cloud Run :::info -You should setup a PostgreSQL database manually to be used by ToolJet. +You should manually set up a PostgreSQL database to be used by ToolJet. We recommend using **Cloud SQL** for this purpose. +Also for deploying ToolJet 3.0, Redis, Postgrest along with PostgreSQL are required. ::: -Follow the steps below to deploy ToolJet on Cloud run with `gcloud` CLI. + ## Deploying ToolJet application 1. Create a new Google Cloud Run Service: + +We are using a multi-container setup + +- **Google Cloud Run service** + - **tooljet-app (container - 1)** + - **postgrest (container - 2)** + - **redis (container - 3)** +- **Cloud SQL (for PostgreSQL)** + - **for both (TOOLJET_DB and PG_DB)**
- Google Cloud Run New Setup + Google Cloud Run New Setup
-2. Ingress and Authentication can be set as shown below, to begin with. Feel free to change the security configurations as per you see fit. +2. Ingress and Authentication can be set as shown below, to begin with. Feel free to change the security configurations as per your requirements.
- ingress-auth + ingress-auth
-3. Under containers tab, please make sure the port is set to 3000 and command `npm, run, start:prod` is entered in container argument field with CPU capacity set to 2GiB: +3. Under the containers tab, please make sure the port is set to 3000 and command `npm, run, start:prod` is entered in container argument field with CPU capacity set to 2GiB:
port-and-capacity-tooljet
-- If the command mentioned above is not compatible, please use the following command structure instead: +- If the above command is not compatible, please use the following command structure instead:
port-and-capacity-tooljet-alternative-command
-- Should you encounter any migration issues, please execute the following command. Be aware that executing this command may cause the revision to break. However, modifying the command back to `npm, run, start:prod` will successfully reboot the instance: +- If you encounter any migration issues, please execute the following command. Be aware that executing this command may cause the revision to break. However, modifying the command back to `npm, run, start:prod` will successfully reboot the instance:
port-and-capacity-tooljet-migration-fix-command
-4. Under environmental variable please add the below ToolJet application variables. You can also refer env variable [**here**](/docs/setup/env-vars). +4. Under environmental variables, please add the below ToolJet application variables. + + You can use these variables in the container 1: tooljet-app +| **Environment Variable** | **Value** | +|-----------------------------|-------------------------------| +| `LOCKBOX_MASTER_KEY` | `` | +| `SECRET_KEY_BASE` | `` | +| `PG_USER` | `postgres` | +| `PG_HOST` | `` | +| `PG_PASS` | `` | +| `PG_DB` | `tooljet_production` | +| `TOOLJET_DB` | `tooljet_db` | +| `TOOLJET_DB_USER` | `postgres` | +| `TOOLJET_DB_HOST` | `` | +| `TOOLJET_DB_PASS` | `` | +| `PGRST_HOST` | `localhost:3001` | +| `PGRST_JWT_SECRET` | `` | +| `REDIS_HOST` | `localhost` | +| `REDIS_PORT` | `6379` | +| `REDIS_USER` | `default` | +| `TOOLJET_HOST` | `` | + +**Note:** These environment variables are in general and might change in the future. You can also refer env variable [**here**](/docs/setup/env-vars). + Update `TOOLJET_HOST` environment variable if you want to use the default url assigned with Cloud run after the initial deploy. @@ -56,59 +89,64 @@ If you are using [Public IP](https://cloud.google.com/sql/docs/postgres/connect- ::: -5. Please go to the connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up. +5. Please go to the connection tab. Under the Cloud SQL instance please select the PostgreSQL database which you have set-up.
cloud-SQL-tooljet
+## Deploy 2nd container: Postgrest -Click on deploy once the above parameters are set. +Check for the option **ADD-CONTAINER**. -:::info -Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public. -::: +
+ add-container +
-## Deploying ToolJet Database +1. For the Postgrest container image `postgrest/postgrest:v12.0.2`. -To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly: -- [Self Hosted](/docs/setup/upgrade-to-v3) - -1. Cloud Run requires prebuilt image to be present within cloud registry. You can pull specific PostgREST image from docker hub and then tag with your project to push it to cloud registry. - ```bash - docker pull postgrest/postgrest:v12.0.2 - ``` - - Please run the above command by launching googleCLI which will help to push the PostgREST image to Google container registry. - -2. Ingress and Authentication can be set as shown below, to begin with. Feel free to change the security configurations as per you see fit. - - ingress-auth + **Note:** v12.0.2 is recommended for Postgrest. -3. Under containers tab, please make sure the port is set 3000 and CPU capacity is set to 1GiB. +
+ postgrest-container +
- port-and-capacity-postgrest - -4. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](/docs/setup/env-vars/#enable-tooljet-database-required). +2. You can add the following environment variables in the **variables and secrets of postgrest container**, for the postgrest container to communicate to the **tooljet-app**. -5. Please go to connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up for ToolJet application or the separate PostgreSQL database created respective to ToolJet Database from the drop-down option. +| **Environment Variable** | **Value** | +|-----------------------------|------------------------------------------------------------| +| `PGRST_DB_PRE_CONFIG` | `postgrest.pre_config` | +| `PGRST_JWT_SECRET` | `` | +| `PGRST_DB_URI` | `postgres://:password@/` | +| `PGRST_SERVER_PORT` | `3001` | - Cloud-SQL-instance +
+ postgrest-environment-variables +
- Click on deploy once the above parameters are set. + +## Deploy 3rd container: Redis + +Check for the option **ADD-CONTAINER** and create another container for Redis. + +For the Redis container we recommend using image `redis:6.2` + +
+ redis-container +
+ + + Click on deploy once the above parameters are set. :::info Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public. ::: -6. Additional Environmental variable to be added to ToolJet application or ToolJet Server connect to PostgREST server. You can also refer env variable [**here**](./env-vars/#enable-tooljet-database-required) - - env-for-tooljet ## 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`. +New LTS versions are released every 3-5 months with an end-of-life of 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.