Skip to main content
Schemaobject

io.k8s.api.coordination.v1alpha2.LeaseCandidateSpec

LeaseCandidateSpec is a specification of a Lease.

Source
specs/apis__coordination.k8s.io__v1alpha2_openapi.json
Revision
9a79c3bd90f7
Active snapshot
2a9112600697
binaryVersion string
required

binaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required.

emulationVersion string
optional

emulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is "OldestEmulationVersion"

leaseName string
required

leaseName is the name of the lease for which this candidate is contending. This field is immutable.

pingTime
optional

pingTime is the last time that the server has requested the LeaseCandidate to renew. It is only done during leader election to check if any LeaseCandidates have become ineligible. When PingTime is updated, the LeaseCandidate will respond by updating RenewTime.

renewTime
optional

renewTime is the time that the LeaseCandidate was last updated. Any time a Lease needs to do leader election, the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime. Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew. The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates.

strategy string
required

strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the candidate with the latest BinaryVersion will be used. If there is still conflict, this is a user error and coordinated leader election will not operate the Lease until resolved.