fix Helm pretty-printer for disabledAPIVersions (#3877)

`disabledAPIVersions` is a list which Helm would print as `[item1 item2]` into YAML, thus, corrupting the YAML format. This can be mitigated by applying the Helm template function `toJson` (or `toYaml`) to the list in question which would format the list as `["item1", "item2"]`. This is no issue for scalars, since Helm's format coincidently matches the one required by YAML.
wireapp · Feb 8, 2024 · 2b104a0 · 2b104a0
1 parent fd9628a
commit 2b104a0
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 7 deletions.
diff --git a/changelog.d/3-bug-fixes/WPB-6428 b/changelog.d/3-bug-fixes/WPB-6428
@@ -0,0 +1 @@
+fix Helm pretty-printer for disabledAPIVersions
diff --git a/charts/brig/templates/configmap.yaml b/charts/brig/templates/configmap.yaml
@@ -323,7 +323,7 @@ data:
       {{- if .setOAuthEnabled }}
       setOAuthEnabled: {{ .setOAuthEnabled }}
       {{- end }}
-      setDisabledAPIVersions: {{ .setDisabledAPIVersions }}
+      setDisabledAPIVersions: {{ toJson .setDisabledAPIVersions }}
       {{- if .setOAuthRefreshTokenExpirationTimeSecs }}
       setOAuthRefreshTokenExpirationTimeSecs: {{ .setOAuthRefreshTokenExpirationTimeSecs }}
       {{- end }}

diff --git a/charts/cannon/templates/configmap.yaml b/charts/cannon/templates/configmap.yaml
@@ -19,7 +19,7 @@ data:
       millisecondsBetweenBatches: {{ .Values.config.drainOpts.millisecondsBetweenBatches }}
       minBatchSize: {{ .Values.config.drainOpts.minBatchSize }}
 
-    disabledAPIVersions: {{ .Values.config.disabledAPIVersions }}
+    disabledAPIVersions: {{ toJson .Values.config.disabledAPIVersions }}
 
 kind: ConfigMap
 metadata:

diff --git a/charts/cargohold/templates/configmap.yaml b/charts/cargohold/templates/configmap.yaml
@@ -56,5 +56,5 @@ data:
       downloadLinkTTL: {{ .downloadLinkTTL }}
       {{- end }}
       federationDomain: {{ .federationDomain }}
-      disabledAPIVersions: {{ .disabledAPIVersions }}
+      disabledAPIVersions: {{ toJson .disabledAPIVersions }}
       {{- end }}
diff --git a/charts/galley/templates/configmap.yaml b/charts/galley/templates/configmap.yaml
@@ -80,7 +80,7 @@ data:
           ed25519: "/etc/wire/galley/secrets/removal_ed25519.pem"
         {{- end }}
       {{- end }}
-      disabledAPIVersions: {{ .settings.disabledAPIVersions }}
+      disabledAPIVersions: {{ toJson .settings.disabledAPIVersions }}
       {{- if .settings.featureFlags }}
       {{- if .settings.guestLinkTTLSeconds }}
       guestLinkTTLSeconds: {{ .settings.guestLinkTTLSeconds }}

diff --git a/charts/gundeck/templates/configmap.yaml b/charts/gundeck/templates/configmap.yaml
@@ -60,7 +60,7 @@ data:
       {{- if hasKey . "perNativePushConcurrency" }}
       perNativePushConcurrency: {{ .perNativePushConcurrency }}
       {{- end }}
-      disabledAPIVersions: {{ .disabledAPIVersions }}
+      disabledAPIVersions: {{ toJson .disabledAPIVersions }}
       # disabledAPIVersions: [ 2 ]
       maxConcurrentNativePushes:
         soft: {{ .maxConcurrentNativePushes.soft }}

diff --git a/charts/proxy/templates/configmap.yaml b/charts/proxy/templates/configmap.yaml
@@ -7,7 +7,7 @@ data:
     logFormat: {{ .Values.config.logFormat }}
     logLevel: {{ .Values.config.logLevel }}
     logNetStrings: {{ .Values.config.logNetStrings }}
-    disabledAPIVersions: {{ .Values.config.disabledAPIVersions }}
+    disabledAPIVersions: {{ toJson .Values.config.disabledAPIVersions }}
     host: 0.0.0.0
     port: {{ .Values.service.internalPort }}
     httpPoolSize: 1000

diff --git a/charts/spar/templates/configmap.yaml b/charts/spar/templates/configmap.yaml
@@ -36,7 +36,7 @@ data:
 
     maxScimTokens: {{ .maxScimTokens }}
 
-    disabledAPIVersions: {{ .disabledAPIVersions }}
+    disabledAPIVersions: {{ toJson .disabledAPIVersions }}
 
     saml:
       version:     SAML2.0