package
1.6.0-alpha.0
Repository: https://github.com/andrewrynhard/kubernetes.git
Documentation: pkg.go.dev
# Functions
DeletionHandlingMetaNamespaceKeyFunc checks for DeletedFinalStateUnknown objects before calling MetaNamespaceKeyFunc.
IndexFuncToKeyFuncAdapter adapts an indexFunc to a keyFunc.
No description provided by the author
No description provided by the author
TODO: check for watch expired error and retry watch from latest point? Same issue exists for Until.
MetaNamespaceIndexFunc is a default index function that indexes based on an object's namespace.
MetaNamespaceKeyFunc is a convenient default KeyFunc which knows how to make keys for API objects which implement meta.Interface.
New makes a new Controller from the given Config.
No description provided by the author
No description provided by the author
No description provided by the author
NewDeltaFIFO returns a Store which can be used process changes to items.
No description provided by the author
NewFIFO returns a Store which can be used to queue up items to process.
No description provided by the author
NewIndexer returns an Indexer implemented simply with a map and a lock.
NewIndexerInformer returns a Indexer and a controller for populating the index while also providing event notifications.
NewInformer returns a Store and a controller for populating the store while also providing event notifications.
NewListWatchFromClient creates a new ListWatch from the specified client, resource, namespace and field selector.
NewNamedReflector same as NewReflector, but with a specified name for logging.
NewNamespaceKeyedIndexerAndReflector creates an Indexer and a Reflector The indexer is configured to key on namespace.
NewReflector creates a new Reflector object which will keep the given store up to date with the server's contents for the given resource.
No description provided by the author
No description provided by the author
NewSharedIndexInformer creates a new instance for the listwatcher.
NewSharedInformer creates a new instance for the listwatcher.
NewStorageClassLister returns a new lister.
NewStore returns a Store implemented simply with a map and a lock.
No description provided by the author
NewTTLStore creates and returns a ExpirationCache with a TTLPolicy.
NewUndeltaStore returns an UndeltaStore implemented with a Store.
Helper function for popping from Queue.
SplitMetaNamespaceKey returns the namespace and name that MetaNamespaceKeyFunc encoded into key.
WaitForCacheSync waits for caches to populate.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
The other types are obvious.
No description provided by the author
# Variables
ErrZeroLengthDeltasObject is returned in a KeyError if a Deltas object with zero length is encountered (should be impossible, even if such an object is accidentally produced by a DeltaCompressor-- but included for completeness).
# Structs
Config contains all the settings for a Controller.
Controller is a generic controller framework.
DeletedFinalStateUnknown is placed into a DeltaFIFO in the case where an object was deleted but the watch deletion event was missed.
Delta is the type stored by a DeltaFIFO.
DeltaFIFO is like FIFO, but allows you to process deletes.
ErrRequeue may be returned by a PopProcessFunc to safely requeue the current item.
ExpirationCache implements the store interface 1.
FakeStore lets you define custom functions for store operations.
No description provided by the author
FIFO receives adds and updates from a Reflector, and puts them in a queue for FIFO order processing.
IndexerToNamespaceLister gives an Indexer List method.
KeyError will be returned any time a KeyFunc gives an error; it includes the object at fault.
ListWatch knows how to list and watch a set of apiserver resources.
Reflector watches a specified resource and causes all changes to be reflected in the given store.
ResourceEventHandlerFuncs is an adaptor to let you easily specify as many or as few of the notification functions as you want while still implementing ResourceEventHandler.
StoreToCertificateRequestLister gives a store List and Exists methods.
StoreToDaemonSetLister gives a store List and Exists methods.
StoreToDeploymentLister helps list deployments.
StoreToEndpointsLister makes a Store that lists endpoints.
StoreToJobLister gives a store List and Exists methods.
StoreToLimitRangeLister helps list limit ranges.
StoreToNodeLister makes a Store have the List method of the client.NodeInterface The Store must contain (only) Nodes.
StoreToPersistentVolumeClaimLister helps list pvcs.
No description provided by the author
StoreToPodLister helps list pods.
Typed wrapper around a store of PersistentVolumes.
StoreToReplicaSetLister helps list replicasets.
StoreToReplicationControllerLister helps list rcs.
StoreToServiceAccountLister helps list service accounts.
StoreToServiceLister helps list services.
StoreToStatefulSetLister gives a store List and Exists methods.
TTLPolicy implements a ttl based ExpirationPolicy.
UndeltaStore listens to incremental updates and sends complete state on every change.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
TODO make the "Controller" private, and convert all references to use ControllerInterface instead.
DeltaCompressor is an algorithm that removes redundant changes.
ExpirationPolicy dictates when an object expires.
GenericLister is a lister skin on a generic Indexer.
GenericNamespaceLister is a lister skin on a generic Indexer.
Getter interface knows how to access Get method from RESTClient.
Indexer is a storage interface that lets you list objects using multiple indexing functions.
A KeyGetter is anything that knows how to get the value stored under a given key.
A KeyLister is anything that knows how to list its keys.
A KeyListerGetter is anything that knows how to list its keys and look up by key.
ListerWatcher is any object that knows how to perform an initial list and start a watch on a resource.
Queue is exactly like a Store, but has a Pop() method too.
ResourceEventHandler can handle notifications for events that happen to a resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
if you use this, there is one behavior change compared to a standard Informer.
StorageClassLister knows how to list storage classes.
Store is a generic object storage interface.
ThreadSafeStore is an interface that allows concurrent access to a storage backend.
# Type aliases
AppendFunc is used to add a matching item to whatever list the caller is using.
DeltaCompressorFunc should remove redundant changes; but changes that are redundant depend on one's desired semantics, so this is an injectable function.
Deltas is a list of one or more 'Delta's to an individual object.
DeltaType is the type of a change (addition, deletion, etc).
ExplicitKey can be passed to MetaNamespaceKeyFunc if you have the key for the object but not the object itself.
Index maps the indexed value to a set of keys in the store that match on that value.
Indexers maps a name to a IndexFunc.
IndexFunc knows how to provide an indexed value for an object.
Indices maps a name to an Index.
InformerSynced is a function that can be used to determine if an informer has synced.
KeyFunc knows how to make a key from an object.
ListFunc knows how to list resources.
NodeConditionPredicate is a function that indicates whether the given node's conditions meet some set of criteria defined by the function.
PopProcessFunc is passed to Pop() method of Queue interface.
ProcessFunc processes a single object.
WatchFunc knows how to watch resources.