Merge pull request #1688 from NeonSludge/skip-init-os

feat(kk): allow skipping OS pre-configuration tasks
kubesphere · Jan 17, 2023 · b6a8ac4 · b6a8ac4
2 parents 8280d60 + a2229f5
commit b6a8ac4
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 15 deletions.
diff --git a/cmd/kk/apis/kubekey/v1alpha2/cluster_types.go b/cmd/kk/apis/kubekey/v1alpha2/cluster_types.go
@@ -92,12 +92,13 @@ type CustomScripts struct {
 
 // System defines the system config for each node in cluster.
 type System struct {
-	NtpServers  []string        `yaml:"ntpServers" json:"ntpServers,omitempty"`
-	Timezone    string          `yaml:"timezone" json:"timezone,omitempty"`
-	Rpms        []string        `yaml:"rpms" json:"rpms,omitempty"`
-	Debs        []string        `yaml:"debs" json:"debs,omitempty"`
-	PreInstall  []CustomScripts `yaml:"preInstall" json:"preInstall,omitempty"`
-	PostInstall []CustomScripts `yaml:"postInstall" json:"postInstall,omitempty"`
+	NtpServers      []string        `yaml:"ntpServers" json:"ntpServers,omitempty"`
+	Timezone        string          `yaml:"timezone" json:"timezone,omitempty"`
+	Rpms            []string        `yaml:"rpms" json:"rpms,omitempty"`
+	Debs            []string        `yaml:"debs" json:"debs,omitempty"`
+	PreInstall      []CustomScripts `yaml:"preInstall" json:"preInstall,omitempty"`
+	PostInstall     []CustomScripts `yaml:"postInstall" json:"postInstall,omitempty"`
+	SkipConfigureOS bool            `yaml:"skipConfigureOS" json:"skipConfigureOS,omitempty"`
 }
 
 // RegistryConfig defines the configuration information of the image's repository.

diff --git a/cmd/kk/pkg/bootstrap/os/module.go b/cmd/kk/pkg/bootstrap/os/module.go
@@ -29,6 +29,11 @@ import (
 
 type ConfigureOSModule struct {
 	common.KubeModule
+	Skip bool
+}
+
+func (c *ConfigureOSModule) IsSkip() bool {
+	return c.Skip
 }
 
 func (c *ConfigureOSModule) Init() {

diff --git a/cmd/kk/pkg/phase/os/config.go b/cmd/kk/pkg/phase/os/config.go
@@ -31,7 +31,7 @@ func NewConfigOSPipeline(runtime *common.KubeRuntime) error {
 	m := []module.Module{
 		&precheck.NodePreCheckModule{},
 		&os.RepositoryModule{Skip: !runtime.Arg.InstallPackages},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 	}
 
 	p := pipeline.Pipeline{

diff --git a/cmd/kk/pkg/pipelines/add_nodes.go b/cmd/kk/pkg/pipelines/add_nodes.go
@@ -51,7 +51,7 @@ func NewAddNodesPipeline(runtime *common.KubeRuntime) error {
 		&artifact.UnArchiveModule{Skip: noArtifact},
 		&os.RepositoryModule{Skip: noArtifact || !runtime.Arg.InstallPackages},
 		&binaries.NodeBinariesModule{},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 		&customscripts.CustomScriptsModule{Phase: "PreInstall", Scripts: runtime.Cluster.System.PreInstall},
 		&registry.RegistryCertsModule{Skip: len(runtime.GetHostsByRole(common.Registry)) == 0},
 		&kubernetes.StatusModule{},
@@ -91,7 +91,7 @@ func NewK3sAddNodesPipeline(runtime *common.KubeRuntime) error {
 		&artifact.UnArchiveModule{Skip: noArtifact},
 		&os.RepositoryModule{Skip: noArtifact || !runtime.Arg.InstallPackages},
 		&binaries.K3sNodeBinariesModule{},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 		&customscripts.CustomScriptsModule{Phase: "PreInstall", Scripts: runtime.Cluster.System.PreInstall},
 		&k3s.StatusModule{},
 		&etcd.PreCheckModule{Skip: runtime.Cluster.Etcd.Type != kubekeyapiv1alpha2.KubeKey},
@@ -128,7 +128,7 @@ func NewK8eAddNodesPipeline(runtime *common.KubeRuntime) error {
 		&artifact.UnArchiveModule{Skip: noArtifact},
 		&os.RepositoryModule{Skip: noArtifact || !runtime.Arg.InstallPackages},
 		&binaries.K8eNodeBinariesModule{},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 
 		&k8e.StatusModule{},
 		&etcd.PreCheckModule{Skip: runtime.Cluster.Etcd.Type != kubekeyapiv1alpha2.KubeKey},

diff --git a/cmd/kk/pkg/pipelines/create_cluster.go b/cmd/kk/pkg/pipelines/create_cluster.go
@@ -63,7 +63,7 @@ func NewCreateClusterPipeline(runtime *common.KubeRuntime) error {
 		&artifact.UnArchiveModule{Skip: noArtifact},
 		&os.RepositoryModule{Skip: noArtifact || !runtime.Arg.InstallPackages},
 		&binaries.NodeBinariesModule{},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 		&customscripts.CustomScriptsModule{Phase: "PreInstall", Scripts: runtime.Cluster.System.PreInstall},
 		&kubernetes.StatusModule{},
 		&container.InstallContainerModule{},
@@ -145,7 +145,7 @@ func NewK3sCreateClusterPipeline(runtime *common.KubeRuntime) error {
 		&artifact.UnArchiveModule{Skip: noArtifact},
 		&os.RepositoryModule{Skip: noArtifact || !runtime.Arg.InstallPackages},
 		&binaries.K3sNodeBinariesModule{},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 		&customscripts.CustomScriptsModule{Phase: "PreInstall", Scripts: runtime.Cluster.System.PreInstall},
 		&k3s.StatusModule{},
 		&etcd.PreCheckModule{Skip: runtime.Cluster.Etcd.Type != kubekeyapiv1alpha2.KubeKey},
@@ -219,7 +219,7 @@ func NewK8eCreateClusterPipeline(runtime *common.KubeRuntime) error {
 		&artifact.UnArchiveModule{Skip: noArtifact},
 		&os.RepositoryModule{Skip: noArtifact || !runtime.Arg.InstallPackages},
 		&binaries.K8eNodeBinariesModule{},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 		&customscripts.CustomScriptsModule{Phase: "PreInstall", Scripts: runtime.Cluster.System.PreInstall},
 		&k8e.StatusModule{},
 		&etcd.PreCheckModule{Skip: runtime.Cluster.Etcd.Type != kubekeyapiv1alpha2.KubeKey},

diff --git a/cmd/kk/pkg/pipelines/init_registry.go b/cmd/kk/pkg/pipelines/init_registry.go
@@ -37,7 +37,7 @@ func NewInitRegistryPipeline(runtime *common.KubeRuntime) error {
 		&precheck.GreetingsModule{},
 		&artifact.UnArchiveModule{Skip: noArtifact},
 		&binaries.RegistryPackageModule{},
-		&os.ConfigureOSModule{},
+		&os.ConfigureOSModule{Skip: runtime.Cluster.System.SkipConfigureOS},
 		&registry.RegistryCertsModule{},
 		&registry.InstallRegistryModule{},
 		&filesystem.ChownWorkDirModule{},

diff --git a/docs/config-example.md b/docs/config-example.md
@@ -42,7 +42,8 @@ spec:
     #  - name: clean tmps files
     #    bash: |
     #       rm -fr /tmp/kubekey/*
-
+    #skipConfigureOS: true # Do not pre-configure the host OS (e.g. kernel modules, /etc/hosts, sysctl.conf, NTP servers, etc). You will have to set these things up via other methods before using KubeKey.
+
   kubernetes:
     version: v1.21.5
     imageRepo: kubesphere