Allow metal-stack resources to be provided externally. (#10)

Author: Gerrit91

.gitignore

@@ -5,6 +5,7 @@
 *.so
 *.dylib
 bin/*
+test/external-crds
 Dockerfile.cross
 
 infrastructure-components.yaml

.golangci.yml

@@ -17,7 +17,6 @@ issues:
         - dupl
         - lll
 linters:
-  disable-all: true
   enable:
     - dupl
     - errcheck
@@ -30,7 +29,6 @@ linters:
     - gosimple
     - govet
     - ineffassign
-    - lll
     - misspell
     - nakedret
     - prealloc

Makefile

@@ -67,6 +67,15 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
+.PHONY: update-test-crds
+update-test-crds:
+	go mod tidy
+	rm -rf test/external-crds
+	mkdir -p test/external-crds/cluster-api
+	mkdir -p test/external-crds/firewall-controller-manager
+	cp -f $(shell go list -mod=mod -m -f '{{.Dir}}' all | grep sigs.k8s.io/cluster-api)/config/crd/bases/* test/external-crds/cluster-api
+	cp -f $(shell go list -mod=mod -m -f '{{.Dir}}' all | grep metal-stack/firewall-controller-manager)/config/crds/* test/external-crds/firewall-controller-manager
+
 .PHONY: fmt
 fmt: ## Run go fmt against code.
 	go fmt ./...
@@ -76,15 +85,15 @@ vet: ## Run go vet against code.
 	go vet ./...
 
 .PHONY: test
-test: manifests generate fmt vet envtest ## Run tests.
+test: manifests generate update-test-crds fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out
 
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # Prometheus and CertManager are installed by default; skip with:
 # - PROMETHEUS_INSTALL_SKIP=true
 # - CERT_MANAGER_INSTALL_SKIP=true
 .PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+test-e2e: manifests generate update-test-crds fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	@command -v kind >/dev/null 2>&1 || { \
 		echo "Kind is not installed. Please install Kind manually."; \
 		exit 1; \
@@ -106,7 +115,7 @@ lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 ##@ Build
 
 .PHONY: build
-build: manifests generate fmt vet ## Build manager binary.
+build: manifests generate update-test-crds fmt vet ## Build manager binary.
 	CGO_ENABLED=0 go build -o bin/manager cmd/main.go
 
 .PHONY: run

api/v1alpha1/metalstackcluster_types.go

@@ -50,14 +50,28 @@ type MetalStackClusterSpec struct {
 	// +optional
 	ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint,omitempty"`
 
-	// ProjectID is the project id of the project in metal-stack in which the associated metal-stack resources are created
+	// ProjectID is the project id of the project in metal-stack in which the associated metal-stack resources are created.
 	ProjectID string `json:"projectID"`
 
-	// Partition is the data center partition in which the resources are created
+	// NodeNetworkID is the network ID in metal-stack in which the worker nodes and the firewall of the cluster are placed.
+	// If not provided this will automatically be acquired during reconcile. Note that this field is not patched after auto-acquisition.
+	// The ID of the auto-acquired network can be looked up in the status resource instead.
+	// +optional
+	NodeNetworkID *string `json:"nodeNetworkID,omitempty"`
+
+	// ControlPlaneIP is the ip address in metal-stack on which the control plane will be exposed.
+	// If this ip and the control plane endpoint are not provided this will automatically be acquired during reconcile. Note that this field is not patched after auto-acquisition.
+	// The address of the auto-acquired ip can be looked up in the control plane endpoint.
+	// +optional
+	ControlPlaneIP *string `json:"controlPlaneIP,omitempty"`
+
+	// Partition is the data center partition in which the resources are created.
 	Partition string `json:"partition"`
 
-	// Firewall describes the firewall for this cluster
-	Firewall Firewall `json:"firewall"`
+	// Firewall describes the firewall for this cluster.
+	// If not provided this will automatically be created during reconcile.
+	// +optional
+	Firewall *Firewall `json:"firewall,omitempty"`
 }
 
 // APIEndpoint represents a reachable Kubernetes API endpoint.
@@ -114,10 +128,10 @@ type MetalStackClusterStatus struct {
 	// +optional
 	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
 
-	// NodeCIDR is set as soon as the node network was created
+	// NodeCIDR is set as soon as the node network was created.
 	// +optional
 	NodeCIDR *string `json:"nodeCIDR,omitempty"`
-	// NodeNetworkID is set as soon as the node network was created
+	// NodeNetworkID is set as soon as the node network was created.
 	// +optional
 	NodeNetworkID *string `json:"nodeNetworkID,omitempty"`
 }

api/v1alpha1/zz_generated.deepcopy.go

@@ -1 +1,2 @@
 .extra_vars.yaml
+requirements.yaml

capi-lab/.gitignore

@@ -7,3 +7,24 @@ metal_ingress_dns: metal.{{ metal_control_plane_ingress_dns }}
 
 metal_partition_metal_api_addr: metal.172.17.0.1.nip.io
 metal_partition_metal_api_basepath: "/"
+
+metal_api_images:
+- id: firewall-ubuntu-3.0
+  name: Firewall 3 Ubuntu
+  description: Firewall 3 Ubuntu Latest Release
+  url: https://images.metal-stack.io/metal-os/{{ metal_api_latest_os_image_release_name }}/firewall/3.0-ubuntu/img.tar.lz4
+  features:
+    - firewall
+- id: ubuntu-24.04
+  name: Ubuntu 24.04
+  description: Ubuntu 24.04 Latest Release
+  url: https://images.metal-stack.io/metal-os/{{ metal_api_latest_os_image_release_name }}/ubuntu/24.04/img.tar.lz4
+  features:
+    - machine
+- id: firewall-ubuntu-3.0.20241106
+  name: Firewall 3 Ubuntu 20241106
+  description: Firewall 3 Ubuntu 20241106
+  url: http://images.metal-stack.io/metal-os/20241106/firewall/3.0-ubuntu/img.tar.lz4
+  classification: supported
+  features:
+    - firewall

capi-lab/mini-lab

@@ -161,15 +161,13 @@ func main() {
 	if err = (&controller.MetalStackClusterReconciler{
 		MetalClient: metalClient,
 		Client:      mgr.GetClient(),
-		Scheme:      mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "MetalStackCluster")
 		os.Exit(1)
 	}
 	if err = (&controller.MetalStackMachineReconciler{
 		MetalClient: metalClient,
 		Client:      mgr.GetClient(),
-		Scheme:      mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "MetalStackMachine")
 		os.Exit(1)