Merge pull request #24 from weaveworks/allow-non-ready-controlplane

Add support for detecting CAPI cluster provisioned.

Author: bigkevmcd

api/v1alpha1/condition_types.go

@@ -23,3 +23,16 @@ const (
 	// CAPINotEnabled signals that CAPI component is not installed.
 	CAPINotEnabled string = "CAPINotEnabled"
 )
+
+const (
+	// ClusterProvisionedCondition is a condition when CAPI clusters are
+	// provisioned.
+	//
+	// This indicates that the cluster has been bootstrapped, but the
+	// control-plane may not yet be ready.
+	ClusterProvisionedCondition string = "ClusterProvisioned"
+
+	// ClusterProvisionedReason is the reason for the provisioned state being
+	// set.
+	ClusterProvisionedReason string = "ClusterProvisioned"
+)

controllers/gitopscluster_controller.go

@@ -26,6 +26,7 @@ import (
 	"github.com/fluxcd/pkg/runtime/conditions"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
@@ -43,6 +44,10 @@ import (
 // finalize a GitOps cluster.
 const GitOpsClusterFinalizer = "clusters.gitops.weave.works"
 
+// GitOpsClusterProvisionedAnnotation if applied to a GitOpsCluster indicates
+// that it should have a ready Provisioned condition.
+const GitOpsClusterProvisionedAnnotation = "clusters.gitops.weave.works/provisioned"
+
 const (
 	// SecretNameIndexKey is the key used for indexing secret
 	// resources based on their name.
@@ -145,6 +150,11 @@ func (r *GitopsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 			Namespace: cluster.GetNamespace(),
 			Name:      cluster.Spec.SecretRef.Name,
 		}
+
+		if metav1.HasAnnotation(cluster.ObjectMeta, GitOpsClusterProvisionedAnnotation) {
+			conditions.MarkTrue(cluster, gitopsv1alpha1.ClusterProvisionedCondition, gitopsv1alpha1.ClusterProvisionedReason, "Cluster Provisioned annotation detected")
+		}
+
 		var secret corev1.Secret
 		if err := r.Get(ctx, name, &secret); err != nil {
 			e := fmt.Errorf("failed to get secret %q: %w", name, err)
@@ -196,8 +206,17 @@ func (r *GitopsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 
 		log.Info("CAPI Cluster found", "CAPI cluster", name)
 
+		updated := false
 		if !capiCluster.Status.ControlPlaneReady {
 			conditions.MarkFalse(cluster, meta.ReadyCondition, gitopsv1alpha1.WaitingForControlPlaneReadyStatusReason, "Waiting for ControlPlaneReady status")
+			updated = true
+		}
+		if clusterv1.ClusterPhase(capiCluster.Status.Phase) == clusterv1.ClusterPhaseProvisioned {
+			conditions.MarkTrue(cluster, gitopsv1alpha1.ClusterProvisionedCondition, gitopsv1alpha1.ClusterProvisionedReason, "CAPI Cluster has been provisioned")
+			updated = true
+		}
+
+		if updated {
 			if err := r.Status().Update(ctx, cluster); err != nil {
 				log.Error(err, "failed to update Cluster status")
 				return ctrl.Result{}, err

controllers/gitopscluster_controller_test.go

@@ -37,6 +37,7 @@ func TestReconcile(t *testing.T) {
 		opts              controllers.Options
 		requeueAfter      time.Duration
 		errString         string
+		wantCondition     string
 		wantStatus        metav1.ConditionStatus
 		wantStatusMessage string
 	}{
@@ -54,6 +55,7 @@ func TestReconcile(t *testing.T) {
 				CAPIEnabled: true,
 			},
 			requeueAfter:      controllers.MissingSecretRequeueTime,
+			wantCondition:     meta.ReadyCondition,
 			wantStatus:        "False",
 			wantStatusMessage: "failed to get secret \"testing/missing\": secrets \"missing\" not found",
 		},
@@ -74,7 +76,28 @@ func TestReconcile(t *testing.T) {
 			opts: controllers.Options{
 				CAPIEnabled: true,
 			},
-			wantStatus: "True",
+			wantCondition: meta.ReadyCondition,
+			wantStatus:    "True",
+		},
+		{
+			name: "non-CAPI cluster has provisioned annotation",
+			state: []runtime.Object{
+				makeTestCluster(func(c *gitopsv1alpha1.GitopsCluster) {
+					c.ObjectMeta.Annotations = map[string]string{
+						controllers.GitOpsClusterProvisionedAnnotation: "true",
+					}
+					c.Spec.SecretRef = &meta.LocalObjectReference{
+						Name: "dev",
+					}
+				}),
+			},
+			obj: types.NamespacedName{Namespace: testNamespace, Name: testName},
+			// The referenced secret doesn't exist so we should still check for
+			// it.
+			requeueAfter:      controllers.MissingSecretRequeueTime,
+			wantCondition:     gitopsv1alpha1.ClusterProvisionedCondition,
+			wantStatus:        "True",
+			wantStatusMessage: "Cluster Provisioned annotation detected",
 		},
 		{
 			name: "CAPI cluster does not exist",
@@ -90,6 +113,7 @@ func TestReconcile(t *testing.T) {
 				CAPIEnabled: true,
 			},
 			errString:         "failed to get CAPI cluster.*missing.*not found",
+			wantCondition:     meta.ReadyCondition,
 			wantStatus:        "False",
 			wantStatusMessage: "failed to get CAPI cluster \"testing/missing\": clusters.cluster.x-k8s.io \"missing\" not found",
 		},
@@ -110,9 +134,33 @@ func TestReconcile(t *testing.T) {
 			opts: controllers.Options{
 				CAPIEnabled: true,
 			},
+			wantCondition:     meta.ReadyCondition,
 			wantStatus:        "False",
 			wantStatusMessage: "Waiting for ControlPlaneReady status",
 		},
+		{
+			name: "CAPI cluster exists and is provisioned",
+			state: []runtime.Object{
+				makeTestCluster(func(c *gitopsv1alpha1.GitopsCluster) {
+					c.Spec.CAPIClusterRef = &meta.LocalObjectReference{
+						Name: "dev",
+					}
+				}),
+				makeTestCAPICluster(types.NamespacedName{
+					Name:      "dev",
+					Namespace: testNamespace,
+				}, func(c *clusterv1.Cluster) {
+					c.Status.SetTypedPhase(clusterv1.ClusterPhaseProvisioned)
+				}),
+			},
+			obj: types.NamespacedName{Namespace: testNamespace, Name: testName},
+			opts: controllers.Options{
+				CAPIEnabled: true,
+			},
+			wantCondition:     gitopsv1alpha1.ClusterProvisionedCondition,
+			wantStatus:        "True",
+			wantStatusMessage: "CAPI Cluster has been provisioned",
+		},
 		{
 			name: "CAPI cluster exists and is ready",
 			state: []runtime.Object{
@@ -132,10 +180,11 @@ func TestReconcile(t *testing.T) {
 			opts: controllers.Options{
 				CAPIEnabled: true,
 			},
-			wantStatus: "True",
+			wantCondition: meta.ReadyCondition,
+			wantStatus:    "True",
 		},
 		{
-			name: "CAPI compnent is not enabled",
+			name: "CAPI component is not enabled",
 			state: []runtime.Object{
 				makeTestCluster(func(c *gitopsv1alpha1.GitopsCluster) {
 					c.Spec.CAPIClusterRef = &meta.LocalObjectReference{
@@ -147,6 +196,7 @@ func TestReconcile(t *testing.T) {
 			opts: controllers.Options{
 				CAPIEnabled: false,
 			},
+			wantCondition:     meta.ReadyCondition,
 			wantStatus:        "False",
 			wantStatusMessage: "CAPIClusterRef \"dev\" found but CAPI support is disabled",
 		},
@@ -168,19 +218,7 @@ func TestReconcile(t *testing.T) {
 
 			clsObjectKey := types.NamespacedName{Namespace: testNamespace, Name: testName}
 			cls := testGetGitopsCluster(t, r.Client, clsObjectKey)
-			cond := conditions.Get(cls, meta.ReadyCondition)
-
-			if cond == nil {
-				t.Fatalf("Ready condition was nil")
-			}
-
-			if cond.Message != tt.wantStatusMessage {
-				t.Fatalf("got condition reason %q, want %q", cond.Message, tt.wantStatusMessage)
-			}
-
-			if cond.Status != tt.wantStatus {
-				t.Fatalf("got condition status %q, want %q", cond.Status, tt.wantStatus)
-			}
+			assertClusterStatus(t, cls, tt.wantCondition, tt.wantStatus, tt.wantStatusMessage)
 		})
 	}
 }
@@ -478,3 +516,22 @@ func testGetGitopsCluster(t *testing.T, c client.Client, k client.ObjectKey) *gi
 	}
 	return &cluster
 }
+
+func assertClusterStatus(t *testing.T, cls *gitopsv1alpha1.GitopsCluster, condType string, status metav1.ConditionStatus, msg string) {
+	t.Helper()
+	cond := conditions.Get(cls, condType)
+	if status == "" {
+		return
+	}
+
+	if cond == nil && status != "" {
+		t.Fatalf("%s condition was nil", condType)
+	}
+
+	if cond.Status != status {
+		t.Fatalf("got condition status %q, want %q", cond.Status, status)
+	}
+	if cond.Message != msg {
+		t.Fatalf("got condition reason %q, want %q", cond.Message, msg)
+	}
+}

controllers/suite_test.go

@@ -25,7 +25,6 @@ import (
 	"k8s.io/client-go/kubernetes/scheme"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
-	"sigs.k8s.io/controller-runtime/pkg/envtest/printer"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
@@ -42,9 +41,7 @@ var testEnv *envtest.Environment
 func TestAPIs(t *testing.T) {
 	RegisterFailHandler(Fail)
 
-	RunSpecsWithDefaultAndCustomReporters(t,
-		"Controller Suite",
-		[]Reporter{printer.NewlineReporter{}})
+	RunSpecs(t, "Controller Suite")
 }
 
 var _ = BeforeSuite(func() {