Interface LeaderElectionConfiguration

All Superinterfaces:

io.micronaut.core.util.Toggleable

@Internal
@ConfigurationProperties("kubernetes.client.operator.leader-election.lock")
public interface LeaderElectionConfiguration
extends io.micronaut.core.util.Toggleable

The leader election configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LEASE_DURATION
static final String	DEFAULT_RENEW_DEADLINE
static final String	DEFAULT_RETRY_PERIOD
static final String	PREFIX

Method Summary

Modifier and Type	Method	Description
Duration	getLeaseDuration()	The lock lease duration.
Duration	getRenewDeadline()	The lock renew deadline.
@NonNull Optional<String>	getResourceName()	The lock resource name.
@NonNull Optional<String>	getResourceNamespace()	The lock resource namespace.
Duration	getRetryPeriod()	The lock acquire retry period.

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Field Details

PREFIX

static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_LEASE_DURATION

static final String DEFAULT_LEASE_DURATION

See Also:

• Constant Field Values

DEFAULT_RENEW_DEADLINE

static final String DEFAULT_RENEW_DEADLINE

See Also:

• Constant Field Values

DEFAULT_RETRY_PERIOD

static final String DEFAULT_RETRY_PERIOD

See Also:

• Constant Field Values

Method Details

getLeaseDuration

@Bindable(defaultValue="10s")
Duration getLeaseDuration()

The lock lease duration. Default "10s".

Returns:

lease duration

getRenewDeadline

@Bindable(defaultValue="8s")
Duration getRenewDeadline()

The lock renew deadline. If the leader elector fails to renew the lock within the deadline, then the controller loses the lock. Default "8s".

Returns:

renew deadline

getRetryPeriod

@Bindable(defaultValue="5s")
Duration getRetryPeriod()

The lock acquire retry period. Default "5s".

Returns:

lock acquire retry period.

getResourceName

@NonNull Optional<String> getResourceName()

The lock resource name. If not provided then the application name is used.

Returns:

the lock resource name

getResourceNamespace

@NonNull Optional<String> getResourceNamespace()

The lock resource namespace. If not provided then the application namespace is used.

Returns:

the lock resource namespace