v1

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the leaderworkerset v1 API group +kubebuilder:object:generate=true +groupName=leaderworkerset.x-k8s.io

Index

Constants

View Source 
const (
	// Exclusive topology annotation is used to specify the topology which
	// be used for 1:1 exclusive scheduling.
	ExclusiveKeyAnnotationKey string = "leaderworkerset.sigs.k8s.io/exclusive-topology"

	// Set name label will record the leaderworkerset name that those resources
	// (Pod/Service/StatefulSets) belong to.
	SetNameLabelKey string = "leaderworkerset.sigs.k8s.io/name"

	// Group index label will be added to pods to record which group this
	// statefulset/pod belong to.
	GroupIndexLabelKey string = "leaderworkerset.sigs.k8s.io/group-index"

	// Worker index will be added to pods as a label and annotation which is
	// the index/identity of the pod in the group.
	WorkerIndexLabelKey string = "leaderworkerset.sigs.k8s.io/worker-index"

	// Size will be added to leader pods as an annotation which corresponds to
	// LeaderWorkerSet.Spec.LeaderWorkerTemplate.Size.
	SizeAnnotationKey string = "leaderworkerset.sigs.k8s.io/size"

	// Pods that are in the same group will have an annotation that is a unique
	// hash value.
	GroupUniqueHashLabelKey string = "leaderworkerset.sigs.k8s.io/group-key"

	// Worker pods will have an annotation that is the leader pod's name.
	LeaderPodNameAnnotationKey string = "leaderworkerset.sigs.k8s.io/leader-name"

	// SHAed leaderWorkerTemplate value for version tracking.
	// This will be applied to all API objects including:
	// leaderStatefulset, leaderPods, workerStatefulsets, workerPods.
	TemplateRevisionHashKey string = "leaderworkerset.sigs.k8s.io/template-revision-hash"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "leaderworkerset.x-k8s.io", Version: "v1"}

	// SchemeGroupVersion is alias to GroupVersion for client-go libraries.
	// It is required by pkg/client/informers/externalversions/...
	SchemeGroupVersion = GroupVersion

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

Types

type LeaderWorkerSet 

type LeaderWorkerSet struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   LeaderWorkerSetSpec   `json:"spec,omitempty"`
	Status LeaderWorkerSetStatus `json:"status,omitempty"`
}

LeaderWorkerSet is the Schema for the leaderworkersets API

func (*LeaderWorkerSet) DeepCopy 

func (in *LeaderWorkerSet) DeepCopy() *LeaderWorkerSet

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

func (*LeaderWorkerSet) DeepCopyInto 

func (in *LeaderWorkerSet) DeepCopyInto(out *LeaderWorkerSet)

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

func (*LeaderWorkerSet) DeepCopyObject 

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

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

type LeaderWorkerSetConditionType 

type LeaderWorkerSetConditionType string
const (
	// LeaderWorkerSetAvailable means the lws is available, ie, at least the
	// minimum available groups are up and running.
	LeaderWorkerSetAvailable LeaderWorkerSetConditionType = "Available"

	// LeaderWorkerSetProgressing means lws is progressing. Progress for a
	// lws replica is considered when a new group is created, and when new pods
	// scale up and down. Before a group has all its pods ready, the group itself
	// will be in progressing state. And any group in progress will make
	// the lws as progressing state.
	LeaderWorkerSetProgressing LeaderWorkerSetConditionType = "Progressing"
)

These are built-in conditions of a LWS.

type LeaderWorkerSetList 

type LeaderWorkerSetList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []LeaderWorkerSet `json:"items"`
}

LeaderWorkerSetList contains a list of LeaderWorkerSet.

func (*LeaderWorkerSetList) DeepCopy 

func (in *LeaderWorkerSetList) DeepCopy() *LeaderWorkerSetList

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

func (*LeaderWorkerSetList) DeepCopyInto 

func (in *LeaderWorkerSetList) DeepCopyInto(out *LeaderWorkerSetList)

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

func (*LeaderWorkerSetList) DeepCopyObject 

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

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

type LeaderWorkerSetSpec 

