leaderelection

Documentation

Index

• Variables
• func GenerateLeaseIdentity() (string, error)
• func ObserveLeaderElected(leaseName, leaseID string, isLeader bool)
• type Config
  • func (c *Config) PrepareValues() *Config
• type Coordinator
  • func NewCoordinator(client coordinationv1.LeasesGetter, config *Config) (Coordinator, error)
  • func NewCoordinatorWithIdentity(client coordinationv1.LeasesGetter, id string, config *Config) (Coordinator, error)

Variables

var (
	DefaultConfig = &Config{
		LeaseNamespace: "furiko-system",
		LeaseDuration:  30 * time.Second,
		RenewDeadline:  15 * time.Second,
		RetryPeriod:    5 * time.Second,
	}
)

Functions

func GenerateLeaseIdentity

func GenerateLeaseIdentity() (string, error)

GenerateLeaseIdentity generates a unique lease identity that can be used in a leader election.

func ObserveLeaderElected

func ObserveLeaderElected(leaseName, leaseID string, isLeader bool)

Types

type Config

type Config struct {
	LeaseName      string
	LeaseNamespace string
	LeaseDuration  time.Duration
	RenewDeadline  time.Duration
	RetryPeriod    time.Duration
}

func (*Config) PrepareValues

func (c *Config) PrepareValues() *Config

type Coordinator

type Coordinator interface {
	IsLeader() bool
	GetLeader() string
	Wait(ctx context.Context) error
	GiveUp()
	GetLeaseName() string
	GetLeaseID() string
}

func NewCoordinator

func NewCoordinator(client coordinationv1.LeasesGetter, config *Config) (Coordinator, error)

NewCoordinator creates a new Coordinator with a randomly generated identity.

func NewCoordinatorWithIdentity

func NewCoordinatorWithIdentity(client coordinationv1.LeasesGetter, id string, config *Config) (Coordinator, error)

NewCoordinatorWithIdentity creates a new Coordinator with the given identity.