This repository contains the official Helm 3 chart for installing and configuring Retool on Kubernetes. For full documentation on all the ways you can deploy Retool on your own infrastructure, please see the Setup Guide.
- This chart requires Helm 3.0.
- A PostgreSQL database.
- Persistent volumes are not reliable - we strongly recommend that a long-term installation of Retool host the database on an externally managed database (for example, AWS RDS).
-
Add the Retool Helm repository:
$ helm repo add retool https://charts.retool.com "retool" has been added to your repositories -
Ensure you have access to the
retoolchart:$ helm search repo retool/retool NAME CHART VERSION APP VERSION DESCRIPTION retool/retool 4.0.0 2.66.2 A Helm chart for Kubernetes -
In the
values.yamlfile, disable the included postgresql chart by settingpostgresql.enabledtofalse. Then specify your external database through theconfig.postgresql.\*properties at the top of the file. -
In the
values.yamlfile, set values forencryptionKeyandjwtSecret. They should each be a different long, random string that you keep private. See our docs on Environment Variables for more information on how they are used. -
In the
values.yamlfile, set the version of Retool you want to install in theimage.tagfield. See our guide on Retool Release Versions to see our most recent version. To prevent issues while upgrading Retool, set a specific semver version number (i.e. a version in the format X.Y.Z) in theimage.tagfield. -
Please see the many other options supported in the
values.yamlfile. -
Now you're all ready to install Retool:
$ helm install my-retool retool/retool