Upgrade to operator-sdk 1.41.1

Rescaffold the keystone-operator to operator-sdk 1.41.1, which includes:
- Reorganize project structure (pkg/ -> internal/)
- Move webhook implementations to internal/webhook/v1beta1/
- Add new cmd/main.go entrypoint with updated controller initialization
- Update RBAC, certmanager, and prometheus configurations
- Enhance network policies for metrics and webhook traffic
- Set keystone as defaulting resource in PROJECT file
- Remove auto-generated test suite scaffolding
- Update build workflow and Dockerfile to version 1.41.1

This upgrade modernizes the operator structure and aligns with the latest
operator-sdk best practices.

Jira: OSPRH-21924

Depends-On: openstack-k8s-operators/openstack-operator#1683

Author: dprince

.ci-operator.yaml

@@ -1,4 +1,4 @@
 build_root_image:
   name: tools
   namespace: openstack-k8s-operators
-  tag: ci-build-root-golang-1.24-sdk-1.31
+  tag: ci-build-root-golang-1.24-sdk-1.41.1

.github/workflows/build-keystone-operator.yaml

@@ -16,7 +16,7 @@ jobs:
     with:
       operator_name: keystone
       go_version: 1.24.x
-      operator_sdk_version: 1.31.0
+      operator_sdk_version: 1.41.1
     secrets:
       IMAGENAMESPACE: ${{ secrets.IMAGENAMESPACE }}
       QUAY_USERNAME: ${{ secrets.QUAY_USERNAME }}

Dockerfile

@@ -26,7 +26,7 @@ RUN mkdir -p ${DEST_ROOT}/usr/local/bin/
 RUN if [ ! -f $CACHITO_ENV_FILE ]; then go mod download ; fi
 
 # Build manager
-RUN if [ -f $CACHITO_ENV_FILE ] ; then source $CACHITO_ENV_FILE ; fi ; env ${GO_BUILD_EXTRA_ENV_ARGS} go build ${GO_BUILD_EXTRA_ARGS} -a -o ${DEST_ROOT}/manager main.go
+RUN if [ -f $CACHITO_ENV_FILE ] ; then source $CACHITO_ENV_FILE ; fi ; env ${GO_BUILD_EXTRA_ENV_ARGS} go build ${GO_BUILD_EXTRA_ARGS} -a -o ${DEST_ROOT}/manager cmd/main.go
 
 RUN cp -r templates ${DEST_ROOT}/templates
 

Makefile

@@ -48,7 +48,7 @@ endif
 
 # Set the Operator SDK version to use. By default, what is installed on the system is used.
 # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
-OPERATOR_SDK_VERSION ?= v1.31.0
+OPERATOR_SDK_VERSION ?= v1.41.1
 
 # Image URL to use all building/pushing image targets
 DEFAULT_IMG ?= quay.io/openstack-k8s-operators/keystone-operator:latest
@@ -129,13 +129,13 @@ PROC_CMD = --procs ${PROCS}
 
 .PHONY: test
 test: manifests generate fmt vet envtest ginkgo ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" $(GINKGO) --trace --cover --coverpkg=../../pkg/keystone,../../controllers,../../api/v1beta1 --coverprofile cover.out --covermode=atomic ${PROC_CMD} $(GINKGO_ARGS) ./tests/...
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" $(GINKGO) --trace --cover --coverpkg=../../internal/keystone,../../internal/controller,../../api/v1beta1 --coverprofile cover.out --covermode=atomic ${PROC_CMD} $(GINKGO_ARGS) ./test/...
 
 ##@ Build
 
 .PHONY: build
 build: generate fmt vet ## Build manager binary.
-	go build -o bin/manager main.go
+	go build -o bin/manager cmd/main.go
 
 .PHONY: run
 run: export METRICS_PORT?=8080
@@ -144,7 +144,7 @@ run: export PPROF_PORT?=8082
 run: export ENABLE_WEBHOOKS?=false
 run: manifests generate fmt vet ## Run a controller from your host.
 	/bin/bash hack/clean_local_webhook.sh
-	go run ./main.go -metrics-bind-address ":$(METRICS_PORT)" -health-probe-bind-address ":$(HEALTH_PORT)" -pprof-bind-address ":$(PPROF_PORT)"
+	go run ./cmd/main.go -metrics-bind-address ":$(METRICS_PORT)" -health-probe-bind-address ":$(HEALTH_PORT)" -pprof-bind-address ":$(PPROF_PORT)"
 
 .PHONY: docker-build
 docker-build: test ## Build docker image with the manager.
@@ -208,7 +208,7 @@ ENVTEST ?= $(LOCALBIN)/setup-envtest
 GINKGO ?= $(LOCALBIN)/ginkgo
 
 ## Tool Versions
-KUSTOMIZE_VERSION ?= v3.8.7
+KUSTOMIZE_VERSION ?= v5.6.0
 CONTROLLER_TOOLS_VERSION ?= v0.18.0
 GOTOOLCHAIN_VERSION ?= go1.24.0
 

