manager

Documentation

Index

• Constants
• type Client
• type Config
• type Manager
  • func New(cfg *Config) (*Manager, error)
  • func (m *Manager) GracefulStop()
  • func (m *Manager) HardStop()
  • func (m *Manager) Run() error
• type Member
  • func (m *Member) Marshal() ([]byte, error)
  • func (m *Member) Unmarshal(data []byte) error
• type NodeStatus
  • func (s NodeStatus) String() string
• type Peer
  • func (p *Peer) String() string

Constants

const (
	DefaultGossipPort = 7980
)

Types

type Client

type Client struct {
	*client.Client
	// contains filtered or unexported fields
}

type Config

type Config struct {
	// name used for etcd.Embed instance, should generally be left alone so
	// that a random name is generated
	Name string

	// directory used for etcd data-dir, wal and snapshot dirs derived from
	// this by etcd
	Dir string

	// the required number of nodes that must be present to start a cluster
	RequiredClusterSize int

	// allows for explicit setting of the host ip
	Host string

	// client endpoint for accessing etcd
	ClientAddr string

	// client url created based upon the client address and use of TLS
	ClientURL url.URL

	// address used for traffic within the cluster
	PeerAddr string

	// peer url created based upon the peer address and use of TLS
	PeerURL url.URL

	// address used for gossip network
	GossipAddr string

	// host used for gossip network, derived from GossipAddr
	GossipHost string

	// port used for gossip network, derived from GossipAddr
	GossipPort int

	// key used to secure  the gossip network, derived from PeerSecurity settings
	GossipSecretKey []byte

	// addresses used to bootstrap the gossip network
	BootstrapAddrs []string

	// amount of time to attempt bootstrapping before failing
	BootstrapTimeout time.Duration

	// identifies a cloud provider to be used for peer discovery
	CloudProvider string `mapstructure:"cloud_provider"`

	// interval for creating etcd snapshots
	SnapshotInterval time.Duration

	// use gzip compression for snapshot backup
	SnapshotCompression bool

	// how often to perform a health check
	HealthCheckInterval time.Duration

	// time until an unreachable member is considered unhealthy
	HealthCheckTimeout time.Duration

	// configures authentication/transport security for clients
	ClientSecurity client.SecurityConfig

	// configures authentication/transport security within the etcd cluster
	PeerSecurity client.SecurityConfig

	// configures the level of the logger used by etcd
	EtcdLogLevel zapcore.Level

	discovery.PeerProvider
	snapshot.SnapshotProvider

	Debug bool
}

type Manager

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

Manager manages an embedded etcd instance.

func New

func New(cfg *Config) (*Manager, error)

New creates a new instance of Manager.

func (*Manager) GracefulStop

func (m *Manager) GracefulStop()

GracefulStop stops all services and cleans up the Manager state. It attempts to gracefully shutdown etcd by waiting for gRPC calls in-flight to finish.

func (*Manager) HardStop

func (m *Manager) HardStop()

HardStop stops all services and cleans up the Manager state. Unlike GracefulStop, it does not attempt to gracefully shutdown etcd.

func (*Manager) Run

func (m *Manager) Run() error

Run starts and manages an etcd node based upon the provided configuration. In the case of a fault, or if the manager is otherwise stopped, this method exits.

type Member

type Member struct {
	ID             uint64
	Name           string
	ClientAddr     string
	ClientURL      string
	PeerAddr       string
	PeerURL        string
	GossipAddr     string
	BootstrapAddrs []string
	Status         NodeStatus
}

func (*Member) Marshal

func (m *Member) Marshal() ([]byte, error)

func (*Member) Unmarshal

func (m *Member) Unmarshal(data []byte) error

type NodeStatus

type NodeStatus int

const (
	Unknown NodeStatus = iota
	Pending
	Running
)

func (NodeStatus) String

func (s NodeStatus) String() string

type Peer

type Peer struct {
	Name string
	URL  string
}

func (*Peer) String

func (p *Peer) String() string