etcd

Documentation

Index

• func Module() fx.Option
• type Client
  • func ProvideClient(in ClientIn) (*Client, error)
• type ClientIn
• type ConfigOverride

Functions

func Module

func Module() fx.Option

Module is a fx module that provides etcd client.

Types

type Client

type Client struct {
	KV      clientv3.KV
	Watcher clientv3.Watcher
	Lease   clientv3.Lease
	Client  *clientv3.Client
	Session *concurrencyv3.Session
	LeaseID clientv3.LeaseID
}

Client is a wrapper around etcd client v3. It provides interfaces rooted by a namespace in etcd.

func ProvideClient

func ProvideClient(in ClientIn) (*Client, error)

ProvideClient creates a new Etcd Client and provides it via Fx.

type ClientIn

type ClientIn struct {
	fx.In

	Unmarshaller   config.Unmarshaller
	Lifecycle      fx.Lifecycle
	Shutdowner     fx.Shutdowner
	Logger         *log.Logger
	ConfigOverride *ConfigOverride `optional:"true"`
}

ClientIn holds parameters for ProvideClient.

type ConfigOverride

type ConfigOverride struct {
	etcd.EtcdConfig
	PerRPCCredentials credentials.PerRPCCredentials // optional
}

ConfigOverride can be provided by an extension to provide etcd client config directly.