package v1alpha2

const (
	// PodGroupScheduled represents status of the scheduling process for this PodGroup.
	PodGroupScheduled string = "PodGroupScheduled"
	// DisruptionTarget indicates the PodGroup is about to be terminated due to disruption
	// such as preemption.
	DisruptionTarget string = "DisruptionTarget"
)

Well-known condition types for PodGroups.

const (
	// Unschedulable reason in the PodGroupScheduled condition indicates that the PodGroup cannot be scheduled
	// due to resource constraints, affinity/anti-affinity rules, or insufficient capacity for the PodGroup.
	PodGroupReasonUnschedulable string = "Unschedulable"
	// SchedulerError reason in the PodGroupScheduled condition means that some internal error happens
	// during scheduling, for example due to nodeAffinity parsing errors.
	PodGroupReasonSchedulerError string = "SchedulerError"
	// PreemptionByScheduler reason in the DisruptionTarget condition indicates the PodGroup was preempted
	// to make room for higher-priority PodGroups or Pods.
	PodGroupReasonPreemptionByScheduler string = "PreemptionByScheduler"
)

Well-known condition reasons for PodGroups.

const GroupName = "scheduling.k8s.io"

GroupName is the group name use in this package

const WorkloadMaxPodGroupTemplates = 8

WorkloadMaxPodGroupTemplates is the maximum number of pod group templates per Workload.

Variables ¶

var (
	ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)

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
)

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

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 BasicSchedulingPolicy ¶

type BasicSchedulingPolicy struct {
}

BasicSchedulingPolicy indicates that standard Kubernetes scheduling behavior should be used.

func (*BasicSchedulingPolicy) DeepCopy ¶

func (in *BasicSchedulingPolicy) DeepCopy() *BasicSchedulingPolicy

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

func (*BasicSchedulingPolicy) DeepCopyInto ¶

func (in *BasicSchedulingPolicy) DeepCopyInto(out *BasicSchedulingPolicy)

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

func (*BasicSchedulingPolicy) Marshal ¶

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

func (*BasicSchedulingPolicy) MarshalTo ¶

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

func (*BasicSchedulingPolicy) MarshalToSizedBuffer ¶

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

func (BasicSchedulingPolicy) OpenAPIModelName ¶

func (in BasicSchedulingPolicy) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*BasicSchedulingPolicy) Reset ¶

func (m *BasicSchedulingPolicy) Reset()

func (*BasicSchedulingPolicy) Size ¶

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

func (*BasicSchedulingPolicy) String ¶

func (this *BasicSchedulingPolicy) String() string

func (BasicSchedulingPolicy) SwaggerDoc ¶

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

func (*BasicSchedulingPolicy) Unmarshal ¶

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

type GangSchedulingPolicy ¶

type GangSchedulingPolicy struct {
	// MinCount is the minimum number of pods that must be schedulable or scheduled
	// at the same time for the scheduler to admit the entire group.
	// It must be a positive integer.
	//
	// +required
	// +k8s:required
	// +k8s:minimum=1
	MinCount int32 `json:"minCount" protobuf:"varint,1,opt,name=minCount"`
}

GangSchedulingPolicy defines the parameters for gang scheduling.

func (*GangSchedulingPolicy) DeepCopy ¶

func (in *GangSchedulingPolicy) DeepCopy() *GangSchedulingPolicy

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

func (*GangSchedulingPolicy) DeepCopyInto ¶

func (in *GangSchedulingPolicy) DeepCopyInto(out *GangSchedulingPolicy)

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

func (*GangSchedulingPolicy) Marshal ¶

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

func (*GangSchedulingPolicy) MarshalTo ¶

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

func (*GangSchedulingPolicy) MarshalToSizedBuffer ¶

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

func (GangSchedulingPolicy) OpenAPIModelName ¶

func (in GangSchedulingPolicy) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*GangSchedulingPolicy) Reset ¶

func (m *GangSchedulingPolicy) Reset()

func (*GangSchedulingPolicy) Size ¶

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

func (*GangSchedulingPolicy) String ¶

func (this *GangSchedulingPolicy) String() string

func (GangSchedulingPolicy) SwaggerDoc ¶

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

