v1

package
v0.31.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 23, 2024 License: Apache-2.0 Imports: 10 Imported by: 967

Documentation

Index

Constants

View Source 
const GroupName = "coordination.k8s.io"

GroupName is the group name use in this package

Variables

View Source 
var (
	ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	AddToScheme = localSchemeBuilder.AddToScheme
)
View Source 
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 CoordinatedLeaseStrategy added in v0.31.0 

type CoordinatedLeaseStrategy string
const (
	// OldestEmulationVersion picks the oldest LeaseCandidate, where "oldest" is defined as follows
	// 1) Select the candidate(s) with the lowest emulation version
	// 2) If multiple candidates have the same emulation version, select the candidate(s) with the lowest binary version. (Note that binary version must be greater or equal to emulation version)
	// 3) If multiple candidates have the same binary version, select the candidate with the oldest creationTimestamp.
	// If a candidate does not specify the emulationVersion and binaryVersion fields, it will not be considered a candidate for the lease.
	OldestEmulationVersion CoordinatedLeaseStrategy = "OldestEmulationVersion"
)

CoordinatedLeaseStrategy defines the strategy for picking the leader for coordinated leader election.

type Lease 

type Lease struct {
	metav1.TypeMeta `json:",inline"`
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// spec contains the specification of the Lease.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Spec LeaseSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}

Lease defines a lease concept.

func (*Lease) APILifecycleIntroduced added in v0.31.0 

func (in *Lease) APILifecycleIntroduced() (major, minor int)

APILifecycleIntroduced is an autogenerated function, returning the release in which the API struct was introduced as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:introduced" tags in types.go.

func (*Lease) DeepCopy 

func (in *Lease) DeepCopy() *Lease

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Lease.

func (*Lease) DeepCopyInto 

func (in *Lease) DeepCopyInto(out *Lease)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Lease) DeepCopyObject 

func (in *Lease) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Lease) Descriptor 

func (*Lease) Descriptor() ([]byte, []int)

func (*Lease) Marshal 

func (m *Lease) Marshal() (dAtA []byte, err error)

func (*Lease) MarshalTo 

func (m *Lease) MarshalTo(dAtA []byte) (int, error)

func (*Lease) MarshalToSizedBuffer added in v0.16.4 

func (m *Lease) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Lease) ProtoMessage 

func (*Lease) ProtoMessage()

func (*Lease) Reset 

func (m *Lease) Reset()

func (*Lease) Size 

func (m *Lease) Size() (n int)

func (*Lease) String 

func (this *Lease) String() string

func (Lease) SwaggerDoc 

func (Lease) SwaggerDoc() map[string]string

func (*Lease) Unmarshal 

func (m *Lease) Unmarshal(dAtA []byte) error

func (*Lease) XXX_DiscardUnknown added in v0.16.4 

func (m *Lease) XXX_DiscardUnknown()

func (*Lease) XXX_Marshal added in v0.16.4 

func (m *Lease) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Lease) XXX_Merge added in v0.16.4 

func (m *Lease) XXX_Merge(src proto.Message)

func (*Lease) XXX_Size added in v0.16.4 

func (m *Lease) XXX_Size() int

func (*Lease) XXX_Unmarshal added in v0.16.4 

func (m *Lease) XXX_Unmarshal(b []byte) error

type LeaseList 

type LeaseList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// items is a list of schema objects.
	Items []Lease `json:"items" protobuf:"bytes,2,rep,name=items"`
}

LeaseList is a list of Lease objects.

func (*LeaseList) APILifecycleIntroduced added in v0.31.0 

func (in *LeaseList) APILifecycleIntroduced() (major, minor int)

APILifecycleIntroduced is an autogenerated function, returning the release in which the API struct was introduced as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:introduced" tags in types.go.

func (*LeaseList) DeepCopy 

func (in *LeaseList) DeepCopy() *LeaseList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LeaseList.

func (*LeaseList) DeepCopyInto 

func (in *LeaseList) DeepCopyInto(out *LeaseList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*LeaseList) DeepCopyObject 

func (in *LeaseList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*LeaseList) Descriptor 

func (*LeaseList) Descriptor() ([]byte, []int)

func (*LeaseList) Marshal 

func (m *LeaseList) Marshal() (dAtA []byte, err error)

func (*LeaseList) MarshalTo 

func (m *LeaseList) MarshalTo(dAtA []byte) (int, error)

func (*LeaseList) MarshalToSizedBuffer added in v0.16.4 

func (m *LeaseList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*LeaseList) ProtoMessage 

