store

Documentation

Index

• Constants
• Variables
• type Backend
• type Config
• type Election
  • func NewElection(kvStore KVStore, path, candidateUID string) Election
• type KVPair
• type KVStore
  • func NewKVStore(cfg Config) (KVStore, error)
• type Store
  • func NewStore(kvStore KVStore, path string) *Store
  • func (s *Store) AtomicPutClusterData(ctx context.Context, cd *cluster.ClusterData, previous *KVPair) (*KVPair, error)
  • func (s *Store) GetClusterData(ctx context.Context) (*cluster.ClusterData, *KVPair, error)
  • func (s *Store) GetKeeperInfo(ctx context.Context, id string) (*cluster.KeeperInfo, bool, error)
  • func (s *Store) GetKeepersInfo(ctx context.Context) (cluster.KeepersInfo, error)
  • func (s *Store) GetLeaderSentinelId(ctx context.Context) (string, error)
  • func (s *Store) GetProxiesInfo(ctx context.Context) (cluster.ProxiesInfo, error)
  • func (s *Store) GetProxyInfo(ctx context.Context, id string) (*cluster.ProxyInfo, bool, error)
  • func (s *Store) GetSentinelInfo(ctx context.Context, id string) (*cluster.SentinelInfo, bool, error)
  • func (s *Store) GetSentinelsInfo(ctx context.Context) (cluster.SentinelsInfo, error)
  • func (s *Store) PutClusterData(ctx context.Context, cd *cluster.ClusterData) error
  • func (s *Store) SetKeeperInfo(ctx context.Context, id string, ms *cluster.KeeperInfo, ttl time.Duration) error
  • func (s *Store) SetProxyInfo(ctx context.Context, pi *cluster.ProxyInfo, ttl time.Duration) error
  • func (s *Store) SetSentinelInfo(ctx context.Context, si *cluster.SentinelInfo, ttl time.Duration) error
• type WriteOptions

Constants

const (
	DefaultEtcdEndpoints   = "http://127.0.0.1:2379"
	DefaultConsulEndpoints = "http://127.0.0.1:8500"
)

const (
	//TODO(sgotti) fix this in libkv?
	// consul min ttl is 10s and libkv divides this by 2
	MinTTL = 20 * time.Second
)

Variables

var (
	// ErrKeyNotFound is thrown when the key is not found in the store during a Get operation
	ErrKeyNotFound      = errors.New("Key not found in store")
	ErrKeyModified      = errors.New("Unable to complete atomic operation, key modified")
	ErrElectionNoLeader = errors.New("election: no leader")
)

var URLSchemeRegexp = regexp.MustCompile(`^([a-zA-Z][a-zA-Z0-9+-.]*)://`)

Types

type Backend

type Backend string

Backend represents a KV Store Backend

const (
	CONSUL Backend = "consul"
	ETCDV2 Backend = "etcdv2"
	ETCDV3 Backend = "etcdv3"
)

type Config

type Config struct {
	Backend       Backend
	Endpoints     string
	CertFile      string
	KeyFile       string
	CAFile        string
	SkipTLSVerify bool
}

type Election

type Election interface {
	// TODO(sgotti) this mimics the current docker/leadership API and the etcdv3
	// implementations adapt to it. In future it could be replaced with a better
	// api like the current one implemented by etcdclientv3/concurrency.
	RunForElection() (<-chan bool, <-chan error)
	Leader() (string, error)
	Stop()
}

func NewElection

func NewElection(kvStore KVStore, path, candidateUID string) Election

type KVPair

type KVPair struct {
	Key       string
	Value     []byte
	LastIndex uint64
}

KVPair represents {Key, Value, Lastindex} tuple

type KVStore

type KVStore interface {
	// Put a value at the specified key
	Put(ctx context.Context, key string, value []byte, options *WriteOptions) error

	// Get a value given its key
	Get(ctx context.Context, key string) (*KVPair, error)

	// List the content of a given prefix
	List(ctx context.Context, directory string) ([]*KVPair, error)

	// Atomic CAS operation on a single value.
	// Pass previous = nil to create a new key.
	AtomicPut(ctx context.Context, key string, value []byte, previous *KVPair, options *WriteOptions) (*KVPair, error)

	Delete(ctx context.Context, key string) error

	// Close the store connection
	Close() error
}

func NewKVStore

func NewKVStore(cfg Config) (KVStore, error)

type Store

type Store struct {
	// contains filtered or unexported fields
}

func NewStore

func NewStore(kvStore KVStore, path string) *Store

func (*Store) AtomicPutClusterData

func (s *Store) AtomicPutClusterData(ctx context.Context, cd *cluster.ClusterData, previous *KVPair) (*KVPair, error)

func (*Store) GetClusterData

func (s *Store) GetClusterData(ctx context.Context) (*cluster.ClusterData, *KVPair, error)

func (*Store) GetKeeperInfo

func (s *Store) GetKeeperInfo(ctx context.Context, id string) (*cluster.KeeperInfo, bool, error)

func (*Store) GetKeepersInfo

func (s *Store) GetKeepersInfo(ctx context.Context) (cluster.KeepersInfo, error)

func (*Store) GetLeaderSentinelId

func (s *Store) GetLeaderSentinelId(ctx context.Context) (string, error)

func (*Store) GetProxiesInfo

func (s *Store) GetProxiesInfo(ctx context.Context) (cluster.ProxiesInfo, error)

func (*Store) GetProxyInfo

func (s *Store) GetProxyInfo(ctx context.Context, id string) (*cluster.ProxyInfo, bool, error)

func (*Store) GetSentinelInfo

func (s *Store) GetSentinelInfo(ctx context.Context, id string) (*cluster.SentinelInfo, bool, error)

func (*Store) GetSentinelsInfo

func (s *Store) GetSentinelsInfo(ctx context.Context) (cluster.SentinelsInfo, error)

func (*Store) PutClusterData

func (s *Store) PutClusterData(ctx context.Context, cd *cluster.ClusterData) error

func (*Store) SetKeeperInfo

func (s *Store) SetKeeperInfo(ctx context.Context, id string, ms *cluster.KeeperInfo, ttl time.Duration) error

func (*Store) SetProxyInfo

func (s *Store) SetProxyInfo(ctx context.Context, pi *cluster.ProxyInfo, ttl time.Duration) error

func (*Store) SetSentinelInfo

func (s *Store) SetSentinelInfo(ctx context.Context, si *cluster.SentinelInfo, ttl time.Duration) error

type WriteOptions

type WriteOptions struct {
	TTL time.Duration
}