leaderelection

Documentation

Index

• Constants
• type Interface
  • func New(log logr.Logger, name, namespace string, kubeClient kubernetes.Interface, ...) (Interface, error)

Constants

const DefaultRetryPeriod = 2 * time.Second

Types

type Interface

type Interface interface {
	// Run is a blocking call that runs a leader election
	Run(ctx context.Context)

	// ID returns this instances unique identifier
	ID() string

	// Name returns the name of the leader election
	Name() string

	// Namespace is the Kubernetes namespace used to coordinate the leader election
	Namespace() string

	// IsLeader indicates if this instance is the leader
	IsLeader() bool

	// GetLeader returns the leader ID
	GetLeader() string
}

func New

func New(log logr.Logger, name, namespace string, kubeClient kubernetes.Interface, id string, retryPeriod time.Duration, startWork func(context.Context), stopWork func()) (Interface, error)