PROJECT

@@ -1,6 +1,10 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: openstack.org
 layout:
-- go.kubebuilder.io/v3
+- go.kubebuilder.io/v4
 plugins:
   manifests.sdk.operatorframework.io/v2: {}
   scorecard.sdk.operatorframework.io/v2: {}

api/bases/keystone.openstack.org_keystoneapis.yaml

@@ -50,6 +50,7 @@ spec:
           metadata:
             type: object
           spec:
+            description: KeystoneAPISpec defines the desired state of KeystoneAPI
             properties:
               adminProject:
                 default: admin
@@ -102,7 +103,7 @@ spec:
                 description: ExtraMounts containing conf files
                 items:
                   description: |-
-                    KeystoneExtraVolMounts exposes additional parameters processed by keystone-operator
+                    KeystoneExtraMounts exposes additional parameters processed by keystone-operator
                     and defines the common VolMounts structure provided by the main storage module
                   properties:
                     extraVol:

api/v1beta1/keystoneapi_types.go

@@ -53,6 +53,7 @@ const (
 	APIDefaultTimeout = 60
 )
 
+// KeystoneAPISpec defines the desired state of KeystoneAPI
 type KeystoneAPISpec struct {
 	KeystoneAPISpecCore `json:",inline"`
 
@@ -61,7 +62,7 @@ type KeystoneAPISpec struct {
 	ContainerImage string `json:"containerImage"`
 }
 
-// KeystoneAPISpec defines the desired state of KeystoneAPI
+// KeystoneAPISpecCore defines the desired state of KeystoneAPI core spec
 type KeystoneAPISpecCore struct {
 	// +kubebuilder:validation:Required
 	// MariaDB instance name
@@ -348,7 +349,7 @@ func SetupDefaults() {
 	SetupKeystoneAPIDefaults(keystoneDefaults)
 }
 
-// KeystoneExtraVolMounts exposes additional parameters processed by keystone-operator
+// KeystoneExtraMounts exposes additional parameters processed by keystone-operator
 // and defines the common VolMounts structure provided by the main storage module
 type KeystoneExtraMounts struct {
 	// +kubebuilder:validation:Optional

api/v1beta1/keystoneapi_webhook.go

@@ -29,7 +29,6 @@ import (
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/util/validation/field"
-	ctrl "sigs.k8s.io/controller-runtime"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
@@ -53,15 +52,6 @@ func SetupKeystoneAPIDefaults(defaults KeystoneAPIDefaults) {
 	keystoneapilog.Info("KeystoneAPI defaults initialized", "defaults", defaults)
 }
 
-// SetupWebhookWithManager sets up the webhook with the Manager
-func (r *KeystoneAPI) SetupWebhookWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewWebhookManagedBy(mgr).
-		For(r).
-		Complete()
-}
-
-//+kubebuilder:webhook:path=/mutate-keystone-openstack-org-v1beta1-keystoneapi,mutating=true,failurePolicy=fail,sideEffects=None,groups=keystone.openstack.org,resources=keystoneapis,verbs=create;update,versions=v1beta1,name=mkeystoneapi.kb.io,admissionReviewVersions=v1
-
 var _ webhook.Defaulter = &KeystoneAPI{}
 
 // Default implements webhook.Defaulter so a webhook will be registered for the type
@@ -88,9 +78,6 @@ func (spec *KeystoneAPISpecCore) Default() {
 	}
 }
 
-// TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
-//+kubebuilder:webhook:path=/validate-keystone-openstack-org-v1beta1-keystoneapi,mutating=false,failurePolicy=fail,sideEffects=None,groups=keystone.openstack.org,resources=keystoneapis,verbs=create;update,versions=v1beta1,name=vkeystoneapi.kb.io,admissionReviewVersions=v1
-
 var _ webhook.Validator = &KeystoneAPI{}
 
 // ValidateCreate implements webhook.Validator so a webhook will be registered for the type
@@ -117,6 +104,7 @@ func (spec *KeystoneAPISpec) ValidateCreate(basePath *field.Path, namespace stri
 	return spec.KeystoneAPISpecCore.ValidateCreate(basePath, namespace)
 }
 
+// ValidateCreate validates the KeystoneAPISpecCore spec during creation
 func (spec *KeystoneAPISpecCore) ValidateCreate(basePath *field.Path, namespace string) field.ErrorList {
 	var allErrs field.ErrorList
 
@@ -159,6 +147,7 @@ func (spec *KeystoneAPISpec) ValidateUpdate(old KeystoneAPISpec, basePath *field
 	return spec.KeystoneAPISpecCore.ValidateUpdate(old.KeystoneAPISpecCore, basePath, namespace)
 }
 
+// ValidateUpdate validates the KeystoneAPISpecCore spec during update
 func (spec *KeystoneAPISpecCore) ValidateUpdate(_ KeystoneAPISpecCore, basePath *field.Path, namespace string) field.ErrorList {
 	var allErrs field.ErrorList