controller

package
v1.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 3, 2022 License: Apache-2.0 Imports: 39 Imported by: 2,348

Documentation

Overview

Package controller contains code for controllers (like the replication controller).

Index

Constants

View Source 
const (
	// If a watch drops a delete event for a pod, it'll take this long
	// before a dormant controller waiting for those packets is woken up anyway. It is
	// specifically targeted at the case where some problem prevents an update
	// of expectations, without it the controller could stay asleep forever. This should
	// be set based on the expected latency of watch events.
	//
	// Currently a controller can service (create *and* observe the watch events for said
	// creation) about 10 pods a second, so it takes about 1 min to service
	// 500 pods. Just creation is limited to 20qps, and watching happens with ~10-30s
	// latency/pod at the scale of 3000 pods over 100 nodes.
	ExpectationsTimeout = 5 * time.Minute
	// When batching pod creates, SlowStartInitialBatchSize is the size of the
	// initial batch.  The size of each successive batch is twice the size of
	// the previous batch.  For example, for a value of 1, batch sizes would be
	// 1, 2, 4, 8, ...  and for a value of 10, batch sizes would be
	// 10, 20, 40, 80, ...  Setting the value higher means that quota denials
	// will result in more doomed API calls and associated event spam.  Setting
	// the value lower will result in more API call round trip periods for
	// large batches.
	//
	// Given a number of pods to start "N":
	// The number of doomed calls per sync once quota is exceeded is given by:
	//      min(N,SlowStartInitialBatchSize)
	// The number of batches is given by:
	//      1+floor(log_2(ceil(N/SlowStartInitialBatchSize)))
	SlowStartInitialBatchSize = 1
)
View Source 
const (
	// FailedCreatePodReason is added in an event and in a replica set condition
	// when a pod for a replica set is failed to be created.
	FailedCreatePodReason = "FailedCreate"
	// SuccessfulCreatePodReason is added in an event when a pod for a replica set
	// is successfully created.
	SuccessfulCreatePodReason = "SuccessfulCreate"
	// FailedDeletePodReason is added in an event and in a replica set condition
	// when a pod for a replica set is failed to be deleted.
	FailedDeletePodReason = "FailedDelete"
	// SuccessfulDeletePodReason is added in an event when a pod for a replica set
	// is successfully deleted.
	SuccessfulDeletePodReason = "SuccessfulDelete"
)

Reasons for pod events

Variables

View Source 
var ExpKeyFunc = func(obj interface{}) (string, error) {
	if e, ok := obj.(*ControlleeExpectations); ok {
		return e.key, nil
	}
	return "", fmt.Errorf("could not find key for obj %#v", obj)
}

ExpKeyFunc to parse out the key from a ControlleeExpectation

View Source 
var (
	KeyFunc = cache.DeletionHandlingMetaNamespaceKeyFunc
)
View Source 
var UIDSetKeyFunc = func(obj interface{}) (string, error) {
	if u, ok := obj.(*UIDSet); ok {
		return u.key, nil
	}
	return "", fmt.Errorf("could not find key for obj %#v", obj)
}

UIDSetKeyFunc to parse out the key from a UIDSet.

View Source 
var UpdateLabelBackoff = wait.Backoff{
	Steps:    5,
	Duration: 100 * time.Millisecond,
	Jitter:   1.0,
}
View Source 
var UpdateTaintBackoff = wait.Backoff{
	Steps:    5,
	Duration: 100 * time.Millisecond,
	Jitter:   1.0,
}

Functions

func AddOrUpdateLabelsOnNode added in v1.14.0 

func AddOrUpdateLabelsOnNode(kubeClient clientset.Interface, nodeName string, labelsToUpdate map[string]string) error

func AddOrUpdateTaintOnNode added in v1.6.0 

func AddOrUpdateTaintOnNode(ctx context.Context, c clientset.Interface, nodeName string, taints ...*v1.Taint) error

AddOrUpdateTaintOnNode add taints to the node. If taint was added into node, it'll issue API calls to update nodes; otherwise, no API calls. Return error if any.

func ComputeHash added in v1.7.0 

func ComputeHash(template *v1.PodTemplateSpec, collisionCount *int32) string

ComputeHash returns a hash value calculated from pod template and a collisionCount to avoid hash collision. The hash will be safe encoded to avoid bad words.

func FilterActivePods added in v0.7.0 

func FilterActivePods(pods []*v1.Pod) []*v1.Pod

FilterActivePods returns pods that have not terminated.

func FilterActiveReplicaSets added in v1.2.0 

func FilterActiveReplicaSets(replicaSets []*apps.ReplicaSet) []*apps.ReplicaSet

FilterActiveReplicaSets returns replica sets that have (or at least ought to have) pods.

func FilterReplicaSets added in v1.6.0 

func FilterReplicaSets(RSes []*apps.ReplicaSet, filterFn filterRS) []*apps.ReplicaSet

FilterReplicaSets returns replica sets that are filtered by filterFn (all returned ones should match filterFn).

func GenerateDeleteOwnerRefStrategicMergeBytes added in v1.23.0 

