add NodeVolumeDetachTimeout to Cluster topology

Author: Yuvaraj Kakaraparthi

api/v1alpha4/conversion.go

@@ -47,6 +47,10 @@ func (src *Cluster) ConvertTo(dstRaw conversion.Hub) error {
 			dst.Spec.Topology.ControlPlane.NodeDrainTimeout = restored.Spec.Topology.ControlPlane.NodeDrainTimeout
 		}
 
+		if restored.Spec.Topology.ControlPlane.NodeVolumeDetachTimeout != nil {
+			dst.Spec.Topology.ControlPlane.NodeVolumeDetachTimeout = restored.Spec.Topology.ControlPlane.NodeVolumeDetachTimeout
+		}
+
 		if restored.Spec.Topology.ControlPlane.NodeDeletionTimeout != nil {
 			dst.Spec.Topology.ControlPlane.NodeDeletionTimeout = restored.Spec.Topology.ControlPlane.NodeDeletionTimeout
 		}

api/v1alpha4/zz_generated.conversion.go

@@ -122,6 +122,11 @@ type ControlPlaneTopology struct {
 	// +optional
 	NodeDrainTimeout *metav1.Duration `json:"nodeDrainTimeout,omitempty"`
 
+	// NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes
+	// to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.
+	// +optional
+	NodeVolumeDetachTimeout *metav1.Duration `json:"nodeVolumeDetachTimeout,omitempty"`
+
 	// NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine
 	// hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.
 	// Defaults to 10 seconds.

api/v1beta1/cluster_types.go

@@ -227,6 +227,13 @@ func (c *ControlPlaneMachineTemplate) NodeDrainTimeout() *Duration {
 	}
 }
 
