Require EDPMServiceType

Brendan Shephard · Brendan Shephard · commit 0cd0898abd2f · 2024-11-08T13:59:29.000+10:00
This change switches EDPMServiceType from optional to required.
Since the EDPMServiceType of custom services needs to match that of an existing service,
we also remove the defaulting mechanism in the webhook.

Signed-off-by: Brendan Shephard &lt;bshephar@redhat.com&gt;
diff --git a/apis/dataplane/v1beta1/openstackdataplaneservice_types.go b/apis/dataplane/v1beta1/openstackdataplaneservice_types.go
@@ -111,6 +111,7 @@ type OpenStackDataPlaneServiceSpec struct {
 	// corresponds to the ansible role name (without the "edpm_" prefix) used
 	// to manage the service. If not set, will default to the
 	// OpenStackDataPlaneService name.
+	// +kubebuilder:validation:Required
 	EDPMServiceType string `json:"edpmServiceType,omitempty" yaml:"edpmServiceType,omitempty"`
 }
 
diff --git a/apis/dataplane/v1beta1/openstackdataplaneservice_webhook.go b/apis/dataplane/v1beta1/openstackdataplaneservice_webhook.go
@@ -44,17 +44,9 @@ var _ webhook.Defaulter = &OpenStackDataPlaneService{}
 func (r *OpenStackDataPlaneService) Default() {
 
 	openstackdataplaneservicelog.Info("default", "name", r.Name)
-	r.Spec.Default(r.Name)
 	r.DefaultLabels()
 }
 
-// Default - set defaults for this OpenStackDataPlaneService
-func (spec *OpenStackDataPlaneServiceSpec) Default(name string) {
-	if spec.EDPMServiceType == "" {
-		spec.EDPMServiceType = name
-	}
-}
-
 // TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
 // +kubebuilder:webhook:path=/validate-dataplane-openstack-org-v1beta1-openstackdataplaneservice,mutating=false,failurePolicy=fail,sideEffects=None,groups=dataplane.openstack.org,resources=openstackdataplaneservices,verbs=create;update,versions=v1beta1,name=vopenstackdataplaneservice.kb.io,admissionReviewVersions=v1
 
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_bootstrap.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_bootstrap.yaml
@@ -4,3 +4,4 @@ metadata:
   name: bootstrap
 spec:
   playbook: osp.edpm.bootstrap
+  edpmServiceType: bootstrap
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_ceph_client.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_ceph_client.yaml
@@ -4,3 +4,4 @@ metadata:
   name: ceph-client
 spec:
   playbook: osp.edpm.ceph_client
+  edpmServiceType: ceph-client
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_ceph_hci_pre.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_ceph_hci_pre.yaml
@@ -4,3 +4,4 @@ metadata:
   name: ceph-hci-pre
 spec:
   playbook: osp.edpm.ceph_hci_pre
+  edpmServiceType: ceph-hci-pre
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_configure_network.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_configure_network.yaml
@@ -4,3 +4,4 @@ metadata:
   name: configure-network
 spec:
   playbook: osp.edpm.configure_network
+  edpmServiceType: configure-network
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_configure_os.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_configure_os.yaml
@@ -4,3 +4,4 @@ metadata:
   name: configure-os
 spec:
   playbook: osp.edpm.configure_os
+  edpmServiceType: configure-os
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_configure_ovs_dpdk.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_configure_ovs_dpdk.yaml
@@ -4,3 +4,4 @@ metadata:
   name: configure-ovs-dpdk
 spec:
   playbook: osp.edpm.configure_ovs_dpdk
+  edpmServiceType: configure-ovs-dpdk
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_ddp_package_option.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_ddp_package_option.yaml
@@ -4,3 +4,4 @@ metadata:
   name: ddp-package-option
 spec:
   playbook: osp.edpm.select_kernel_ddp_package
+  edpmServiceType: ddp-package-option
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_derive_pci_devicespec.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_derive_pci_devicespec.yaml
@@ -4,3 +4,4 @@ metadata:
   name: derive-pci-devicespec
 spec:
   playbook: osp.edpm.sriov_derive_device_spec
+  edpmServiceType: derive-pci-devicespec
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_download_cache.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_download_cache.yaml
@@ -4,3 +4,4 @@ metadata:
   name: download-cache
 spec:
   playbook: osp.edpm.download_cache
+  edpmServiceType: download-cache
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_fips_status.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_fips_status.yaml
@@ -5,3 +5,4 @@ metadata:
 spec:
   label: fips-status
   playbook: osp.edpm.fips_status
+  edpmServiceType: fips-status
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_frr.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_frr.yaml
@@ -6,3 +6,4 @@ spec:
   playbook: osp.edpm.frr
   containerImageFields:
   - EdpmFrrImage
+  edpmServiceType: frr
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_install_certs.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_install_certs.yaml
@@ -5,3 +5,4 @@ metadata:
 spec:
   playbook: osp.edpm.install_certs
   addCertMounts: True
+  edpmServiceType: install-certs
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_install_os.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_install_os.yaml
@@ -4,3 +4,4 @@ metadata:
   name: install-os
 spec:
   playbook: osp.edpm.install_os
