Merge pull request #4781 from nojnhuh/v2-ready

k8s-ci-robot · web-flow · commit cef502c4a886 · 2024-04-29T11:49:08.000-07:00
ASOAPI: reconcile status.ready
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_azureasomanagedclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_azureasomanagedclusters.yaml
@@ -70,6 +70,11 @@ spec:
             description: AzureASOManagedClusterStatus defines the observed state of
               AzureASOManagedCluster.
             properties:
+              ready:
+                description: |-
+                  Ready represents whether or not the cluster has been provisioned and is ready. It fulfills Cluster
+                  API's cluster infrastructure provider contract.
+                type: boolean
               resources:
                 items:
                   description: ResourceStatus represents the status of a resource.
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_azureasomanagedcontrolplanes.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_azureasomanagedcontrolplanes.yaml
@@ -73,6 +73,16 @@ spec:
                 - host
                 - port
                 type: object
+              initialized:
+                description: |-
+                  Initialized represents whether or not the API server has been provisioned. It fulfills Cluster API's
+                  control plane provider contract. For AKS, this is equivalent to `ready`.
+                type: boolean
+              ready:
+                description: |-
+                  Ready represents whether or not the API server is ready to receive requests. It fulfills Cluster API's
+                  control plane provider contract. For AKS, this is equivalent to `initialized`.
+                type: boolean
               resources:
                 items:
                   description: ResourceStatus represents the status of a resource.
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_azureasomanagedmachinepools.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_azureasomanagedmachinepools.yaml
@@ -60,6 +60,11 @@ spec:
             description: AzureASOManagedMachinePoolStatus defines the observed state
               of AzureASOManagedMachinePool.
             properties:
+              ready:
+                description: |-
+                  Ready represents whether or not the infrastructure is ready to be used. It fulfills Cluster API's
+                  machine pool infrastructure provider contract.
+                type: boolean
               replicas:
                 description: |-
                   Replicas is the current number of provisioned replicas. It fulfills Cluster API's machine pool
diff --git a/exp/api/v1alpha1/azureasomanagedcluster_types.go b/exp/api/v1alpha1/azureasomanagedcluster_types.go
@@ -43,6 +43,11 @@ type AzureASOManagedClusterSpec struct {
 
 // AzureASOManagedClusterStatus defines the observed state of AzureASOManagedCluster.
 type AzureASOManagedClusterStatus struct {
+	// Ready represents whether or not the cluster has been provisioned and is ready. It fulfills Cluster
+	// API's cluster infrastructure provider contract.
+	//+optional
+	Ready bool `json:"ready"`
+
 	//+optional
 	Resources []ResourceStatus `json:"resources,omitempty"`
 }
diff --git a/exp/api/v1alpha1/azureasomanagedcontrolplane_types.go b/exp/api/v1alpha1/azureasomanagedcontrolplane_types.go
@@ -31,6 +31,16 @@ type AzureASOManagedControlPlaneSpec struct {
 
 // AzureASOManagedControlPlaneStatus defines the observed state of AzureASOManagedControlPlane.
 type AzureASOManagedControlPlaneStatus struct {
+	// Initialized represents whether or not the API server has been provisioned. It fulfills Cluster API's
+	// control plane provider contract. For AKS, this is equivalent to `ready`.
+	//+optional
+	Initialized bool `json:"initialized"`
+
+	// Ready represents whether or not the API server is ready to receive requests. It fulfills Cluster API's
+	// control plane provider contract. For AKS, this is equivalent to `initialized`.
+	//+optional
+	Ready bool `json:"ready"`
+
 	// Version is the observed Kubernetes version of the control plane. It fulfills Cluster API's control
 	// plane provider contract.
 	//+optional
diff --git a/exp/api/v1alpha1/azureasomanagedmachinepool_types.go b/exp/api/v1alpha1/azureasomanagedmachinepool_types.go
@@ -35,6 +35,11 @@ type AzureASOManagedMachinePoolStatus struct {
 	//+optional
 	Replicas int32 `json:"replicas"`
 
+	// Ready represents whether or not the infrastructure is ready to be used. It fulfills Cluster API's
+	// machine pool infrastructure provider contract.
+	//+optional
+	Ready bool `json:"ready"`
+
 	//+optional
 	Resources []ResourceStatus `json:"resources,omitempty"`
 }
diff --git a/exp/controllers/azureasomanagedcluster_controller.go b/exp/controllers/azureasomanagedcluster_controller.go
@@ -186,6 +186,8 @@ func (r *AzureASOManagedClusterReconciler) Reconcile(ctx context.Context, req ct
 		}
 	}()
 
+	asoManagedCluster.Status.Ready = false
+
 	cluster, err := util.GetOwnerCluster(ctx, r.Client, asoManagedCluster.ObjectMeta)
 	if err != nil {
 		return ctrl.Result{}, err
@@ -252,6 +254,8 @@ func (r *AzureASOManagedClusterReconciler) reconcileNormal(ctx context.Context,
 	}
 	asoManagedCluster.Spec.ControlPlaneEndpoint = asoManagedControlPlane.Status.ControlPlaneEndpoint
 
+	asoManagedCluster.Status.Ready = !asoManagedCluster.Spec.ControlPlaneEndpoint.IsZero()
+
 	return ctrl.Result{}, nil
 }
 
diff --git a/exp/controllers/azureasomanagedcluster_controller_test.go b/exp/controllers/azureasomanagedcluster_controller_test.go
@@ -182,6 +182,9 @@ func TestAzureASOManagedClusterReconcile(t *testing.T) {
 					clusterv1.ClusterFinalizer,
 				},
 			},
+			Status: infrav1exp.AzureASOManagedClusterStatus{
+				Ready: true,
+			},
 		}
 		c := fakeClientBuilder().
 			WithObjects(cluster, asoManagedCluster).
