[prometheus-blackbox-exporter] fix issue when set extra containers

[allanhung]

What this PR does / why we need it

fix issue when set extra containers

cat > values.yaml << EOF
extraInitContainers:
- name: k8s-sidecar
  image: quay.io/kiwigrid/k8s-sidecar
extraContainers:
- name: k8s-sidecar
  image: quay.io/kiwigrid/k8s-sidecar
EOF
helm template -f values.yaml prometheus-community/prometheus-blackbox-exporter
Error: YAML parse error on prometheus-blackbox-exporter/templates/deployment.yaml: error converting YAML to JSON: yaml: line 37: block sequence entries are not allowed in this context

Use --debug flag to render out invalid YAML

Which issue this PR fixes

(optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged)

• fixes [prometheus-blackbox-exporter] Issue with extraInitContainers #3856

Special notes for your reviewer

Checklist

• DCO signed
• Chart Version bumped
• Title of the PR starts with chart name (e.g. [prometheus-couchdb-exporter])

[allanhung]

@monotek @blazarecki-scaleway Can you please help to approve this pr? From my test case, if the minus sign is not removed, it will result in a template rendering error. Thanks.

[tomkukral]

This issue was cause by me refactoring of DaemonSet vs Deployment podSpec. I'm sorry for it.

I have independently prepared same PR and confirm it to be working. indent 2 can be remove as well to be have consistent indentation across the file but it is just a cosmetic change.

+++ b/charts/prometheus-blackbox-exporter/templates/_helpers.tpl
@@ -122,7 +122,7 @@ affinity:
 {{- end }}
 {{- with .Values.tolerations }}
 tolerations:
-  {{- toYaml . | nindent 2 }}
+{{- toYaml . }}
 {{- end }}
 {{- if .Values.image.pullSecrets }}
 imagePullSecrets:
@@ -150,7 +150,7 @@ securityContext:
 {{- end }}
 {{- with .Values.extraInitContainers }}
 initContainers:
-  {{- toYaml . | indent 2 }}
+{{ toYaml . }}
 {{- end }}
 containers:
 {{- with .Values.extraContainers }}

👍 for fixing and 👍 for merging

[allanhung]

This issue was cause by me refactoring of DaemonSet vs Deployment podSpec. I'm sorry for it.

I have independently prepared same PR and confirm it to be working. indent 2 can be remove as well to be have consistent indentation across the file but it is just a cosmetic change.

+++ b/charts/prometheus-blackbox-exporter/templates/_helpers.tpl
@@ -122,7 +122,7 @@ affinity:
 {{- end }}
 {{- with .Values.tolerations }}
 tolerations:
-  {{- toYaml . | nindent 2 }}
+{{- toYaml . }}
 {{- end }}
 {{- if .Values.image.pullSecrets }}
 imagePullSecrets:
@@ -150,7 +150,7 @@ securityContext:
 {{- end }}
 {{- with .Values.extraInitContainers }}
 initContainers:
-  {{- toYaml . | indent 2 }}
+{{ toYaml . }}
 {{- end }}
 containers:
 {{- with .Values.extraContainers }}

👍 for fixing and 👍 for merging

Regarding the indentation, you're right; it's more of a cosmetic change, but it's always good to have consistent formatting. Thanks for addressing this. I've also tested other parts, and it seems that the topologySpreadConstraints need adjustment as well. Here is my test:

$ cat > values.yaml << EOF
topologySpreadConstraints:
- maxSkew: 1
  topologyKey: kubernetes.io/hostname
  whenUnsatisfiable: DoNotSchedule
  labelSelector:
    matchLabels:
      app: foo
  matchLabelKeys:
    - pod-template-hash
tolerations:
- key: "key1"
  operator: "Equal"
  value: "value1"
  effect: "NoSchedule"
imagePullSecrets:
- regcred1
- regcred2
hostAliases:
- ip: 127.0.0.1
  hostNames:
  - "foo.local"
  - "bar.local"
- ip: "10.1.2.3"
  hostNames:
  - "foo.remote"
  - "bar.remote"
extraInitContainers:
- name: k8s-sidecar
  image: quay.io/kiwigrid/k8s-sidecar
extraContainers:
- name: k8s-sidecar
  image: quay.io/kiwigrid/k8s-sidecar
EOF
cat > test.patch << EOF
--- a/prometheus-blackbox-exporter/templates/_helpers.tpl
+++ b//prometheus-blackbox-exporter/templates/_helpers.tpl
@@ -110,7 +110,7 @@
 serviceAccountName: {{ template "prometheus-blackbox-exporter.serviceAccountName" . }}
 {{- with .Values.topologySpreadConstraints }}
 topologySpreadConstraints:
-  {{- toYaml . | nindent 2 }}
+{{ toYaml . }}
 {{- end }}
 {{- with .Values.nodeSelector }}
 nodeSelector:
@@ -122,7 +122,7 @@
 {{- end }}
 {{- with .Values.tolerations }}
 tolerations:
-  {{- toYaml . | nindent 2 }}
+{{ toYaml . }}
 {{- end }}
 {{- if .Values.image.pullSecrets }}
 imagePullSecrets:
@@ -150,10 +150,10 @@
 {{- end }}
 {{- with .Values.extraInitContainers }}
 initContainers:
-  {{- toYaml . | indent 2 }}
+{{ toYaml . }}
 {{- end }}
 containers:
-{{- with .Values.extraContainers }}
+{{ with .Values.extraContainers }}
   {{- toYaml . }}
 {{- end }}
 - name: blackbox-exporter
 EOF
$ helm pull --untar prometheus-community/prometheus-blackbox-exporter
$ patch -p1 < test.patch
$ helm template -f values.yaml prometheus-blackbox-exporter

[tomkukral]

@monotek can you review again? I'd like to get this merged so my mistake is not blocking other people.