+  edpmServiceType: install-os
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_libvirt.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_libvirt.yaml
@@ -23,3 +23,4 @@ spec:
         - client auth
       issuer: osp-rootca-issuer-libvirt
   caCerts: combined-ca-bundle
+  edpmServiceType: libvirt
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_logging.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_logging.yaml
@@ -7,3 +7,4 @@ spec:
     - secretRef:
         name: logging-compute-config-data
   playbook: osp.edpm.telemetry_logging
+  edpmServiceType: logging
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_dhcp.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_dhcp.yaml
@@ -10,3 +10,4 @@ spec:
   caCerts: combined-ca-bundle
   containerImageFields:
   - EdpmNeutronDhcpAgentImage
+  edpmServiceType: neutron-dhcp
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_metadata.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_metadata.yaml
@@ -24,3 +24,4 @@ spec:
   caCerts: combined-ca-bundle
   containerImageFields:
   - EdpmNeutronMetadataAgentImage
+  edpmServiceType: neutron-metadata
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_ovn.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_ovn.yaml
@@ -22,3 +22,4 @@ spec:
   caCerts: combined-ca-bundle
   containerImageFields:
   - EdpmNeutronOvnAgentImage
+  edpmServiceType: neutron-ovn
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_sriov.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_neutron_sriov.yaml
@@ -10,3 +10,4 @@ spec:
   caCerts: combined-ca-bundle
   containerImageFields:
   - EdpmNeutronSriovAgentImage
+  edpmServiceType: neutron-sriov
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_os_reboot.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_os_reboot.yaml
@@ -4,3 +4,4 @@ metadata:
   name: reboot-os
 spec:
   playbook: osp.edpm.reboot
+  edpmServiceType: reboot-os
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_ovn.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_ovn.yaml
@@ -23,3 +23,4 @@ spec:
   caCerts: combined-ca-bundle
   containerImageFields:
   - OvnControllerImage
+  edpmServiceType: ovn
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_ovn_bgp_agent.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_ovn_bgp_agent.yaml
@@ -23,3 +23,4 @@ spec:
   caCerts: combined-ca-bundle
   containerImageFields:
   - EdpmOvnBgpAgentImage
+  edpmServiceType: ovn-bgp-agent
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_run_os.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_run_os.yaml
@@ -7,3 +7,4 @@ spec:
   containerImageFields:
   - EdpmLogrotateCrondImage
   - EdpmIscsidImage
+  edpmServiceType: run-os
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_ssh_known_hosts.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_ssh_known_hosts.yaml
@@ -5,3 +5,4 @@ metadata:
 spec:
   playbook: osp.edpm.ssh_known_hosts
   deployOnAllNodeSets: true
+  edpmServiceType: ssh-known-hosts
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_swift.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_swift.yaml
@@ -11,3 +11,4 @@ spec:
         name: swift-storage-config-data
     - configMapRef:
         name: swift-ring-files
+  edpmServiceType: swift
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_telemetry.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_telemetry.yaml
@@ -15,3 +15,4 @@ spec:
   containerImageFields:
   - CeilometerComputeImage
   - EdpmNodeExporterImage
+  edpmServiceType: telemetry
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_telemetry_power_monitoring.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_telemetry_power_monitoring.yaml
@@ -15,3 +15,4 @@ spec:
   containerImageFields:
   - CeilometerIpmiImage
   - EdpmKeplerImage
+  edpmServiceType: telemetry-power-monitoring
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_update.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_update.yaml
@@ -4,3 +4,4 @@ metadata:
   name: update
 spec:
   playbook: osp.edpm.update
+  edpmServiceType: update
diff --git a/config/services/dataplane_v1beta1_openstackdataplaneservice_validate_network.yaml b/config/services/dataplane_v1beta1_openstackdataplaneservice_validate_network.yaml
@@ -4,3 +4,4 @@ metadata:
   name: validate-network
 spec:
   playbook: osp.edpm.validate_network
+  edpmServiceType: validate-network
diff --git a/docs/assemblies/proc_creating-a-custom-service.adoc b/docs/assemblies/proc_creating-a-custom-service.adoc
@@ -112,7 +112,7 @@ spec:
   deployOnAllNodeSets: true
 ----
 
-. Optional: Specify the `edpmServiceType` field for the service. Different custom services may use the same ansible content to manage the same EDPM service (such as `ovn` or `nova`). The `DataSources`, TLS certificates, and CA certificates need to be mounted at the same locations so they can be found by the ansible content even when using a custom service. `edpmServiceType` is used to create this association. The value is the name of the default service that uses the same ansible content as the custom service. If there are multiple services with the same `edpmServiceType` listed in a nodeset or deployment spec, latter ones would be ignored.
+. Required: Specify the `edpmServiceType` field for the service. Different custom services may use the same ansible content to manage the same EDPM service (such as `ovn` or `nova`). The `DataSources`, TLS certificates, and CA certificates need to be mounted at the same locations so they can be found by the ansible content even when using a custom service. `edpmServiceType` is used to create this association. The value is the name of the default service that uses the same ansible content as the custom service. If there are multiple services with the same `edpmServiceType` listed in a nodeset or deployment spec, latter ones would be ignored.
 +
 For example, a custom service that uses the `edpm_ovn` ansible content from `edpm-ansible` would set `edpmServiceType` to `ovn`, which matches the default `ovn` service name provided by `openstack-operator`.
 +
