⎈ k8s knowledge compiler

LeaseCandidate [page]deterministic

LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

reference

`apiVersion: coordination.k8s.io/v1beta1`

`import "k8s.io/api/coordination/v1beta1"`

## LeaseCandidate {#LeaseCandidate}

LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

<hr>

<table> <thead><tr><th>Field</th><th>Description</th></tr></thead> <tbody> <tr> <td><code>apiVersion</code><br/><em>string</em></td> <td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</td> </tr> <tr> <td><code>kind</code><br/><em>string</em></td> <td>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</td> </tr> <tr> <td><code>metadata</code><br/><em><a href="">ObjectMeta</a></em></td> <td>More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</td> </tr> <tr> <td><code>spec</code>&nbsp;<strong>*</strong><br/><em><a href="">LeaseCandidateSpec</a></em></td> <td>spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</td> </tr> </tbody> </table>

## LeaseCandidateSpec {#LeaseCandidateSpec}

LeaseCandidateSpec is a specification of a Lease.

<hr>

<table> <thead><tr><th>Field</th><th>Description</th></tr></thead> <tbody> <tr> <td><code>binaryVersion</code>&nbsp;<strong>*</strong><br/><em>string</em></td> <td>BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required.</td> </tr> <tr> <td><code>emulationVersion</code><br/><em>string</em></td> <td>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"</td> </tr> <tr> <td><code>leaseName</code>&nbsp;<strong>*</strong><br/><em>string</em></td> <td>LeaseName is the name of the lease for which this candidate is contending. The limits on this field are the same as on Lease.name. Multiple lease candidates may reference the same Lease.name. This field is immutable.</td> </tr> <tr> <td><code>pingTime</code><br/><em><a href="">MicroTime</a></em></td> <td>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.</td> </tr> <tr> <td><code>renewTime</code><br/><em><a href="">MicroTime</a></em></td> <td>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.</td> </tr> <tr> <td><code>strategy</code>&nbsp;<strong>*</strong><br/><em>string</em></td> <td>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 con …(trimmed)

Sources

reference/kubernetes-api/coordination/lease-candidate-v1beta1.md · docLeaseCandidate

Related (16)

part_of LeaseCandidate {#LeaseCandidate}describes conf=1
part_of LeaseCandidateSpec {#LeaseCandidateSpec}describes conf=1
part_of LeaseCandidateList {#LeaseCandidateList}describes conf=1
part_of Operations {#Operations}describes conf=1
part_of `post` Createdescribes conf=1
part_of `patch` Patchdescribes conf=1
part_of `put` Replacedescribes conf=1
part_of `delete` Deletedescribes conf=1
part_of `delete` Delete Collectiondescribes conf=1
part_of `get` Readdescribes conf=1
part_of `get` Listdescribes conf=1
part_of `get` List All Namespacesdescribes conf=1
part_of `get` Watchdescribes conf=1
part_of `get` Watch Listdescribes conf=1
part_of `get` Watch List All Namespacesdescribes conf=1
api_for Leasedocuments API object conf=1

← all Docs