kubeadm

Documentation

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type API
  • func (in *API) DeepCopy() *API
  • func (in *API) DeepCopyInto(out *API)
• type Etcd
  • func (in *Etcd) DeepCopy() *Etcd
  • func (in *Etcd) DeepCopyInto(out *Etcd)
• type HostPathMount
  • func (in *HostPathMount) DeepCopy() *HostPathMount
  • func (in *HostPathMount) DeepCopyInto(out *HostPathMount)
• type MasterConfiguration
  • func (in *MasterConfiguration) DeepCopy() *MasterConfiguration
  • func (in *MasterConfiguration) DeepCopyInto(out *MasterConfiguration)
  • func (in *MasterConfiguration) DeepCopyObject() runtime.Object
  • func (cfg *MasterConfiguration) GetControlPlaneImageRepository() string
• type Networking
  • func (in *Networking) DeepCopy() *Networking
  • func (in *Networking) DeepCopyInto(out *Networking)
• type NodeConfiguration
  • func (in *NodeConfiguration) DeepCopy() *NodeConfiguration
  • func (in *NodeConfiguration) DeepCopyInto(out *NodeConfiguration)
  • func (in *NodeConfiguration) DeepCopyObject() runtime.Object
• type SelfHostedEtcd
  • func (in *SelfHostedEtcd) DeepCopy() *SelfHostedEtcd
  • func (in *SelfHostedEtcd) DeepCopyInto(out *SelfHostedEtcd)
• type TokenDiscovery
  • func (in *TokenDiscovery) DeepCopy() *TokenDiscovery
  • func (in *TokenDiscovery) DeepCopyInto(out *TokenDiscovery)

Constants

const GroupName = "kubeadm.k8s.io"

GroupName is the group name use in this package

const (
	// NodeLabelKubeadmAlphaRole is a label that kubeadm applies to a Node as a hint that it has a particular purpose.
	// Use of NodeLabelRole is preferred.
	NodeLabelKubeadmAlphaRole = "kubeadm.alpha.kubernetes.io/role"
)

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

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type API

type API struct {
	// AdvertiseAddress sets the address for the API server to advertise.
	AdvertiseAddress string
	// BindPort sets the secure port for the API Server to bind to
	BindPort int32
}

API struct contains elements of API server address.

func (*API) DeepCopy

func (in *API) DeepCopy() *API

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

func (*API) DeepCopyInto

func (in *API) DeepCopyInto(out *API)

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

type Etcd

type Etcd struct {
	Endpoints []string
	CAFile    string
	CertFile  string
	KeyFile   string
	DataDir   string
	ExtraArgs map[string]string
	// Image specifies which container image to use for running etcd. If empty, automatically populated by kubeadm using the image repository and default etcd version
	Image      string
	SelfHosted *SelfHostedEtcd
}

Etcd contains elements describing Etcd configuration

func (*Etcd) DeepCopy

func (in *Etcd) DeepCopy() *Etcd

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

func (*Etcd) DeepCopyInto

func (in *Etcd) DeepCopyInto(out *Etcd)

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

type HostPathMount

type HostPathMount struct {
	Name      string
	HostPath  string
	MountPath string
}

HostPathMount contains elements describing volumes that are mounted from the host

func (*HostPathMount) DeepCopy

func (in *HostPathMount) DeepCopy() *HostPathMount

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

func (*HostPathMount) DeepCopyInto

func (in *HostPathMount) DeepCopyInto(out *HostPathMount)

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

type MasterConfiguration

type MasterConfiguration struct {
	metav1.TypeMeta

	API                API
	Etcd               Etcd
	Networking         Networking
	KubernetesVersion  string
	CloudProvider      string
	NodeName           string
	AuthorizationModes []string

	Token    string
	TokenTTL *metav1.Duration

	APIServerExtraArgs         map[string]string
	ControllerManagerExtraArgs map[string]string
	SchedulerExtraArgs         map[string]string

	APIServerExtraVolumes         []HostPathMount
	ControllerManagerExtraVolumes []HostPathMount
	SchedulerExtraVolumes         []HostPathMount

	// APIServerCertSANs sets extra Subject Alternative Names for the API Server signing cert
	APIServerCertSANs []string
	// CertificatesDir specifies where to store or look for all required certificates
	CertificatesDir string

	// ImageRepository what container registry to pull control plane images from
	ImageRepository string

	// Container registry for core images generated by CI
	// +k8s:conversion-gen=false
	CIImageRepository string

	// UnifiedControlPlaneImage specifies if a specific container image should be used for all control plane components
	UnifiedControlPlaneImage string

	// FeatureGates enabled by the user
	FeatureGates map[string]bool
}

