Documentation
¶
Overview ¶
Package v1alpha3 defines the v1alpha3 version of the kubeadm data structures related to structured output The purpose of the kubeadm structured output is to have a well defined versioned output format that other software that uses kubeadm for cluster deployments can use and rely on.
Changes since v1alpha2:
- Added support for outputting certificate expiration information for "kubeadm certs check-expiration" with the CertificateExpirationInfo structure.
- Introduce a (breaking) change to the UpgradePlan structure used by "kubeadm upgrade plan". UpgradePlan now contains a list of AvailableUpgrade structures.
Index ¶
- Constants
- Variables
- func Convert_output_AvailableUpgrade_To_v1alpha3_AvailableUpgrade(in *output.AvailableUpgrade, out *AvailableUpgrade, s conversion.Scope) error
- func Convert_output_BootstrapToken_To_v1alpha3_BootstrapToken(in *output.BootstrapToken, out *BootstrapToken, s conversion.Scope) error
- func Convert_output_CertificateExpirationInfo_To_v1alpha3_CertificateExpirationInfo(in *output.CertificateExpirationInfo, out *CertificateExpirationInfo, ...) error
- func Convert_output_Certificate_To_v1alpha3_Certificate(in *output.Certificate, out *Certificate, s conversion.Scope) error
- func Convert_output_ComponentConfigVersionState_To_v1alpha3_ComponentConfigVersionState(in *output.ComponentConfigVersionState, out *ComponentConfigVersionState, ...) error
- func Convert_output_ComponentUpgradePlan_To_v1alpha3_ComponentUpgradePlan(in *output.ComponentUpgradePlan, out *ComponentUpgradePlan, s conversion.Scope) error
- func Convert_output_Images_To_v1alpha3_Images(in *output.Images, out *Images, s conversion.Scope) error
- func Convert_output_UpgradePlan_To_v1alpha3_UpgradePlan(in *output.UpgradePlan, out *UpgradePlan, s conversion.Scope) error
- func Convert_v1alpha3_AvailableUpgrade_To_output_AvailableUpgrade(in *AvailableUpgrade, out *output.AvailableUpgrade, s conversion.Scope) error
- func Convert_v1alpha3_BootstrapToken_To_output_BootstrapToken(in *BootstrapToken, out *output.BootstrapToken, s conversion.Scope) error
- func Convert_v1alpha3_CertificateExpirationInfo_To_output_CertificateExpirationInfo(in *CertificateExpirationInfo, out *output.CertificateExpirationInfo, ...) error
- func Convert_v1alpha3_Certificate_To_output_Certificate(in *Certificate, out *output.Certificate, s conversion.Scope) error
- func Convert_v1alpha3_ComponentConfigVersionState_To_output_ComponentConfigVersionState(in *ComponentConfigVersionState, out *output.ComponentConfigVersionState, ...) error
- func Convert_v1alpha3_ComponentUpgradePlan_To_output_ComponentUpgradePlan(in *ComponentUpgradePlan, out *output.ComponentUpgradePlan, s conversion.Scope) error
- func Convert_v1alpha3_Images_To_output_Images(in *Images, out *output.Images, s conversion.Scope) error
- func Convert_v1alpha3_UpgradePlan_To_output_UpgradePlan(in *UpgradePlan, out *output.UpgradePlan, s conversion.Scope) error
- func RegisterConversions(s *runtime.Scheme) error
- type AvailableUpgrade
- type BootstrapToken
- type Certificate
- type CertificateExpirationInfo
- type ComponentConfigVersionState
- type ComponentUpgradePlan
- type Images
- type UpgradePlan
Constants ¶
const GroupName = "output.kubeadm.k8s.io"
GroupName is the group name use in this package
Variables ¶
var ( // SchemeBuilder points to a list of functions added to Scheme. SchemeBuilder runtime.SchemeBuilder // AddToScheme applies all the stored functions to the scheme. AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha3"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Convert_output_AvailableUpgrade_To_v1alpha3_AvailableUpgrade ¶
func Convert_output_AvailableUpgrade_To_v1alpha3_AvailableUpgrade(in *output.AvailableUpgrade, out *AvailableUpgrade, s conversion.Scope) error
Convert_output_AvailableUpgrade_To_v1alpha3_AvailableUpgrade is an autogenerated conversion function.
func Convert_output_BootstrapToken_To_v1alpha3_BootstrapToken ¶
func Convert_output_BootstrapToken_To_v1alpha3_BootstrapToken(in *output.BootstrapToken, out *BootstrapToken, s conversion.Scope) error
Convert_output_BootstrapToken_To_v1alpha3_BootstrapToken is an autogenerated conversion function.
func Convert_output_CertificateExpirationInfo_To_v1alpha3_CertificateExpirationInfo ¶
func Convert_output_CertificateExpirationInfo_To_v1alpha3_CertificateExpirationInfo(in *output.CertificateExpirationInfo, out *CertificateExpirationInfo, s conversion.Scope) error
Convert_output_CertificateExpirationInfo_To_v1alpha3_CertificateExpirationInfo is an autogenerated conversion function.
func Convert_output_Certificate_To_v1alpha3_Certificate ¶
func Convert_output_Certificate_To_v1alpha3_Certificate(in *output.Certificate, out *Certificate, s conversion.Scope) error
Convert_output_Certificate_To_v1alpha3_Certificate is an autogenerated conversion function.
func Convert_output_ComponentConfigVersionState_To_v1alpha3_ComponentConfigVersionState ¶
func Convert_output_ComponentConfigVersionState_To_v1alpha3_ComponentConfigVersionState(in *output.ComponentConfigVersionState, out *ComponentConfigVersionState, s conversion.Scope) error
Convert_output_ComponentConfigVersionState_To_v1alpha3_ComponentConfigVersionState is an autogenerated conversion function.
func Convert_output_ComponentUpgradePlan_To_v1alpha3_ComponentUpgradePlan ¶
func Convert_output_ComponentUpgradePlan_To_v1alpha3_ComponentUpgradePlan(in *output.ComponentUpgradePlan, out *ComponentUpgradePlan, s conversion.Scope) error
Convert_output_ComponentUpgradePlan_To_v1alpha3_ComponentUpgradePlan is an autogenerated conversion function.
func Convert_output_Images_To_v1alpha3_Images ¶
func Convert_output_Images_To_v1alpha3_Images(in *output.Images, out *Images, s conversion.Scope) error
Convert_output_Images_To_v1alpha3_Images is an autogenerated conversion function.
func Convert_output_UpgradePlan_To_v1alpha3_UpgradePlan ¶
func Convert_output_UpgradePlan_To_v1alpha3_UpgradePlan(in *output.UpgradePlan, out *UpgradePlan, s conversion.Scope) error
Convert_output_UpgradePlan_To_v1alpha3_UpgradePlan is an autogenerated conversion function.
func Convert_v1alpha3_AvailableUpgrade_To_output_AvailableUpgrade ¶
func Convert_v1alpha3_AvailableUpgrade_To_output_AvailableUpgrade(in *AvailableUpgrade, out *output.AvailableUpgrade, s conversion.Scope) error
Convert_v1alpha3_AvailableUpgrade_To_output_AvailableUpgrade is an autogenerated conversion function.
func Convert_v1alpha3_BootstrapToken_To_output_BootstrapToken ¶
func Convert_v1alpha3_BootstrapToken_To_output_BootstrapToken(in *BootstrapToken, out *output.BootstrapToken, s conversion.Scope) error
Convert_v1alpha3_BootstrapToken_To_output_BootstrapToken is an autogenerated conversion function.
func Convert_v1alpha3_CertificateExpirationInfo_To_output_CertificateExpirationInfo ¶
func Convert_v1alpha3_CertificateExpirationInfo_To_output_CertificateExpirationInfo(in *CertificateExpirationInfo, out *output.CertificateExpirationInfo, s conversion.Scope) error
Convert_v1alpha3_CertificateExpirationInfo_To_output_CertificateExpirationInfo is an autogenerated conversion function.
func Convert_v1alpha3_Certificate_To_output_Certificate ¶
func Convert_v1alpha3_Certificate_To_output_Certificate(in *Certificate, out *output.Certificate, s conversion.Scope) error
Convert_v1alpha3_Certificate_To_output_Certificate is an autogenerated conversion function.
func Convert_v1alpha3_ComponentConfigVersionState_To_output_ComponentConfigVersionState ¶
func Convert_v1alpha3_ComponentConfigVersionState_To_output_ComponentConfigVersionState(in *ComponentConfigVersionState, out *output.ComponentConfigVersionState, s conversion.Scope) error
Convert_v1alpha3_ComponentConfigVersionState_To_output_ComponentConfigVersionState is an autogenerated conversion function.
func Convert_v1alpha3_ComponentUpgradePlan_To_output_ComponentUpgradePlan ¶
func Convert_v1alpha3_ComponentUpgradePlan_To_output_ComponentUpgradePlan(in *ComponentUpgradePlan, out *output.ComponentUpgradePlan, s conversion.Scope) error
Convert_v1alpha3_ComponentUpgradePlan_To_output_ComponentUpgradePlan is an autogenerated conversion function.
func Convert_v1alpha3_Images_To_output_Images ¶
func Convert_v1alpha3_Images_To_output_Images(in *Images, out *output.Images, s conversion.Scope) error
Convert_v1alpha3_Images_To_output_Images is an autogenerated conversion function.
func Convert_v1alpha3_UpgradePlan_To_output_UpgradePlan ¶
func Convert_v1alpha3_UpgradePlan_To_output_UpgradePlan(in *UpgradePlan, out *output.UpgradePlan, s conversion.Scope) error
Convert_v1alpha3_UpgradePlan_To_output_UpgradePlan is an autogenerated conversion function.
func RegisterConversions ¶
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
Types ¶
type AvailableUpgrade ¶
type AvailableUpgrade struct {
metav1.TypeMeta
Description string `json:"description"`
Components []ComponentUpgradePlan `json:"components"`
}
AvailableUpgrade represents information for a single available upgrade.
func (*AvailableUpgrade) DeepCopy ¶
func (in *AvailableUpgrade) DeepCopy() *AvailableUpgrade
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AvailableUpgrade.
func (*AvailableUpgrade) DeepCopyInto ¶
func (in *AvailableUpgrade) DeepCopyInto(out *AvailableUpgrade)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AvailableUpgrade) DeepCopyObject ¶
func (in *AvailableUpgrade) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BootstrapToken ¶
type BootstrapToken struct {
metav1.TypeMeta `json:",inline"`
bootstraptokenv1.BootstrapToken
}
BootstrapToken represents information for the bootstrap token output produced by kubeadm
func (*BootstrapToken) DeepCopy ¶
func (in *BootstrapToken) DeepCopy() *BootstrapToken
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BootstrapToken.
func (*BootstrapToken) DeepCopyInto ¶
func (in *BootstrapToken) DeepCopyInto(out *BootstrapToken)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BootstrapToken) DeepCopyObject ¶
func (in *BootstrapToken) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Certificate ¶
type Certificate struct {
// Name of the certificate.
Name string `json:"name"`
// ExpirationDate defines certificate expiration date in UTC following the RFC3339 format.
ExpirationDate metav1.Time `json:"expirationDate"`
// ResidualTimeSeconds represents the duration in seconds relative to the residual time before expiration.
ResidualTimeSeconds int64 `json:"residualTime"`
// ExternallyManaged defines if the certificate is externally managed.
ExternallyManaged bool `json:"externallyManaged"`
// CAName represents the name of the CA that signed the certificate.
// This field is empty for self-signed, root CA certificates.
CAName string `json:"caName,omitempty"`
// Missing represents if the certificate is missing.
Missing bool `json:"missing"`
}
Certificate represents information for a certificate or a certificate authority when using the check-expiration command.
func (*Certificate) DeepCopy ¶
func (in *Certificate) DeepCopy() *Certificate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Certificate.
func (*Certificate) DeepCopyInto ¶
func (in *Certificate) DeepCopyInto(out *Certificate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateExpirationInfo ¶
type CertificateExpirationInfo struct {
metav1.TypeMeta
// Certificates holds a list of certificates to show expiration information for.
Certificates []Certificate `json:"certificates"`
// CertificateAuthorities holds a list of certificate authorities to show expiration information for.
CertificateAuthorities []Certificate `json:"certificateAuthorities"`
}
CertificateExpirationInfo represents information for the output produced by 'kubeadm certs check-expiration'.
func (*CertificateExpirationInfo) DeepCopy ¶
func (in *CertificateExpirationInfo) DeepCopy() *CertificateExpirationInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateExpirationInfo.
func (*CertificateExpirationInfo) DeepCopyInto ¶
func (in *CertificateExpirationInfo) DeepCopyInto(out *CertificateExpirationInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CertificateExpirationInfo) DeepCopyObject ¶
func (in *CertificateExpirationInfo) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ComponentConfigVersionState ¶
type ComponentConfigVersionState struct {
// Group points to the Kubernetes API group that covers the config
Group string `json:"group"`
// CurrentVersion is the currently active component config version
// NOTE: This can be empty in case the config was not found on the cluster or it was unsupported
// kubeadm generated version
CurrentVersion string `json:"currentVersion"`
// PreferredVersion is the component config version that is currently preferred by kubeadm for use.
// NOTE: As of today, this is the only version supported by kubeadm.
PreferredVersion string `json:"preferredVersion"`
// ManualUpgradeRequired indicates if users need to manually upgrade their component config versions. This happens if
// the CurrentVersion of the config is user supplied (or modified) and no longer supported. Users should upgrade
// their component configs to PreferredVersion or any other supported component config version.
ManualUpgradeRequired bool `json:"manualUpgradeRequired"`
}
ComponentConfigVersionState describes the current and desired version of a component config
func (*ComponentConfigVersionState) DeepCopy ¶
func (in *ComponentConfigVersionState) DeepCopy() *ComponentConfigVersionState
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentConfigVersionState.
func (*ComponentConfigVersionState) DeepCopyInto ¶
func (in *ComponentConfigVersionState) DeepCopyInto(out *ComponentConfigVersionState)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentUpgradePlan ¶
type ComponentUpgradePlan struct {
metav1.TypeMeta
Name string `json:"name"`
CurrentVersion string `json:"currentVersion"`
NewVersion string `json:"newVersion"`
NodeName string `json:"nodeName,omitempty"`
}
ComponentUpgradePlan represents information about upgrade plan for one component
func (*ComponentUpgradePlan) DeepCopy ¶
func (in *ComponentUpgradePlan) DeepCopy() *ComponentUpgradePlan
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentUpgradePlan.
func (*ComponentUpgradePlan) DeepCopyInto ¶
func (in *ComponentUpgradePlan) DeepCopyInto(out *ComponentUpgradePlan)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ComponentUpgradePlan) DeepCopyObject ¶
func (in *ComponentUpgradePlan) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Images ¶
Images represents information for the output produced by 'kubeadm config images list'
func (*Images) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Images.
func (*Images) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Images) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UpgradePlan ¶
type UpgradePlan struct {
metav1.TypeMeta
AvailableUpgrades []AvailableUpgrade `json:"availableUpgrades,omitempty"`
ConfigVersions []ComponentConfigVersionState `json:"configVersions,omitempty"`
}
UpgradePlan represents information about upgrade plan for the output produced by 'kubeadm upgrade plan'
func (*UpgradePlan) DeepCopy ¶
func (in *UpgradePlan) DeepCopy() *UpgradePlan
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UpgradePlan.
func (*UpgradePlan) DeepCopyInto ¶
func (in *UpgradePlan) DeepCopyInto(out *UpgradePlan)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UpgradePlan) DeepCopyObject ¶
func (in *UpgradePlan) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.