Implement FromPoolAnnotation

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

Author: s3rj1k

api/v1beta1/metal3datatemplate_types.go

@@ -141,6 +141,17 @@ type FromPool struct {
 	Kind string `json:"kind"`
 }
 
+// FromPoolAnnotation contains the information to fetch pool reference details from an annotation.
+type FromPoolAnnotation struct {
+	// +kubebuilder:validation:Enum=machine;metal3machine;baremetalhost
+	// Object is the type of the object from which we retrieve the annotation
+	Object string `json:"object"`
+
+	// Annotation is the key of the annotation that contains the pool name.
+	// The annotation value should be a string containing the pool name.
+	Annotation string `json:"annotation"`
+}
+
 // MetaData represents a keyand value of the metadata.
 type MetaData struct {
 	// Strings is the list of metadata items to be rendered from strings
@@ -363,6 +374,12 @@ type NetworkGatewayv4 struct {
 
 	// FromPoolRef is a reference to a IP pool to fetch the gateway from
 	FromPoolRef *corev1.TypedLocalObjectReference `json:"fromPoolRef,omitempty"`
+
+	// FromPoolAnnotation allows specifying the pool name via an annotation on
+	// a Machine, Metal3Machine, or BareMetalHost object.
+	// When set, FromIPPool and FromPoolRef are ignored.
+	// +optional
+	FromPoolAnnotation *FromPoolAnnotation `json:"fromPoolAnnotation,omitempty"`
 }
 
 // NetworkGatewayv6 represents a gateway, given as a string or as a reference to
@@ -379,6 +396,12 @@ type NetworkGatewayv6 struct {
 
 	// FromPoolRef is a reference to a IP pool to fetch the gateway from
 	FromPoolRef *corev1.TypedLocalObjectReference `json:"fromPoolRef,omitempty"`
+
+	// FromPoolAnnotation allows specifying the pool name via an annotation on
+	// a Machine, Metal3Machine, or BareMetalHost object.
+	// When set, FromIPPool and FromPoolRef are ignored.
+	// +optional
+	FromPoolAnnotation *FromPoolAnnotation `json:"fromPoolAnnotation,omitempty"`
 }
 
 // NetworkDataRoutev4 represents an ipv4 route object.
@@ -432,6 +455,12 @@ type NetworkDataIPv4 struct {
 	// FromPoolRef is a reference to a IP pool to allocate an address from.
 	FromPoolRef *corev1.TypedLocalObjectReference `json:"fromPoolRef,omitempty"`
 
+	// FromPoolAnnotation allows specifying the pool reference via an annotation on
+	// a Machine, Metal3Machine, or BareMetalHost object.
+	// When set, IPAddressFromIPPool and FromPoolRef are ignored.
+	// +optional
+	FromPoolAnnotation *FromPoolAnnotation `json:"fromPoolAnnotation,omitempty"`
+
 	// Routes contains a list of IPv4 routes
 	// +optional
 	Routes []NetworkDataRoutev4 `json:"routes,omitempty"`
@@ -452,6 +481,12 @@ type NetworkDataIPv6 struct {
 	// FromPoolRef is a reference to a IP pool to allocate an address from.
 	FromPoolRef *corev1.TypedLocalObjectReference `json:"fromPoolRef,omitempty"`
 
+	// FromPoolAnnotation allows specifying the pool reference via an annotation on
+	// a Machine, Metal3Machine, or BareMetalHost object.
+	// When set, IPAddressFromIPPool and FromPoolRef are ignored.
+	// +optional
+	FromPoolAnnotation *FromPoolAnnotation `json:"fromPoolAnnotation,omitempty"`
+
 	// Routes contains a list of IPv6 routes
 	// +optional
 	Routes []NetworkDataRoutev6 `json:"routes,omitempty"`

api/v1beta1/zz_generated.deepcopy.go

@@ -240,7 +240,7 @@ func (m *DataManager) createSecrets(ctx context.Context) error {
 
 	// Fetch all the Metal3IPPools and create Metal3IPClaims as needed. Check if the
 	// IP address has been allocated, if so, fetch the address, gateway and prefix.
-	poolAddresses, err := m.getAddressesFromPool(ctx, *m3dt)
+	poolAddresses, err := m.getAddressesFromPool(ctx, *m3dt, m3m, capiMachine, bmh)
 	if err != nil {
 		return err
 	}
@@ -334,15 +334,18 @@ type reconciledClaim struct {
 // return a Transient type ReconcileError, indicating that some addresses were not fully allocated yet.
 func (m *DataManager) getAddressesFromPool(ctx context.Context,
 	m3dt infrav1.Metal3DataTemplate,
+	m3m *infrav1.Metal3Machine,
+	machine *clusterv1.Machine,
+	bmh *bmov1alpha1.BareMetalHost,
 ) (map[string]addressFromPool, error) {
 	var err error
+	addresses := map[string]addressFromPool{}
 
-	poolRefs, err := getReferencedPools(m3dt)
+	poolRefs, err := getReferencedPools(m3dt, m3m, machine, bmh)
 	if err != nil {
-		return nil, err
+		return addresses, err
 	}
 	claims := map[string]reconciledClaim{}
-	addresses := map[string]addressFromPool{}
 
 	for pool, ref := range poolRefs {
 		var rc reconciledClaim
@@ -401,7 +404,7 @@ func isMetal3IPPoolRef(ref corev1.TypedLocalObjectReference) bool {
 
 // releaseAddressesFromPool releases all addresses allocated by a [Metal3DataTemplate] by deleting the IP claims.
 func (m *DataManager) releaseAddressesFromPool(ctx context.Context, m3dt infrav1.Metal3DataTemplate) error {
-	poolRefs, err := getReferencedPools(m3dt)
+	poolRefs, err := getReferencedPools(m3dt, nil, nil, nil)
 	if err != nil {
 		return err
 	}
@@ -461,8 +464,48 @@ func (p poolRefs) addName(name string) error {
 	return p.addRef(corev1.TypedLocalObjectReference{Name: name})
 }
 
+// addFromAnnotation resolves a pool reference from an annotation and adds it to the pool refs.
+// The annotation value should be a string containing the pool name.
+// If the annotation pointer is nil or objects are nil (e.g., during release), this function returns nil without error.
+func (p poolRefs) addFromAnnotation(
+	fromPoolAnnotation *infrav1.FromPoolAnnotation,
+	m3m *infrav1.Metal3Machine,
+	machine *clusterv1.Machine,
+	bmh *bmov1alpha1.BareMetalHost,
+) error {
+	if fromPoolAnnotation == nil {
+		return nil
+	}
+
+	if m3m == nil && machine == nil && bmh == nil {
+		return nil
+	}
+
+	annotationValue, err := getValueFromAnnotation(fromPoolAnnotation.Object, fromPoolAnnotation.Annotation, m3m, machine, bmh)
+	if err != nil {
+		return err
+	}
+
+	if annotationValue == "" {
+		return fmt.Errorf("annotation %s not found or empty on %s", fromPoolAnnotation.Annotation, fromPoolAnnotation.Object)
+	}
+
+	ref := corev1.TypedLocalObjectReference{
+		Name:     annotationValue,
+		APIGroup: ptr.To("ipam.metal3.io"),
+		Kind:     IPPoolKind,
+	}
+
+	return p.addRef(ref)
+}
+
 // getReferencedPools returns a map containing references to all pools mentioned by a [Metal3DataTemplate].
-func getReferencedPools(m3dt infrav1.Metal3DataTemplate) (map[string]corev1.TypedLocalObjectReference, error) {
+// It resolves both direct pool references and annotation-based references.
+func getReferencedPools(m3dt infrav1.Metal3DataTemplate,
+	m3m *infrav1.Metal3Machine,
+	machine *clusterv1.Machine,
+	bmh *bmov1alpha1.BareMetalHost,
+) (map[string]corev1.TypedLocalObjectReference, error) {
 	pools := poolRefs{}
 	if m3dt.Spec.MetaData != nil {
 		for _, pool := range m3dt.Spec.MetaData.IPAddressesFromPool {
@@ -488,7 +531,9 @@ func getReferencedPools(m3dt infrav1.Metal3DataTemplate) (map[string]corev1.Type
 	}
 	if m3dt.Spec.NetworkData != nil {
 		for _, network := range m3dt.Spec.NetworkData.Networks.IPv4 { //nolint:dupl
-			if network.FromPoolRef != nil && network.FromPoolRef.Name != "" {
+			if err := pools.addFromAnnotation(network.FromPoolAnnotation, m3m, machine, bmh); err != nil {
+				return pools, err
+			} else if network.FromPoolRef != nil && network.FromPoolRef.Name != "" {
 				if err := pools.addRef(*network.FromPoolRef); err != nil {
 					return pools, err
 				}
@@ -499,7 +544,9 @@ func getReferencedPools(m3dt infrav1.Metal3DataTemplate) (map[string]corev1.Type
 			}
 
 			for _, route := range network.Routes {
-				if route.Gateway.FromPoolRef != nil && route.Gateway.FromPoolRef.Name != "" {
+				if err := pools.addFromAnnotation(route.Gateway.FromPoolAnnotation, m3m, machine, bmh); err != nil {
+					return pools, err
+				} else if route.Gateway.FromPoolRef != nil && route.Gateway.FromPoolRef.Name != "" {
 					if err := pools.addRef(*route.Gateway.FromPoolRef); err != nil {
 						return pools, err
 					}
@@ -517,7 +564,9 @@ func getReferencedPools(m3dt infrav1.Metal3DataTemplate) (map[string]corev1.Type
 		}
 
 		for _, network := range m3dt.Spec.NetworkData.Networks.IPv6 { //nolint:dupl
-			if network.FromPoolRef != nil && network.FromPoolRef.Name != "" {
+			if err := pools.addFromAnnotation(network.FromPoolAnnotation, m3m, machine, bmh); err != nil {
+				return pools, err
+			} else if network.FromPoolRef != nil && network.FromPoolRef.Name != "" {
 				if err := pools.addRef(*network.FromPoolRef); err != nil {
 					return pools, err
 				}
@@ -527,7 +576,9 @@ func getReferencedPools(m3dt infrav1.Metal3DataTemplate) (map[string]corev1.Type
 				}
 			}
 			for _, route := range network.Routes {
-				if route.Gateway.FromPoolRef != nil && route.Gateway.FromPoolRef.Name != "" {
+				if err := pools.addFromAnnotation(route.Gateway.FromPoolAnnotation, m3m, machine, bmh); err != nil {
+					return pools, err
+				} else if route.Gateway.FromPoolRef != nil && route.Gateway.FromPoolRef.Name != "" {
 					if err := pools.addRef(*route.Gateway.FromPoolRef); err != nil {
 						return pools, err
 					}