cluster-api: sigs.k8s.io/cluster-api/controlplane/kubeadm/internal Index | Files | Directories

package internal

import "sigs.k8s.io/cluster-api/controlplane/kubeadm/internal"

Index

Package Files

cluster.go cluster_labels.go control_plane.go etcd_client_generator.go failure_domain.go kubeadm_config_map.go machine_collection.go workload_cluster.go workload_cluster_coredns.go workload_cluster_etcd.go workload_cluster_rbac.go

Constants

const (
    // NodeBootstrapTokenAuthGroup specifies which group a Node Bootstrap Token should be authenticated in
    NodeBootstrapTokenAuthGroup = "system:bootstrappers:kubeadm:default-node-token"

    // GetNodesClusterRoleName defines the name of the ClusterRole and ClusterRoleBinding to get nodes
    GetNodesClusterRoleName = "kubeadm:get-nodes"

    // NodesGroup defines the well-known group for all nodes.
    NodesGroup = "system:nodes"

    // KubeletConfigMapRolePrefix defines base kubelet configuration ConfigMap role prefix.
    KubeletConfigMapRolePrefix = "kubeadm:"

    // KubeletConfigMapName defines base kubelet configuration ConfigMap name.
    KubeletConfigMapName = "kubelet-config-%d.%d"
)

Variables

var (
    ErrControlPlaneMinNodes = errors.New("cluster has fewer than 2 control plane nodes; removing an etcd member is not supported")
)
var Log = klogr.New()

Log is the global logger for the internal package.

func ControlPlaneLabelsForCluster Uses

func ControlPlaneLabelsForCluster(clusterName string) map[string]string

ControlPlaneLabelsForCluster returns a set of labels to add to a control plane machine for this specific cluster.

func PickFewest Uses

func PickFewest(failureDomains clusterv1.FailureDomains, machines FilterableMachineCollection) *string

PickFewest returns the failure domain with the fewest number of machines.

func PickMost Uses

func PickMost(c *ControlPlane, machines FilterableMachineCollection) *string

PickMost returns a failure domain that is in machines and has most control-plane machines on.

type ClusterStatus Uses

type ClusterStatus struct {
    // Nodes are a total count of nodes
    Nodes int32
    // ReadyNodes are the count of nodes that are reporting ready
    ReadyNodes int32
    // HasKubeadmConfig will be true if the kubeadm config map has been uploaded, false otherwise.
    HasKubeadmConfig bool
}

ClusterStatus holds stats information about the cluster.

type ControlPlane Uses

type ControlPlane struct {
    KCP      *controlplanev1.KubeadmControlPlane
    Cluster  *clusterv1.Cluster
    Machines FilterableMachineCollection
    // contains filtered or unexported fields
}

ControlPlane holds business logic around control planes. It should never need to connect to a service, that responsibility lies outside of this struct. Going forward we should be trying to add more logic to here and reduce the amount of logic in the reconciler.

func NewControlPlane Uses

func NewControlPlane(ctx context.Context, client client.Client, cluster *clusterv1.Cluster, kcp *controlplanev1.KubeadmControlPlane, ownedMachines FilterableMachineCollection) (*ControlPlane, error)

NewControlPlane returns an instantiated ControlPlane.

func (*ControlPlane) AsOwnerReference Uses

func (c *ControlPlane) AsOwnerReference() *metav1.OwnerReference

AsOwnerReference returns an owner reference to the KubeadmControlPlane.

func (*ControlPlane) EtcdImageData Uses

func (c *ControlPlane) EtcdImageData() (string, string)

EtcdImageData returns the etcd image data embedded in the ClusterConfiguration or empty strings if none are defined.

func (*ControlPlane) FailureDomainWithMostMachines Uses

func (c *ControlPlane) FailureDomainWithMostMachines(machines FilterableMachineCollection) *string

FailureDomainWithMostMachines returns a fd which exists both in machines and control-plane machines and has the most control-plane machines on it.

func (*ControlPlane) FailureDomains Uses

func (c *ControlPlane) FailureDomains() clusterv1.FailureDomains

FailureDomains returns a slice of failure domain objects synced from the infrastructure provider into Cluster.Status.

func (*ControlPlane) GenerateKubeadmConfig Uses

