Migrate to Bitnami Mongo DB Chart (#50)

* Breaking change: Move from single mongo deployment to mongodb helm chart. No upgrade path for data. Must be done manually.
* Use sorry-cypress 1.0.3

.github/workflows/lint-test.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
         with:
-          fetch-depth: 0
+          fetch-depth: "0"
 
       - name: Set up Helm
         uses: azure/setup-helm@v1
@@ -36,10 +36,15 @@ jobs:
           python-version: 3.7
 
       - name: Set up chart-testing
-        uses: helm/chart-testing-action@v2.0.1
+        uses: helm/chart-testing-action@v2.1.0
         with:
           version: v3.4.0
 
+      # - name: Add dependency chart repos
+      #   run: |
+      #     helm repo add minio https://helm.min.io/ --force-update
+      #     helm repo add mongodb https://charts.bitnami.com/bitnami --force-update
+
       - name: Run chart-testing (list-changed)
         id: list-changed
         run: |

.github/workflows/release.yml

@@ -29,7 +29,8 @@ jobs:
 
       - name: Add dependency chart repos
         run: |
-          helm repo add minio https://helm.min.io/
+          helm repo add minio https://helm.min.io/ --force-update
+          helm repo add mongodb https://charts.bitnami.com/bitnami --force-update
         
       - name: Run chart-releaser
         uses: helm/[email protected]

charts/sorry-cypress/Chart.yaml

@@ -2,8 +2,8 @@ apiVersion: v2
 name: sorry-cypress
 description: A Helm chart for Sorry Cypress
 type: application
-version: 0.1.37
-appVersion: 0.6.1
+version: 1.0.0-alpha
+appVersion: 1.0.3
 home: https://sorry-cypress.dev/
 sources:
   - https://github.com/sorry-cypress/sorry-cypress
@@ -16,3 +16,7 @@ dependencies:
     repository: https://helm.min.io/
     version: 8.0.9
     condition: minio.enabled
+  - name: mongodb
+    repository: https://charts.bitnami.com/bitnami
+    version: 10.19.0
+    condition: mongodb.enabled

charts/sorry-cypress/changelog.md

@@ -0,0 +1,3 @@
+# 1.0.0
+## Breaking Changes
+Uses the bitnami mongodb helm chart. There is no automated upgrade path from previous versions... you will have to manually migrate data.

charts/sorry-cypress/ci/mongo-values.yaml

@@ -2,6 +2,3 @@
 director:
   environmentVariables:
     executionDriver: "../execution/mongo/driver"
-
-mongo:
-  enabled: true

charts/sorry-cypress/templates/_helpers.tpl

@@ -73,11 +73,15 @@ Create the s3 secret
 {{/*
   Determine the MongoDB hostname.
 */}}
-{{- define "mongo.hostname" -}}
-{{- if .Values.mongo.enabled }}
-{{- printf "%s-%s" (include "sorry-cypress-helm.fullname" .) "mongo" -}}
+{{- define "mongodb.hostname" -}}
+{{- if .Values.mongodb.enabled }}
+  {{- if eq .Values.mongodb.architecture "standalone" }}
+  {{- printf "%s-%s" (include "sorry-cypress-helm.fullname" .) "mongodb" -}}
+  {{- else }}
+  {{- printf "%s-%s" (include "sorry-cypress-helm.fullname" .) "mongodb-headless" -}}
+  {{- end }}
 {{- else }}
-{{- printf "%s" .Values.mongo.mongoServer -}}
+{{- printf "%s" .Values.mongodb.mongoServer -}}
 {{- end }}
 {{- end }}
 

charts/sorry-cypress/templates/deployment-api.yml

@@ -34,11 +34,11 @@ spec:
       {{- end }}
       containers:
       - env:
-        {{- if .Values.mongo.enabled }}
+        {{- if .Values.mongodb.enabled }}
         - name: MONGODB_DATABASE
-          value: {{ .Values.mongo.mongoDatabase }}
+          value: {{ .Values.mongodb.mongoDatabase }}
         - name: MONGODB_URI
-          value: mongodb://{{ include "mongo.hostname" . }}:{{ .Values.mongo.service.port }}
+          value: mongodb://{{ include "mongodb.hostname" . }}:{{ .Values.mongodb.service.port }}
         {{- end }}
         image: "{{ .Values.api.image.repository }}:{{ .Values.api.image.tag | default .Chart.AppVersion }}"
         imagePullPolicy: {{ .Values.api.image.pullPolicy }}

charts/sorry-cypress/templates/deployment-director.yml

@@ -40,9 +40,9 @@ spec:
           value: {{ .Values.director.environmentVariables.executionDriver }}
         {{- if eq .Values.director.environmentVariables.executionDriver "../execution/mongo/driver" }}
         - name: MONGODB_DATABASE
-          value: {{ .Values.mongo.mongoDatabase }}
+          value: {{ .Values.mongodb.mongoDatabase }}
         - name: MONGODB_URI
-          value: mongodb://{{ include "mongo.hostname" . }}:{{ .Values.mongo.service.port }}
+          value: mongodb://{{ include "mongodb.hostname" . }}:{{ .Values.mongodb.service.port }}
         {{- end }}
         - name: SCREENSHOTS_DRIVER
           value: {{ .Values.director.environmentVariables.screenshotsDriver }}

charts/sorry-cypress/templates/test/test-connections.yaml

@@ -34,13 +34,13 @@ spec:
       args:  ['{{ include "sorry-cypress-helm.fullname" . }}-director:{{ .Values.director.service.port }}']
   restartPolicy: Never
 ---
-{{- if .Values.mongo.enabled }}
+{{- if .Values.mongodb.enabled }}
 apiVersion: v1
 kind: Pod
 metadata:
-  name: "{{ include "sorry-cypress-helm.fullname" . }}-test-mongo-connection"
+  name: "{{ include "sorry-cypress-helm.fullname" . }}-test-mongodb-connection"
   labels:
-    app.kubernetes.io/name: "{{ include "sorry-cypress-helm.fullname" . }}-test-mongo-connection"
+    app.kubernetes.io/name: "{{ include "sorry-cypress-helm.fullname" . }}-test-mongodb-connection"
   annotations:
     "helm.sh/hook": test-success
     "helm.sh/hook-delete-policy": hook-succeeded
@@ -49,7 +49,7 @@ spec:
     - name: wget
       image: busybox
       command: ['wget']
-      args:  ['{{ include "sorry-cypress-helm.fullname" . }}-mongo:{{ .Values.mongo.service.port }}']
+      args:  ['{{ include "sorry-cypress-helm.fullname" . }}-mongodb-headless:{{ .Values.mongodb.service.port }}']
   restartPolicy: Never
 {{- end }}
 ---

charts/sorry-cypress/values.yaml

@@ -30,9 +30,8 @@ api:
   service:
     port: 4000
 
-  # If you are using v10.0.0-beta.15 or greater, you can enable a readinessProbe for the API pods.
   readinessProbe:
-    enabled: false
+    enabled: true
     periodSeconds: 5
     timeoutSeconds: 3
     successThreshold: 2
@@ -178,51 +177,20 @@ director:
     #    hosts:
     #      - chart-example.local
 
-mongo:
-  # You need to ensure that director.environmentVariables.executionDriver is set to "../execution/mongo/driver" if you want mongo.enabled to be true.
+mongodb:
+  # You need to ensure that director.environmentVariables.executionDriver is set to "../execution/mongo/driver" if you want the director to use mongodb.
   enabled: true
-
   mongoDatabase: "sorry-cypress"
-
   # Ignored if mongo.enabled is set to true
   mongoServer: ""
 
-  image:
-    repository: mongo
-    pullPolicy: Always
-    tag: "4.0"
-
-  nodeSelector: {}
-
-  tolerations: []
-
-  affinity: {}
-
+  # If enabled, you can use any values from the mongodb helm chart: https://github.com/bitnami/charts/blob/master/bitnami/mongodb/values.yaml
+  # Below are the bare minimim to get you started.
+  architecture: replicaset
+  auth:
+    enabled: false
   persistence:
     enabled: false
-    accessMode: "ReadWriteOnce"
-    size: "1Gi"
-
-  resources: {}
-    # We usually recommend not to specify default resources and to leave this as a conscious
-    # choice for the user. This also increases chances charts run on environments with little
-    # resources, such as Minikube. If you do want to specify resources, uncomment the following
-    # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
-    # limits:
-    #   cpu: 100m
-    #   memory: 128Mi
-    # requests:
-    #   cpu: 100m
-    #   memory: 128Mi
-
-  # Set annotations for pods
-  podAnnotations: {}
-
-  # Additional pod labels
-  podLabels: {}
-
-  service:
-    port: 27017
 
 s3:
   bucketName: example-bucket
@@ -254,6 +222,9 @@ s3:
 minio:
   enabled: false
 
+  # If enabled, you can include any values from the minio helm chart: https://github.com/minio/charts/blob/master/minio/values.yaml
+  # Below are the bare minimim to get you started.
+
   endpoint: storage.yourdomain.com
   url: http://storage.yourdomain.com
 

lint.yaml

@@ -3,5 +3,6 @@ remote: origin
 target-branch: main
 chart-repos:
   - minio=https://helm.min.io
+  - mongodb=https://charts.bitnami.com/bitnami
 chart-dirs:
   - charts

test.yaml

@@ -3,6 +3,7 @@ remote: origin
 target-branch: main
 chart-repos:
   - minio=https://helm.min.io
+  - mongodb=https://charts.bitnami.com/bitnami
 chart-dirs:
   - charts
 helm-extra-args: --timeout 600s