Add recommended label "app.kubernetes.io/version" for operand (open-telemetry#797)

* Including new label

Signed-off-by: Yuri Sa <yurimsa@gmail.com>

* Checking len of version var

Signed-off-by: Yuri Sa <yurimsa@gmail.com>

* Fixing function signature

Signed-off-by: Yuri Sa <yurimsa@gmail.com>

* Fixing linters

Signed-off-by: Yuri Sa <yurimsa@gmail.com>

* Fixing number of labels in test files

Signed-off-by: Yuri Sa <yurimsa@gmail.com>

* Test len of label version for configmap

Signed-off-by: Yuri Sa <yurimsa@gmail.com>

* Added missing len check

Signed-off-by: Yuri Sa <yurimsa@gmail.com>

Author: yuriolisa

pkg/collector/daemonset_test.go

@@ -148,7 +148,7 @@ func TestDaemonsetFilterLabels(t *testing.T) {
 
 	d := DaemonSet(cfg, logger, otelcol)
 
-	assert.Len(t, d.ObjectMeta.Labels, 5)
+	assert.Len(t, d.ObjectMeta.Labels, 6)
 	for k := range excludedLabels {
 		assert.NotContains(t, d.ObjectMeta.Labels, k)
 	}

pkg/collector/deployment_test.go

@@ -170,7 +170,7 @@ func TestDeploymentFilterLabels(t *testing.T) {
 
 	d := Deployment(cfg, logger, otelcol)
 
-	assert.Len(t, d.ObjectMeta.Labels, 5)
+	assert.Len(t, d.ObjectMeta.Labels, 6)
 	for k := range excludedLabels {
 		assert.NotContains(t, d.ObjectMeta.Labels, k)
 	}

pkg/collector/labels.go

@@ -16,6 +16,7 @@ package collector
 
 import (
 	"regexp"
+	"strings"
 
 	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
 	"github.com/open-telemetry/opentelemetry-operator/pkg/naming"
@@ -46,6 +47,12 @@ func Labels(instance v1alpha1.OpenTelemetryCollector, filterLabels []string) map
 	base["app.kubernetes.io/instance"] = naming.Truncate("%s.%s", 63, instance.Namespace, instance.Name)
 	base["app.kubernetes.io/part-of"] = "opentelemetry"
 	base["app.kubernetes.io/component"] = "opentelemetry-collector"
+	version := strings.Split(instance.Spec.Image, ":")
+	if len(version) > 1 {
+		base["app.kubernetes.io/version"] = version[len(version)-1]
+	} else {
+		base["app.kubernetes.io/version"] = "latest"
+	}
 
 	return base
 }

pkg/collector/labels_test.go

@@ -31,12 +31,37 @@ func TestLabelsCommonSet(t *testing.T) {
 			Name:      "my-instance",
 			Namespace: "my-ns",
 		},
+		Spec: v1alpha1.OpenTelemetryCollectorSpec{
+			Image: "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator:0.47.0",
+		},
+	}
+
+	// test
+	labels := Labels(otelcol, []string{})
+	assert.Equal(t, "opentelemetry-operator", labels["app.kubernetes.io/managed-by"])
+	assert.Equal(t, "my-ns.my-instance", labels["app.kubernetes.io/instance"])
+	assert.Equal(t, "0.47.0", labels["app.kubernetes.io/version"])
+	assert.Equal(t, "opentelemetry", labels["app.kubernetes.io/part-of"])
+	assert.Equal(t, "opentelemetry-collector", labels["app.kubernetes.io/component"])
+}
+
+func TestLabelsTagUnset(t *testing.T) {
+	// prepare
+	otelcol := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "my-instance",
+			Namespace: "my-ns",
+		},
+		Spec: v1alpha1.OpenTelemetryCollectorSpec{
+			Image: "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
+		},
 	}
 
 	// test
 	labels := Labels(otelcol, []string{})
 	assert.Equal(t, "opentelemetry-operator", labels["app.kubernetes.io/managed-by"])
 	assert.Equal(t, "my-ns.my-instance", labels["app.kubernetes.io/instance"])
+	assert.Equal(t, "latest", labels["app.kubernetes.io/version"])
 	assert.Equal(t, "opentelemetry", labels["app.kubernetes.io/part-of"])
 	assert.Equal(t, "opentelemetry-collector", labels["app.kubernetes.io/component"])
 }
