Merge branch 'main' into dependabot/go_modules/k8s.io/component-base-0.29.3

mergify[bot] · web-flow · commit 58e1f872b802 · 2024-06-20T03:29:59.000Z
diff --git a/api/v1beta1/tinkerbellmachine_types.go b/api/v1beta1/tinkerbellmachine_types.go
@@ -61,7 +61,7 @@ type TinkerbellMachineSpec struct {
 	ImageLookupOSVersion string `json:"imageLookupOSVersion,omitempty"`
 
 	// TemplateOverride overrides the default Tinkerbell template used by CAPT.
-	// You can learn more about Tinkerbell templates here: https://docs.tinkerbell.org/templates/
+	// You can learn more about Tinkerbell templates here: https://tinkerbell.org/docs/concepts/templates/
 	// +optional
 	TemplateOverride string `json:"templateOverride,omitempty"`
 
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_tinkerbellmachines.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_tinkerbellmachines.yaml
@@ -236,7 +236,7 @@ spec:
               templateOverride:
                 description: |-
                   TemplateOverride overrides the default Tinkerbell template used by CAPT.
-                  You can learn more about Tinkerbell templates here: https://docs.tinkerbell.org/templates/
+                  You can learn more about Tinkerbell templates here: https://tinkerbell.org/docs/concepts/templates/
                 type: string
             type: object
           status:
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_tinkerbellmachinetemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_tinkerbellmachinetemplates.yaml
@@ -228,7 +228,7 @@ spec:
                       templateOverride:
                         description: |-
                           TemplateOverride overrides the default Tinkerbell template used by CAPT.
-                          You can learn more about Tinkerbell templates here: https://docs.tinkerbell.org/templates/
+                          You can learn more about Tinkerbell templates here: https://tinkerbell.org/docs/concepts/templates/
                         type: string
                     type: object
                 required:
diff --git a/controllers/machine_reconcile_scope.go b/controllers/machine_reconcile_scope.go
@@ -28,6 +28,7 @@ import (
 	"text/template"
 
 	"k8s.io/apimachinery/pkg/labels"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	corev1 "k8s.io/api/core/v1"
@@ -49,8 +50,6 @@ import (
 
 const (
 	providerIDPlaceholder = "PROVIDER_ID"
-	inUse                 = "in_use"
-	provisioned           = "provisioned"
 )
 
 var (
@@ -107,7 +106,20 @@ func (scope *machineReconcileScope) addFinalizer() error {
 }
 
 func isHardwareReady(hw *tinkv1.Hardware) bool {
-	return hw.Spec.Metadata.State == inUse && hw.Spec.Metadata.Instance.State == provisioned
+	// if allowpxe false for all interface, hardware ready
+	if len(hw.Spec.Interfaces) == 0 {
+		return false
+	}
+
+	for _, ifc := range hw.Spec.Interfaces {
+		if ifc.Netboot != nil {
+			if *ifc.Netboot.AllowPXE {
+				return false
+			}
+		}
+	}
+
+	return true
 }
 
 type errRequeueRequested struct{}
@@ -184,7 +196,7 @@ func (scope *machineReconcileScope) reconcile(hw *tinkv1.Hardware) error {
 		return nil
 	}
 
-	if err := scope.patchHardwareStates(hw, inUse, provisioned); err != nil {
+	if err := scope.patchHardwareStates(hw, false); err != nil {
 		return fmt.Errorf("failed to patch hardware: %w", err)
 	}
 
@@ -195,14 +207,17 @@ func (scope *machineReconcileScope) reconcile(hw *tinkv1.Hardware) error {
 }
 
 // patchHardwareStates patches a hardware's metadata and instance states.
-func (scope *machineReconcileScope) patchHardwareStates(hw *tinkv1.Hardware, mdState, iState string) error {
+func (scope *machineReconcileScope) patchHardwareStates(hw *tinkv1.Hardware, allowpxe bool) error {
 	patchHelper, err := patch.NewHelper(hw, scope.client)
 	if err != nil {
 		return fmt.Errorf("initializing patch helper for selected hardware: %w", err)
 	}
 
-	hw.Spec.Metadata.State = mdState
-	hw.Spec.Metadata.Instance.State = iState
+	for _, ifc := range hw.Spec.Interfaces {
+		if ifc.Netboot != nil {
+			ifc.Netboot.AllowPXE = ptr.To(allowpxe)
+		}
+	}
 
 	if err := patchHelper.Patch(scope.ctx, hw); err != nil {
 		return fmt.Errorf("patching Hardware object: %w", err)
@@ -716,12 +731,15 @@ func (scope *machineReconcileScope) releaseHardware(hardware *tinkv1.Hardware) e
 
 	delete(hardware.ObjectMeta.Labels, HardwareOwnerNameLabel)
 	delete(hardware.ObjectMeta.Labels, HardwareOwnerNamespaceLabel)
-	// setting these Metadata.State and Metadata.Instance.State = "" indicates to Boots
-	// that this hardware should be allowed to netboot. FYI, this is not authoritative.
+	// setting the AllowPXE=true indicates to Smee that this hardware should be allowed
+	// to netboot. FYI, this is not authoritative.
 	// Other hardware values can be set to prohibit netbooting of a machine.
-	// See this Boots function for the logic around this: https://github.com/tinkerbell/boots/blob/main/job/dhcp.go#L115
-	hardware.Spec.Metadata.State = ""
-	hardware.Spec.Metadata.Instance.State = ""
+	// See this Boots function for the logic around this: https://github.com/tinkerbell/smee/blob/main/internal/ipxe/script/ipxe.go#L112
+	for _, ifc := range hardware.Spec.Interfaces {
+		if ifc.Netboot != nil {
+			ifc.Netboot.AllowPXE = ptr.To(true)
+		}
+	}
 
 	controllerutil.RemoveFinalizer(hardware, infrastructurev1.MachineFinalizer)
 
diff --git a/controllers/tinkerbellmachine_controller_test.go b/controllers/tinkerbellmachine_controller_test.go
@@ -190,6 +190,9 @@ func validHardware(name, uuid, ip string, options ...testOptions) *tinkv1.Hardwa
 							Address: ip,
 						},
 					},
+					Netboot: &tinkv1.Netboot{
+						AllowPXE: ptr.To(true),
+					},
 				},
 			},
 			Metadata: &tinkv1.HardwareMetadata{
@@ -417,7 +420,7 @@ func Test_Machine_reconciliation_with_available_hardware(t *testing.T) {
 		g.Expect(updatedMachine.Status.Addresses).NotTo(BeEmpty(), "Machine status should be updated on every reconciliation")
 	})
 
-	t.Run("in_use_states_are_not_set", func(t *testing.T) {
+	t.Run("allowPXE_is_not_updated", func(t *testing.T) {
 		t.Parallel()
 		g := NewWithT(t)
 
@@ -428,10 +431,7 @@ func Test_Machine_reconciliation_with_available_hardware(t *testing.T) {
 
 		updatedHardware := &tinkv1.Hardware{}
 		g.Expect(client.Get(ctx, hardwareNamespacedName, updatedHardware)).To(Succeed())
-		if diff := cmp.Diff(updatedHardware.Spec.Metadata.State, ""); diff != "" {
-			t.Errorf(diff)
-		}
-		if diff := cmp.Diff(updatedHardware.Spec.Metadata.Instance.State, ""); diff != "" {
+		if diff := cmp.Diff(updatedHardware.Spec.Interfaces[0].Netboot.AllowPXE, ptr.To(true)); diff != "" {
 			t.Errorf(diff)
 		}
 	})
@@ -554,7 +554,7 @@ func Test_Machine_reconciliation_workflow_complete(t *testing.T) {
 		g.Expect(updatedMachine.Status.Addresses).NotTo(BeEmpty(), "Machine status should be updated on every reconciliation")
 	})
 
-	t.Run("in_use_states_are_set", func(t *testing.T) {
+	t.Run("allowPXE_is_updated", func(t *testing.T) {
 		t.Parallel()
 		g := NewWithT(t)
 
@@ -565,10 +565,7 @@ func Test_Machine_reconciliation_workflow_complete(t *testing.T) {
 
 		updatedHardware := &tinkv1.Hardware{}
 		g.Expect(client.Get(ctx, hardwareNamespacedName, updatedHardware)).To(Succeed())
-		if diff := cmp.Diff(updatedHardware.Spec.Metadata.State, "in_use"); diff != "" {
-			t.Errorf(diff)
-		}
-		if diff := cmp.Diff(updatedHardware.Spec.Metadata.Instance.State, "provisioned"); diff != "" {
+		if diff := cmp.Diff(updatedHardware.Spec.Interfaces[0].Netboot.AllowPXE, ptr.To(false)); diff != "" {
 			t.Errorf(diff)
 		}
 	})
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/tinkerbell/cluster-api-provider-tinkerbell
 
-go 1.21
+go 1.21.0
 
 toolchain go1.21.2
 
@@ -10,7 +10,7 @@ require (
 	github.com/google/go-cmp v0.6.0
 	github.com/google/uuid v1.6.0
 	github.com/onsi/ginkgo v1.16.5
-	github.com/onsi/gomega v1.32.0
+	github.com/onsi/gomega v1.33.1
 	github.com/pkg/errors v0.9.1
 	github.com/rs/zerolog v1.32.0
 	github.com/spf13/pflag v1.0.5
@@ -24,7 +24,7 @@ require (
 	k8s.io/utils v0.0.0-20231127182322-b307cd553661
 	sigs.k8s.io/cluster-api v1.6.3
 	sigs.k8s.io/controller-runtime v0.17.0
-	sigs.k8s.io/kustomize/kustomize/v5 v5.3.0
+	sigs.k8s.io/kustomize/kustomize/v5 v5.4.1
 	sigs.k8s.io/yaml v1.4.0
 )
 
@@ -70,17 +70,17 @@ require (
 	github.com/xlab/treeprint v1.2.0 // indirect
 	go.starlark.net v0.0.0-20231121155337-90ade8b19d09 // indirect
 	golang.org/x/exp v0.0.0-20231219180239-dc181d75b848 // indirect
-	golang.org/x/net v0.20.0 // indirect
+	golang.org/x/net v0.24.0 // indirect
 	golang.org/x/oauth2 v0.15.0 // indirect
-	golang.org/x/sys v0.16.0 // indirect
-	golang.org/x/term v0.16.0 // indirect
+	golang.org/x/sys v0.19.0 // indirect
+	golang.org/x/term v0.19.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/time v0.5.0 // indirect
-	golang.org/x/tools v0.17.0 // indirect
+	golang.org/x/tools v0.20.0 // indirect
 	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
 	google.golang.org/appengine v1.6.8 // indirect
 	google.golang.org/protobuf v1.33.0 // indirect
-	gopkg.in/evanphx/json-patch.v5 v5.7.0 // indirect
+	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
@@ -89,8 +89,8 @@ require (
 	k8s.io/cluster-bootstrap v0.29.0 // indirect
 	k8s.io/kube-openapi v0.0.0-20231214164306-ab13479f8bf8 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
-	sigs.k8s.io/kustomize/api v0.16.0 // indirect
-	sigs.k8s.io/kustomize/cmd/config v0.13.0 // indirect
-	sigs.k8s.io/kustomize/kyaml v0.16.0 // indirect
+	sigs.k8s.io/kustomize/api v0.17.1 // indirect
+	sigs.k8s.io/kustomize/cmd/config v0.14.0 // indirect
+	sigs.k8s.io/kustomize/kyaml v0.17.0 // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
 )
diff --git a/go.sum b/go.sum
