Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-04-24 15:07:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ToolJet/docs/versioned_docs/version-2.33.0/setup/google-cloud-run.md
Akshay 2d08d889de
Release: Community changes (v2.34.0) (#9226) 
* add custom resolvers info and editable row selection info (#9057)

* fix system requirements icon

* add auth info for webhooks and fix casing

* add regex custom validation info (#9068)

* [docs]: Marketplace 1.7 updates (#9085)

* [docs] Amazon redshift plugin

* make minor improvements

* add and update docs for marketplace 1.7

* update order of plugins in overview to match sidebar

* create new version

---------

Co-authored-by: Shubhendra <withshubh@gmail.com>

* add the latest version in the versions.json file (#9094)

* [docs]: Update PDF component (#9088)

* update PDF component

* merged with develop and added changes to the new version

* update docs favicon: (#9118)

* [docs] SSO revamp (#9031)

* add method to set default language

* update image settings through custom css and update screenshots for getting started and tooljet concepts (#9158)

* fix read documentation button

* fix formatting for setup icons (#9172)

* fix sidebar link for aws lambda

* Update static media (#9175)

* updated the screenshots

* reduced the gif size

* reverted the package.json file

* edited the zoomed in images and replaced some gifs with screenshots

* removed one gif

* update static media

* update file names

* update toolbar

* fix file names

* fix: dynamodb img path

* update media for org management dashboard

* fix: casing and formatting

* update workspace constant media

* update media in workspace settings and github

* update github sso

* minor change to github sso docs

* minor fix

* update google sso

* change includeCurrentVersion flag to false

---------

Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>

* Feature: Engagespot plugin (#9012)

* feat(plugins): added engagespot plugin

* feat(docs): added engagespot plugin docs

* chore(engagespot-plugin): revised copywritings

* Feature: Databricks data source (#9174)

* plugin-created

* Databricks integration

* icon, error handling

* removed unrelated changes from marketplace and frontend package-lock.json removed runAsync and maxRows timeouts pending

* timeout implementation

* socket timeout and error handling

* resolve comments

* resolve comments2

* solved render issue test connection improvements

* solved undefined error

* fix TJDB not null value fail for is operation (#9055)

* fix TJDB not null value fail for is operation

* handling not null and null case insenstive values

* Support for marketplace plugin deploy on render preview app (#9221)

* Fix for marketplace error on render preview app

* add marketplace build command

* Adding new workflow for building marketplace plugin

* removed render app creation

* [:docs] Add documentation for Databricks plugin (#9224)

* add docs for databricks

* update databricks docs

* update docs

* remove ref to clusters

* bump to v2.34.0

* Fixed data source cypress failure (#9227)

* updated spec with required text

* updated mongodb and import spec

* updated import spec

---------

Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>
Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com>
Co-authored-by: Midhun G S <gsmithun4@gmail.com>
Co-authored-by: Shubhendra <withshubh@gmail.com>
Co-authored-by: Aman Regu <amanregu@gmail.com>
Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Jobin Jose <129726530+jobin-logidots@users.noreply.github.com>
Co-authored-by: Syed Mohammad Akhtar Rizvi <85864291+ShazanRizvi@users.noreply.github.com>
Co-authored-by: blank0537 <111295371+blank0537@users.noreply.github.com>
Co-authored-by: Mekhla Asopa <59684099+Mekhla-Asopa@users.noreply.github.com>
2024-03-29 19:13:26 +05:30

7.7 KiB
Raw Blame History

id title
google-cloud-run Google Cloud Run

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 hello@tooljet.com.

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.

    gcloud auth configure-docker
docker pull tooljet/tooljet:latest
docker tag tooljet/tooljet:latest gcr.io/<replace-your-project-id>/tooljet/tooljet:latest
docker push gcr.io/<replace-your-project-id>/tooljet/tooljet: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.3-ee2.10.2 before upgrading.

  • Users on versions earlier than v2.23.3-ee2.10.2 must first upgrade to this version before proceeding to the latest version.

For specific issues or questions, refer to our Slack.