func GenerateDeleteOwnerRefStrategicMergeBytes(dependentUID types.UID, ownerUIDs []types.UID, finalizers ...string) ([]byte, error)

func GetPodFromTemplate added in v1.3.0 

func GetPodFromTemplate(template *v1.PodTemplateSpec, parentObject runtime.Object, controllerRef *metav1.OwnerReference) (*v1.Pod, error)

func IsPodActive added in v1.2.0 

func IsPodActive(p *v1.Pod) bool

func NoResyncPeriodFunc added in v1.1.1 

func NoResyncPeriodFunc() time.Duration

Returns 0 for resyncPeriod in case resyncing is not needed.

func PatchNodeTaints added in v1.6.0 

func PatchNodeTaints(ctx context.Context, c clientset.Interface, nodeName string, oldNode *v1.Node, newNode *v1.Node) error

PatchNodeTaints patches node's taints.

func PodKey added in v1.2.0 

func PodKey(pod *v1.Pod) string

PodKey returns a key unique to the given pod within a cluster. It's used so we consistently use the same key scheme in this module. It does exactly what cache.MetaNamespaceKeyFunc would have done except there's not possibility for error since we know the exact type.

func RecheckDeletionTimestamp added in v1.6.0 

func RecheckDeletionTimestamp(getObject func(context.Context) (metav1.Object, error)) func(context.Context) error

RecheckDeletionTimestamp returns a CanAdopt() function to recheck deletion.

The CanAdopt() function calls getObject() to fetch the latest value, and denies adoption attempts if that object has a non-nil DeletionTimestamp.

func RemoveTaintOffNode added in v1.6.0 

func RemoveTaintOffNode(ctx context.Context, c clientset.Interface, nodeName string, node *v1.Node, taints ...*v1.Taint) error

RemoveTaintOffNode is for cleaning up taints temporarily added to node, won't fail if target taint doesn't exist or has been removed. If passed a node it'll check if there's anything to be done, if taint is not present it won't issue any API calls.

Types

type ActivePods added in v1.1.0 

type ActivePods []*v1.Pod

ActivePods type allows custom sorting of pods so a controller can pick the best ones to delete.

func (ActivePods) Len added in v1.1.0 

func (s ActivePods) Len() int

func (ActivePods) Less added in v1.1.0 

func (s ActivePods) Less(i, j int) bool

func (ActivePods) Swap added in v1.1.0 

func (s ActivePods) Swap(i, j int)

type ActivePodsWithRanks added in v1.17.0 

type ActivePodsWithRanks struct {
	// Pods is a list of pods.
	Pods []*v1.Pod

	// Rank is a ranking of pods.  This ranking is used during sorting when
	// comparing two pods that are both scheduled, in the same phase, and
	// having the same ready status.
	Rank []int

	// Now is a reference timestamp for doing logarithmic timestamp comparisons.
	// If zero, comparison happens without scaling.
	Now metav1.Time
}

ActivePodsWithRanks is a sortable list of pods and a list of corresponding ranks which will be considered during sorting. The two lists must have equal length. After sorting, the pods will be ordered as follows, applying each rule in turn until one matches:

  1. If only one of the pods is assigned to a node, the pod that is not assigned comes before the pod that is.
  2. If the pods' phases differ, a pending pod comes before a pod whose phase is unknown, and a pod whose phase is unknown comes before a running pod.
  3. If exactly one of the pods is ready, the pod that is not ready comes before the ready pod.
  4. If controller.kubernetes.io/pod-deletion-cost annotation is set, then the pod with the lower value will come first.
  5. If the pods' ranks differ, the pod with greater rank comes before the pod with lower rank.
  6. If both pods are ready but have not been ready for the same amount of time, the pod that has been ready for a shorter amount of time comes before the pod that has been ready for longer.
  7. If one pod has a container that has restarted more than any container in the other pod, the pod with the container with more restarts comes before the other pod.
  8. If the pods' creation times differ, the pod that was created more recently comes before the older pod.

In 6 and 8, times are compared in a logarithmic scale. This allows a level of randomness among equivalent Pods when sorting. If two pods have the same logarithmic rank, they are sorted by UUID to provide a pseudorandom order.

If none of these rules matches, the second pod comes before the first pod.

The intention of this ordering is to put pods that should be preferred for deletion first in the list.

func (ActivePodsWithRanks) Len added in v1.17.0 

func (s ActivePodsWithRanks) Len() int

func (ActivePodsWithRanks) Less added in v1.17.0 

func (s ActivePodsWithRanks) Less(i, j int) bool

Less compares two pods with corresponding ranks and returns true if the first one should be preferred for deletion.

func (ActivePodsWithRanks) Swap added in v1.17.0 

func (s ActivePodsWithRanks) Swap(i, j int)

type BaseControllerRefManager added in v1.8.0 

type BaseControllerRefManager struct {
	Controller metav1.Object
	Selector   labels.Selector

	CanAdoptFunc func(ctx context.Context) error
	// contains filtered or unexported fields
}

func (*BaseControllerRefManager) CanAdopt added in v1.8.0 

