CAPI e2e tests

.github/workflows/e2e.yaml

@@ -0,0 +1,88 @@
+name: E2E Tests
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  build-e2e-images:
+    name: Build & Run E2E Images
+    runs-on: [self-hosted, linux, X64, jammy, xlarge]
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+      - name: Install requirements
+        run: |
+          sudo apt install make
+          sudo snap install go --classic
+          sudo apt install docker-buildx
+          sudo snap install kubectl --classic
+      - name: Build provider images
+        run: sudo make docker-build-e2e
+      - name: Build k8s-snap image
+        run: |
+          cd templates/docker
+          sudo docker build . -t k8s-snap:dev
+      - name: Save provider image
+        run: |
+          sudo docker save -o provider-images.tar ghcr.io/canonical/cluster-api-k8s/controlplane-controller:dev ghcr.io/canonical/cluster-api-k8s/bootstrap-controller:dev
+          sudo chmod 775 provider-images.tar
+      - name: Save k8s-snap image
+        run: |
+          sudo docker save -o k8s-snap-image.tar k8s-snap:dev
+          sudo chmod 775 k8s-snap-image.tar
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2e-images
+          path: |
+            provider-images.tar
+            k8s-snap-image.tar
+
+  run-e2e-tests:
+    name: Run E2E Tests
+    runs-on: [self-hosted, linux, X64, jammy, xlarge]
+    needs: build-e2e-images
+    strategy:
+      matrix:
+        ginkgo_focus: [
+          "KCP remediation",
+          "MachineDeployment remediation",
+          "Workload cluster creation",
+          "Workload cluster scaling",
+          "Workload cluster upgrade",
+          ]
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+      - name: Install requirements
+        run: |
+          sudo apt install make
+          sudo snap install go --classic
+          sudo apt install docker-buildx
+          sudo snap install kubectl --classic
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: e2e-images
+          path: .
+      - name: Load provider image
+        run: sudo docker load -i provider-images.tar
+      - name: Load k8s-snap image
+        run: sudo docker load -i k8s-snap-image.tar
+      - name: Create docker network
+        run: |
+          sudo docker network create kind --driver=bridge -o com.docker.network.bridge.enable_ip_masquerade=true
+      - name: Increase inotify watches
+        run: |
+          # Prevents https://cluster-api.sigs.k8s.io/user/troubleshooting#cluster-api-with-docker----too-many-open-files
+          sudo sysctl fs.inotify.max_user_watches=1048576
+          sudo sysctl fs.inotify.max_user_instances=8192
+      - name: Run e2e tests
+        run: |
+          sudo GINKGO_FOCUS="${{ matrix.ginkgo_focus }}" SKIP_RESOURCE_CLEANUP=true make test-e2e
+      - name: Setup tmate session
+        if: ${{ failure() }}
+        uses: canonical/action-tmate@main

.golangci.yml

@@ -90,6 +90,7 @@ linters-settings:
 
           - github.com/google/uuid
           - github.com/pkg/errors
+          - sigs.k8s.io/kind/pkg/errors
   gci:
     sections:
       - standard

Makefile

@@ -242,6 +242,9 @@ docker-build-bootstrap-%:
 	DOCKER_BUILDKIT=1 docker build --build-arg builder_image=$(GO_CONTAINER_IMAGE) --build-arg goproxy=$(GOPROXY) --build-arg ARCH=$* --build-arg package=./bootstrap/main.go --build-arg ldflags="$(LDFLAGS)" . -t ${BOOTSTRAP_IMG}:${BOOTSTRAP_IMG_TAG}-$*
 docker-build-bootstrap: manager-bootstrap docker-build-bootstrap-amd64 docker-build-bootstrap-arm64
 
+docker-build-bootstrap-e2e: manager-bootstrap
+	DOCKER_BUILDKIT=1 docker build --build-arg builder_image=$(GO_CONTAINER_IMAGE) --build-arg goproxy=$(GOPROXY) --build-arg ARCH=$(ARCH) --build-arg package=./bootstrap/main.go --build-arg ldflags="$(LDFLAGS)" . -t ${BOOTSTRAP_IMG}:${BOOTSTRAP_IMG_TAG}
+
 # Push the bootstrap multiarch image
 .PHONY: docker-push-bootstrap
 docker-push-bootstrap-%: docker-build-bootstrap-%
