Documentation ¶
Overview ¶
Package cache is a client-side caching mechanism. It is useful for reducing the number of server calls you'd otherwise need to make. Reflector watches a server and updates a Store. Two stores are provided; one that simply caches objects (for example, to allow a scheduler to list currently available nodes), and one that additionally acts as a FIFO queue (for example, to allow a scheduler to process incoming pods).
Index ¶
- Constants
- Variables
- func MetaNamespaceIndexFunc(obj interface{}) ([]string, error)
- func MetaNamespaceKeyFunc(obj interface{}) (string, error)
- func NewNamespaceKeyedIndexerAndReflector(lw ListerWatcher, expectedType interface{}, resyncPeriod time.Duration) (indexer Indexer, reflector *Reflector)
- func SplitMetaNamespaceKey(key string) (namespace, name string, err error)
- type DeletedFinalStateUnknown
- type Delta
- type DeltaCompressor
- type DeltaCompressorFunc
- type DeltaFIFO
- func (f *DeltaFIFO) Add(obj interface{}) error
- func (f *DeltaFIFO) AddIfNotPresent(obj interface{}) error
- func (f *DeltaFIFO) Delete(obj interface{}) error
- func (f *DeltaFIFO) Get(obj interface{}) (item interface{}, exists bool, err error)
- func (f *DeltaFIFO) GetByKey(key string) (item interface{}, exists bool, err error)
- func (f *DeltaFIFO) HasSynced() bool
- func (f *DeltaFIFO) KeyOf(obj interface{}) (string, error)
- func (f *DeltaFIFO) List() []interface{}
- func (f *DeltaFIFO) ListKeys() []string
- func (f *DeltaFIFO) Pop() interface{}
- func (f *DeltaFIFO) Replace(list []interface{}, resourceVersion string) error
- func (f *DeltaFIFO) Resync() error
- func (f *DeltaFIFO) Update(obj interface{}) error
- type DeltaType
- type Deltas
- type ExpirationCache
- func (c *ExpirationCache) Add(obj interface{}) error
- func (c *ExpirationCache) Delete(obj interface{}) error
- func (c *ExpirationCache) Get(obj interface{}) (interface{}, bool, error)
- func (c *ExpirationCache) GetByKey(key string) (interface{}, bool, error)
- func (c *ExpirationCache) List() []interface{}
- func (c *ExpirationCache) ListKeys() []string
- func (c *ExpirationCache) Replace(list []interface{}, resourceVersion string) error
- func (c *ExpirationCache) Resync() error
- func (c *ExpirationCache) Update(obj interface{}) error
- type ExpirationPolicy
- type ExplicitKey
- type FIFO
- func (f *FIFO) Add(obj interface{}) error
- func (f *FIFO) AddIfNotPresent(obj interface{}) error
- func (f *FIFO) Delete(obj interface{}) error
- func (f *FIFO) Get(obj interface{}) (item interface{}, exists bool, err error)
- func (f *FIFO) GetByKey(key string) (item interface{}, exists bool, err error)
- func (f *FIFO) HasSynced() bool
- func (f *FIFO) List() []interface{}
- func (f *FIFO) ListKeys() []string
- func (f *FIFO) Pop() interface{}
- func (f *FIFO) Replace(list []interface{}, resourceVersion string) error
- func (f *FIFO) Resync() error
- func (f *FIFO) Update(obj interface{}) error
- type FakeCustomStore
- func (f *FakeCustomStore) Add(obj interface{}) error
- func (f *FakeCustomStore) Delete(obj interface{}) error
- func (f *FakeCustomStore) Get(obj interface{}) (item interface{}, exists bool, err error)
- func (f *FakeCustomStore) GetByKey(key string) (item interface{}, exists bool, err error)
- func (f *FakeCustomStore) List() []interface{}
- func (f *FakeCustomStore) ListKeys() []string
- func (f *FakeCustomStore) Replace(list []interface{}, resourceVersion string) error
- func (f *FakeCustomStore) Resync() error
- func (f *FakeCustomStore) Update(obj interface{}) error
- type FakeExpirationPolicy
- type Getter
- type Index
- type IndexFunc
- type Indexer
- type Indexers
- type Indices
- type KeyError
- type KeyFunc
- type KeyGetter
- type KeyLister
- type KeyListerGetter
- type ListFunc
- type ListWatch
- type ListerWatcher
- type NodeConditionPredicate
- type Queue
- type Reflector
- type Store
- type StoreToDaemonSetLister
- type StoreToDeploymentLister
- func (s *StoreToDeploymentLister) Exists(deployment *extensions.Deployment) (bool, error)
- func (s *StoreToDeploymentLister) GetDeploymentsForReplicaSet(rs *extensions.ReplicaSet) (deployments []extensions.Deployment, err error)
- func (s *StoreToDeploymentLister) List() (deployments []extensions.Deployment, err error)
- type StoreToEndpointsLister
- type StoreToJobLister
- type StoreToNodeLister
- type StoreToPVCFetcher
- type StoreToPVFetcher
- type StoreToPetSetLister
- func (s *StoreToPetSetLister) Exists(ps *apps.PetSet) (bool, error)
- func (s *StoreToPetSetLister) GetPodPetSets(pod *api.Pod) (psList []apps.PetSet, err error)
- func (s *StoreToPetSetLister) List() (psList []apps.PetSet, err error)
- func (s *StoreToPetSetLister) PetSets(namespace string) storePetSetsNamespacer
- type StoreToPodLister
- type StoreToReplicaSetLister
- func (s *StoreToReplicaSetLister) Exists(rs *extensions.ReplicaSet) (bool, error)
- func (s *StoreToReplicaSetLister) GetPodReplicaSets(pod *api.Pod) (rss []extensions.ReplicaSet, err error)
- func (s *StoreToReplicaSetLister) List() (rss []extensions.ReplicaSet, err error)
- func (s *StoreToReplicaSetLister) ReplicaSets(namespace string) storeReplicaSetsNamespacer
- type StoreToReplicationControllerLister
- func (s *StoreToReplicationControllerLister) Exists(controller *api.ReplicationController) (bool, error)
- func (s *StoreToReplicationControllerLister) GetPodControllers(pod *api.Pod) (controllers []api.ReplicationController, err error)
- func (s *StoreToReplicationControllerLister) List() (controllers []api.ReplicationController, err error)
- func (s *StoreToReplicationControllerLister) ReplicationControllers(namespace string) storeReplicationControllersNamespacer
- type StoreToServiceLister
- type TTLPolicy
- type ThreadSafeStore
- type UndeltaStore
- type WatchFunc
Constants ¶
const (
NamespaceIndex string = "namespace"
)
Variables ¶
var ( // 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). ErrZeroLengthDeltasObject = errors.New("0 length Deltas object; can't get key") )
Functions ¶
func MetaNamespaceIndexFunc ¶ added in v0.11.0
MetaNamespaceIndexFunc is a default index function that indexes based on an object's namespace
func MetaNamespaceKeyFunc ¶ added in v0.10.0
MetaNamespaceKeyFunc is a convenient default KeyFunc which knows how to make keys for API objects which implement meta.Interface. The key uses the format <namespace>/<name> unless <namespace> is empty, then it's just <name>.
TODO: replace key-as-string with a key-as-struct so that this packing/unpacking won't be necessary.
func NewNamespaceKeyedIndexerAndReflector ¶ added in v0.13.0
func NewNamespaceKeyedIndexerAndReflector(lw ListerWatcher, expectedType interface{}, resyncPeriod time.Duration) (indexer Indexer, reflector *Reflector)
NewNamespaceKeyedIndexerAndReflector creates an Indexer and a Reflector The indexer is configured to key on namespace
func SplitMetaNamespaceKey ¶ added in v0.16.0
SplitMetaNamespaceKey returns the namespace and name that MetaNamespaceKeyFunc encoded into key.
TODO: replace key-as-string with a key-as-struct so that this packing/unpacking won't be necessary.
Types ¶
type DeletedFinalStateUnknown ¶ added in v0.15.0
type DeletedFinalStateUnknown struct { Key string Obj interface{} }
DeletedFinalStateUnknown is placed into a DeltaFIFO in the case where an object was deleted but the watch deletion event was missed. In this case we don't know the final "resting" state of the object, so there's a chance the included `Obj` is stale.
type Delta ¶ added in v0.15.0
type Delta struct { Type DeltaType Object interface{} }
Delta is the type stored by a DeltaFIFO. It tells you what change happened, and the object's state after* that change.
[*] Unless the change is a deletion, and then you'll get the final
state of the object before it was deleted.
type DeltaCompressor ¶ added in v0.15.0
DeltaCompressor is an algorithm that removes redundant changes.
type DeltaCompressorFunc ¶ added in v0.15.0
DeltaCompressorFunc should remove redundant changes; but changes that are redundant depend on one's desired semantics, so this is an injectable function.
DeltaCompressorFunc adapts a raw function to be a DeltaCompressor.
func (DeltaCompressorFunc) Compress ¶ added in v0.15.0
func (dc DeltaCompressorFunc) Compress(d Deltas) Deltas
Compress just calls dc.
type DeltaFIFO ¶ added in v0.15.0
type DeltaFIFO struct {
// contains filtered or unexported fields
}
DeltaFIFO is like FIFO, but allows you to process deletes.
DeltaFIFO is a producer-consumer queue, where a Reflector is intended to be the producer, and the consumer is whatever calls the Pop() method.
DeltaFIFO solves this use case:
- You want to process every object change (delta) at most once.
- When you process an object, you want to see everything that's happened to it since you last processed it.
- You want to process the deletion of objects.
- You might want to periodically reprocess objects.
DeltaFIFO's Pop(), Get(), and GetByKey() methods return interface{} to satisfy the Store/Queue interfaces, but it will always return an object of type Deltas.
A note on threading: If you call Pop() in parallel from multiple threads, you could end up with multiple threads processing slightly different versions of the same object.
A note on the KeyLister used by the DeltaFIFO: It's main purpose is to list keys that are "known", for the purpose of figuring out which items have been deleted when Replace() or Delete() are called. The deleted object will be included in the DeleteFinalStateUnknown markers. These objects could be stale.
You may provide a function to compress deltas (e.g., represent a series of Updates as a single Update).
func NewDeltaFIFO ¶ added in v0.15.0
func NewDeltaFIFO(keyFunc KeyFunc, compressor DeltaCompressor, knownObjects KeyListerGetter) *DeltaFIFO
NewDeltaFIFO returns a Store which can be used process changes to items.
keyFunc is used to figure out what key an object should have. (It's exposed in the returned DeltaFIFO's KeyOf() method, with bonus features.)
'compressor' may compress as many or as few items as it wants (including returning an empty slice), but it should do what it does quickly since it is called while the queue is locked. 'compressor' may be nil if you don't want any delta compression.
'keyLister' is expected to return a list of keys that the consumer of this queue "knows about". It is used to decide which items are missing when Replace() is called; 'Deleted' deltas are produced for these items. It may be nil if you don't need to detect all deletions. TODO: consider merging keyLister with this object, tracking a list of
"known" keys when Pop() is called. Have to think about how that affects error retrying.
TODO(lavalamp): I believe there is a possible race only when using an
external known object source that the above TODO would fix.
Also see the comment on DeltaFIFO.
func (*DeltaFIFO) Add ¶ added in v0.15.0
Add inserts an item, and puts it in the queue. The item is only enqueued if it doesn't already exist in the set.
func (*DeltaFIFO) AddIfNotPresent ¶ added in v0.15.0
AddIfNotPresent inserts an item, and puts it in the queue. If the item is already present in the set, it is neither enqueued nor added to the set.
This is useful in a single producer/consumer scenario so that the consumer can safely retry items without contending with the producer and potentially enqueueing stale items.
Important: obj must be a Deltas (the output of the Pop() function). Yes, this is different from the Add/Update/Delete functions.
func (*DeltaFIFO) Delete ¶ added in v0.15.0
Delete is just like Add, but makes an Deleted Delta. If the item does not already exist, it will be ignored. (It may have already been deleted by a Replace (re-list), for example.
func (*DeltaFIFO) Get ¶ added in v0.15.0
Get returns the complete list of deltas for the requested item, or sets exists=false. You should treat the items returned inside the deltas as immutable.
func (*DeltaFIFO) GetByKey ¶ added in v0.15.0
GetByKey returns the complete list of deltas for the requested item, setting exists=false if that list is empty. You should treat the items returned inside the deltas as immutable.
func (*DeltaFIFO) HasSynced ¶ added in v1.2.0
Return true if an Add/Update/Delete/AddIfNotPresent are called first, or an Update called first but the first batch of items inserted by Replace() has been popped
func (*DeltaFIFO) KeyOf ¶ added in v0.15.0
KeyOf exposes f's keyFunc, but also detects the key of a Deltas object or DeletedFinalStateUnknown objects.
func (*DeltaFIFO) List ¶ added in v0.15.0
func (f *DeltaFIFO) List() []interface{}
List returns a list of all the items; it returns the object from the most recent Delta. You should treat the items returned inside the deltas as immutable.
func (*DeltaFIFO) ListKeys ¶ added in v0.15.0
ListKeys returns a list of all the keys of the objects currently in the FIFO.
func (*DeltaFIFO) Pop ¶ added in v0.15.0
func (f *DeltaFIFO) Pop() interface{}
Pop blocks until an item is added to the queue, and then returns it. If multiple items are ready, they are returned in the order in which they were added/updated. The item is removed from the queue (and the store) before it is returned, so if you don't successfully process it, you need to add it back with AddIfNotPresent().
Pop returns a 'Deltas', which has a complete list of all the things that happened to the object (deltas) while it was sitting in the queue.
func (*DeltaFIFO) Replace ¶ added in v0.15.0
Replace will delete the contents of 'f', using instead the given map. 'f' takes ownership of the map, you should not reference the map again after calling this function. f's queue is reset, too; upon return, it will contain the items in the map, in no particular order.
type DeltaType ¶ added in v0.15.0
type DeltaType string
DeltaType is the type of a change (addition, deletion, etc)
const ( Added DeltaType = "Added" Updated DeltaType = "Updated" Deleted DeltaType = "Deleted" // The other types are obvious. You'll get Sync deltas when: // * A watch expires/errors out and a new list/watch cycle is started. // * You've turned on periodic syncs. // (Anything that trigger's DeltaFIFO's Replace() method.) Sync DeltaType = "Sync" )
type Deltas ¶ added in v0.15.0
type Deltas []Delta
Deltas is a list of one or more 'Delta's to an individual object. The oldest delta is at index 0, the newest delta is the last one.
type ExpirationCache ¶ added in v0.15.0
type ExpirationCache struct {
// contains filtered or unexported fields
}
ExpirationCache implements the store interface
- All entries are automatically time stamped on insert a. The key is computed based off the original item/keyFunc b. The value inserted under that key is the timestamped item
- Expiration happens lazily on read based on the expiration policy a. No item can be inserted into the store while we're expiring *any* item in the cache.
- Time-stamps are stripped off unexpired entries before return
Note that the ExpirationCache is inherently slower than a normal threadSafeStore because it takes a write lock every time it checks if an item has expired.
func (*ExpirationCache) Add ¶ added in v0.15.0
func (c *ExpirationCache) Add(obj interface{}) error
Add timestamps an item and inserts it into the cache, overwriting entries that might exist under the same key.
func (*ExpirationCache) Delete ¶ added in v0.15.0
func (c *ExpirationCache) Delete(obj interface{}) error
Delete removes an item from the cache.
func (*ExpirationCache) Get ¶ added in v0.15.0
func (c *ExpirationCache) Get(obj interface{}) (interface{}, bool, error)
Get returns unexpired items. It purges the cache of expired items in the process.
func (*ExpirationCache) GetByKey ¶ added in v0.15.0
func (c *ExpirationCache) GetByKey(key string) (interface{}, bool, error)
GetByKey returns the item stored under the key, or sets exists=false.
func (*ExpirationCache) List ¶ added in v0.15.0
func (c *ExpirationCache) List() []interface{}
List retrieves a list of unexpired items. It purges the cache of expired items in the process.
func (*ExpirationCache) ListKeys ¶ added in v0.15.0
func (c *ExpirationCache) ListKeys() []string
ListKeys returns a list of all keys in the expiration cache.
func (*ExpirationCache) Replace ¶ added in v0.15.0
func (c *ExpirationCache) Replace(list []interface{}, resourceVersion string) error
Replace will convert all items in the given list to TimestampedEntries before attempting the replace operation. The replace operation will delete the contents of the ExpirationCache `c`.
func (*ExpirationCache) Resync ¶ added in v1.3.0
func (c *ExpirationCache) Resync() error
Resync will touch all objects to put them into the processing queue
func (*ExpirationCache) Update ¶ added in v0.15.0
func (c *ExpirationCache) Update(obj interface{}) error
Update has not been implemented yet for lack of a use case, so this method simply calls `Add`. This effectively refreshes the timestamp.
type ExpirationPolicy ¶ added in v0.15.0
type ExpirationPolicy interface {
IsExpired(obj *timestampedEntry) bool
}
ExpirationPolicy dictates when an object expires. Currently only abstracted out so unittests don't rely on the system clock.
type ExplicitKey ¶ added in v0.15.0
type ExplicitKey string
ExplicitKey can be passed to MetaNamespaceKeyFunc if you have the key for the object but not the object itself.
type FIFO ¶
type FIFO struct {
// contains filtered or unexported fields
}
FIFO receives adds and updates from a Reflector, and puts them in a queue for FIFO order processing. If multiple adds/updates of a single item happen while an item is in the queue before it has been processed, it will only be processed once, and when it is processed, the most recent version will be processed. This can't be done with a channel.
FIFO solves this use case:
- You want to process every object (exactly) once.
- You want to process the most recent version of the object when you process it.
- You do not want to process deleted objects, they should be removed from the queue.
- You do not want to periodically reprocess objects.
Compare with DeltaFIFO for other use cases.
func (*FIFO) Add ¶
Add inserts an item, and puts it in the queue. The item is only enqueued if it doesn't already exist in the set.
func (*FIFO) AddIfNotPresent ¶ added in v0.12.0
AddIfNotPresent inserts an item, and puts it in the queue. If the item is already present in the set, it is neither enqueued nor added to the set.
This is useful in a single producer/consumer scenario so that the consumer can safely retry items without contending with the producer and potentially enqueueing stale items.
func (*FIFO) Delete ¶
Delete removes an item. It doesn't add it to the queue, because this implementation assumes the consumer only cares about the objects, not the order in which they were created/added.
func (*FIFO) HasSynced ¶ added in v1.2.0
Return true if an Add/Update/Delete/AddIfNotPresent are called first, or an Update called first but the first batch of items inserted by Replace() has been popped
func (*FIFO) ListKeys ¶ added in v0.15.0
ListKeys returns a list of all the keys of the objects currently in the FIFO.
func (*FIFO) Pop ¶
func (f *FIFO) Pop() interface{}
Pop waits until an item is ready and returns it. If multiple items are ready, they are returned in the order in which they were added/updated. The item is removed from the queue (and the store) before it is returned, so if you don't successfully process it, you need to add it back with AddIfNotPresent().
func (*FIFO) Replace ¶
Replace will delete the contents of 'f', using instead the given map. 'f' takes ownership of the map, you should not reference the map again after calling this function. f's queue is reset, too; upon return, it will contain the items in the map, in no particular order.
type FakeCustomStore ¶ added in v1.3.0
type FakeCustomStore struct { AddFunc func(obj interface{}) error UpdateFunc func(obj interface{}) error DeleteFunc func(obj interface{}) error ListFunc func() []interface{} ListKeysFunc func() []string GetFunc func(obj interface{}) (item interface{}, exists bool, err error) GetByKeyFunc func(key string) (item interface{}, exists bool, err error) ReplaceFunc func(list []interface{}, resourceVerion string) error ResyncFunc func() error }
FakeStore lets you define custom functions for store operations
func (*FakeCustomStore) Add ¶ added in v1.3.0
func (f *FakeCustomStore) Add(obj interface{}) error
Add calls the custom Add function if defined
func (*FakeCustomStore) Delete ¶ added in v1.3.0
func (f *FakeCustomStore) Delete(obj interface{}) error
Delete calls the custom Delete function if defined
func (*FakeCustomStore) Get ¶ added in v1.3.0
func (f *FakeCustomStore) Get(obj interface{}) (item interface{}, exists bool, err error)
Get calls the custom Get function if defined
func (*FakeCustomStore) GetByKey ¶ added in v1.3.0
func (f *FakeCustomStore) GetByKey(key string) (item interface{}, exists bool, err error)
GetByKey calls the custom GetByKey function if defined
func (*FakeCustomStore) List ¶ added in v1.3.0
func (f *FakeCustomStore) List() []interface{}
List calls the custom List function if defined
func (*FakeCustomStore) ListKeys ¶ added in v1.3.0
func (f *FakeCustomStore) ListKeys() []string
ListKeys calls the custom ListKeys function if defined
func (*FakeCustomStore) Replace ¶ added in v1.3.0
func (f *FakeCustomStore) Replace(list []interface{}, resourceVersion string) error
Replace calls the custom Replace function if defined
func (*FakeCustomStore) Resync ¶ added in v1.3.0
func (f *FakeCustomStore) Resync() error
Resync calls the custom Resync function if defined
func (*FakeCustomStore) Update ¶ added in v1.3.0
func (f *FakeCustomStore) Update(obj interface{}) error
Update calls the custom Update function if defined
type FakeExpirationPolicy ¶ added in v0.15.0
func (*FakeExpirationPolicy) IsExpired ¶ added in v0.15.0
func (p *FakeExpirationPolicy) IsExpired(obj *timestampedEntry) bool
type Getter ¶ added in v1.1.0
type Getter interface {
Get() *restclient.Request
}
Getter interface knows how to access Get method from RESTClient.
type Index ¶ added in v0.11.0
Index maps the indexed value to a set of keys in the store that match on that value
type Indexer ¶ added in v0.11.0
type Indexer interface { Store // Retrieve list of objects that match on the named indexing function Index(indexName string, obj interface{}) ([]interface{}, error) // ListIndexFuncValues returns the list of generated values of an Index func ListIndexFuncValues(indexName string) []string // ByIndex lists object that match on the named indexing function with the exact key ByIndex(indexName, indexKey string) ([]interface{}, error) // GetIndexer return the indexers GetIndexers() Indexers // AddIndexers adds more indexers to this store. If you call this after you already have data // in the store, the results are undefined. AddIndexers(newIndexers Indexers) error }
Indexer is a storage interface that lets you list objects using multiple indexing functions
func NewIndexer ¶ added in v0.11.0
NewIndexer returns an Indexer implemented simply with a map and a lock.
type KeyError ¶ added in v0.15.0
type KeyError struct { Obj interface{} Err error }
KeyError will be returned any time a KeyFunc gives an error; it includes the object at fault.
type KeyFunc ¶ added in v0.10.0
KeyFunc knows how to make a key from an object. Implementations should be deterministic.
func IndexFuncToKeyFuncAdapter ¶ added in v1.1.0
IndexFuncToKeyFuncAdapter adapts an indexFunc to a keyFunc. This is only useful if your index function returns unique values for every object. This is conversion can create errors when more than one key is found. You should prefer to make proper key and index functions.
type KeyGetter ¶ added in v0.19.0
A KeyGetter is anything that knows how to get the value stored under a given key.
type KeyLister ¶ added in v0.15.0
type KeyLister interface {
ListKeys() []string
}
A KeyLister is anything that knows how to list its keys.
type KeyListerGetter ¶ added in v1.2.0
A KeyListerGetter is anything that knows how to list its keys and look up by key.
type ListFunc ¶ added in v0.11.0
type ListFunc func(options api.ListOptions) (runtime.Object, error)
ListFunc knows how to list resources
type ListWatch ¶ added in v0.9.0
ListWatch knows how to list and watch a set of apiserver resources. It satisfies the ListerWatcher interface. It is a convenience function for users of NewReflector, etc. ListFunc and WatchFunc must not be nil
func NewListWatchFromClient ¶ added in v0.11.0
func NewListWatchFromClient(c Getter, resource string, namespace string, fieldSelector fields.Selector) *ListWatch
NewListWatchFromClient creates a new ListWatch from the specified client, resource, namespace and field selector.
type ListerWatcher ¶
type ListerWatcher interface { // List should return a list type object; the Items field will be extracted, and the // ResourceVersion field will be used to start the watch in the right place. List(options api.ListOptions) (runtime.Object, error) // Watch should begin a watch at the specified version. Watch(options api.ListOptions) (watch.Interface, error) }
ListerWatcher is any object that knows how to perform an initial list and start a watch on a resource.
type NodeConditionPredicate ¶ added in v1.2.0
NodeConditionPredicate is a function that indicates whether the given node's conditions meet some set of criteria defined by the function.
type Queue ¶ added in v0.15.0
type Queue interface { Store // Pop blocks until it has something to return. Pop() interface{} // AddIfNotPresent adds a value previously // returned by Pop back into the queue as long // as nothing else (presumably more recent) // has since been added. AddIfNotPresent(interface{}) error // Return true if the first batch of items has been popped HasSynced() bool }
Queue is exactly like a Store, but has a Pop() method too.
type Reflector ¶
type Reflector struct {
// contains filtered or unexported fields
}
Reflector watches a specified resource and causes all changes to be reflected in the given store.
func NewNamedReflector ¶ added in v1.1.0
func NewNamedReflector(name string, lw ListerWatcher, expectedType interface{}, store Store, resyncPeriod time.Duration) *Reflector
NewNamedReflector same as NewReflector, but with a specified name for logging
func NewReflector ¶
func NewReflector(lw ListerWatcher, expectedType interface{}, store Store, resyncPeriod time.Duration) *Reflector
NewReflector creates a new Reflector object which will keep the given store up to date with the server's contents for the given resource. Reflector promises to only put things in the store that have the type of expectedType, unless expectedType is nil. If resyncPeriod is non-zero, then lists will be executed after every resyncPeriod, so that you can use reflectors to periodically process everything as well as incrementally processing the things that change.
func (*Reflector) LastSyncResourceVersion ¶ added in v0.15.0
LastSyncResourceVersion is the resource version observed when last sync with the underlying store The value returned is not synchronized with access to the underlying store and is not thread-safe
func (*Reflector) ListAndWatch ¶ added in v1.1.0
ListAndWatch first lists all items and get the resource version at the moment of call, and then use the resource version to watch. It returns error if ListAndWatch didn't even try to initialize watch.
type Store ¶
type Store interface { Add(obj interface{}) error Update(obj interface{}) error Delete(obj interface{}) error List() []interface{} ListKeys() []string Get(obj interface{}) (item interface{}, exists bool, err error) GetByKey(key string) (item interface{}, exists bool, err error) // Replace will delete the contents of the store, using instead the // given list. Store takes ownership of the list, you should not reference // it after calling this function. Replace([]interface{}, string) error Resync() error }
Store is a generic object storage interface. Reflector knows how to watch a server and update a store. A generic store is provided, which allows Reflector to be used as a local caching system, and an LRU store, which allows Reflector to work like a queue of items yet to be processed.
Store makes no assumptions about stored object identity; it is the responsibility of a Store implementation to provide a mechanism to correctly key objects and to define the contract for obtaining objects by some arbitrary key type.
func NewFakeExpirationStore ¶ added in v0.15.0
type StoreToDaemonSetLister ¶ added in v1.1.0
type StoreToDaemonSetLister struct {
Store
}
StoreToDaemonSetLister gives a store List and Exists methods. The store must contain only DaemonSets.
func (*StoreToDaemonSetLister) Exists ¶ added in v1.1.0
func (s *StoreToDaemonSetLister) Exists(ds *extensions.DaemonSet) (bool, error)
Exists checks if the given daemon set exists in the store.
func (*StoreToDaemonSetLister) GetPodDaemonSets ¶ added in v1.1.0
func (s *StoreToDaemonSetLister) GetPodDaemonSets(pod *api.Pod) (daemonSets []extensions.DaemonSet, err error)
GetPodDaemonSets returns a list of daemon sets managing a pod. Returns an error if and only if no matching daemon sets are found.
func (*StoreToDaemonSetLister) List ¶ added in v1.1.0
func (s *StoreToDaemonSetLister) List() (dss extensions.DaemonSetList, err error)
List lists all daemon sets in the store. TODO: converge on the interface in pkg/client
type StoreToDeploymentLister ¶ added in v1.2.0
type StoreToDeploymentLister struct {
Store
}
StoreToDeploymentLister gives a store List and Exists methods. The store must contain only Deployments.
func (*StoreToDeploymentLister) Exists ¶ added in v1.2.0
func (s *StoreToDeploymentLister) Exists(deployment *extensions.Deployment) (bool, error)
Exists checks if the given deployment exists in the store.
func (*StoreToDeploymentLister) GetDeploymentsForReplicaSet ¶ added in v1.2.0
func (s *StoreToDeploymentLister) GetDeploymentsForReplicaSet(rs *extensions.ReplicaSet) (deployments []extensions.Deployment, err error)
GetDeploymentsForReplicaSet returns a list of deployments managing a replica set. Returns an error only if no matching deployments are found.
func (*StoreToDeploymentLister) List ¶ added in v1.2.0
func (s *StoreToDeploymentLister) List() (deployments []extensions.Deployment, err error)
StoreToDeploymentLister lists all deployments in the store. TODO: converge on the interface in pkg/client
type StoreToEndpointsLister ¶ added in v1.1.0
type StoreToEndpointsLister struct {
Store
}
StoreToEndpointsLister makes a Store that lists endpoints.
func (*StoreToEndpointsLister) GetServiceEndpoints ¶ added in v1.1.0
func (s *StoreToEndpointsLister) GetServiceEndpoints(svc *api.Service) (ep api.Endpoints, err error)
GetServiceEndpoints returns the endpoints of a service, matched on service name.
func (*StoreToEndpointsLister) List ¶ added in v1.1.0
func (s *StoreToEndpointsLister) List() (services api.EndpointsList, err error)
List lists all endpoints in the store.
type StoreToJobLister ¶ added in v1.1.0
type StoreToJobLister struct {
Store
}
StoreToJobLister gives a store List and Exists methods. The store must contain only Jobs.
func (*StoreToJobLister) Exists ¶ added in v1.1.0
func (s *StoreToJobLister) Exists(job *batch.Job) (bool, error)
Exists checks if the given job exists in the store.
func (*StoreToJobLister) GetPodJobs ¶ added in v1.1.0
GetPodJobs returns a list of jobs managing a pod. Returns an error only if no matching jobs are found.
type StoreToNodeLister ¶ added in v0.9.0
type StoreToNodeLister struct {
Store
}
StoreToNodeLister makes a Store have the List method of the client.NodeInterface The Store must contain (only) Nodes.
func (*StoreToNodeLister) List ¶ added in v0.9.0
func (s *StoreToNodeLister) List() (machines api.NodeList, err error)
func (*StoreToNodeLister) NodeCondition ¶ added in v0.17.0
func (s *StoreToNodeLister) NodeCondition(predicate NodeConditionPredicate) storeToNodeConditionLister
NodeCondition returns a storeToNodeConditionLister
type StoreToPVCFetcher ¶ added in v1.2.0
type StoreToPVCFetcher struct {
Store
}
Typed wrapper around a store of PersistentVolumeClaims
func (*StoreToPVCFetcher) GetPersistentVolumeClaimInfo ¶ added in v1.2.0
func (s *StoreToPVCFetcher) GetPersistentVolumeClaimInfo(namespace string, id string) (*api.PersistentVolumeClaim, error)
GetPersistentVolumeClaimInfo returns cached data for the PersistentVolumeClaim 'id'.
type StoreToPVFetcher ¶ added in v1.2.0
type StoreToPVFetcher struct {
Store
}
Typed wrapper around a store of PersistentVolumes
func (*StoreToPVFetcher) GetPersistentVolumeInfo ¶ added in v1.2.0
func (s *StoreToPVFetcher) GetPersistentVolumeInfo(id string) (*api.PersistentVolume, error)
GetPersistentVolumeInfo returns cached data for the PersistentVolume 'id'.
type StoreToPetSetLister ¶ added in v1.3.0
type StoreToPetSetLister struct {
Store
}
StoreToPetSetLister gives a store List and Exists methods. The store must contain only PetSets.
func (*StoreToPetSetLister) Exists ¶ added in v1.3.0
func (s *StoreToPetSetLister) Exists(ps *apps.PetSet) (bool, error)
Exists checks if the given PetSet exists in the store.
func (*StoreToPetSetLister) GetPodPetSets ¶ added in v1.3.0
GetPodPetSets returns a list of PetSets managing a pod. Returns an error only if no matching PetSets are found.
func (*StoreToPetSetLister) List ¶ added in v1.3.0
func (s *StoreToPetSetLister) List() (psList []apps.PetSet, err error)
List lists all PetSets in the store.
func (*StoreToPetSetLister) PetSets ¶ added in v1.3.0
func (s *StoreToPetSetLister) PetSets(namespace string) storePetSetsNamespacer
type StoreToPodLister ¶ added in v0.9.0
type StoreToPodLister struct {
Indexer
}
StoreToPodLister makes a Store have the List method of the client.PodInterface The Store must contain (only) Pods.
Example: s := cache.NewStore() lw := cache.ListWatch{Client: c, FieldSelector: sel, Resource: "pods"} r := cache.NewReflector(lw, &api.Pod{}, s).Run() l := StoreToPodLister{s} l.List()
func (*StoreToPodLister) Exists ¶ added in v0.13.1
func (s *StoreToPodLister) Exists(pod *api.Pod) (bool, error)
Exists returns true if a pod matching the namespace/name of the given pod exists in the store.
func (*StoreToPodLister) List ¶ added in v0.9.0
Please note that selector is filtering among the pods that have gotten into the store; there may have been some filtering that already happened before that.
TODO: converge on the interface in pkg/client.
func (*StoreToPodLister) Pods ¶ added in v0.16.0
func (s *StoreToPodLister) Pods(namespace string) storePodsNamespacer
Pods is taking baby steps to be more like the api in pkg/client
type StoreToReplicaSetLister ¶ added in v1.2.0
type StoreToReplicaSetLister struct {
Store
}
StoreToReplicaSetLister gives a store List and Exists methods. The store must contain only ReplicaSets.
func (*StoreToReplicaSetLister) Exists ¶ added in v1.2.0
func (s *StoreToReplicaSetLister) Exists(rs *extensions.ReplicaSet) (bool, error)
Exists checks if the given ReplicaSet exists in the store.
func (*StoreToReplicaSetLister) GetPodReplicaSets ¶ added in v1.2.0
func (s *StoreToReplicaSetLister) GetPodReplicaSets(pod *api.Pod) (rss []extensions.ReplicaSet, err error)
GetPodReplicaSets returns a list of ReplicaSets managing a pod. Returns an error only if no matching ReplicaSets are found.
func (*StoreToReplicaSetLister) List ¶ added in v1.2.0
func (s *StoreToReplicaSetLister) List() (rss []extensions.ReplicaSet, err error)
List lists all ReplicaSets in the store. TODO: converge on the interface in pkg/client
func (*StoreToReplicaSetLister) ReplicaSets ¶ added in v1.2.0
func (s *StoreToReplicaSetLister) ReplicaSets(namespace string) storeReplicaSetsNamespacer
type StoreToReplicationControllerLister ¶ added in v1.1.0
type StoreToReplicationControllerLister struct {
Indexer
}
StoreToReplicationControllerLister gives a store List and Exists methods. The store must contain only ReplicationControllers.
func (*StoreToReplicationControllerLister) Exists ¶ added in v1.1.0
func (s *StoreToReplicationControllerLister) Exists(controller *api.ReplicationController) (bool, error)
Exists checks if the given rc exists in the store.
func (*StoreToReplicationControllerLister) GetPodControllers ¶ added in v1.1.0
func (s *StoreToReplicationControllerLister) GetPodControllers(pod *api.Pod) (controllers []api.ReplicationController, err error)
GetPodControllers returns a list of replication controllers managing a pod. Returns an error only if no matching controllers are found.
func (*StoreToReplicationControllerLister) List ¶ added in v1.1.0
func (s *StoreToReplicationControllerLister) List() (controllers []api.ReplicationController, err error)
StoreToReplicationControllerLister lists all controllers in the store. TODO: converge on the interface in pkg/client
func (*StoreToReplicationControllerLister) ReplicationControllers ¶ added in v1.2.0
func (s *StoreToReplicationControllerLister) ReplicationControllers(namespace string) storeReplicationControllersNamespacer
type StoreToServiceLister ¶ added in v0.9.0
type StoreToServiceLister struct {
Store
}
StoreToServiceLister makes a Store that has the List method of the client.ServiceInterface The Store must contain (only) Services.
func (*StoreToServiceLister) GetPodServices ¶ added in v0.9.0
TODO: Move this back to scheduler as a helper function that takes a Store, rather than a method of StoreToServiceLister.
func (*StoreToServiceLister) List ¶ added in v0.9.0
func (s *StoreToServiceLister) List() (services api.ServiceList, err error)
type TTLPolicy ¶ added in v0.15.0
type TTLPolicy struct { // >0: Expire entries with an age > ttl // <=0: Don't expire any entry Ttl time.Duration // Clock used to calculate ttl expiration Clock util.Clock }
TTLPolicy implements a ttl based ExpirationPolicy.
type ThreadSafeStore ¶ added in v0.15.0
type ThreadSafeStore interface { Add(key string, obj interface{}) Update(key string, obj interface{}) Delete(key string) Get(key string) (item interface{}, exists bool) List() []interface{} ListKeys() []string Replace(map[string]interface{}, string) Index(indexName string, obj interface{}) ([]interface{}, error) ListIndexFuncValues(name string) []string ByIndex(indexName, indexKey string) ([]interface{}, error) GetIndexers() Indexers // AddIndexers adds more indexers to this store. If you call this after you already have data // in the store, the results are undefined. AddIndexers(newIndexers Indexers) error Resync() error }
ThreadSafeStore is an interface that allows concurrent access to a storage backend. TL;DR caveats: you must not modify anything returned by Get or List as it will break the indexing feature in addition to not being thread safe.
The guarantees of thread safety provided by List/Get are only valid if the caller treats returned items as read-only. For example, a pointer inserted in the store through `Add` will be returned as is by `Get`. Multiple clients might invoke `Get` on the same key and modify the pointer in a non-thread-safe way. Also note that modifying objects stored by the indexers (if any) will *not* automatically lead to a re-index. So it's not a good idea to directly modify the objects returned by Get/List, in general.
func NewThreadSafeStore ¶ added in v0.15.0
func NewThreadSafeStore(indexers Indexers, indices Indices) ThreadSafeStore
type UndeltaStore ¶ added in v0.9.0
type UndeltaStore struct { Store PushFunc func([]interface{}) }
UndeltaStore listens to incremental updates and sends complete state on every change. It implements the Store interface so that it can receive a stream of mirrored objects from Reflector. Whenever it receives any complete (Store.Replace) or incremental change (Store.Add, Store.Update, Store.Delete), it sends the complete state by calling PushFunc. It is thread-safe. It guarantees that every change (Add, Update, Replace, Delete) results in one call to PushFunc, but sometimes PushFunc may be called twice with the same values. PushFunc should be thread safe.
func NewUndeltaStore ¶ added in v0.9.0
func NewUndeltaStore(pushFunc func([]interface{}), keyFunc KeyFunc) *UndeltaStore
NewUndeltaStore returns an UndeltaStore implemented with a Store.
func (*UndeltaStore) Add ¶ added in v0.9.0
func (u *UndeltaStore) Add(obj interface{}) error
func (*UndeltaStore) Delete ¶ added in v0.9.0
func (u *UndeltaStore) Delete(obj interface{}) error
func (*UndeltaStore) Replace ¶ added in v0.9.0
func (u *UndeltaStore) Replace(list []interface{}, resourceVersion string) error
func (*UndeltaStore) Update ¶ added in v0.9.0
func (u *UndeltaStore) Update(obj interface{}) error