Merge pull request #54 from tryretool/bdj/docs

Bdj/docs

README.md

@@ -20,21 +20,53 @@ Guide](https://docs.retool.com/docs/setup-instructions).
         $ helm repo add retool https://charts.retool.com
         "retool" has been added to your repositories
 
-1. Ensure you have access to the `retool` chart:
+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
-1. Run this command `git clone https://github.com/tryretool/retool-helm.git`
+3. Run this command `git clone https://github.com/tryretool/retool-helm.git`
 
-1. 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.
+4. Modify the `values.yaml` file:
 
-1. 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](https://docs.retool.com/docs/environment-variables) for more information on how they are used.
+* Set values for `config.encryptionKey` and `config.jwtSecret`. They should each be a different long, random string that you keep private. See our docs on [Environment Variables](https://docs.retool.com/docs/environment-variables) for more information on how they are used.
 
-1. 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](https://docs.retool.com/docs/updating-retool-on-premise#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.
+* Set `image.tag` with the version of Retool you want to install (i.e. a version in the format X.Y.Z). See our guide on [Retool Release Versions](https://docs.retool.com/docs/updating-retool-on-premise#retool-release-versions) to see our most recent version.
 
-1. Please see the many other options supported in the `values.yaml` file.
+* Set `config.licenseKey` with your license key.
 
-1. Now you're all ready to install Retool:
+5. Now you're all ready to install Retool:
 
         $ helm install my-retool retool/retool -f values.yaml
+
+## Additional Configuration
+
+### Externalize database
+Modify `values.yaml`:
+
+* 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.
+
+### gRPC
+1. Create a `configMap` of the directory which contains your `proto` files.
+
+        $ kubectl create configmap protos --from-file=<protos-path>
+
+2. Modify `values.yaml`:
+
+        extraVolumeMounts:
+          - name: protos
+          mountPath: /retool_backend/protos
+          readOnly: true
+
+        extraVolumes:
+          - name: protos
+          configMap:
+            name: protos 
+
+        env:
+          PROTO_DIRECTORY_PATH=/retool_backend/protos
+
+### Ingress
+Modify `values.yaml`:
+
+* Uncomment `ingress.hosts` and change `ingress.hosts.host` to be the hostname of your kubernetes instance.