v1alpha2

package
v0.0.0-...-ac39e06 Latest Latest
Warning

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

 Go to latest Published: Apr 2, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// GroupName is the group name used in this package.
	GroupName = "scheduling.sigs.dev"

	// GroupVersion is the version of scheduling group
	GroupVersion = "v1alpha2"
)
View Source 
const (
	// PodFailedReason is probed if pod of PodGroup failed
	PodFailedReason string = "PodFailed"

	// PodDeletedReason is probed if pod of PodGroup deleted
	PodDeletedReason string = "PodDeleted"

	// NotEnoughResourcesReason is probed if there're not enough resources to schedule pods
	NotEnoughResourcesReason string = "NotEnoughResources"

	// NotEnoughPodsReason is probed if there're not enough tasks compared to `spec.minMember`
	NotEnoughPodsReason string = "NotEnoughTasks"
)
View Source 
const GroupNameAnnotationKey = "scheduling.k8s.io/group-name"

GroupNameAnnotationKey is the annotation key of Pod to identify which PodGroup it belongs to.

View Source 
const QueueNameAnnotationKey = GroupName + "/queue-name"

QueueNameAnnotationKey is the annotation key of Pod to identify which queue it belongs to.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: GroupVersion}

SchemeGroupVersion is the group version used to register these objects.

Functions

func Convert_scheduling_PodGroupCondition_To_v1alpha2_PodGroupCondition 

func Convert_scheduling_PodGroupCondition_To_v1alpha2_PodGroupCondition(in *scheduling.PodGroupCondition, out *PodGroupCondition, s conversion.Scope) error

Convert_scheduling_PodGroupCondition_To_v1alpha2_PodGroupCondition is an autogenerated conversion function.

func Convert_scheduling_PodGroupList_To_v1alpha2_PodGroupList 

func Convert_scheduling_PodGroupList_To_v1alpha2_PodGroupList(in *scheduling.PodGroupList, out *PodGroupList, s conversion.Scope) error

Convert_scheduling_PodGroupList_To_v1alpha2_PodGroupList is an autogenerated conversion function.

func Convert_scheduling_PodGroupSpec_To_v1alpha2_PodGroupSpec 

func Convert_scheduling_PodGroupSpec_To_v1alpha2_PodGroupSpec(in *scheduling.PodGroupSpec, out *PodGroupSpec, s conversion.Scope) error

Convert_scheduling_PodGroupSpec_To_v1alpha2_PodGroupSpec is an autogenerated conversion function.

func Convert_scheduling_PodGroupStatus_To_v1alpha2_PodGroupStatus 

func Convert_scheduling_PodGroupStatus_To_v1alpha2_PodGroupStatus(in *scheduling.PodGroupStatus, out *PodGroupStatus, s conversion.Scope) error

Convert_scheduling_PodGroupStatus_To_v1alpha2_PodGroupStatus is an autogenerated conversion function.

func Convert_scheduling_PodGroup_To_v1alpha2_PodGroup 

func Convert_scheduling_PodGroup_To_v1alpha2_PodGroup(in *scheduling.PodGroup, out *PodGroup, s conversion.Scope) error

Convert_scheduling_PodGroup_To_v1alpha2_PodGroup is an autogenerated conversion function.

func Convert_scheduling_QueueList_To_v1alpha2_QueueList 

func Convert_scheduling_QueueList_To_v1alpha2_QueueList(in *scheduling.QueueList, out *QueueList, s conversion.Scope) error

Convert_scheduling_QueueList_To_v1alpha2_QueueList is an autogenerated conversion function.

func Convert_scheduling_QueueSpec_To_v1alpha2_QueueSpec 

func Convert_scheduling_QueueSpec_To_v1alpha2_QueueSpec(in *scheduling.QueueSpec, out *QueueSpec, s conversion.Scope) error

Convert_scheduling_QueueSpec_To_v1alpha2_QueueSpec is an autogenerated conversion function.

func Convert_scheduling_QueueStatus_To_v1alpha2_QueueStatus 

func Convert_scheduling_QueueStatus_To_v1alpha2_QueueStatus(in *scheduling.QueueStatus, out *QueueStatus, s conversion.Scope) error

Convert_scheduling_QueueStatus_To_v1alpha2_QueueStatus is an autogenerated conversion function.

func Convert_scheduling_Queue_To_v1alpha2_Queue 

func Convert_scheduling_Queue_To_v1alpha2_Queue(in *scheduling.Queue, out *Queue, s conversion.Scope) error

