Add watcher deployment to openstackcontrolplane

This patch is adding Watcher deployment to the OpenStackControlPlane.

It includes:

- CRD modification to OpenStackControlPlane
- New conditions
- pkg/watcher.go to implement the reconcile loop for Watcher
- functional tests
- Watcher deployment is added to one of the existing kuttl tests

Jira: OSPRH-16241
Signed-off-by: Alfredo Moralejo <[email protected]>

Author: amoralej

apis/bases/core.openstack.org_openstackcontrolplanes.yaml

@@ -155,6 +155,12 @@ const (
 
 	// OpenStackControlPlaneOpenStackVersionInitializationReadyCondition Status=True condition which indicates if OpenStackVersion is initialized
 	OpenStackControlPlaneOpenStackVersionInitializationReadyCondition condition.Type = "OpenStackControlPlaneOpenStackVersionInitializationReadyCondition"
+
+	// OpenStackControlPlaneWatcherReadyCondition Status=True condition which indicates if Watcher is configured and operational
+	OpenStackControlPlaneWatcherReadyCondition condition.Type = "OpenStackControlPlaneWatcherReady"
+
+	// OpenStackControlPlaneExposeWatcherReadyCondition Status=True condition which indicates if Watcher is exposed via a route
+	OpenStackControlPlaneExposeWatcherReadyCondition condition.Type = "OpenStackControlPlaneExposeWatcherReady"
 )
 
 // Common Messages used by API objects.
@@ -486,6 +492,18 @@ const (
 
 	// OpenStackControlPlaneOpenStackVersionInitializationReadyErrorMessage
 	OpenStackControlPlaneOpenStackVersionInitializationReadyErrorMessage = "OpenStackControlPlane OpenStackVersion initialization error occured %s"
+
+	// OpenStackControlPlaneWatcherReadyInitMessage
+	OpenStackControlPlaneWatcherReadyInitMessage = "OpenStackControlPlane Watcher not started"
+
+	// OpenStackControlPlaneWatcherReadyMessage
+	OpenStackControlPlaneWatcherReadyMessage = "OpenStackControlPlane Watcher completed"
+
+	// OpenStackControlPlaneWatcherReadyRunningMessage
+	OpenStackControlPlaneWatcherReadyRunningMessage = "OpenStackControlPlane Watcher in progress"
+
+	// OpenStackControlPlaneWatcherReadyErrorMessage
+	OpenStackControlPlaneWatcherReadyErrorMessage = "OpenStackControlPlane Watcher error occured %s"
 )
 
 // Version Conditions used by to drive minor updates

apis/core/v1beta1/conditions.go

