output

Documentation

Overview

Package output implements the kubeadm 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.

Index

• Constants
• Variables
• type AvailableUpgrade
  • func (in *AvailableUpgrade) DeepCopy() *AvailableUpgrade
  • func (in *AvailableUpgrade) DeepCopyInto(out *AvailableUpgrade)
  • func (in *AvailableUpgrade) DeepCopyObject() runtime.Object
• type BootstrapToken
  • func (in *BootstrapToken) DeepCopy() *BootstrapToken
  • func (in *BootstrapToken) DeepCopyInto(out *BootstrapToken)
  • func (in *BootstrapToken) DeepCopyObject() runtime.Object
• type Certificate
  • func (in *Certificate) DeepCopy() *Certificate
  • func (in *Certificate) DeepCopyInto(out *Certificate)
• type CertificateExpirationInfo
  • func (in *CertificateExpirationInfo) DeepCopy() *CertificateExpirationInfo
  • func (in *CertificateExpirationInfo) DeepCopyInto(out *CertificateExpirationInfo)
  • func (in *CertificateExpirationInfo) DeepCopyObject() runtime.Object
• type ComponentConfigVersionState
  • func (in *ComponentConfigVersionState) DeepCopy() *ComponentConfigVersionState
  • func (in *ComponentConfigVersionState) DeepCopyInto(out *ComponentConfigVersionState)
• type ComponentUpgradePlan
  • func (in *ComponentUpgradePlan) DeepCopy() *ComponentUpgradePlan
  • func (in *ComponentUpgradePlan) DeepCopyInto(out *ComponentUpgradePlan)
  • func (in *ComponentUpgradePlan) DeepCopyObject() runtime.Object
• type Images
  • func (in *Images) DeepCopy() *Images
  • func (in *Images) DeepCopyInto(out *Images)
  • func (in *Images) DeepCopyObject() runtime.Object
• type UpgradePlan
  • func (in *UpgradePlan) DeepCopy() *UpgradePlan
  • func (in *UpgradePlan) DeepCopyInto(out *UpgradePlan)
  • func (in *UpgradePlan) DeepCopyObject() runtime.Object

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.NewSchemeBuilder(addKnownTypes)
	// AddToScheme applies all the stored functions to the scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Types

type AvailableUpgrade

type AvailableUpgrade struct {
	metav1.TypeMeta

	Description string

	Components []ComponentUpgradePlan
}

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

	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

	// ExpirationDate defines certificate expiration date in UTC following the RFC3339 format.
	ExpirationDate metav1.Time

	// ResidualTimeSeconds represents the duration in seconds relative to the residual time before expiration.
	ResidualTimeSeconds int64

	// ExternallyManaged defines if the certificate is externally managed.
	ExternallyManaged bool

	// CAName represents the name of the CA that signed the certificate.
	// This field is empty for self-signed, root CA certificates.
	CAName string

	// Missing represents if the certificate is missing.
	Missing bool
}

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

	// CertificateAuthorities holds a list of certificate authorities to show expiration information for.
	CertificateAuthorities []Certificate
}

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

	// 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

	// 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

	// 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
}

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
	CurrentVersion string
	NewVersion     string
	NodeName       string
}

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

type Images struct {
	metav1.TypeMeta

	Images []string
}

Images represents information for the output produced by 'kubeadm config images list'

func (*Images) DeepCopy

func (in *Images) DeepCopy() *Images

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Images.

func (*Images) DeepCopyInto

func (in *Images) DeepCopyInto(out *Images)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Images) DeepCopyObject

func (in *Images) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type UpgradePlan

type UpgradePlan struct {
	metav1.TypeMeta

	AvailableUpgrades []AvailableUpgrade

	ConfigVersions []ComponentConfigVersionState

	// TODO: Remove this field when v1alpha2 is removed
	Components []ComponentUpgradePlan
}

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.