Upgrade watcher-operator to operator-sdk 1.41.1

.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-watcher-operator.yaml

@@ -16,7 +16,7 @@ jobs:
     with:
       operator_name: watcher
       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 }}

.github/workflows/force-bump-pr-manual.yaml

@@ -9,6 +9,6 @@ jobs:
     with:
       operator_name: watcher
       branch_name: ${{ github.ref_name }}
-      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.31
+      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.41.1
     secrets:
       FORCE_BUMP_PULL_REQUEST_PAT: ${{ secrets.FORCE_BUMP_PULL_REQUEST_PAT }}

.github/workflows/force-bump-pr-scheduled.yaml

@@ -10,6 +10,6 @@ jobs:
     uses: openstack-k8s-operators/openstack-k8s-operators-ci/.github/workflows/force-bump-branches.yaml@main
     with:
       operator_name: watcher
-      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.31
+      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.41.1
     secrets:
       FORCE_BUMP_PULL_REQUEST_PAT: ${{ secrets.FORCE_BUMP_PULL_REQUEST_PAT }}

.pre-commit-config.yaml

@@ -79,7 +79,7 @@ repos:
       # E012: here doc didn't end before EOF
 
 - repo: https://github.com/golangci/golangci-lint
-  rev: v2.4.0
+  rev: v2.6.1
   hooks:
     - id: golangci-lint-full
       args: ["-v"]

.zuul.yaml

@@ -138,6 +138,7 @@
       A zuul job building content from OpenDev epoxy release.
     parent: openstack-meta-content-provider
     vars:
+      cifmw_install_yamls_sdk_version: v1.41.1
       cifmw_bop_openstack_release: epoxy
       cifmw_bop_dlrn_baseurl: "https://trunk.rdoproject.org/centos9-epoxy"
       cifmw_repo_setup_branch: epoxy
@@ -208,6 +209,7 @@
     nodeset: centos-stream-10-vexxhost
     parent: openstack-meta-content-provider
     vars:
+      cifmw_install_yamls_sdk_version: v1.41.1
       cifmw_bop_openstack_release: master
       cifmw_bop_dlrn_baseurl: "https://trunk.rdoproject.org/centos10-master"
       cifmw_repo_setup_branch: master

Dockerfile

@@ -25,7 +25,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/watcher-operator:latest
@@ -146,22 +146,22 @@ PROC_CMD = --procs ${PROCS}
 .PHONY: test
 test: manifests generate fmt vet envtest ginkgo ## Run tests.
 	OPERATOR_TEMPLATES="$(PWD)/templates" \
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" $(GINKGO) --trace --cover --coverpkg=../../pkg/watcher,../../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/watcher,../../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?=24604
 run: export HEALTH_PORT?=24605
 run: export PPROF_PORT?=8082
 run: export ENABLE_WEBHOOKS?=false
 run: manifests generate fmt vet ## Run a controller from your host.
-	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)"
 
 
 # Extra vars which will be passed to the Docker-build
@@ -212,7 +212,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
 SETUP_ENVTEST_VERSION ?= release-0.22
 