func (m *BaseControllerRefManager) CanAdopt(ctx context.Context) error

func (*BaseControllerRefManager) ClaimObject added in v1.8.0 

func (m *BaseControllerRefManager) ClaimObject(ctx context.Context, obj metav1.Object, match func(metav1.Object) bool, adopt, release func(context.Context, metav1.Object) error) (bool, error)

ClaimObject tries to take ownership of an object for this controller.

It will reconcile the following:

  • Adopt orphans if the match function returns true.
  • Release owned objects if the match function returns false.

A non-nil error is returned if some form of reconciliation was attempted and failed. Usually, controllers should try again later in case reconciliation is still needed.

If the error is nil, either the reconciliation succeeded, or no reconciliation was necessary. The returned boolean indicates whether you now own the object.

No reconciliation will be attempted if the controller is being deleted.

type ByLogging added in v1.4.0 

type ByLogging []*v1.Pod

ByLogging allows custom sorting of pods so the best one can be picked for getting its logs.

func (ByLogging) Len added in v1.4.0 

func (s ByLogging) Len() int

func (ByLogging) Less added in v1.4.0 

func (s ByLogging) Less(i, j int) bool

func (ByLogging) Swap added in v1.4.0 

func (s ByLogging) Swap(i, j int)

type ControlleeExpectations added in v1.2.0 

type ControlleeExpectations struct {
	// contains filtered or unexported fields
}

ControlleeExpectations track controllee creates/deletes.

func (*ControlleeExpectations) Add added in v1.2.0 

func (e *ControlleeExpectations) Add(add, del int64)

Add increments the add and del counters.

func (*ControlleeExpectations) Fulfilled added in v1.2.0 

func (e *ControlleeExpectations) Fulfilled() bool

Fulfilled returns true if this expectation has been fulfilled.

func (*ControlleeExpectations) GetExpectations added in v1.2.0 

func (e *ControlleeExpectations) GetExpectations() (int64, int64)

GetExpectations returns the add and del expectations of the controllee.

type ControllerExpectations added in v1.1.0 

type ControllerExpectations struct {
	cache.Store
}

ControllerExpectations is a cache mapping controllers to what they expect to see before being woken up for a sync.

func NewControllerExpectations added in v1.1.0 

func NewControllerExpectations() *ControllerExpectations

NewControllerExpectations returns a store for ControllerExpectations.

func (*ControllerExpectations) CreationObserved added in v1.1.0 

func (r *ControllerExpectations) CreationObserved(controllerKey string)

CreationObserved atomically decrements the `add` expectation count of the given controller.

func (*ControllerExpectations) DeleteExpectations added in v1.1.0 

func (r *ControllerExpectations) DeleteExpectations(controllerKey string)

DeleteExpectations deletes the expectations of the given controller from the TTLStore.

func (*ControllerExpectations) DeletionObserved added in v1.1.0 

func (r *ControllerExpectations) DeletionObserved(controllerKey string)

DeletionObserved atomically decrements the `del` expectation count of the given controller.

func (*ControllerExpectations) ExpectCreations added in v1.1.0 

func (r *ControllerExpectations) ExpectCreations(controllerKey string, adds int) error

func (*ControllerExpectations) ExpectDeletions added in v1.1.0 

func (r *ControllerExpectations) ExpectDeletions(controllerKey string, dels int) error

func (*ControllerExpectations) GetExpectations added in v1.1.0 

func (r *ControllerExpectations) GetExpectations(controllerKey string) (*ControlleeExpectations, bool, error)

GetExpectations returns the ControlleeExpectations of the given controller.

func (*ControllerExpectations) LowerExpectations added in v1.2.0 

func (r *ControllerExpectations) LowerExpectations(controllerKey string, add, del int)

Decrements the expectation counts of the given controller.

func (*ControllerExpectations) RaiseExpectations added in v1.2.0 

func (r *ControllerExpectations) RaiseExpectations(controllerKey string, add, del int)

Increments the expectation counts of the given controller.

func (*ControllerExpectations) SatisfiedExpectations added in v1.1.0 

func (r *ControllerExpectations) SatisfiedExpectations(controllerKey string) bool

SatisfiedExpectations returns true if the required adds/dels for the given controller have been observed. Add/del counts are established by the controller at sync time, and updated as controllees are observed by the controller manager.

func (*ControllerExpectations) SetExpectations added in v1.1.0 

func (r *ControllerExpectations) SetExpectations(controllerKey string, add, del int) error

SetExpectations registers new expectations for the given controller. Forgets existing expectations.

type ControllerExpectationsInterface added in v1.1.0 

type ControllerExpectationsInterface interface {
	GetExpectations(controllerKey string) (*ControlleeExpectations, bool, error)
	SatisfiedExpectations(controllerKey string) bool
	DeleteExpectations(controllerKey string)
	SetExpectations(controllerKey string, add, del int) error
	ExpectCreations(controllerKey string, adds int) error
	ExpectDeletions(controllerKey string, dels int) error
	CreationObserved(controllerKey string)
	DeletionObserved(controllerKey string)
	RaiseExpectations(controllerKey string, add, del int)
	LowerExpectations(controllerKey string, add, del int)
}