func (c *ControlPlane) GenerateKubeadmConfig(spec *bootstrapv1.KubeadmConfigSpec) *bootstrapv1.KubeadmConfig

GenerateKubeadmConfig generates a new kubeadm config for creating new control plane nodes.

func (*ControlPlane) HasDeletingMachine Uses

func (c *ControlPlane) HasDeletingMachine() bool

HasDeletingMachine returns true if any machine in the control plane is in the process of being deleted.

func (*ControlPlane) InfrastructureTemplate Uses

func (c *ControlPlane) InfrastructureTemplate() *corev1.ObjectReference

InfrastructureTemplate returns the KubeadmControlPlane's infrastructure template.

func (*ControlPlane) InitialControlPlaneConfig Uses

func (c *ControlPlane) InitialControlPlaneConfig() *bootstrapv1.KubeadmConfigSpec

InitialControlPlaneConfig returns a new KubeadmConfigSpec that is to be used for an initializing control plane.

func (*ControlPlane) IsEtcdManaged Uses

func (c *ControlPlane) IsEtcdManaged() bool

IsEtcdManaged returns true if the control plane relies on a managed etcd.

func (*ControlPlane) JoinControlPlaneConfig Uses

func (c *ControlPlane) JoinControlPlaneConfig() *bootstrapv1.KubeadmConfigSpec

JoinControlPlaneConfig returns a new KubeadmConfigSpec that is to be used for joining control planes.

func (*ControlPlane) Logger Uses

func (c *ControlPlane) Logger() logr.Logger

Logger returns a logger with useful context.

func (*ControlPlane) MachineInFailureDomainWithMostMachines Uses

func (c *ControlPlane) MachineInFailureDomainWithMostMachines(machines FilterableMachineCollection) (*clusterv1.Machine, error)

MachineInFailureDomainWithMostMachines returns the first matching failure domain with machines that has the most control-plane machines on it.

func (*ControlPlane) MachinesNeedingRollout Uses

func (c *ControlPlane) MachinesNeedingRollout() FilterableMachineCollection

MachinesNeedingRollout return a list of machines that need to be rolled out.

func (*ControlPlane) NeedsReplacementNode Uses

func (c *ControlPlane) NeedsReplacementNode() bool

NeedsReplacementNode determines if the control plane needs to create a replacement node during upgrade.

func (*ControlPlane) NewMachine Uses

func (c *ControlPlane) NewMachine(infraRef, bootstrapRef *corev1.ObjectReference, failureDomain *string) *clusterv1.Machine

NewMachine returns a machine configured to be a part of the control plane.

func (*ControlPlane) NextFailureDomainForScaleUp Uses

func (c *ControlPlane) NextFailureDomainForScaleUp() *string

NextFailureDomainForScaleUp returns the failure domain with the fewest number of up-to-date machines.

func (*ControlPlane) UpToDateMachines Uses

func (c *ControlPlane) UpToDateMachines() FilterableMachineCollection

UpToDateMachines returns the machines that are up to date with the control plane's configuration and therefore do not require rollout.

func (*ControlPlane) Version Uses

func (c *ControlPlane) Version() *string

Version returns the KubeadmControlPlane's version.

type CoreDNSMigrator Uses

type CoreDNSMigrator struct{}

func (*CoreDNSMigrator) Migrate Uses

func (c *CoreDNSMigrator) Migrate(fromCoreDNSVersion, toCoreDNSVersion, corefile string, deprecations bool) (string, error)

type FilterableMachineCollection Uses

type FilterableMachineCollection map[string]*clusterv1.Machine

FilterableMachineCollection is a set of Machines

func NewFilterableMachineCollection Uses

func NewFilterableMachineCollection(machines ...*clusterv1.Machine) FilterableMachineCollection

NewFilterableMachineCollection creates a FilterableMachineCollection from a list of values.

func NewFilterableMachineCollectionFromMachineList Uses

func NewFilterableMachineCollectionFromMachineList(machineList *clusterv1.MachineList) FilterableMachineCollection

NewFilterableMachineCollectionFromMachineList creates a FilterableMachineCollection from the given MachineList

func (FilterableMachineCollection) AnyFilter Uses

func (s FilterableMachineCollection) AnyFilter(filters ...machinefilters.Func) FilterableMachineCollection

