Add support for experimental features at build time

Signed-off-by: jose.vazquez <[email protected]>

Author: josvazg

.licenses-gomod.sha256

@@ -1 +1 @@
-100644 cc82b2933dc41b1ba0560cbc6b1709c13678dcf7 go.mod
+100644 b68045f891e8dcb43981fbcd757bf32e36a699fd go.mod

Makefile

@@ -13,6 +13,15 @@ DOCKER_SBOM_PLUGIN_VERSION=0.6.1
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
 VERSION ?= $(shell git describe --always --tags --dirty --broken | cut -c 2-)
 
+# LD_FLAGS
+LD_FLAG_SET_VERSION = -X github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/version.Version=$(VERSION)
+LD_FLAGS_SET_EXPERIMENTAL = -X github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/version.Experimental=$(EXPERIMENTAL)
+ifdef EXPERIMENTAL
+LD_FLAGS = $(LD_FLAGS_SET_EXPERIMENTAL) $(LD_FLAG_SET_VERSION)
+else
+LD_FLAGS = $(LD_FLAG_SET_VERSION)
+endif
+
 # NEXT_VERSION represents a version that is higher than anything released
 # VERSION default value does not play well with the run target which might end up failing
 # with errors such as:
@@ -219,7 +228,7 @@ bin/$(TARGET_OS)/$(TARGET_ARCH):
 
 bin/$(TARGET_OS)/$(TARGET_ARCH)/manager: $(GO_SOURCES) bin/$(TARGET_OS)/$(TARGET_ARCH)
 	@echo "Building operator with version $(VERSION); $(TARGET_OS) - $(TARGET_ARCH)"
-	CGO_ENABLED=0 GOOS=$(TARGET_OS) GOARCH=$(TARGET_ARCH) go build -o $@ -ldflags="-X github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/version.Version=$(VERSION)" cmd/main.go
+	CGO_ENABLED=0 GOOS=$(TARGET_OS) GOARCH=$(TARGET_ARCH) go build -o $@ -ldflags="$(LD_FLAGS)" cmd/main.go
 	@touch $@
 
 bin/manager: bin/$(TARGET_OS)/$(TARGET_ARCH)/manager
@@ -246,7 +255,9 @@ manifests: CRD_OPTIONS ?= "crd:crdVersions=v1,ignoreUnexportedFields=true"
 manifests: fmt ## Generate manifests e.g. CRD, RBAC etc.
 	controller-gen $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./api/..." paths="./internal/controller/..." output:crd:artifacts:config=config/crd/bases
 	@./scripts/split_roles_yaml.sh
-
+ifdef EXPERIMENTAL
+	controller-gen crd paths="./internal/nextapi/v1" output:crd:artifacts:config=internal/next-crds
+endif
 
 .PHONY: lint
 lint: ## Run the lint against the code
@@ -275,6 +286,9 @@ vet: $(TIMESTAMPS_DIR)/vet ## Run go vet against code
 .PHONY: generate
 generate: ${GO_SOURCES} ## Generate code
 	controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./api/..." paths="./internal/controller/..."
+ifdef EXPERIMENTAL
+	controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./internal/nextapi/v1/..."
+endif
 	$(MAKE) fmt
 
 .PHONY: check-missing-files
@@ -530,6 +544,9 @@ clear-e2e-leftovers: ## Clear the e2e test leftovers quickly
 .PHONY: install-crds
 install-crds: ## Install CRDs in Kubernetes
 	kubectl apply -k config/crd