Convert_scheduling_Queue_To_v1alpha2_Queue is an autogenerated conversion function.

func Convert_v1alpha2_PodGroupCondition_To_scheduling_PodGroupCondition 

func Convert_v1alpha2_PodGroupCondition_To_scheduling_PodGroupCondition(in *PodGroupCondition, out *scheduling.PodGroupCondition, s conversion.Scope) error

Convert_v1alpha2_PodGroupCondition_To_scheduling_PodGroupCondition is an autogenerated conversion function.

func Convert_v1alpha2_PodGroupList_To_scheduling_PodGroupList 

func Convert_v1alpha2_PodGroupList_To_scheduling_PodGroupList(in *PodGroupList, out *scheduling.PodGroupList, s conversion.Scope) error

Convert_v1alpha2_PodGroupList_To_scheduling_PodGroupList is an autogenerated conversion function.

func Convert_v1alpha2_PodGroupSpec_To_scheduling_PodGroupSpec 

func Convert_v1alpha2_PodGroupSpec_To_scheduling_PodGroupSpec(in *PodGroupSpec, out *scheduling.PodGroupSpec, s conversion.Scope) error

Convert_v1alpha2_PodGroupSpec_To_scheduling_PodGroupSpec is an autogenerated conversion function.

func Convert_v1alpha2_PodGroupStatus_To_scheduling_PodGroupStatus 

func Convert_v1alpha2_PodGroupStatus_To_scheduling_PodGroupStatus(in *PodGroupStatus, out *scheduling.PodGroupStatus, s conversion.Scope) error

Convert_v1alpha2_PodGroupStatus_To_scheduling_PodGroupStatus is an autogenerated conversion function.

func Convert_v1alpha2_PodGroup_To_scheduling_PodGroup 

func Convert_v1alpha2_PodGroup_To_scheduling_PodGroup(in *PodGroup, out *scheduling.PodGroup, s conversion.Scope) error

Convert_v1alpha2_PodGroup_To_scheduling_PodGroup is an autogenerated conversion function.

func Convert_v1alpha2_QueueList_To_scheduling_QueueList 

func Convert_v1alpha2_QueueList_To_scheduling_QueueList(in *QueueList, out *scheduling.QueueList, s conversion.Scope) error

Convert_v1alpha2_QueueList_To_scheduling_QueueList is an autogenerated conversion function.

func Convert_v1alpha2_QueueSpec_To_scheduling_QueueSpec 

func Convert_v1alpha2_QueueSpec_To_scheduling_QueueSpec(in *QueueSpec, out *scheduling.QueueSpec, s conversion.Scope) error

Convert_v1alpha2_QueueSpec_To_scheduling_QueueSpec is an autogenerated conversion function.

func Convert_v1alpha2_QueueStatus_To_scheduling_QueueStatus 

func Convert_v1alpha2_QueueStatus_To_scheduling_QueueStatus(in *QueueStatus, out *scheduling.QueueStatus, s conversion.Scope) error

Convert_v1alpha2_QueueStatus_To_scheduling_QueueStatus is an autogenerated conversion function.

func Convert_v1alpha2_Queue_To_scheduling_Queue 

func Convert_v1alpha2_Queue_To_scheduling_Queue(in *Queue, out *scheduling.Queue, s conversion.Scope) error

Convert_v1alpha2_Queue_To_scheduling_Queue is an autogenerated conversion function.

func RegisterConversions 

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group-qualified GroupResource.

Types

type PodGroup 

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

	// Specification of the desired behavior of the pod group.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
	// +optional
	Spec PodGroupSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Status represents the current information about a pod group.
	// This data may not be up to date.
	// +optional
	Status PodGroupStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

PodGroup is a collection of Pod; used for batch workload.

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.

type PodGroupCondition 

type PodGroupCondition struct {
	// Type is the type of the condition
	Type PodGroupConditionType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type"`

	// Status is the status of the condition.
	Status v1.ConditionStatus `json:"status,omitempty" protobuf:"bytes,2,opt,name=status"`

	// The ID of condition transition.
	TransitionID string `json:"transitionID,omitempty" protobuf:"bytes,3,opt,name=transitionID"`

	// Last time the phase transitioned from another to current phase.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,4,opt,name=lastTransitionTime"`

	// Unique, one-word, CamelCase reason for the phase's last transition.
	// +optional
	Reason string `json:"reason,omitempty" protobuf:"bytes,5,opt,name=reason"`

	// Human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty" protobuf:"bytes,6,opt,name=message"`
}

