isabella232 / retool-helm

retool-helm

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.

Prerequisites

• 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).

Usage

1. Add the Retool Helm repository:

    $ helm repo add retool https://charts.retool.com
    "retool" has been added to your repositories
   

2. Ensure you have access to the retool chart:

    $ helm search repo retool/retool
    NAME         	CHART VERSION	APP VERSION	DESCRIPTION                
    retool/retool	4.0.0        	2.66.2     	A Helm chart for Kubernetes
   

3. Run this command git clone https://github.com/tryretool/retool-helm.git

4. In the values.yaml file, disable the included postgresql chart by setting postgresql.enabled to false. Then specify your external database through the config.postgresql.\* properties at the top of the file.

5. In the values.yaml file, set values for encryptionKey and jwtSecret. 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.

6. In the values.yaml file, set the version of Retool you want to install in the image.tag field. 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 the image.tag field.

7. Please see the many other options supported in the values.yaml file.

8. Now you're all ready to install Retool:

    $ helm install my-retool retool/retool -f values.yaml