etcd

Documentation

Index

• Variables
• func GetEtcdClient(ctx context.Context, certificates *Certificates, endpoints ...string) (*clientv3.Client, error)
• func WaitForEtcd(parentCtx context.Context, certificates *Certificates, endpoints ...string) error
• type Certificates
• type Client
  • func New(ctx context.Context, certificates *Certificates, endpoints ...string) (Client, error)
  • func NewFromConfig(ctx context.Context, vConfig *config.VirtualClusterConfig) (Client, error)
• type Value

Variables

var (
	ErrNotFound = errors.New("etcdwrapper: key not found")
)

Functions

func GetEtcdClient

func GetEtcdClient(ctx context.Context, certificates *Certificates, endpoints ...string) (*clientv3.Client, error)

GetEtcdClient returns an etcd client connected to the specified endpoints. If no endpoints are provided, endpoints are retrieved from the provided runtime config. If the runtime config does not list any endpoints, the default endpoint is used. The returned client should be closed when no longer needed, in order to avoid leaking GRPC client goroutines.

func WaitForEtcd

func WaitForEtcd(parentCtx context.Context, certificates *Certificates, endpoints ...string) error

Types

type Certificates

type Certificates struct {
	CaCert     string
	ServerCert string
	ServerKey  string
}

type Client

type Client interface {
	List(ctx context.Context, key string, rev int) ([]Value, error)
	Watch(ctx context.Context, key string, rev int) clientv3.WatchChan
	Get(ctx context.Context, key string) (Value, error)
	Put(ctx context.Context, key string, value []byte) error
	Create(ctx context.Context, key string, value []byte) error
	Update(ctx context.Context, key string, revision int64, value []byte) error
	Delete(ctx context.Context, key string, revision int64) error
	Compact(ctx context.Context, revision int64) (int64, error)
	Close() error
}

func New

func New(ctx context.Context, certificates *Certificates, endpoints ...string) (Client, error)

func NewFromConfig

func NewFromConfig(ctx context.Context, vConfig *config.VirtualClusterConfig) (Client, error)

type Value

type Value struct {
	Key      []byte
	Data     []byte
	Revision int64
}