Merge pull request #21 from flanksource/feat/helm-chart

chore: Moves defaults to values file & adds comments.

Author: moshloop

chart/templates/deployment.yaml

@@ -28,8 +28,8 @@ spec:
             - name: DB_URL
               valueFrom:
                 secretKeyRef:
-                  name: {{ .Values.db.secretKeyRef.name | default "postgres-connection" }}
-                  key: {{ .Values.db.secretKeyRef.key | default 'DB_URL' }}
+                  name: {{ .Values.db.secretKeyRef.name }}
+                  key: {{ .Values.db.secretKeyRef.key }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
       {{- with .Values.extra }}

chart/values.yaml

@@ -14,12 +14,17 @@ image:
   tag: "latest"
 
 db:
+  # Setting this to true will create a postgres stateful set for config-db to connect to.
   enabled: false
-  secretKeyRef: 
-    name:
-    key: "DB_URL"
   storageClass: 
   storage: 
+  secretKeyRef: 
+    # Setting the name of the secret will disable secret creation in this chart and look for an existing secret (whose name is specified in this field) to mount.
+    # When setting this up in a fresh environment as a standalone app, it's best to leave the value empty.
+    name:
+    # This is the key that either the secret will create(if secretRefKey is empty) or this is the key it'll look for in the secret(if secretRefKey is mentioned).
+    # The name of the key is mandatory to set.
+    key: DB_URL
 
 ingress:
   enabled: false