statusstore

Documentation

Index

• Constants
• func IsNoStatus(err error) bool
• func IsStaleIndex(err error) bool
• func NewStaleIndex(key string, index uint64) staleIndex
• type Namespace
  • func (n Namespace) String() string
• type NoStatusError
  • func (n NoStatusError) Error() string
• type ResourceID
  • func (id ResourceID) String() string
• type ResourceType
  • func (t ResourceType) String() string
• type Status
  • func (s Status) Bytes() []byte
• type Store
  • func NewConsul(client consulutil.ConsulClient) Store

Constants

const (
	PC  = ResourceType("pod_clusters")
	POD = ResourceType("pods")
	DS  = ResourceType("daemon_sets")
	RC  = ResourceType("replication_controllers")
)

Should this be collapsed with label types and "tree" names? this stuff is all over the place but sometimes has subtle differences

Functions

func IsNoStatus

func IsNoStatus(err error) bool

func IsStaleIndex

func IsStaleIndex(err error) bool

func NewStaleIndex

func NewStaleIndex(key string, index uint64) staleIndex

Types

type Namespace

type Namespace string

The resource type isn't enough to namespace a status. For example, there might be two different implementations of pcstore.ConcreteSyncer that wish to record independent status structs for the same pod cluster without interfering with eachother.

func (Namespace) String

func (n Namespace) String() string

type NoStatusError

type NoStatusError struct {
	Key string
}

func (NoStatusError) Error

func (n NoStatusError) Error() string

type ResourceID

type ResourceID string

Unfortunately each ResourceType will carry along with it a different "ID" type def, e.g. types.PodID. Go isn't flexible enough to handle this so we require all callers to cast their ID type to ResourceID and back when interacting with the status store.

func (ResourceID) String

func (id ResourceID) String() string

type ResourceType

type ResourceType string

The resource type being labeled. See the constants below

func (ResourceType) String

func (t ResourceType) String() string

type Status

type Status []byte

The store doesn't care what status looks like, it will be implementation-specific (e.g. some structured JSON).

func (Status) Bytes

func (s Status) Bytes() []byte

type Store

type Store interface {
	// Set the status for a particular resource specified by ResourceType and ID,
	// namespaced by a Namespace string
	SetStatus(t ResourceType, id ResourceID, namespace Namespace, status Status) error

	SetTxn(ctx context.Context, t ResourceType, id ResourceID, namespace Namespace, status Status) error

	// Like SetStatus(), but compare-and-swap value at a specified ModifyIndex (see consul docs)
	CASStatus(ctx context.Context, t ResourceType, id ResourceID, namespace Namespace, status Status, modifyIndex uint64) error

	// Get the status for a particular resource specified by ResourceType and ID,
	// namespaced by a Namespace string
	GetStatus(t ResourceType, id ResourceID, namespace Namespace) (Status, *api.QueryMeta, error)

	// Like GetStatus(), but doesn't return status until waitIndex has been surpassed in consul
	WatchStatus(t ResourceType, id ResourceID, namespace Namespace, waitIndex uint64) (Status, *api.QueryMeta, error)

	// Delete the status entry for a resource that has been deleted once the
	// deletion has been processed
	DeleteStatus(t ResourceType, id ResourceID, namespace Namespace) error

	// DeleteStatusTxn adds an operation to the transaction within the passed context that arranges for deleting the corresponding
	// status record when transaction.Commit() is called with the context
	DeleteStatusTxn(ctx context.Context, t ResourceType, id ResourceID, namespace Namespace) error

	// Get the status for all namespaces for a particular resource specified
	// by ResourceType and ID
	GetAllStatusForResource(t ResourceType, id ResourceID) (map[Namespace]Status, error)

	// Get the statuses for all resources of a given type. Returns a map of
	// resource ID to map[Namespace]Status
	GetAllStatusForResourceType(t ResourceType) (map[ResourceID]map[Namespace]Status, error)
}

func NewConsul

func NewConsul(client consulutil.ConsulClient) Store