Validate config apiVersion and kind

Signed-off-by: Kimmo Lehto <klehto@mirantis.com> Fix Signed-off-by: Kimmo Lehto <klehto@mirantis.com> Perform validation in Validate() Signed-off-by: Kimmo Lehto <klehto@mirantis.com>
k0sproject · Nov 25, 2021 · 7eb56a6 · 7eb56a6
1 parent 4fdd052
commit 7eb56a6
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 15 deletions.
diff --git a/docs/airgap-install.md b/docs/airgap-install.md
@@ -59,7 +59,7 @@ As an alternative to the previous step, you can use k0sctl to upload the bundle
 
 ```YAML
 apiVersion: k0sctl.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: k0s-cluster
 spec:
@@ -93,7 +93,7 @@ Use the following `k0s.yaml` to ensure that containerd does not pull images for
 
 ```yaml
 apiVersion: k0s.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: k0s
 spec:

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -34,7 +34,7 @@ A YAML config file follows, with defaults as generated by the `k0s default-confi
 
 ```yaml
 apiVersion: k0s.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: k0s
 spec:

diff --git a/docs/k0s-in-docker.md b/docs/k0s-in-docker.md
@@ -75,7 +75,7 @@ services:
     environment:
       K0S_CONFIG: |-
         apiVersion: k0s.k0sproject.io/v1beta1
-        kind: Cluster
+        kind: ClusterConfig
         metadata:
           name: k0s
         # Any additional configuration goes here ...

diff --git a/examples/footloose-ha-controllers/k0s.yaml b/examples/footloose-ha-controllers/k0s.yaml
@@ -1,5 +1,5 @@
 apiVersion: k0s.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: k0s-etcd
 spec:

diff --git a/examples/footloose-mysql/mke.yaml b/examples/footloose-mysql/mke.yaml
@@ -1,6 +1,6 @@
 
 apiVersion: k0s.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: foobar
 spec:
@@ -10,6 +10,6 @@ spec:
       dataSource: mysql://root:kine@tcp(172.17.0.4)/kine
   api:
     address: 172.17.0.2 # Address where the k8s API is accessed at (nodes public IP or LB)
-    
+
 
 
diff --git a/inttest/backup/backup_test.go b/inttest/backup/backup_test.go
@@ -32,7 +32,7 @@ import (
 
 const configWithExternaladdress = `
 apiVersion: k0s.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: k0s
 spec:

diff --git a/inttest/customports/customports_test.go b/inttest/customports/customports_test.go
@@ -36,7 +36,7 @@ type Suite struct {
 
 const configWithExternaladdress = `
 apiVersion: k0s.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: k0s
 spec:

diff --git a/pkg/apis/k0s.k0sproject.io/v1beta1/clusterconfig_types.go b/pkg/apis/k0s.k0sproject.io/v1beta1/clusterconfig_types.go
@@ -188,9 +188,11 @@ func ConfigFromString(yml string, dataDir string) (*ClusterConfig, error) {
 	if err != nil {
 		return config, err
 	}
+
 	if config.Spec == nil {
 		config.Spec = DefaultClusterSpec(dataDir)
 	}
+
 	return config, nil
 }
 
@@ -199,18 +201,15 @@ func DefaultClusterConfig(dataDir string) *ClusterConfig {
 	return &ClusterConfig{
 		ObjectMeta: metav1.ObjectMeta{Name: "k0s"},
 		TypeMeta: metav1.TypeMeta{
-			APIVersion: "k0s.k0sproject.io/v1beta1",
-			Kind:       "ClusterConfig",
+			APIVersion: ClusterConfigAPIVersion,
+			Kind:       ClusterConfigKind,
 		},
 		Spec: DefaultClusterSpec(dataDir),
 	}
 }
 
 // UnmarshalJSON sets in some sane defaults when unmarshaling the data from json
 func (c *ClusterConfig) UnmarshalJSON(data []byte) error {
-	if c.Kind == "" {
-		c.Kind = "ClusterConfig"
-	}
 	if c.ClusterName == "" {
 		c.ClusterName = "k0s"
 	}
@@ -268,6 +267,14 @@ type Validateable interface {
 func (c *ClusterConfig) Validate() []error {
 	var errors []error
 
+	if c.APIVersion != ClusterConfigAPIVersion {
+		errors = append(errors, fmt.Errorf("expected apiVersion: %s but found %s", ClusterConfigAPIVersion, c.APIVersion))
+	}
+
+	if c.Kind != ClusterConfigKind {
+		errors = append(errors, fmt.Errorf("expected kind: %s but found %s", ClusterConfigKind, c.Kind))
+	}
+
 	errors = append(errors, validateSpecs(c.Spec.API)...)
 	errors = append(errors, validateSpecs(c.Spec.ControllerManager)...)
 	errors = append(errors, validateSpecs(c.Spec.Scheduler)...)

diff --git a/pkg/apis/k0s.k0sproject.io/v1beta1/clusterconfig_types_test.go b/pkg/apis/k0s.k0sproject.io/v1beta1/clusterconfig_types_test.go
@@ -17,6 +17,7 @@ package v1beta1
 
 import (
 	"encoding/json"
+	"fmt"
 	"testing"
 
 	"github.com/k0sproject/k0s/internal/pkg/iface"
@@ -40,6 +41,24 @@ unknown: 1`, dataDir)
 	assert.Error(t, err)
 }
 
+func TestAPIVersionValidation(t *testing.T) {
+	c, _ := ConfigFromString("apiVersion: "+ClusterConfigAPIVersion, dataDir)
+	assert.Len(t, c.Validate(), 0)
+	c, _ = ConfigFromString("apiVersion: k0sctl.k0sproject.io/v1beta1", dataDir)
+	errors := c.Validate()
+	assert.Len(t, errors, 1)
+	assert.Contains(t, errors[0].Error(), "k0sctl.k0sproject.io")
+}
+
+func TestKindValidation(t *testing.T) {
+	c, _ := ConfigFromString(fmt.Sprintf("apiVersion: %s\nkind: %s", ClusterConfigAPIVersion, ClusterConfigKind), dataDir)
+	assert.Len(t, c.Validate(), 0)
+	c, _ = ConfigFromString(fmt.Sprintf("apiVersion: %s\nkind: %s", ClusterConfigAPIVersion, "UnsupportedKind"), dataDir)
+	errors := c.Validate()
+	assert.Len(t, errors, 1)
+	assert.Contains(t, errors[0].Error(), "UnsupportedKind")
+}
+
 func TestStorageDefaults(t *testing.T) {
 	yamlData := `
 apiVersion: k0s.k0sproject.io/v1beta1

diff --git a/pkg/apis/k0s.k0sproject.io/v1beta1/network_test.go b/pkg/apis/k0s.k0sproject.io/v1beta1/network_test.go
@@ -93,7 +93,7 @@ func (s *NetworkSuite) TestNetworkDefaults() {
 func (s *NetworkSuite) TestCalicoDefaultsAfterMashaling() {
 	yamlData := `
 apiVersion: k0s.k0sproject.io/v1beta1
-kind: Cluster
+kind: ClusterConfig
 metadata:
   name: foobar
 spec: