features

Documentation

Index

• Constants
• Variables
• func CheckDeprecatedFlags(f *FeatureList, features map[string]bool) map[string]string
• func Enabled(featureList map[string]bool, featureName string) bool
• func KnownFeatures(f *FeatureList) []string
• func NewFeatureGate(f *FeatureList, value string) (map[string]bool, error)
• func Supports(featureList FeatureList, featureName string) bool
• func ValidateVersion(allFeatures FeatureList, requestedFeatures map[string]bool, ...) error
• type Feature
• type FeatureList

Constants

const (
	// PublicKeysECDSA is expected to be alpha in v1.19
	PublicKeysECDSA = "PublicKeysECDSA"
	// RootlessControlPlane is expected to be in alpha in v1.22
	RootlessControlPlane = "RootlessControlPlane"
	// EtcdLearnerMode is expected to be in alpha in v1.27, beta in v1.29, ga in v1.32
	EtcdLearnerMode = "EtcdLearnerMode"
	// WaitForAllControlPlaneComponents is expected to be alpha in v1.30
	WaitForAllControlPlaneComponents = "WaitForAllControlPlaneComponents"
	// ControlPlaneKubeletLocalMode is expected to be in alpha in v1.31, beta in v1.32
	ControlPlaneKubeletLocalMode = "ControlPlaneKubeletLocalMode"
	// NodeLocalCRISocket is expected to be in alpha in v1.32, beta in v1.33, ga in v1.35
	NodeLocalCRISocket = "NodeLocalCRISocket"
)

Variables

var InitFeatureGates = FeatureList{
	PublicKeysECDSA: {
		FeatureSpec: featuregate.FeatureSpec{Default: false, PreRelease: featuregate.Deprecated},
		DeprecationMessage: "The PublicKeysECDSA feature gate is deprecated and will be removed when v1beta3 is removed." +
			" v1beta4 supports a new option 'ClusterConfiguration.EncryptionAlgorithm'.",
	},
	RootlessControlPlane: {FeatureSpec: featuregate.FeatureSpec{Default: false, PreRelease: featuregate.Alpha},
		DeprecationMessage: "Deprecated in favor of the core kubelet feature UserNamespacesSupport which is beta since 1.30." +
			" Once UserNamespacesSupport graduates to GA, kubeadm will start using it and RootlessControlPlane will be removed.",
	},
	EtcdLearnerMode:                  {FeatureSpec: featuregate.FeatureSpec{Default: true, PreRelease: featuregate.GA, LockToDefault: true}},
	WaitForAllControlPlaneComponents: {FeatureSpec: featuregate.FeatureSpec{Default: false, PreRelease: featuregate.Alpha}},
	ControlPlaneKubeletLocalMode:     {FeatureSpec: featuregate.FeatureSpec{Default: false, PreRelease: featuregate.Alpha}},
	NodeLocalCRISocket:               {FeatureSpec: featuregate.FeatureSpec{Default: false, PreRelease: featuregate.Alpha}},
}

InitFeatureGates are the default feature gates for the init command

Functions

func CheckDeprecatedFlags

func CheckDeprecatedFlags(f *FeatureList, features map[string]bool) map[string]string

CheckDeprecatedFlags takes a list of existing feature gate flags and validates against the current feature flag set. It used during upgrades for ensuring consistency of feature gates used in an existing cluster, that might be created with a previous version of kubeadm, with the set of features currently supported by kubeadm

func Enabled

func Enabled(featureList map[string]bool, featureName string) bool

Enabled indicates whether a feature name has been enabled

func KnownFeatures

func KnownFeatures(f *FeatureList) []string

KnownFeatures returns a slice of strings describing the FeatureList features.

func NewFeatureGate

func NewFeatureGate(f *FeatureList, value string) (map[string]bool, error)

NewFeatureGate parses a string of the form "key1=value1,key2=value2,..." into a map[string]bool of known keys or returns an error.

func Supports

func Supports(featureList FeatureList, featureName string) bool

Supports indicates whether a feature name is supported on the given feature set

func ValidateVersion

func ValidateVersion(allFeatures FeatureList, requestedFeatures map[string]bool, requestedVersion string) error

ValidateVersion ensures that a feature gate list is compatible with the chosen Kubernetes version

Types

type Feature

type Feature struct {
	featuregate.FeatureSpec
	MinimumVersion     *version.Version
	HiddenInHelpText   bool
	DeprecationMessage string
}

Feature represents a feature being gated

type FeatureList

type FeatureList map[string]Feature

FeatureList represents a list of feature gates