@@ -53,7 +78,7 @@ func TestLabelsPropagateDown(t *testing.T) {
 	labels := Labels(otelcol, []string{})
 
 	// verify
-	assert.Len(t, labels, 5)
+	assert.Len(t, labels, 6)
 	assert.Equal(t, "mycomponent", labels["myapp"])
 }
 
@@ -68,7 +93,7 @@ func TestLabelsFilter(t *testing.T) {
 	labels := Labels(otelcol, []string{".*.bar.io"})
 
 	// verify
-	assert.Len(t, labels, 5)
+	assert.Len(t, labels, 6)
 	assert.NotContains(t, labels, "test.bar.io")
 	assert.Equal(t, "bar", labels["test.foo.io"])
 }

pkg/collector/reconcile/configmap.go

@@ -18,6 +18,7 @@ import (
 	"context"
 	"fmt"
 	"reflect"
+	"strings"
 
 	"gopkg.in/yaml.v2"
 	corev1 "k8s.io/api/core/v1"
@@ -64,8 +65,14 @@ func ConfigMaps(ctx context.Context, params Params) error {
 
 func desiredConfigMap(_ context.Context, params Params) corev1.ConfigMap {
 	name := naming.ConfigMap(params.Instance)
+	version := strings.Split(params.Instance.Spec.Image, ":")
 	labels := collector.Labels(params.Instance, []string{})
 	labels["app.kubernetes.io/name"] = name
+	if len(version) > 1 {
+		labels["app.kubernetes.io/version"] = version[len(version)-1]
+	} else {
+		labels["app.kubernetes.io/version"] = "latest"
+	}
 	config, err := ReplaceConfig(params)
 	if err != nil {
 		params.Log.V(2).Info("failed to update prometheus config to use sharded targets: ", err)
@@ -86,8 +93,14 @@ func desiredConfigMap(_ context.Context, params Params) corev1.ConfigMap {
 
 func desiredTAConfigMap(params Params) (corev1.ConfigMap, error) {
 	name := naming.TAConfigMap(params.Instance)
+	version := strings.Split(params.Instance.Spec.Image, ":")
 	labels := targetallocator.Labels(params.Instance)
 	labels["app.kubernetes.io/name"] = name
+	if len(version) > 1 {
+		labels["app.kubernetes.io/version"] = version[len(version)-1]
+	} else {
+		labels["app.kubernetes.io/version"] = "latest"
+	}
 
 	promConfig, err := ta.ConfigToPromConfig(params.Instance.Spec.Config)
 	if err != nil {

pkg/collector/reconcile/configmap_test.go

@@ -36,11 +36,13 @@ func TestDesiredConfigMap(t *testing.T) {
 		"app.kubernetes.io/managed-by": "opentelemetry-operator",
 		"app.kubernetes.io/instance":   "default.test",
 		"app.kubernetes.io/part-of":    "opentelemetry",
+		"app.kubernetes.io/version":    "0.47.0",
 	}
 
 	t.Run("should return expected collector config map", func(t *testing.T) {
 		expectedLables["app.kubernetes.io/component"] = "opentelemetry-collector"
 		expectedLables["app.kubernetes.io/name"] = "test-collector"
+		expectedLables["app.kubernetes.io/version"] = "0.47.0"
 
 		expectedData := map[string]string{
 			"collector.yaml": `processors:

pkg/collector/reconcile/suite_test.go

@@ -182,6 +182,7 @@ func params() Params {
 				UID:       instanceUID,
 			},
 			Spec: v1alpha1.OpenTelemetryCollectorSpec{
+				Image: "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator:0.47.0",
 				Ports: []v1.ServicePort{{
 					Name: "web",
 					Port: 80,

pkg/collector/statefulset_test.go

@@ -229,7 +229,7 @@ func TestStatefulSetFilterLabels(t *testing.T) {
 
 	d := StatefulSet(cfg, logger, otelcol)
 
-	assert.Len(t, d.ObjectMeta.Labels, 5)
+	assert.Len(t, d.ObjectMeta.Labels, 6)
 	for k := range excludedLabels {
 		assert.NotContains(t, d.ObjectMeta.Labels, k)
 	}