Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RunOrDie ¶
func RunOrDie(ctx context.Context, lec ElectionConfig)
RunOrDie starts a client with the provided config or panics if the config fails to validate.
Types ¶
type ElectionConfig ¶
type ElectionConfig struct { // Lock is the resource that will be used for locking Lock rl.Interface // LeaseDuration is the duration that non-leader candidates will // wait to force acquire leadership. This is measured against time of // last observed ack. LeaseDuration time.Duration // RenewDeadline is the duration that the acting master will retry // refreshing leadership before giving up. RenewDeadline time.Duration // RetryPeriod is the duration the LeaderElector clients should wait // between tries of actions. RetryPeriod time.Duration // Callbacks are callbacks that are triggered during certain lifecycle // events of the LeaderElector Callbacks LeaderCallbacks // WatchDog is the associated health checker // WatchDog may be null if its not needed/configured. WatchDog *HealthzAdaptor // Name is the name of the resource lock for debugging Name string }
ElectionConfig expands LeaderElectionConfiguration to include controller specific configuration.
type HealthzAdaptor ¶
type HealthzAdaptor struct {
// contains filtered or unexported fields
}
HealthzAdaptor associates the /healthz endpoint with the LeaderElection object. It helps deal with the /healthz endpoint being set up prior to the LeaderElection. This contains the code needed to act as an adaptor between the leader election code the health check code. It allows us to provide health status about the leader election. Most specifically about if the leader has failed to renew without exiting the process. In that case we should report not healthy and rely on the kubelet to take down the process.
func NewLeaderHealthzAdaptor ¶
func NewLeaderHealthzAdaptor(timeout time.Duration) *HealthzAdaptor
NewLeaderHealthzAdaptor creates a basic healthz adaptor to monitor a leader election. timeout determines the time beyond the lease expiry to be allowed for timeout. checks within the timeout period after the lease expires will still return healthy.
func (*HealthzAdaptor) Check ¶
func (l *HealthzAdaptor) Check(req *http.Request) error
Check is called by the healthz endpoint handler. It fails (returns an error) if we own the lease but had not been able to renew it.
func (*HealthzAdaptor) Name ¶
func (l *HealthzAdaptor) Name() string
Name returns the name of the health check we are implementing.
func (*HealthzAdaptor) SetLeaderElection ¶
func (l *HealthzAdaptor) SetLeaderElection(le *LeaderElector)
SetLeaderElection ties a leader election object to a HealthzAdaptor
type LeaderCallbacks ¶
type LeaderCallbacks struct { // OnStartedLeading is called when a LeaderElector client starts leading OnStartedLeading func(context.Context) // 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) }
LeaderCallbacks are callbacks that are triggered during certain lifecycle events of the LeaderElector. These are invoked asynchronously.
possible future callbacks:
- OnChallenge()
type LeaderElector ¶
type LeaderElector struct {
// contains filtered or unexported fields
}
LeaderElector is a leader election client.
func NewLeaderElector ¶
func NewLeaderElector(lec ElectionConfig) (*LeaderElector, error)
NewLeaderElector creates a LeaderElector from a ElectionConfig
func (*LeaderElector) Check ¶
func (le *LeaderElector) Check(maxTolerableExpiredLease time.Duration) error
Check will determine if the current lease is expired by more than timeout.
func (*LeaderElector) GetLeader ¶
func (le *LeaderElector) GetLeader() string
GetLeader returns the identity of the last observed leader or returns the empty string if no leader has yet been observed.
func (*LeaderElector) IsLeader ¶
func (le *LeaderElector) IsLeader() bool
IsLeader returns true if the last observed leader was this client else returns false.
func (*LeaderElector) Run ¶
func (le *LeaderElector) Run(ctx context.Context)
Run starts the leader election loop