@@ -47,6 +47,7 @@ import (
 	placementv1 "github.com/openstack-k8s-operators/placement-operator/api/v1beta1"
 	swiftv1 "github.com/openstack-k8s-operators/swift-operator/api/v1beta1"
 	telemetryv1 "github.com/openstack-k8s-operators/telemetry-operator/api/v1beta1"
+	watcherv1 "github.com/openstack-k8s-operators/watcher-operator/api/v1beta1"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -212,6 +213,11 @@ type OpenStackControlPlaneSpec struct {
 	// TopologyRef to apply the Topology defined by the associated CR referenced
 	// by name
 	TopologyRef *topologyv1.TopoRef `json:"topologyRef,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// Watcher - Parameters related to the Watcher service
+	Watcher WatcherSection `json:"watcher,omitempty"`
 }
 
 // TLSSection defines the desired state of TLS configuration
@@ -798,6 +804,25 @@ type OpenStackClientSection struct {
 	Template v1beta1.OpenStackClientSpecCore `json:"template,omitempty"`
 }
 
+// WatcherSection defines the desired state of Watcher service
+type WatcherSection struct {
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=false
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:booleanSwitch"}
+	// Enabled - Whether Watcher service should be deployed and managed
+	Enabled bool `json:"enabled"`
+
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// Template - Overrides to use when creating the Watcher service
+	Template *watcherv1.WatcherSpecCore `json:"template,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// APIOverride, provides the ability to override the generated manifest of several child resources.
+	APIOverride Override `json:"apiOverride,omitempty"`
+}
+
 // OpenStackControlPlaneStatus defines the observed state of OpenStackControlPlane
 type OpenStackControlPlaneStatus struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:io.kubernetes.conditions"}
@@ -913,6 +938,7 @@ func (instance *OpenStackControlPlane) InitConditions() {
 		condition.UnknownCondition(OpenStackControlPlaneRedisReadyCondition, condition.InitReason, OpenStackControlPlaneRedisReadyInitMessage),
 		condition.UnknownCondition(OpenStackControlPlaneCAReadyCondition, condition.InitReason, OpenStackControlPlaneCAReadyInitMessage),
 		condition.UnknownCondition(OpenStackControlPlaneOpenStackVersionInitializationReadyCondition, condition.InitReason, OpenStackControlPlaneOpenStackVersionInitializationReadyInitMessage),
+		condition.UnknownCondition(OpenStackControlPlaneWatcherReadyCondition, condition.InitReason, OpenStackControlPlaneWatcherReadyInitMessage),
 
 		// Also add the overall status condition as Unknown
 		condition.UnknownCondition(condition.ReadyCondition, condition.InitReason, condition.ReadyInitMessage),

apis/core/v1beta1/openstackcontrolplane_types.go

@@ -26,6 +26,7 @@ import (
 	common_webhook "github.com/openstack-k8s-operators/lib-common/modules/common/webhook"
 	mariadbv1 "github.com/openstack-k8s-operators/mariadb-operator/api/v1beta1"
 	placementv1 "github.com/openstack-k8s-operators/placement-operator/api/v1beta1"
+	watcherv1 "github.com/openstack-k8s-operators/watcher-operator/api/v1beta1"
 	"golang.org/x/exp/maps"
 	"golang.org/x/exp/slices"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -244,6 +245,12 @@ func (r *OpenStackControlPlane) checkDepsEnabled(name string) string {
 		if !(r.Spec.Rabbitmq.Enabled && r.Spec.Keystone.Enabled) {
 			reqs = "RabbitMQ, Keystone"
 		}
+	case "Watcher":
+		if !(r.Spec.Galera.Enabled && r.Spec.Memcached.Enabled && r.Spec.Rabbitmq.Enabled &&
+			r.Spec.Keystone.Enabled && r.Spec.Telemetry.Enabled && *r.Spec.Telemetry.Template.Ceilometer.Enabled &&
+			*r.Spec.Telemetry.Template.MetricStorage.Enabled) {
+			reqs = "Galera, Memcached, RabbitMQ, Keystone, Telemetry, Telemetry.Ceilometer, Telemetry.MetricStorage"
+		}
 	}
 
 	// If "reqs" is not the empty string, we have missing requirements
@@ -345,6 +352,11 @@ func (r *OpenStackControlPlane) ValidateCreateServices(basePath *field.Path) (ad
 		errors = append(errors, validateTLSOverrideSpec(&r.Spec.Designate.APIOverride.Route, basePath.Child("designate").Child("apiOverride").Child("route"))...)
 	}
 
+	if r.Spec.Watcher.Enabled {
+		errors = append(errors, r.Spec.Watcher.Template.ValidateCreate(basePath.Child("watcher").Child("template"), r.Namespace)...)
+		errors = append(errors, validateTLSOverrideSpec(&r.Spec.Watcher.APIOverride.Route, basePath.Child("watcher").Child("apiOverride").Child("route"))...)
+	}
+
 	// Validation for remaining services...
 	if r.Spec.Galera.Enabled {
 		for key, s := range *r.Spec.Galera.Templates {
@@ -533,6 +545,14 @@ func (r *OpenStackControlPlane) ValidateUpdateServices(old OpenStackControlPlane
 		errors = append(errors, validateTLSOverrideSpec(&r.Spec.Designate.APIOverride.Route, basePath.Child("designate").Child("apiOverride").Child("route"))...)
 	}
 
+	if r.Spec.Watcher.Enabled {
+		if old.Watcher.Template == nil {
+			old.Watcher.Template = &watcherv1.WatcherSpecCore{}
+		}
+		errors = append(errors, r.Spec.Watcher.Template.ValidateUpdate(*old.Watcher.Template, basePath.Child("watcher").Child("template"), r.Namespace)...)
+		errors = append(errors, validateTLSOverrideSpec(&r.Spec.Watcher.APIOverride.Route, basePath.Child("watcher").Child("apiOverride").Child("route"))...)
+	}
+
 	if r.Spec.Memcached.Enabled {
 		if r.Spec.Memcached.Templates != nil {
 			err := common_webhook.ValidateDNS1123Label(
@@ -680,6 +700,12 @@ func (r *OpenStackControlPlane) ValidateServiceDependencies(basePath *field.Path
 			allErrs = append(allErrs, err)
 		}
 	}
+	if r.Spec.Watcher.Enabled {
+		if depErrorMsg := r.checkDepsEnabled("Watcher"); depErrorMsg != "" {
+			err := field.Invalid(basePath.Child("watcher").Child("enabled"), r.Spec.Watcher.Enabled, depErrorMsg)
+			allErrs = append(allErrs, err)
+		}
+	}
 
 	return allErrs
 }
@@ -1031,6 +1057,24 @@ func (r *OpenStackControlPlane) DefaultServices() {
 		}
 	}
 
+	// Watcher
+	if r.Spec.Watcher.Enabled || r.Spec.Watcher.Template != nil {
+		if r.Spec.Watcher.Template == nil {
+			r.Spec.Watcher.Template = &watcherv1.WatcherSpecCore{}
+		}
+		r.Spec.Watcher.Template.Default()
+
+		if r.Spec.Watcher.Enabled {
+			initializeOverrideSpec(&r.Spec.Watcher.APIOverride.Route, true)
+			r.Spec.Watcher.Template.SetDefaultRouteAnnotations(r.Spec.Watcher.APIOverride.Route.Annotations)
+		}
+
+		// Default DatabaseInstance
+		if r.Spec.Watcher.Template.DatabaseInstance == nil || *r.Spec.Watcher.Template.DatabaseInstance == "" {
+			r.Spec.Watcher.Template.DatabaseInstance = ptr.To("openstack")
+		}
+	}
+
 }
 
 // DefaultLabel - adding default label to the OpenStackControlPlane

apis/core/v1beta1/openstackcontrolplane_webhook.go

@@ -28,6 +28,7 @@ require (
 	github.com/openstack-k8s-operators/placement-operator/api v0.6.1-0.20250728155507-d9002b5278c5
 	github.com/openstack-k8s-operators/swift-operator/api v0.6.1-0.20250731125612-06e01ca6844a
 	github.com/openstack-k8s-operators/telemetry-operator/api v0.6.1-0.20250731100510-eb1934ea2786
+	github.com/openstack-k8s-operators/watcher-operator/api v0.6.1-0.20250730131205-1720b37fea7f
 	github.com/rhobs/obo-prometheus-operator/pkg/apis/monitoring v0.71.0-rhobs1 // indirect
 	github.com/rhobs/observability-operator v0.3.1 // indirect
 	go.uber.org/multierr v1.11.0 // indirect

apis/core/v1beta1/zz_generated.deepcopy.go

@@ -140,6 +140,8 @@ github.com/openstack-k8s-operators/swift-operator/api v0.6.1-0.20250731125612-06
 github.com/openstack-k8s-operators/swift-operator/api v0.6.1-0.20250731125612-06e01ca6844a/go.mod h1:KqMMH8J0UW6oqFa0viWmITCKdWNNboQL7xupnPnvkDg=
 github.com/openstack-k8s-operators/telemetry-operator/api v0.6.1-0.20250731100510-eb1934ea2786 h1:JqHIKGHUe02LkyIi3MKgvoa/e8F//7AVnZ5/sIZSI0o=
 github.com/openstack-k8s-operators/telemetry-operator/api v0.6.1-0.20250731100510-eb1934ea2786/go.mod h1:462IbW/UydmvLhQNfZPmDafav23FxibUiA34yGxtR9k=
+github.com/openstack-k8s-operators/watcher-operator/api v0.6.1-0.20250730131205-1720b37fea7f h1:6I2FFzRAws3Udu0QSer/bZq0xluKBXdJ0E7bFrxDtcQ=
+github.com/openstack-k8s-operators/watcher-operator/api v0.6.1-0.20250730131205-1720b37fea7f/go.mod h1:XTKoOjXqybRkS7gwi02VxkQmDWud4OUKivWi9TJ+8Uk=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=