ControllerExpectationsInterface is an interface that allows users to set and wait on expectations. Only abstracted out for testing. Warning: if using KeyFunc it is not safe to use a single ControllerExpectationsInterface with different types of controllers, because the keys might conflict across types.

type ControllerRevisionControlInterface added in v1.7.0 

type ControllerRevisionControlInterface interface {
	PatchControllerRevision(ctx context.Context, namespace, name string, data []byte) error
}

TODO: merge the controller revision interface in controller_history.go with this one ControllerRevisionControlInterface is an interface that knows how to patch ControllerRevisions, as well as increment or decrement them. It is used by the daemonset controller to ease testing of actions that it takes.

type ControllerRevisionControllerRefManager added in v1.7.0 

type ControllerRevisionControllerRefManager struct {
	BaseControllerRefManager
	// contains filtered or unexported fields
}

ControllerRevisionControllerRefManager is used to manage controllerRef of ControllerRevisions. Three methods are defined on this object 1: Classify 2: AdoptControllerRevision and 3: ReleaseControllerRevision which are used to classify the ControllerRevisions into appropriate categories and accordingly adopt or release them. See comments on these functions for more details.

func NewControllerRevisionControllerRefManager added in v1.7.0 

func NewControllerRevisionControllerRefManager(
	crControl ControllerRevisionControlInterface,
	controller metav1.Object,
	selector labels.Selector,
	controllerKind schema.GroupVersionKind,
	canAdopt func(ctx context.Context) error,
) *ControllerRevisionControllerRefManager

NewControllerRevisionControllerRefManager returns a ControllerRevisionControllerRefManager that exposes methods to manage the controllerRef of ControllerRevisions.

The canAdopt() function can be used to perform a potentially expensive check (such as a live GET from the API server) prior to the first adoption. It will only be called (at most once) if an adoption is actually attempted. If canAdopt() returns a non-nil error, all adoptions will fail.

NOTE: Once canAdopt() is called, it will not be called again by the same 

ControllerRevisionControllerRefManager instance. Create a new instance if it
makes sense to check canAdopt() again (e.g. in a different sync pass).

func (*ControllerRevisionControllerRefManager) AdoptControllerRevision added in v1.7.0 

func (m *ControllerRevisionControllerRefManager) AdoptControllerRevision(ctx context.Context, history *apps.ControllerRevision) error

AdoptControllerRevision sends a patch to take control of the ControllerRevision. It returns the error if the patching fails.

func (*ControllerRevisionControllerRefManager) ClaimControllerRevisions added in v1.7.0 

func (m *ControllerRevisionControllerRefManager) ClaimControllerRevisions(ctx context.Context, histories []*apps.ControllerRevision) ([]*apps.ControllerRevision, error)

ClaimControllerRevisions tries to take ownership of a list of ControllerRevisions.

It will reconcile the following:

  • Adopt orphans if the selector matches.
  • Release owned objects if the selector no longer matches.

A non-nil error is returned if some form of reconciliation was attempted and failed. Usually, controllers should try again later in case reconciliation is still needed.

If the error is nil, either the reconciliation succeeded, or no reconciliation was necessary. The list of ControllerRevisions that you now own is returned.

func (*ControllerRevisionControllerRefManager) ReleaseControllerRevision added in v1.7.0 

func (m *ControllerRevisionControllerRefManager) ReleaseControllerRevision(ctx context.Context, history *apps.ControllerRevision) error

ReleaseControllerRevision sends a patch to free the ControllerRevision from the control of its controller. It returns the error if the patching fails. 404 and 422 errors are ignored.

type ControllersByCreationTimestamp added in v1.2.0 

type ControllersByCreationTimestamp []*v1.ReplicationController

ControllersByCreationTimestamp sorts a list of ReplicationControllers by creation timestamp, using their names as a tie breaker.

func (ControllersByCreationTimestamp) Len added in v1.2.0 

func (o ControllersByCreationTimestamp) Len() int

func (ControllersByCreationTimestamp) Less added in v1.2.0 

func (o ControllersByCreationTimestamp) Less(i, j int) bool

func (ControllersByCreationTimestamp) Swap added in v1.2.0 

func (o ControllersByCreationTimestamp) Swap(i, j int)

type FakePodControl added in v1.1.0 

type FakePodControl struct {
	sync.Mutex
	Templates       []v1.PodTemplateSpec
	ControllerRefs  []metav1.OwnerReference
	DeletePodName   []string
	Patches         [][]byte
	Err             error
	CreateLimit     int
	CreateCallCount int
}

func (*FakePodControl) Clear added in v1.1.0 

func (f *FakePodControl) Clear()

func (*FakePodControl) CreatePods added in v1.1.0 

func (f *FakePodControl) CreatePods(ctx context.Context, namespace string, spec *v1.PodTemplateSpec, object runtime.Object, controllerRef *metav1.OwnerReference) error

func (*FakePodControl) CreatePodsWithGenerateName added in v1.22.0 

