controller

package
v1.1.0-beta3 Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2016 License: Apache-2.0, Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	CreatedByAnnotation = "kubernetes.io/created-by"

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

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 = framework.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.

Functions

func FilterActivePods 

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

FilterActivePods returns pods that have not terminated.

func FilterActiveReplicaSets added in v1.1.0 

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

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

func GetPodFromTemplate added in v1.1.0 

func GetPodFromTemplate(template *api.PodTemplateSpec, parentObject runtime.Object) (*api.Pod, error)

func IsPodActive added in v1.1.0 

func IsPodActive(p api.Pod) bool

func NoResyncPeriodFunc 

func NoResyncPeriodFunc() time.Duration

Returns 0 for resyncPeriod in case resyncing is not needed.

func PodKey added in v1.1.0 

func PodKey(pod *api.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 expcept there's not possibility for error since we know the exact type.

Types

type ActivePods 

type ActivePods []*api.Pod

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

func (ActivePods) Len 

func (s ActivePods) Len() int

func (ActivePods) Less 

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

func (ActivePods) Swap 

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

type ControlleeExpectations added in v1.1.0 

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

ControlleeExpectations track controllee creates/deletes.

func (*ControlleeExpectations) Add added in v1.1.0 

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

Add increments the add and del counters.

func (*ControlleeExpectations) Fulfilled added in v1.1.0 

func (e *ControlleeExpectations) Fulfilled() bool

Fulfilled returns true if this expectation has been fulfilled.

func (*ControlleeExpectations) GetExpectations added in v1.1.0 

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

GetExpectations returns the add and del expectations of the controllee.

type ControllerExpectations 

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 

func NewControllerExpectations() *ControllerExpectations

NewControllerExpectations returns a store for ControllerExpectations.

func (*ControllerExpectations) CreationObserved 

func (r *ControllerExpectations) CreationObserved(controllerKey string)

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

func (*ControllerExpectations) DeleteExpectations 

func (r *ControllerExpectations) DeleteExpectations(controllerKey string)

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

func (*ControllerExpectations) DeletionObserved 

func (r *ControllerExpectations) DeletionObserved(controllerKey string)

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

func (*ControllerExpectations) ExpectCreations 

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

func (*ControllerExpectations) ExpectDeletions 

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

func (*ControllerExpectations) GetExpectations 

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

GetExpectations returns the ControlleeExpectations of the given controller.

func (*ControllerExpectations) LowerExpectations added in v1.1.0 

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

Decrements the expectation counts of the given controller.

func (*ControllerExpectations) RaiseExpectations added in v1.1.0 

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

Increments the expectation counts of the given controller.

func (*ControllerExpectations) SatisfiedExpectations 

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 

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

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

type ControllerExpectationsInterface 

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 ControllersByCreationTimestamp added in v1.1.0 

type ControllersByCreationTimestamp []*api.ReplicationController

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

func (ControllersByCreationTimestamp) Len added in v1.1.0 

func (o ControllersByCreationTimestamp) Len() int

func (ControllersByCreationTimestamp) Less added in v1.1.0 

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

func (ControllersByCreationTimestamp) Swap added in v1.1.0 

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

type Expectations 

type Expectations interface {
	Fulfilled() bool
}

Expectations are either fulfilled, or expire naturally.

type FakePodControl 

type FakePodControl struct {
	sync.Mutex
	Templates     []api.PodTemplateSpec
	DeletePodName []string
	Err           error
}

func (*FakePodControl) Clear 

func (f *FakePodControl) Clear()

func (*FakePodControl) CreatePods 

func (f *FakePodControl) CreatePods(namespace string, spec *api.PodTemplateSpec, object runtime.Object) error

func (*FakePodControl) CreatePodsOnNode 

func (f *FakePodControl) CreatePodsOnNode(nodeName, namespace string, template *api.PodTemplateSpec, object runtime.Object) error

func (*FakePodControl) DeletePod 

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

type MatchingCache added in v1.1.0 

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

MatchingCache save label and selector matching relationship

func NewMatchingCache added in v1.1.0 

func NewMatchingCache(maxCacheEntries int) *MatchingCache

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

func (*MatchingCache) Add added in v1.1.0 

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

Add will add matching information to the cache.

func (*MatchingCache) GetMatchingObject added in v1.1.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.1.0 

func (c *MatchingCache) InvalidateAll()

InvalidateAll invalidate the whole cache.

func (*MatchingCache) Update added in v1.1.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.
	CreatePods(namespace string, template *api.PodTemplateSpec, object runtime.Object) error
	// CreatePodsOnNode creates a new pod accorting to the spec on the specified node.
	CreatePodsOnNode(nodeName, namespace string, template *api.PodTemplateSpec, object runtime.Object) error
	// DeletePod deletes the pod identified by podID.
	DeletePod(namespace string, podID string, object runtime.Object) error
}

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

