Skip to main content
Version: 2.35.0

Deploying ToolJet on Google Cloud Run

info

You should setup a PostgreSQL database manually to be used by ToolJet.

If you have any questions feel free to join our Slack Community or send us an email at [email protected].

Follow the steps below to deploy ToolJet on Cloud run with gcloud CLI.

Deploying ToolJet application

  1. Cloud Run requires prebuilt image to be present within cloud registry. You can pull specific tooljet image from docker hub and then tag with your project to push it to cloud registry.

Ensure you change replace-with-your-project-id in the below command with your project ID.

  gcloud auth configure-docker
docker pull tooljet/tooljet:EE-LTS-latest
docker tag tooljet/tooljet:EE-LTS-latest gcr.io/replace-with-your-project-id/tooljet/tooljet:EE-LTS-latest
docker push gcr.io/replace-with-your-project-id/tooljet/tooljet:EE-LTS-latest

Please run the above command by launching GoogleCLI which will help to push the Tooljet application image to Google container registry.

CLI
  1. Create new cloud run service

    Select and add the pushed Tooljet application image as shown below.

tooljet-app-service
  1. 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
  1. 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:
port-and-capacity-tooljet
  • If the command mentioned above 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:
port-and-capacity-tooljet-migration-fix-command
  1. Under environmental variable please add the below Tooljet application variables. You can also refer env variable here.

Update TOOLJET_HOST environment variable if you want to use the default url assigned with Cloud run after the initial deploy.

env-variable-tooljet
tip

If you are using Public IP for Cloud SQL, then database host connection (value for PG_HOST) needs to be set using unix socket format, /cloudsql/<CLOUD_SQL_CONNECTION_NAME>.

  1. Please go to the connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up.
cloud-SQL-tooljet

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 to make the service public.

Deploying ToolJet Database

If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.

PostgREST server

  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.

    gcloud auth configure-docker
    docker pull postgrest/postgrest:v10.1.1.20221215
    docker tag postgrest/postgrest:v10.1.1.20221215 gcr.io/tooljet-test-338806/postgrest/postgrest:v10.1.1.20221215
    docker push gcr.io/tooljet-test-338806/postgrest/postgrest:v10.1.1.20221215

Please run the above command by launching googleCLI which will help to push the PostgREST image to Google container registry.

CLI
  1. Once the PostgREST image is pushed. Click on create service.

Select and add the pushed PostgREST image as shown in below.

create-service-cloud-run-postgrest
  1. 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
  1. Under containers tab, please make sure the port is set 3000 and CPU capacity is set to 1GiB.
port-and-capacity-postgrest
  1. Under environmental variable please add corresponding Tooljet database env variables. You can also refer env variable.

  2. 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.

Cloud-SQL-instance

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 to make the service public.

  1. Additional Environmental variable to be added to Tooljet application or Tooljet Server connect to PostgREST server. You can also refer env variable here
env-for-tooljet

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.