@@ -205,6 +208,9 @@ func TestAzureASOManagedClusterReconcile(t *testing.T) {
 		result, err := r.Reconcile(ctx, ctrl.Request{NamespacedName: client.ObjectKeyFromObject(asoManagedCluster)})
 		g.Expect(err).NotTo(HaveOccurred())
 		g.Expect(result).To(Equal(ctrl.Result{}))
+
+		g.Expect(r.Get(ctx, client.ObjectKeyFromObject(asoManagedCluster), asoManagedCluster)).To(Succeed())
+		g.Expect(asoManagedCluster.Status.Ready).To(BeFalse())
 	})
 
 	t.Run("successfully reconciles normally", func(t *testing.T) {
@@ -239,6 +245,9 @@ func TestAzureASOManagedClusterReconcile(t *testing.T) {
 					clusterv1.ClusterFinalizer,
 				},
 			},
+			Status: infrav1exp.AzureASOManagedClusterStatus{
+				Ready: false,
+			},
 		}
 		asoManagedControlPlane := &infrav1exp.AzureASOManagedControlPlane{
 			ObjectMeta: metav1.ObjectMeta{
@@ -268,6 +277,7 @@ func TestAzureASOManagedClusterReconcile(t *testing.T) {
 
 		g.Expect(c.Get(ctx, client.ObjectKeyFromObject(asoManagedCluster), asoManagedCluster)).To(Succeed())
 		g.Expect(asoManagedCluster.Spec.ControlPlaneEndpoint.Host).To(Equal("endpoint"))
+		g.Expect(asoManagedCluster.Status.Ready).To(BeTrue())
 	})
 
 	t.Run("successfully reconciles pause", func(t *testing.T) {
diff --git a/exp/controllers/azureasomanagedcontrolplane_controller.go b/exp/controllers/azureasomanagedcontrolplane_controller.go
@@ -137,6 +137,9 @@ func (r *AzureASOManagedControlPlaneReconciler) Reconcile(ctx context.Context, r
 		}
 	}()
 
+	asoManagedControlPlane.Status.Ready = false
+	asoManagedControlPlane.Status.Initialized = false
+
 	cluster, err := util.GetOwnerCluster(ctx, r.Client, asoManagedControlPlane.ObjectMeta)
 	if err != nil {
 		return ctrl.Result{}, err
@@ -220,6 +223,11 @@ func (r *AzureASOManagedControlPlaneReconciler) reconcileNormal(ctx context.Cont
 		return ctrl.Result{}, fmt.Errorf("failed to reconcile kubeconfig: %w", err)
 	}
 
+	asoManagedControlPlane.Status.Ready = !asoManagedControlPlane.Status.ControlPlaneEndpoint.IsZero()
+	// The AKS API doesn't allow us to distinguish between CAPI's definitions of "initialized" and "ready" so
+	// we treat them equivalently.
+	asoManagedControlPlane.Status.Initialized = asoManagedControlPlane.Status.Ready
+
 	return ctrl.Result{}, nil
 }
 
diff --git a/exp/controllers/azureasomanagedcontrolplane_controller_test.go b/exp/controllers/azureasomanagedcontrolplane_controller_test.go
@@ -181,6 +181,9 @@ func TestAzureASOManagedControlPlaneReconcile(t *testing.T) {
 					},
 				},
 			},
