leaderelection

Documentation

Index

• type Config
  • func (e *Config) GetLeader() string
  • func (e *Config) ID() string
  • func (e *Config) IsLeader() bool
  • func (e *Config) Name() string
  • func (e *Config) Namespace() string
  • func (e *Config) Run(ctx context.Context)
• type Interface
  • func New(name, namespace string, kubeClient kubernetes.Interface, ...) (Interface, error)

Types

type Config

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

func (*Config) GetLeader

func (e *Config) GetLeader() string

func (*Config) ID

func (e *Config) ID() string

func (*Config) IsLeader

func (e *Config) IsLeader() bool

func (*Config) Name

func (e *Config) Name() string

func (*Config) Namespace

func (e *Config) Namespace() string

func (*Config) Run

func (e *Config) Run(ctx context.Context)

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(name, namespace string, kubeClient kubernetes.Interface, startWork, stopWork func(), log logr.Logger) (Interface, error)