Improving installation via Helm (#247)

* Update helm docker image used in CI

* Move helm dependencies from requirements.yaml into Chart.yaml

* Fix the port-forwarding notes in the helm chart

* Document how to clean up state after helm uninstall

Signed-off-by: Jenny Lea <[email protected]>
Signed-off-by: Othman Alkhamra <[email protected]>

Author: th3n3rd

.travis.yml

@@ -35,7 +35,7 @@ jobs:
           tags: true
   - name: "Build & Deploy Helm"
     script:
-      - docker run -v $TRAVIS_BUILD_DIR/deployment/helm/:/helm  -w /helm --entrypoint /helm/build.sh alpine/helm:3.0.0-beta.5 $TRAVIS_TAG
+      - docker run -v $TRAVIS_BUILD_DIR/deployment/helm/:/helm  -w /helm --entrypoint /helm/build.sh alpine/helm:3.2.1 $TRAVIS_TAG
     deploy:
       - provider: releases
         draft: true

deployment/helm/Chart.lock

@@ -5,5 +5,5 @@ dependencies:
 - name: redis
   repository: https://kubernetes-charts.storage.googleapis.com
   version: 9.4.3
-digest: sha256:63b5c2d6fa6dbceb477ec60d94c9d4f3f14e0ee85738b32880213282ab9a7f0e
-generated: "2019-10-26T07:44:45.177984+01:00"
+digest: sha256:18dea218d4c6460be6a3b7b203d6668650e1a9dfe42a4859ccdd7f5ebc6b9038
+generated: "2020-05-12T14:21:00.129069+01:00"

deployment/helm/Chart.yaml

@@ -44,8 +44,16 @@ 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.2.0-beta
+version: 0.4.0-beta
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.
 appVersion: latest
+
+dependencies:
+  - name: postgresql
+    version: 6.5.0
+    repository: "@stable"
+  - name: redis
+    version: 9.4.3
+    repository: "@stable"

deployment/helm/README.md

@@ -85,9 +85,11 @@ option for postgres you would add the following to the install/upgrade command
 ```
 
 
-# Building the chart
+# Local development
 
-To build and run the chart locally, follow the following steps
+## Building the chart
+
+To build the chart locally, follow the following steps
 
 1. Install Helm CLI (version 3+)
 1. Add stable chart repository to helm
@@ -100,5 +102,24 @@ To build and run the chart locally, follow the following steps
     ```
 1. Build the chart: 
     ```shell script
-    helm package
-    ```
+    helm package .
+    ```
+
+## Installing the chart
+
+Installing the chart locally with the following command:
+
+```shell script
+helm install postfacto <local-chart.tgz>
+```
+
+This will automatically install `postgresql` and `redis` with persistence enabled, which means the configuration and data
+survive `helm uninstall`.
+
+In this case the next time `postfacto` gets installed, `postgresql` will attempt to generate a new password and fail to authenticate.
+
+In order to clean the state after `helm uninstall` it is recommended to delete all persistent volume claims using:
+
+```shell script
+kubectl delete pvc -l release=postfacto
+```

deployment/helm/build.sh

@@ -41,7 +41,6 @@ sed -i.bak s/appVersion:.*/appVersion:\ $APP_VERSION/  Chart.yaml
 
 helm repo add stable https://kubernetes-charts.storage.googleapis.com
 
-rm -f Chart.lock # workaround for: https://github.com/helm/helm/issues/6416
 helm dependency build
 
 helm package .

deployment/helm/requirements.yaml

@@ -15,7 +15,6 @@
   export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "postfacto.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
   echo http://$SERVICE_IP:{{ .Values.service.port }}
 {{- else if contains "ClusterIP" .Values.service.type }}
-  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "postfacto.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
   echo "Visit http://127.0.0.1:8080 to use your application"
-  kubectl port-forward $POD_NAME 8080:80
+  kubectl port-forward service/{{ include "postfacto.fullname" . }} 8080:80
 {{- end }}