etcdutil

Documentation

Index

• Constants
• func AddEtcdMember(client *clientv3.Client, urls []string) (*clientv3.MemberAddResponse, error)
• func CheckClusterID(localClusterID types.ID, um types.URLsMap, tlsConfig *tls.Config) error
• func EtcdKVGet(c *clientv3.Client, key string, opts ...clientv3.OpOption) (*clientv3.GetResponse, error)
• func GetProtoMsgWithModRev(c *clientv3.Client, key string, msg proto.Message, opts ...clientv3.OpOption) (bool, int64, error)
• func GetValue(c *clientv3.Client, key string, opts ...clientv3.OpOption) ([]byte, error)
• func ListEtcdMembers(client *clientv3.Client) (*clientv3.MemberListResponse, error)
• func RemoveEtcdMember(client *clientv3.Client, id uint64) (*clientv3.MemberRemoveResponse, error)

Constants

const (
	// DefaultDialTimeout is the maximum amount of time a dial will wait for a
	// connection to setup. 30s is long enough for most of the network conditions.
	DefaultDialTimeout = 30 * time.Second

	// DefaultRequestTimeout 10s is long enough for most of etcd clusters.
	DefaultRequestTimeout = 10 * time.Second

	// DefaultSlowRequestTime 1s for the threshold for normal request, for those
	// longer then 1s, they are considered as slow requests.
	DefaultSlowRequestTime = 1 * time.Second
)

Functions

func AddEtcdMember

func AddEtcdMember(client *clientv3.Client, urls []string) (*clientv3.MemberAddResponse, error)

AddEtcdMember adds an etcd member.

func CheckClusterID

func CheckClusterID(localClusterID types.ID, um types.URLsMap, tlsConfig *tls.Config) error

CheckClusterID checks Etcd's cluster ID, returns an error if mismatch. This function will never block even quorum is not satisfied.

func EtcdKVGet

func EtcdKVGet(c *clientv3.Client, key string, opts ...clientv3.OpOption) (*clientv3.GetResponse, error)

EtcdKVGet returns the etcd GetResponse by given key or key prefix

func GetProtoMsgWithModRev

func GetProtoMsgWithModRev(c *clientv3.Client, key string, msg proto.Message, opts ...clientv3.OpOption) (bool, int64, error)

GetProtoMsgWithModRev returns boolean to indicate whether the key exists or not.

func GetValue

func GetValue(c *clientv3.Client, key string, opts ...clientv3.OpOption) ([]byte, error)

GetValue gets value with key from etcd.

func ListEtcdMembers

func ListEtcdMembers(client *clientv3.Client) (*clientv3.MemberListResponse, error)

ListEtcdMembers returns a list of internal etcd members.

func RemoveEtcdMember

func RemoveEtcdMember(client *clientv3.Client, id uint64) (*clientv3.MemberRemoveResponse, error)

RemoveEtcdMember removes a member by the given id.