Refactor values.yaml following Helm best practices

- Variables should use camel case.
- Favor flat hierarchy over nested.
- "Every defined property in values.yaml should be documented. The
  documentation string should begin with the name of the property it
describes, and then give at least a one-sentence description."
- Source, https://helm.sh/docs/topics/chart_best_practices/values/

deployment/helm/human-connection/templates/deployments/deployment-backend.yaml

@@ -25,7 +25,7 @@ spec:
       containers:
       - name: backend
         image: humanconnection/nitro-backend:latest
-        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        imagePullPolicy: {{ .Values.pullPolicy }}
         envFrom:
         - configMapRef:
             name: {{ .Release.Name }}-configmap

deployment/helm/human-connection/templates/deployments/deployment-mailserver.yaml

@@ -19,7 +19,7 @@ spec:
       containers:
       - name: mailserver
         image: djfarrelly/maildev
-        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        imagePullPolicy: {{ .Values.pullPolicy }}
         ports:
         - containerPort: 80
         - containerPort: 25

deployment/helm/human-connection/templates/deployments/deployment-neo4j.yaml

@@ -23,7 +23,7 @@ spec:
       containers:
       - name: neo4j
         image: humanconnection/neo4j:0.2.2
-        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        imagePullPolicy: {{ .Values.pullPolicy }}
         ports:
         - containerPort: 7687
         - containerPort: 7474
@@ -32,13 +32,6 @@ spec:
             memory: {{ .Values.neo4jResourceRequestsMemory | default "1G" | quote }}
           limits:
             memory: {{ .Values.neo4jResourceLimitsMemory | default "1G" | quote }}
-        env:
-        - name: NEO4J_dbms_security_procedures_unrestricted
-          value: "algo.*,apoc.*"
-          {{- range $key, $val := .Values.neo4jConfig }}
-        - name: NEO4J_{{ $key }}
-          value: {{ $val | quote }}
-          {{- end }}
         envFrom:
         - configMapRef:
             name: {{ .Release.Name }}-configmap

deployment/helm/human-connection/templates/deployments/deployment-web.yaml

@@ -19,7 +19,7 @@ spec:
       containers:
       - name: webapp
         image: humanconnection/nitro-web:0.2.2
-        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        imagePullPolicy: {{ .Values.pullPolicy }}
         envFrom:
         - configMapRef:
             name: {{ .Release.Name }}-configmap

deployment/helm/human-connection/templates/ingress/ingress.template.yaml

@@ -9,10 +9,10 @@ metadata:
 spec:
   tls:
     - hosts:
-      - {{ .Values.humanConnectionDomain }}
+      - {{ .Values.domain }}
       secretName: tls
   rules:
-    - host: {{ .Values.humanConnectionDomain }}
+    - host: {{ .Values.domain }}
       http:
         paths:
           - path: /

deployment/helm/human-connection/templates/jobs/db-migration.yaml

@@ -15,7 +15,7 @@ spec:
       containers:
       - name: db-migrations-job
         image: humanconnection/nitro-backend:latest
-        command: ["/bin/sh", "-c", "{{ .Values.application.migrationsCommand }}"]
+        command: ["/bin/sh", "-c", "{{ .Values.dbMigrations }}"]
         envFrom:
           - configMapRef:
               name: {{ .Release.Name }}-configmap

deployment/helm/human-connection/values.yaml

@@ -1,33 +1,40 @@
+# domain is the user-facing domain.
 domain: develop.human-connection.org
+# commit is the latest github commit deployed.
 commit: 889a7cdd24dda04a139b2b77d626e984d6db6781
-
-# configs
-application:
-  initializeCommand: "yarn prod:migrate init"
-  migrationsCommand: "yarn prod:migrate up"
-developmentMailserverDomain: "mailserver.human-connection.org"
-humanConnectionDomain: "develop.human-connection.org"
-image:
-  pullPolicy: Always
+# dbInitialization runs the database initializations in a post-install hook.
+dbInitializion: "yarn prod:migrate init"
+# dbMigrations runs the database migrations in a post-upgrade hook.
+dbMigrations: "yarn prod:migrate up"
+# pullPolicy indicates when, if ever, pods pull a new image from docker hub.
+pullPolicy: Always
+# letsencryptIssuer is used by cert-manager to set up certificates with the given provider.
 letsencryptIssuer: "letsencrypt-prod"
+# neo4jConfig changes any default neo4j config/adds it.
 neo4jConfig:
-  apoc_import_file_enabled: "true"
-  dbms_memory_pagecache_size: "490M"
-  dbms_memory_heap_max__size: "500M"
-  dbms_memory_heap_initial__size: "500M"
+  # acceptLicenseAgreement is used to agree to the license agreement for neo4j's enterprise edition.
+  acceptLicenseAgreement: "yes"
+  # apocImportFileEnabled enables the import of files to neo4j using the plugin apoc 
+  apocImportFileEnabled: "true"
+  # dbmsMemoryHeapInitialSize configures initial heap size. By default, it is calculated based on available system resources.(valid units are `k`, `K`, `m`, `M`, `g`, `G`)
+  dbmsMemoryHeapInitialSize: "500M"
+  # dbmsMemoryHeapMaxSize configures maximum heap size. By default it is calculated based on available system resources.(valid units are `k`, `K`, `m`, `M`, `g`, `G`)
+  dbmsMemoryHeapMaxSize: "500M"
+  # dbmsMemoryPagecacheSize configures the amount of memory to use for mapping the store files, in bytes (or 'k', 'm', and 'g')
+  dbmsMemoryPagecacheSize: "490M"
+# neo4jResourceLimitsMemory configures the memory limits available.
 neo4jResourceLimitsMemory: "2G"
+# neo4jResourceLimitsMemory configures the memory available for requests.
 neo4jResourceRequestsMemory: "1G"
+# supportEmail is used for letsencrypt certs.
 supportEmail: "devcom@human-connection.org"
+# smtpHost is the host for the mailserver.
 smtpHost: "mailserver.human-connection"
+# smtpPort is the port to be used for the mailserver.
 smtpPort: "25"
-smtpUsername:
-smtpPassword:
-volumes:
-  uploads:
-    storage: 5Gi
-  neo4jData:
-    storage: 8Gi
-# secrets
+# jwtSecret is used to encode/decode a user's JWT for authentication
 jwtSecret: "Yi8mJjdiNzhCRiZmdi9WZA=="
+# privateKeyPassphrase is used for activity pub
 privateKeyPassphrase: "YTdkc2Y3OHNhZGc4N2FkODdzZmFnc2FkZzc4"
+# mapboxToken is used for the Mapbox API, geolocalization.
 mapboxToken: "cGsuZXlKMUlqb2lhSFZ0WVc0dFkyOXVibVZqZEdsdmJpSXNJbUVpT2lKamFqbDBjbkJ1Ykdvd2VUVmxNM1Z3WjJsek5UTnVkM1p0SW4wLktaOEtLOWw3MG9talhiRWtrYkhHc1E="