✨ Update controller runtime and cluster-api to the newest version (CAPI 1.10) (#1628)

Author: guettli

.github/actions/e2e/action.yaml

@@ -43,9 +43,9 @@ runs:
     - name: Install hcloud
       shell: bash
       env:
-        hcloudctl_version: 1.40.0
+        hcloudctl_version: v1.52.0
       run: |
-        curl -fsSL https://github.com/hetznercloud/cli/releases/download/v${{ env.hcloudctl_version }}/hcloud-linux-amd64.tar.gz | tar -xzv hcloud
+        curl -fsSL https://github.com/hetznercloud/cli/releases/download/${{ env.hcloudctl_version }}/hcloud-linux-amd64.tar.gz | tar -xzv hcloud
         mkdir -p hack/tools/bin/
         mv hcloud hack/tools/bin/hcloud
 

.golangci.yaml

@@ -83,8 +83,6 @@ linters-settings:
         alias: bootstrapv1
       - pkg: sigs.k8s.io/controller-runtime/pkg/metrics/server
         alias: metricsserver
-      - pkg: sigs.k8s.io/cluster-api/errors
-        alias: capierrors
       - pkg: sigs.k8s.io/controller-runtime/pkg/client/fake
         alias: fakeclient
   nolintlint:

.mockery.yaml

@@ -0,0 +1,18 @@
+# This config was choosen, so that the output matches to old structure (pre config file .mockery.yaml).
+# If you are here to copy this config to a new project, then it might
+# make sense to choose a structure which needs less config by using
+# the default values of Mockery.
+all: True
+filename: "{{.InterfaceName}}.go"
+mockname: "{{.InterfaceName}}"
+outpkg: mocks
+packages:
+  github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/ssh:
+    config:
+      dir: "{{.InterfaceDir}}/../mocks/ssh"
+  github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/robot:
+    config:
+      dir: "{{.InterfaceDir}}/../mocks/robot"
+  github.com/syself/cluster-api-provider-hetzner/pkg/services/hcloud/client:
+    config:
+      dir: "{{.InterfaceDir}}/mocks"

Makefile

@@ -174,7 +174,7 @@ install-essentials: ## This gets the secret and installs a CNI and the CCM. Usag
 	$(MAKE) install-cilium-in-wl-cluster
 	$(MAKE) install-ccm-in-wl-cluster
 
-wait-and-get-secret:
+wait-and-get-secret: $(KUBECTL)
 	./hack/ensure-env-variables.sh CLUSTER_NAME
 	# Wait for the kubeconfig to become available.
 	rm -f $(WORKER_CLUSTER_KUBECONFIG)
@@ -201,7 +201,7 @@ ifeq ($(BUILD_IN_CONTAINER),true)
 else
 	helm repo add syself https://charts.syself.com
 	helm repo update syself
-	KUBECONFIG=$(WORKER_CLUSTER_KUBECONFIG) helm upgrade --install ccm syself/ccm-hetzner --version 1.1.10 \
+	KUBECONFIG=$(WORKER_CLUSTER_KUBECONFIG) helm upgrade --install ccm syself/ccm-hetzner --version 2.0.1 \
 	--namespace kube-system \
 	--set privateNetwork.enabled=$(PRIVATE_NETWORK)
 	@echo 'run "kubectl --kubeconfig=$(WORKER_CLUSTER_KUBECONFIG) ..." to work with the new target cluster'
@@ -241,6 +241,7 @@ create-workload-cluster-hcloud-network: env-vars-for-wl-cluster $(KUSTOMIZE) $(E
 	$(MAKE) install-cilium-in-wl-cluster
 	$(MAKE) install-ccm-in-wl-cluster PRIVATE_NETWORK=true
 
+# Use that, if you want to test hcloud control-planes, hcloud worker and bm worker.
 create-workload-cluster-hetzner-hcloud-control-plane: env-vars-for-wl-cluster $(KUSTOMIZE) $(ENVSUBST) ## Creates a workload-cluster.
 	# Create workload Cluster.
 	./hack/ensure-env-variables.sh HCLOUD_TOKEN HETZNER_ROBOT_USER HETZNER_ROBOT_PASSWORD HETZNER_SSH_PRIV_PATH HETZNER_SSH_PUB_PATH SSH_KEY_NAME
@@ -782,8 +783,7 @@ ifeq ($(BUILD_IN_CONTAINER),true)
 		-v $(shell pwd):/src/cluster-api-provider-$(INFRA_PROVIDER)$(MOUNT_FLAGS) \
 		$(BUILDER_IMAGE):$(BUILDER_IMAGE_VERSION) $@;
 else
-	cd pkg/services/baremetal/client; go run github.com/vektra/mockery/[email protected]
-	cd pkg/services/hcloud/client; go run github.com/vektra/mockery/[email protected] --all
+	go run github.com/vektra/mockery/[email protected]
 endif
 
 .PHONY: generate

api/v1beta1/hcloudmachine_types.go

@@ -20,7 +20,7 @@ import (
 	"github.com/hetznercloud/hcloud-go/v2/hcloud"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
-	capierrors "sigs.k8s.io/cluster-api/errors"
+	capierrors "sigs.k8s.io/cluster-api/errors" //nolint:staticcheck // we will handle that, when we update to capi v1.11
 )
 
 const (

api/v1beta1/hcloudmachine_webhook.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1beta1
 
 import (
+	"context"
 	"fmt"
 
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -29,13 +30,18 @@ import (
 	"github.com/syself/cluster-api-provider-hetzner/pkg/utils"
 )
 
+type hcloudMachineWebhook struct{}
+
 // log is for logging in this package.
 var hcloudmachinelog = utils.GetDefaultLogger("info").WithName("hcloudmachine-resource")
 
 // SetupWebhookWithManager initializes webhook manager for HCloudMachine.
 func (r *HCloudMachine) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	w := new(hcloudMachineWebhook)
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
+		WithDefaulter(w).
+		WithValidator(w).
 		Complete()
 }
 
@@ -48,46 +54,59 @@ func (r *HCloudMachineList) SetupWebhookWithManager(mgr ctrl.Manager) error {
 
 //+kubebuilder:webhook:path=/mutate-infrastructure-cluster-x-k8s-io-v1beta1-hcloudmachine,mutating=true,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=hcloudmachines,verbs=create;update,versions=v1beta1,name=mutation.hcloudmachine.infrastructure.cluster.x-k8s.io,admissionReviewVersions={v1,v1beta1}
 
-var _ webhook.Defaulter = &HCloudMachine{}
+var _ webhook.CustomDefaulter = &hcloudMachineWebhook{}
 
-// Default implements webhook.Defaulter so a webhook will be registered for the type.
-func (r *HCloudMachine) Default() {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type.
+func (*hcloudMachineWebhook) Default(_ context.Context, obj runtime.Object) error {
+	r, ok := obj.(*HCloudMachine)
+	if !ok {
+		return fmt.Errorf("expected an HCloudMachine object but got %T", r)
+	}
 	if r.Spec.PublicNetwork == nil {
 		r.Spec.PublicNetwork = &PublicNetworkSpec{
 			EnableIPv4: true,
 			EnableIPv6: true,
 		}
 	}
+	return nil
 }
 
 //+kubebuilder:webhook:path=/validate-infrastructure-cluster-x-k8s-io-v1beta1-hcloudmachine,mutating=false,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=hcloudmachines,verbs=create;update,versions=v1beta1,name=validation.hcloudmachine.infrastructure.cluster.x-k8s.io,admissionReviewVersions={v1,v1beta1}
 
-var _ webhook.Validator = &HCloudMachine{}
+var _ webhook.CustomValidator = &hcloudMachineWebhook{}
+
+// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudMachineWebhook) ValidateCreate(_ context.Context, obj runtime.Object) (admission.Warnings, error) {
+	r, ok := obj.(*HCloudMachine)
+	if !ok {
+		return nil, fmt.Errorf("expected an HCloudMachine object but got %T", r)
+	}
 
-// ValidateCreate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudMachine) ValidateCreate() (admission.Warnings, error) {
 	hcloudmachinelog.V(1).Info("validate create", "name", r.Name)
 	var allErrs field.ErrorList
 
 	return nil, aggregateObjErrors(r.GroupVersionKind().GroupKind(), r.Name, allErrs)
 }
 
-// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudMachine) ValidateUpdate(old runtime.Object) (admission.Warnings, error) {
+// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudMachineWebhook) ValidateUpdate(_ context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) {
+	r, ok := newObj.(*HCloudMachine)
+	if !ok {
+		return nil, fmt.Errorf("expected an HCloudMachine object but got %T", r)
+	}
 	hcloudmachinelog.V(1).Info("validate update", "name", r.Name)
 
-	oldM, ok := old.(*HCloudMachine)
+	oldM, ok := oldObj.(*HCloudMachine)
 	if !ok {
-		return nil, apierrors.NewBadRequest(fmt.Sprintf("expected an HCloudMachine but got a %T", old))
+		return nil, apierrors.NewBadRequest(fmt.Sprintf("expected an HCloudMachine but got a %T", oldObj))
 	}
 
 	allErrs := validateHCloudMachineSpecUpdate(oldM.Spec, r.Spec)
 
 	return nil, aggregateObjErrors(r.GroupVersionKind().GroupKind(), r.Name, allErrs)
 }
 
-// ValidateDelete implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudMachine) ValidateDelete() (admission.Warnings, error) {
-	hcloudmachinelog.V(1).Info("validate delete", "name", r.Name)
+// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
+func (r *hcloudMachineWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }

api/v1beta1/hcloudmachinetemplate_webhook.go

@@ -30,29 +30,39 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
 )
 
-// SetupWebhookWithManager initializes webhook manager for HetznerMachineTemplate.
-func (r *HCloudMachineTemplateWebhook) SetupWebhookWithManager(mgr ctrl.Manager) error {
+// SetupWebhookWithManager initializes webhook manager for HCloudMachineTemplate.
+func (r *HCloudMachineTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	w := new(hcloudMachineTemplateWebhook)
 	return ctrl.NewWebhookManagedBy(mgr).
-		For(&HCloudMachineTemplate{}).
-		WithValidator(r).
+		For(r).
+		WithValidator(w).
+		WithDefaulter(w).
 		Complete()
 }
 
 // HCloudMachineTemplateWebhook implements a custom validation webhook for HCloudMachineTemplate.
 // +kubebuilder:object:generate=false
-type HCloudMachineTemplateWebhook struct{}
+type hcloudMachineTemplateWebhook struct{}
+
+// Default implements admission.CustomDefaulter.
+func (*hcloudMachineTemplateWebhook) Default(_ context.Context, _ runtime.Object) error {
+	return nil
+}
 
 // +kubebuilder:webhook:path=/validate-infrastructure-cluster-x-k8s-io-v1beta1-hcloudmachinetemplate,mutating=false,sideEffects=None,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=hcloudmachinetemplates,verbs=create;update,versions=v1beta1,name=validation.hcloudmachinetemplate.infrastructure.x-k8s.io,admissionReviewVersions=v1;v1beta1
 
-var _ webhook.CustomValidator = &HCloudMachineTemplateWebhook{}
+var (
+	_ webhook.CustomValidator = &hcloudMachineTemplateWebhook{}
+	_ webhook.CustomDefaulter = &hcloudMachineTemplateWebhook{}
+)
 
-// ValidateCreate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudMachineTemplateWebhook) ValidateCreate(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
+// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudMachineTemplateWebhook) ValidateCreate(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }
 
-// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldRaw runtime.Object, newRaw runtime.Object) (admission.Warnings, error) {
+// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldRaw runtime.Object, newRaw runtime.Object) (admission.Warnings, error) {
 	newHCloudMachineTemplate, ok := newRaw.(*HCloudMachineTemplate)
 	if !ok {
 		return nil, apierrors.NewBadRequest(fmt.Sprintf("expected a HCloudMachineTemplate but got a %T", newRaw))
@@ -74,7 +84,7 @@ func (r *HCloudMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldRa
 	return nil, aggregateObjErrors(newHCloudMachineTemplate.GroupVersionKind().GroupKind(), newHCloudMachineTemplate.Name, allErrs)
 }
 
-// ValidateDelete implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudMachineTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
+// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudMachineTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }

api/v1beta1/hcloudremediation_webhook.go

@@ -17,42 +17,50 @@ limitations under the License.
 package v1beta1
 
 import (
+	"context"
+
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
 )
 
+type hcloudRemediationWebhook struct{}
+
 // SetupWebhookWithManager initializes webhook manager for HCloudRemediation.
 func (r *HCloudRemediation) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	w := new(hcloudRemediationWebhook)
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
+		WithValidator(w).
+		WithDefaulter(w).
 		Complete()
 }
 
 //+kubebuilder:webhook:path=/mutate-infrastructure-cluster-x-k8s-io-v1beta1-hcloudremediation,mutating=true,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=hcloudremediations,verbs=create;update,versions=v1beta1,name=mutation.hcloudremediation.infrastructure.cluster.x-k8s.io,admissionReviewVersions={v1,v1beta1}
 
-var _ webhook.Defaulter = &HCloudRemediation{}
+var _ webhook.CustomDefaulter = &hcloudRemediationWebhook{}
 
-// Default implements webhook.Defaulter so a webhook will be registered for the type.
-func (r *HCloudRemediation) Default() {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type.
+func (*hcloudRemediationWebhook) Default(_ context.Context, _ runtime.Object) error {
+	return nil
 }
 
 //+kubebuilder:webhook:path=/validate-infrastructure-cluster-x-k8s-io-v1beta1-hcloudremediation,mutating=false,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=hcloudremediations,verbs=create;update,versions=v1beta1,name=validation.hcloudremediation.infrastructure.cluster.x-k8s.io,admissionReviewVersions={v1,v1beta1}
 
-var _ webhook.Validator = &HCloudRemediation{}
+var _ webhook.CustomValidator = &hcloudRemediationWebhook{}
 
-// ValidateCreate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudRemediation) ValidateCreate() (admission.Warnings, error) {
+// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudRemediationWebhook) ValidateCreate(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }
 
-// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudRemediation) ValidateUpdate(runtime.Object) (admission.Warnings, error) {
+// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudRemediationWebhook) ValidateUpdate(_ context.Context, _ runtime.Object, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }
 
-// ValidateDelete implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudRemediation) ValidateDelete() (admission.Warnings, error) {
+// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudRemediationWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }

api/v1beta1/hcloudremediationtemplate_webhook.go

@@ -17,42 +17,50 @@ limitations under the License.
 package v1beta1
 
 import (
+	"context"
+
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
 )
 
+type hcloudRemediationTemplateWebhook struct{}
+
 // SetupWebhookWithManager initializes webhook manager for HCloudRemediationTemplate.
 func (r *HCloudRemediationTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	w := new(hcloudRemediationTemplateWebhook)
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
+		WithValidator(w).
+		WithDefaulter(w).
 		Complete()
 }
 
 //+kubebuilder:webhook:path=/mutate-infrastructure-cluster-x-k8s-io-v1beta1-hcloudremediationtemplate,mutating=true,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=hcloudremediationtemplates,verbs=create;update,versions=v1beta1,name=mhcloudremediationtemplate.kb.io,admissionReviewVersions=v1
 
-var _ webhook.Defaulter = &HCloudRemediationTemplate{}
+var _ webhook.CustomDefaulter = &hcloudRemediationTemplateWebhook{}
 
-// Default implements webhook.Defaulter so a webhook will be registered for the type.
-func (r *HCloudRemediationTemplate) Default() {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type.
+func (*hcloudRemediationTemplateWebhook) Default(_ context.Context, _ runtime.Object) error {
+	return nil
 }
 
 //+kubebuilder:webhook:path=/validate-infrastructure-cluster-x-k8s-io-v1beta1-hcloudremediationtemplate,mutating=false,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=hcloudremediationtemplates,verbs=create;update,versions=v1beta1,name=vhcloudremediationtemplate.kb.io,admissionReviewVersions=v1
 
-var _ webhook.Validator = &HCloudRemediationTemplate{}
+var _ webhook.CustomValidator = &hcloudRemediationTemplateWebhook{}
 
-// ValidateCreate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudRemediationTemplate) ValidateCreate() (admission.Warnings, error) {
+// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudRemediationTemplateWebhook) ValidateCreate(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }
 
-// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudRemediationTemplate) ValidateUpdate(runtime.Object) (admission.Warnings, error) {
+// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudRemediationTemplateWebhook) ValidateUpdate(_ context.Context, _ runtime.Object, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }
 
-// ValidateDelete implements webhook.Validator so a webhook will be registered for the type.
-func (r *HCloudRemediationTemplate) ValidateDelete() (admission.Warnings, error) {
+// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
+func (*hcloudRemediationTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
 	return nil, nil
 }