Better sample values

Chart.yaml

@@ -14,7 +14,7 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 0.1.0
+version: 0.1.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.

README.md

@@ -1,17 +1,19 @@
 # GlitchTip Helm Chart
 
-We use this chart internally. However it's not fully documented yet nor tested in a wide range of scenarios.
-If you are a helm and kubernetes expert - feel free to use this and help contribute to this repo.  
-
 Based on https://gitlab.com/burke-software/django-helm-chart/
 
+This helm chart will deploy GlitchTip web, worker, migration job, postgres (if enabled), and redis (if enabled).
+
 # Usage
 
 1. Add our Helm chart repo `helm repo add glitchtip https://gitlab.com/api/v4/projects/16325141/packages/helm/stable`
-2. Review our values.yaml. At a minimum you'll need to set env.secret.DATABASE_URL and env.secret.SECRET_KEY.
-3. Install the chart `helm install glitchtip glitchtip/glitchtip`. You'll need to specify your own values.yml file or make use of `--set`
+2. Review our values.yaml and values.sample.yaml. At a minimum, decide if using helm postgresql and set env.secret.SECRET_KEY
+3. Install the chart `helm install glitchtip glitchtip/glitchtip -f your-values.yaml`. You'll need to specify your own values.yml file or make use of `--set`
 
-The default values assume a externally managed PostgreSQL database and a chart managed Redis. Redis in GlitchTip is ephemeral.
+For postgresql, we recommend an externally managed database and providing only the DATABASE_URL environment variable. If using helm managed postgresql, then make sure to consider:
+
+- If you uninstall the chart, it will not delete the pvc. If you reinstall the chart, it won't have the correct password because of this.
+- postgresql helm chart does not support major upgrades (such as 14.0 to 15.0). It will fail to start. You could export to a sql file and import if downtime is acceptable. Minor updates are supported.
 
 ## Important Tips
 
@@ -27,8 +29,8 @@ The default values assume a externally managed PostgreSQL database and a chart m
 - Set the image.tag to the [latest version](https://gitlab.com/glitchtip/glitchtip-frontend/-/releases)
 - `helm diff upgrade glitchtip glitchtip/glitchtip`
 - Carefully review diff
-- `helm upgrade glitchtip glitchtip/glitchtip`
+- `helm upgrade glitchtip glitchtip/glitchtip -f your-values.yaml`
 
 # Contributing
 
-Please open issues only with potential solutions and be prepared to do some work or else fund it. Contributors are welcome. However, we kindly ask that feature requests and support requests not be opened in this repo. This repo is an internal asset that happens to be open source. We don't recommend using this install method for anyone except advanced Kubernetes experts.
+Please open issues only with potential solutions and be prepared to do some work or else fund it. Contributors are welcome. However, we kindly ask that feature requests and support requests not be opened in this repo.

values.sample.yaml

@@ -3,12 +3,16 @@ image:
   pullPolicy: IfNotPresent
 env:
   normal:
-    GLITCHTIP_DOMAIN: https://example.com
+    GLITCHTIP_DOMAIN: https://change_this.example.com
   secret:
     SECRET_KEY: change_this
-    # DATABASE_URL: Specify if using external postgres (not managed by this chart)
+    # Specify if using external postgres (not managed by this chart)
+    # DATABASE_URL: postgres://postgres:postgres@postgres:5432/postgres 
 postgresql:
-  enabled: true  # Be careful upgrading if using this. The postgresql helm chart does not support major upgrades.
+  enabled: true  # Be careful upgrading. The postgresql helm chart does not support major upgrades.
   primary:
     persistence:
       size: 10Gi  # Default is 8, may want this considerably higher
+redis:
+  auth:
+    password: change_this