func (f *FakePodControl) CreatePodsWithGenerateName(ctx context.Context, namespace string, spec *v1.PodTemplateSpec, object runtime.Object, controllerRef *metav1.OwnerReference, generateNamePrefix string) error

func (*FakePodControl) DeletePod added in v1.1.0 

func (f *FakePodControl) DeletePod(ctx context.Context, namespace string, podID string, object runtime.Object) error

func (*FakePodControl) PatchPod added in v1.4.0 

func (f *FakePodControl) PatchPod(ctx context.Context, namespace, name string, data []byte) error

type MatchingCache added in v1.2.0 

type MatchingCache struct {
	// contains filtered or unexported fields
}

MatchingCache save label and selector matching relationship

func NewMatchingCache added in v1.2.0 

func NewMatchingCache(maxCacheEntries int) *MatchingCache

NewMatchingCache return a NewMatchingCache, which save label and selector matching relationship.

func (*MatchingCache) Add added in v1.2.0 

func (c *MatchingCache) Add(labelObj objectWithMeta, selectorObj objectWithMeta)

Add will add matching information to the cache.

func (*MatchingCache) GetMatchingObject added in v1.2.0 

func (c *MatchingCache) GetMatchingObject(labelObj objectWithMeta) (controller interface{}, exists bool)

GetMatchingObject lookup the matching object for a given object. Note: the cache information may be invalid since the controller may be deleted or updated, we need check in the external request to ensure the cache data is not dirty.

func (*MatchingCache) InvalidateAll added in v1.2.0 

func (c *MatchingCache) InvalidateAll()

InvalidateAll invalidate the whole cache.

func (*MatchingCache) Update added in v1.2.0 

func (c *MatchingCache) Update(labelObj objectWithMeta, selectorObj objectWithMeta)

Update update the cached matching information.

type PodControlInterface 

type PodControlInterface interface {
	// CreatePods creates new pods according to the spec, and sets object as the pod's controller.
	CreatePods(ctx context.Context, namespace string, template *v1.PodTemplateSpec, object runtime.Object, controllerRef *metav1.OwnerReference) error
	// CreatePodsWithGenerateName creates new pods according to the spec, sets object as the pod's controller and sets pod's generateName.
	CreatePodsWithGenerateName(ctx context.Context, namespace string, template *v1.PodTemplateSpec, object runtime.Object, controllerRef *metav1.OwnerReference, generateName string) error
	// DeletePod deletes the pod identified by podID.
	DeletePod(ctx context.Context, namespace string, podID string, object runtime.Object) error
	// PatchPod patches the pod.
	PatchPod(ctx context.Context, namespace, name string, data []byte) error
}

PodControlInterface is an interface that knows how to add or delete pods created as an interface to allow testing.

type PodControllerRefManager added in v1.4.0 

type PodControllerRefManager struct {
	BaseControllerRefManager
	// contains filtered or unexported fields
}

func NewPodControllerRefManager added in v1.4.0 

func NewPodControllerRefManager(
	podControl PodControlInterface,
	controller metav1.Object,
	selector labels.Selector,
	controllerKind schema.GroupVersionKind,
	canAdopt func(ctx context.Context) error,
	finalizers ...string,
) *PodControllerRefManager

NewPodControllerRefManager returns a PodControllerRefManager that exposes methods to manage the controllerRef of pods.

The CanAdopt() function can be used to perform a potentially expensive check (such as a live GET from the API server) prior to the first adoption. It will only be called (at most once) if an adoption is actually attempted. If CanAdopt() returns a non-nil error, all adoptions will fail.

NOTE: Once CanAdopt() is called, it will not be called again by the same 

PodControllerRefManager instance. Create a new instance if it makes
sense to check CanAdopt() again (e.g. in a different sync pass).

func (*PodControllerRefManager) AdoptPod added in v1.4.0 

func (m *PodControllerRefManager) AdoptPod(ctx context.Context, pod *v1.Pod) error

AdoptPod sends a patch to take control of the pod. It returns the error if the patching fails.

func (*PodControllerRefManager) ClaimPods added in v1.6.0 

func (m *PodControllerRefManager) ClaimPods(ctx context.Context, pods []*v1.Pod, filters ...func(*v1.Pod) bool) ([]*v1.Pod, error)

ClaimPods tries to take ownership of a list of Pods.

It will reconcile the following:

  • Adopt orphans if the selector matches.
  • Release owned objects if the selector no longer matches.

Optional: If one or more filters are specified, a Pod will only be claimed if all filters return true.

A non-nil error is returned if some form of reconciliation was attempted and failed. Usually, controllers should try again later in case reconciliation is still needed.

If the error is nil, either the reconciliation succeeded, or no reconciliation was necessary. The list of Pods that you now own is returned.

func (*PodControllerRefManager) ReleasePod added in v1.4.0 

func (m *PodControllerRefManager) ReleasePod(ctx context.Context, pod *v1.Pod) error

ReleasePod sends a patch to free the pod from the control of the controller. It returns the error if the patching fails. 404 and 422 errors are ignored.