+ifdef EXPERIMENTAL
+	kubectl apply -f internal/next-crds/*.yaml
+endif
 
 .PHONY: set-namespace
 set-namespace:
@@ -553,7 +570,7 @@ prepare-run: generate vet manifests run-kind install-crds install-credentials
 .PHONY: run
 run: prepare-run ## Run a freshly compiled manager against kind
 ifdef RUN_YAML
-	kubectl apply -f $(RUN_YAML)
+	kubectl apply -n $(OPERATOR_NAMESPACE) -f $(RUN_YAML)
 endif
 	VERSION=$(NEXT_VERSION) \
 	OPERATOR_POD_NAME=$(OPERATOR_POD_NAME) \

cmd/main.go

@@ -73,6 +73,9 @@ func main() {
 	ctrl.SetLogger(logrLogger.WithName("ctrl"))
 	klog.SetLogger(logrLogger.WithName("klog"))
 	setupLog := logger.Named("setup").Sugar()
+	if version.IsExperimental() {
+		setupLog.Warn("Experimental features enabled!")
+	}
 	setupLog.Info("starting with configuration", zap.Any("config", config), zap.Any("version", version.Version))
 
 	runnable, err := operator.NewBuilder(operator.ManagerProviderFunc(ctrl.NewManager), akoScheme, time.Duration(minimumIndependentSyncPeriod)*time.Minute).
@@ -87,6 +90,7 @@ func main() {
 		WithDeletionProtection(config.ObjectDeletionProtection).
 		WithIndependentSyncPeriod(time.Duration(config.IndependentSyncPeriod) * time.Minute).
 		WithDryRun(config.DryRun).
+		WithExperimentalReconcilers(version.IsExperimental()).
 		Build(ctx)
 	if err != nil {
 		setupLog.Error(err, "unable to start operator")

internal/controller/registry.go

@@ -43,6 +43,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/controller/watch"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/dryrun"
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/featureflags"
+	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/version"
 )
 
 type Reconciler interface {
@@ -114,6 +115,9 @@ func (r *Registry) registerControllers(c cluster.Cluster, ap atlas.Provider) {
 	reconcilers = append(reconcilers, atlasipaccesslist.NewAtlasIPAccessListReconciler(c, r.defaultPredicates(), ap, r.deletionProtection, r.independentSyncPeriod, r.logger, r.globalSecretRef))
 	reconcilers = append(reconcilers, atlasnetworkcontainer.NewAtlasNetworkContainerReconciler(c, r.defaultPredicates(), ap, r.deletionProtection, r.logger, r.independentSyncPeriod, r.globalSecretRef))
 	reconcilers = append(reconcilers, atlasnetworkpeering.NewAtlasNetworkPeeringsReconciler(c, r.defaultPredicates(), ap, r.deletionProtection, r.logger, r.independentSyncPeriod, r.globalSecretRef))
+	if version.IsExperimental() {
+		// Experimental reconciler initializations go here
+	}
 	r.reconcilers = reconcilers
 }
 

internal/operator/builder.go

@@ -81,14 +81,15 @@ type Builder struct {
 	leaderElection        bool
 	leaderElectionID      string
 
-	atlasDomain        string
-	predicates         []predicate.Predicate
-	apiSecret          client.ObjectKey
-	atlasProvider      atlas.Provider
-	featureFlags       *featureflags.FeatureFlags
-	deletionProtection bool
-	skipNameValidation bool
-	dryRun             bool
+	atlasDomain             string
+	predicates              []predicate.Predicate
+	apiSecret               client.ObjectKey
+	atlasProvider           atlas.Provider
+	featureFlags            *featureflags.FeatureFlags
+	deletionProtection      bool
+	skipNameValidation      bool
+	dryRun                  bool
+	experimentalReconcilers bool
 }
 
 func (b *Builder) WithConfig(config *rest.Config) *Builder {
@@ -175,6 +176,11 @@ func (b *Builder) WithDryRun(dryRun bool) *Builder {
 	return b
 }
 
+func (b *Builder) WithExperimentalReconcilers(experimentalReconcilers bool) *Builder {
+	b.experimentalReconcilers = experimentalReconcilers
+	return b
+}
+
 // Build builds the cluster object and configures operator controllers
 func (b *Builder) Build(ctx context.Context) (cluster.Cluster, error) {
 	mergeDefaults(b)
@@ -202,7 +208,14 @@ func (b *Builder) Build(ctx context.Context) (cluster.Cluster, error) {
 		}
 	}
 
-	controllerRegistry := controller.NewRegistry(b.predicates, b.deletionProtection, b.logger, b.independentSyncPeriod, b.featureFlags, b.apiSecret)
+	controllerRegistry := controller.NewRegistry(
+		b.predicates,
+		b.deletionProtection,
+		b.logger,
+		b.independentSyncPeriod,
+		b.featureFlags,
+		b.apiSecret,
+	)
 
 	var akoCluster cluster.Cluster
 	if b.dryRun {

internal/version/experimental_test.go

@@ -0,0 +1,51 @@
+// Copyright 2025 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package version
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestIsExperimental(t *testing.T) {
+	testCases := []struct {
+		title string
+		set   string
+		want  bool
+	}{
+		{
+			title: "default is not experimental",
+		},
+		{
+			title: "setting true makes it experimental",
+			set:   "true",
+			want:  true,
+		},
+		{
+			title: "setting other value is not experimental",
+			set:   "1",
+			want:  false,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.title, func(t *testing.T) {
+			if tc.set != "" {
+				Experimental = tc.set
+			}
+			assert.Equal(t, tc.want, IsExperimental())
+		})
+	}
+}

internal/version/version.go

@@ -24,7 +24,14 @@ const DefaultVersion = "unknown"
 // Version set by the linker during link time.
 var Version = DefaultVersion
 
+// Experimental enables unreleased features
+var Experimental = "false"
+
 func IsRelease(v string) bool {
 	return v != DefaultVersion &&
 		regexp.MustCompile(`^[0-9]+\.[0-9]+\.[0-9]+[-certified]*$`).Match([]byte(strings.TrimSpace(v)))
 }
+
+func IsExperimental() bool {
+	return Experimental == "true"
+}

licenses.csv

@@ -113,7 +113,7 @@ golang.org/x/exp,https://cs.opensource.google/go/x/exp/+/8a7402ab:LICENSE,BSD-3-
 golang.org/x/net,https://cs.opensource.google/go/x/net/+/v0.40.0:LICENSE,BSD-3-Clause
 golang.org/x/oauth2,https://cs.opensource.google/go/x/oauth2/+/v0.30.0:LICENSE,BSD-3-Clause
 golang.org/x/sync,https://cs.opensource.google/go/x/sync/+/v0.14.0:LICENSE,BSD-3-Clause
-golang.org/x/sys,https://cs.opensource.google/go/x/sys/+/v0.33.0:LICENSE,BSD-3-Clause
+golang.org/x/sys/unix,https://cs.opensource.google/go/x/sys/+/v0.33.0:LICENSE,BSD-3-Clause
 golang.org/x/term,https://cs.opensource.google/go/x/term/+/v0.32.0:LICENSE,BSD-3-Clause
 golang.org/x/text,https://cs.opensource.google/go/x/text/+/v0.25.0:LICENSE,BSD-3-Clause
 golang.org/x/time/rate,https://cs.opensource.google/go/x/time/+/v0.11.0:LICENSE,BSD-3-Clause