type LeaderWorkerSetSpec struct {
	// Number of leader-workers groups. A scale subresource is available to enable HPA. The
	// selector for HPA will be that of the leader pod, and so practically HPA will be looking up the
	// leader pod metrics. Note that the leader pod could aggregate metrics from
	// the rest of the group and expose them as a summary custom metric representing the whole
	// group.
	// On scale down, the leader pod as well as the workers statefulset will be deleted.
	// Default to 1.
	//
	// +optional
	// +kubebuilder:default=1
	Replicas *int32 `json:"replicas,omitempty"`

	// LeaderWorkerTemplate defines the template for leader/worker pods
	LeaderWorkerTemplate LeaderWorkerTemplate `json:"leaderWorkerTemplate"`

	// RolloutStrategy defines the strategy that will be applied to update replicas
	// when a revision is made to the leaderWorkerTemplate.
	RolloutStrategy RolloutStrategy `json:"rolloutStrategy"`
}

One group consists of a single leader and M workers, and the total number of pods in a group is M+1. LeaderWorkerSet will create N replicas of leader-worker pod groups (hereinafter referred to as group).

Each group has a unique index between 0 and N-1. We call this the leaderIndex. The leaderIndex is used to uniquely name the leader pod of each group in the following format: leaderWorkerSetName-leaderIndex. This is considered as the name of the group too.

Each worker pod in the group has a unique workerIndex between 1 and M. The leader also gets a workerIndex, and it is always set to 0. Worker pods are named using the format: leaderWorkerSetName-leaderIndex-workerIndex.

func (*LeaderWorkerSetSpec) DeepCopy 

func (in *LeaderWorkerSetSpec) DeepCopy() *LeaderWorkerSetSpec

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

func (*LeaderWorkerSetSpec) DeepCopyInto 

func (in *LeaderWorkerSetSpec) DeepCopyInto(out *LeaderWorkerSetSpec)

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

type LeaderWorkerSetStatus 

type LeaderWorkerSetStatus struct {
	// Conditions track the condition of the leaderworkerset.
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// ReadyReplicas track the number of groups that are in ready state (updated or not).
	ReadyReplicas int32 `json:"readyReplicas,omitempty"`

	// UpdatedReplicas track the number of groups that have been updated (ready or not).
	UpdatedReplicas int32 `json:"updatedReplicas,omitempty"`

	// Replicas track the total number of groups that have been created (updated or not, ready or not)
	Replicas int32 `json:"replicas,omitempty"`

	// HPAPodSelector for pods that belong to the LeaderWorkerSet object, this is
	// needed for HPA to know what pods belong to the LeaderWorkerSet object. Here
	// we only select the leader pods.
	HPAPodSelector string `json:"hpaPodSelector,omitempty"`
}

LeaderWorkerSetStatus defines the observed state of LeaderWorkerSet

func (*LeaderWorkerSetStatus) DeepCopy 

func (in *LeaderWorkerSetStatus) DeepCopy() *LeaderWorkerSetStatus

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

func (*LeaderWorkerSetStatus) DeepCopyInto 

func (in *LeaderWorkerSetStatus) DeepCopyInto(out *LeaderWorkerSetStatus)

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

type LeaderWorkerTemplate 

type LeaderWorkerTemplate struct {
	// LeaderTemplate defines the pod template for leader pods.
	LeaderTemplate *corev1.PodTemplateSpec `json:"leaderTemplate,omitempty"`

	// WorkerTemplate defines the pod template for worker pods.
	WorkerTemplate corev1.PodTemplateSpec `json:"workerTemplate"`

	// Number of pods to create. It is the total number of pods in each group.
	// The minimum is 1 which represent the leader. When set to 1, the leader
	// pod is created for each group as well as a 0-replica StatefulSet for the workers.
	// Default to 1.
	//
	// +optional
	// +kubebuilder:default=1
	Size *int32 `json:"size,omitempty"`

	// RestartPolicy defines the restart policy when pod failures happen.
	// +kubebuilder:default=Default
	// +kubebuilder:validation:Enum={Default,RecreateGroupOnPodRestart}
	RestartPolicy RestartPolicyType `json:"restartPolicy"`
}

