feat: Provide operating system from config (#1809)

* feat: Provide operating system from config * validate provided operating system * fallback to runtime detection Signed-off-by: Artiom Diomin <kron82@gmail.com> * Fix mistake with a OS detection Signed-off-by: Artiom Diomin <kron82@gmail.com> * Pre-pull images only on control-plane Signed-off-by: Artiom Diomin <kron82@gmail.com> * Set operating_system in terraform output for static workers as well Signed-off-by: Artiom Diomin <kron82@gmail.com> * Switch AWS terraform example from CentOS8 image to RockyLinux8 Signed-off-by: Artiom Diomin <kron82@gmail.com>
kubermatic · Feb 10, 2022 · 13b4099 · 13b4099
1 parent 7821186
commit 13b4099
Show file tree

Hide file tree

Showing 12 changed files with 82 additions and 14 deletions.
diff --git a/docs/api_reference/v1beta2.en.md b/docs/api_reference/v1beta2.en.md
@@ -1,6 +1,6 @@
 +++
 title = "v1beta2 API Reference"
-date = 2022-01-28T16:22:51+05:00
+date = 2022-02-04T17:38:06+02:00
 weight = 11
 +++
 ## v1beta2
@@ -401,6 +401,7 @@ HostConfig describes a single control plane node.
 | isLeader | IsLeader indicates this host as a session leader. Default value is populated at the runtime. | bool | false |
 | taints | Taints if not provided (i.e. nil) defaults to TaintEffectNoSchedule, with key node-role.kubernetes.io/master for control plane nodes. Explicitly empty (i.e. []corev1.Taint{}) means no taints will be applied (this is default for worker nodes). | [][corev1.Taint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#taint-v1-core) | false |
 | kubelet | Kubelet | [KubeletConfig](#kubeletconfig) | false |
+| operatingSystem | OperatingSystem information, can be populated at the runtime. | OperatingSystemName | false |
 
 [Back to Group](#v1beta2)
 

diff --git a/examples/terraform/aws/output.tf b/examples/terraform/aws/output.tf
@@ -36,6 +36,7 @@ output "kubeone_hosts" {
       cloud_provider       = "aws"
       private_address      = aws_instance.control_plane.*.private_ip
       hostnames            = aws_instance.control_plane.*.private_dns
+      operating_system     = var.os
       ssh_agent_socket     = var.ssh_agent_socket
       ssh_port             = var.ssh_port
       ssh_private_key_file = var.ssh_private_key_file
@@ -54,6 +55,7 @@ output "kubeone_static_workers" {
     workers1 = {
       private_address      = aws_instance.static_workers1.*.private_ip
       hostnames            = aws_instance.static_workers1.*.private_dns
+      operating_system     = var.os
       ssh_agent_socket     = var.ssh_agent_socket
       ssh_port             = var.ssh_port
       ssh_private_key_file = var.ssh_private_key_file

diff --git a/examples/terraform/aws/variables.tf b/examples/terraform/aws/variables.tf
@@ -157,9 +157,9 @@ variable "ami_filters" {
     }
 
     centos = {
-      owners     = ["125523088429"] # CentOS
-      image_name = ["CentOS 8.* x86_64"]
-      osp_name   = "osp-centos8"
+      owners     = ["792107900819"] # RockyLinux
+      image_name = ["Rocky-8-ec2-*.x86_64"]
+      osp_name   = "osp-centos"
     }
 
     flatcar = {

diff --git a/pkg/apis/kubeone/helpers.go b/pkg/apis/kubeone/helpers.go
@@ -84,8 +84,31 @@ func (h *HostConfig) SetHostname(hostname string) {
 }
 
 // SetOperatingSystem sets the operating system for the given host
-func (h *HostConfig) SetOperatingSystem(os OperatingSystemName) {
-	h.OperatingSystem = os
+func (h *HostConfig) SetOperatingSystem(os OperatingSystemName) error {
+	if h.OperatingSystem.IsValid() {
+		h.OperatingSystem = os
+
+		return nil
+	}
+
+	return errors.Errorf("unknown operating system %q", os)
+}
+
+func (osName OperatingSystemName) IsValid() bool {
+	// linter exhaustive will make sure this switch is iterating over all current and future possibilities
+	switch osName {
+	case OperatingSystemNameUbuntu:
+	case OperatingSystemNameDebian:
+	case OperatingSystemNameCentOS:
+	case OperatingSystemNameRHEL:
+	case OperatingSystemNameAmazon:
+	case OperatingSystemNameFlatcar:
+	case OperatingSystemNameUnknown:
+	default:
+		return false
+	}
+
+	return true
 }
 
 // SetLeader sets is the given host leader

diff --git a/pkg/apis/kubeone/types.go b/pkg/apis/kubeone/types.go
@@ -178,8 +178,8 @@ type HostConfig struct {
 	Taints []corev1.Taint `json:"taints,omitempty"`
 	// Kubelet
 	Kubelet KubeletConfig `json:"kubelet,omitempty"`
-	// OperatingSystem information populated at the runtime.
-	OperatingSystem OperatingSystemName `json:"-"`
+	// OperatingSystem information, can be populated at the runtime.
+	OperatingSystem OperatingSystemName `json:"operatingSystem,omitempty"`
 }
 
 // ControlPlaneConfig defines control plane nodes

diff --git a/pkg/apis/kubeone/v1beta2/types.go b/pkg/apis/kubeone/v1beta2/types.go
@@ -176,8 +176,8 @@ type HostConfig struct {
 	Taints []corev1.Taint `json:"taints,omitempty"`
 	// Kubelet
 	Kubelet KubeletConfig `json:"kubelet,omitempty"`
-	// OperatingSystem information populated at the runtime.
-	OperatingSystem OperatingSystemName `json:"-"`
+	// OperatingSystem information, can be populated at the runtime.
+	OperatingSystem OperatingSystemName `json:"operatingSystem,omitempty"`
 }
 
 // ControlPlaneConfig defines control plane nodes

diff --git a/pkg/apis/kubeone/validation/validation.go b/pkg/apis/kubeone/validation/validation.go
@@ -592,6 +592,9 @@ func ValidateHostConfig(hosts []kubeoneapi.HostConfig, fldPath *field.Path) fiel
 		if len(h.SSHUsername) == 0 {
 			allErrs = append(allErrs, field.Required(fldPath, "no SSH username given"))
 		}
+		if !h.OperatingSystem.IsValid() {
+			allErrs = append(allErrs, field.Invalid(fldPath.Child("operatingSystem"), h.OperatingSystem, "invalid operatingSystem provided"))
+		}
 	}
 
 	return allErrs

diff --git a/pkg/apis/kubeone/validation/validation_test.go b/pkg/apis/kubeone/validation/validation_test.go
@@ -1852,6 +1852,34 @@ func TestValidateHostConfig(t *testing.T) {
 			},
 			expectedError: true,
 		},
+		{
+			name: "valid OS",
+			hostConfig: []kubeoneapi.HostConfig{
+				{
+					PublicAddress:     "192.168.1.1",
+					PrivateAddress:    "192.168.0.1",
+					SSHPrivateKeyFile: "test",
+					SSHAgentSocket:    "test",
+					SSHUsername:       "root",
+					OperatingSystem:   kubeoneapi.OperatingSystemNameCentOS,
+				},
+			},
+			expectedError: false,
+		},
+		{
+			name: "invalid OS",
+			hostConfig: []kubeoneapi.HostConfig{
+				{
+					PublicAddress:     "192.168.1.1",
+					PrivateAddress:    "192.168.0.1",
+					SSHPrivateKeyFile: "test",
+					SSHAgentSocket:    "test",
+					SSHUsername:       "root",
+					OperatingSystem:   kubeoneapi.OperatingSystemName("non-existing"),
+				},
+			},
+			expectedError: true,
+		},
 	}
 
 	for _, tc := range tests {

diff --git a/pkg/cmd/apply.go b/pkg/cmd/apply.go
@@ -299,7 +299,7 @@ func runApplyInstall(s *state.State, opts *applyOpts) error { // Print the expec
 
 	for _, node := range s.LiveCluster.StaticWorkers {
 		if !node.IsInCluster {
-			fmt.Printf("\t+ join worker node %q (%s)\n", node.Config.Hostname, node.Config.PrivateAddress)
+			fmt.Printf("\t+ join static worker node %q (%s)\n", node.Config.Hostname, node.Config.PrivateAddress)
 		}
 	}
 

diff --git a/pkg/tasks/prerequisites.go b/pkg/tasks/prerequisites.go
@@ -43,7 +43,7 @@ func installPrerequisites(s *state.State) error {
 		return fmt.Errorf("failed to install prerequisites: %w", err)
 	}
 
-	return s.RunTaskOnAllNodes(func(ctx *state.State, node *kubeoneapi.HostConfig, conn ssh.Connection) error {
+	return s.RunTaskOnControlPlane(func(ctx *state.State, node *kubeoneapi.HostConfig, conn ssh.Connection) error {
 		ctx.Logger.Info("Pre-pull images")
 
 		_, _, err := ctx.Runner.Run(

diff --git a/pkg/tasks/util.go b/pkg/tasks/util.go
@@ -50,6 +50,8 @@ func determineHostname(s *state.State) error {
 
 	return s.RunTaskOnAllNodes(func(s *state.State, node *kubeoneapi.HostConfig, conn ssh.Connection) error {
 		if node.Hostname != "" {
+			s.Logger.Debugf("Hostname is already set to %q", node.Hostname)
+
 			return nil
 		}
 
@@ -64,6 +66,7 @@ func determineHostname(s *state.State) error {
 			return err
 		}
 
+		s.Logger.Debugf("Hostname is detected: %q", stdout)
 		node.SetHostname(stdout)
 
 		return nil
@@ -74,15 +77,21 @@ func determineOS(s *state.State) error {
 	s.Logger.Infoln("Determine operating system...")
 
 	return s.RunTaskOnAllNodes(func(s *state.State, node *kubeoneapi.HostConfig, conn ssh.Connection) error {
+		if node.OperatingSystem != kubeoneapi.OperatingSystemNameUnknown {
+			s.Logger.Debugf("Operating system is already set to %q", node.OperatingSystem)
+
+			return nil
+		}
+
 		buf, err := fs.ReadFile(sshiofs.New(conn), "/etc/os-release")
 		if err != nil {
 			return err
 		}
 
 		osrData := osrelease.Parse(string(buf))
-		node.SetOperatingSystem(kubeoneapi.OperatingSystemName(osrData.ID))
+		s.Logger.Debugf("Operating system detected: %q", osrData.ID)
 
-		return nil
+		return node.SetOperatingSystem(kubeoneapi.OperatingSystemName(osrData.ID))
 	}, state.RunParallel)
 }
 

diff --git a/pkg/terraform/v1beta2/config.go b/pkg/terraform/v1beta2/config.go
@@ -70,6 +70,7 @@ type hostsSpec struct {
 	PublicAddress     []string `json:"public_address"`
 	PrivateAddress    []string `json:"private_address"`
 	Hostnames         []string `json:"hostnames"`
+	OperatingSystem   string   `json:"operating_system"`
 	SSHUser           string   `json:"ssh_user"`
 	SSHPort           int      `json:"ssh_port"`
 	SSHPrivateKeyFile string   `json:"ssh_private_key_file"`
@@ -286,6 +287,7 @@ func newHostConfig(publicIP, privateIP, hostname string, hs *hostsSpec) kubeonev
 		BastionPort:       hs.BastionPort,
 		BastionUser:       hs.BastionUser,
 		Hostname:          hostname,
+		OperatingSystem:   kubeonev1beta2.OperatingSystemName(hs.OperatingSystem),
 		PrivateAddress:    privateIP,
 		PublicAddress:     publicIP,
 		SSHAgentSocket:    hs.SSHAgentSocket,