CSPL-3675 Update Operator-SDK to v1.39 (#1488)

* v.1.39.0 migration

---------

Co-authored-by: igor.grzankowski <@splunk.com>
Co-authored-by: Vivek Reddy <[email protected]>
Co-authored-by: rlieberman-splunk <[email protected]>
Co-authored-by: kasiakoziol <[email protected]>
Co-authored-by: Patryk Wasielewski <[email protected]>

Author: 5 people

.biased_lang_exclude

@@ -29,11 +29,11 @@ api/v3/licensemaster_types.go
 api/v3/zz_generated.deepcopy.go
 api/v3/common_types.go
 pkg/splunk/enterprise/licensemaster.go
-controllers/licensemaster_controller.go
+controller/licensemaster_controller.go
 tools/k8s_collectors/k8s-systeminfo-collector.sh
-controllers/common/predicate.go
+controller/common/predicate.go
 pkg/splunk/enterprise/finalizers.go
-controllers/monitoringconsole_controller.go
+controller/monitoringconsole_controller.go
 pkg/splunk/enterprise/events.go
 #Exceptions for dual support of cluster manager
 api/v3/clustermaster_types.go
@@ -47,9 +47,9 @@ config/rbac/clustermaster_editor_role.yaml
 config/rbac/clustermaster_viewer_role.yaml
 config/rbac/clustermanager_editor_role.yaml
 config/rbac/clustermanager_viewer_role.yaml
-controllers/clustermaster_controller.go
-controllers/clustermaster_controller_test.go
-controllers/licensemaster_controller_test.go
+controller/clustermaster_controller.go
+controller/clustermaster_controller_test.go
+controller/licensemaster_controller_test.go
 kuttl/tests/smoke/clustered-master-deployment-c3/00-assert.yaml
 kuttl/tests/smoke/clustered-master-deployment-c3/00-deploy-clustermanager.yaml
 kuttl/tests/smoke/clustered-master-deployment-c3/01-deploy-indexercluster.yaml
@@ -82,7 +82,7 @@ main.go
 PROJECT
 pkg/
 deploy/
-controllers/
+internal/controller/
 test/
 docs/
 README.md

.env

@@ -1,4 +1,4 @@
-OPERATOR_SDK_VERSION=v1.31.0
+OPERATOR_SDK_VERSION=v1.39.0
 REVIEWERS=vivekr-splunk,rlieberman-splunk,patrykw-splunk,Igor-splunk,kasiakoziol
 GO_VERSION=1.23.0
 AWSCLI_URL=https://awscli.amazonaws.com/awscli-exe-linux-x86_64-2.8.6.zip

Dockerfile

@@ -8,7 +8,7 @@ ARG BASE_IMAGE=registry.access.redhat.com/ubi8/ubi-minimal@sha256
 ARG BASE_IMAGE_VERSION=3b0f20d81f5fc0dfb3f96cbe9912e02959d1e508411e0e46fad52520208a651c
 
 # Build the manager binary
-FROM golang:1.23.0 AS builder
+FROM golang:1.24.2 AS builder
 
 WORKDIR /workspace
 
@@ -19,16 +19,16 @@ COPY go.sum go.sum
 RUN go mod download
 
 # Copy the go source
-COPY main.go main.go
+COPY cmd/main.go cmd/main.go
 COPY api/ api/
-COPY controllers/ controllers/
+COPY internal/controller/ internal/controller/
 COPY pkg/ pkg/
 COPY tools/ tools/
 COPY hack hack/
 
 # Build
 # TARGETOS and TARGETARCH are provided(inferred) by buildx via the --platforms flag
-RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -a -o manager main.go
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go
 
 # Use BASE_IMAGE as the base image
 FROM ${BASE_IMAGE}:${BASE_IMAGE_VERSION}

Dockerfile.distroless

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.23.0 AS builder
+FROM golang:1.24.2 AS builder
 
 WORKDIR /workspace
 # Copy the Go Modules manifests
@@ -9,16 +9,16 @@ COPY go.sum go.sum
 RUN go mod download
 
 # Copy the go source
-COPY main.go main.go
+COPY cmd/main.go cmd/main.go
 COPY api/ api/
-COPY controllers/ controllers/
+COPY internal/controller/ internal/controller/
 COPY pkg/ pkg/
 COPY tools/ tools/
 COPY hack hack/
 
 # Build
 # TARGETOS and TARGETARCH are provided(inferred) by buildx via the --platforms flag
-RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -a -o manager main.go
+RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless

Makefile

@@ -11,7 +11,7 @@ ${ENVIRONMENT}:
 VERSION ?= 2.8.0
 
 # SPLUNK_ENTERPRISE_IMAGE defines the splunk docker tag that is used as default image.
-SPLUNK_ENTERPRISE_IMAGE ?= "docker.io/splunk/splunk:edge"
+SPLUNK_ENTERPRISE_IMAGE ?= "docker.io/splunk/splunk"
 
 # WATCH_NAMESPACE defines if its clusterwide operator or namespace specific
 # by default we leave it as clusterwide if it has to be namespace specific,
@@ -54,7 +54,7 @@ BUNDLE_IMG ?= ${IMAGE_TAG_BASE}-bundle:v${VERSION}
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
-ENVTEST_K8S_VERSION = 1.26.0
+ENVTEST_K8S_VERSION = 1.31.0
 
 ignore-not-found ?= True
 
@@ -127,20 +127,20 @@ scheck: ## Run static check against code
 	go install honnef.co/go/tools/cmd/[email protected]
 	staticcheck ./...
 
-vet: setup/ginkgo ## Run go vet against code.
+vet: setup/ginkgo	 ## Run go vet against code.
 	go vet ./...
 
 test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use ${ENVTEST_K8S_VERSION} --bin-dir $(LOCALBIN) -p path)" ginkgo --junit-report=unit_test.xml --output-dir=`pwd` -vv --trace --keep-going --timeout=3h --cover --covermode=count --coverprofile=coverage.out ./pkg/splunk/common ./pkg/splunk/enterprise ./pkg/splunk/controller ./pkg/splunk/client ./pkg/splunk/util ./controllers
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use ${ENVTEST_K8S_VERSION} --bin-dir $(LOCALBIN) -p path)" ginkgo --junit-report=unit_test.xml --output-dir=`pwd` -vv --trace --keep-going --timeout=3h --cover --covermode=count --coverprofile=coverage.out ./pkg/splunk/common ./pkg/splunk/enterprise ./pkg/splunk/client ./pkg/splunk/util ./internal/controller ./pkg/splunk/splkcontroller
 
 
 ##@ Build
 
 build: setup/ginkgo manifests generate fmt vet ## Build manager binary.
-	go build -o bin/manager main.go
+	go build -o bin/manager cmd/main.go
 
 run: manifests generate fmt vet ## Run a controller from your host.
-	go run ./main.go
+	go run ./cmd/main.go
 
 docker-build: #test ## Build docker image with the manager.
 	docker build -t ${IMG} .
@@ -162,20 +162,23 @@ BASE_IMAGE_VERSION ?= 3b0f20d81f5fc0dfb3f96cbe9912e02959d1e508411e0e46fad5252020
 
 docker-buildx:
 	@if [ -z "${IMG}" ]; then \
-		echo "Error: IMG is a mandatory argument. Usage: make docker-buildx IMG=<image_name> ...."; \
-		exit 1; \
-	fi; \
-	if echo "${BASE_IMAGE}" | grep -q "distroless"; then \
-		DOCKERFILE="Dockerfile.distroless"; \
-		BUILD_TAG="${IMG}-distroless"; \
-	else \
-		DOCKERFILE="Dockerfile"; \
-		BUILD_TAG="${IMG}"; \
-	fi; \
-	docker buildx build --push --platform="${PLATFORMS}" \
-		--build-arg BASE_IMAGE="${BASE_IMAGE}" \
-		--build-arg BASE_IMAGE_VERSION="${BASE_IMAGE_VERSION}" \
-		--tag "$$BUILD_TAG" -f "$$DOCKERFILE" .
+            echo "Error: IMG is a mandatory argument. Usage: make docker-buildx IMG=<image_name> ...."; \
+            exit 1; \
+        fi; \
+        	docker buildx create --name project-v3-builder --use || true; \
+        	docker buildx use project-v3-builder; \
+        if echo "${BASE_IMAGE}" | grep -q "distroless"; then \
+            DOCKERFILE="Dockerfile.distroless"; \
+            BUILD_TAG="${IMG}-distroless"; \
+        else \
+            DOCKERFILE="Dockerfile"; \
+            BUILD_TAG="${IMG}"; \
+        fi; \
+        docker buildx build --push --platform="${PLATFORMS}" \
+            --build-arg BASE_IMAGE="${BASE_IMAGE}" \
+            --build-arg BASE_IMAGE_VERSION="${BASE_IMAGE_VERSION}" \
+            --tag "$$BUILD_TAG" -f "$$DOCKERFILE" .; \
+        - docker buildx rm project-v3-builder || true
 
 
 
@@ -205,7 +208,7 @@ $(LOCALBIN):
 	mkdir -p $(LOCALBIN)
 
 ## Tool Versions
-KUSTOMIZE_VERSION ?= v4.5.5
+KUSTOMIZE_VERSION ?= v5.4.3
 CONTROLLER_TOOLS_VERSION ?= v0.16.1
 
 CONTROLLER_GEN = $(LOCALBIN)/controller-gen
@@ -255,7 +258,7 @@ ifeq (,$(shell which opm 2>/dev/null))
 	set -e ;\
 	mkdir -p $(dir $(OPM)) ;\
 	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
-	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm ;\
+	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.24.2/$${OS}-$${ARCH}-opm ;\
 	chmod +x $(OPM) ;\
 	}
 else
@@ -400,3 +403,9 @@ setup/ginkgo:
 	@go install -mod=mod github.com/onsi/ginkgo/v2/ginkgo@latest
 	@echo Installing gomega
 	@go get github.com/onsi/gomega/...
+
+.PHONY: build-installer
+build-installer: manifests generate kustomize
+	mkdir -p dist
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default > dist/install.yaml

PROJECT

@@ -1,6 +1,6 @@
 domain: splunk.com
 layout:
-- go.kubebuilder.io/v3
+- go.kubebuilder.io/v4
 plugins:
   manifests.sdk.operatorframework.io/v2: {}
   scorecard.sdk.operatorframework.io/v2: {}

main.go cmd/main.gomain.go renamed to cmd/main.go

@@ -18,7 +18,11 @@ package main
 
 import (
 	"flag"
+	"fmt"
+	intController "github.com/splunk/splunk-operator/internal/controller"
+	"github.com/splunk/splunk-operator/internal/controller/debug"
 	"os"
+	"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
 	"time"
 
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
@@ -36,12 +40,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
+	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 
 	enterpriseApiV3 "github.com/splunk/splunk-operator/api/v3"
 	enterpriseApi "github.com/splunk/splunk-operator/api/v4"
-	"github.com/splunk/splunk-operator/controllers"
-	debug "github.com/splunk/splunk-operator/controllers/debug"
-	"github.com/splunk/splunk-operator/pkg/config"
 	//+kubebuilder:scaffold:imports
 	//extapi "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
@@ -106,73 +108,76 @@ func main() {
 	// Logging setup
 	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))
 
-	options := ctrl.Options{
+	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
+		Metrics: metricsserver.Options{
+			BindAddress:    metricsAddr,
+			FilterProvider: filters.WithAuthenticationAndAuthorization,
+		},
 		Scheme:                 scheme,
-		MetricsBindAddress:     metricsAddr,
-		Port:                   9443,
 		HealthProbeBindAddress: probeAddr,
 		LeaderElection:         enableLeaderElection,
 		LeaderElectionID:       "270bec8c.splunk.com",
 		LeaseDuration:          &leaseDuration,
 		RenewDeadline:          &renewDeadline,
-	}
+	})
 
-	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), config.ManagerOptionsWithNamespaces(setupLog, options))
 	if err != nil {
 		setupLog.Error(err, "unable to start manager")
 		os.Exit(1)
 	}
 
-	if err = (&controllers.ClusterMasterReconciler{
+	if err = (&intController.ClusterManagerReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
-		setupLog.Error(err, "unable to create controller", "controller", "ClusterMaster")
+		fmt.Printf(" error - %v", err)
+		setupLog.Error(err, "unable to create controller", "controller", "ClusterManager ")
 		os.Exit(1)
 	}
-	if err = (&controllers.ClusterManagerReconciler{
+	fmt.Printf("%v", err)
+	if err = (&intController.ClusterMasterReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
-		setupLog.Error(err, "unable to create controller", "controller", "ClusterManager")
+		setupLog.Error(err, "unable to create controller", "controller", "ClusterMaster")
 		os.Exit(1)
 	}
-	if err = (&controllers.IndexerClusterReconciler{
+	if err = (&intController.IndexerClusterReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "IndexerCluster")
 		os.Exit(1)
 	}
-	if err = (&controllers.LicenseMasterReconciler{
+	if err = (&intController.LicenseMasterReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "LicenseMaster")
 		os.Exit(1)
 	}
-	if err = (&controllers.LicenseManagerReconciler{
+	if err = (&intController.LicenseManagerReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "LicenseManager")
 		os.Exit(1)
 	}
-	if err = (&controllers.MonitoringConsoleReconciler{
+	if err = (&intController.MonitoringConsoleReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "MonitoringConsole")
 		os.Exit(1)
 	}
-	if err = (&controllers.SearchHeadClusterReconciler{
+	if err = (&intController.SearchHeadClusterReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "SearchHeadCluster")
 		os.Exit(1)
 	}
-	if err = (&controllers.StandaloneReconciler{
+	if err = (&intController.StandaloneReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
@@ -205,7 +210,7 @@ func main() {
 // Note that these endpoints meant to be sensitive and shouldn't be exposed publicly.
 func customSetupEndpoints(pprofActive bool, mgr manager.Manager) error {
 	if pprofActive {
-		if err := debug.RegisterEndpoint(mgr.AddMetricsExtraHandler, nil); err != nil {
+		if err := debug.RegisterEndpoint(mgr.AddMetricsServerExtraHandler, nil); err != nil {
 			setupLog.Error(err, "Unable to register pprof endpoint")
 			return err
 		}