func (*GangSchedulingPolicy) Unmarshal ¶

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

type PodGroup ¶

type PodGroup struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// 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 defines the desired state of the PodGroup.
	//
	// +required
	Spec PodGroupSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`

	// Status represents the current observed state of the PodGroup.
	//
	// +optional
	Status PodGroupStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

PodGroup represents a runtime instance of pods grouped together. PodGroups are created by workload controllers (Job, LWS, JobSet, etc...) from Workload.podGroupTemplates. PodGroup API enablement is toggled by the GenericWorkload feature gate.

func (*PodGroup) DeepCopy ¶

func (in *PodGroup) DeepCopy() *PodGroup

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

func (*PodGroup) DeepCopyInto ¶

func (in *PodGroup) DeepCopyInto(out *PodGroup)

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

func (*PodGroup) DeepCopyObject ¶

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

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

func (*PodGroup) Marshal ¶

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

func (*PodGroup) MarshalTo ¶

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

func (*PodGroup) MarshalToSizedBuffer ¶

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

func (PodGroup) OpenAPIModelName ¶

func (in PodGroup) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroup) Reset ¶

func (m *PodGroup) Reset()

func (*PodGroup) Size ¶

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

func (*PodGroup) String ¶

func (this *PodGroup) String() string

func (PodGroup) SwaggerDoc ¶

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

func (*PodGroup) Unmarshal ¶

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

type PodGroupList ¶

type PodGroupList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	//
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Items is the list of PodGroups.
	Items []PodGroup `json:"items" protobuf:"bytes,2,rep,name=items"`
}

PodGroupList contains a list of PodGroup resources.

func (*PodGroupList) DeepCopy ¶

func (in *PodGroupList) DeepCopy() *PodGroupList

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

func (*PodGroupList) DeepCopyInto ¶

func (in *PodGroupList) DeepCopyInto(out *PodGroupList)

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

func (*PodGroupList) DeepCopyObject ¶

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

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

func (*PodGroupList) Marshal ¶

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

func (*PodGroupList) MarshalTo ¶

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

func (*PodGroupList) MarshalToSizedBuffer ¶

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

func (PodGroupList) OpenAPIModelName ¶

func (in PodGroupList) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroupList) Reset ¶

func (m *PodGroupList) Reset()

func (*PodGroupList) Size ¶

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

func (*PodGroupList) String ¶

func (this *PodGroupList) String() string

func (PodGroupList) SwaggerDoc ¶

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

func (*PodGroupList) Unmarshal ¶

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

type PodGroupSchedulingConstraints ¶

type PodGroupSchedulingConstraints struct {
	// Topology defines the topology constraints for the pod group.
	// Currently only a single topology constraint can be specified. This may change in the future.
	//
	// +optional
	// +k8s:optional
	// +k8s:maxItems=1
	// +listType=atomic
	// +k8s:listType=atomic
	Topology []TopologyConstraint `json:"topology,omitempty" protobuf:"bytes,1,rep,name=topology"`
}

PodGroupSchedulingConstraints defines scheduling constraints (e.g. topology) for a PodGroup.

func (*PodGroupSchedulingConstraints) DeepCopy ¶

func (in *PodGroupSchedulingConstraints) DeepCopy() *PodGroupSchedulingConstraints

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

func (*PodGroupSchedulingConstraints) DeepCopyInto ¶

func (in *PodGroupSchedulingConstraints) DeepCopyInto(out *PodGroupSchedulingConstraints)

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

func (*PodGroupSchedulingConstraints) Marshal ¶

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

func (*PodGroupSchedulingConstraints) MarshalTo ¶

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

func (*PodGroupSchedulingConstraints) MarshalToSizedBuffer ¶

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

func (PodGroupSchedulingConstraints) OpenAPIModelName ¶

func (in PodGroupSchedulingConstraints) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroupSchedulingConstraints) Reset ¶

func (m *PodGroupSchedulingConstraints) Reset()

func (*PodGroupSchedulingConstraints) Size ¶

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

func (*PodGroupSchedulingConstraints) String ¶

func (this *PodGroupSchedulingConstraints) String() string

func (PodGroupSchedulingConstraints) SwaggerDoc ¶

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

func (*PodGroupSchedulingConstraints) Unmarshal ¶

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

type PodGroupSchedulingPolicy ¶

type PodGroupSchedulingPolicy struct {
	// Basic specifies that the pods in this group should be scheduled using
	// standard Kubernetes scheduling behavior.
	//
	// +optional
	// +k8s:optional
	// +k8s:unionMember
	Basic *BasicSchedulingPolicy `json:"basic,omitempty" protobuf:"bytes,1,opt,name=basic"`

	// Gang specifies that the pods in this group should be scheduled using
	// all-or-nothing semantics.
	//
	// +optional
	// +k8s:optional
	// +k8s:unionMember
	Gang *GangSchedulingPolicy `json:"gang,omitempty" protobuf:"bytes,2,opt,name=gang"`
}

PodGroupSchedulingPolicy defines the scheduling configuration for a PodGroup. Exactly one policy must be set. +union

func (*PodGroupSchedulingPolicy) DeepCopy ¶

func (in *PodGroupSchedulingPolicy) DeepCopy() *PodGroupSchedulingPolicy

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

func (*PodGroupSchedulingPolicy) DeepCopyInto ¶

func (in *PodGroupSchedulingPolicy) DeepCopyInto(out *PodGroupSchedulingPolicy)

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

func (*PodGroupSchedulingPolicy) Marshal ¶

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

func (*PodGroupSchedulingPolicy) MarshalTo ¶

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

func (*PodGroupSchedulingPolicy) MarshalToSizedBuffer ¶

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

func (PodGroupSchedulingPolicy) OpenAPIModelName ¶

func (in PodGroupSchedulingPolicy) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroupSchedulingPolicy) Reset ¶

func (m *PodGroupSchedulingPolicy) Reset()

func (*PodGroupSchedulingPolicy) Size ¶

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

func (*PodGroupSchedulingPolicy) String ¶

func (this *PodGroupSchedulingPolicy) String() string

func (PodGroupSchedulingPolicy) SwaggerDoc ¶

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

func (*PodGroupSchedulingPolicy) Unmarshal ¶

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

type PodGroupSpec ¶

type PodGroupSpec struct {
	// PodGroupTemplateRef references an optional PodGroup template within other object
	// (e.g. Workload) that was used to create the PodGroup. This field is immutable.
	//
	// +optional
	// +k8s:optional
	// +k8s:alpha(since:"1.36")=+k8s:immutable
	PodGroupTemplateRef *PodGroupTemplateReference `json:"podGroupTemplateRef" protobuf:"bytes,1,opt,name=podGroupTemplateRef"`

	// SchedulingPolicy defines the scheduling policy for this instance of the PodGroup.
	// Controllers are expected to fill this field by copying it from a PodGroupTemplate.
	// This field is immutable.
	//
	// +required
	// +k8s:alpha(since:"1.36")=+k8s:immutable
	SchedulingPolicy PodGroupSchedulingPolicy `json:"schedulingPolicy" protobuf:"bytes,2,opt,name=schedulingPolicy"`

	// SchedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroup.
	// Controllers are expected to fill this field by copying it from a PodGroupTemplate.
	// This field is immutable.
	// This field is only available when the TopologyAwareWorkloadScheduling feature gate is enabled.
	//
	// +featureGate=TopologyAwareWorkloadScheduling
	// +optional
	// +k8s:ifDisabled(TopologyAwareWorkloadScheduling)=+k8s:forbidden
	// +k8s:ifEnabled(TopologyAwareWorkloadScheduling)=+k8s:optional
	// +k8s:ifEnabled(TopologyAwareWorkloadScheduling)=+k8s:immutable
	SchedulingConstraints *PodGroupSchedulingConstraints `json:"schedulingConstraints,omitempty" protobuf:"bytes,3,opt,name=schedulingConstraints"`
}

PodGroupSpec defines the desired state of a PodGroup.

func (*PodGroupSpec) DeepCopy ¶

func (in *PodGroupSpec) DeepCopy() *PodGroupSpec

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

func (*PodGroupSpec) DeepCopyInto ¶

func (in *PodGroupSpec) DeepCopyInto(out *PodGroupSpec)

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

func (*PodGroupSpec) Marshal ¶

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

func (*PodGroupSpec) MarshalTo ¶

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

func (*PodGroupSpec) MarshalToSizedBuffer ¶

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

func (PodGroupSpec) OpenAPIModelName ¶

func (in PodGroupSpec) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroupSpec) Reset ¶

func (m *PodGroupSpec) Reset()

func (*PodGroupSpec) Size ¶

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

func (*PodGroupSpec) String ¶

func (this *PodGroupSpec) String() string

func (PodGroupSpec) SwaggerDoc ¶

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

func (*PodGroupSpec) Unmarshal ¶

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

type PodGroupStatus ¶

type PodGroupStatus struct {
	// Conditions represent the latest observations of the PodGroup's state.
	//
	// Known condition types:
	// - "PodGroupScheduled": Indicates whether the scheduling requirement has been satisfied.
	// - "DisruptionTarget": Indicates whether the PodGroup is about to be terminated
	//   due to disruption such as preemption.
	//
	// Known reasons for the PodGroupScheduled condition:
	// - "Unschedulable": The PodGroup cannot be scheduled due to resource constraints,
	//   affinity/anti-affinity rules, or insufficient capacity for the gang.
	// - "SchedulerError": The PodGroup cannot be scheduled due to some internal error
	//   that happened during scheduling, for example due to nodeAffinity parsing errors.
	//
	// Known reasons for the DisruptionTarget condition:
	// - "PreemptionByScheduler": The PodGroup was preempted by the scheduler to make room for
	//   higher-priority PodGroups or Pods.
	//
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=type
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
}

PodGroupStatus represents information about the status of a pod group.

func (*PodGroupStatus) DeepCopy ¶

func (in *PodGroupStatus) DeepCopy() *PodGroupStatus

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

func (*PodGroupStatus) DeepCopyInto ¶

func (in *PodGroupStatus) DeepCopyInto(out *PodGroupStatus)

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

func (*PodGroupStatus) Marshal ¶

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

func (*PodGroupStatus) MarshalTo ¶

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

func (*PodGroupStatus) MarshalToSizedBuffer ¶

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

func (PodGroupStatus) OpenAPIModelName ¶

func (in PodGroupStatus) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroupStatus) Reset ¶

func (m *PodGroupStatus) Reset()

func (*PodGroupStatus) Size ¶

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

func (*PodGroupStatus) String ¶

func (this *PodGroupStatus) String() string

func (PodGroupStatus) SwaggerDoc ¶

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

func (*PodGroupStatus) Unmarshal ¶

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

type PodGroupTemplate ¶

type PodGroupTemplate struct {
	// Name is a unique identifier for the PodGroupTemplate within the Workload.
	// It must be a DNS label. This field is immutable.
	//
	// +required
	// +k8s:required
	// +k8s:format=k8s-short-name
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`

	// SchedulingPolicy defines the scheduling policy for this PodGroupTemplate.
	//
	// +required
	SchedulingPolicy PodGroupSchedulingPolicy `json:"schedulingPolicy" protobuf:"bytes,2,opt,name=schedulingPolicy"`

	// SchedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroupTemplate.
	// This field is only available when the TopologyAwareWorkloadScheduling feature gate is enabled.
	//
	// +featureGate=TopologyAwareWorkloadScheduling
	// +optional
	// +k8s:ifDisabled(TopologyAwareWorkloadScheduling)=+k8s:forbidden
	// +k8s:ifEnabled(TopologyAwareWorkloadScheduling)=+k8s:optional
	SchedulingConstraints *PodGroupSchedulingConstraints `json:"schedulingConstraints" protobuf:"bytes,3,opt,name=schedulingConstraints"`
}

