v1alpha1

Documentation

Index

• Constants
• Variables
• func JobSuspended(job metav1.Object) bool
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type Queue
  • func (in *Queue) DeepCopy() *Queue
  • func (in *Queue) DeepCopyInto(out *Queue)
  • func (in *Queue) DeepCopyObject() runtime.Object
• type QueueList
  • func (in *QueueList) DeepCopy() *QueueList
  • func (in *QueueList) DeepCopyInto(out *QueueList)
  • func (in *QueueList) DeepCopyObject() runtime.Object
• type QueuePolicy
• type QueueSpec
  • func (in *QueueSpec) DeepCopy() *QueueSpec
  • func (in *QueueSpec) DeepCopyInto(out *QueueSpec)
• type QueueStatus
  • func (in *QueueStatus) DeepCopy() *QueueStatus
  • func (in *QueueStatus) DeepCopyInto(out *QueueStatus)
• type QueueUnit
  • func (in *QueueUnit) DeepCopy() *QueueUnit
  • func (in *QueueUnit) DeepCopyInto(out *QueueUnit)
  • func (in *QueueUnit) DeepCopyObject() runtime.Object
• type QueueUnitList
  • func (in *QueueUnitList) DeepCopy() *QueueUnitList
  • func (in *QueueUnitList) DeepCopyInto(out *QueueUnitList)
  • func (in *QueueUnitList) DeepCopyObject() runtime.Object
• type QueueUnitPhase
• type QueueUnitSpec
  • func (in *QueueUnitSpec) DeepCopy() *QueueUnitSpec
  • func (in *QueueUnitSpec) DeepCopyInto(out *QueueUnitSpec)
• type QueueUnitStatus
  • func (in *QueueUnitStatus) DeepCopy() *QueueUnitStatus
  • func (in *QueueUnitStatus) DeepCopyInto(out *QueueUnitStatus)

Constants

const Placement = "scheduling.x-k8s.io/placement"

Placement is the scheduling result of the scheduler

const Suspend = "scheduling.x-k8s.io/suspend"

Suspend is a flag that instructs the job operator to suspend processing this job

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

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

SchemeGroupVersion is group version used to register these objects

Functions

func JobSuspended

func JobSuspended(job metav1.Object) bool

JobSuspended checks if a Job should be suspended by checking whether its annotation contains key Suspend and its value is set "true"

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Queue

type Queue struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,name=metadata"`

	Spec   QueueSpec   `json:"spec,omitempty" protobuf:"bytes,2,name=spec"`
	Status QueueStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

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 QueueList

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

QueueUnitList contains a list of QueueUnit

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 QueuePolicy

type QueuePolicy string

+k8s:openapi-gen=true QueuePolicy defines the queueing policy for the elements in the queue

const (
	QueuePolicyFIFO     QueuePolicy = "FIFO"
	QueuePolicyPriority QueuePolicy = "Priority"
)

type QueueSpec

type QueueSpec struct {
	QueuePolicy       QueuePolicy `json:"queuePolicy,omitempty" protobuf:"bytes,1,opt,name=queuePolicy`
	Priority          *int32      `json:"priority,omitempty" protobuf:"varint,2,opt,name=priority"`
	PriorityClassName string      `json:"priorityClassName,omitempty" protobuf:"bytes,3,opt,name=priorityClassName"`
}

QueueSpec defines the desired state 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 QueueStatus

type QueueStatus struct {
}

QueueStatus defines the observed state 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.

type QueueUnit

type QueueUnit struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,name=metadata"`

	Spec   QueueUnitSpec   `json:"spec,omitempty" protobuf:"bytes,2,name=spec"`
	Status QueueUnitStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

func (*QueueUnit) DeepCopy

func (in *QueueUnit) DeepCopy() *QueueUnit

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

func (*QueueUnit) DeepCopyInto

func (in *QueueUnit) DeepCopyInto(out *QueueUnit)

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

func (*QueueUnit) DeepCopyObject

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

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

type QueueUnitList

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

QueueUnitList contains a list of QueueUnit

func (*QueueUnitList) DeepCopy

func (in *QueueUnitList) DeepCopy() *QueueUnitList

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

func (*QueueUnitList) DeepCopyInto

func (in *QueueUnitList) DeepCopyInto(out *QueueUnitList)

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

func (*QueueUnitList) DeepCopyObject

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

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

type QueueUnitPhase

type QueueUnitPhase string

const (
	Enqueued     QueueUnitPhase = "Enqueued"
	Dequeued     QueueUnitPhase = "Dequeued"
	SchedReady   QueueUnitPhase = "Running"
	SchedSucceed QueueUnitPhase = "Succeed"
	SchedFailed  QueueUnitPhase = "Failed"
	Backoff      QueueUnitPhase = "TimeoutBackoff"
)

type QueueUnitSpec

type QueueUnitSpec struct {
	ConsumerRef       *corev1.ObjectReference `json:"consumerRef,omitempty" protobuf:"bytes,1,opt,name=consumerRef"`
	Priority          *int32                  `json:"priority,omitempty" protobuf:"varint,2,opt,name=priority"`
	Queue             string                  `json:"queue,omitempty" protobuf:"bytes,3,opt,name=queue"`
	Resource          corev1.ResourceList     `json:"resource,omitempty" protobuf:"bytes,4,name=resource"`
	PriorityClassName string                  `json:"priorityClassName,omitempty" protobuf:"bytes,5,opt,name=priorityClassName"`
}

QueueUnitSpec defines the desired state of QueueUnit

func (*QueueUnitSpec) DeepCopy

func (in *QueueUnitSpec) DeepCopy() *QueueUnitSpec

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

func (*QueueUnitSpec) DeepCopyInto

func (in *QueueUnitSpec) DeepCopyInto(out *QueueUnitSpec)

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

type QueueUnitStatus

type QueueUnitStatus struct {
	Phase          QueueUnitPhase `json:"phase" protobuf:"bytes,1,name=phase"`
	Message        string         `json:"message,omitempty" protobuf:"bytes,2,opt,name=message"`
	LastUpdateTime *metav1.Time   `json:"lastUpdateTime" protobuf:"bytes,3,name=lastUpdateTime"`
}

QueueUnitStatus defines the observed state of QueueUnit

func (*QueueUnitStatus) DeepCopy

func (in *QueueUnitStatus) DeepCopy() *QueueUnitStatus

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

func (*QueueUnitStatus) DeepCopyInto

func (in *QueueUnitStatus) DeepCopyInto(out *QueueUnitStatus)

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