client-go: k8s.io/client-go/tools/leaderelection Index | Files | Directories

package leaderelection

import "k8s.io/client-go/tools/leaderelection"

Package leaderelection implements leader election of a set of endpoints. It uses an annotation in the endpoints object to store the record of the election state.

This implementation does not guarantee that only one client is acting as a leader (a.k.a. fencing). A client observes timestamps captured locally to infer the state of the leader election. Thus the implementation is tolerant to arbitrary clock skew, but is not tolerant to arbitrary clock skew rate.

However the level of tolerance to skew rate can be configured by setting RenewDeadline and LeaseDuration appropriately. The tolerance expressed as a maximum tolerated ratio of time passed on the fastest node to time passed on the slowest node can be approximately achieved with a configuration that sets the same ratio of LeaseDuration to RenewDeadline. For example if a user wanted to tolerate some nodes progressing forward in time twice as fast as other nodes, the user could set LeaseDuration to 60 seconds and RenewDeadline to 30 seconds.

While not required, some method of clock synchronization between nodes in the cluster is highly recommended. It's important to keep in mind when configuring this client that the tolerance to skew rate varies inversely to master availability.

Larger clusters often have a more lenient SLA for API latency. This should be taken into account when configuring the client. The rate of leader transitions should be monitored and RetryPeriod and LeaseDuration should be increased until the rate is stable and acceptably low. It's important to keep in mind when configuring this client that the tolerance to API latency varies inversely to master availability.

DISCLAIMER: this is an alpha API. This library will likely change significantly or even be removed entirely in subsequent releases. Depend on this API at your own risk.

Index

Package Files

leaderelection.go

Constants

const (
    JitterFactor = 1.2
)

func RunOrDie Uses

func RunOrDie(ctx context.Context, lec LeaderElectionConfig)

RunOrDie starts a client with the provided config or panics if the config fails to validate.

type LeaderCallbacks Uses

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 LeaderElectionConfig Uses

type LeaderElectionConfig 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
}

type LeaderElector Uses

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

LeaderElector is a leader election client.

func NewLeaderElector Uses

func NewLeaderElector(lec LeaderElectionConfig) (*LeaderElector, error)

NewLeaderElector creates a LeaderElector from a LeaderElectionConfig

func (*LeaderElector) GetLeader Uses

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 Uses

func (le *LeaderElector) IsLeader() bool

IsLeader returns true if the last observed leader was this client else returns false.

func (*LeaderElector) Run Uses

func (le *LeaderElector) Run(ctx context.Context)

Run starts the leader election loop

Directories

PathSynopsis
resourcelock

Package leaderelection imports 10 packages (graph) and is imported by 43 packages. Updated 2018-09-27. Refresh now. Tools for package owners.