PodGroupTemplate represents a template for a set of pods with a scheduling policy.

func (*PodGroupTemplate) DeepCopy ¶

func (in *PodGroupTemplate) DeepCopy() *PodGroupTemplate

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

func (*PodGroupTemplate) DeepCopyInto ¶

func (in *PodGroupTemplate) DeepCopyInto(out *PodGroupTemplate)

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

func (*PodGroupTemplate) Marshal ¶

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

func (*PodGroupTemplate) MarshalTo ¶

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

func (*PodGroupTemplate) MarshalToSizedBuffer ¶

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

func (PodGroupTemplate) OpenAPIModelName ¶

func (in PodGroupTemplate) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroupTemplate) Reset ¶

func (m *PodGroupTemplate) Reset()

func (*PodGroupTemplate) Size ¶

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

func (*PodGroupTemplate) String ¶

func (this *PodGroupTemplate) String() string

func (PodGroupTemplate) SwaggerDoc ¶

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

func (*PodGroupTemplate) Unmarshal ¶

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

type PodGroupTemplateReference ¶

type PodGroupTemplateReference struct {
	// Workload references the PodGroupTemplate within the Workload object that was used to create
	// the PodGroup.
	//
	// +optional
	// +k8s:optional
	// +k8s:unionMember
	Workload *WorkloadPodGroupTemplateReference `json:"workload" protobuf:"bytes,1,opt,name=workload"`
}