PodGroupCondition contains details for the current state of this pod group.

func (*PodGroupCondition) DeepCopy 

func (in *PodGroupCondition) DeepCopy() *PodGroupCondition

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

func (*PodGroupCondition) DeepCopyInto 

func (in *PodGroupCondition) DeepCopyInto(out *PodGroupCondition)

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

type PodGroupConditionDetail 

type PodGroupConditionDetail string
const (
	// PodGroupReady is that PodGroup has reached scheduling restriction
	PodGroupReady PodGroupConditionDetail = "pod group is ready"
	// PodGroupNotReady is that PodGroup has not yet reached the scheduling restriction
	PodGroupNotReady PodGroupConditionDetail = "pod group is not ready"
)

type PodGroupConditionType 

type PodGroupConditionType string
const (
	// PodGroupUnschedulableType is Unschedulable event type
	PodGroupUnschedulableType PodGroupConditionType = "Unschedulable"

	// PodGroupScheduled is scheduled event type
	PodGroupScheduled PodGroupConditionType = "Scheduled"
)

type PodGroupList 

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

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

PodGroupList is a collection of pod groups.

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.

type PodGroupPhase 

type PodGroupPhase string

PodGroupPhase is the phase of a pod group at the current time. 

const (
	// PodPending means the pod group has been accepted by the system, but scheduler can not allocate
	// enough resources to it.
	PodGroupPending PodGroupPhase = "Pending"

	// PodRunning means `spec.minMember` pods of PodGroups has been in running phase.
	PodGroupRunning PodGroupPhase = "Running"

	// PodGroupUnknown means part of `spec.minMember` pods are running but the other part can not
	// be scheduled, e.g. not enough resource; scheduler will wait for related controller to recover it.
	PodGroupUnknown PodGroupPhase = "Unknown"

	// PodGroupInqueue means controllers can start to create pods,
	// is a new state between PodGroupPending and PodGroupRunning
	PodGroupInqueue PodGroupPhase = "Inqueue"
)

These are the valid phase of podGroups.

type PodGroupSpec 

type PodGroupSpec struct {
	// MinMember defines the minimal number of members/tasks to run the pod group;
	// if there's not enough resources to start all tasks, the scheduler
	// will not start anyone.
	MinMember int32 `json:"minMember,omitempty" protobuf:"bytes,1,opt,name=minMember"`

	// Queue defines the queue to allocate resource for PodGroup; if queue does not exist,
	// the PodGroup will not be scheduled. Defaults to `default` Queue with the lowest weight.
	// +optional
	Queue string `json:"queue,omitempty" protobuf:"bytes,2,opt,name=queue"`

	// If specified, indicates the PodGroup's priority. "system-node-critical" and
	// "system-cluster-critical" are two special keywords which indicate the
	// highest priorities with the former being the highest priority. Any other
	// name must be defined by creating a PriorityClass object with that name.
	// If not specified, the PodGroup priority will be default or zero if there is no
	// default.
	// +optional
	PriorityClassName string `json:"priorityClassName,omitempty" protobuf:"bytes,3,opt,name=priorityClassName"`

	// MinResources defines the minimal resource of members/tasks to run the pod group;
	// if there's not enough resources to start all tasks, the scheduler
	// will not start anyone.
	MinResources *v1.ResourceList `json:"minResources,omitempty" protobuf:"bytes,4,opt,name=minResources"`
}

PodGroupSpec represents the template of a pod group.

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.

type PodGroupStatus 

type PodGroupStatus struct {
	// Current phase of PodGroup.
	Phase PodGroupPhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase"`

	// The conditions of PodGroup.
	// +optional
	Conditions []PodGroupCondition `json:"conditions,omitempty" protobuf:"bytes,2,opt,name=conditions"`

	// The number of actively running pods.
	// +optional
	Running int32 `json:"running,omitempty" protobuf:"bytes,3,opt,name=running"`

	// The number of pods which reached phase Succeeded.
	// +optional
	Succeeded int32 `json:"succeeded,omitempty" protobuf:"bytes,4,opt,name=succeeded"`

	// The number of pods which reached phase Failed.
	// +optional
	Failed int32 `json:"failed,omitempty" protobuf:"bytes,5,opt,name=failed"`
}

PodGroupStatus represents the current state 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.

type Queue 

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

	// Specification of the desired behavior of the queue.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
	// +optional
	Spec QueueSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// The status of queue.
	// +optional
	Status QueueStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

Queue is a queue of PodGroup.

func (*Queue) DeepCopy 

func (in *Queue) DeepCopy() *Queue

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

func (*Queue) DeepCopyInto 

func (in *Queue) DeepCopyInto(out *Queue)

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

func (*Queue) DeepCopyObject 

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

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

type QueueAction 

type QueueAction string

QueueAction is the action that queue controller will take according to the event. 

const (
	// SyncQueueAction is the action to sync queue status.
	SyncQueueAction QueueAction = "SyncQueue"
	// OpenQueueAction is the action to open queue
	OpenQueueAction QueueAction = "OpenQueue"
	// CloseQueueAction is the action to close queue
	CloseQueueAction QueueAction = "CloseQueue"
)

type QueueEvent 

type QueueEvent string

QueueEvent represent the phase of queue 

const (
	// QueueOutOfSyncEvent is triggered if PodGroup/Queue were updated
	QueueOutOfSyncEvent QueueEvent = "OutOfSync"
	// QueueCommandIssuedEvent is triggered if a command is raised by user
	QueueCommandIssuedEvent QueueEvent = "CommandIssued"
)

type QueueList 

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

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

QueueList is a collection of queues.

func (*QueueList) DeepCopy 

func (in *QueueList) DeepCopy() *QueueList

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

func (*QueueList) DeepCopyInto 

func (in *QueueList) DeepCopyInto(out *QueueList)

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

func (*QueueList) DeepCopyObject 

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

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

type QueueRequest 

type QueueRequest struct {
	// Name is queue name
	Name string

	// Event is event of queue
	Event QueueEvent
	// Action is action to be performed
	Action QueueAction
}

QueueRequest struct

func (*QueueRequest) DeepCopy 

func (in *QueueRequest) DeepCopy() *QueueRequest

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

func (*QueueRequest) DeepCopyInto 

func (in *QueueRequest) DeepCopyInto(out *QueueRequest)

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

type QueueSpec 

type QueueSpec struct {
	Weight     int32           `json:"weight,omitempty" protobuf:"bytes,1,opt,name=weight"`
	Capability v1.ResourceList `json:"capability,omitempty" protobuf:"bytes,2,opt,name=capability"`
	// State controller the status of queue
	State QueueState `json:"state,omitempty" protobuf:"bytes,3,opt,name=state"`
	// Reclaimable indicate whether the queue can be reclaimed by other queue
	Reclaimable *bool `json:"reclaimable,omitempty" protobuf:"bytes,4,opt,name=reclaimable"`
}

QueueSpec represents the template of Queue.

func (*QueueSpec) DeepCopy 

func (in *QueueSpec) DeepCopy() *QueueSpec

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

func (*QueueSpec) DeepCopyInto 

func (in *QueueSpec) DeepCopyInto(out *QueueSpec)

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

type QueueState 

type QueueState string

QueueState is state type of queue 

const (
	// QueueStateOpen indicate `Open` state of queue
	QueueStateOpen QueueState = "Open"
	// QueueStateClosed indicate `Closed` state of queue
	QueueStateClosed QueueState = "Closed"
	// QueueStateClosing indicate `Closing` state of queue
	QueueStateClosing QueueState = "Closing"
	// QueueStateUnknown indicate `Unknown` state of queue
	QueueStateUnknown QueueState = "Unknown"
)

type QueueStatus 

type QueueStatus struct {
	// The number of 'Unknown' PodGroup in this queue.
	Unknown int32 `json:"unknown,omitempty" protobuf:"bytes,1,opt,name=unknown"`
	// The number of 'Pending' PodGroup in this queue.
	Pending int32 `json:"pending,omitempty" protobuf:"bytes,2,opt,name=pending"`
	// The number of 'Running' PodGroup in this queue.
	Running int32 `json:"running,omitempty" protobuf:"bytes,3,opt,name=running"`
	// The number of `Inqueue` PodGroup in this queue.
	Inqueue int32 `json:"inqueue,omitempty" protobuf:"bytes,4,opt,name=inqueue"`
	// State is state of queue
	State QueueState `json:"state,omitempty" protobuf:"bytes,5,opt,name=state"`
}

QueueStatus represents the status of Queue.

func (*QueueStatus) DeepCopy 

func (in *QueueStatus) DeepCopy() *QueueStatus

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

func (*QueueStatus) DeepCopyInto 

func (in *QueueStatus) DeepCopyInto(out *QueueStatus)

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

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.