AnyFilter returns a FilterableMachineCollection containing only the Machines that match any of the given MachineFilters

func (FilterableMachineCollection) ConditionGetters Uses

func (s FilterableMachineCollection) ConditionGetters() []conditions.Getter

ConditionGetters returns the slice with machines converted into conditions.Getter.

func (FilterableMachineCollection) DeepCopy Uses

func (s FilterableMachineCollection) DeepCopy() FilterableMachineCollection

DeepCopy returns a deep copy

func (FilterableMachineCollection) Difference Uses

func (s FilterableMachineCollection) Difference(machines FilterableMachineCollection) FilterableMachineCollection

Difference returns a copy without machines that are in the given collection

func (FilterableMachineCollection) Filter Uses

func (s FilterableMachineCollection) Filter(filters ...machinefilters.Func) FilterableMachineCollection

Filter returns a FilterableMachineCollection containing only the Machines that match all of the given MachineFilters

func (FilterableMachineCollection) Insert Uses

func (s FilterableMachineCollection) Insert(machines ...*clusterv1.Machine)

Insert adds items to the set.

func (FilterableMachineCollection) Len Uses

func (s FilterableMachineCollection) Len() int

Len returns the size of the set.

func (FilterableMachineCollection) Names Uses

func (s FilterableMachineCollection) Names() []string

Names returns a slice of the names of each machine in the collection. Useful for logging and test assertions.

func (FilterableMachineCollection) Newest Uses

func (s FilterableMachineCollection) Newest() *clusterv1.Machine

Newest returns the Machine with the most recent CreationTimestamp

func (FilterableMachineCollection) Oldest Uses

func (s FilterableMachineCollection) Oldest() *clusterv1.Machine

Oldest returns the Machine with the oldest CreationTimestamp

func (FilterableMachineCollection) SortedByCreationTimestamp Uses

func (s FilterableMachineCollection) SortedByCreationTimestamp() []*clusterv1.Machine

SortedByCreationTimestamp returns the machines sorted by creation timestamp

type HealthCheckResult Uses

type HealthCheckResult map[string]error

HealthCheckResult maps nodes that are checked to any errors the node has related to the check.

type Management Uses

type Management struct {
    Client ctrlclient.Reader
}

Management holds operations on the management cluster.

func (*Management) Get Uses

func (m *Management) Get(ctx context.Context, key ctrlclient.ObjectKey, obj client.Object) error

Get implements ctrlclient.Reader

func (*Management) GetMachinesForCluster Uses

func (m *Management) GetMachinesForCluster(ctx context.Context, cluster client.ObjectKey, filters ...machinefilters.Func) (FilterableMachineCollection, error)

GetMachinesForCluster returns a list of machines that can be filtered or not. If no filter is supplied then all machines associated with the target cluster are returned.

func (*Management) GetWorkloadCluster Uses

func (m *Management) GetWorkloadCluster(ctx context.Context, clusterKey client.ObjectKey) (WorkloadCluster, error)

GetWorkloadCluster builds a cluster object. The cluster comes with an etcd client generator to connect to any etcd pod living on a managed machine.

func (*Management) List Uses

func (m *Management) List(ctx context.Context, list client.ObjectList, opts ...ctrlclient.ListOption) error

List implements ctrlclient.Reader

func (*Management) TargetClusterControlPlaneIsHealthy Uses

func (m *Management) TargetClusterControlPlaneIsHealthy(ctx context.Context, clusterKey client.ObjectKey) error

TargetClusterControlPlaneIsHealthy checks every node for control plane health.

func (*Management) TargetClusterEtcdIsHealthy Uses

func (m *Management) TargetClusterEtcdIsHealthy(ctx context.Context, clusterKey client.ObjectKey) error

TargetClusterEtcdIsHealthy runs a series of checks over a target cluster's etcd cluster. In addition, it verifies that there are the same number of etcd members as control plane Machines.

type ManagementCluster Uses

type ManagementCluster interface {
    ctrlclient.Reader

    GetMachinesForCluster(ctx context.Context, cluster client.ObjectKey, filters ...machinefilters.Func) (FilterableMachineCollection, error)
    TargetClusterEtcdIsHealthy(ctx context.Context, clusterKey client.ObjectKey) error
    TargetClusterControlPlaneIsHealthy(ctx context.Context, clusterKey client.ObjectKey) error
    GetWorkloadCluster(ctx context.Context, clusterKey client.ObjectKey) (WorkloadCluster, error)
}