PodGroupTemplateReference references a PodGroup template defined in some object (e.g. Workload). Exactly one reference must be set. +union

func (*PodGroupTemplateReference) DeepCopy ¶

func (in *PodGroupTemplateReference) DeepCopy() *PodGroupTemplateReference

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

func (*PodGroupTemplateReference) DeepCopyInto ¶

func (in *PodGroupTemplateReference) DeepCopyInto(out *PodGroupTemplateReference)

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

func (*PodGroupTemplateReference) Marshal ¶

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

func (*PodGroupTemplateReference) MarshalTo ¶

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

func (*PodGroupTemplateReference) MarshalToSizedBuffer ¶

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

func (PodGroupTemplateReference) OpenAPIModelName ¶

func (in PodGroupTemplateReference) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*PodGroupTemplateReference) Reset ¶

func (m *PodGroupTemplateReference) Reset()

func (*PodGroupTemplateReference) Size ¶

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

func (*PodGroupTemplateReference) String ¶

func (this *PodGroupTemplateReference) String() string

func (PodGroupTemplateReference) SwaggerDoc ¶

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

func (*PodGroupTemplateReference) Unmarshal ¶

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

type TopologyConstraint ¶

type TopologyConstraint struct {
	// Key specifies the key of the node label representing the topology domain.
	// All pods within the PodGroup must be colocated within the same domain instance.
	// Different PodGroups can land on different domain instances even if they derive from the same PodGroupTemplate.
	// Examples: "topology.kubernetes.io/rack"
	//
	// +required
	// +k8s:required
	// +k8s:format=k8s-label-key
	Key string `json:"key" protobuf:"bytes,1,opt,name=key"`
}

