Merge pull request kubernetes#127242 from SataQiu/refactor-upgrade-node

kubeadm: add addon and post-upgrade phases for 'kubeadm upgrade node'

Author: k8s-ci-robot

cmd/kubeadm/app/cmd/phases/upgrade/apply/addons.go renamed to cmd/kubeadm/app/cmd/phases/upgrade/addons.go

@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package apply implements phases of 'kubeadm upgrade apply'.
-package apply
+// Package upgrade holds the common phases for 'kubeadm upgrade'.
+package upgrade
 
 import (
 	"fmt"
@@ -28,7 +28,6 @@ import (
 	kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
 	"k8s.io/kubernetes/cmd/kubeadm/app/cmd/options"
 	"k8s.io/kubernetes/cmd/kubeadm/app/cmd/phases/workflow"
-	cmdutil "k8s.io/kubernetes/cmd/kubeadm/app/cmd/util"
 	dnsaddon "k8s.io/kubernetes/cmd/kubeadm/app/phases/addons/dns"
 	proxyaddon "k8s.io/kubernetes/cmd/kubeadm/app/phases/addons/proxy"
 	"k8s.io/kubernetes/cmd/kubeadm/app/phases/upgrade"
@@ -39,7 +38,6 @@ func NewAddonPhase() workflow.Phase {
 	return workflow.Phase{
 		Name:  "addon",
 		Short: "Upgrade the default kubeadm addons",
-		Long:  cmdutil.MacroCommandLongDescription,
 		Phases: []workflow.Phase{
 			{
 				Name:           "all",
@@ -98,7 +96,6 @@ func runCoreDNSAddon(c workflow.RunData) error {
 		return nil
 	}
 
-	// Upgrade CoreDNS
 	if err := dnsaddon.EnsureDNSAddon(&cfg.ClusterConfiguration, client, patchesDir, out, dryRun); err != nil {
 		return err
 	}
@@ -121,7 +118,6 @@ func runKubeProxyAddon(c workflow.RunData) error {
 		return nil
 	}
 
-	// Upgrade kube-proxy
 	if err := proxyaddon.EnsureProxyAddon(&cfg.ClusterConfiguration, &cfg.LocalAPIEndpoint, client, out, dryRun); err != nil {
 		return err
 	}

cmd/kubeadm/app/cmd/phases/upgrade/apply/data.go

@@ -18,26 +18,14 @@ limitations under the License.
 package apply
 
 import (
-	"io"
-
-	"k8s.io/apimachinery/pkg/util/sets"
-	clientset "k8s.io/client-go/kubernetes"
-
-	kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
+	"k8s.io/kubernetes/cmd/kubeadm/app/cmd/phases/upgrade"
 )
 
 // Data is the interface to use for kubeadm upgrade apply phases.
 // The "applyData" type from "cmd/upgrade/apply.go" must satisfy this interface.
 type Data interface {
-	EtcdUpgrade() bool
-	RenewCerts() bool
-	DryRun() bool
-	Cfg() *kubeadmapi.UpgradeConfiguration
-	InitCfg() *kubeadmapi.InitConfiguration
-	Client() clientset.Interface
-	IgnorePreflightErrors() sets.Set[string]
-	PatchesDir() string
-	OutputWriter() io.Writer
+	upgrade.Data
+
 	SessionIsInteractive() bool
 	AllowExperimentalUpgrades() bool
 	AllowRCUpgrades() bool

cmd/kubeadm/app/cmd/phases/upgrade/apply/uploadconfig.go

@@ -28,7 +28,6 @@ import (
 	kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
 	"k8s.io/kubernetes/cmd/kubeadm/app/cmd/options"
 	"k8s.io/kubernetes/cmd/kubeadm/app/cmd/phases/workflow"
-	cmdutil "k8s.io/kubernetes/cmd/kubeadm/app/cmd/util"
 	kubeletphase "k8s.io/kubernetes/cmd/kubeadm/app/phases/kubelet"
 	patchnodephase "k8s.io/kubernetes/cmd/kubeadm/app/phases/patchnode"
 	"k8s.io/kubernetes/cmd/kubeadm/app/phases/uploadconfig"
@@ -40,7 +39,6 @@ func NewUploadConfigPhase() workflow.Phase {
 		Name:    "upload-config",
 		Aliases: []string{"uploadconfig"},
 		Short:   "Upload the kubeadm and kubelet configurations to ConfigMaps",
-		Long:    cmdutil.MacroCommandLongDescription,
 		Phases: []workflow.Phase{
 			{
 				Name:           "all",

cmd/kubeadm/app/cmd/phases/upgrade/data.go

@@ -0,0 +1,40 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package upgrade holds the common phases for 'kubeadm upgrade'.
+package upgrade
+
+import (
+	"io"
+
+	"k8s.io/apimachinery/pkg/util/sets"
+	clientset "k8s.io/client-go/kubernetes"
+
+	kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
+)
+
+// Data is the common interface to use for kubeadm upgrade phases.
+type Data interface {
+	EtcdUpgrade() bool
+	RenewCerts() bool
+	DryRun() bool
+	Cfg() *kubeadmapi.UpgradeConfiguration
+	InitCfg() *kubeadmapi.InitConfiguration
+	Client() clientset.Interface
+	IgnorePreflightErrors() sets.Set[string]
+	PatchesDir() string
+	OutputWriter() io.Writer
+}

cmd/kubeadm/app/cmd/phases/upgrade/data_test.go

@@ -0,0 +1,42 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package upgrade
+
+import (
+	"io"
+
+	"k8s.io/apimachinery/pkg/util/sets"
+	clientset "k8s.io/client-go/kubernetes"
+
+	kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
+)
+
+// a package local type for testing purposes.
+type testData struct{}
+
+// testData must satisfy Data.
+var _ Data = &testData{}
+
+func (t *testData) EtcdUpgrade() bool                       { return false }
+func (t *testData) RenewCerts() bool                        { return false }
+func (t *testData) DryRun() bool                            { return false }
+func (t *testData) Cfg() *kubeadmapi.UpgradeConfiguration   { return nil }
+func (t *testData) InitCfg() *kubeadmapi.InitConfiguration  { return nil }
+func (t *testData) Client() clientset.Interface             { return nil }
+func (t *testData) IgnorePreflightErrors() sets.Set[string] { return nil }
+func (t *testData) PatchesDir() string                      { return "" }
+func (t *testData) OutputWriter() io.Writer                 { return nil }

cmd/kubeadm/app/cmd/phases/upgrade/apply/kubeletconfig.go renamed to cmd/kubeadm/app/cmd/phases/upgrade/kubeletconfig.go

@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package apply implements phases of 'kubeadm upgrade apply'.
-package apply
+// Package upgrade holds the common phases for 'kubeadm upgrade'.
+package upgrade
 
 import (
 	"fmt"
@@ -57,16 +57,14 @@ func runKubeletConfigPhase(c workflow.RunData) error {
 		return errors.New("kubelet-config phase invoked with an invalid data struct")
 	}
 
-	initCfg, dryRun := data.InitCfg(), data.DryRun()
-
 	// Write the configuration for the kubelet down to disk and print the generated manifests instead of dry-running.
 	// If not dry-running, the kubelet config file will be backed up to the /etc/kubernetes/tmp/ dir, so that it could be
 	// recovered if anything goes wrong.
-	err := upgrade.WriteKubeletConfigFiles(initCfg, data.PatchesDir(), dryRun, data.OutputWriter())
+	err := upgrade.WriteKubeletConfigFiles(data.InitCfg(), data.PatchesDir(), data.DryRun(), data.OutputWriter())
 	if err != nil {
 		return err
 	}
 
-	fmt.Println("[upgrade/kubelet-config] The kubelet configuration for this node was successfully updated!")
+	fmt.Println("[upgrade/kubelet-config] The kubelet configuration for this node was successfully upgraded!")
 	return nil
 }

cmd/kubeadm/app/cmd/phases/upgrade/node/controlplane.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package node implements phases of 'kubeadm upgrade node'.
 package node
 
 import (
@@ -28,13 +29,14 @@ import (
 	"k8s.io/kubernetes/cmd/kubeadm/app/util/apiclient"
 )
 
-// NewControlPlane creates a kubeadm workflow phase that implements handling of control-plane upgrade.
+// NewControlPlane returns a new control-plane phase.
 func NewControlPlane() workflow.Phase {
 	phase := workflow.Phase{
 		Name:  "control-plane",
 		Short: "Upgrade the control plane instance deployed on this node, if any",
 		Run:   runControlPlane(),
 		InheritFlags: []string{
+			options.CfgPath,
 			options.DryRun,
 			options.KubeconfigPath,
 			options.CertificateRenewal,
@@ -54,7 +56,7 @@ func runControlPlane() func(c workflow.RunData) error {
 
 		// if this is not a control-plane node, this phase should not be executed
 		if !data.IsControlPlaneNode() {
-			fmt.Println("[upgrade] Skipping phase. Not a control plane node.")
+			fmt.Println("[upgrade/control-plane] Skipping phase. Not a control plane node.")
 			return nil
 		}
 
@@ -67,8 +69,9 @@ func runControlPlane() func(c workflow.RunData) error {
 		patchesDir := data.PatchesDir()
 
 		// Upgrade the control plane and etcd if installed on this node
-		fmt.Printf("[upgrade] Upgrading your Static Pod-hosted control plane instance to version %q...\n", cfg.KubernetesVersion)
+		fmt.Printf("[upgrade/control-plane] Upgrading your Static Pod-hosted control plane instance to version %q...\n", cfg.KubernetesVersion)
 		if dryRun {
+			fmt.Printf("[dryrun] Would upgrade your static Pod-hosted control plane to version %q", cfg.KubernetesVersion)
 			return upgrade.DryRunStaticPodUpgrade(patchesDir, cfg)
 		}
 
@@ -78,11 +81,7 @@ func runControlPlane() func(c workflow.RunData) error {
 			return errors.Wrap(err, "couldn't complete the static pod upgrade")
 		}
 
-		if err := upgrade.PerformAddonsUpgrade(client, cfg, data.PatchesDir(), data.OutputWriter()); err != nil {
-			return errors.Wrap(err, "failed to perform addons upgrade")
-		}
-
-		fmt.Println("[upgrade] The control plane instance for this node was successfully updated!")
+		fmt.Println("[upgrade/control-plane] The control plane instance for this node was successfully upgraded!")
 
 		return nil
 	}

cmd/kubeadm/app/cmd/phases/upgrade/node/data.go

@@ -14,29 +14,18 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package node implements phases of 'kubeadm upgrade node'.
 package node
 
 import (
-	"io"
-
-	"k8s.io/apimachinery/pkg/util/sets"
-	clientset "k8s.io/client-go/kubernetes"
-
-	kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
+	"k8s.io/kubernetes/cmd/kubeadm/app/cmd/phases/upgrade"
 )
 
 // Data is the interface to use for kubeadm upgrade node phases.
 // The "nodeData" type from "cmd/upgrade/node.go" must satisfy this interface.
 type Data interface {
-	EtcdUpgrade() bool
-	RenewCerts() bool
-	DryRun() bool
-	Cfg() *kubeadmapi.UpgradeConfiguration
-	InitCfg() *kubeadmapi.InitConfiguration
+	upgrade.Data
+
 	IsControlPlaneNode() bool
-	Client() clientset.Interface
-	IgnorePreflightErrors() sets.Set[string]
-	PatchesDir() string
 	KubeConfigPath() string
-	OutputWriter() io.Writer
 }

cmd/kubeadm/app/cmd/phases/upgrade/node/kubeconfig.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package node holds phases of "kubeadm upgrade node".
+// Package node implements phases of 'kubeadm upgrade node'.
 package node
 
 import (
@@ -28,14 +28,15 @@ import (
 	"k8s.io/kubernetes/cmd/kubeadm/app/phases/upgrade"
 )
 
-// NewKubeconfigPhase creates a kubeadm workflow phase that implements handling of kubeconfig upgrade.
+// NewKubeconfigPhase returns a new kubeconfig phase.
 func NewKubeconfigPhase() workflow.Phase {
 	phase := workflow.Phase{
 		Name:   "kubeconfig",
 		Short:  "Upgrade kubeconfig files for this node",
 		Run:    runKubeconfig(),
 		Hidden: true,
 		InheritFlags: []string{
+			options.CfgPath,
 			options.DryRun,
 			options.KubeconfigPath,
 		},
@@ -50,23 +51,22 @@ func runKubeconfig() func(c workflow.RunData) error {
 			return errors.New("kubeconfig phase invoked with an invalid data struct")
 		}
 
-		// if this is not a control-plane node, this phase should not be executed
+		// If this is not a control-plane node, this phase should not be executed.
 		if !data.IsControlPlaneNode() {
-			fmt.Println("[upgrade] Skipping phase. Not a control plane node.")
+			fmt.Println("[upgrade/kubeconfig] Skipping phase. Not a control plane node.")
 			return nil
 		}
 
-		// otherwise, retrieve all the info required for kubeconfig upgrade
+		// Otherwise, retrieve all the info required for kubeconfig upgrade.
 		cfg := data.InitCfg()
-		dryRun := data.DryRun()
 
 		if features.Enabled(cfg.FeatureGates, features.ControlPlaneKubeletLocalMode) {
-			if err := upgrade.UpdateKubeletLocalMode(cfg, dryRun); err != nil {
+			if err := upgrade.UpdateKubeletLocalMode(cfg, data.DryRun()); err != nil {
 				return errors.Wrap(err, "failed to update kubelet local mode")
 			}
 		}
 
-		fmt.Println("[upgrade] The kubeconfig for this node was successfully updated!")
+		fmt.Println("[upgrade/kubeconfig] The kubeconfig files for this node were successfully upgraded!")
 
 		return nil
 	}