etcd

Documentation

Overview

Package etcd has a generic implementation of a registry that stores things in etcd.

Index

• type Etcd
  • func (e *Etcd) Create(ctx api.Context, id string, obj runtime.Object) error
  • func (e *Etcd) Delete(ctx api.Context, id string) error
  • func (e *Etcd) Get(ctx api.Context, id string) (runtime.Object, error)
  • func (e *Etcd) List(ctx api.Context, m generic.Matcher) (runtime.Object, error)
  • func (e *Etcd) Update(ctx api.Context, id string, obj runtime.Object) error
  • func (e *Etcd) Watch(ctx api.Context, m generic.Matcher, resourceVersion uint64) (watch.Interface, error)

Types

type Etcd

type Etcd 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
	EndpointName string

	// Used for listing/watching; should not include trailing "/"
	KeyRoot string

	// Called for Create/Update/Get/Delete
	KeyFunc func(id string) string

	// Used for all etcd access functions
	Helper tools.EtcdHelper
}

Etcd implements generic.Registry, backing it with etcd storage. 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.

func (*Etcd) Create

func (e *Etcd) Create(ctx api.Context, id string, obj runtime.Object) error

Create inserts a new item.

func (*Etcd) Delete

func (e *Etcd) Delete(ctx api.Context, id string) error

Delete removes the item from etcd.

func (*Etcd) Get

func (e *Etcd) Get(ctx api.Context, id string) (runtime.Object, error)

Get retrieves the item from etcd.

func (*Etcd) List

func (e *Etcd) List(ctx api.Context, m generic.Matcher) (runtime.Object, error)

List returns a list of all the items matching m.

func (*Etcd) Update

func (e *Etcd) Update(ctx api.Context, id string, obj runtime.Object) error

Update updates the item.

func (*Etcd) Watch

func (e *Etcd) Watch(ctx api.Context, m generic.Matcher, resourceVersion uint64) (watch.Interface, error)

Watch starts a watch for the items that m matches. TODO: Detect if m references a single object instead of a list.