TopologyConstraint defines a topology constraint for a PodGroup.

func (*TopologyConstraint) DeepCopy ¶

func (in *TopologyConstraint) DeepCopy() *TopologyConstraint

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

func (*TopologyConstraint) DeepCopyInto ¶

func (in *TopologyConstraint) DeepCopyInto(out *TopologyConstraint)

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

func (*TopologyConstraint) Marshal ¶

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

func (*TopologyConstraint) MarshalTo ¶

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

func (*TopologyConstraint) MarshalToSizedBuffer ¶

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

func (TopologyConstraint) OpenAPIModelName ¶

func (in TopologyConstraint) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*TopologyConstraint) Reset ¶

func (m *TopologyConstraint) Reset()

func (*TopologyConstraint) Size ¶

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

func (*TopologyConstraint) String ¶

func (this *TopologyConstraint) String() string

func (TopologyConstraint) SwaggerDoc ¶

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

func (*TopologyConstraint) Unmarshal ¶

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

type TypedLocalObjectReference ¶

type TypedLocalObjectReference struct {
	// APIGroup is the group for the resource being referenced.
	// If APIGroup is empty, the specified Kind must be in the core API group.
	// For any other third-party types, setting APIGroup is required.
	// It must be a DNS subdomain.
	//
	// +optional
	// +k8s:optional
	// +k8s:format=k8s-long-name
	APIGroup string `json:"apiGroup,omitempty" protobuf:"bytes,1,opt,name=apiGroup"`
	// Kind is the type of resource being referenced.
	// It must be a path segment name.
	//
	// +required
	// +k8s:required
	// +k8s:format=k8s-path-segment-name
	Kind string `json:"kind" protobuf:"bytes,2,opt,name=kind"`
	// Name is the name of resource being referenced.
	// It must be a path segment name.
	//
	// +required
	// +k8s:required
	// +k8s:format=k8s-path-segment-name
	Name string `json:"name" protobuf:"bytes,3,opt,name=name"`
}

