leadership

Documentation

Index

• type Leadership
  • func New(opts Options) *Leadership
  • func (l *Leadership) Elect(ctx context.Context) (context.Context, *elector.Elected, error)
  • func (l *Leadership) Reelect(ctx context.Context) (context.Context, *elector.Elected, error)
  • func (l *Leadership) Run(ctx context.Context) error
• type Options

Types

type Leadership

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

Leadership manages the leadership for this replica. It will elect and re-elect leadership, returning contexts which cancel on lost quorum.

func New

func New(opts Options) *Leadership

func (*Leadership) Elect

func (l *Leadership) Elect(ctx context.Context) (context.Context, *elector.Elected, error)

Elect will elect this replica as the leader. It will return a context which will cancel when the leadership quorum is lost.

func (*Leadership) Reelect

func (l *Leadership) Reelect(ctx context.Context) (context.Context, *elector.Elected, error)

Reelect will re-elect this replica as the leader. It will return a context which will cancel when the leadership quorum is lost. Should be called after initial election quorum is lost.

func (*Leadership) Run

func (l *Leadership) Run(ctx context.Context) error

type Options

type Options struct {
	// Log is the logger for the leadership.
	Log logr.Logger

	// Client is the etcd client.
	Client client.Interface

	// Key is the ETCD key generator.
	Key *key.Key

	// ReplicaData is the replicaData for the instance using the cron library.
	// This will contain data like host + port for keeping track of active replicas.
	ReplicaData *anypb.Any
}

Options are the options for the Leadership.