leaderelection

Documentation

Index

• func NewLeaderElectionConfig(config *rest.Config, options Options) (*leaderelection.LeaderElectionConfig, error)
• func NewResourceLock(config *rest.Config, eventRecorder record.EventRecorder, options Options) (resourcelock.Interface, error)
• func RunOrDie(ctx context.Context, config *rest.Config, options Options)
• type Options

Functions

func NewLeaderElectionConfig

func NewLeaderElectionConfig(config *rest.Config, options Options) (*leaderelection.LeaderElectionConfig, error)

NewLeaderElectionConfig

func NewResourceLock

func NewResourceLock(config *rest.Config, eventRecorder record.EventRecorder, options Options) (resourcelock.Interface, error)

NewResourceLock creates a resourcelock.Interface object with provided parameters.

func RunOrDie

func RunOrDie(ctx context.Context, config *rest.Config, options Options)

RunOrDie

Types

type Options

type Options struct {
	// LeaderElectionID is the unique string identifying a lease holder across
	// all participants in an election.
	LeaderElectionID string

	// LeaderElectionNamespace determines the namespace in which the leader
	// election resource will be created.
	LeaderElectionNamespace string

	// LeaderElectionName determines the name of the resource that leader election
	// will use for holding the leader lock.
	LeaderElectionName string

	// LeaseDuration is the duration that non-leader candidates will
	// wait to force acquire leadership. This is measured against time of
	// last observed ack.
	//
	// A client needs to wait a full LeaseDuration without observing a change to
	// the record before it can attempt to take over. When all clients are
	// shutdown and a new set of clients are started with different names against
	// the same leader record, they must wait the full LeaseDuration before
	// attempting to acquire the lease. Thus LeaseDuration should be as short as
	// possible (within your tolerance for clock skew rate) to avoid a possible
	// long waits in the scenario.
	//
	// Core clients default this value to 15 seconds.
	LeaseDuration time.Duration

	// RenewDeadline is the duration that the acting master will retry
	// refreshing leadership before giving up.
	//
	// Core clients default this value to 10 seconds.
	RenewDeadline time.Duration

	// RetryPeriod is the duration the LeaderElector clients should wait
	// between tries of actions.
	//
	// Core clients default this value to 2 seconds.
	RetryPeriod time.Duration

	// OnStartedLeading is called when a LeaderElector client starts leading
	OnStartedLeading func()

	// OnStoppedLeading is called when a LeaderElector client stops leading
	OnStoppedLeading func()

	// OnNewLeader is called when the client observes a leader that is
	// not the previously observed leader. This includes the first observed
	// leader when the client starts.
	OnNewLeader func(identity string)
}

Options provides the requested configuration to create a new resource lock.