type RSControlInterface added in v1.6.0 

type RSControlInterface interface {
	PatchReplicaSet(ctx context.Context, namespace, name string, data []byte) error
}

RSControlInterface is an interface that knows how to add or delete ReplicaSets, as well as increment or decrement them. It is used by the deployment controller to ease testing of actions that it takes.

type RealControllerRevisionControl added in v1.7.0 

type RealControllerRevisionControl struct {
	KubeClient clientset.Interface
}

RealControllerRevisionControl is the default implementation of ControllerRevisionControlInterface.

func (RealControllerRevisionControl) PatchControllerRevision added in v1.7.0 

func (r RealControllerRevisionControl) PatchControllerRevision(ctx context.Context, namespace, name string, data []byte) error

type RealPodControl 

type RealPodControl struct {
	KubeClient clientset.Interface
	Recorder   record.EventRecorder
}

RealPodControl is the default implementation of PodControlInterface.

func (RealPodControl) CreatePods added in v1.1.0 

func (r RealPodControl) CreatePods(ctx context.Context, namespace string, template *v1.PodTemplateSpec, controllerObject runtime.Object, controllerRef *metav1.OwnerReference) error

func (RealPodControl) CreatePodsWithGenerateName added in v1.22.0 

func (r RealPodControl) CreatePodsWithGenerateName(ctx context.Context, namespace string, template *v1.PodTemplateSpec, controllerObject runtime.Object, controllerRef *metav1.OwnerReference, generateName string) error

func (RealPodControl) DeletePod added in v1.1.0 

func (r RealPodControl) DeletePod(ctx context.Context, namespace string, podID string, object runtime.Object) error

func (RealPodControl) PatchPod added in v1.4.0 

func (r RealPodControl) PatchPod(ctx context.Context, namespace, name string, data []byte) error

type RealRSControl added in v1.6.0 

type RealRSControl struct {
	KubeClient clientset.Interface
	Recorder   record.EventRecorder
}

RealRSControl is the default implementation of RSControllerInterface.

func (RealRSControl) PatchReplicaSet added in v1.6.0 

func (r RealRSControl) PatchReplicaSet(ctx context.Context, namespace, name string, data []byte) error

type ReplicaSetControllerRefManager added in v1.6.0 

type ReplicaSetControllerRefManager struct {
	BaseControllerRefManager
	// contains filtered or unexported fields
}

ReplicaSetControllerRefManager is used to manage controllerRef of ReplicaSets. Three methods are defined on this object 1: Classify 2: AdoptReplicaSet and 3: ReleaseReplicaSet which are used to classify the ReplicaSets into appropriate categories and accordingly adopt or release them. See comments on these functions for more details.

func NewReplicaSetControllerRefManager added in v1.6.0 

func NewReplicaSetControllerRefManager(
	rsControl RSControlInterface,
	controller metav1.Object,
	selector labels.Selector,
	controllerKind schema.GroupVersionKind,
	canAdopt func(ctx context.Context) error,
) *ReplicaSetControllerRefManager

NewReplicaSetControllerRefManager returns a ReplicaSetControllerRefManager that exposes methods to manage the controllerRef of ReplicaSets.

The CanAdopt() function can be used to perform a potentially expensive check (such as a live GET from the API server) prior to the first adoption. It will only be called (at most once) if an adoption is actually attempted. If CanAdopt() returns a non-nil error, all adoptions will fail.

NOTE: Once CanAdopt() is called, it will not be called again by the same 

ReplicaSetControllerRefManager instance. Create a new instance if it
makes sense to check CanAdopt() again (e.g. in a different sync pass).

func (*ReplicaSetControllerRefManager) AdoptReplicaSet added in v1.6.0 

func (m *ReplicaSetControllerRefManager) AdoptReplicaSet(ctx context.Context, rs *apps.ReplicaSet) error

AdoptReplicaSet sends a patch to take control of the ReplicaSet. It returns the error if the patching fails.

func (*ReplicaSetControllerRefManager) ClaimReplicaSets added in v1.6.0 

func (m *ReplicaSetControllerRefManager) ClaimReplicaSets(ctx context.Context, sets []*apps.ReplicaSet) ([]*apps.ReplicaSet, error)

ClaimReplicaSets tries to take ownership of a list of ReplicaSets.

It will reconcile the following:

  • Adopt orphans if the selector matches.
  • Release owned objects if the selector no longer matches.

A non-nil error is returned if some form of reconciliation was attempted and failed. Usually, controllers should try again later in case reconciliation is still needed.

If the error is nil, either the reconciliation succeeded, or no reconciliation was necessary. The list of ReplicaSets that you now own is returned.

func (*ReplicaSetControllerRefManager) ReleaseReplicaSet added in v1.6.0 

func (m *ReplicaSetControllerRefManager) ReleaseReplicaSet(ctx context.Context, replicaSet *apps.ReplicaSet) error

ReleaseReplicaSet sends a patch to free the ReplicaSet from the control of the Deployment controller. It returns the error if the patching fails. 404 and 422 errors are ignored.

