feat(targetallocator): propagate cr annotation to deployment

Author: mikel-jason

.chloggen/targetallocator-deployment-annotations.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
+component: target allocator
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Annotations of the `OpenTelemetryCollector` and `TargetAllocator` resources are now propagated to the target allocator deployment resource.
+
+# One or more tracking issues related to the change
+issues: [4393]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: ""

internal/manifests/targetallocator/annotations.go

@@ -15,6 +15,26 @@ import (
 
 const configMapHashAnnotationKey = "opentelemetry-targetallocator-config/hash"
 
+// Annotations returns the annotations for the TargetAllocator resources.
+func Annotations(instance v1alpha1.TargetAllocator, configMap *v1.ConfigMap, filterAnnotations []string) map[string]string {
+	annotations := make(map[string]string, len(instance.ObjectMeta.Annotations))
+	if instance.ObjectMeta.Annotations != nil {
+		for k, v := range instance.ObjectMeta.Annotations {
+			if !manifestutils.IsFilteredSet(k, filterAnnotations) {
+				annotations[k] = v
+			}
+		}
+	}
+	if configMap != nil {
+		cmHash := getConfigMapSHA(configMap)
+		if cmHash != "" {
+			annotations[configMapHashAnnotationKey] = getConfigMapSHA(configMap)
+		}
+	}
+
+	return annotations
+}
+
 // PodAnnotations returns the annotations for the TargetAllocator Pod.
 func PodAnnotations(instance v1alpha1.TargetAllocator, configMap *v1.ConfigMap, filterAnnotations []string) map[string]string {
 	// Make a copy of PodAnnotations to be safe

internal/manifests/targetallocator/deployment.go

@@ -22,13 +22,15 @@ func Deployment(params Params) (*appsv1.Deployment, error) {
 		params.Log.Info("failed to construct target allocator config map for annotations")
 		configMap = nil
 	}
+	annotations := Annotations(params.TargetAllocator, configMap, params.Config.AnnotationsFilter)
 	podAnnotations := PodAnnotations(params.TargetAllocator, configMap, params.Config.AnnotationsFilter)
 
 	return &appsv1.Deployment{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      name,
-			Namespace: params.TargetAllocator.Namespace,
-			Labels:    labels,
+			Name:        name,
+			Namespace:   params.TargetAllocator.Namespace,
+			Labels:      labels,
+			Annotations: annotations,
 		},
 		Spec: appsv1.DeploymentSpec{
 			Replicas: params.TargetAllocator.Spec.Replicas,

internal/manifests/targetallocator/deployment_test.go

@@ -145,10 +145,37 @@ func TestDeploymentNewDefault(t *testing.T) {
 	assert.Contains(t, d.Spec.Template.Annotations, configMapHashAnnotationKey)
 	assert.Len(t, d.Spec.Template.Annotations, 1)
 
+	// should only have the ConfigMap hash annotation
+	assert.Contains(t, d.ObjectMeta.Annotations, configMapHashAnnotationKey)
+	assert.Len(t, d.ObjectMeta.Annotations, 1)
+
 	// the pod selector should match the pod spec's labels
 	assert.Subset(t, d.Spec.Template.Labels, d.Spec.Selector.MatchLabels)
 }
 
+func TestDeploymentAnnotations(t *testing.T) {
+	// prepare
+	testAnnotationValues := map[string]string{"annotation-key": "annotation-value"}
+	otelcol := collectorInstance()
+	targetAllocator := targetAllocatorInstance()
+	targetAllocator.ObjectMeta.Annotations = testAnnotationValues
+	cfg := config.New()
+
+	params := Params{
+		Collector:       otelcol,
+		TargetAllocator: targetAllocator,
+		Config:          cfg,
+		Log:             logger,
+	}
+
+	// test
+	ds, err := Deployment(params)
+	assert.NoError(t, err)
+	// verify
+	assert.Equal(t, "my-instance-targetallocator", ds.Name)
+	assert.Subset(t, ds.ObjectMeta.Annotations, testAnnotationValues)
+}
+
 func TestDeploymentPodAnnotations(t *testing.T) {
 	// prepare
 	testPodAnnotationValues := map[string]string{"annotation-key": "annotation-value"}