@@ -266,8 +269,8 @@ test-controlplane: envtest generate-controlplane generate-controlplane-conversio
 docker-build-e2e: ## Run docker-build-* targets for all the images with settings to be used for the e2e tests
     # please ensure the generated image name matches image names used in the E2E_CONF_FILE
     # and it also match the image tags in bootstrap/config/default and controlplane/config/default
-	$(MAKE) BOOTSTRAP_IMG_TAG=dev docker-build-bootstrap
-	$(MAKE) CONTROLPLANE_IMG_TAG=dev docker-build-controlplane
+	$(MAKE) BOOTSTRAP_IMG_TAG=dev docker-build-bootstrap-e2e
+	$(MAKE) CONTROLPLANE_IMG_TAG=dev docker-build-controlplane-e2e
 
 .PHONY: test-e2e
 test-e2e: $(GINKGO) $(KUSTOMIZE) ## Run the end-to-end tests
@@ -326,6 +329,9 @@ docker-build-controlplane-%:
 	DOCKER_BUILDKIT=1 docker build --build-arg builder_image=$(GO_CONTAINER_IMAGE) --build-arg goproxy=$(GOPROXY) --build-arg ARCH=$* --build-arg package=./controlplane/main.go --build-arg ldflags="$(LDFLAGS)" . -t ${CONTROLPLANE_IMG}:${CONTROLPLANE_IMG_TAG}-$*
 docker-build-controlplane: manager-controlplane docker-build-controlplane-amd64 docker-build-controlplane-arm64
 
+docker-build-controlplane-e2e: manager-controlplane
+	DOCKER_BUILDKIT=1 docker build --build-arg builder_image=$(GO_CONTAINER_IMAGE) --build-arg goproxy=$(GOPROXY) --build-arg ARCH=${ARCH} --build-arg package=./controlplane/main.go --build-arg ldflags="$(LDFLAGS)" . -t ${CONTROLPLANE_IMG}:${CONTROLPLANE_IMG_TAG}
+
 # Push the controlplane multiarch image
 .PHONY: docker-push-controlplane
 docker-push-controlplane-%: docker-build-controlplane-%

bootstrap/config/samples/bootstrap_v1alpha1_ck8sconfig.yaml

@@ -1,4 +1,4 @@
-apiVersion: bootstrap.cluster.x-k8s.io/v1beta1
+apiVersion: bootstrap.cluster.x-k8s.io/v1beta2
 kind: CK8sConfig
 metadata:
   name: ck8sconfig-sample

bootstrap/config/samples/bootstrap_v1alpha3_ck8sconfigtemplate.yaml

@@ -1,4 +1,4 @@
-apiVersion: bootstrap.cluster.x-k8s.io/v1beta1
+apiVersion: bootstrap.cluster.x-k8s.io/v1beta2
 kind: CK8sConfigTemplate
 metadata:
   name: ck8sconfigtemplate-sample

controlplane/config/default/kustomization.yaml

@@ -28,7 +28,7 @@ patchesStrategicMerge:
   # Protect the /metrics endpoint by putting it behind auth.
   # If you want your controller-manager to expose the /metrics
   # endpoint w/o any authn/z, please comment the following line.
-- manager_auth_proxy_patch.yaml
+#- manager_auth_proxy_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

controlplane/config/samples/controlplane_v1alpha3_ck8scontrolplane.yaml

@@ -1,4 +1,4 @@
-apiVersion: controlplane.cluster.x-k8s.io/v1beta1
+apiVersion: controlplane.cluster.x-k8s.io/v1beta2
 kind: CK8sControlPlane
 metadata:
   name: ck8scontrolplane-sample

docs/main.md

@@ -14,7 +14,7 @@ The default behaviour is to `snap install k8s` using the matching track (e.g. in
 You can override this behaviour by changing the default installation script by setting the following fields on the config template:
 
 ```yaml
-apiVersion: controlplane.cluster.x-k8s.io/v1beta1
+apiVersion: controlplane.cluster.x-k8s.io/v1beta2
 kind: CK8sControlPlane
 metadata:
   name: ${CLUSTER_NAME}-control-plane
@@ -47,7 +47,7 @@ For airgap deployments, or environment you can specify `airGapped: true` to prev
 Any extra yaml files placed in `/capi/manifests` will be applied once on the cluster after bootstrapping. Files are applied in alphabetical order, so you can use this in case of dependencies. Example:
 
 ```yaml
-apiVersion: controlplane.cluster.x-k8s.io/v1beta1
+apiVersion: controlplane.cluster.x-k8s.io/v1beta2
 kind: CK8sControlPlane
 metadata:
   name: ${CLUSTER_NAME}-control-plane