type ReplicaSetsByCreationTimestamp added in v1.2.0 

type ReplicaSetsByCreationTimestamp []*apps.ReplicaSet

ReplicaSetsByCreationTimestamp sorts a list of ReplicaSet by creation timestamp, using their names as a tie breaker.

func (ReplicaSetsByCreationTimestamp) Len added in v1.2.0 

func (o ReplicaSetsByCreationTimestamp) Len() int

func (ReplicaSetsByCreationTimestamp) Less added in v1.2.0 

func (o ReplicaSetsByCreationTimestamp) Less(i, j int) bool

func (ReplicaSetsByCreationTimestamp) Swap added in v1.2.0 

func (o ReplicaSetsByCreationTimestamp) Swap(i, j int)

type ReplicaSetsBySizeNewer added in v1.4.0 

type ReplicaSetsBySizeNewer []*apps.ReplicaSet

ReplicaSetsBySizeNewer sorts a list of ReplicaSet by size in descending order, using their creation timestamp or name as a tie breaker. By using the creation timestamp, this sorts from new to old replica sets.

func (ReplicaSetsBySizeNewer) Len added in v1.4.0 

func (o ReplicaSetsBySizeNewer) Len() int

func (ReplicaSetsBySizeNewer) Less added in v1.4.0 

func (o ReplicaSetsBySizeNewer) Less(i, j int) bool

func (ReplicaSetsBySizeNewer) Swap added in v1.4.0 

func (o ReplicaSetsBySizeNewer) Swap(i, j int)

type ReplicaSetsBySizeOlder added in v1.4.0 

type ReplicaSetsBySizeOlder []*apps.ReplicaSet

ReplicaSetsBySizeOlder sorts a list of ReplicaSet by size in descending order, using their creation timestamp or name as a tie breaker. By using the creation timestamp, this sorts from old to new replica sets.

func (ReplicaSetsBySizeOlder) Len added in v1.4.0 

func (o ReplicaSetsBySizeOlder) Len() int

func (ReplicaSetsBySizeOlder) Less added in v1.4.0 

func (o ReplicaSetsBySizeOlder) Less(i, j int) bool

func (ReplicaSetsBySizeOlder) Swap added in v1.4.0 

func (o ReplicaSetsBySizeOlder) Swap(i, j int)

type ResyncPeriodFunc added in v1.1.1 

type ResyncPeriodFunc func() time.Duration

func StaticResyncPeriodFunc added in v1.2.0 

func StaticResyncPeriodFunc(resyncPeriod time.Duration) ResyncPeriodFunc

StaticResyncPeriodFunc returns the resync period specified

type UIDSet added in v1.2.0 

type UIDSet struct {
	sets.String
	// contains filtered or unexported fields
}

UIDSet holds a key and a set of UIDs. Used by the UIDTrackingControllerExpectations to remember which UID it has seen/still waiting for.

type UIDTrackingControllerExpectations added in v1.2.0 

type UIDTrackingControllerExpectations struct {
	ControllerExpectationsInterface
	// contains filtered or unexported fields
}

UIDTrackingControllerExpectations tracks the UID of the pods it deletes. This cache is needed over plain old expectations to safely handle graceful deletion. The desired behavior is to treat an update that sets the DeletionTimestamp on an object as a delete. To do so consistently, one needs to remember the expected deletes so they aren't double counted. TODO: Track creates as well (#22599)

func NewUIDTrackingControllerExpectations added in v1.2.0 

func NewUIDTrackingControllerExpectations(ce ControllerExpectationsInterface) *UIDTrackingControllerExpectations

NewUIDTrackingControllerExpectations returns a wrapper around ControllerExpectations that is aware of deleteKeys.

func (*UIDTrackingControllerExpectations) DeleteExpectations added in v1.2.0 

func (u *UIDTrackingControllerExpectations) DeleteExpectations(rcKey string)

DeleteExpectations deletes the UID set and invokes DeleteExpectations on the underlying ControllerExpectationsInterface.

func (*UIDTrackingControllerExpectations) DeletionObserved added in v1.2.0 

func (u *UIDTrackingControllerExpectations) DeletionObserved(rcKey, deleteKey string)

DeletionObserved records the given deleteKey as a deletion, for the given rc.

func (*UIDTrackingControllerExpectations) ExpectDeletions added in v1.2.0 

func (u *UIDTrackingControllerExpectations) ExpectDeletions(rcKey string, deletedKeys []string) error

ExpectDeletions records expectations for the given deleteKeys, against the given controller.

func (*UIDTrackingControllerExpectations) GetUIDs added in v1.2.0 

func (u *UIDTrackingControllerExpectations) GetUIDs(controllerKey string) sets.String

GetUIDs is a convenience method to avoid exposing the set of expected uids. The returned set is not thread safe, all modifications must be made holding the uidStoreLock.

Source Files

View all Source files

Directories

Path Synopsis
apis
config
config/fuzzer
config/scheme
config/v1alpha1
Package bootstrap provides automatic processes necessary for bootstraping.
 Package bootstrap provides automatic processes necessary for bootstraping.