+// NodeVolumeDetachTimeout provides access to the nodeVolumeDetachTimeout of a MachineTemplate.
+func (c *ControlPlaneMachineTemplate) NodeVolumeDetachTimeout() *Duration {
+	return &Duration{
+		path: Path{"spec", "machineTemplate", "nodeVolumeDetachTimeout"},
+	}
+}
+
 // NodeDeletionTimeout provides access to the nodeDeletionTimeout of a MachineTemplate.
 func (c *ControlPlaneMachineTemplate) NodeDeletionTimeout() *Duration {
 	return &Duration{

api/v1beta1/zz_generated.deepcopy.go

@@ -171,6 +171,28 @@ func TestControlPlane(t *testing.T) {
 		g.Expect(durationString).To(Equal(expectedDurationString))
 	})
 
+	t.Run("Manages spec.machineTemplate.nodeVolumeDetachTimeout", func(t *testing.T) {
+		g := NewWithT(t)
+
+		duration := metav1.Duration{Duration: 2*time.Minute + 10*time.Second}
+		expectedDurationString := "2m10s"
+		g.Expect(ControlPlane().MachineTemplate().NodeVolumeDetachTimeout().Path()).To(Equal(Path{"spec", "machineTemplate", "nodeVolumeDetachTimeout"}))
+
+		err := ControlPlane().MachineTemplate().NodeVolumeDetachTimeout().Set(obj, duration)
+		g.Expect(err).ToNot(HaveOccurred())
+
+		got, err := ControlPlane().MachineTemplate().NodeVolumeDetachTimeout().Get(obj)
+		g.Expect(err).ToNot(HaveOccurred())
+		g.Expect(got).ToNot(BeNil())
+		g.Expect(*got).To(Equal(duration))
+
+		// Check that the literal string value of the duration is correctly formatted.
+		durationString, found, err := unstructured.NestedString(obj.UnstructuredContent(), "spec", "machineTemplate", "nodeVolumeDetachTimeout")
+		g.Expect(err).ToNot(HaveOccurred())
+		g.Expect(found).To(BeTrue())
+		g.Expect(durationString).To(Equal(expectedDurationString))
+	})
+
 	t.Run("Manages spec.machineTemplate.nodeDeletionTimeout", func(t *testing.T) {
 		g := NewWithT(t)
 

api/v1beta1/zz_generated.openapi.go

@@ -242,6 +242,13 @@ func (r *Reconciler) computeControlPlane(ctx context.Context, s *scope.Scope, in
 		}
 	}
 
+	// If it is required to manage the NodeVolumeDetachTimeout for the control plane, set the corresponding field.
+	if s.Blueprint.Topology.ControlPlane.NodeVolumeDetachTimeout != nil {
+		if err := contract.ControlPlane().MachineTemplate().NodeVolumeDetachTimeout().Set(controlPlane, *s.Blueprint.Topology.ControlPlane.NodeVolumeDetachTimeout); err != nil {
+			return nil, errors.Wrap(err, "failed to set spec.machineTemplate.nodeVolumeDetachTimeout in the ControlPlane object")
+		}
+	}
+
 	// If it is required to manage the NodeDeletionTimeout for the control plane, set the corresponding field.
 	if s.Blueprint.Topology.ControlPlane.NodeDeletionTimeout != nil {
 		if err := contract.ControlPlane().MachineTemplate().NodeDeletionTimeout().Set(controlPlane, *s.Blueprint.Topology.ControlPlane.NodeDeletionTimeout); err != nil {

config/crd/bases/cluster.x-k8s.io_clusters.yaml

@@ -263,6 +263,7 @@ func TestComputeControlPlane(t *testing.T) {
 	replicas := int32(3)
 	duration := 10 * time.Second
 	nodeDrainTimeout := metav1.Duration{Duration: duration}
+	nodeVolumeDetachTimeout := metav1.Duration{Duration: duration}
 	nodeDeletionTimeout := metav1.Duration{Duration: duration}
 	cluster := &clusterv1.Cluster{
 		ObjectMeta: metav1.ObjectMeta{
@@ -277,9 +278,10 @@ func TestComputeControlPlane(t *testing.T) {
 						Labels:      map[string]string{"l2": ""},
 						Annotations: map[string]string{"a2": ""},
 					},
-					Replicas:            &replicas,
-					NodeDrainTimeout:    &nodeDrainTimeout,
-					NodeDeletionTimeout: &nodeDeletionTimeout,
+					Replicas:                &replicas,
+					NodeDrainTimeout:        &nodeDrainTimeout,
+					NodeVolumeDetachTimeout: &nodeVolumeDetachTimeout,
+					NodeDeletionTimeout:     &nodeDeletionTimeout,
 				},
 			},
 		},
@@ -317,6 +319,7 @@ func TestComputeControlPlane(t *testing.T) {
 		assertNestedField(g, obj, version, contract.ControlPlane().Version().Path()...)
 		assertNestedField(g, obj, int64(replicas), contract.ControlPlane().Replicas().Path()...)
 		assertNestedField(g, obj, duration.String(), contract.ControlPlane().MachineTemplate().NodeDrainTimeout().Path()...)
+		assertNestedField(g, obj, duration.String(), contract.ControlPlane().MachineTemplate().NodeVolumeDetachTimeout().Path()...)
 		assertNestedField(g, obj, duration.String(), contract.ControlPlane().MachineTemplate().NodeDeletionTimeout().Path()...)
 		assertNestedFieldUnset(g, obj, contract.ControlPlane().MachineTemplate().InfrastructureRef().Path()...)
 

internal/contract/controlplane.go

@@ -371,6 +371,7 @@ func updateDesiredState(ctx context.Context, req *runtimehooksv1.GeneratePatches
 		contract.ControlPlane().MachineTemplate().Metadata().Path(),
 		contract.ControlPlane().MachineTemplate().InfrastructureRef().Path(),
 		contract.ControlPlane().MachineTemplate().NodeDrainTimeout().Path(),
+		contract.ControlPlane().MachineTemplate().NodeVolumeDetachTimeout().Path(),
 		contract.ControlPlane().MachineTemplate().NodeDeletionTimeout().Path(),
 		contract.ControlPlane().Replicas().Path(),
 		contract.ControlPlane().Version().Path(),