Merge pull request #1591 from fmount/notif

openshift-merge-bot[bot] · web-flow · commit c14431f58910 · 2025-10-02T07:59:15.000Z
Add NotificationsBusInstance API field
diff --git a/apis/bases/core.openstack.org_openstackcontrolplanes.yaml b/apis/bases/core.openstack.org_openstackcontrolplanes.yaml
@@ -9855,6 +9855,8 @@ spec:
                 additionalProperties:
                   type: string
                 type: object
+              notificationsBusInstance:
+                type: string
               nova:
                 properties:
                   apiOverride:
diff --git a/apis/core/v1beta1/openstackcontrolplane_types.go b/apis/core/v1beta1/openstackcontrolplane_types.go
@@ -127,6 +127,13 @@ type OpenStackControlPlaneSpec struct {
 	// Rabbitmq - Parameters related to the Rabbitmq service
 	Rabbitmq RabbitmqSection `json:"rabbitmq,omitempty"`
 
+	// +kubebuilder:validation:Optional
+	// NotificationsBusInstance - the name of RabbitMQ Cluster CR to select a Messaging
+	// Bus Service instance used by all services that produce or consume notifications.
+	// Avoid colocating it with RabbitMQ services used for PRC.
+	// That instance will be pushed down for services, unless overriden in templates.
+	NotificationsBusInstance *string `json:"notificationsBusInstance,omitempty"`
+
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// Memcached - Parameters related to the Memcached service
diff --git a/apis/core/v1beta1/openstackcontrolplane_webhook.go b/apis/core/v1beta1/openstackcontrolplane_webhook.go
@@ -132,6 +132,10 @@ func (r *OpenStackControlPlane) ValidateCreate() (admission.Warnings, error) {
 		allErrs = append(allErrs, err)
 	}
 
+	if err := r.ValidateNotificationsBusInstance(basePath); err != nil {
+		allErrs = append(allErrs, err)
+	}
+
 	if len(allErrs) != 0 {
 		return allWarn, apierrors.NewInvalid(
 			schema.GroupKind{Group: "core.openstack.org", Kind: "OpenStackControlPlane"},
@@ -161,6 +165,10 @@ func (r *OpenStackControlPlane) ValidateUpdate(old runtime.Object) (admission.Wa
 		allErrs = append(allErrs, err)
 	}
 
+	if err := r.ValidateNotificationsBusInstance(basePath); err != nil {
+		allErrs = append(allErrs, err)
+	}
+
 	if len(allErrs) != 0 {
 		return nil, apierrors.NewInvalid(
 			schema.GroupKind{Group: "core.openstack.org", Kind: "OpenStackControlPlane"},
@@ -1138,3 +1146,28 @@ func (r *OpenStackControlPlane) ValidateTopology(basePath *field.Path) *field.Er
 	}
 	return nil
 }
+
+// ValidateNotificationsBusInstance - returns an error if the notificationsBusInstance
+// parameter is not valid.
+// - nil or empty string must be raised as an error
+// - when notificationsBusInstance does not point to an existing RabbitMQ instance
+func (r *OpenStackControlPlane) ValidateNotificationsBusInstance(basePath *field.Path) *field.Error {
+	notificationsField := basePath.Child("notificationsBusInstance")
+	// no notificationsBusInstance field set, nothing to validate here
+	if r.Spec.NotificationsBusInstance == nil {
+		return nil
+	}
+	// When NotificationsBusInstance is set, fail if it is an empty string
+	if *r.Spec.NotificationsBusInstance == "" {
+		return field.Invalid(notificationsField, *r.Spec.NotificationsBusInstance, "notificationsBusInstance is not a valid string")
+	}
+	// NotificationsBusInstance is set and must be equal to an existing
+	// deployed rabbitmq instance, otherwise we should fail because it
+	// does not represent a valid string
+	for k := range(*r.Spec.Rabbitmq.Templates) {
+		if *r.Spec.NotificationsBusInstance == k {
+			return nil
+		}
+	}
+	return field.Invalid(notificationsField, *r.Spec.NotificationsBusInstance, "notificationsBusInstance must match an existing RabbitMQ instance name")
+}
diff --git a/apis/core/v1beta1/zz_generated.deepcopy.go b/apis/core/v1beta1/zz_generated.deepcopy.go
diff --git a/bindata/crds/crds.yaml b/bindata/crds/crds.yaml
@@ -10021,6 +10021,8 @@ spec:
                 additionalProperties:
                   type: string
                 type: object
+              notificationsBusInstance:
+                type: string
               nova:
                 properties:
                   apiOverride:
diff --git a/config/crd/bases/core.openstack.org_openstackcontrolplanes.yaml b/config/crd/bases/core.openstack.org_openstackcontrolplanes.yaml
@@ -9855,6 +9855,8 @@ spec:
                 additionalProperties:
                   type: string
                 type: object
+              notificationsBusInstance:
+                type: string
               nova:
                 properties:
                   apiOverride:
diff --git a/pkg/openstack/cinder.go b/pkg/openstack/cinder.go
@@ -130,6 +130,12 @@ func ReconcileCinder(ctx context.Context, instance *corev1beta1.OpenStackControl
 		instance.Spec.Cinder.Template.TopologyRef = instance.Spec.TopologyRef
 	}
 
+	// When no NotificationsBusInstance is referenced in the subCR (override)
+	// try to inject the top-level one if defined
+	if instance.Spec.Cinder.Template.NotificationsBusInstance == nil {
+		instance.Spec.Cinder.Template.NotificationsBusInstance = instance.Spec.NotificationsBusInstance
+	}
+
 	Log.Info("Reconciling Cinder", "Cinder.Namespace", instance.Namespace, "Cinder.Name", cinderName)
 	op, err := controllerutil.CreateOrPatch(ctx, helper.GetClient(), cinder, func() error {
 		instance.Spec.Cinder.Template.CinderSpecBase.DeepCopyInto(&cinder.Spec.CinderSpecBase)
diff --git a/pkg/openstack/glance.go b/pkg/openstack/glance.go
@@ -74,6 +74,12 @@ func ReconcileGlance(ctx context.Context, instance *corev1beta1.OpenStackControl
 		instance.Spec.Glance.Template.TopologyRef = instance.Spec.TopologyRef
 	}
 
+	// When no NotificationsBusInstance is referenced in the subCR (override)
+	// try to inject the top-level one if defined
+	if instance.Spec.Glance.Template.NotificationBusInstance == nil {
+		instance.Spec.Glance.Template.NotificationBusInstance = instance.Spec.NotificationsBusInstance
+	}
+
 	// When component services got created check if there is the need to create a route
 	if err := helper.GetClient().Get(ctx, types.NamespacedName{Name: glanceName, Namespace: instance.Namespace}, glance); err != nil {
 		if !k8s_errors.IsNotFound(err) {
diff --git a/pkg/openstack/manila.go b/pkg/openstack/manila.go
@@ -118,6 +118,12 @@ func ReconcileManila(ctx context.Context, instance *corev1beta1.OpenStackControl
 		instance.Spec.Manila.Template.TopologyRef = instance.Spec.TopologyRef
 	}
 
+	// When no NotificationsBusInstance is referenced in the subCR (override)
+	// try to inject the top-level one if defined
+	if instance.Spec.Manila.Template.NotificationsBusInstance == nil {
+		instance.Spec.Manila.Template.NotificationsBusInstance = instance.Spec.NotificationsBusInstance
+	}
+
 	Log.Info("Reconciling Manila", "Manila.Namespace", instance.Namespace, "Manila.Name", "manila")
 	op, err := controllerutil.CreateOrPatch(ctx, helper.GetClient(), manila, func() error {
 		instance.Spec.Manila.Template.ManilaSpecBase.DeepCopyInto(&manila.Spec.ManilaSpecBase)
diff --git a/pkg/openstack/neutron.go b/pkg/openstack/neutron.go
@@ -155,6 +155,12 @@ func ReconcileNeutron(ctx context.Context, instance *corev1beta1.OpenStackContro
 		instance.Spec.Neutron.Template.TopologyRef = instance.Spec.TopologyRef
 	}
 
+	// When no NotificationsBusInstance is referenced in the subCR (override)
+	// try to inject the top-level one if defined
+	if instance.Spec.Neutron.Template.NotificationsBusInstance == nil {
+		instance.Spec.Neutron.Template.NotificationsBusInstance = instance.Spec.NotificationsBusInstance
+	}
+
 	Log.Info("Reconciling NeutronAPI", "NeutronAPI.Namespace", instance.Namespace, "NeutronAPI.Name", "neutron")
 	op, err := controllerutil.CreateOrPatch(ctx, helper.GetClient(), neutronAPI, func() error {
 		instance.Spec.Neutron.Template.DeepCopyInto(&neutronAPI.Spec.NeutronAPISpecCore)
diff --git a/pkg/openstack/nova.go b/pkg/openstack/nova.go
@@ -72,6 +72,12 @@ func ReconcileNova(ctx context.Context, instance *corev1beta1.OpenStackControlPl
 		instance.Spec.Nova.Template.NodeSelector = &instance.Spec.NodeSelector
 	}
 
+	// When no NotificationsBusInstance is referenced in the subCR (override)
+	// try to inject the top-level one if defined
+	if instance.Spec.Nova.Template.NotificationsBusInstance == nil {
+		instance.Spec.Nova.Template.NotificationsBusInstance = instance.Spec.NotificationsBusInstance
+	}
+
 	// When there's no Topology referenced in the Service Template, inject the
 	// top-level one
 	// NOTE: This does not check the Service subCRs: by default the generated
diff --git a/pkg/openstack/watcher.go b/pkg/openstack/watcher.go
@@ -114,6 +114,12 @@ func ReconcileWatcher(ctx context.Context, instance *corev1beta1.OpenStackContro
 		instance.Spec.Watcher.Template.TopologyRef = instance.Spec.TopologyRef
 	}
 
+	// When no NotificationsBusInstance is referenced in the subCR (override)
+	// try to inject the top-level one if defined
+	if instance.Spec.Watcher.Template.NotificationsBusInstance == nil {
+		instance.Spec.Watcher.Template.NotificationsBusInstance = instance.Spec.NotificationsBusInstance
+	}
+
 	helper.GetLogger().Info("Reconciling Watcher", "Watcher.Namespace", instance.Namespace, "Watcher.Name", "watcher")
 	op, err := controllerutil.CreateOrPatch(ctx, helper.GetClient(), watcher, func() error {
 		instance.Spec.Watcher.Template.DeepCopyInto(&watcher.Spec.WatcherSpecCore)
diff --git a/tests/functional/ctlplane/base_test.go b/tests/functional/ctlplane/base_test.go
@@ -37,6 +37,7 @@ import (
 	manilav1 "github.com/openstack-k8s-operators/manila-operator/api/v1beta1"
 	mariadbv1 "github.com/openstack-k8s-operators/mariadb-operator/api/v1beta1"
 	neutronv1 "github.com/openstack-k8s-operators/neutron-operator/api/v1beta1"
+	novav1 "github.com/openstack-k8s-operators/nova-operator/api/v1beta1"
 	openstackclientv1 "github.com/openstack-k8s-operators/openstack-operator/apis/client/v1beta1"
 	corev1 "github.com/openstack-k8s-operators/openstack-operator/apis/core/v1beta1"
 	dataplanev1 "github.com/openstack-k8s-operators/openstack-operator/apis/dataplane/v1beta1"
@@ -69,6 +70,8 @@ type Names struct {
 	RabbitMQCertName                   types.NamespacedName
 	RabbitMQCell1Name                  types.NamespacedName
 	RabbitMQCell1CertName              types.NamespacedName
+	RabbitMQNotificationsName          types.NamespacedName
+	RabbitMQNotificationsCertName      types.NamespacedName
 	NoVNCProxyCell1CertPublicRouteName types.NamespacedName
 	NoVNCProxyCell1CertPublicSvcName   types.NamespacedName
 	NoVNCProxyCell1CertVencryptName    types.NamespacedName
@@ -223,6 +226,14 @@ func CreateNames(openstackControlplaneName types.NamespacedName) Names {
 			Namespace: openstackControlplaneName.Namespace,
 			Name:      "cert-rabbitmq-cell1-svc",
 		},
+		RabbitMQNotificationsName: types.NamespacedName{
+			Namespace: openstackControlplaneName.Namespace,
+			Name:      "rabbitmq-notifications",
+		},
+		RabbitMQNotificationsCertName: types.NamespacedName{
+			Namespace: openstackControlplaneName.Namespace,
+			Name:      "cert-rabbitmq-notifications-svc",
+		},
 		NoVNCProxyCell1CertPublicRouteName: types.NamespacedName{
 			Name:      "cert-nova-novncproxy-cell1-public-route",
 			Namespace: openstackControlplaneName.Namespace,
@@ -535,6 +546,9 @@ func GetDefaultOpenStackControlPlaneSpec() map[string]interface{} {
 		names.RabbitMQCell1Name.Name: map[string]interface{}{
 			"replicas": 1,
 		},
+		names.RabbitMQNotificationsName.Name: map[string]interface{}{
+			"replicas": 1,
+		},
 	}
 	galeraTemplate := map[string]interface{}{
 		names.DBName.Name: map[string]interface{}{
@@ -876,6 +890,15 @@ func GetNeutron(name types.NamespacedName) *neutronv1.NeutronAPI {
 	return instance
 }
 
+// GetNova
+func GetNova(name types.NamespacedName) *novav1.Nova {
+	instance := &novav1.Nova{}
+	Eventually(func(g Gomega) {
+		g.Expect(k8sClient.Get(ctx, name, instance)).Should(Succeed())
+	}, timeout, interval).Should(Succeed())
+	return instance
+}
+
 // GetManila
 func GetManila(name types.NamespacedName) *manilav1.Manila {
 	instance := &manilav1.Manila{}
diff --git a/tests/functional/ctlplane/openstackoperator_controller_test.go b/tests/functional/ctlplane/openstackoperator_controller_test.go