+			Status: infrav1exp.AzureASOManagedControlPlaneStatus{
+				Ready: true,
+			},
 		}
 		c := fakeClientBuilder().
 			WithObjects(cluster, asoManagedControlPlane).
@@ -204,6 +207,9 @@ func TestAzureASOManagedControlPlaneReconcile(t *testing.T) {
 		result, err := r.Reconcile(ctx, ctrl.Request{NamespacedName: client.ObjectKeyFromObject(asoManagedControlPlane)})
 		g.Expect(err).NotTo(HaveOccurred())
 		g.Expect(result).To(Equal(ctrl.Result{}))
+
+		g.Expect(c.Get(ctx, client.ObjectKeyFromObject(asoManagedControlPlane), asoManagedControlPlane)).To(Succeed())
+		g.Expect(asoManagedControlPlane.Status.Ready).To(BeFalse())
 	})
 
 	t.Run("successfully reconciles normally", func(t *testing.T) {
@@ -278,6 +284,9 @@ func TestAzureASOManagedControlPlaneReconcile(t *testing.T) {
 					},
 				},
 			},
+			Status: infrav1exp.AzureASOManagedControlPlaneStatus{
+				Ready: false,
+			},
 		}
 		c := fakeClientBuilder().
 			WithObjects(cluster, asoManagedControlPlane, managedCluster, kubeconfig).
@@ -309,6 +318,7 @@ func TestAzureASOManagedControlPlaneReconcile(t *testing.T) {
 		g.Expect(asoManagedControlPlane.Status.ControlPlaneEndpoint.Host).To(Equal("endpoint"))
 		g.Expect(asoManagedControlPlane.Status.Version).To(Equal("vCurrent"))
 		g.Expect(kubeConfigPatched).To(BeTrue())
+		g.Expect(asoManagedControlPlane.Status.Ready).To(BeTrue())
 	})
 
 	t.Run("successfully reconciles pause", func(t *testing.T) {
diff --git a/exp/controllers/azureasomanagedmachinepool_controller.go b/exp/controllers/azureasomanagedmachinepool_controller.go
@@ -149,6 +149,8 @@ func (r *AzureASOManagedMachinePoolReconciler) Reconcile(ctx context.Context, re
 		}
 	}()
 
+	asoManagedMachinePool.Status.Ready = false
+
 	machinePool, err := utilexp.GetOwnerMachinePool(ctx, r.Client, asoManagedMachinePool.ObjectMeta)
 	if err != nil {
 		return ctrl.Result{}, err
@@ -274,6 +276,8 @@ func (r *AzureASOManagedMachinePoolReconciler) reconcileNormal(ctx context.Conte
 	asoManagedMachinePool.Spec.ProviderIDList = providerIDs
 	asoManagedMachinePool.Status.Replicas = int32(ptr.Deref(agentPool.Status.Count, 0))
 
+	asoManagedMachinePool.Status.Ready = true
+
 	return ctrl.Result{}, nil
 }
 
diff --git a/exp/controllers/azureasomanagedmachinepool_controller_test.go b/exp/controllers/azureasomanagedmachinepool_controller_test.go
@@ -239,6 +239,9 @@ func TestAzureASOManagedMachinePoolReconcile(t *testing.T) {
 					},
 				},
 			},