Template of the leader/worker pods, the group will include at least one leader pod. Defaults to the worker template if not specified. The idea is to allow users to create a group with identical templates without needing to specify the template in both places. For the leader it represents the id of the group, while for the workers it represents the index within the group. For this reason, users should depend on the labels injected by this API whenever possible.

func (*LeaderWorkerTemplate) DeepCopy 

func (in *LeaderWorkerTemplate) DeepCopy() *LeaderWorkerTemplate

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

func (*LeaderWorkerTemplate) DeepCopyInto 

func (in *LeaderWorkerTemplate) DeepCopyInto(out *LeaderWorkerTemplate)

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

type RestartPolicyType 

type RestartPolicyType string
const (
	// RecreateGroupOnPodRestart will recreate all the pods in the group if
	// 1. Any individual pod in the group is recreated; 2. Any containers/init-containers
	// in a pod is restarted. This is to ensure all pods/containers in the group will be
	// started in the same time.
	RecreateGroupOnPodRestart RestartPolicyType = "RecreateGroupOnPodRestart"

	// Default will follow the same behavior as the StatefulSet where only the failed pod
	// will be restarted on failure and other pods in the group will not be impacted.
	DefaultRestartPolicy RestartPolicyType = "Default"
)

type RollingUpdateConfiguration added in v0.2.0 

type RollingUpdateConfiguration struct {
	// The maximum number of replicas that can be unavailable during the update.
	// Value can be an absolute number (ex: 5) or a percentage of total replicas at the start of update (ex: 10%).
	// Absolute number is calculated from percentage by rounding down.
	// This can not be 0 because it will pass through to statefulset which doesn't allow 0 value.
	// By default, a fixed value of 1 is used.
	// Example: when this is set to 30%, the old replicas can be scaled down by 30%
	// immediately when the rolling update starts. Once new replicas are ready, old replicas
	// can be scaled down further, followed by scaling up the new replicas, ensuring
	// that at least 70% of original number of replicas are available at all times
	// during the update.
	//
	// +kubebuilder:validation:XIntOrString
	// +kubebuilder:default=1
	MaxUnavailable intstr.IntOrString `json:"maxUnavailable,omitempty"`
}

RollingUpdateConfiguration defines the parameters to be used for RollingUpdateStrategyType.

func (*RollingUpdateConfiguration) DeepCopy added in v0.2.0 

func (in *RollingUpdateConfiguration) DeepCopy() *RollingUpdateConfiguration

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

func (*RollingUpdateConfiguration) DeepCopyInto added in v0.2.0 

func (in *RollingUpdateConfiguration) DeepCopyInto(out *RollingUpdateConfiguration)

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

type RolloutStrategy added in v0.2.0 

type RolloutStrategy struct {
	// Type defines the rollout strategy, it can only be “RollingUpdate” for now.
	//
	// +kubebuilder:validation:Enum={RollingUpdate}
	// +kubebuilder:default=RollingUpdate
	Type RolloutStrategyType `json:"type"`

	// RollingUpdateConfiguration defines the parameters to be used when type is RollingUpdateStrategyType.
	// +optional
	RollingUpdateConfiguration *RollingUpdateConfiguration `json:"rollingUpdateConfiguration,omitempty"`
}

RolloutStrategy defines the strategy that the leaderWorkerSet controller will use to perform replica updates.

func (*RolloutStrategy) DeepCopy added in v0.2.0 

func (in *RolloutStrategy) DeepCopy() *RolloutStrategy

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

func (*RolloutStrategy) DeepCopyInto added in v0.2.0 

func (in *RolloutStrategy) DeepCopyInto(out *RolloutStrategy)

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

type RolloutStrategyType added in v0.2.0 

type RolloutStrategyType string
const (
	// RollingUpdateStrategyType indicates that replicas will be updated one by one(defined
	// by RollingUpdateConfiguration), the latter one will not start the update until the
	// former one(leader+workers) is ready.
	RollingUpdateStrategyType RolloutStrategyType = "RollingUpdate"
)

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.