cluster

Documentation

Index

• type Member
  • func NewMember(log zerolog.Logger, store cluster.Backend, addr, advAddr, name string) (*Member, error)
  • func (m *Member) ClearLeadership()
  • func (m *Member) IsHA() bool
  • func (m *Member) Leader() (bool, string, string, error)
  • func (m *Member) RunLeadershipLoop()
• type MembershipUpdate

Types

type Member

type Member struct {

	// UpdateChan is used to publish leadership updates to the server. This allows the server to
	// coordinate tasks such as scaling state garbage collection and the autoscaler, both of which
	// should only be run by the leader.
	UpdateChan chan *MembershipUpdate
	// contains filtered or unexported fields
}

func NewMember

func NewMember(log zerolog.Logger, store cluster.Backend, addr, advAddr, name string) (*Member, error)

func (*Member) ClearLeadership

func (m *Member) ClearLeadership()

ClearLeadership is used to coordinate the shutdown of the cluster membership processes so we can exist cleanly. This allows other servers to quickly take over as leader and therefore resume cluster operations.

func (*Member) IsHA

func (m *Member) IsHA() bool

func (*Member) Leader

func (m *Member) Leader() (bool, string, string, error)

Leader is used to identify the clusters currently recognised leader and identify the associated HTTP addresses.

func (*Member) RunLeadershipLoop

func (m *Member) RunLeadershipLoop()

type MembershipUpdate

type MembershipUpdate struct {

	// IsLeader is used to determine whether or not the Sherpa server is acting as the cluster
	// leader.
	IsLeader bool

	// Msg is an optional message to pass which can be useful when logging update events.
	Msg string
}

MembershipUpdate is the information used to update the server about leadership changes.