MasterConfiguration contains a list of elements which make up master's configuration object.

func (*MasterConfiguration) DeepCopy

func (in *MasterConfiguration) DeepCopy() *MasterConfiguration

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

func (*MasterConfiguration) DeepCopyInto

func (in *MasterConfiguration) DeepCopyInto(out *MasterConfiguration)

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

func (*MasterConfiguration) DeepCopyObject

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

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

func (*MasterConfiguration) GetControlPlaneImageRepository

func (cfg *MasterConfiguration) GetControlPlaneImageRepository() string

GetControlPlaneImageRepository returns name of image repository for control plane images (API,Controller Manager,Scheduler and Proxy) It will override location with CI registry name in case user requests special Kubernetes version from CI build area. (See: kubeadmconstants.DefaultCIImageRepository)

type Networking

type Networking struct {
	ServiceSubnet string
	PodSubnet     string
	DNSDomain     string
}

Networking contains elements describing cluster's networking configuration

func (*Networking) DeepCopy

func (in *Networking) DeepCopy() *Networking

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

func (*Networking) DeepCopyInto

func (in *Networking) DeepCopyInto(out *Networking)

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

type NodeConfiguration

type NodeConfiguration struct {
	metav1.TypeMeta

	CACertPath     string
	DiscoveryFile  string
	DiscoveryToken string
	// Currently we only pay attention to one api server but hope to support >1 in the future
	DiscoveryTokenAPIServers []string
	NodeName                 string
	TLSBootstrapToken        string
	Token                    string

	// DiscoveryTokenCACertHashes specifies a set of public key pins to verify
	// when token-based discovery is used. The root CA found during discovery
	// must match one of these values. Specifying an empty set disables root CA
	// pinning, which can be unsafe. Each hash is specified as "<type>:<value>",
	// where the only currently supported type is "sha256". This is a hex-encoded
	// SHA-256 hash of the Subject Public Key Info (SPKI) object in DER-encoded
	// ASN.1. These hashes can be calculated using, for example, OpenSSL:
	// openssl x509 -pubkey -in ca.crt openssl rsa -pubin -outform der 2>&/dev/null | openssl dgst -sha256 -hex
	DiscoveryTokenCACertHashes []string

	// DiscoveryTokenUnsafeSkipCAVerification allows token-based discovery
	// without CA verification via DiscoveryTokenCACertHashes. This can weaken
	// the security of kubeadm since other nodes can impersonate the master.
	DiscoveryTokenUnsafeSkipCAVerification bool
}

NodeConfiguration contains elements describing a particular node

func (*NodeConfiguration) DeepCopy

func (in *NodeConfiguration) DeepCopy() *NodeConfiguration

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

func (*NodeConfiguration) DeepCopyInto

func (in *NodeConfiguration) DeepCopyInto(out *NodeConfiguration)

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

func (*NodeConfiguration) DeepCopyObject

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

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

type SelfHostedEtcd

type SelfHostedEtcd struct {
	// CertificatesDir represents the directory where all etcd TLS assets are stored. By default this is
	// a dir names "etcd" in the main CertificatesDir value.
	CertificatesDir string
	// ClusterServiceName is the name of the service that load balances the etcd cluster
	ClusterServiceName string
	// EtcdVersion is the version of etcd running in the cluster.
	EtcdVersion string
	// OperatorVersion is the version of the etcd-operator to use.
	OperatorVersion string
}

SelfHostedEtcd describes options required to configure self-hosted etcd

func (*SelfHostedEtcd) DeepCopy

func (in *SelfHostedEtcd) DeepCopy() *SelfHostedEtcd

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

func (*SelfHostedEtcd) DeepCopyInto

func (in *SelfHostedEtcd) DeepCopyInto(out *SelfHostedEtcd)

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

type TokenDiscovery

type TokenDiscovery struct {
	ID        string
	Secret    string
	Addresses []string
}

TokenDiscovery contains elements needed for token discovery

func (*TokenDiscovery) DeepCopy

func (in *TokenDiscovery) DeepCopy() *TokenDiscovery

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

func (*TokenDiscovery) DeepCopyInto

func (in *TokenDiscovery) DeepCopyInto(out *TokenDiscovery)

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