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_controller.go

@@ -417,16 +417,25 @@ func ensureCertificates(ctx context.Context, cluster *clusterv1.Cluster, kcp *cp
 }
 
 // FormatStatusVersion formats the status version to match the spec version format.
-// If spec.version doesn't contain "-k0s." suffix, it removes the suffix from status.version as well.
+// If spec.version doesn't contain "-k0s." or "+k0s." suffix, it removes the suffix from status.version as well.
+// TODO: Remove support for "-k0s." suffix in future versions.
 func FormatStatusVersion(specVersion, statusVersion string) string {
-	specHasK0sSuffix := strings.Contains(specVersion, "-k0s.")
-
-	// Adjust status.version to match the format of spec.version
-	if !specHasK0sSuffix && strings.Contains(statusVersion, "-k0s.") {
-		// If spec.version doesn't have the -k0s. suffix, remove it from status.version as well
-		parts := strings.Split(statusVersion, "-k0s.")
-		if len(parts) > 0 {
-			return parts[0]
+	specHasK0sSuffix := strings.Contains(specVersion, "-k0s.") || strings.Contains(specVersion, "+k0s.")
+
+	if !specHasK0sSuffix {
+		if strings.Contains(statusVersion, "-k0s.") {
+			// If spec.version doesn't have the -k0s. suffix, remove it from status.version as well
+			parts := strings.Split(statusVersion, "-k0s.")
+			if len(parts) > 0 {
+				return parts[0]
+			}
+		}
+		if strings.Contains(statusVersion, "+k0s.") {
+			// If spec.version doesn't have the +k0s. suffix, remove it from status.version as well
+			parts := strings.Split(statusVersion, "+k0s.")
+			if len(parts) > 0 {
+				return parts[0]
+			}
 		}
 	}
 
@@ -462,8 +471,8 @@ func (c *K0smotronController) computeStatus(ctx context.Context, cluster *cluste
 	var updatedReplicas, readyReplicas, unavailableReplicas int
 
 	desiredVersionStr := kcp.Spec.Version
-	if !strings.Contains(desiredVersionStr, "-") {
-		desiredVersionStr = fmt.Sprintf("%s-%s", desiredVersionStr, kapi.DefaultK0SSuffix)
+	if !strings.Contains(desiredVersionStr, "-") && !strings.Contains(desiredVersionStr, "+") {
+		desiredVersionStr = fmt.Sprintf("%s+%s", desiredVersionStr, kapi.DefaultK0SSuffix)
 	}
 	desiredVersion, err := version.NewVersion(desiredVersionStr)
 	if err != nil {
@@ -488,7 +497,12 @@ func (c *K0smotronController) computeStatus(ctx context.Context, cluster *cluste
 			continue
 		}
 
-		currentVersion, err := scope.getComparableK0sVersionRunningInPod(ctx, &pod)
+		currentVersion, err := scope.getK0sVersionRunningInPod(ctx, &pod)
+		if err != nil {
+			return err
+		}
+		// Align version format in spec to the current version format for comparison. DO NOT modify version format in spec.
+		currentVersion, err = alignToSpecVersionFormat(desiredVersion, currentVersion)
 		if err != nil {
 			return err
 		}
@@ -527,6 +541,32 @@ func (c *K0smotronController) computeStatus(ctx context.Context, cluster *cluste
 	return nil
 }
 
+// alignToSpecVersionFormat ensures that the currentVersion format matches the desiredVersion format.
+// TODO: Once the "-k0s." suffix is fully deprecated, this function can be removed.
+func alignToSpecVersionFormat(specVersion, currentVersion *version.Version) (*version.Version, error) {
+	specVersionUsesDefaultK0SSuffix := strings.Contains(specVersion.String(), "+")
+	currentVersionUsesDefaultK0SSuffix := strings.Contains(currentVersion.String(), "+")
+
+	isFormatAligned := (specVersionUsesDefaultK0SSuffix && currentVersionUsesDefaultK0SSuffix) ||
+		(!specVersionUsesDefaultK0SSuffix && !currentVersionUsesDefaultK0SSuffix)
+
+	if isFormatAligned {
+		return currentVersion, nil
+	}
+
+	currentVersionStr := currentVersion.String()
+	if !specVersionUsesDefaultK0SSuffix {
+		// Spec version format is like "vX.Y.Z-k0s.0". Convert currentVersion to match it.
+		currentVersionAlignedStr := strings.Replace(currentVersionStr, "+k0s.", "-k0s.", 1)
+		return version.NewVersion(currentVersionAlignedStr)
+	}
+
+	// Current version format is like "vX.Y.Z-k0s.0". Convert currentVersion to match it.
+	currentVersionAlignedStr := strings.Replace(currentVersionStr, "-k0s.", "+k0s.", 1)
+	return version.NewVersion(currentVersionAlignedStr)
+
+}
+
 // computeAvailability checks if the control plane is ready by connecting to the API server
 // and checking if the control plane is initialized
 func (c *K0smotronController) computeAvailability(ctx context.Context, cluster *clusterv1.Cluster, kcp *cpv1beta1.K0smotronControlPlane) {
@@ -574,16 +614,12 @@ func (c *K0smotronController) computeAvailability(ctx context.Context, cluster *
 	})
 }
 
-func (scope *kmcScope) getComparableK0sVersionRunningInPod(ctx context.Context, pod *corev1.Pod) (*version.Version, error) {
+func (scope *kmcScope) getK0sVersionRunningInPod(ctx context.Context, pod *corev1.Pod) (*version.Version, error) {
 	currentVersionOutput, err := exec.PodExecCmdOutput(ctx, scope.clientSet, scope.restConfig, pod.GetName(), pod.GetNamespace(), "k0s version")
 	if err != nil {
 		return nil, err
 	}
 	currentVersionStr, _ := strings.CutSuffix(currentVersionOutput, "\n")
-	// In order to compare the version reported by the 'k0s version' command executed in the pod running
-	// the controlplane with the version declared in K0smotronControlPlane.spec this transformation is
-	// necessary to match their format.
-	currentVersionStr = strings.Replace(currentVersionStr, "+", "-", 1)
 	return version.NewVersion(currentVersionStr)
 }
 

internal/controller/controlplane/k0smotron_controlplane_controller_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	kapi "github.com/k0sproject/k0smotron/api/k0smotron.io/v1beta1"
+	"github.com/k0sproject/version"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -247,3 +248,38 @@ func TestIsClusterSpecSynced(t *testing.T) {
 		})
 	}
 }
+
+func Test_alignToSpecVersionFormat(t *testing.T) {
+	tests := []struct {
+		name           string
+		specVersion    *version.Version
+		currentVersion *version.Version
+		want           *version.Version
+	}{
+		{
+			name:           "both versions have same format",
+			specVersion:    version.MustParse("v1.33.1-k0s.0"),
+			currentVersion: version.MustParse("v1.33.1-k0s.1"),
+			want:           version.MustParse("v1.33.1-k0s.1"),
+		},
+		{
+			name:           "versions does not have same format: spec with +k0s, current with -k0s",
+			specVersion:    version.MustParse("v1.33.1+k0s.0"),
+			currentVersion: version.MustParse("v1.33.1-k0s.1"),
+			want:           version.MustParse("v1.33.1+k0s.1"),
+		},
+		{
+			name:           "versions does not have same format: spec with -k0s, current with +k0s",
+			specVersion:    version.MustParse("v1.33.1-k0s.0"),
+			currentVersion: version.MustParse("v1.33.1+k0s.1"),
+			want:           version.MustParse("v1.33.1-k0s.1"),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := alignToSpecVersionFormat(tt.specVersion, tt.currentVersion)
+			require.NoError(t, err)
+			require.True(t, tt.want.Equal(got), "alignToSpecVersionFormat() = %v, want %v", got, tt.want)
+		})
+	}
+}

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",