[collector] Fix: Enable external configmap checksum (#1302)

* Enable external configmap checksum

Fixes [collector] No collector reload when using external configmap #1194

* Update examples for `opentelemetry-collector`

* Rename option to `configFile` for better consistency

* Template checksum annotation for all Deployment modes

* Add example for external configmap

* Hint with option name that config is a chart Template

* Remove unneeded example

* Adhere to existing user-config convention

* Update Collector chart schema to include new property

* Regenerate Collector examples

* Revert "Regenerate Collector examples"

This reverts commit 5e6d8f8.

* Remove configmap from local testing

* Generate annotation checksums by inferring ConfigMap name from the value of `existingName`

* Remove configmap from local testing

* Run `make generate-examples CHARTS=opentelemetry-collector`

* Bring back `configMap.existingPath` option

There doesn't seem to be a way to get at rendered template contents in Helm. This key allows a user to specify the path to template file that will be used to create `configMap.existingName`, in cases like mine where we want to wrap this chart in a chart that feeds in custom configmap contents.

* Regen examples to match upstream

* Improve comments based on PR comments

* Bump chart

* Update examples for chart version `102.1`

* Prefer `SHOULD`

Co-authored-by: Tyler Helmuth <[email protected]>

---------

Co-authored-by: Tyler Helmuth <[email protected]>

charts/opentelemetry-collector/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: opentelemetry-collector
-version: 0.102.0
+version: 0.102.1
 description: OpenTelemetry Collector Helm chart for Kubernetes
 type: application
 home: https://opentelemetry.io/

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/configmap-agent.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/configmap.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/daemonset.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -23,7 +23,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 4ec9f3c7e80ff74c7609668fa628aa20b6f1c13c6113cd6c8e0af2eb3d6f0a51
+        checksum/config: 6ca4f8927489af6d1b6ef3af9e2921147dff5f71bd661dd51c33fbc027cae9ae
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/deployment.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -25,7 +25,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 39e9727e920b7f499f75036d7b6d3133fbc9eceede910eeb77d515832f016d76
+        checksum/config: e4935d38fe18c9388e403cee58fa4656e34eb3c1c2168feb0ee5f492a0cfd677
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/service.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-collector-logs/rendered/configmap-agent.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-collector-logs/rendered/daemonset.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -23,7 +23,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: cfd6f4326f424284994ef4f367ea7b85c9e3d9c4b19d91251400fdf88f643aab
+        checksum/config: ad46e162cd7a250982434b98a5b97c64b726b07791b88a87480c85c4cbb2f974
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-collector-logs/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-hostmetrics/rendered/configmap-agent.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-hostmetrics/rendered/daemonset.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -23,7 +23,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 874906fd5c031df77ab4f4684bb236eb5efaada31c798308b1ca707fac19e8c9
+        checksum/config: e009d488c32ae94d75648202bf8269b9e2c115c4065128c8dd79993ba7b9fd67
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-hostmetrics/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-lifecycle-hooks/rendered/configmap-agent.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-lifecycle-hooks/rendered/daemonset.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -23,7 +23,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: e8c879f1a526f29114330ea3e372567ae6ae5b4673d80ddd6e4561e6c9345b42
+        checksum/config: 11a810ea6778e04fa676656c340aaa81855ffcbd43993f14261fa84905b37530
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-lifecycle-hooks/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-only/rendered/configmap-agent.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/daemonset-only/rendered/daemonset.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector-agent
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -23,7 +23,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: e8c879f1a526f29114330ea3e372567ae6ae5b4673d80ddd6e4561e6c9345b42
+        checksum/config: 11a810ea6778e04fa676656c340aaa81855ffcbd43993f14261fa84905b37530
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-only/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-only/rendered/configmap.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-only/rendered/deployment.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -25,7 +25,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 39e9727e920b7f499f75036d7b6d3133fbc9eceede910eeb77d515832f016d76
+        checksum/config: e4935d38fe18c9388e403cee58fa4656e34eb3c1c2168feb0ee5f492a0cfd677
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/deployment-only/rendered/service.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-only/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-otlp-traces/rendered/configmap.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-otlp-traces/rendered/deployment.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -25,7 +25,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 1a77cba116d181aaa1771b218b219129c301de6654f07c6005f1af8bc097cf10
+        checksum/config: b57fd12f658c06971ab67b6ea12617f5e0682c2d118fa07a55ab4148378cc6e7
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/deployment-otlp-traces/rendered/service.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-otlp-traces/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-use-existing-configMap/rendered/deployment.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-use-existing-configMap/rendered/service.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/deployment-use-existing-configMap/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/kubernetesAttributes/rendered/clusterrole.yaml

@@ -5,7 +5,7 @@ kind: ClusterRole
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/kubernetesAttributes/rendered/clusterrolebinding.yaml

@@ -5,7 +5,7 @@ kind: ClusterRoleBinding
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/kubernetesAttributes/rendered/configmap.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"

charts/opentelemetry-collector/examples/kubernetesAttributes/rendered/deployment.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"
@@ -25,7 +25,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 8091cab7affee20cd22f4bb632e9c4af7f477d0d7ccdcea2c490753f59040016
+        checksum/config: 1ff6792d78c7be9a7e90955127540f2c7fb96ae54dc50902a138f3a398bb7c35
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/kubernetesAttributes/rendered/service.yaml

@@ -6,7 +6,7 @@ metadata:
   name: example-opentelemetry-collector
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-collector-0.102.0
+    helm.sh/chart: opentelemetry-collector-0.102.1
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.107.0"