leaderelection

Documentation

Index

• type Options
  • func (o *Options) BindFlags(fs *pflag.FlagSet)

Types

type Options

type Options struct {
	// Enable determines whether or not to use leader election when
	// starting the manager.
	Enable bool

	// ReleaseOnCancel defines if the leader should step down voluntarily
	// when the Manager ends. This requires the binary to immediately end when the
	// Manager is stopped, otherwise this setting is unsafe. Setting this significantly
	// speeds up voluntary leader transitions as the new leader doesn't have to wait
	// LeaseDuration time first.
	ReleaseOnCancel bool

	// LeaseDuration is the duration that non-leader candidates will
	// wait to force acquire leadership. This is measured against time of
	// last observed ack. Default is 35 seconds.
	LeaseDuration time.Duration

	// RenewDeadline is the duration that the acting controlplane will retry
	// refreshing leadership before giving up. Default is 30 seconds.
	RenewDeadline time.Duration

	// RetryPeriod is the duration the LeaderElector clients should wait
	// between tries of actions. Default is 5 seconds.
	RetryPeriod time.Duration
}

Options contains the configuration options for the leader election.

func (*Options) BindFlags

func (o *Options) BindFlags(fs *pflag.FlagSet)

BindFlags will parse the given flagset for leader election option flags and set the Options accordingly.