func (*LeaseList) ProtoMessage()

func (*LeaseList) Reset 

func (m *LeaseList) Reset()

func (*LeaseList) Size 

func (m *LeaseList) Size() (n int)

func (*LeaseList) String 

func (this *LeaseList) String() string

func (LeaseList) SwaggerDoc 

func (LeaseList) SwaggerDoc() map[string]string

func (*LeaseList) Unmarshal 

func (m *LeaseList) Unmarshal(dAtA []byte) error

func (*LeaseList) XXX_DiscardUnknown added in v0.16.4 

func (m *LeaseList) XXX_DiscardUnknown()

func (*LeaseList) XXX_Marshal added in v0.16.4 

func (m *LeaseList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LeaseList) XXX_Merge added in v0.16.4 

func (m *LeaseList) XXX_Merge(src proto.Message)

func (*LeaseList) XXX_Size added in v0.16.4 

func (m *LeaseList) XXX_Size() int

func (*LeaseList) XXX_Unmarshal added in v0.16.4 

func (m *LeaseList) XXX_Unmarshal(b []byte) error

type LeaseSpec 

type LeaseSpec struct {
	// 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.
	// +optional
	HolderIdentity *string `json:"holderIdentity,omitempty" protobuf:"bytes,1,opt,name=holderIdentity"`
	// 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.
	// +optional
	LeaseDurationSeconds *int32 `json:"leaseDurationSeconds,omitempty" protobuf:"varint,2,opt,name=leaseDurationSeconds"`
	// acquireTime is a time when the current lease was acquired.
	// +optional
	AcquireTime *metav1.MicroTime `json:"acquireTime,omitempty" protobuf:"bytes,3,opt,name=acquireTime"`
	// renewTime is a time when the current holder of a lease has last
	// updated the lease.
	// +optional
	RenewTime *metav1.MicroTime `json:"renewTime,omitempty" protobuf:"bytes,4,opt,name=renewTime"`
	// leaseTransitions is the number of transitions of a lease between
	// holders.
	// +optional
	LeaseTransitions *int32 `json:"leaseTransitions,omitempty" protobuf:"varint,5,opt,name=leaseTransitions"`
	// 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.
	// +featureGate=CoordinatedLeaderElection
	// +optional
	Strategy *CoordinatedLeaseStrategy `json:"strategy,omitempty" protobuf:"bytes,6,opt,name=strategy"`
	// 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.
	// +featureGate=CoordinatedLeaderElection
	// +optional
	PreferredHolder *string `json:"preferredHolder,omitempty" protobuf:"bytes,7,opt,name=preferredHolder"`
}

LeaseSpec is a specification of a Lease.

func (*LeaseSpec) DeepCopy 

func (in *LeaseSpec) DeepCopy() *LeaseSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LeaseSpec.

func (*LeaseSpec) DeepCopyInto 

func (in *LeaseSpec) DeepCopyInto(out *LeaseSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*LeaseSpec) Descriptor 

func (*LeaseSpec) Descriptor() ([]byte, []int)

func (*LeaseSpec) Marshal 

func (m *LeaseSpec) Marshal() (dAtA []byte, err error)

func (*LeaseSpec) MarshalTo 

func (m *LeaseSpec) MarshalTo(dAtA []byte) (int, error)

func (*LeaseSpec) MarshalToSizedBuffer added in v0.16.4 

func (m *LeaseSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*LeaseSpec) ProtoMessage 

func (*LeaseSpec) ProtoMessage()

func (*LeaseSpec) Reset 

func (m *LeaseSpec) Reset()

func (*LeaseSpec) Size 

func (m *LeaseSpec) Size() (n int)

func (*LeaseSpec) String 

func (this *LeaseSpec) String() string

func (LeaseSpec) SwaggerDoc 

func (LeaseSpec) SwaggerDoc() map[string]string

func (*LeaseSpec) Unmarshal 

func (m *LeaseSpec) Unmarshal(dAtA []byte) error

func (*LeaseSpec) XXX_DiscardUnknown added in v0.16.4 

func (m *LeaseSpec) XXX_DiscardUnknown()

func (*LeaseSpec) XXX_Marshal added in v0.16.4 

func (m *LeaseSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LeaseSpec) XXX_Merge added in v0.16.4 

func (m *LeaseSpec) XXX_Merge(src proto.Message)

func (*LeaseSpec) XXX_Size added in v0.16.4 

func (m *LeaseSpec) XXX_Size() int

func (*LeaseSpec) XXX_Unmarshal added in v0.16.4 

func (m *LeaseSpec) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.