+			Status: infrav1exp.AzureASOManagedMachinePoolStatus{
+				Ready: true,
+			},
 		}
 		machinePool := &expv1.MachinePool{
 			ObjectMeta: metav1.ObjectMeta{
@@ -271,6 +274,9 @@ func TestAzureASOManagedMachinePoolReconcile(t *testing.T) {
 		result, err := r.Reconcile(ctx, ctrl.Request{NamespacedName: client.ObjectKeyFromObject(asoManagedMachinePool)})
 		g.Expect(err).NotTo(HaveOccurred())
 		g.Expect(result).To(Equal(ctrl.Result{}))
+
+		g.Expect(r.Get(ctx, client.ObjectKeyFromObject(asoManagedMachinePool), asoManagedMachinePool)).To(Succeed())
+		g.Expect(asoManagedMachinePool.Status.Ready).To(BeFalse())
 	})
 
 	t.Run("successfully reconciles normally", func(t *testing.T) {
@@ -336,6 +342,9 @@ func TestAzureASOManagedMachinePoolReconcile(t *testing.T) {
 					},
 				},
 			},
+			Status: infrav1exp.AzureASOManagedMachinePoolStatus{
+				Ready: false,
+			},
 		}
 		machinePool := &expv1.MachinePool{
 			ObjectMeta: metav1.ObjectMeta{
@@ -400,6 +409,7 @@ func TestAzureASOManagedMachinePoolReconcile(t *testing.T) {
 		g.Expect(r.Get(ctx, client.ObjectKeyFromObject(asoManagedMachinePool), asoManagedMachinePool)).To(Succeed())
 		g.Expect(asoManagedMachinePool.Spec.ProviderIDList).To(ConsistOf("azure://node1", "azure://node2"))
 		g.Expect(asoManagedMachinePool.Status.Replicas).To(Equal(int32(3)))
+		g.Expect(asoManagedMachinePool.Status.Ready).To(BeTrue())
 	})
 
 	t.Run("successfully reconciles pause", func(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -186,6 +186,8 @@ func (r *AzureASOManagedClusterReconciler) Reconcile(ctx context.Context, req ct`
`186`	`186`	`}`
`187`	`187`	`}()`
`188`	`188`
	`189`	`+ asoManagedCluster.Status.Ready = false`
	`190`	`+`
`189`	`191`	`cluster, err := util.GetOwnerCluster(ctx, r.Client, asoManagedCluster.ObjectMeta)`
`190`	`192`	`if err != nil {`
`191`	`193`	`return ctrl.Result{}, err`
`@@ -252,6 +254,8 @@ func (r *AzureASOManagedClusterReconciler) reconcileNormal(ctx context.Context,`
`252`	`254`	`}`
`253`	`255`	`asoManagedCluster.Spec.ControlPlaneEndpoint = asoManagedControlPlane.Status.ControlPlaneEndpoint`
`254`	`256`
	`257`	`+ asoManagedCluster.Status.Ready = !asoManagedCluster.Spec.ControlPlaneEndpoint.IsZero()`
	`258`	`+`
`255`	`259`	`return ctrl.Result{}, nil`
`256`	`260`	`}`
`257`	`261`
Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,9 @@ func (r *AzureASOManagedControlPlaneReconciler) Reconcile(ctx context.Context, r`
`137`	`137`	`}`
`138`	`138`	`}()`
`139`	`139`
	`140`	`+ asoManagedControlPlane.Status.Ready = false`
	`141`	`+ asoManagedControlPlane.Status.Initialized = false`
	`142`	`+`
`140`	`143`	`cluster, err := util.GetOwnerCluster(ctx, r.Client, asoManagedControlPlane.ObjectMeta)`
`141`	`144`	`if err != nil {`
`142`	`145`	`return ctrl.Result{}, err`
`@@ -220,6 +223,11 @@ func (r *AzureASOManagedControlPlaneReconciler) reconcileNormal(ctx context.Cont`
`220`	`223`	`return ctrl.Result{}, fmt.Errorf("failed to reconcile kubeconfig: %w", err)`
`221`	`224`	`}`
`222`	`225`
	`226`	`+ asoManagedControlPlane.Status.Ready = !asoManagedControlPlane.Status.ControlPlaneEndpoint.IsZero()`
	`227`	`+ // The AKS API doesn't allow us to distinguish between CAPI's definitions of "initialized" and "ready" so`
	`228`	`+ // we treat them equivalently.`
	`229`	`+ asoManagedControlPlane.Status.Initialized = asoManagedControlPlane.Status.Ready`
	`230`	`+`
`223`	`231`	`return ctrl.Result{}, nil`
`224`	`232`	`}`
`225`	`233`