Package certificates implements an abstract controller that is useful for building controllers that manage CSRs
 Package certificates implements an abstract controller that is useful for building controllers that manage CSRs
approver
Package approver implements an automated approver for kubelet certificates.
 Package approver implements an automated approver for kubelet certificates.
authority
cleaner
Package cleaner implements an automated cleaner that does garbage collection on CSRs that meet specific criteria.
 Package cleaner implements an automated cleaner that does garbage collection on CSRs that meet specific criteria.
rootcacertpublisher
signer
Package signer implements a CA signer that uses keys stored on local disk.
 Package signer implements a CA signer that uses keys stored on local disk.
signer/config
signer/config/v1alpha1
Package cronjob contains the controller for CronJob objects.
 Package cronjob contains the controller for CronJob objects.
config
config/v1alpha1
metrics
Package daemon contains logic for watching and synchronizing daemons.
 Package daemon contains logic for watching and synchronizing daemons.
config
config/v1alpha1
util
Package deployment contains all the logic for handling Kubernetes Deployments.
 Package deployment contains all the logic for handling Kubernetes Deployments.
config
config/v1alpha1
util
Package endpoint provides EndpointController implementation to manage and sync service endpoints.
 Package endpoint provides EndpointController implementation to manage and sync service endpoints.
config
config/v1alpha1
config
config/v1alpha1
metrics
topologycache
config
config/v1alpha1
metrics
config
config/v1alpha1
metaonly
metrics
job
Package job contains logic for watching and synchronizing jobs.
 Package job contains logic for watching and synchronizing jobs.
config
config/v1alpha1
metrics
Package namespace contains a controller that handles namespace lifecycle
 Package namespace contains a controller that handles namespace lifecycle
config
config/v1alpha1
deletion
Package nodeipam contains code for syncing cloud instances with node registry
 Package nodeipam contains code for syncing cloud instances with node registry
config
config/v1alpha1
ipam
Package ipam provides different allocators for assigning IP ranges to nodes.
 Package ipam provides different allocators for assigning IP ranges to nodes.
ipam/cidrset
ipam/sync
ipam/test
config
config/v1alpha1
scheduler
Package podautoscaler contains logic for autoscaling number of pods based on metrics observed.
 Package podautoscaler contains logic for autoscaling number of pods based on metrics observed.
config
config/v1alpha1
metrics
Package podgc contains a very simple pod "garbage collector" implementation, PodGCController, that runs in the controller manager.
 Package podgc contains a very simple pod "garbage collector" implementation, PodGCController, that runs in the controller manager.
config
config/v1alpha1
Package replicaset contains logic for watching and synchronizing ReplicaSets.
 Package replicaset contains logic for watching and synchronizing ReplicaSets.
config
config/v1alpha1
metrics
Package replication contains logic for watching and synchronizing replication controllers.
 Package replication contains logic for watching and synchronizing replication controllers.
config
config/v1alpha1
Package resourcequota contains a controller that makes resource quota usage observations
 Package resourcequota contains a controller that makes resource quota usage observations
config
config/v1alpha1
Package serviceaccount provides implementations to manage service accounts and service account tokens
 Package serviceaccount provides implementations to manage service accounts and service account tokens
config
config/v1alpha1
config
config/v1alpha1
config
config/v1alpha1
metrics
util
endpoint
endpointslice
node
volume
attachdetach
Package attachdetach implements a controller to manage volume attach and detach operations.
 Package attachdetach implements a controller to manage volume attach and detach operations.
attachdetach/cache
Package cache implements data structures used by the attach/detach controller to keep track of volumes, the nodes they are attached to, and the pods that reference them.
 Package cache implements data structures used by the attach/detach controller to keep track of volumes, the nodes they are attached to, and the pods that reference them.
attachdetach/config
attachdetach/config/v1alpha1
attachdetach/metrics
attachdetach/populator
Package populator implements interfaces that monitor and keep the states of the desired_state_of_word in sync with the "ground truth" from informer.
 Package populator implements interfaces that monitor and keep the states of the desired_state_of_word in sync with the "ground truth" from informer.
attachdetach/reconciler
Package reconciler implements interfaces that attempt to reconcile the desired state of the with the actual state of the world by triggering actions.
 Package reconciler implements interfaces that attempt to reconcile the desired state of the with the actual state of the world by triggering actions.
attachdetach/statusupdater
Package statusupdater implements interfaces that enable updating the status of API objects.
 Package statusupdater implements interfaces that enable updating the status of API objects.
attachdetach/testing
attachdetach/util
common
ephemeral
Package ephemeral implements the controller part of https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1698-generic-ephemeral-volumes It was derived from the expand controller.
 Package ephemeral implements the controller part of https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1698-generic-ephemeral-volumes It was derived from the expand controller.
ephemeral/config
ephemeral/config/v1alpha1
ephemeral/metrics
events
expand
persistentvolume
persistentvolume/config
persistentvolume/config/v1alpha1
persistentvolume/metrics
persistentvolume/options
persistentvolume/testing
protectionutil
pvcprotection
pvprotection

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.