TypedLocalObjectReference allows to reference typed object inside the same namespace.

func (*TypedLocalObjectReference) DeepCopy ¶

func (in *TypedLocalObjectReference) DeepCopy() *TypedLocalObjectReference

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

func (*TypedLocalObjectReference) DeepCopyInto ¶

func (in *TypedLocalObjectReference) DeepCopyInto(out *TypedLocalObjectReference)

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

func (*TypedLocalObjectReference) Marshal ¶

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

func (*TypedLocalObjectReference) MarshalTo ¶

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

func (*TypedLocalObjectReference) MarshalToSizedBuffer ¶

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

func (TypedLocalObjectReference) OpenAPIModelName ¶

func (in TypedLocalObjectReference) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*TypedLocalObjectReference) Reset ¶

func (m *TypedLocalObjectReference) Reset()

func (*TypedLocalObjectReference) Size ¶

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

func (*TypedLocalObjectReference) String ¶

func (this *TypedLocalObjectReference) String() string

func (TypedLocalObjectReference) SwaggerDoc ¶

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

func (*TypedLocalObjectReference) Unmarshal ¶

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

type Workload ¶

type Workload struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// 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 defines the desired behavior of a Workload.
	//
	// +required
	Spec WorkloadSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
}

Workload allows for expressing scheduling constraints that should be used when managing the lifecycle of workloads from the scheduling perspective, including scheduling, preemption, eviction and other phases. Workload API enablement is toggled by the GenericWorkload feature gate.

func (*Workload) DeepCopy ¶

func (in *Workload) DeepCopy() *Workload

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

func (*Workload) DeepCopyInto ¶

func (in *Workload) DeepCopyInto(out *Workload)

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

func (*Workload) DeepCopyObject ¶

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

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

func (*Workload) Marshal ¶

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

func (*Workload) MarshalTo ¶

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

func (*Workload) MarshalToSizedBuffer ¶

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

func (Workload) OpenAPIModelName ¶

func (in Workload) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*Workload) Reset ¶

func (m *Workload) Reset()

func (*Workload) Size ¶

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

func (*Workload) String ¶

func (this *Workload) String() string

func (Workload) SwaggerDoc ¶

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

func (*Workload) Unmarshal ¶

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

type WorkloadList ¶

type WorkloadList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	//
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Items is the list of Workloads.
	Items []Workload `json:"items" protobuf:"bytes,2,rep,name=items"`
}

WorkloadList contains a list of Workload resources.

func (*WorkloadList) DeepCopy ¶

func (in *WorkloadList) DeepCopy() *WorkloadList

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

func (*WorkloadList) DeepCopyInto ¶

func (in *WorkloadList) DeepCopyInto(out *WorkloadList)

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

func (*WorkloadList) DeepCopyObject ¶

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

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

func (*WorkloadList) Marshal ¶

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

func (*WorkloadList) MarshalTo ¶

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

func (*WorkloadList) MarshalToSizedBuffer ¶

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

func (WorkloadList) OpenAPIModelName ¶

func (in WorkloadList) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*WorkloadList) Reset ¶

func (m *WorkloadList) Reset()

func (*WorkloadList) Size ¶

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

func (*WorkloadList) String ¶

func (this *WorkloadList) String() string

func (WorkloadList) SwaggerDoc ¶

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

func (*WorkloadList) Unmarshal ¶

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

type WorkloadPodGroupTemplateReference ¶

type WorkloadPodGroupTemplateReference struct {
	// WorkloadName defines the name of the Workload object.
	//
	// +required
	// +k8s:required
	// +k8s:format=k8s-long-name
	WorkloadName string `json:"workloadName" protobuf:"bytes,1,opt,name=workloadName"`

	// PodGroupTemplateName defines the PodGroupTemplate name within the Workload object.
	//
	// +required
	// +k8s:required
	// +k8s:format=k8s-short-name
	PodGroupTemplateName string `json:"podGroupTemplateName" protobuf:"bytes,2,opt,name=podGroupTemplateName"`
}

