Skip to content

coordination_v1alpha1

LeaseCandidate

class lightkube.models.coordination_v1alpha1.LeaseCandidate(apiVersion=None, kind=None, metadata=None, spec=None)

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.

parameters

  • apiVersion Optional[str] - 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
  • kind Optional[str] - 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
  • metadata Optional[meta_v1.ObjectMeta] - More info
  • spec Optional[LeaseCandidateSpec] - spec contains the specification of the Lease. More info

LeaseCandidateList

class lightkube.models.coordination_v1alpha1.LeaseCandidateList(items, apiVersion=None, kind=None, metadata=None)

LeaseCandidateList is a list of Lease objects.

parameters

  • items List[LeaseCandidate] - items is a list of schema objects.
  • apiVersion Optional[str] - 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
  • kind Optional[str] - 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
  • metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

LeaseCandidateSpec

class lightkube.models.coordination_v1alpha1.LeaseCandidateSpec(leaseName, preferredStrategies, binaryVersion=None, emulationVersion=None, pingTime=None, renewTime=None)

LeaseCandidateSpec is a specification of a Lease.

parameters

  • leaseName str - LeaseName is the name of the lease for which this candidate is contending. This field is immutable.
  • preferredStrategies List[str] - PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election. The list is ordered, and the first strategy supersedes all other strategies. The list is used by coordinated leader election to make a decision about the final election strategy. This follows as
  • If all clients have strategy X as the first element in this list, strategy X will be used. - If a candidate has strategy [X] and another candidate has strategy [Y, X], Y supersedes X and strategy Y will be used.
  • If a candidate has strategy [X, Y] and another candidate has strategy [Y, X], this is a user error and leader election will not operate the Lease until resolved. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.
  • binaryVersion Optional[str] - BinaryVersion is the binary version. It must be in a semver format without leading v. This field is required when strategy is "OldestEmulationVersion"
  • emulationVersion Optional[str] - 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"
  • pingTime Optional[meta_v1.MicroTime] - 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[meta_v1.MicroTime] - 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.