diff --git a/tests/functional/dataplane/base_test.go b/tests/functional/dataplane/base_test.go
@@ -514,7 +514,11 @@ func DefaultDataplaneService(name types.NamespacedName) map[string]interface{} {
 		"metadata": map[string]interface{}{
 			"name":      name.Name,
 			"namespace": name.Namespace,
-		}}
+		},
+		"spec": map[string]interface{}{
+			"edpmServiceType": "notGlobal",
+		},
+	}
 }
 
 // Create an empty OpenStackDataPlaneService struct
@@ -531,6 +535,7 @@ func DefaultDataplaneGlobalService(name types.NamespacedName) map[string]interfa
 		},
 		"spec": map[string]interface{}{
 			"deployOnAllNodeSets": true,
+			"edpmServiceType":     "global",
 		},
 	}
 }
diff --git a/tests/functional/dataplane/openstackdataplanedeployment_controller_test.go b/tests/functional/dataplane/openstackdataplanedeployment_controller_test.go
@@ -279,7 +279,7 @@ var _ = Describe("Dataplane Deployment Test", func() {
 			CreateDataplaneService(dataplaneServiceName, false)
 			CreateDataplaneService(dataplaneGlobalServiceName, true)
 			CreateDataPlaneServiceFromSpec(dataplaneUpdateServiceName, map[string]interface{}{
-				"edpmServiceType":               "foo-update-service",
+				"edpmServiceType":               "update",
 				"openStackAnsibleEERunnerImage": "foo-image:latest"})
 
 			DeferCleanup(th.DeleteService, dataplaneServiceName)
@@ -750,7 +750,7 @@ var _ = Describe("Dataplane Deployment Test", func() {
 			CreateDataplaneService(dataplaneServiceName, false)
 			CreateDataplaneService(dataplaneGlobalServiceName, true)
 			CreateDataPlaneServiceFromSpec(dataplaneUpdateServiceName, map[string]interface{}{
-				"EDPMServiceType": "foo-update-service"})
+				"edpmServiceType": "foo-update-service"})
 
 			DeferCleanup(th.DeleteService, dataplaneServiceName)
 			DeferCleanup(th.DeleteService, dataplaneGlobalServiceName)
@@ -1081,7 +1081,7 @@ var _ = Describe("Dataplane Deployment Test", func() {
 			CreateDataplaneService(dataplaneServiceName, false)
 			CreateDataplaneService(dataplaneGlobalServiceName, true)
 			CreateDataPlaneServiceFromSpec(dataplaneUpdateServiceName, map[string]interface{}{
-				"EDPMServiceType": "foo-update-service"})
+				"edpmServiceType": "foo-update-service"})
 
 			DeferCleanup(th.DeleteService, dataplaneServiceName)
 			DeferCleanup(th.DeleteService, dataplaneGlobalServiceName)
@@ -1288,7 +1288,7 @@ var _ = Describe("Dataplane Deployment Test", func() {
 			CreateDataplaneService(dataplaneServiceName, false)
 			CreateDataplaneService(dataplaneGlobalServiceName, true)
 			CreateDataPlaneServiceFromSpec(dataplaneUpdateServiceName, map[string]interface{}{
-				"EDPMServiceType": "foo-update-service"})
+				"edpmServiceType": "foo-update-service"})
 
 			DeferCleanup(th.DeleteService, dataplaneServiceName)
 			DeferCleanup(th.DeleteService, dataplaneGlobalServiceName)
diff --git a/tests/functional/dataplane/openstackdataplanenodeset_controller_test.go b/tests/functional/dataplane/openstackdataplanenodeset_controller_test.go
@@ -1358,7 +1358,8 @@ var _ = Describe("Dataplane NodeSet Test", func() {
 
 			dataplanev1.SetupDefaults()
 			updateServiceSpec := map[string]interface{}{
-				"playbook": "osp.edpm.update",
+				"playbook":        "osp.edpm.update",
+				"edpmServiceType": "update",
 			}
 			CreateDataPlaneServiceFromSpec(dataplaneUpdateServiceName, updateServiceSpec)
 			DeferCleanup(th.DeleteService, dataplaneUpdateServiceName)

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ type OpenStackDataPlaneServiceSpec struct {`
`111`	`111`	`// corresponds to the ansible role name (without the "edpm_" prefix) used`
`112`	`112`	`// to manage the service. If not set, will default to the`
`113`	`113`	`// OpenStackDataPlaneService name.`
	`114`	`+ // +kubebuilder:validation:Required`
`114`	`115`	EDPMServiceType string `json:"edpmServiceType,omitempty" yaml:"edpmServiceType,omitempty"`
`115`	`116`	`}`
`116`	`117`