WorkloadPodGroupTemplateReference references the PodGroupTemplate within the Workload object.

func (*WorkloadPodGroupTemplateReference) DeepCopy ¶

func (in *WorkloadPodGroupTemplateReference) DeepCopy() *WorkloadPodGroupTemplateReference

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

func (*WorkloadPodGroupTemplateReference) DeepCopyInto ¶

func (in *WorkloadPodGroupTemplateReference) DeepCopyInto(out *WorkloadPodGroupTemplateReference)

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

func (*WorkloadPodGroupTemplateReference) Marshal ¶

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

func (*WorkloadPodGroupTemplateReference) MarshalTo ¶

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

func (*WorkloadPodGroupTemplateReference) MarshalToSizedBuffer ¶

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

func (WorkloadPodGroupTemplateReference) OpenAPIModelName ¶

func (in WorkloadPodGroupTemplateReference) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*WorkloadPodGroupTemplateReference) Reset ¶

func (m *WorkloadPodGroupTemplateReference) Reset()

func (*WorkloadPodGroupTemplateReference) Size ¶

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

func (*WorkloadPodGroupTemplateReference) String ¶

func (this *WorkloadPodGroupTemplateReference) String() string

func (WorkloadPodGroupTemplateReference) SwaggerDoc ¶

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

func (*WorkloadPodGroupTemplateReference) Unmarshal ¶

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

type WorkloadSpec ¶

type WorkloadSpec struct {
	// ControllerRef is an optional reference to the controlling object, such as a
	// Deployment or Job. This field is intended for use by tools like CLIs
	// to provide a link back to the original workload definition.
	// This field is immutable.
	//
	// +optional
	// +k8s:optional
	// +k8s:alpha(since:"1.36")=+k8s:immutable
	ControllerRef *TypedLocalObjectReference `json:"controllerRef,omitempty" protobuf:"bytes,1,opt,name=controllerRef"`

	// PodGroupTemplates is the list of templates that make up the Workload.
	// The maximum number of templates is 8. This field is immutable.
	//
	// +required
	// +listType=map
	// +listMapKey=name
	// +k8s:required
	// +k8s:listType=map
	// +k8s:listMapKey=name
	// +k8s:maxItems=8
	// +k8s:alpha(since:"1.36")=+k8s:immutable
	PodGroupTemplates []PodGroupTemplate `json:"podGroupTemplates" protobuf:"bytes,2,rep,name=podGroupTemplates"`
}

WorkloadSpec defines the desired state of a Workload.

func (*WorkloadSpec) DeepCopy ¶

func (in *WorkloadSpec) DeepCopy() *WorkloadSpec

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

func (*WorkloadSpec) DeepCopyInto ¶

func (in *WorkloadSpec) DeepCopyInto(out *WorkloadSpec)

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

func (*WorkloadSpec) Marshal ¶

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

func (*WorkloadSpec) MarshalTo ¶

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

func (*WorkloadSpec) MarshalToSizedBuffer ¶

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

func (WorkloadSpec) OpenAPIModelName ¶

func (in WorkloadSpec) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

func (*WorkloadSpec) Reset ¶

func (m *WorkloadSpec) Reset()

func (*WorkloadSpec) Size ¶

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

func (*WorkloadSpec) String ¶

func (this *WorkloadSpec) String() string

func (WorkloadSpec) SwaggerDoc ¶

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

func (*WorkloadSpec) Unmarshal ¶

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

Source Files ¶

doc.go generated.pb.go register.go types.go types_swagger_doc_generated.go zz_generated.deepcopy.go zz_generated.model_name.go

Version: v0.36.0-beta.0
Published: Mar 20, 2026
Platform: js/wasm
Imports: 8 packages
Last checked: 7 minutes ago –

Tools for package owners.

?	: This menu
/	: Search site
f	: Jump to identifier
g then g	: Go to top of page
g then b	: Go to end of page
G	: Go to end of page
g then i	: Go to index
g then e	: Go to examples