ManagementCluster defines all behaviors necessary for something to function as a management cluster.

type RemoteClusterConnectionError Uses

type RemoteClusterConnectionError struct {
    Name string
    Err  error
}

RemoteClusterConnectionError represents a failure to connect to a remote cluster

func (*RemoteClusterConnectionError) Error Uses

func (e *RemoteClusterConnectionError) Error() string

func (*RemoteClusterConnectionError) Unwrap Uses

func (e *RemoteClusterConnectionError) Unwrap() error

type Workload Uses

type Workload struct {
    Client          ctrlclient.Client
    CoreDNSMigrator coreDNSMigrator
    // contains filtered or unexported fields
}

Workload defines operations on workload clusters.

func (*Workload) AllowBootstrapTokensToGetNodes Uses

func (w *Workload) AllowBootstrapTokensToGetNodes(ctx context.Context) error

AllowBootstrapTokensToGetNodes creates RBAC rules to allow Node Bootstrap Tokens to list nodes

func (*Workload) ClusterStatus Uses

func (w *Workload) ClusterStatus(ctx context.Context) (ClusterStatus, error)

ClusterStatus returns the status of the cluster.

func (*Workload) ControlPlaneIsHealthy Uses

func (w *Workload) ControlPlaneIsHealthy(ctx context.Context) (HealthCheckResult, error)

controlPlaneIsHealthy does a best effort check of the control plane components the kubeadm control plane cares about. The return map is a map of node names as keys to error that that node encountered. All nodes will exist in the map with nil errors if there were no errors for that node.

func (*Workload) EnsureResource Uses

func (w *Workload) EnsureResource(ctx context.Context, obj client.Object) error

EnsureResource creates a resoutce if the target resource doesn't exist. If the resource exists already, this function will ignore the resource instead.

func (*Workload) EtcdIsHealthy Uses

func (w *Workload) EtcdIsHealthy(ctx context.Context) (HealthCheckResult, error)

EtcdIsHealthy runs checks for every etcd member in the cluster to satisfy our definition of healthy. This is a best effort check and nodes can become unhealthy after the check is complete. It is not a guarantee. It's used a signal for if we should allow a target cluster to scale up, scale down or upgrade. It returns a map of nodes checked along with an error for a given node.

func (*Workload) ForwardEtcdLeadership Uses

func (w *Workload) ForwardEtcdLeadership(ctx context.Context, machine *clusterv1.Machine, leaderCandidate *clusterv1.Machine) error

ForwardEtcdLeadership forwards etcd leadership to the first follower

func (*Workload) ReconcileEtcdMembers Uses

func (w *Workload) ReconcileEtcdMembers(ctx context.Context) error

ReconcileEtcdMembers iterates over all etcd members and finds members that do not have corresponding nodes. If there are any such members, it deletes them from etcd and removes their nodes from the kubeadm configmap so that kubeadm does not run etcd health checks on them.

func (*Workload) ReconcileKubeletRBACBinding Uses

func (w *Workload) ReconcileKubeletRBACBinding(ctx context.Context, version semver.Version) error

ReconcileKubeletRBACBinding will create a RoleBinding for the new kubelet version during upgrades. If the role binding already exists this function is a no-op.

func (*Workload) ReconcileKubeletRBACRole Uses

func (w *Workload) ReconcileKubeletRBACRole(ctx context.Context, version semver.Version) error

ReconcileKubeletRBACRole will create a Role for the new kubelet version during upgrades. If the role already exists this function is a no-op.

func (*Workload) RemoveEtcdMemberForMachine Uses

func (w *Workload) RemoveEtcdMemberForMachine(ctx context.Context, machine *clusterv1.Machine) error

RemoveEtcdMemberForMachine removes the etcd member from the target cluster's etcd cluster. Removing the last remaining member of the cluster is not supported.

func (*Workload) RemoveMachineFromKubeadmConfigMap Uses

func (w *Workload) RemoveMachineFromKubeadmConfigMap(ctx context.Context, machine *clusterv1.Machine) error

RemoveMachineFromKubeadmConfigMap removes the entry for the machine from the kubeadm configmap.

