Documentation ¶
Index ¶
- Constants
- Variables
- func AddToScheme(scheme *runtime.Scheme)
- func ChecksumForConfigMap(cm *v1.ConfigMap) string
- func Default(clusterCfg *kubeadmapi.ClusterConfiguration, ...)
- func FetchFromCluster(clusterCfg *kubeadmapi.ClusterConfiguration, client clientset.Interface) error
- func FetchFromDocumentMap(clusterCfg *kubeadmapi.ClusterConfiguration, docmap kubeadmapi.DocumentMap) error
- func GetVersionStates(clusterCfg *kubeadmapi.ClusterConfiguration, client clientset.Interface) ([]outputapiv1alpha3.ComponentConfigVersionState, error)
- func SignConfigMap(cm *v1.ConfigMap)
- func Validate(clusterCfg *kubeadmapi.ClusterConfiguration) field.ErrorList
- func VerifyConfigMapSignature(cm *v1.ConfigMap) bool
- type UnsupportedConfigVersionError
- type UnsupportedConfigVersionsErrorMap
Constants ¶
const ( // KubeProxyGroup is a pointer to the used API group name for the kube-proxy config KubeProxyGroup = kubeproxyconfig.GroupName )
const ( // KubeletGroup is a pointer to the used API group name for the kubelet config KubeletGroup = kubeletconfig.GroupName )
Variables ¶
var Codecs = serializer.NewCodecFactory(Scheme)
Codecs provides access to encoding and decoding for the scheme.
var Scheme = runtime.NewScheme()
Scheme is the runtime.Scheme to which all supported kubeadm ComponentConfig API types are registered.
Functions ¶
func AddToScheme ¶
AddToScheme builds the kubeadm ComponentConfig scheme using all known ComponentConfig versions.
func ChecksumForConfigMap ¶ added in v1.19.0
ChecksumForConfigMap calculates a checksum for the supplied config map. The exact algorithm depends on hash and prefix parameters
func Default ¶ added in v1.18.0
func Default(clusterCfg *kubeadmapi.ClusterConfiguration, localAPIEndpoint *kubeadmapi.APIEndpoint, nodeRegOpts *kubeadmapi.NodeRegistrationOptions)
Default sets up defaulted component configs in the supplied ClusterConfiguration
func FetchFromCluster ¶ added in v1.18.0
func FetchFromCluster(clusterCfg *kubeadmapi.ClusterConfiguration, client clientset.Interface) error
FetchFromCluster attempts to fetch all known component configs from their config maps and store them in the supplied ClusterConfiguration
func FetchFromDocumentMap ¶ added in v1.18.0
func FetchFromDocumentMap(clusterCfg *kubeadmapi.ClusterConfiguration, docmap kubeadmapi.DocumentMap) error
FetchFromDocumentMap attempts to load all known component configs from a document map into the supplied ClusterConfiguration
func GetVersionStates ¶ added in v1.19.0
func GetVersionStates(clusterCfg *kubeadmapi.ClusterConfiguration, client clientset.Interface) ([]outputapiv1alpha3.ComponentConfigVersionState, error)
GetVersionStates returns a slice of ComponentConfigVersionState structs describing all supported component config groups that were identified on the cluster
func SignConfigMap ¶ added in v1.19.0
SignConfigMap calculates the supplied config map checksum and annotates it with it
func Validate ¶ added in v1.18.0
func Validate(clusterCfg *kubeadmapi.ClusterConfiguration) field.ErrorList
Validate is a placeholder for performing a validation on an already loaded component configs in a ClusterConfiguration TODO: investigate if the function can be repurposed for validating component config via CLI
func VerifyConfigMapSignature ¶ added in v1.19.0
VerifyConfigMapSignature returns true if the config map has checksum annotation and it matches; false otherwise
Types ¶
type UnsupportedConfigVersionError ¶ added in v1.19.0
type UnsupportedConfigVersionError struct { // OldVersion is the config version that is causing the problem OldVersion schema.GroupVersion // CurrentVersion describes the natively supported config version CurrentVersion schema.GroupVersion // Document points to the YAML/JSON document that caused the problem Document []byte }
UnsupportedConfigVersionError is a special error type returned whenever we encounter too old config version
func (*UnsupportedConfigVersionError) Error ¶ added in v1.19.0
func (err *UnsupportedConfigVersionError) Error() string
Error implements the standard Golang error interface for UnsupportedConfigVersionError
type UnsupportedConfigVersionsErrorMap ¶ added in v1.19.0
type UnsupportedConfigVersionsErrorMap map[string]*UnsupportedConfigVersionError
UnsupportedConfigVersionsErrorMap is a cumulative version of the UnsupportedConfigVersionError type
func (UnsupportedConfigVersionsErrorMap) Error ¶ added in v1.19.0
func (errs UnsupportedConfigVersionsErrorMap) Error() string
Error implements the standard Golang error interface for UnsupportedConfigVersionsErrorMap