Changes for Zammad 7.0 (#395)

- Update to Zammad 7.0
- Adds support for Redis Sentinel. Fixes #391.
- Fix all `rails` invocations to use `bundle exec rails`.
- Pass POSTGRESQL_* variables directly rather than DATABASE_URL
  - Zammad 7.0 is able to construct the DATABASE_URL itself, so it's better to pass the raw variables to it to avoid issues with special character escaping.
- The bitnami memcached subchart was replaced with [cloudpirates-memcached/memcached](https://artifacthub.io/packages/helm/cloudpirates-memcached/memcached).
  This should be a seamless update.
  Closes #402 
- The bitnami redis subchart was replaced with [cloudpirates-redis/redis](https://artifacthub.io/packages/helm/cloudpirates-redis/redis).
  Please check your values for this subchart, as there have been minor changes here (resources configuration is now on the top level rather than in `master`).
  The name of the primary redis service has changed from `{{ .Release.Name }}-redis-master` to `{{ .Release.Name }}-redis`.
  A data migration is not required here.
  Fixes #367, closes: #401

Author: mgruner

.github/updatecli.yaml

@@ -6,10 +6,10 @@ sources:
     spec:
       image: "zammad/zammad-docker-compose"
       architecture: "linux/amd64"
-      # tagfilter: "^6\\.5\\.2$"
-      # tagfilter: "^6\\.5\\.2-\\d{1}"
-      tagfilter: "^6\\.5\\.2-\\d{2}"
-      # tagfilter: "^6\\.5\\.2-\\d{3}"
+      tagfilter: "^7\\.0\\.0$"
+      # tagfilter: "^7\\.0\\.0-\\d{1}"
+      # tagfilter: "^7\\.0\\.0-\\d{2}"
+      # tagfilter: "^7\\.0\\.0-\\d{3}"
   alpine:
     kind: dockerimage
     spec:
@@ -32,27 +32,27 @@ sources:
   #     name: minio
   #     versionfilter:
   #       pattern: "14.x.x"
-  # memcached:
-  #   kind: helmchart
-  #   spec:
-  #     url: https://charts.bitnami.com/bitnami
-  #     name: memcached
-  #     versionfilter:
-  #       pattern: "7.x.x"
+  memcached:
+    kind: helmchart
+    spec:
+      url: oci://ghcr.io/cloudpirates-io/helm-charts
+      name: memcached
+      versionfilter:
+        pattern: "0.x.x"
   # postgresql:
   #   kind: helmchart
   #   spec:
   #     url: https://charts.bitnami.com/bitnami
   #     name: postgresql
   #     versionfilter:
   #       pattern: "16.x.x"
-  # redis:
-  #   kind: helmchart
-  #   spec:
-  #     url: https://charts.bitnami.com/bitnami
-  #     name: redis
-  #     versionfilter:
-  #       pattern: "20.x.x"
+  redis:
+    kind: helmchart
+    spec:
+      url: oci://ghcr.io/cloudpirates-io/helm-charts
+      name: redis
+      versionfilter:
+        pattern: "0.x.x"
 
 conditions: {}
 
@@ -88,14 +88,14 @@ targets:
   #     file: "Chart.yaml"
   #     key: "$.dependencies[1].version"
   #     versionincrement: patch
-  # memcached:
-  #   kind: helmchart
-  #   sourceid: memcached
-  #   spec:
-  #     name: "zammad"
-  #     file: "Chart.yaml"
-  #     key: "$.dependencies[2].version"
-  #     versionincrement: patch
+  memcached:
+    kind: helmchart
+    sourceid: memcached
+    spec:
+      name: "zammad"
+      file: "Chart.yaml"
+      key: "$.dependencies[2].version"
+      versionincrement: patch
   # postgresql:
   #   kind: helmchart
   #   sourceid: postgresql
@@ -104,11 +104,11 @@ targets:
   #     file: "Chart.yaml"
   #     key: "$.dependencies[3].version"
   #     versionincrement: patch
-  # redis:
-  #   kind: helmchart
-  #   sourceid: redis
-  #   spec:
-  #     name: "zammad"
-  #     file: "Chart.yaml"
-  #     key: "$.dependencies[4].version"
-  #     versionincrement: patch
+  redis:
+    kind: helmchart
+    sourceid: redis
+    spec:
+      name: "zammad"
+      file: "Chart.yaml"
+      key: "$.dependencies[4].version"
+      versionincrement: patch

.github/workflows/ci.yaml

@@ -4,8 +4,6 @@ permissions: read-all
 
 on:
   pull_request:
-    branches:
-      - main
 
 env:
   helm-version: "v3.19.4"

zammad/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: zammad
-version: 15.7.0
-appVersion: 6.5.2-85
+version: 16.0.0
+appVersion: 7.0.0
 description: Zammad is a web based open source helpdesk/customer support system with many features to manage customer communication via several channels like telephone, facebook, twitter, chat and e-mails.
 home: https://zammad.org
 icon: https://raw.githubusercontent.com/zammad/zammad-documentation/main/images/zammad_logo_600x520.png
@@ -23,14 +23,14 @@ dependencies:
     repository: https://charts.bitnami.com/bitnami
     condition: zammadConfig.minio.enabled
   - name: memcached
-    version: 7.9.3
-    repository: https://charts.bitnami.com/bitnami
+    version: 0.10.1
+    repository: oci://ghcr.io/cloudpirates-io/helm-charts
     condition: zammadConfig.memcached.enabled
   - name: postgresql
     version: 16.7.21
     repository: https://charts.bitnami.com/bitnami
     condition: zammadConfig.postgresql.enabled
   - name: redis
-    version: 20.13.4
-    repository: https://charts.bitnami.com/bitnami
+    version: 0.25.6
+    repository: oci://ghcr.io/cloudpirates-io/helm-charts
     condition: zammadConfig.redis.enabled

zammad/README.md

@@ -93,10 +93,10 @@ Note that this `PVC` must provide `ReadWriteMany` access to work properly for th
 #### How to migrate from `File` to `S3` storage
 
 - In the admin panel, go to "System -> Storage" and select "Simple Storage (S3)" as the new storage provider.
-- Migrate existing `File` store content by running `kubectl exec zammad-0 -c zammad-railsserver -- rails r "Store::File.move('File', 'S3')"`. Example:
+- Migrate existing `File` store content by running `kubectl exec zammad-0 -c zammad-railsserver -- bundle exec rails r "Store::File.move('File', 'S3')"`. Example:
 
 ```log
-kubectl exec zammad-0 -c zammad-railsserver -- rails r "Store::File.move('File', 'S3')"
+kubectl exec zammad-0 -c zammad-railsserver -- bundle exec rails r "Store::File.move('File', 'S3')"
 I, [2024-01-24T11:06:13.501572 #168]  INFO -- : ActionCable is using the redis instance at redis://:zammad@zammad-redis-master:6379.
 I, [2024-01-24T11:06:13.506180#168-5980]  INFO -- : Using memcached as Rails cache store.
 I, [2024-01-24T11:06:13.506246#168-5980]  INFO -- : Using the Redis back end for Zammad's web socket session store.
@@ -193,15 +193,24 @@ available. You can create a job from a cronjob template for it:
 kubectl create job my-reindex-job --from=cronjob/zammad-cronjob-reindex
 ```
 
-This cronjob never runs by default, but you can channge `zammadConfig.cronJob.reindex.suspend`
+This cronjob never runs by default, but you can change `zammadConfig.cronJob.reindex.suspend`
 and `zammadConfig.cronJob.reindex.schedule` if you want to run it periodically.
 
 ## Upgrading
 
+### From Chart Version 15.x to 16.0.0
+
+- The bitnami memcached subchart was replaced with [cloudpirates-memcached/memcached](https://artifacthub.io/packages/helm/cloudpirates-memcached/memcached).
+  This should be a seamless update.
+- The bitnami redis subchart was replaced with [cloudpirates-redis/redis](https://artifacthub.io/packages/helm/cloudpirates-redis/redis).
+  - Please check your values for this subchart, as there have been minor changes here (resources configuration is now on the top level rather than in `master`).
+  - The name of the primary redis service has changed from `{{ .Release.Name }}-redis-master` to `{{ .Release.Name }}-redis`.
+  - The new subchart creates its own `PersistentVolumeClaim`. As Zammad does not store permantent data in Redis, there is no data migration required here. Feel free to clean up the unused `PersistentVolumeClaim` from the previous subchart at your convenience (it has `master` in its name, e.g. `redis-data-zammad-redis-master-0`).
+
 ### From Chart Version 14.x to 15.0.0
 
-- The selector matchLabels of all deployments changed which are unfortunately immutable. This means each deployment needs to  
-  be deleted before upgrading the helm chart. To preserve high availability the `cascade=orphan` option can be used  
+- The selector matchLabels of all deployments changed which are unfortunately immutable. This means each deployment needs to
+  be deleted before upgrading the helm chart. To preserve high availability the `cascade=orphan` option can be used
   (e.g. `kubectl/oc delete deployment --selector app.kubernetes.io/name=zammad --cascade=orphan`).
 
 ### From Chart Version 13.x to 14.0.0

zammad/ci/full-values.yaml

@@ -15,6 +15,10 @@ secrets:
     useExisting: true
     secretKey: redis-password
     secretName: redis-existing-secret
+    sentinel:
+      useExisting: true
+      secretKey: redis-password
+      secretName: redis-existing-secret
 
 autoWizard:
   enabled: true
@@ -30,10 +34,14 @@ minio:
   auth:
     existingSecret: minio-existing-secret
 
+# Use existing Redis secrets and run in Redis Sentinel mode.
 redis:
   auth:
     existingSecret: redis-existing-secret
     existingSecretPasswordKey: redis-password
+  sentinel:
+    enabled: true
+  architecture: replication
 
 zammadConfig:
   storageVolume:
@@ -60,6 +68,9 @@ zammadConfig:
       my-railsserver-pod-label: my-railsserver-pod-label-value
     podAnnotations:
       my-railsserver-pod-annotation: my-railsserver-pod-annotation-value
+  redis:
+    sentinel:
+      enabled: true
   scheduler:
     podLabels:
       my-scheduler-pod-label: my-scheduler-pod-label-value

zammad/templates/_helpers.tpl

@@ -138,6 +138,17 @@ redis secret name
 {{- end -}}
 {{- end -}}
 
+{{/*
+redis sentinel secret name
+*/}}
+{{- define "zammad.redisSentinelSecretName" -}}
+{{- if .Values.secrets.redis.sentinel.useExisting -}}
+{{ .Values.secrets.redis.sentinel.secretName }}
+{{- else -}}
+{{ include "zammad.fullname" . }}-{{ .Values.secrets.redis.sentinel.secretName }}
+{{- end -}}
+{{- end -}}
+
 {{/*
 S3 access URL
 */}}
@@ -176,29 +187,72 @@ S3 access URL
 {{- end -}}
 
 {{/*
-environment variables for the Zammad Rails stack
+Redis Variables
 */}}
-{{- define "zammad.env" -}}
-{{- if or .Values.zammadConfig.redis.pass .Values.secrets.redis.useExisting -}}
+{{- define "zammad.env.redisVariables" -}}
+{{- if .Values.zammadConfig.redis.sentinel.username }}
+- name: REDIS_USERNAME
+  value: "{{ .Values.zammadConfig.redis.username }}"
+{{- end }}
+{{- if or .Values.zammadConfig.redis.pass .Values.secrets.redis.useExisting }}
 - name: REDIS_PASSWORD
   valueFrom:
     secretKeyRef:
       name: {{ include "zammad.redisSecretName" . }}
       key: {{ .Values.secrets.redis.secretKey }}
 {{- end }}
+# sentinel
+{{- if .Values.zammadConfig.redis.sentinel.enabled }}
+- name: REDIS_SENTINELS
+{{- if .Values.zammadConfig.redis.enabled }}
+  value: "{{ .Release.Name }}-redis"
+{{- else }}
+  value: "{{ join "," .Values.zammadConfig.redis.sentinel.sentinels }}"
+{{- end }}
+- name: REDIS_SENTINEL_NAME
+  value: "{{ .Values.zammadConfig.redis.sentinel.masterName | default "mymaster" }}"
+{{- if .Values.zammadConfig.redis.sentinel.username }}
+- name: REDIS_SENTINEL_USERNAME
+  value: "{{ .Values.zammadConfig.redis.sentinel.username }}"
+{{- end }}
+{{- if or .Values.zammadConfig.redis.sentinel.pass .Values.secrets.redis.useExisting }}
+- name: REDIS_SENTINEL_PASSWORD
+  valueFrom:
+    secretKeyRef:
+      name: {{ include "zammad.redisSentinelSecretName" . }}
+      key: {{ .Values.secrets.redis.sentinel.secretKey }}
+{{- end }}
+{{- else }}
+# standalone
+- name: REDIS_URL
+  value: "redis://{{ .Values.zammadConfig.redis.username }}:$(REDIS_PASSWORD)@{{ if .Values.zammadConfig.redis.enabled }}{{ .Release.Name }}-redis{{ else }}{{ .Values.zammadConfig.redis.host }}{{ end }}:{{ .Values.zammadConfig.redis.port }}"
+{{- end }}
+{{- end }}
+
+{{/*
+environment variables for the Zammad Rails stack
+*/}}
+{{- define "zammad.env" -}}
+{{ include "zammad.env.redisVariables" . }}
 - name: MEMCACHE_SERVERS
   value: "{{ if .Values.zammadConfig.memcached.enabled }}{{ .Release.Name }}-memcached{{ else }}{{ .Values.zammadConfig.memcached.host }}{{ end }}:{{ .Values.zammadConfig.memcached.port }}"
 - name: RAILS_TRUSTED_PROXIES
   value: "{{ .Values.zammadConfig.railsserver.trustedProxies }}"
-- name: REDIS_URL
-  value: "redis://:$(REDIS_PASSWORD)@{{ if .Values.zammadConfig.redis.enabled }}{{ .Release.Name }}-redis-master{{ else }}{{ .Values.zammadConfig.redis.host }}{{ end }}:{{ .Values.zammadConfig.redis.port }}"
+- name: POSTGRESQL_HOST
+  value: {{ if .Values.zammadConfig.postgresql.enabled }}{{ .Release.Name }}-postgresql{{ else }}{{ .Values.zammadConfig.postgresql.host }}{{ end }}
+- name: POSTGRESQL_PORT
+  value: {{ .Values.zammadConfig.postgresql.port | toString | toYaml }}
+- name: POSTGRESQL_USER
+  value: {{ .Values.zammadConfig.postgresql.user }}
 - name: POSTGRESQL_PASS
   valueFrom:
     secretKeyRef:
       name: {{ include "zammad.postgresqlSecretName" . }}
       key: {{ .Values.secrets.postgresql.secretKey }}
-- name: DATABASE_URL
-  value: "postgres://{{ .Values.zammadConfig.postgresql.user }}:$(POSTGRESQL_PASS)@{{ if .Values.zammadConfig.postgresql.enabled }}{{ .Release.Name }}-postgresql{{ else }}{{ .Values.zammadConfig.postgresql.host }}{{ end }}:{{ .Values.zammadConfig.postgresql.port }}/{{ .Values.zammadConfig.postgresql.db }}?{{ .Values.zammadConfig.postgresql.options }}"
+- name: POSTGRESQL_DB
+  value: {{ .Values.zammadConfig.postgresql.db }}
+- name: POSTGRESQL_OPTIONS
+  value: {{ .Values.zammadConfig.postgresql.options }}
 {{ include "zammad.env.S3_URL" . }}
 - name: TMP # All zammad containers need the possibility to create temporary files, e.g. for file uploads or image resizing.
   value: {{ .Values.zammadConfig.railsserver.tmpdir }}

zammad/templates/secrets.yaml

@@ -54,3 +54,20 @@ type: Opaque
 data:
   {{ .Values.secrets.redis.secretKey }}: {{ .Values.zammadConfig.redis.pass | b64enc | quote }}
 {{ end }}
+
+{{ if and .Values.zammadConfig.redis.sentinel.enabled }}
+{{ if and .Values.zammadConfig.redis.sentinel.pass (not .Values.secrets.redis.sentinel.useExisting) }}
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "zammad.redisSentinelSecretName" . }}
+  labels:
+    {{- include "zammad.labels" . | nindent 4 }}
+  annotations:
+    {{- include "zammad.annotations" . | nindent 4 }}
+type: Opaque
+data:
+  {{ .Values.secrets.redis.sentinel.secretKey }}: {{ .Values.zammadConfig.redis.sentinel.pass | b64enc | quote }}
+{{ end }}
+{{ end }}