Merge pull request #11923 from fabriziopandini/add-v1beta2-conditions-to-DevMachine-Docker

🌱 Add v1beta2 conditions to DevMachine and DevCluster with Docker backend

Author: k8s-ci-robot

api/v1beta1/v1beta2_condition_consts.go

@@ -209,4 +209,7 @@ const (
 
 	// ProvisionedV1Beta2Reason documents an object or a piece of infrastructure being provisioned.
 	ProvisionedV1Beta2Reason = "Provisioned"
+
+	// NotProvisionedV1Beta2Reason documents an object or a piece of infrastructure is not provisioned.
+	NotProvisionedV1Beta2Reason = "NotProvisioned"
 )

test/infrastructure/docker/api/v1beta1/devcluster_types.go

@@ -28,6 +28,46 @@ const (
 	ListenerAnnotationName = "inmemorycluster.infrastructure.cluster.x-k8s.io/listener"
 )
 
+// DevCluster's v1Beta2 conditions that apply to all the supported backends.
+
+// DevCluster's Ready condition and corresponding reasons that will be used in v1Beta2 API version.
+const (
+	// DevClusterReadyV1Beta2Condition is true if
+	// - The DevCluster's is using a docker backend and LoadBalancerAvailable is true.
+	DevClusterReadyV1Beta2Condition = clusterv1.ReadyV1Beta2Condition
+
+	// DevClusterReadyV1Beta2Reason surfaces when the DevCluster readiness criteria is met.
+	DevClusterReadyV1Beta2Reason = clusterv1.ReadyV1Beta2Reason
+
+	// DevClusterNotReadyV1Beta2Reason surfaces when the DevCluster readiness criteria is not met.
+	DevClusterNotReadyV1Beta2Reason = clusterv1.NotReadyV1Beta2Reason
+
+	// DevClusterReadyUnknownV1Beta2Reason surfaces when at least one DevCluster readiness criteria is unknown
+	// and no DevCluster readiness criteria is not met.
+	DevClusterReadyUnknownV1Beta2Reason = clusterv1.ReadyUnknownV1Beta2Reason
+)
+
+// DevCluster's v1Beta2 conditions that apply to the docker backend.
+
+// LoadBalancerAvailable condition and corresponding reasons that will be used in v1Beta2 API version for a DevCluster's docker backend.
+const (
+	// DevClusterDockerLoadBalancerAvailableV1Beta2Condition documents the availability of the container that implements
+	// the load balancer for a DevCluster's docker backend..
+	DevClusterDockerLoadBalancerAvailableV1Beta2Condition string = "LoadBalancerAvailable"
+
+	// DevClusterDockerLoadBalancerNotAvailableV1Beta2Reason surfaces when the container that implements
+	// the load balancer for a DevCluster's docker backend is not available.
+	DevClusterDockerLoadBalancerNotAvailableV1Beta2Reason = clusterv1.NotAvailableV1Beta2Reason
+
+	// DevClusterDockerLoadBalancerAvailableV1Beta2Reason surfaces when the container that implements
+	// the load balancer for a DevCluster's docker backend is available.
+	DevClusterDockerLoadBalancerAvailableV1Beta2Reason = clusterv1.AvailableV1Beta2Reason
+
+	// DevClusterDockerLoadBalancerDeletingV1Beta2Reason surfaces when the container that implements
+	// the load balancer for a DevCluster's docker backend is deleting.
+	DevClusterDockerLoadBalancerDeletingV1Beta2Reason = clusterv1.DeletingV1Beta2Reason
+)
+
 // DevClusterSpec defines the desired state of the DevCluster infrastructure.
 type DevClusterSpec struct {
 	// controlPlaneEndpoint represents the endpoint used to communicate with the control plane.

test/infrastructure/docker/api/v1beta1/devmachine_types.go

@@ -70,8 +70,10 @@ const (
 
 // DevMachine's Ready condition and corresponding reasons that will be used in v1Beta2 API version.
 const (
-	// DevMachineReadyV1Beta2Condition is true if the DevMachine's VMProvisioned, NodeProvisioned,
-	// EtcdProvisioned (if present) and APIServerProvisioned (if present) conditions are true.
+	// DevMachineReadyV1Beta2Condition is true if
+	// - The DevMachine's is using a docker backend and LoadBalancerAvailable is true.
+	// - The DevMachine's is using an in memory backend and VMProvisioned, NodeProvisioned,
+	//	 EtcdProvisioned (if present) and APIServerProvisioned (if present) conditions are true
 	DevMachineReadyV1Beta2Condition = clusterv1.ReadyV1Beta2Condition
 
 	// DevMachineReadyV1Beta2Reason surfaces when the DevMachine readiness criteria is met.
@@ -85,6 +87,61 @@ const (
 	DevMachineReadyUnknownV1Beta2Reason = clusterv1.ReadyUnknownV1Beta2Reason
 )
 
+// DevMachine's v1Beta2 conditions that apply to the docker backend.
+
+// ContainerProvisioned condition and corresponding reasons that will be used in v1Beta2 API version for a DevMachine's docker backend.
+const (
+	// DevMachineDockerContainerProvisionedV1Beta2Condition documents the status of the provisioning of the container
+	// generated by a DevMachine's docker backend.
+	//
+	// NOTE as a difference from other providers, container provisioning and bootstrap are directly managed
+	// by the DevMachine's docker backend controller (not by cloud-init).
+	DevMachineDockerContainerProvisionedV1Beta2Condition string = "ContainerProvisioned"
+
+	// DevMachineDockerContainerWaitingForClusterInfrastructureReadyV1Beta2Reason documents the container for a DevMachine's docker backend waiting for the cluster
+	// infrastructure to be ready.
+	DevMachineDockerContainerWaitingForClusterInfrastructureReadyV1Beta2Reason = clusterv1.WaitingForClusterInfrastructureReadyV1Beta2Reason
+
+	// DevMachineDockerContainerWaitingForControlPlaneInitializedV1Beta2Reason documents a container for a DevMachine's docker backend waiting
+	// for the control plane to be initialized.
+	DevMachineDockerContainerWaitingForControlPlaneInitializedV1Beta2Reason = clusterv1.WaitingForControlPlaneInitializedV1Beta2Reason
+
+	// DevMachineDockerContainerWaitingForBootstrapDataV1Beta2Reason documents a container for a DevMachine's docker backend waiting for the bootstrap
+	// data to be ready.
+	DevMachineDockerContainerWaitingForBootstrapDataV1Beta2Reason = clusterv1.WaitingForBootstrapDataV1Beta2Reason
+
+	// DevMachineDockerContainerProvisionedV1Beta2Reason documents the container for a DevMachine's docker backend is provisioned.
+	DevMachineDockerContainerProvisionedV1Beta2Reason = clusterv1.ProvisionedV1Beta2Reason
+
+	// DevMachineDockerContainerNotProvisionedV1Beta2Reason documents the container for a DevMachine's docker
+	// backend is not provisioned.
+	DevMachineDockerContainerNotProvisionedV1Beta2Reason = clusterv1.NotProvisionedV1Beta2Reason
+
+	// DevMachineDockerContainerDeletingV1Beta2Reason surfaces when the container for a DevMachine's docker
+	// backend is deleting.
+	DevMachineDockerContainerDeletingV1Beta2Reason = clusterv1.DeletingV1Beta2Reason
+)
+
+// BootstrapExecSucceeded condition and corresponding reasons that will be used in v1Beta2 API version for a DevMachine's docker backend.
+const (
+	// DevMachineDockerContainerBootstrapExecSucceededV1Beta2Condition provides an observation of the DevMachine's docker backend bootstrap process.
+	// It is set based on successful execution of bootstrap commands and on the existence of
+	// the /run/cluster-api/bootstrap-success.complete file.
+	// The condition gets generated after ContainerProvisioned condition is True.
+	//
+	// NOTE as a difference from other providers, container provisioning and bootstrap are directly managed
+	// by the DevMachine's docker backend controller (not by cloud-init).
+	DevMachineDockerContainerBootstrapExecSucceededV1Beta2Condition string = "BootstrapExecSucceeded"
+
+	// DevMachineDockerContainerBootstrapExecSucceededV1Beta2Reason documents the container for a DevMachine's docker backend having
+	// completed bootstrap exec commands.
+	DevMachineDockerContainerBootstrapExecSucceededV1Beta2Reason string = "Succeeded"
+
+	// DevMachineDockerContainerBootstrapExecNotSucceededV1Beta2Reason documents the container for a DevMachine's docker backend not having
+	// completed bootstrap exec commands.
+	DevMachineDockerContainerBootstrapExecNotSucceededV1Beta2Reason string = "NotSucceeded"
+)
+
 // DevMachine's v1Beta2 conditions that apply to the in memory backend.
 
 // VirtualMachineProvisioned condition and corresponding reasons that will be used in v1Beta2 API version for a DevMachine's in memory backend.

test/infrastructure/docker/internal/controllers/backends/docker/dockercluster_backend.go

@@ -19,9 +19,12 @@ package docker
 
 import (
 	"context"
+	"fmt"
 	"strconv"
+	"time"
 
 	"github.com/pkg/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
@@ -31,16 +34,14 @@ import (
 	infrav1 "sigs.k8s.io/cluster-api/test/infrastructure/docker/api/v1beta1"
 	"sigs.k8s.io/cluster-api/test/infrastructure/docker/internal/docker"
 	"sigs.k8s.io/cluster-api/util/conditions"
+	v1beta2conditions "sigs.k8s.io/cluster-api/util/conditions/v1beta2"
 	"sigs.k8s.io/cluster-api/util/patch"
 )
 
 // ClusterBackEndReconciler reconciles a DockerCluster object.
 type ClusterBackEndReconciler struct {
 	client.Client
 	ContainerRuntime container.Runtime
-
-	NewPatchHelperFunc  func(obj client.Object, crClient client.Client) (*patch.Helper, error)
-	PatchDevClusterFunc func(ctx context.Context, patchHelper *patch.Helper, dockerCluster *infrav1.DevCluster) error
 }
 
 // ReconcileNormal handle docker backend for DevCluster not yet deleted.
@@ -61,19 +62,37 @@ func (r *ClusterBackEndReconciler) ReconcileNormal(ctx context.Context, cluster
 		strconv.Itoa(dockerCluster.Spec.ControlPlaneEndpoint.Port))
 	if err != nil {
 		conditions.MarkFalse(dockerCluster, infrav1.LoadBalancerAvailableCondition, infrav1.LoadBalancerProvisioningFailedReason, clusterv1.ConditionSeverityWarning, err.Error())
+		v1beta2conditions.Set(dockerCluster, metav1.Condition{
+			Type:    infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+			Status:  metav1.ConditionFalse,
+			Reason:  infrav1.DevClusterDockerLoadBalancerNotAvailableV1Beta2Reason,
+			Message: fmt.Sprintf("Failed to create helper for managing the externalLoadBalancer: %v", err),
+		})
 		return ctrl.Result{}, errors.Wrapf(err, "failed to create helper for managing the externalLoadBalancer")
 	}
 
 	// Create the docker container hosting the load balancer.
 	if err := externalLoadBalancer.Create(ctx); err != nil {
 		conditions.MarkFalse(dockerCluster, infrav1.LoadBalancerAvailableCondition, infrav1.LoadBalancerProvisioningFailedReason, clusterv1.ConditionSeverityWarning, err.Error())
+		v1beta2conditions.Set(dockerCluster, metav1.Condition{
+			Type:    infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+			Status:  metav1.ConditionFalse,
+			Reason:  infrav1.DevClusterDockerLoadBalancerNotAvailableV1Beta2Reason,
+			Message: fmt.Sprintf("Failed to create load balancer: %v", err),
+		})
 		return ctrl.Result{}, errors.Wrap(err, "failed to create load balancer")
 	}
 
 	// Set APIEndpoints with the load balancer IP so the Cluster API Cluster Controller can pull it
 	lbIP, err := externalLoadBalancer.IP(ctx)
 	if err != nil {
 		conditions.MarkFalse(dockerCluster, infrav1.LoadBalancerAvailableCondition, infrav1.LoadBalancerProvisioningFailedReason, clusterv1.ConditionSeverityWarning, err.Error())
+		v1beta2conditions.Set(dockerCluster, metav1.Condition{
+			Type:    infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+			Status:  metav1.ConditionFalse,
+			Reason:  infrav1.DevClusterDockerLoadBalancerNotAvailableV1Beta2Reason,
+			Message: fmt.Sprintf("Failed to get ip for the load balancer: %v", err),
+		})
 		return ctrl.Result{}, errors.Wrap(err, "failed to get ip for the load balancer")
 	}
 
@@ -86,6 +105,11 @@ func (r *ClusterBackEndReconciler) ReconcileNormal(ctx context.Context, cluster
 	// Mark the dockerCluster ready
 	dockerCluster.Status.Ready = true
 	conditions.MarkTrue(dockerCluster, infrav1.LoadBalancerAvailableCondition)
+	v1beta2conditions.Set(dockerCluster, metav1.Condition{
+		Type:   infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+		Status: metav1.ConditionTrue,
+		Reason: infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Reason,
+	})
 
 	return ctrl.Result{}, nil
 }
@@ -103,28 +127,26 @@ func (r *ClusterBackEndReconciler) ReconcileDelete(ctx context.Context, cluster
 		strconv.Itoa(dockerCluster.Spec.ControlPlaneEndpoint.Port))
 	if err != nil {
 		conditions.MarkFalse(dockerCluster, infrav1.LoadBalancerAvailableCondition, infrav1.LoadBalancerProvisioningFailedReason, clusterv1.ConditionSeverityWarning, err.Error())
+		v1beta2conditions.Set(dockerCluster, metav1.Condition{
+			Type:    infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+			Status:  metav1.ConditionFalse,
+			Reason:  infrav1.DevClusterDockerLoadBalancerNotAvailableV1Beta2Reason,
+			Message: fmt.Sprintf("Failed to create helper for managing the externalLoadBalancer: %v", err),
+		})
+
 		return ctrl.Result{}, errors.Wrapf(err, "failed to create helper for managing the externalLoadBalancer")
 	}
 
-	// Set the LoadBalancerAvailableCondition reporting delete is started, and issue a patch in order to make
+	// Set the LoadBalancerAvailableCondition reporting delete is started, and requeue in order to make
 	// this visible to the users.
-	// NB. The operation in docker is fast, so there is the chance the user will not notice the status change;
-	// nevertheless we are issuing a patch so we can test a pattern that will be used by other providers as well
-	newPatchHelperFunc := r.NewPatchHelperFunc
-	if newPatchHelperFunc == nil {
-		newPatchHelperFunc = patch.NewHelper
-	}
-	patchHelper, err := newPatchHelperFunc(dockerCluster, r.Client)
-	if err != nil {
-		return ctrl.Result{}, err
-	}
-	conditions.MarkFalse(dockerCluster, infrav1.LoadBalancerAvailableCondition, clusterv1.DeletingReason, clusterv1.ConditionSeverityInfo, "")
-	patchDevClusterFunc := r.PatchDevClusterFunc
-	if patchDevClusterFunc == nil {
-		patchDevClusterFunc = r.PatchDevCluster
-	}
-	if err := patchDevClusterFunc(ctx, patchHelper, dockerCluster); err != nil {
-		return ctrl.Result{}, errors.Wrap(err, "failed to patch DockerCluster")
+	if conditions.GetReason(dockerCluster, infrav1.LoadBalancerAvailableCondition) != clusterv1.DeletingReason {
+		conditions.MarkFalse(dockerCluster, infrav1.LoadBalancerAvailableCondition, clusterv1.DeletingReason, clusterv1.ConditionSeverityInfo, "")
+		v1beta2conditions.Set(dockerCluster, metav1.Condition{
+			Type:   infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+			Status: metav1.ConditionFalse,
+			Reason: infrav1.DevClusterDockerLoadBalancerDeletingV1Beta2Reason,
+		})
+		return ctrl.Result{RequeueAfter: 1 * time.Second}, nil
 	}
 
 	// Delete the docker container hosting the load balancer
@@ -152,6 +174,24 @@ func (r *ClusterBackEndReconciler) PatchDevCluster(ctx context.Context, patchHel
 		),
 		conditions.WithStepCounterIf(dockerCluster.ObjectMeta.DeletionTimestamp.IsZero()),
 	)
+	if err := v1beta2conditions.SetSummaryCondition(dockerCluster, dockerCluster, infrav1.DevClusterReadyV1Beta2Condition,
+		v1beta2conditions.ForConditionTypes{
+			infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+		},
+		// Using a custom merge strategy to override reasons applied during merge.
+		v1beta2conditions.CustomMergeStrategy{
+			MergeStrategy: v1beta2conditions.DefaultMergeStrategy(
+				// Use custom reasons.
+				v1beta2conditions.ComputeReasonFunc(v1beta2conditions.GetDefaultComputeMergeReasonFunc(
+					infrav1.DevClusterNotReadyV1Beta2Reason,
+					infrav1.DevClusterReadyUnknownV1Beta2Reason,
+					infrav1.DevClusterReadyV1Beta2Reason,
+				)),
+			),
+		},
+	); err != nil {
+		return errors.Wrapf(err, "failed to set %s condition", infrav1.DevClusterReadyV1Beta2Condition)
+	}
 
 	// Patch the object, ignoring conflicts on the conditions owned by this controller.
 	return patchHelper.Patch(
@@ -161,5 +201,9 @@ func (r *ClusterBackEndReconciler) PatchDevCluster(ctx context.Context, patchHel
 			clusterv1.ReadyCondition,
 			infrav1.LoadBalancerAvailableCondition,
 		}},
+		patch.WithOwnedV1Beta2Conditions{Conditions: []string{
+			infrav1.DevClusterReadyV1Beta2Condition,
+			infrav1.DevClusterDockerLoadBalancerAvailableV1Beta2Condition,
+		}},
 	)
 }