Update documentation for syncing with CKS Cluster

Author: vishesh92

Makefile

@@ -293,7 +293,7 @@ E2E_TIMEOUT ?= 3h
 run-e2e: e2e-essentials ## Run e2e testing. JOB is an optional REGEXP to select certainn test cases to run. e.g. JOB=PR-Blocking, JOB=Conformance
 	$(KUBECTL) apply -f cloud-config.yaml && \
 	cd test/e2e && \
-	$(GINKGO) -vv --trace --tags=e2e --focus=$(JOB) --timeout=$(E2E_TIMEOUT) --skip=Conformance --skip-package=kubeconfig_helper --nodes=1 --no-color=false ./... -- \
+	$(GINKGO) -v --trace --tags=e2e --focus=$(JOB) --timeout=$(E2E_TIMEOUT) --skip=Conformance --skip-package=kubeconfig_helper --nodes=1 --no-color=false ./... -- \
 	    -e2e.artifacts-folder=${REPO_ROOT}/_artifacts \
 	    -e2e.config=${E2E_CONFIG} \
 	    -e2e.skip-resource-cleanup=false -e2e.use-existing-cluster=true

config/manager/manager.yaml

@@ -27,6 +27,7 @@ spec:
         - "--metrics-bind-addr=localhost:8080"
         - "--cloudstackcluster-concurrency=${CAPC_CLOUDSTACKCLUSTER_CONCURRENCY:=10}"
         - "--cloudstackmachine-concurrency=${CAPC_CLOUDSTACKMACHINE_CONCURRENCY:=10}"
+        - "--enable-cloudstack-cks-sync=${CAPC_CLOUDSTACKMACHINE_CKS_SYNC:=false}"
         image: controller:latest
         name: manager
         securityContext:

controllers/cks_cluster_controller.go

@@ -70,16 +70,12 @@ func (reconciler *CksClusterReconciler) Reconcile(ctx context.Context, req ctrl.
 
 // Reconcile actually reconciles the CloudStackCluster.
 func (r *CksClusterReconciliationRunner) Reconcile() (res ctrl.Result, reterr error) {
-	if !r.CSCluster.Spec.SyncWithACS {
+	if !r.CSCluster.Spec.SyncWithACS || len(r.FailureDomains.Items) == 0 {
 		return ctrl.Result{}, nil
 	}
 	// Prevent premature deletion.
 	controllerutil.AddFinalizer(r.ReconciliationSubject, CksClusterFinalizer)
 
-	if len(r.FailureDomains.Items) == 0 {
-		return r.RequeueWithMessage("No failure domains found")
-	}
-
 	res, err := r.AsFailureDomainUser(&r.FailureDomains.Items[0].Spec)()
 	if r.ShouldReturn(res, err) {
 		return res, err

controllers/cloudstackmachine_controller_test.go

@@ -54,11 +54,6 @@ var _ = Describe("CloudStackMachineReconciler", func() {
 			// Setup a failure domain for the machine reconciler to find.
 			Ω(k8sClient.Create(ctx, dummies.CSFailureDomain1)).Should(Succeed())
 			setClusterReady(k8sClient)
-
-			mockCloudClient.EXPECT().GetOrCreateCksCluster(gomock.Any(), gomock.Any(), gomock.Any()).Do(
-				func(arg1, _, _ interface{}) {
-					arg1.(*infrav1.CloudStackCluster).Status.CloudStackClusterID = "cluster-id-123"
-				}).AnyTimes().Return(nil)
 		})
 
 		It("Should call GetOrCreateVMInstance and set Status.Ready to true", func() {

docs/book/src/development/common.md

@@ -33,6 +33,11 @@
 
     # The SSH KeyPair to log into the VM (Optional: you must use clusterctl --flavor *managed-ssh*)
     export CLOUDSTACK_SSH_KEY_NAME=CAPCKeyPair6
+
+    # Sync resources created by CAPC in Apache Cloudstack CKS. Default is false.
+    # Requires setting CAPC_CLOUDSTACKMACHINE_CKS_SYNC=true before initialising the cloudstack provider.
+    # Or set enable-cloudstack-cks-sync to true in the deployment for capc-controller.
+    export CLOUDSTACK_SYNC_WITH_ACS=true
     ```
 
 2. Generate the CAPC cluster spec yaml file

docs/book/src/getting-started.md

@@ -51,6 +51,11 @@ Run the following command to turn your cluster into a management cluster and loa
 
     clusterctl init --infrastructure cloudstack
 
+> If you wish to enable syncing of CAPC resources with cloudstack, set the environment variable
+> `CAPC_CLOUDSTACKMACHINE_CKS_SYNC=true` before initializing the cloudstack provider. Or set
+> `enable-cloudstack-cks-sync` to true in the deployment for capc-controller.
+> This is only supported for Apache CloudStack version 4.19 and above.
+
 <!-- References -->
 
 [capi-quick-start]: https://cluster-api.sigs.k8s.io/user/quick-start.html

pkg/cloud/cks_cluster.go

@@ -102,7 +102,8 @@ func (c *client) GetOrCreateCksCluster(cluster *clusterv1.Cluster, csCluster *in
 
 func (c *client) DeleteCksCluster(csCluster *infrav1.CloudStackCluster) error {
 	if csCluster.Status.CloudStackClusterID != "" {
-		csCksCluster, count, err := c.cs.Kubernetes.GetKubernetesClusterByID(csCluster.Status.CloudStackClusterID, withExternalManaged())
+		csCksCluster, count, err := c.cs.Kubernetes.GetKubernetesClusterByID(
+			csCluster.Status.CloudStackClusterID, withExternalManaged(), cloudstack.WithProject(c.user.Project.ID))
 		if err != nil && strings.Contains(err.Error(), " not found") {
 			return nil
 		}

templates/cluster-template-managed-ssh.yaml

@@ -23,6 +23,7 @@ kind: CloudStackCluster
 metadata:
   name: ${CLUSTER_NAME}
 spec:
+  syncWithACS: ${CLOUDSTACK_SYNC_WITH_ACS=false}
   controlPlaneEndpoint:
     host: ${CLUSTER_ENDPOINT_IP}
     port: ${CLUSTER_ENDPOINT_PORT=6443}

templates/cluster-template-ssh-material.yaml

@@ -23,6 +23,7 @@ kind: CloudStackCluster
 metadata:
   name: ${CLUSTER_NAME}
 spec:
+  syncWithACS: ${CLOUDSTACK_SYNC_WITH_ACS=false}
   controlPlaneEndpoint:
     host: ${CLUSTER_ENDPOINT_IP}
     port: ${CLUSTER_ENDPOINT_PORT=6443}

templates/cluster-template-with-disk-offering.yaml

@@ -23,6 +23,7 @@ kind: CloudStackCluster
 metadata:
   name: ${CLUSTER_NAME}
 spec:
+  syncWithACS: ${CLOUDSTACK_SYNC_WITH_ACS=false}
   controlPlaneEndpoint:
     host: ${CLUSTER_ENDPOINT_IP}
     port: ${CLUSTER_ENDPOINT_PORT=6443}