Documentation ¶
Index ¶
- Constants
- func CheckClusterHealth(client clientset.Interface, cfg *kubeadmapi.ClusterConfiguration, ...) error
- func DryRunStaticPodUpgrade(patchesDir string, internalcfg *kubeadmapi.InitConfiguration) error
- func GetEtcdImageTagFromStaticPod(manifestDir string) (string, error)
- func GetKubeletDir(dryRun bool) (string, error)
- func PerformStaticPodUpgrade(client clientset.Interface, waiter apiclient.Waiter, ...) error
- func RunCoreDNSMigrationCheck(client clientset.Interface, ignorePreflightErrors sets.Set[string]) error
- func StaticPodControlPlane(client clientset.Interface, waiter apiclient.Waiter, ...) error
- func UnupgradedControlPlaneInstances(client clientset.Interface, nodeName string) ([]string, error)
- func UpdateKubeletLocalMode(cfg *kubeadmapi.InitConfiguration, dryRun bool) error
- func WriteKubeletConfigFiles(cfg *kubeadmapi.InitConfiguration, patchesDir string, dryRun bool, ...) error
- type ClusterState
- type CoreDNSCheck
- type KubeStaticPodPathManager
- func (spm *KubeStaticPodPathManager) BackupEtcdDir() string
- func (spm *KubeStaticPodPathManager) BackupManifestDir() string
- func (spm *KubeStaticPodPathManager) BackupManifestPath(component string) string
- func (spm *KubeStaticPodPathManager) CleanupDirs() error
- func (spm *KubeStaticPodPathManager) KubernetesDir() string
- func (spm *KubeStaticPodPathManager) MoveFile(oldPath, newPath string) error
- func (spm *KubeStaticPodPathManager) PatchesDir() string
- func (spm *KubeStaticPodPathManager) RealManifestDir() string
- func (spm *KubeStaticPodPathManager) RealManifestPath(component string) string
- func (spm *KubeStaticPodPathManager) TempManifestDir() string
- func (spm *KubeStaticPodPathManager) TempManifestPath(component string) string
- type KubeVersionGetter
- func (g *KubeVersionGetter) ClusterVersion() (string, *versionutil.Version, error)
- func (g *KubeVersionGetter) ComponentVersions(name string) (map[string][]string, error)
- func (g *KubeVersionGetter) KubeadmVersion() (string, *versionutil.Version, error)
- func (g *KubeVersionGetter) KubeletVersions() (map[string][]string, error)
- func (g *KubeVersionGetter) VersionFromCILabel(ciVersionLabel, description string) (string, *versionutil.Version, error)
- type OfflineVersionGetter
- type StaticPodPathManager
- func GetPathManagerForUpgrade(kubernetesDir, patchesDir string, internalcfg *kubeadmapi.InitConfiguration, ...) (StaticPodPathManager, error)
- func NewKubeStaticPodPathManager(kubernetesDir, patchesDir, tempDir, backupDir, backupEtcdDir string, ...) StaticPodPathManager
- func NewKubeStaticPodPathManagerUsingTempDirs(kubernetesDir, patchesDir string, saveManifestsDir, saveEtcdDir bool) (StaticPodPathManager, error)
- type Upgrade
- type VersionGetter
- type VersionSkewPolicyErrors
Constants ¶
const ( // MaximumAllowedMinorVersionUpgradeSkew describes how many minor versions kubeadm can upgrade the control plane version in one go MaximumAllowedMinorVersionUpgradeSkew = 1 // MaximumAllowedMinorVersionDowngradeSkew describes how many minor versions kubeadm can upgrade the control plane version in one go MaximumAllowedMinorVersionDowngradeSkew = 1 // MaximumAllowedMinorVersionKubeletSkew describes how many minor versions the control plane version and the kubelet can skew in a kubeadm cluster MaximumAllowedMinorVersionKubeletSkew = 3 )
Variables ¶
This section is empty.
Functions ¶
func CheckClusterHealth ¶
func CheckClusterHealth(client clientset.Interface, cfg *kubeadmapi.ClusterConfiguration, ignoreChecksErrors sets.Set[string], printer output.Printer) error
CheckClusterHealth makes sure: - the cluster can accept a workload - all control-plane Nodes are Ready - (if static pod-hosted) that all required Static Pod manifests exist on disk
func DryRunStaticPodUpgrade ¶ added in v1.15.0
func DryRunStaticPodUpgrade(patchesDir string, internalcfg *kubeadmapi.InitConfiguration) error
DryRunStaticPodUpgrade fakes an upgrade of the control plane
func GetEtcdImageTagFromStaticPod ¶ added in v1.19.0
GetEtcdImageTagFromStaticPod returns the image tag of the local etcd static pod
func GetKubeletDir ¶ added in v1.15.0
GetKubeletDir gets the kubelet directory based on whether the user is dry-running this command or not.
func PerformStaticPodUpgrade ¶ added in v1.15.0
func PerformStaticPodUpgrade(client clientset.Interface, waiter apiclient.Waiter, internalcfg *kubeadmapi.InitConfiguration, etcdUpgrade, renewCerts bool, patchesDir string) error
PerformStaticPodUpgrade performs the upgrade of the control plane components for a static pod hosted cluster
func RunCoreDNSMigrationCheck ¶ added in v1.16.0
func RunCoreDNSMigrationCheck(client clientset.Interface, ignorePreflightErrors sets.Set[string]) error
RunCoreDNSMigrationCheck initializes checks related to CoreDNS migration.
func StaticPodControlPlane ¶
func StaticPodControlPlane(client clientset.Interface, waiter apiclient.Waiter, pathMgr StaticPodPathManager, cfg *kubeadmapi.InitConfiguration, etcdUpgrade, renewCerts bool, oldEtcdClient, newEtcdClient etcdutil.ClusterInterrogator) error
StaticPodControlPlane upgrades a static pod-hosted control plane
func UnupgradedControlPlaneInstances ¶ added in v1.32.0
UnupgradedControlPlaneInstances returns a list of control plane instances that have not yet been upgraded.
NB. This function can only be called after the current control plane instance has been upgraded already. Because it determines whether the other control plane instances have been upgraded by checking whether the kube-apiserver image of other control plane instance is the same as that of this instance.
func UpdateKubeletLocalMode ¶ added in v1.31.0
func UpdateKubeletLocalMode(cfg *kubeadmapi.InitConfiguration, dryRun bool) error
UpdateKubeletLocalMode changes the Server URL in the kubelets kubeconfig to the local API endpoint if it is currently set to the ControlPlaneEndpoint. TODO: remove this function once kubeletKubeConfigFilePath goes GA and is hardcoded to enabled by default: https://github.com/kubernetes/kubeadm/issues/2271
func WriteKubeletConfigFiles ¶ added in v1.27.0
func WriteKubeletConfigFiles(cfg *kubeadmapi.InitConfiguration, patchesDir string, dryRun bool, out io.Writer) error
WriteKubeletConfigFiles writes the kubelet config file to disk, but first creates a backup of any existing one.
Types ¶
type ClusterState ¶
type ClusterState struct { // KubeVersion describes the version of latest Kubernetes API Server in the cluster. KubeVersion string // DNSVersion describes the version of the DNS add-on. DNSVersion string // KubeadmVersion describes the version of the kubeadm CLI KubeadmVersion string // EtcdVersion represents the version of etcd used in the cluster EtcdVersion string // The following maps describe the versions of the different components in the cluster. // The key is the version string and the value is a list of nodes that have that version. KubeAPIServerVersions map[string][]string KubeControllerManagerVersions map[string][]string KubeSchedulerVersions map[string][]string EtcdVersions map[string][]string KubeletVersions map[string][]string }
ClusterState describes the state of certain versions for a cluster during an upgrade
type CoreDNSCheck ¶ added in v1.16.0
type CoreDNSCheck struct {
// contains filtered or unexported fields
}
CoreDNSCheck validates installed kubelet version
func (CoreDNSCheck) Check ¶ added in v1.16.0
func (c CoreDNSCheck) Check() (warnings, errors []error)
Check is part of the preflight.Checker interface
func (CoreDNSCheck) Name ¶ added in v1.16.0
func (c CoreDNSCheck) Name() string
Name is part of the preflight.Checker interface
type KubeStaticPodPathManager ¶
type KubeStaticPodPathManager struct {
// contains filtered or unexported fields
}
KubeStaticPodPathManager is a real implementation of StaticPodPathManager that is used when upgrading a static pod cluster
func (*KubeStaticPodPathManager) BackupEtcdDir ¶ added in v1.9.0
func (spm *KubeStaticPodPathManager) BackupEtcdDir() string
BackupEtcdDir should point to the backup directory used for backing up manifests during the transition
func (*KubeStaticPodPathManager) BackupManifestDir ¶
func (spm *KubeStaticPodPathManager) BackupManifestDir() string
BackupManifestDir should point to the backup directory used for backing up manifests during the transition
func (*KubeStaticPodPathManager) BackupManifestPath ¶
func (spm *KubeStaticPodPathManager) BackupManifestPath(component string) string
BackupManifestPath gets the file path for the component in the backup directory used for backing up manifests during the transition
func (*KubeStaticPodPathManager) CleanupDirs ¶ added in v1.11.0
func (spm *KubeStaticPodPathManager) CleanupDirs() error
CleanupDirs cleans up all temporary directories except those the user has requested to keep around
func (*KubeStaticPodPathManager) KubernetesDir ¶ added in v1.15.0
func (spm *KubeStaticPodPathManager) KubernetesDir() string
KubernetesDir should point to the directory Kubernetes owns for storing various configuration files
func (*KubeStaticPodPathManager) MoveFile ¶
func (spm *KubeStaticPodPathManager) MoveFile(oldPath, newPath string) error
MoveFile should move a file from oldPath to newPath
func (*KubeStaticPodPathManager) PatchesDir ¶ added in v1.19.0
func (spm *KubeStaticPodPathManager) PatchesDir() string
PatchesDir should point to the folder where patches for components are stored
func (*KubeStaticPodPathManager) RealManifestDir ¶
func (spm *KubeStaticPodPathManager) RealManifestDir() string
RealManifestDir should point to the static pod manifest directory used by the kubelet
func (*KubeStaticPodPathManager) RealManifestPath ¶
func (spm *KubeStaticPodPathManager) RealManifestPath(component string) string
RealManifestPath gets the file path for the component in the "real" static pod manifest directory used by the kubelet
func (*KubeStaticPodPathManager) TempManifestDir ¶
func (spm *KubeStaticPodPathManager) TempManifestDir() string
TempManifestDir should point to the temporary directory created for generating new manifests for the upgrade
func (*KubeStaticPodPathManager) TempManifestPath ¶
func (spm *KubeStaticPodPathManager) TempManifestPath(component string) string
TempManifestPath gets the file path for the component in the temporary directory created for generating new manifests for the upgrade
type KubeVersionGetter ¶
type KubeVersionGetter struct {
// contains filtered or unexported fields
}
KubeVersionGetter handles the version-fetching mechanism from external sources
func (*KubeVersionGetter) ClusterVersion ¶
func (g *KubeVersionGetter) ClusterVersion() (string, *versionutil.Version, error)
ClusterVersion gets API server version
func (*KubeVersionGetter) ComponentVersions ¶ added in v1.30.0
func (g *KubeVersionGetter) ComponentVersions(name string) (map[string][]string, error)
ComponentVersions gets the versions of the control-plane components in the cluster. The name parameter is the name of the component to get the versions for. The function returns a map with the version as the key and a list of node names as the value.
func (*KubeVersionGetter) KubeadmVersion ¶
func (g *KubeVersionGetter) KubeadmVersion() (string, *versionutil.Version, error)
KubeadmVersion gets kubeadm version
func (*KubeVersionGetter) KubeletVersions ¶
func (g *KubeVersionGetter) KubeletVersions() (map[string][]string, error)
KubeletVersions gets the versions of the kubelets in the cluster.
func (*KubeVersionGetter) VersionFromCILabel ¶
func (g *KubeVersionGetter) VersionFromCILabel(ciVersionLabel, description string) (string, *versionutil.Version, error)
VersionFromCILabel resolves a version label like "latest" or "stable" to an actual version using the public Kubernetes CI uploads
type OfflineVersionGetter ¶ added in v1.11.0
type OfflineVersionGetter struct { VersionGetter // contains filtered or unexported fields }
OfflineVersionGetter will use the version provided or
func (*OfflineVersionGetter) VersionFromCILabel ¶ added in v1.11.0
func (o *OfflineVersionGetter) VersionFromCILabel(ciVersionLabel, description string) (string, *versionutil.Version, error)
VersionFromCILabel will return the version that was passed into the struct
type StaticPodPathManager ¶
type StaticPodPathManager interface { // MoveFile should move a file from oldPath to newPath MoveFile(oldPath, newPath string) error // KubernetesDir is the directory Kubernetes owns for storing various configuration files KubernetesDir() string // PatchesDir should point to the folder where patches for components are stored PatchesDir() string // RealManifestPath gets the file path for the component in the "real" static pod manifest directory used by the kubelet RealManifestPath(component string) string // RealManifestDir should point to the static pod manifest directory used by the kubelet RealManifestDir() string // TempManifestPath gets the file path for the component in the temporary directory created for generating new manifests for the upgrade TempManifestPath(component string) string // TempManifestDir should point to the temporary directory created for generating new manifests for the upgrade TempManifestDir() string // BackupManifestPath gets the file path for the component in the backup directory used for backing up manifests during the transition BackupManifestPath(component string) string // BackupManifestDir should point to the backup directory used for backing up manifests during the transition BackupManifestDir() string // BackupEtcdDir should point to the backup directory used for backing up manifests during the transition BackupEtcdDir() string // CleanupDirs cleans up all temporary directories CleanupDirs() error }
StaticPodPathManager is responsible for tracking the directories used in the static pod upgrade transition
func GetPathManagerForUpgrade ¶ added in v1.15.0
func GetPathManagerForUpgrade(kubernetesDir, patchesDir string, internalcfg *kubeadmapi.InitConfiguration, etcdUpgrade bool) (StaticPodPathManager, error)
GetPathManagerForUpgrade returns a path manager properly configured for the given InitConfiguration.
func NewKubeStaticPodPathManager ¶
func NewKubeStaticPodPathManager(kubernetesDir, patchesDir, tempDir, backupDir, backupEtcdDir string, keepManifestDir, keepEtcdDir bool) StaticPodPathManager
NewKubeStaticPodPathManager creates a new instance of KubeStaticPodPathManager
func NewKubeStaticPodPathManagerUsingTempDirs ¶
func NewKubeStaticPodPathManagerUsingTempDirs(kubernetesDir, patchesDir string, saveManifestsDir, saveEtcdDir bool) (StaticPodPathManager, error)
NewKubeStaticPodPathManagerUsingTempDirs creates a new instance of KubeStaticPodPathManager with temporary directories backing it
type Upgrade ¶
type Upgrade struct { Description string Before ClusterState After ClusterState }
Upgrade defines an upgrade possibility to upgrade from a current version to a new one
func GetAvailableUpgrades ¶
func GetAvailableUpgrades(versionGetterImpl VersionGetter, experimentalUpgradesAllowed, rcUpgradesAllowed bool, client clientset.Interface, printer output.Printer) ([]Upgrade, error)
GetAvailableUpgrades fetches all versions from the specified VersionGetter and computes which kinds of upgrades can be performed
func (*Upgrade) CanUpgradeKubelets ¶
CanUpgradeKubelets returns whether an upgrade of any kubelet in the cluster is possible
type VersionGetter ¶
type VersionGetter interface { // ClusterVersion should return the version of the cluster i.e. the API Server version ClusterVersion() (string, *versionutil.Version, error) // KubeadmVersion should return the version of the kubeadm CLI KubeadmVersion() (string, *versionutil.Version, error) // VersionFromCILabel should resolve CI labels like `latest`, `stable`, `stable-1.8`, etc. to real versions VersionFromCILabel(string, string) (string, *versionutil.Version, error) // KubeletVersions should return a map with a version and a list of node names that describes how many kubelets there are for that version KubeletVersions() (map[string][]string, error) // ComponentVersions should return a map with a version and a list of node names that describes how many a given control-plane components there are for that version ComponentVersions(string) (map[string][]string, error) }
VersionGetter defines an interface for fetching different versions. Easy to implement a fake variant of this interface for unit testing
func NewKubeVersionGetter ¶
func NewKubeVersionGetter(client clientset.Interface) VersionGetter
NewKubeVersionGetter returns a new instance of KubeVersionGetter
func NewOfflineVersionGetter ¶ added in v1.11.0
func NewOfflineVersionGetter(versionGetter VersionGetter, version string) VersionGetter
NewOfflineVersionGetter wraps a VersionGetter and skips online communication if default information is supplied. Version can be "" and the behavior will be identical to the versionGetter passed in.
type VersionSkewPolicyErrors ¶
VersionSkewPolicyErrors describes version skew errors that might be seen during the validation process in EnforceVersionPolicies
func EnforceVersionPolicies ¶
func EnforceVersionPolicies(versionGetter VersionGetter, newK8sVersionStr string, newK8sVersion *version.Version, allowExperimentalUpgrades, allowRCUpgrades bool) *VersionSkewPolicyErrors
EnforceVersionPolicies enforces that the proposed new version is compatible with all the different version skew policies