func (*Workload) RemoveNodeFromKubeadmConfigMap Uses

func (w *Workload) RemoveNodeFromKubeadmConfigMap(ctx context.Context, name string) error

RemoveNodeFromKubeadmConfigMap removes the entry for the node from the kubeadm configmap.

func (*Workload) UpdateCoreDNS Uses

func (w *Workload) UpdateCoreDNS(ctx context.Context, kcp *controlplanev1.KubeadmControlPlane) error

UpdateCoreDNS updates the kubeadm configmap, coredns corefile and coredns deployment.

func (*Workload) UpdateEtcdVersionInKubeadmConfigMap Uses

func (w *Workload) UpdateEtcdVersionInKubeadmConfigMap(ctx context.Context, imageRepository, imageTag string) error

UpdateEtcdVersionInKubeadmConfigMap sets the imageRepository or the imageTag or both in the kubeadm config map.

func (*Workload) UpdateImageRepositoryInKubeadmConfigMap Uses

func (w *Workload) UpdateImageRepositoryInKubeadmConfigMap(ctx context.Context, imageRepository string) error

UpdateKubernetesVersionInKubeadmConfigMap updates the kubernetes version in the kubeadm config map.

func (*Workload) UpdateKubeProxyImageInfo Uses

func (w *Workload) UpdateKubeProxyImageInfo(ctx context.Context, kcp *controlplanev1.KubeadmControlPlane) error

UpdateKubeProxyImageInfo updates kube-proxy image in the kube-proxy DaemonSet.

func (*Workload) UpdateKubeletConfigMap Uses

func (w *Workload) UpdateKubeletConfigMap(ctx context.Context, version semver.Version) error

UpdateKubeletConfigMap will create a new kubelet-config-1.x config map for a new version of the kubelet. This is a necessary process for upgrades.

func (*Workload) UpdateKubernetesVersionInKubeadmConfigMap Uses

func (w *Workload) UpdateKubernetesVersionInKubeadmConfigMap(ctx context.Context, version semver.Version) error

UpdateKubernetesVersionInKubeadmConfigMap updates the kubernetes version in the kubeadm config map.

type WorkloadCluster Uses

type WorkloadCluster interface {
    // Basic health and status checks.
    ClusterStatus(ctx context.Context) (ClusterStatus, error)
    ControlPlaneIsHealthy(ctx context.Context) (HealthCheckResult, error)
    EtcdIsHealthy(ctx context.Context) (HealthCheckResult, error)

    // Upgrade related tasks.
    ReconcileKubeletRBACBinding(ctx context.Context, version semver.Version) error
    ReconcileKubeletRBACRole(ctx context.Context, version semver.Version) error
    UpdateKubernetesVersionInKubeadmConfigMap(ctx context.Context, version semver.Version) error
    UpdateImageRepositoryInKubeadmConfigMap(ctx context.Context, imageRepository string) error
    UpdateEtcdVersionInKubeadmConfigMap(ctx context.Context, imageRepository, imageTag string) error
    UpdateKubeletConfigMap(ctx context.Context, version semver.Version) error
    UpdateKubeProxyImageInfo(ctx context.Context, kcp *controlplanev1.KubeadmControlPlane) error
    UpdateCoreDNS(ctx context.Context, kcp *controlplanev1.KubeadmControlPlane) error
    RemoveEtcdMemberForMachine(ctx context.Context, machine *clusterv1.Machine) error
    RemoveMachineFromKubeadmConfigMap(ctx context.Context, machine *clusterv1.Machine) error
    RemoveNodeFromKubeadmConfigMap(ctx context.Context, nodeName string) error
    ForwardEtcdLeadership(ctx context.Context, machine *clusterv1.Machine, leaderCandidate *clusterv1.Machine) error
    AllowBootstrapTokensToGetNodes(ctx context.Context) error

    // State recovery tasks.
    ReconcileEtcdMembers(ctx context.Context) error
}

WorkloadCluster defines all behaviors necessary to upgrade kubernetes on a workload cluster

Directories

PathSynopsis
etcdPackage etcd provides a connection to an etcd member.
etcd/fake
etcd/util
hash
machinefilters
proxy

Package internal imports 46 packages (graph) and is imported by 1 packages. Updated 2020-10-27. Refresh now. Tools for package owners.