switch to featuregate

Author: jaronoff97

.chloggen/add_all_receiver_defaults.yaml

@@ -13,4 +13,6 @@ issues: [3126]
 # (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:
+subtext: |
+  This feature is enabled by default. It can be disabled by specifying
+  `--feature-gates=-operator.collector.default.config`.

apis/v1beta1/collector_webhook.go

@@ -30,6 +30,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-operator/internal/fips"
 	ta "github.com/open-telemetry/opentelemetry-operator/internal/manifests/targetallocator/adapters"
 	"github.com/open-telemetry/opentelemetry-operator/internal/rbac"
+	"github.com/open-telemetry/opentelemetry-operator/pkg/featuregate"
 )
 
 var (
@@ -43,14 +44,13 @@ var (
 // +kubebuilder:object:generate=false
 
 type CollectorWebhook struct {
-	logger            logr.Logger
-	cfg               config.Config
-	scheme            *runtime.Scheme
-	reviewer          *rbac.Reviewer
-	metrics           *Metrics
-	bv                BuildValidator
-	fips              fips.FIPSCheck
-	disableDefaulting bool
+	logger   logr.Logger
+	cfg      config.Config
+	scheme   *runtime.Scheme
+	reviewer *rbac.Reviewer
+	metrics  *Metrics
+	bv       BuildValidator
+	fips     fips.FIPSCheck
 }
 
 func (c CollectorWebhook) Default(_ context.Context, obj runtime.Object) error {
@@ -101,7 +101,7 @@ func (c CollectorWebhook) Default(_ context.Context, obj runtime.Object) error {
 	if len(otelcol.Spec.ManagementState) == 0 {
 		otelcol.Spec.ManagementState = ManagementStateManaged
 	}
-	if c.disableDefaulting {
+	if !featuregate.EnableConfigDefaulting.IsEnabled() {
 		return nil
 	}
 	return otelcol.Spec.Config.ApplyDefaults(c.logger)
@@ -435,30 +435,20 @@ func NewCollectorWebhook(
 	metrics *Metrics,
 	bv BuildValidator,
 	fips fips.FIPSCheck,
-	disableDefaulting bool) *CollectorWebhook {
+) *CollectorWebhook {
 	return &CollectorWebhook{
-		logger:            logger,
-		scheme:            scheme,
-		cfg:               cfg,
-		reviewer:          reviewer,
-		metrics:           metrics,
-		bv:                bv,
-		fips:              fips,
-		disableDefaulting: disableDefaulting,
+		logger:   logger,
+		scheme:   scheme,
+		cfg:      cfg,
+		reviewer: reviewer,
+		metrics:  metrics,
+		bv:       bv,
+		fips:     fips,
 	}
 }
 
-func SetupCollectorWebhook(mgr ctrl.Manager, cfg config.Config, reviewer *rbac.Reviewer, metrics *Metrics, bv BuildValidator, fipsCheck fips.FIPSCheck, disableDefaulting bool) error {
-	cvw := NewCollectorWebhook(
-		mgr.GetLogger().WithValues("handler", "CollectorWebhook", "version", "v1beta1"),
-		mgr.GetScheme(),
-		cfg,
-		reviewer,
-		metrics,
-		bv,
-		fipsCheck,
-		disableDefaulting,
-	)
+func SetupCollectorWebhook(mgr ctrl.Manager, cfg config.Config, reviewer *rbac.Reviewer, metrics *Metrics, bv BuildValidator, fipsCheck fips.FIPSCheck) error {
+	cvw := NewCollectorWebhook(mgr.GetLogger().WithValues("handler", "CollectorWebhook", "version", "v1beta1"), mgr.GetScheme(), cfg, reviewer, metrics, bv, fipsCheck)
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(&OpenTelemetryCollector{}).
 		WithValidator(cvw).

apis/v1beta1/collector_webhook_test.go

@@ -103,10 +103,18 @@ func TestValidate(t *testing.T) {
 
 	for _, tt := range tests {
 		test := tt
-		webhook := v1beta1.NewCollectorWebhook(logr.Discard(), testScheme, config.New(
-			config.WithCollectorImage("collector:v0.0.0"),
-			config.WithTargetAllocatorImage("ta:v0.0.0"),
-		), getReviewer(test.shouldFailSar), nil, bv, nil, false)
+		webhook := v1beta1.NewCollectorWebhook(
+			logr.Discard(),
+			testScheme,
+			config.New(
+				config.WithCollectorImage("collector:v0.0.0"),
+				config.WithTargetAllocatorImage("ta:v0.0.0"),
+			),
+			getReviewer(test.shouldFailSar),
+			nil,
+			bv,
+			nil,
+		)
 		t.Run(tt.name, func(t *testing.T) {
 			tt := tt
 			warnings, err := webhook.Validate(context.Background(), &tt.collector)
@@ -531,10 +539,18 @@ func TestCollectorDefaultingWebhook(t *testing.T) {
 	for _, test := range tests {
 		test := test
 		t.Run(test.name, func(t *testing.T) {
-			cvw := v1beta1.NewCollectorWebhook(logr.Discard(), testScheme, config.New(
-				config.WithCollectorImage("collector:v0.0.0"),
-				config.WithTargetAllocatorImage("ta:v0.0.0"),
-			), getReviewer(test.shouldFailSar), nil, bv, nil, false)
+			cvw := v1beta1.NewCollectorWebhook(
+				logr.Discard(),
+				testScheme,
+				config.New(
+					config.WithCollectorImage("collector:v0.0.0"),
+					config.WithTargetAllocatorImage("ta:v0.0.0"),
+				),
+				getReviewer(test.shouldFailSar),
+				nil,
+				bv,
+				nil,
+			)
 			ctx := context.Background()
 			err := cvw.Default(ctx, &test.otelcol)
 			assert.NoError(t, err)
@@ -1315,10 +1331,18 @@ func TestOTELColValidatingWebhook(t *testing.T) {
 	for _, test := range tests {
 		test := test
 		t.Run(test.name, func(t *testing.T) {
-			cvw := v1beta1.NewCollectorWebhook(logr.Discard(), testScheme, config.New(
-				config.WithCollectorImage("collector:v0.0.0"),
-				config.WithTargetAllocatorImage("ta:v0.0.0"),
-			), getReviewer(test.shouldFailSar), nil, bv, nil, false)
+			cvw := v1beta1.NewCollectorWebhook(
+				logr.Discard(),
+				testScheme,
+				config.New(
+					config.WithCollectorImage("collector:v0.0.0"),
+					config.WithTargetAllocatorImage("ta:v0.0.0"),
+				),
+				getReviewer(test.shouldFailSar),
+				nil,
+				bv,
+				nil,
+			)
 			ctx := context.Background()
 			warnings, err := cvw.ValidateCreate(ctx, &test.otelcol)
 			if test.expectedErr == "" {
@@ -1375,10 +1399,18 @@ func TestOTELColValidateUpdateWebhook(t *testing.T) {
 	for _, test := range tests {
 		test := test
 		t.Run(test.name, func(t *testing.T) {
-			cvw := v1beta1.NewCollectorWebhook(logr.Discard(), testScheme, config.New(
-				config.WithCollectorImage("collector:v0.0.0"),
-				config.WithTargetAllocatorImage("ta:v0.0.0"),
-			), getReviewer(test.shouldFailSar), nil, bv, nil, false)
+			cvw := v1beta1.NewCollectorWebhook(
+				logr.Discard(),
+				testScheme,
+				config.New(
+					config.WithCollectorImage("collector:v0.0.0"),
+					config.WithTargetAllocatorImage("ta:v0.0.0"),
+				),
+				getReviewer(test.shouldFailSar),
+				nil,
+				bv,
+				nil,
+			)
 			ctx := context.Background()
 			warnings, err := cvw.ValidateUpdate(ctx, &test.otelcolOld, &test.otelcolNew)
 			if test.expectedErr == "" {

config/manager/kustomization.yaml

@@ -5,4 +5,4 @@ kind: Kustomization
 images:
 - name: controller
   newName: jaronoff/opentelemetry-operator
-  newTag: op-v177
+  newTag: op-v178

controllers/suite_test.go

@@ -182,7 +182,7 @@ func TestMain(m *testing.M) {
 	}
 	reviewer := rbac.NewReviewer(clientset)
 
-	if err = v1beta1.SetupCollectorWebhook(mgr, config.New(), reviewer, nil, nil, nil, false); err != nil {
+	if err = v1beta1.SetupCollectorWebhook(mgr, config.New(), reviewer, nil, nil, nil); err != nil {
 		fmt.Printf("failed to SetupWebhookWithManager: %v", err)
 		os.Exit(1)
 	}

internal/webhook/podmutation/webhookhandler_suite_test.go

@@ -105,7 +105,7 @@ func TestMain(m *testing.M) {
 	}
 	reviewer := rbac.NewReviewer(clientset)
 
-	if err = v1beta1.SetupCollectorWebhook(mgr, config.New(), reviewer, nil, nil, nil, false); err != nil {
+	if err = v1beta1.SetupCollectorWebhook(mgr, config.New(), reviewer, nil, nil, nil); err != nil {
 		fmt.Printf("failed to SetupWebhookWithManager: %v", err)
 		os.Exit(1)
 	}

main.go

@@ -123,7 +123,6 @@ func main() {
 		enableNodeJSInstrumentation      bool
 		enableJavaInstrumentation        bool
 		enableCRMetrics                  bool
-		disableEndpointDefaulting        bool
 		collectorImage                   string
 		targetAllocatorImage             string
 		operatorOpAMPBridgeImage         string
@@ -163,7 +162,6 @@ func main() {
 	pflag.BoolVar(&enableNodeJSInstrumentation, constants.FlagNodeJS, true, "Controls whether the operator supports nodejs auto-instrumentation")
 	pflag.BoolVar(&enableJavaInstrumentation, constants.FlagJava, true, "Controls whether the operator supports java auto-instrumentation")
 	pflag.BoolVar(&enableCRMetrics, constants.FlagCRMetrics, false, "Controls whether exposing the CR metrics is enabled")
-	pflag.BoolVar(&disableEndpointDefaulting, "disable-event-defaulting", false, "Controls whether the operator should attempt to default the configuration for components")
 
 	stringFlagOrEnv(&collectorImage, "collector-image", "RELATED_IMAGE_COLLECTOR", fmt.Sprintf("ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector:%s", v.OpenTelemetryCollector), "The default OpenTelemetry collector image. This image is used when no image is specified in the CustomResource.")
 	stringFlagOrEnv(&targetAllocatorImage, "target-allocator-image", "RELATED_IMAGE_TARGET_ALLOCATOR", fmt.Sprintf("ghcr.io/open-telemetry/opentelemetry-operator/target-allocator:%s", v.TargetAllocator), "The default OpenTelemetry target allocator image. This image is used when no image is specified in the CustomResource.")
@@ -218,7 +216,6 @@ func main() {
 		"go-version", v.Go,
 		"go-arch", runtime.GOARCH,
 		"go-os", runtime.GOOS,
-		"disable-event-defaulting", disableEndpointDefaulting,
 		"labels-filter", labelsFilter,
 		"annotations-filter", annotationsFilter,
 		"enable-multi-instrumentation", enableMultiInstrumentation,
@@ -450,7 +447,7 @@ func main() {
 			logger.Info("Fips disabled components", "receivers", receivers, "exporters", exporters, "processors", processors, "extensions", extensions)
 			fipsCheck = fips.NewFipsCheck(receivers, exporters, processors, extensions)
 		}
-		if err = otelv1beta1.SetupCollectorWebhook(mgr, cfg, reviewer, crdMetrics, bv, fipsCheck, disableEndpointDefaulting); err != nil {
+		if err = otelv1beta1.SetupCollectorWebhook(mgr, cfg, reviewer, crdMetrics, bv, fipsCheck); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "OpenTelemetryCollector")
 			os.Exit(1)
 		}

pkg/collector/upgrade/suite_test.go

@@ -105,7 +105,7 @@ func TestMain(m *testing.M) {
 	}
 	reviewer := rbac.NewReviewer(clientset)
 
-	if err = v1beta1.SetupCollectorWebhook(mgr, config.New(), reviewer, nil, nil, nil, false); err != nil {
+	if err = v1beta1.SetupCollectorWebhook(mgr, config.New(), reviewer, nil, nil, nil); err != nil {
 		fmt.Printf("failed to SetupWebhookWithManager: %v", err)
 		os.Exit(1)
 	}

pkg/featuregate/featuregate.go

@@ -40,6 +40,13 @@ var (
 		featuregate.WithRegisterDescription("enables feature to set GOMEMLIMIT and GOMAXPROCS automatically"),
 		featuregate.WithRegisterFromVersion("v0.100.0"),
 	)
+	// EnableConfigDefaulting is the feature gate that enables the operator to default the endpoint for known components.
+	EnableConfigDefaulting = featuregate.GlobalRegistry().MustRegister(
+		"operator.collector.default.config",
+		featuregate.StageBeta,
+		featuregate.WithRegisterDescription("enables the operator to default the endpoint for known components"),
+		featuregate.WithRegisterFromVersion("v0.110.0"),
+	)
 )
 
 // Flags creates a new FlagSet that represents the available featuregate flags using the supplied featuregate registry.