Documentation
¶
Overview ¶
Package etcd has a generic implementation of a registry that stores things in etcd.
Index ¶
- Constants
- Variables
- func NamespaceKeyFunc(ctx api.Context, prefix string, name string) (string, error)
- func NamespaceKeyRootFunc(ctx api.Context, prefix string) string
- func NoNamespaceKeyFunc(ctx api.Context, prefix string, name string) (string, error)
- func StorageWithCacher(storageConfig *storagebackend.Config, capacity int, objectType runtime.Object, ...) (storage.Interface, factory.DestroyFunc)
- type Store
- func (e *Store) Create(ctx api.Context, obj runtime.Object) (runtime.Object, error)
- func (e *Store) Delete(ctx api.Context, name string, options *api.DeleteOptions) (runtime.Object, error)
- func (e *Store) DeleteCollection(ctx api.Context, options *api.DeleteOptions, listOptions *api.ListOptions) (runtime.Object, error)
- func (e *Store) Export(ctx api.Context, name string, opts unversioned.ExportOptions) (runtime.Object, error)
- func (e *Store) Get(ctx api.Context, name string) (runtime.Object, error)
- func (e *Store) List(ctx api.Context, options *api.ListOptions) (runtime.Object, error)
- func (e *Store) ListPredicate(ctx api.Context, p storage.SelectionPredicate, options *api.ListOptions) (runtime.Object, error)
- func (e *Store) New() runtime.Object
- func (e *Store) NewList() runtime.Object
- func (e *Store) Update(ctx api.Context, name string, objInfo rest.UpdatedObjectInfo) (runtime.Object, bool, error)
- func (e *Store) Watch(ctx api.Context, options *api.ListOptions) (watch.Interface, error)
- func (e *Store) WatchPredicate(ctx api.Context, p storage.SelectionPredicate, resourceVersion string) (watch.Interface, error)
Constants ¶
const OptimisticLockErrorMsg = "the object has been modified; please apply your changes to the latest version and try again"
Variables ¶
var EnableGarbageCollector bool
EnableGarbageCollector affects the handling of Update and Delete requests. It must be synced with the corresponding flag in kube-controller-manager.
Functions ¶
func NamespaceKeyFunc ¶
NamespaceKeyFunc is the default function for constructing storage paths to a resource relative to prefix enforcing namespace rules. If no namespace is on context, it errors.
func NamespaceKeyRootFunc ¶
NamespaceKeyRootFunc is the default function for constructing storage paths to resource directories enforcing namespace rules.
func NoNamespaceKeyFunc ¶
NoNamespaceKeyFunc is the default function for constructing storage paths to a resource relative to prefix without a namespace
func StorageWithCacher ¶
func StorageWithCacher( storageConfig *storagebackend.Config, capacity int, objectType runtime.Object, resourcePrefix string, scopeStrategy rest.NamespaceScopedStrategy, newListFunc func() runtime.Object, triggerFunc storage.TriggerPublisherFunc) (storage.Interface, factory.DestroyFunc)
Creates a cacher based given storageConfig.
Types ¶
type Store ¶
type Store struct {
// Called to make a new object, should return e.g., &api.Pod{}
NewFunc func() runtime.Object
// Called to make a new listing object, should return e.g., &api.PodList{}
NewListFunc func() runtime.Object
// Used for error reporting
QualifiedResource unversioned.GroupResource
// Used for listing/watching; should not include trailing "/"
KeyRootFunc func(ctx api.Context) string
// Called for Create/Update/Get/Delete. Note that 'namespace' can be
// gotten from ctx.
KeyFunc func(ctx api.Context, name string) (string, error)
// Called to get the name of an object
ObjectNameFunc func(obj runtime.Object) (string, error)
// Return the TTL objects should be persisted with. Update is true if this
// is an operation against an existing object. Existing is the current TTL
// or the default for this operation.
TTLFunc func(obj runtime.Object, existing uint64, update bool) (uint64, error)
// Returns a matcher corresponding to the provided labels and fields.
PredicateFunc func(label labels.Selector, field fields.Selector) storage.SelectionPredicate
// Called to cleanup storage clients.
DestroyFunc func()
// DeleteCollectionWorkers is the maximum number of workers in a single
// DeleteCollection call.
DeleteCollectionWorkers int
// Decorator is called as exit hook on object returned from the underlying storage.
// The returned object could be individual object (e.g. Pod) or the list type (e.g. PodList).
// Decorator is intended for integrations that are above storage and
// should only be used for specific cases where storage of the value is
// not appropriate, since they cannot be watched.
Decorator rest.ObjectFunc
// Allows extended behavior during creation, required
CreateStrategy rest.RESTCreateStrategy
// On create of an object, attempt to run a further operation.
AfterCreate rest.ObjectFunc
// Allows extended behavior during updates, required
UpdateStrategy rest.RESTUpdateStrategy
// On update of an object, attempt to run a further operation.
AfterUpdate rest.ObjectFunc
// Allows extended behavior during updates, optional
DeleteStrategy rest.RESTDeleteStrategy
// On deletion of an object, attempt to run a further operation.
AfterDelete rest.ObjectFunc
// If true, return the object that was deleted. Otherwise, return a generic
// success status response.
ReturnDeletedObject bool
// Allows extended behavior during export, optional
ExportStrategy rest.RESTExportStrategy
// Used for all storage access functions
Storage storage.Interface
}
Store implements generic.Registry. It's intended to be embeddable, so that you can implement any non-generic functions if needed. You must supply a value for every field below before use; these are left public as it's meant to be overridable if need be. This object is intended to be copyable so that it can be used in different ways but share the same underlying behavior.
The intended use of this type is embedding within a Kind specific RESTStorage implementation. This type provides CRUD semantics on a Kubelike resource, handling details like conflict detection with ResourceVersion and semantics. The RESTCreateStrategy and RESTUpdateStrategy are generic across all backends, and encapsulate logic specific to the API.
TODO: make the default exposed methods exactly match a generic RESTStorage
func (*Store) Delete ¶
func (e *Store) Delete(ctx api.Context, name string, options *api.DeleteOptions) (runtime.Object, error)
Delete removes the item from storage.
func (*Store) DeleteCollection ¶
func (e *Store) DeleteCollection(ctx api.Context, options *api.DeleteOptions, listOptions *api.ListOptions) (runtime.Object, error)
DeleteCollection remove all items returned by List with a given ListOptions from storage.
DeleteCollection is currently NOT atomic. It can happen that only subset of objects will be deleted from storage, and then an error will be returned. In case of success, the list of deleted objects will be returned.
TODO: Currently, there is no easy way to remove 'directory' entry from storage (if we are removing all objects of a given type) with the current API (it's technically possibly with storage API, but watch is not delivered correctly then). It will be possible to fix it with v3 etcd API.
func (*Store) Export ¶
func (e *Store) Export(ctx api.Context, name string, opts unversioned.ExportOptions) (runtime.Object, error)
Implements the rest.Exporter interface
func (*Store) ListPredicate ¶
func (e *Store) ListPredicate(ctx api.Context, p storage.SelectionPredicate, options *api.ListOptions) (runtime.Object, error)
ListPredicate returns a list of all the items matching m.
func (*Store) Update ¶
func (e *Store) Update(ctx api.Context, name string, objInfo rest.UpdatedObjectInfo) (runtime.Object, bool, error)
Update performs an atomic update and set of the object. Returns the result of the update or an error. If the registry allows create-on-update, the create flow will be executed. A bool is returned along with the object and any errors, to indicate object creation.
Source Files