@@ -391,6 +391,10 @@ watcher: export WATCHER_DECISION_ENGINE_IMAGE=${WATCHER_DECISION_ENGINE_CI_IMAGE
 watcher: export WATCHER_APPLIER_IMAGE=${WATCHER_APPLIER_CI_IMAGE}
 watcher: export CATALOG_IMG=${CATALOG_IMAGE}
 watcher: ## Install watcher operator via olm
+	# explicitly to delete any running watcher-operator deployments from openstack-operator here as
+	# label selectors can change and installing a service catalog/index like this alongside
+	# openstack-operator (what CI appears to do?) is not recommended
+	oc delete deployment watcher-operator-controller-manager -n openstack-operators --ignore-not-found=true
 	bash ci/olm.sh
 	oc apply -f ci/olm.yaml
 	timeout 300s bash -c "while ! (oc get csv -n  openshift-operators -l  operators.coreos.com/cluster-observability-operator.openshift-operators -o jsonpath='{.items[*].status.phase}' | grep Succeeded); do sleep 10; done"
@@ -424,7 +428,7 @@ watcher_cleanup: ## Cleaning watcher operator via olm
 
 KUTTL_SUITE ?= default
 KUTTL_NAMESPACE ?= watcher-kuttl-$(KUTTL_SUITE)
-KUTTL_SUITE_DIR ?= tests/kuttl/test-suites/$(KUTTL_SUITE)
+KUTTL_SUITE_DIR ?= test/kuttl/test-suites/$(KUTTL_SUITE)
 
 .PHONY: stop_watcher_integrated
 stop_watcher_integrated:

PROJECT

@@ -4,7 +4,7 @@
 # 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/v1beta1/common_types.go

@@ -147,7 +147,7 @@ type PasswordSelector struct {
 	Service *string `json:"service"`
 }
 
-// WatcherSubCrsCommon
+// WatcherSubCrsCommon defines the common fields for Watcher sub-CRs
 type WatcherSubCrsCommon struct {
 	// +kubebuilder:validation:Optional
 	// The service specific Container Image URL (will be set to environmental default if empty)
@@ -189,6 +189,7 @@ type WatcherSubCrsTemplate struct {
 	TopologyRef *topologyv1.TopoRef `json:"topologyRef,omitempty"`
 }
 
+// WatcherImages defines the container images for all Watcher services
 type WatcherImages struct {
 	// +kubebuilder:validation:Required
 	// APIContainerImageURL
@@ -203,6 +204,7 @@ type WatcherImages struct {
 	ApplierContainerImageURL string `json:"applierContainerImageURL"`
 }
 
+// Default sets default values for WatcherImages based on the provided defaults
 func (r *WatcherImages) Default(defaults WatcherDefaults) {
 	if r.APIContainerImageURL == "" {
 		r.APIContainerImageURL = defaults.APIContainerImageURL
@@ -215,8 +217,7 @@ func (r *WatcherImages) Default(defaults WatcherDefaults) {
 	}
 }
 
-// SetupDefaults - initializes any CRD field defaults based on environment variables (the defaulting mechanism itself is implemented via webhooks)
-
+// SetupDefaults initializes any CRD field defaults based on environment variables (the defaulting mechanism itself is implemented via webhooks)
 func SetupDefaults() {
 	// Acquire environmental defaults and initialize Watcher defaults with them
 	watcherDefaults := WatcherDefaults{

api/v1beta1/conditions.go

@@ -5,7 +5,7 @@ import "github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 const (
 	// WatcherRabbitMQTransportURLReadyCondition -
 	WatcherRabbitMQTransportURLReadyCondition condition.Type = "WatcherRabbitMQTransportURLReady"
-	// WatcherNotificationsBusTransportURLReadyCondition -
+	// WatcherNotificationTransportURLReadyCondition indicates whether the Watcher notification transport URL is ready
 	WatcherNotificationTransportURLReadyCondition condition.Type = "WatcherNotificationTransportURLReady"
 	// WatcherAPIReadyCondition -
 	WatcherAPIReadyCondition condition.Type = "WatcherAPIReady"

api/v1beta1/watcher_types.go

@@ -63,6 +63,7 @@ type WatcherStatus struct {
 	DecisionEngineServiceReadyCount int32 `json:"decisionengineServiceReadyCount,omitempty"`
 }
 
+// WatcherDBPurge defines the parameters for the Watcher database purging cron job
 type WatcherDBPurge struct {
 	// +kubebuilder:validation:Optional
 	// +kubebuilder:default="0 1 * * *"
@@ -117,8 +118,8 @@ func (instance Watcher) RbacResourceName() string {
 }
 
 // IsReady returns true if the ReadyCondition is true
-func (r *Watcher) IsReady() bool {
-	return r.Status.Conditions.IsTrue(condition.ReadyCondition)
+func (instance *Watcher) IsReady() bool {
+	return instance.Status.Conditions.IsTrue(condition.ReadyCondition)
 }
 
 func init() {

api/v1beta1/watcher_webhook.go

@@ -42,13 +42,12 @@ var watcherDefaults WatcherDefaults
 // log is for logging in this package.
 var watcherlog = logf.Log.WithName("watcher-resource")
 
+// SetupWatcherDefaults initializes the Watcher defaults for the webhook
 func SetupWatcherDefaults(defaults WatcherDefaults) {
 	watcherDefaults = defaults
 	watcherlog.Info("Watcher defaults initialized", "defaults", defaults)
 }
 
-//+kubebuilder:webhook:path=/mutate-watcher-openstack-org-v1beta1-watcher,mutating=true,failurePolicy=fail,sideEffects=None,groups=watcher.openstack.org,resources=watchers,verbs=create;update,versions=v1beta1,name=mwatcher.kb.io,admissionReviewVersions=v1
-
 var _ webhook.Defaulter = &Watcher{}
 
 // Default implements webhook.Defaulter so a webhook will be registered for the type
@@ -68,8 +67,6 @@ func (spec *WatcherSpecCore) Default() {
 	// no validations . Placeholder for defaulting webhook integrated in the OpenStackControlPlane
 }
 
-//+kubebuilder:webhook:path=/validate-watcher-openstack-org-v1beta1-watcher,mutating=false,failurePolicy=fail,sideEffects=None,groups=watcher.openstack.org,resources=watchers,verbs=create;update,versions=v1beta1,name=vwatcher.kb.io,admissionReviewVersions=v1
-
 var _ webhook.Validator = &Watcher{}
 
 // ValidateCreate implements webhook.Validator so a webhook will be registered for the type
@@ -88,33 +85,33 @@ func (r *Watcher) ValidateCreate() (admission.Warnings, error) {
 }
 
 // ValidateCreate validates the WatcherSpec during the webhook invocation.
-func (r *WatcherSpec) ValidateCreate(basePath *field.Path, namespace string) field.ErrorList {
-	return r.WatcherSpecCore.ValidateCreate(basePath, namespace)
+func (spec *WatcherSpec) ValidateCreate(basePath *field.Path, namespace string) field.ErrorList {
+	return spec.WatcherSpecCore.ValidateCreate(basePath, namespace)
 }
 
 // ValidateCreate validates the WatcherSpecCore during the webhook invocation. It is
 // expected to be called by the validation webhook in the higher level meta
 // operator
-func (r *WatcherSpecCore) ValidateCreate(basePath *field.Path, namespace string) field.ErrorList {
+func (spec *WatcherSpecCore) ValidateCreate(basePath *field.Path, namespace string) field.ErrorList {
 	var allErrs field.ErrorList
 
-	if *r.DatabaseInstance == "" || r.DatabaseInstance == nil {
+	if *spec.DatabaseInstance == "" || spec.DatabaseInstance == nil {
 		allErrs = append(
 			allErrs,
 			field.Invalid(
 				basePath.Child("databaseInstance"), "", "databaseInstance field should not be empty"),
 		)
 	}
 
-	if *r.RabbitMqClusterName == "" || r.RabbitMqClusterName == nil {
+	if *spec.RabbitMqClusterName == "" || spec.RabbitMqClusterName == nil {
 		allErrs = append(
 			allErrs,
 			field.Invalid(
 				basePath.Child("rabbitMqClusterName"), "", "rabbitMqClusterName field should not be empty"),
 		)
 	}
 
-	allErrs = append(allErrs, r.ValidateWatcherTopology(basePath, namespace)...)
+	allErrs = append(allErrs, spec.ValidateWatcherTopology(basePath, namespace)...)
 
 	return allErrs
 }
@@ -140,34 +137,34 @@ func (r *Watcher) ValidateUpdate(old runtime.Object) (admission.Warnings, error)
 
 }
 
-// ValidateCreate validates the WatcherSpec during the webhook invocation.
-func (r *WatcherSpec) ValidateUpdate(old WatcherSpec, basePath *field.Path, namespace string) field.ErrorList {
-	return r.WatcherSpecCore.ValidateUpdate(old.WatcherSpecCore, basePath, namespace)
+// ValidateUpdate validates the WatcherSpec during the webhook update invocation.
+func (spec *WatcherSpec) ValidateUpdate(old WatcherSpec, basePath *field.Path, namespace string) field.ErrorList {
+	return spec.WatcherSpecCore.ValidateUpdate(old.WatcherSpecCore, basePath, namespace)
 }
 
 // ValidateUpdate validates the WatcherSpecCore during the webhook invocation. It is
 // expected to be called by the validation webhook in the higher level meta
 // operator
-func (r *WatcherSpecCore) ValidateUpdate(old WatcherSpecCore, basePath *field.Path, namespace string) field.ErrorList {
+func (spec *WatcherSpecCore) ValidateUpdate(old WatcherSpecCore, basePath *field.Path, namespace string) field.ErrorList {
 	var allErrs field.ErrorList
 
-	if *r.DatabaseInstance == "" || r.DatabaseInstance == nil {
+	if *spec.DatabaseInstance == "" || spec.DatabaseInstance == nil {
 		allErrs = append(
 			allErrs,
 			field.Invalid(
 				basePath.Child("databaseInstance"), "", "databaseInstance field should not be empty"),
 		)
 	}
 
-	if *r.RabbitMqClusterName == "" || r.RabbitMqClusterName == nil {
+	if *spec.RabbitMqClusterName == "" || spec.RabbitMqClusterName == nil {
 		allErrs = append(
 			allErrs,
 			field.Invalid(
 				basePath.Child("rabbitMqClusterName"), "", "rabbitMqClusterName field should not be empty"),
 		)
 	}
 
-	allErrs = append(allErrs, r.ValidateWatcherTopology(basePath, namespace)...)
+	allErrs = append(allErrs, spec.ValidateWatcherTopology(basePath, namespace)...)
 
 	return allErrs
 }

api/v1beta1/watcherapi_types.go

@@ -138,8 +138,8 @@ type WatcherAPIList struct {
 }
 
 // IsReady returns true if the ReadyCondition is true
-func (r *WatcherAPI) IsReady() bool {
-	return r.Status.Conditions.IsTrue(condition.ReadyCondition)
+func (instance *WatcherAPI) IsReady() bool {
+	return instance.Status.Conditions.IsTrue(condition.ReadyCondition)
 }
 
 func init() {

api/v1beta1/watcherapi_webhook.go

@@ -20,7 +20,6 @@ import (
 	topologyv1 "github.com/openstack-k8s-operators/infra-operator/apis/topology/v1beta1"
 	"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"
@@ -29,16 +28,8 @@ import (
 // log is for logging in this package.
 var watcherapilog = logf.Log.WithName("watcherapi-resource")
 
-func (r *WatcherAPI) SetupWebhookWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewWebhookManagedBy(mgr).
-		For(r).
-		Complete()
-}
-
 // TODO(user): EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 
-//+kubebuilder:webhook:path=/mutate-watcher-openstack-org-v1beta1-watcherapi,mutating=true,failurePolicy=fail,sideEffects=None,groups=watcher.openstack.org,resources=watcherapis,verbs=create;update,versions=v1beta1,name=mwatcherapi.kb.io,admissionReviewVersions=v1
-
 var _ webhook.Defaulter = &WatcherAPI{}
 
 // Default implements webhook.Defaulter so a webhook will be registered for the type
@@ -49,7 +40,6 @@ func (r *WatcherAPI) Default() {
 }
 
 // TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
-//+kubebuilder:webhook:path=/validate-watcher-openstack-org-v1beta1-watcherapi,mutating=false,failurePolicy=fail,sideEffects=None,groups=watcher.openstack.org,resources=watcherapis,verbs=create;update,versions=v1beta1,name=vwatcherapi.kb.io,admissionReviewVersions=v1
 
 var _ webhook.Validator = &WatcherAPI{}
 

api/v1beta1/watcherapplier_types.go

@@ -76,7 +76,7 @@ type WatcherApplierStatus struct {
 	LastAppliedTopology *topologyv1.TopoRef `json:"lastAppliedTopology,omitempty"`
 }
 
-// WatcherApplierTemplatce defines the input parameters specified by the user to
+// WatcherApplierTemplate defines the input parameters specified by the user to
 // create a WatcherApplier via higher level CRDs.
 type WatcherApplierTemplate struct {
 	WatcherSubCrsTemplate `json:",inline"`
@@ -104,8 +104,8 @@ type WatcherApplier struct {
 }
 
 // IsReady returns true if the ReadyCondition is true
-func (r *WatcherApplier) IsReady() bool {
-	return r.Status.Conditions.IsTrue(condition.ReadyCondition)
+func (instance *WatcherApplier) IsReady() bool {
+	return instance.Status.Conditions.IsTrue(condition.ReadyCondition)
 }
 
 //+kubebuilder:object:root=true