internal/manifests/collector: migrate configmap

Signed-off-by: Benedikt Bongartz <[email protected]>

Author: frzifus

internal/manifests/collector/config_replace.go

@@ -19,9 +19,14 @@ import (
 
 	promconfig "github.com/prometheus/prometheus/config"
 	_ "github.com/prometheus/prometheus/discovery/install" // Package install has the side-effect of registering all builtin.
-	"gopkg.in/yaml.v2"
-
-	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
+	// HACK: It seems that the "marshal" behavior of both yaml libraries used
+	// here is different. For the conversion of the otel configuration in v1alpha2,
+	// sig.k8s.io/yaml is used. In order not to influence the behavior
+	// too much, we will continue to use go-yaml for now.
+	go_yaml "gopkg.in/yaml.v2"
+	"sigs.k8s.io/yaml"
+
+	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha2"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests/collector/adapters"
 	ta "github.com/open-telemetry/opentelemetry-operator/internal/manifests/targetallocator/adapters"
 	"github.com/open-telemetry/opentelemetry-operator/internal/naming"
@@ -42,18 +47,22 @@ type Config struct {
 	TargetAllocConfig *targetAllocator   `yaml:"target_allocator,omitempty"`
 }
 
-func ReplaceConfig(instance v1alpha1.OpenTelemetryCollector) (string, error) {
+func ReplaceConfig(instance v1alpha2.OpenTelemetryCollector) (string, error) {
+	cfgStr, err := yaml.Marshal(&instance.Spec.Config)
+	if err != nil {
+		return "", err
+	}
 	// Check if TargetAllocator is enabled, if not, return the original config
 	if !instance.Spec.TargetAllocator.Enabled {
-		return instance.Spec.Config, nil
+		return string(cfgStr), nil
 	}
 
-	config, err := adapters.ConfigFromString(instance.Spec.Config)
+	config, err := adapters.ConfigFromString(string(cfgStr))
 	if err != nil {
 		return "", err
 	}
 
-	promCfgMap, getCfgPromErr := ta.ConfigToPromConfig(instance.Spec.Config)
+	promCfgMap, getCfgPromErr := ta.ConfigToPromConfig(string(cfgStr))
 	if getCfgPromErr != nil {
 		return "", getCfgPromErr
 	}
@@ -74,11 +83,10 @@ func ReplaceConfig(instance v1alpha1.OpenTelemetryCollector) (string, error) {
 		// type coercion checks are handled in the AddTAConfigToPromConfig method above
 		config["receivers"].(map[interface{}]interface{})["prometheus"] = updPromCfgMap
 
-		out, updCfgMarshalErr := yaml.Marshal(config)
+		out, updCfgMarshalErr := go_yaml.Marshal(config)
 		if updCfgMarshalErr != nil {
 			return "", updCfgMarshalErr
 		}
-
 		return string(out), nil
 	}
 
@@ -89,10 +97,11 @@ func ReplaceConfig(instance v1alpha1.OpenTelemetryCollector) (string, error) {
 		return "", err
 	}
 
+	// To avoid issues caused by Prometheus validation logic, which fails regex validation when it encounters
 	// type coercion checks are handled in the ConfigToPromConfig method above
 	config["receivers"].(map[interface{}]interface{})["prometheus"] = updPromCfgMap
 
-	out, err := yaml.Marshal(config)
+	out, err := go_yaml.Marshal(config)
 	if err != nil {
 		return "", err
 	}

internal/manifests/collector/config_replace_test.go

@@ -24,21 +24,24 @@ import (
 	colfeaturegate "go.opentelemetry.io/collector/featuregate"
 	"gopkg.in/yaml.v2"
 
+	"github.com/open-telemetry/opentelemetry-operator/internal/api/convert"
 	ta "github.com/open-telemetry/opentelemetry-operator/internal/manifests/targetallocator/adapters"
 	"github.com/open-telemetry/opentelemetry-operator/pkg/featuregate"
 )
 
 func TestPrometheusParser(t *testing.T) {
 	param, err := newParams("test/test-img", "testdata/http_sd_config_test.yaml")
 	assert.NoError(t, err)
+	otelCol, err := convert.V1Alpha1to2(param.OtelCol)
+	assert.NoError(t, err)
 
 	t.Run("should update config with http_sd_config", func(t *testing.T) {
 		err := colfeaturegate.GlobalRegistry().Set(featuregate.EnableTargetAllocatorRewrite.ID(), false)
 		require.NoError(t, err)
 		t.Cleanup(func() {
 			_ = colfeaturegate.GlobalRegistry().Set(featuregate.EnableTargetAllocatorRewrite.ID(), true)
 		})
-		actualConfig, err := ReplaceConfig(param.OtelCol)
+		actualConfig, err := ReplaceConfig(otelCol)
 		assert.NoError(t, err)
 
 		// prepare
@@ -71,8 +74,8 @@ func TestPrometheusParser(t *testing.T) {
 
 	t.Run("should update config with targetAllocator block if block not present", func(t *testing.T) {
 		// Set up the test scenario
-		param.OtelCol.Spec.TargetAllocator.Enabled = true
-		actualConfig, err := ReplaceConfig(param.OtelCol)
+		otelCol.Spec.TargetAllocator.Enabled = true
+		actualConfig, err := ReplaceConfig(otelCol)
 		assert.NoError(t, err)
 
 		// Verify the expected changes in the config
@@ -96,9 +99,12 @@ func TestPrometheusParser(t *testing.T) {
 		// Set up the test scenario
 		paramTa, err := newParams("test/test-img", "testdata/http_sd_config_ta_test.yaml")
 		require.NoError(t, err)
+		otelColTa, err := convert.V1Alpha1to2(paramTa.OtelCol)
+		assert.NoError(t, err)
+
 		paramTa.OtelCol.Spec.TargetAllocator.Enabled = true
 
-		actualConfig, err := ReplaceConfig(paramTa.OtelCol)
+		actualConfig, err := ReplaceConfig(otelColTa)
 		assert.NoError(t, err)
 
 		// Verify the expected changes in the config
@@ -119,8 +125,9 @@ func TestPrometheusParser(t *testing.T) {
 	})
 
 	t.Run("should not update config with http_sd_config", func(t *testing.T) {
-		param.OtelCol.Spec.TargetAllocator.Enabled = false
-		actualConfig, err := ReplaceConfig(param.OtelCol)
+		otelCol.Spec.TargetAllocator.Enabled = false
+
+		actualConfig, err := ReplaceConfig(otelCol)
 		assert.NoError(t, err)
 
 		// prepare
@@ -156,14 +163,16 @@ func TestPrometheusParser(t *testing.T) {
 func TestReplaceConfig(t *testing.T) {
 	param, err := newParams("test/test-img", "testdata/relabel_config_original.yaml")
 	assert.NoError(t, err)
+	otelCol, err := convert.V1Alpha1to2(param.OtelCol)
+	assert.NoError(t, err)
 
 	t.Run("should not modify config when TargetAllocator is disabled", func(t *testing.T) {
-		param.OtelCol.Spec.TargetAllocator.Enabled = false
+		otelCol.Spec.TargetAllocator.Enabled = false
 		expectedConfigBytes, err := os.ReadFile("testdata/relabel_config_original.yaml")
 		assert.NoError(t, err)
 		expectedConfig := string(expectedConfigBytes)
 
-		actualConfig, err := ReplaceConfig(param.OtelCol)
+		actualConfig, err := ReplaceConfig(otelCol)
 		assert.NoError(t, err)
 
 		assert.Equal(t, expectedConfig, actualConfig)
@@ -176,26 +185,26 @@ func TestReplaceConfig(t *testing.T) {
 			_ = colfeaturegate.GlobalRegistry().Set(featuregate.EnableTargetAllocatorRewrite.ID(), true)
 		})
 
-		param.OtelCol.Spec.TargetAllocator.Enabled = true
+		otelCol.Spec.TargetAllocator.Enabled = true
 
 		expectedConfigBytes, err := os.ReadFile("testdata/relabel_config_expected_with_sd_config.yaml")
 		assert.NoError(t, err)
 		expectedConfig := string(expectedConfigBytes)
 
-		actualConfig, err := ReplaceConfig(param.OtelCol)
+		actualConfig, err := ReplaceConfig(otelCol)
 		assert.NoError(t, err)
 
 		assert.Equal(t, expectedConfig, actualConfig)
 	})
 
 	t.Run("should remove scrape configs if TargetAllocator is enabled and feature flag is set", func(t *testing.T) {
-		param.OtelCol.Spec.TargetAllocator.Enabled = true
+		otelCol.Spec.TargetAllocator.Enabled = true
 
 		expectedConfigBytes, err := os.ReadFile("testdata/config_expected_targetallocator.yaml")
 		assert.NoError(t, err)
 		expectedConfig := string(expectedConfigBytes)
 
-		actualConfig, err := ReplaceConfig(param.OtelCol)
+		actualConfig, err := ReplaceConfig(otelCol)
 		assert.NoError(t, err)
 
 		assert.Equal(t, expectedConfig, actualConfig)

internal/manifests/collector/configmap.go

@@ -18,16 +18,21 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+	"github.com/open-telemetry/opentelemetry-operator/internal/api/convert"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests/manifestutils"
 	"github.com/open-telemetry/opentelemetry-operator/internal/naming"
 )
 
 func ConfigMap(params manifests.Params) (*corev1.ConfigMap, error) {
-	name := naming.ConfigMap(params.OtelCol.Name)
-	labels := manifestutils.Labels(params.OtelCol.ObjectMeta, name, params.OtelCol.Spec.Image, ComponentOpenTelemetryCollector, []string{})
+	otelCol, err := convert.V1Alpha1to2(params.OtelCol)
+	if err != nil {
+		return nil, err
+	}
+	name := naming.ConfigMap(otelCol.Name)
+	labels := manifestutils.Labels(otelCol.ObjectMeta, name, otelCol.Spec.Image, ComponentOpenTelemetryCollector, []string{})
 
-	replacedConf, err := ReplaceConfig(params.OtelCol)
+	replacedConf, err := ReplaceConfig(otelCol)
 	if err != nil {
 		params.Log.V(2).Info("failed to update prometheus config to use sharded targets: ", "err", err)
 		return nil, err
@@ -36,9 +41,9 @@ func ConfigMap(params manifests.Params) (*corev1.ConfigMap, error) {
 	return &corev1.ConfigMap{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:        name,
-			Namespace:   params.OtelCol.Namespace,
+			Namespace:   otelCol.Namespace,
 			Labels:      labels,
-			Annotations: params.OtelCol.Annotations,
+			Annotations: otelCol.Annotations,
 		},
 		Data: map[string]string{
 			"collector.yaml": replacedConf,