type RealPodControl 

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

RealPodControl is the default implementation of PodControlInterface.

func (RealPodControl) CreatePods 

func (r RealPodControl) CreatePods(namespace string, template *api.PodTemplateSpec, object runtime.Object) error

func (RealPodControl) CreatePodsOnNode 

func (r RealPodControl) CreatePodsOnNode(nodeName, namespace string, template *api.PodTemplateSpec, object runtime.Object) error

func (RealPodControl) DeletePod 

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

type ReplicaSetsByCreationTimestamp added in v1.1.0 

type ReplicaSetsByCreationTimestamp []*extensions.ReplicaSet

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

func (ReplicaSetsByCreationTimestamp) Len added in v1.1.0 

func (o ReplicaSetsByCreationTimestamp) Len() int

func (ReplicaSetsByCreationTimestamp) Less added in v1.1.0 

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

func (ReplicaSetsByCreationTimestamp) Swap added in v1.1.0 

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

type ResyncPeriodFunc 

type ResyncPeriodFunc func() time.Duration

func StaticResyncPeriodFunc 

func StaticResyncPeriodFunc(resyncPeriod time.Duration) ResyncPeriodFunc

StaticResyncPeriodFunc returns the resync period specified

type UIDSet added in v1.1.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.1.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 consistenly, one needs to remember the expected deletes so they aren't double counted. TODO: Track creates as well (#22599)

func NewUIDTrackingControllerExpectations added in v1.1.0 

func NewUIDTrackingControllerExpectations(ce ControllerExpectationsInterface) *UIDTrackingControllerExpectations

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

func (*UIDTrackingControllerExpectations) DeleteExpectations added in v1.1.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.1.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.1.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.1.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
Package daemon contains logic for watching and synchronizing daemons.
 Package daemon contains logic for watching and synchronizing daemons.
Package service provides EndpointController implementation to manage and sync service endpoints.
 Package service provides EndpointController implementation to manage and sync service endpoints.
Package framework implements all the grunt work involved in running a simple controller.
 Package framework implements all the grunt work involved in running a simple controller.
informers
Package gc contains a very simple pod "garbage collector" implementation, GCController, that runs in the controller manager.
 Package gc contains a very simple pod "garbage collector" implementation, GCController, that runs in the controller manager.
Package job contains logic for watching and synchronizing jobs.
 Package job contains logic for watching and synchronizing jobs.
namespace contains a controller that handles namespace lifecycle
 namespace contains a controller that handles namespace lifecycle
Package node contains code for syncing cloud instances with node registry
 Package node contains code for syncing cloud instances with node registry
options
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.
metrics
Package replicaset contains logic for watching and synchronizing ReplicaSets.
 Package replicaset contains logic for watching and synchronizing ReplicaSets.
options
Package replication contains logic for watching and synchronizing replication controllers.
 Package replication contains logic for watching and synchronizing replication controllers.
resourcequota contains a controller that makes resource quota usage observations
 resourcequota contains a controller that makes resource quota usage observations
Package route contains code for syncing cloud routing rules with the list of registered nodes.
 Package route contains code for syncing cloud routing rules with the list of registered nodes.
Package service contains code for syncing cloud load balancers with the service registry.
 Package service contains code for syncing cloud load balancers with the service registry.
Package serviceaccount provides implementations to manage service accounts and service account tokens
 Package serviceaccount provides implementations to manage service accounts and service account tokens
Package volume implements a controller to manage volume attach and detach operations.
 Package volume implements a controller to manage volume attach and detach operations.
attacherdetacher
Package attacherdetacher implements interfaces that enable triggering attach and detach operations on volumes.
 Package attacherdetacher implements interfaces that enable triggering attach and detach operations on volumes.
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.
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.
testing

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.