leaderelection

package

v1.1.0 Latest Latest Go to latest Published: Feb 17, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/liqotech/liqo

Links

Documentation ¶

Overview ¶

Package leaderelection contains the leader election mechanism.

Index ¶

func Blocking(ctx context.Context, rc *rest.Config, eb record.EventBroadcaster, opts *Opts) (bool, error)
func Init(opts *Opts, rc *rest.Config, eb record.EventBroadcaster) (*leaderelection.LeaderElector, error)
func IsLeader() bool
func LabelerOnElection(ctx context.Context, mgr manager.Manager, info *PodInfo)
func Run(ctx context.Context, leaderelector *leaderelection.LeaderElector)
type Opts
type PodInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Blocking ¶

func Blocking(ctx context.Context, rc *rest.Config, eb record.EventBroadcaster, opts *Opts) (bool, error)

Blocking runs the blocking leader election.

func Init ¶

func Init(opts *Opts, rc *rest.Config, eb record.EventBroadcaster) (*leaderelection.LeaderElector, error)

Init initializes the leader election mechanism.

func IsLeader ¶

func IsLeader() bool

IsLeader returns true if the current pod is the leader.

func LabelerOnElection ¶

func LabelerOnElection(ctx context.Context, mgr manager.Manager, info *PodInfo)

LabelerOnElection is a function that labels the leader pod with the leader label.

func Run ¶

func Run(ctx context.Context, leaderelector *leaderelection.LeaderElector)

Run run the leader election mechanism.

Types ¶

type Opts ¶

type Opts struct {
	PodInfo
	Client            client.Client
	LeaderElectorName string
	LeaseDuration     time.Duration
	RenewDeadline     time.Duration
	RetryPeriod       time.Duration
	InitCallback      func()
	StopCallback      func()
	LabelLeader       bool
}

Opts contains the options to configure the leader election mechanism.

type PodInfo ¶

type PodInfo struct {
	PodName        string
	Namespace      string
	DeploymentName *string
}

PodInfo contains the information about the pod.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL