feat(manager): add region to openStackMachineSpec.ProviderID field from crd identityRef

To made CAPO compatible with OCCM multi-cloud deployment we need to manage providerID format with region code as introduced [here](kubernetes/cloud-provider-openstack#1900) (`openstack://region/instance_uuid`).
Add ProviderIDRegion field to OpenStackIdentityReference type to define region name in providerID string.

An empty or undefined ProviderIDRegion field permit to be fully backward compatible.

Signed-off-by: MatthieuFin <[email protected]>

Author: MatthieuFin

api/v1beta1/identity_types.go

@@ -28,6 +28,12 @@ type OpenStackIdentityReference struct {
 	// CloudName specifies the name of the entry in the clouds.yaml file to use.
 	// +kubebuilder:validation:Required
 	CloudName string `json:"cloudName"`
+
+	// ProviderIDRegion specifies the name of the region to specify in providerID field format `openstack://ProviderIDRegion/instance_uuid`.
+	// This option permit to been compatible with multiple OCCM (one per OS cluster).
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="region is immutable"
+	// +optional
+	ProviderIDRegion string `json:"providerIDRegion,omitempty"`
 }
 
 // IdentityRefProvider is an interface for obtaining OpenStack credentials from an API object

controllers/openstackmachine_controller.go

@@ -422,7 +422,7 @@ func (r *OpenStackMachineReconciler) reconcileMachineState(scope *scope.WithLogg
 		conditions.MarkTrue(openStackMachine, infrav1.InstanceReadyCondition)
 
 		// Set properties required by CAPI machine controller
-		openStackMachine.Spec.ProviderID = ptr.To(fmt.Sprintf("openstack:///%s", *openStackServer.Status.InstanceID))
+		openStackMachine.Spec.ProviderID = ptr.To(fmt.Sprintf("openstack://%s/%s", openStackMachine.Spec.IdentityRef.ProviderIDRegion, *openStackServer.Status.InstanceID))
 		openStackMachine.Status.InstanceID = openStackServer.Status.InstanceID
 		openStackMachine.Status.Ready = true
 	case infrav1.InstanceStateError: