etcd

Documentation

Index

• Constants
• func GeneratePeerCert(etcdCA *x509.PEMEncodedCertificateAndKey) (*x509.PEMEncodedCertificateAndKey, error)
• type Client
  • func NewClient(endpoints []string) (client *Client, err error)
  • func NewClientFromControlPlaneIPs(ctx context.Context, creds *x509.PEMEncodedCertificateAndKey, ...) (client *Client, err error)
  • func NewLocalClient() (client *Client, err error)
  • func (c *Client) ForfeitLeadership(ctx context.Context) (string, error)
  • func (c *Client) LeaveCluster(ctx context.Context) error
  • func (c *Client) RemoveMember(ctx context.Context, hostname string) error
  • func (c *Client) ValidateForUpgrade(ctx context.Context, config config.Provider, preserve bool) error
  • func (c *Client) ValidateQuorum(ctx context.Context) (err error)

Constants

const QuorumCheckTimeout = 15 * time.Second

QuorumCheckTimeout is the amount of time to allow for KV operations before quorum is declared invalid.

Functions

func GeneratePeerCert

func GeneratePeerCert(etcdCA *x509.PEMEncodedCertificateAndKey) (*x509.PEMEncodedCertificateAndKey, error)

GeneratePeerCert generates etcd peer certificate and key from etcd CA.

Types

type Client

type Client struct {
	*clientv3.Client
}

Client is a wrapper around the official etcd client.

func NewClient

func NewClient(endpoints []string) (client *Client, err error)

NewClient initializes and returns an etcd client configured to talk to a list of endpoints.

func NewClientFromControlPlaneIPs

func NewClientFromControlPlaneIPs(ctx context.Context, creds *x509.PEMEncodedCertificateAndKey, endpoint *url.URL) (client *Client, err error)

NewClientFromControlPlaneIPs initializes and returns an etcd client configured to talk to all members.

func NewLocalClient

func NewLocalClient() (client *Client, err error)

NewLocalClient initializes and returns etcd client configured to talk to localhost endpoint.

func (*Client) ForfeitLeadership

func (c *Client) ForfeitLeadership(ctx context.Context) (string, error)

ForfeitLeadership transfers leadership from the current member to another member.

func (*Client) LeaveCluster

func (c *Client) LeaveCluster(ctx context.Context) error

LeaveCluster removes the current member from the etcd cluster and nukes etcd data directory.

func (*Client) RemoveMember

func (c *Client) RemoveMember(ctx context.Context, hostname string) error

RemoveMember removes the member from the etcd cluster.

func (*Client) ValidateForUpgrade

func (c *Client) ValidateForUpgrade(ctx context.Context, config config.Provider, preserve bool) error

ValidateForUpgrade validates the etcd cluster state to ensure that performing an upgrade is safe.

func (*Client) ValidateQuorum

func (c *Client) ValidateQuorum(ctx context.Context) (err error)

ValidateQuorum performs a KV operation to make certain that quorum is good.