v1

Documentation

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type Lease
  • func (v *Lease) GroupVersionKind() schema.GroupVersionKind
• type LeaseList
  • func (v *LeaseList) GroupVersionKind() schema.GroupVersionKind
• type LeaseSpec

Constants

const GroupName = "coordination.k8s.io"

GroupName is the group name use in this package

Variables

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Lease

type Lease struct {

	// 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
	APIVersion string `json:"apiVersion,omitempty"`

	// 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
	Kind string `json:"kind,omitempty"`

	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	Spec *LeaseSpec `json:"spec,omitempty"`
}

Lease Lease defines a lease concept.

swagger:model Lease

func (*Lease) GroupVersionKind

func (v *Lease) GroupVersionKind() schema.GroupVersionKind

type LeaseList

type LeaseList struct {

	// 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
	APIVersion string `json:"apiVersion,omitempty"`

	// items is a list of schema objects.
	// Required: true
	Items []*Lease `json:"items"`

	// 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
	Kind string `json:"kind,omitempty"`

	// Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

LeaseList LeaseList is a list of Lease objects.

swagger:model LeaseList

func (*LeaseList) GroupVersionKind

func (v *LeaseList) GroupVersionKind() schema.GroupVersionKind

type LeaseSpec

type LeaseSpec struct {

	// acquireTime is a time when the current lease was acquired.
	AcquireTime *apimachinery_pkg_apis_meta_v1.MicroTime `json:"acquireTime,omitempty"`

	// holderIdentity contains the identity of the holder of a current lease. If Coordinated Leader Election is used, the holder identity must be equal to the elected LeaseCandidate.metadata.name field.
	HolderIdentity string `json:"holderIdentity,omitempty"`

	// leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measured against the time of last observed renewTime.
	LeaseDurationSeconds int32 `json:"leaseDurationSeconds,omitempty"`

	// leaseTransitions is the number of transitions of a lease between holders.
	LeaseTransitions int32 `json:"leaseTransitions,omitempty"`

	// PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up. This field can only be set if Strategy is also set.
	PreferredHolder string `json:"preferredHolder,omitempty"`

	// renewTime is a time when the current holder of a lease has last updated the lease.
	RenewTime *apimachinery_pkg_apis_meta_v1.MicroTime `json:"renewTime,omitempty"`

	// Strategy indicates the strategy for picking the leader for coordinated leader election. If the field is not specified, there is no active coordination for this lease. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.
	Strategy string `json:"strategy,omitempty"`
}

LeaseSpec LeaseSpec is a specification of a Lease.

swagger:model LeaseSpec