Unify k0s version format

Signed-off-by: apedriza <[email protected]>

Author: apedriza

api/k0smotron.io/v1beta1/k0smotroncluster_types.go

@@ -19,9 +19,10 @@ package v1beta1
 import (
 	"crypto/md5"
 	"fmt"
+	"strings"
+
 	"github.com/k0sproject/version"
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
-	"strings"
 
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -174,27 +175,34 @@ type Mount struct {
 }
 
 const (
-	defaultK0SImage   = "quay.io/k0sproject/k0s"
-	DefaultK0SVersion = "v1.27.9-k0s.0"
-	DefaultK0SSuffix  = "k0s.0"
-	DefaultEtcdImage  = "quay.io/k0sproject/etcd:v3.5.13"
+	defaultK0SRepository = "quay.io/k0sproject/k0s"
+	// DefaultK0SVersion is the default version used (kubernetes version + k0s version).
+	DefaultK0SVersion = "v1.27.9+k0s.0"
+	// DefaultK0SSuffix is the default k0s version used.
+	DefaultK0SSuffix = "k0s.0"
+	// DefaultEtcdImage is the default etcd image reference used.
+	DefaultEtcdImage = "quay.io/k0sproject/etcd:v3.5.13"
 )
 
-func (c *ClusterSpec) GetImage() string {
-	k0sVersion := c.Version
-	if k0sVersion == "" {
-		k0sVersion = DefaultK0SVersion
+// GetK0sImageRef returns the k0s image reference.
+func (c *ClusterSpec) GetK0sImageRef() string {
+	k0sTag := c.Version
+	if k0sTag == "" {
+		k0sTag = DefaultK0SVersion
 	}
 
-	if !strings.Contains(k0sVersion, "-k0s.") {
-		k0sVersion = fmt.Sprintf("%s-%s", k0sVersion, DefaultK0SSuffix)
+	if !strings.Contains(k0sTag, "+k0s.") {
+		k0sTag = fmt.Sprintf("%s+%s", k0sTag, DefaultK0SSuffix)
 	}
 
+	k0sImageRef := fmt.Sprintf("%s:%s", c.Image, k0sTag)
 	if c.Image == "" {
-		return fmt.Sprintf("%s:%s", defaultK0SImage, k0sVersion)
+		k0sImageRef = fmt.Sprintf("%s:%s", defaultK0SRepository, k0sTag)
 	}
 
-	return fmt.Sprintf("%s:%s", c.Image, k0sVersion)
+	// Mutate image reference to avoid "+" character in the k0s version tag which is not allowed in some
+	// registries like Docker Hub (https://github.com/distribution/reference/blob/main/reference.go)
+	return strings.ReplaceAll(k0sImageRef, "+k0s.", "-k0s.")
 }
 
 // ClusterStatus defines the observed state of K0smotronCluster

api/k0smotron.io/v1beta1/k0smotroncluster_types_test.go

@@ -37,7 +37,7 @@ func TestClusterSpec_GetImage(t *testing.T) {
 		{
 			name: "Only version given with suffix",
 			spec: &ClusterSpec{
-				Version: "v1.29.4-k0s.0",
+				Version: "v1.29.4+k0s.0",
 			},
 			want: "quay.io/k0sproject/k0s:v1.29.4-k0s.0",
 		},
@@ -66,7 +66,7 @@ func TestClusterSpec_GetImage(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := tt.spec.GetImage(); got != tt.want {
+			if got := tt.spec.GetK0sImageRef(); got != tt.want {
 				require.Equal(t, tt.want, got)
 			}
 		})

cmd/main.go

@@ -327,7 +327,7 @@ func main() {
 				os.Exit(1)
 			}
 
-			if err = (&controlplane.K0smotronControlPlaneValidator{}).SetupK0smotronControlPlaneWebhookWithManager(mgr); err != nil {
+			if err = controlplane.SetupK0smotronControlPlaneWebhookWithManager(mgr); err != nil {
 				setupLog.Error(err, "unable to create validation webhook", "webhook", "K0smotronControlPlaneValidator")
 				os.Exit(1)
 			}

config/webhook/manifests.yaml

@@ -24,6 +24,26 @@ webhooks:
     resources:
     - clusters
   sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: webhook-service
+      namespace: system
+      path: /mutate-controlplane-cluster-x-k8s-io-v1beta1-k0smotroncontrolplane
+  failurePolicy: Fail
+  name: mutate-k0smotroncontrolplane-v1beta1.k0smotron.io
+  rules:
+  - apiGroups:
+    - controlplane.cluster.x-k8s.io
+    apiVersions:
+    - v1beta1
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - k0smotroncontrolplanes
+  sideEffects: None
 ---
 apiVersion: admissionregistration.k8s.io/v1
 kind: ValidatingWebhookConfiguration

internal/controller/controlplane/k0smotron_controlplane_webhook.go

@@ -19,6 +19,7 @@ package controlplane
 import (
 	"context"
 	"fmt"
+
 	k0smotronio "github.com/k0sproject/k0smotron/internal/controller/k0smotron.io"
 	"github.com/k0sproject/version"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -30,6 +31,7 @@ import (
 )
 
 // +kubebuilder:webhook:path=/validate-controlplane-cluster-x-k8s-io-v1beta1-k0smotroncontrolplane,mutating=false,failurePolicy=fail,sideEffects=None,groups=controlplane.cluster.x-k8s.io,resources=k0smotroncontrolplanes,verbs=create;update,versions=v1beta1,name=validate-k0smotroncontrolplane-v1beta1.k0smotron.io,admissionReviewVersions=v1
+// +kubebuilder:webhook:path=/mutate-controlplane-cluster-x-k8s-io-v1beta1-k0smotroncontrolplane,mutating=true,failurePolicy=fail,sideEffects=None,groups=controlplane.cluster.x-k8s.io,resources=k0smotroncontrolplanes,verbs=create;update,versions=v1beta1,name=mutate-k0smotroncontrolplane-v1beta1.k0smotron.io,admissionReviewVersions=v1
 
 // K0smotronControlPlaneValidator struct is responsible for validating the K0smotronControlPlane resource when it is created, updated, or deleted.
 //
@@ -39,7 +41,25 @@ type K0smotronControlPlaneValidator struct {
 	cv k0smotronio.ClusterValidator
 }
 
+// K0smotronControlPlaneDefaulter struct is responsible for defaulting the K0smotronControlPlane resource when it is created or updated.
+//
+// NOTE: The +kubebuilder:object:generate=false marker prevents controller-gen from generating DeepCopy methods,
+// as this struct is used only for temporary operations and does not need to be deeply copied.
+type K0smotronControlPlaneDefaulter struct {
+	cv k0smotronio.ClusterDefaulter
+}
+
 var _ webhook.CustomValidator = &K0smotronControlPlaneValidator{}
+var _ webhook.CustomDefaulter = &K0smotronControlPlaneDefaulter{}
+
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type K0smotronControlPlane.
+func (d *K0smotronControlPlaneDefaulter) Default(_ context.Context, obj runtime.Object) error {
+	kcp, ok := obj.(*v1beta1.K0smotronControlPlane)
+	if !ok {
+		return fmt.Errorf("expected a K0smotronControlPlane object but got %T", obj)
+	}
+	return d.cv.DefaultClusterSpec(&kcp.Spec)
+}
 
 // ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type K0smotronControlPlane.
 func (v *K0smotronControlPlaneValidator) ValidateCreate(_ context.Context, obj runtime.Object) (admission.Warnings, error) {
@@ -108,9 +128,10 @@ func (v *K0smotronControlPlaneValidator) ValidateDelete(_ context.Context, _ run
 }
 
 // SetupK0smotronControlPlaneWebhookWithManager registers the webhook for K0smotronControlPlane in the manager.
-func (v *K0smotronControlPlaneValidator) SetupK0smotronControlPlaneWebhookWithManager(mgr ctrl.Manager) error {
+func SetupK0smotronControlPlaneWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(&v1beta1.K0smotronControlPlane{}).
-		WithValidator(v).
+		WithValidator(&K0smotronControlPlaneValidator{}).
+		WithDefaulter(&K0smotronControlPlaneDefaulter{}).
 		Complete()
 }

internal/controller/k0smotron.io/k0smotroncluster_etcd.go

@@ -406,7 +406,7 @@ func initialCluster(kmc *km.Cluster, replicas int32) string {
 }
 
 func generateEtcdInitContainers(kmc *km.Cluster, existingSts *apps.StatefulSet) []v1.Container {
-	checkImage := kmc.Spec.GetImage()
+	checkImage := kmc.Spec.GetK0sImageRef()
 	if existingSts != nil {
 		for _, c := range existingSts.Spec.Template.Spec.InitContainers {
 			if c.Name == "dns-check" {

internal/controller/k0smotron.io/k0smotroncluster_statefulset.go

@@ -118,7 +118,7 @@ func (scope *kmcScope) generateStatefulSet(kmc *km.Cluster) (apps.StatefulSet, e
 					}},
 					Containers: []v1.Container{{
 						Name:            "controller",
-						Image:           kmc.Spec.GetImage(),
+						Image:           kmc.Spec.GetK0sImageRef(),
 						ImagePullPolicy: v1.PullIfNotPresent,
 						Args:            []string{"/bin/sh", "-c", "/k0smotron-entrypoint.sh"},
 						Ports: []v1.ContainerPort{
@@ -442,7 +442,7 @@ func mountSecrets(kmc *km.Cluster, sfs *apps.StatefulSet) {
 	// Otherwise k0s will trip over the permissions and RO mounts
 	sfs.Spec.Template.Spec.InitContainers = append(sfs.Spec.Template.Spec.InitContainers, v1.Container{
 		Name:  "certs-init",
-		Image: kmc.Spec.GetImage(),
+		Image: kmc.Spec.GetK0sImageRef(),
 		Command: []string{
 			"sh",
 			"-c",

internal/controller/k0smotron.io/k0smotroncluster_webhook.go

@@ -56,8 +56,6 @@ func (c ClusterValidator) ValidateDelete(_ context.Context, _ runtime.Object) (w
 
 // ValidateClusterSpec validates the ClusterSpec and returns any warnings or errors.
 func (c ClusterValidator) ValidateClusterSpec(kcs *km.ClusterSpec) (warnings admission.Warnings, err error) {
-	warnings = c.validateVersionSuffix(kcs.Version)
-
 	if kcs.Ingress != nil {
 		warn, err := kcs.Ingress.Validate(kcs.Version)
 		warnings = append(warnings, warn...)
@@ -73,43 +71,43 @@ func (c ClusterValidator) ValidateClusterSpec(kcs *km.ClusterSpec) (warnings adm
 	return warnings, nil
 }
 
-// validateVersionSuffix checks if the version has a k0s suffix and returns a warning if it doesn't
-func (c ClusterValidator) validateVersionSuffix(version string) admission.Warnings {
-	warnings := admission.Warnings{}
-	if version != "" && !strings.Contains(version, "-k0s.") {
-		warnings = append(warnings, fmt.Sprintf("The specified version '%s' requires a k0s suffix (-k0s.<number>). Using '%s-k0s.0' instead.", version, version))
-	}
-
-	return warnings
-}
-
-func (c *ClusterDefaulter) Default(_ context.Context, obj runtime.Object) error {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type Cluster.
+func (c ClusterDefaulter) Default(_ context.Context, obj runtime.Object) error {
 	kmc, ok := obj.(*km.Cluster)
 	if !ok {
 		return fmt.Errorf("expected a Cluster object but got %T", obj)
 	}
 
-	if kmc.Spec.Replicas == 0 {
-		kmc.Spec.Replicas = 1
-	}
+	return c.DefaultClusterSpec(&kmc.Spec)
+}
 
-	if kmc.Spec.Version == "" {
-		kmc.Spec.Version = km.DefaultK0SVersion
+// DefaultClusterSpec sets default values for the ClusterSpec.
+func (c *ClusterDefaulter) DefaultClusterSpec(kmcSpec *km.ClusterSpec) error {
+	if kmcSpec.Replicas == 0 {
+		kmcSpec.Replicas = 1
 	}
 
-	if kmc.Spec.Service.Type == "" {
-		kmc.Spec.Service.Type = corev1.ServiceTypeClusterIP
-		kmc.Spec.Service.APIPort = 30443
-		kmc.Spec.Service.KonnectivityPort = 30132
+	if kmcSpec.Version == "" {
+		kmcSpec.Version = km.DefaultK0SVersion
+	}
+	// Ensure we store the version with +k0s. That way we can standardize the k0s version format.
+	// Needed sanitization will be done in runtime when building image references and not required
+	// by the user.
+	kmcSpec.Version = strings.ReplaceAll(kmcSpec.Version, "-k0s.", "+k0s.")
+
+	if kmcSpec.Service.Type == "" {
+		kmcSpec.Service.Type = corev1.ServiceTypeClusterIP
+		kmcSpec.Service.APIPort = 30443
+		kmcSpec.Service.KonnectivityPort = 30132
 	}
 
-	if kmc.Spec.Etcd.Image == "" {
-		kmc.Spec.Etcd.Image = km.DefaultEtcdImage
+	if kmcSpec.Etcd.Image == "" {
+		kmcSpec.Etcd.Image = km.DefaultEtcdImage
 	}
 
-	if kmc.Spec.Ingress != nil {
-		if kmc.Spec.Ingress.Deploy == nil {
-			kmc.Spec.Ingress.Deploy = ptr.To(true)
+	if kmcSpec.Ingress != nil {
+		if kmcSpec.Ingress.Deploy == nil {
+			kmcSpec.Ingress.Deploy = ptr.To(true)
 		}
 	}