Merge branch 'main' into cyclonedx-sbom

Author: robertvolkmann

DEVELOPMENT.md

@@ -85,32 +85,6 @@ If you want to provide service's of type load balancer through MetalLB by the me
 kubectl --kubeconfig capi-lab/.capms-cluster-kubeconfig.yaml apply --kustomize capi-lab/metallb
 ```
 
-For each node in your Kubernetes cluster, you need to create a BGP peer configuration. Replace the placeholders ({{
-NODE_ASN }}, {{ NODE_HOSTNAME }}, and {{ NODE_ROUTER_ID }}) with the appropriate values for each node.
-
-```bash
-cat <<EOF | kubectl --kubeconfig=capi-lab/.capms-cluster-kubeconfig.yaml create -f -
-apiVersion: metallb.io/v1beta2
-kind: BGPPeer
-metadata:
-  name: ${NODE_HOSTNAME}
-  namespace: metallb-system
-spec:
-  holdTime: 1m30s
-  keepaliveTime: 0s
-  myASN: ${NODE_ASN}
-  nodeSelectors:
-  - matchExpressions:
-    - key: kubernetes.io/hostname
-      operator: In
-      values:
-      - ${NODE_HOSTNAME}
-  passwordSecret: {}
-  peerASN: ${NODE_ASN}
-  peerAddress: ${NODE_ROUTER_ID}
-EOF
-```
-
 That's it!
 
 ### To Deploy on the cluster
@@ -230,7 +204,7 @@ export WORKER_MACHINE_SIZE=
 
 export CLUSTER_NAME=
 export NAMESPACE=default
-export KUBERNETES_VERSION=v1.30.6
+export KUBERNETES_VERSION=v1.31.6
 
 export CONTROL_PLANE_MACHINE_COUNT=1
 export WORKER_MACHINE_COUNT=1

README.md

@@ -146,42 +146,6 @@ If you want to provide service's of type `LoadBalancer` through MetalLB by the `
 kubectl --kubeconfig capms-cluster.kubeconfig apply --kustomize capi-lab/metallb
 ```
 
-For each worker node in your Kubernetes cluster, you need to create a BGP peer configuration. Replace the placeholders (`{{
-NODE_ASN }}`, `{{ NODE_HOSTNAME }}`, and `{{ NODE_ROUTER_ID }}`) with the appropriate values for each node.
-
-```bash
-# in metal-stack, list all machines of your cluster
-metalctl machine ls --project $METAL_PROJECT_ID
-
-# for each worker machine collect the information as follows
-export NODE_ID=<worker-machine-id>
-export NODE_HOSTNAME=$(metalctl machine describe $NODE_ID -o template --template '{{ .allocation.hostname }}')
-export NODE_ASN=$(metalctl machine describe $NODE_ID -o template --template '{{ printf "%.0f" (index .allocation.networks 0).asn }}')
-export NODE_ROUTER_ID=$(metalctl machine describe $NODE_ID -o template --template '{{ (index (index .allocation.networks 0).ips 0) }}')
-
-# for each worker machine generate and apply the BGPPeer resource
-cat <<EOF | kubectl --kubeconfig=capms-cluster.kubeconfig create -f -
-apiVersion: metallb.io/v1beta2
-kind: BGPPeer
-metadata:
-  name: ${NODE_HOSTNAME}
-  namespace: metallb-system
-spec:
-  holdTime: 1m30s
-  keepaliveTime: 0s
-  myASN: ${NODE_ASN}
-  nodeSelectors:
-  - matchExpressions:
-    - key: kubernetes.io/hostname
-      operator: In
-      values:
-      - ${NODE_HOSTNAME}
-  passwordSecret: {}
-  peerASN: ${NODE_ASN}
-  peerAddress: ${NODE_ROUTER_ID}
-EOF
-```
-
 ## Frequently Asked Questions
 
 ### I need to know the Control Plane IP address in advance. Can I provide a static IP address in advance?

api/v1alpha1/metalstackcluster_types.go

@@ -142,5 +142,5 @@ func (c *MetalStackCluster) SetConditions(conditions clusterv1.Conditions) {
 }
 
 func (c *MetalStackCluster) GetClusterID() string {
-	return fmt.Sprintf("%s/%s", c.GetNamespace(), c.GetName())
+	return fmt.Sprintf("%s.%s", c.GetNamespace(), c.GetName())
 }

api/v1alpha1/metalstackcluster_types_test.go

@@ -0,0 +1,35 @@
+package v1alpha1_test
+
+import (
+	"github.com/metal-stack/cluster-api-provider-metal-stack/api/v1alpha1"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	utilvalidation "k8s.io/apimachinery/pkg/util/validation"
+)
+
+var _ = Describe("MetalStackCluster", func() {
+	It("GetClusterID is a valid label value", func() {
+		cluster := &v1alpha1.MetalStackCluster{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-cluster",
+				Namespace: "some-namespace",
+			},
+		}
+
+		clusterID := cluster.GetClusterID()
+		Expect(utilvalidation.IsValidLabelValue(clusterID)).To(BeEmpty())
+	})
+
+	It("GetClusterID is constant", func() {
+		cluster := &v1alpha1.MetalStackCluster{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "my-cluster",
+				Namespace: "some-namespace",
+			},
+		}
+
+		clusterID := cluster.GetClusterID()
+		Expect(clusterID).To(Equal("some-namespace.my-cluster"))
+	})
+})

api/v1alpha1/suite_test.go

@@ -0,0 +1,13 @@
+package v1alpha1_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestTypes(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "v1alpha1.Types Suite")
+}

capi-lab/Makefile

@@ -6,6 +6,9 @@ KIND_EXPERIMENTAL_DOCKER_NETWORK=mini_lab_ext
 KUBECONFIG := $(shell pwd)/mini-lab/.kubeconfig
 MINI_LAB_FLAVOR=capms
 
+CLUSTER_NAME ?= metal-test
+KUBERNETES_VERSION ?= 1.31.6
+
 METAL_API_URL=http://metal.203.0.113.1.nip.io:8080
 METAL_API_HMAC=metal-edit
 METAL_API_HMAC_AUTH_TYPE=Metal-Edit
@@ -16,9 +19,9 @@ METALCTL_HMAC_AUTH_TYPE=Metal-Edit
 METAL_PARTITION ?= mini-lab
 METAL_PROJECT_ID ?= 00000000-0000-0000-0000-000000000001
 
-CONTROL_PLANE_MACHINE_IMAGE ?= ubuntu-24.0-k8s-1.31.6
+CONTROL_PLANE_MACHINE_IMAGE ?= ubuntu-24.0-k8s-$(KUBERNETES_VERSION)
 CONTROL_PLANE_MACHINE_SIZE ?= v1-small-x86
-WORKER_MACHINE_IMAGE ?= ubuntu-24.0-k8s-1.31.6
+WORKER_MACHINE_IMAGE ?= ubuntu-24.0-k8s-$(KUBERNETES_VERSION)
 WORKER_MACHINE_SIZE ?= v1-small-x86
 
 IMG ?= ghcr.io/metal-stack/cluster-api-metal-stack-controller:latest
@@ -54,37 +57,38 @@ controller:
 
 .PHONY: firewall
 firewall:
-	metalctl firewall create --description fw --name fw --hostname fw --project 00000000-0000-0000-0000-000000000001 --partition mini-lab --image firewall-ubuntu-3.0 --size v1-small-x86 --firewall-rules-file=firewall-rules.yaml --networks internet-mini-lab,$(shell metalctl network list --name metal-test -o template --template '{{ .id }}')
+	metalctl firewall create --description fw --name fw --hostname fw --project 00000000-0000-0000-0000-000000000001 --partition mini-lab --image firewall-ubuntu-3.0 --size v1-small-x86 --firewall-rules-file=firewall-rules.yaml --networks internet-mini-lab,$(shell metalctl network list --name $(CLUSTER_NAME) -o template --template '{{ .id }}')
 
 .PHONY: node-network
 node-network:
-	metalctl network allocate --description "node network for metal-test cluster" --name metal-test --project 00000000-0000-0000-0000-000000000001 --partition mini-lab
+	metalctl network allocate --description "node network for $(CLUSTER_NAME) cluster" --name $(CLUSTER_NAME) --project 00000000-0000-0000-0000-000000000001 --partition mini-lab
 
 .PHONY: control-plane-ip
 control-plane-ip:
 	metalctl network ip create --network internet-mini-lab --project $(METAL_PROJECT_ID) --name "$(CLUSTER_NAME)-vip" --type static -o template --template "{{ .ipaddress }}"
 
 .PHONY: apply-sample-cluster
 apply-sample-cluster:
-	$(eval METAL_NODE_NETWORK_ID = $(shell metalctl network list --name metal-test -o template --template '{{ .id }}'))
-	$(eval CONTROL_PLANE_IP = $(shell metalctl network ip list --name "$(CLUSTER_NAME)-vip" -o template --template '{{ .id }}'))
-	clusterctl generate cluster metal-test \
+	$(eval METAL_NODE_NETWORK_ID = $(shell metalctl network list --name $(CLUSTER_NAME) -o template --template '{{ .id }}'))
+	$(eval CONTROL_PLANE_IP = $(shell metalctl network ip list --name "$(CLUSTER_NAME)-vip" -o template --template '{{ .ipaddress }}'))
+	echo  $(CLUSTER_NAME)
+	clusterctl generate cluster $(CLUSTER_NAME) \
 		--kubeconfig=$(KUBECONFIG) \
 		--worker-machine-count 1 \
 		--control-plane-machine-count 1 \
-		--kubernetes-version 1.30.6 \
+		--kubernetes-version $(KUBERNETES_VERSION) \
 		--from ../config/clusterctl-templates/cluster-template.yaml \
 		| kubectl --kubeconfig=$(KUBECONFIG) apply -f -
 
 .PHONY: delete-sample-cluster
 delete-sample-cluster:
-	$(eval METAL_NODE_NETWORK_ID = $(shell metalctl network list --name metal-test -o template --template '{{ .id }}'))
-	$(eval CONTROL_PLANE_IP = $(shell metalctl network ip list --name "$(CLUSTER_NAME)-vip" -o template --template '{{ .id }}'))
-	clusterctl generate cluster metal-test \
+	$(eval METAL_NODE_NETWORK_ID = $(shell metalctl network list --name $(CLUSTER_NAME) -o template --template '{{ .id }}'))
+	$(eval CONTROL_PLANE_IP = $(shell metalctl network ip list --name "$(CLUSTER_NAME)-vip" -o template --template '{{ .ipaddress }}'))
+	clusterctl generate cluster $(CLUSTER_NAME) \
 		--kubeconfig=$(KUBECONFIG) \
 		--worker-machine-count 1 \
 		--control-plane-machine-count 1 \
-		--kubernetes-version 1.30.6 \
+		--kubernetes-version $(KUBERNETES_VERSION) \
 		--from ../config/clusterctl-templates/cluster-template.yaml \
 		| kubectl --kubeconfig=$(KUBECONFIG) delete -f -
 
@@ -95,7 +99,7 @@ mtu-fix:
 
 .PHONY: deploy-metal-ccm
 deploy-metal-ccm:
-	$(eval METAL_CLUSTER_ID = $(shell kubectl get metalstackclusters.infrastructure.cluster.x-k8s.io metal-test -ojsonpath='{.metadata.uid}'))
-	$(eval METAL_NODE_NETWORK_ID = $(shell metalctl network list --name metal-test -o template --template '{{ .id }}'))
+	$(eval NAMESPACE = $(shell kubectl get metalstackclusters.infrastructure.cluster.x-k8s.io $(CLUSTER_NAME) -ojsonpath='{.metadata.namespace}'))
+	$(eval METAL_NODE_NETWORK_ID = $(shell metalctl network list --name $(CLUSTER_NAME) -o template --template '{{ .id }}'))
 	$(eval CONTROL_PLANE_IP = $(shell metalctl network ip list --name "$(CLUSTER_NAME)-vip" -o template --template '{{ .id }}'))
 	cat metal-ccm.yaml | envsubst | kubectl --kubeconfig=.capms-cluster-kubeconfig.yaml apply -f -

capi-lab/metal-ccm.yaml

@@ -184,14 +184,14 @@ spec:
           value: mini-lab
         # associates service type load balancer ips with this cluster:
         - name: METAL_CLUSTER_ID
-          value: ${METAL_CLUSTER_ID}
+          value: ${NAMESPACE}.${CLUSTER_NAME}
         - name: METAL_DEFAULT_EXTERNAL_NETWORK_ID
           value: internet-mini-lab
         - name: METAL_ADDITIONAL_NETWORKS
           value: internet-mini-lab,${METAL_NODE_NETWORK_ID}
         - name: METAL_SSH_PUBLICKEY
           value: ""
-        image: ghcr.io/metal-stack/metal-ccm:v0.9.4
+        image: ghcr.io/metal-stack/metal-ccm:v0.9.7
         imagePullPolicy: IfNotPresent
         livenessProbe:
           failureThreshold: 2

config/target-cluster/metal-ccm.yaml

@@ -184,14 +184,14 @@ spec:
               value: ${METAL_PARTITION}
             # associates service type load balancer ips with this cluster:
             - name: METAL_CLUSTER_ID
-              value: ${NAMESPACE}/${CLUSTER_NAME}
+              value: ${NAMESPACE}.${CLUSTER_NAME}
             - name: METAL_DEFAULT_EXTERNAL_NETWORK_ID
               value: internet
             - name: METAL_ADDITIONAL_NETWORKS
               value: internet,${METAL_NODE_NETWORK_ID}
             - name: METAL_SSH_PUBLICKEY
               value: ""
-          image: ghcr.io/metal-stack/metal-ccm:v0.9.4
+          image: ghcr.io/metal-stack/metal-ccm:v0.9.7
           imagePullPolicy: IfNotPresent
           livenessProbe:
             failureThreshold: 2

internal/controller/metalstackcluster_controller.go

@@ -337,7 +337,7 @@ func (r *clusterReconciler) ensureControlPlaneIP() (string, error) {
 
 	defaultNetwork := nwResp.Payload[0]
 	resp, err := r.metalClient.IP().AllocateIP(ipmodels.NewAllocateIPParams().WithBody(&models.V1IPAllocateRequest{
-		Description: fmt.Sprintf("%s/%s control plane ip", r.infraCluster.GetNamespace(), r.infraCluster.GetName()),
+		Description: fmt.Sprintf("%s control plane ip", r.infraCluster.GetClusterID()),
 		Name:        r.infraCluster.GetName() + "-control-plane",
 		Networkid:   defaultNetwork.ID,
 		Projectid:   &r.infraCluster.Spec.ProjectID,

internal/controller/metalstackcluster_controller_test.go

@@ -275,7 +275,7 @@ var _ = Describe("MetalStackCluster Controller", func() {
 							"metal-stack.infrastructure.cluster.x-k8s.io/purpose=control-plane",
 						},
 						Name:        resource.Name + "-control-plane",
-						Description: resource.Namespace + "/" + resource.Name + " control plane ip",
+						Description: resource.GetClusterID() + " control plane ip",
 						Networkid:   ptr.To("internet"),
 						Projectid:   ptr.To("test-project"),
 						Type:        ptr.To("ephemeral"),