api

Documentation

Index

• Variables
• type Arguments
• type ClusterID
• type JobQueue
  • func NewJobQueue(q *QueueInfo) *JobQueue
  • func (qj *JobQueue) DeleteMark(jobID string)
  • func (qj *JobQueue) GetJob() (*PFJob, bool)
  • func (qj *JobQueue) GetName() string
  • func (qj *JobQueue) Insert(job *PFJob)
• type JobQueues
  • func NewJobQueues() JobQueues
  • func (jq *JobQueues) Delete(id QueueID)
  • func (jq *JobQueues) Get(id QueueID) (*JobQueue, bool)
  • func (jq *JobQueues) Insert(id QueueID, jobQueue *JobQueue)
• type LessFn
• type PFJob
  • func NewJobInfo(job *models.Job) (*PFJob, error)
  • func (pfj *PFJob) UpdateAnnotations(annotations map[string]string)
  • func (pfj *PFJob) UpdateJobPriority(priorityClassName string)
  • func (pfj *PFJob) UpdateLabels(labels map[string]string)
• type PFJobInterface
• type PolicyFactory
• type PriorityQueue
  • func NewPriorityQueue(lessFn LessFn) *PriorityQueue
  • func (q *PriorityQueue) Empty() bool
  • func (q *PriorityQueue) Len() int
  • func (q *PriorityQueue) Pop() interface{}
  • func (q *PriorityQueue) Push(it interface{})
• type QueueID
• type QueueInfo
  • func NewQueueInfo(q models.Queue) *QueueInfo
  • func (q *QueueInfo) JobOrderFn(l, r interface{}) bool
• type Registry
  • func (r Registry) Register(name string, factory PolicyFactory) error
  • func (r Registry) Unregister(name string) error
• type SortPolicy
  • func NewRegistry(policyNames []string) []SortPolicy

Variables

var QueueSortPolicies = make(Registry)

QueueSortPolicies global queue sort policies

Types

type Arguments

type Arguments map[string]string

Arguments map

type ClusterID

type ClusterID string

type JobQueue

type JobQueue struct {
	sync.RWMutex
	StopCh chan struct{}
	Queue  *QueueInfo

	Jobs *PriorityQueue
	// contains filtered or unexported fields
}

func NewJobQueue

func NewJobQueue(q *QueueInfo) *JobQueue

func (*JobQueue) DeleteMark

func (qj *JobQueue) DeleteMark(jobID string)

func (*JobQueue) GetJob

func (qj *JobQueue) GetJob() (*PFJob, bool)

func (*JobQueue) GetName

func (qj *JobQueue) GetName() string

func (*JobQueue) Insert

func (qj *JobQueue) Insert(job *PFJob)

type JobQueues

type JobQueues struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

JobQueues the collect of JobQueue

func NewJobQueues

func NewJobQueues() JobQueues

func (*JobQueues) Delete

func (jq *JobQueues) Delete(id QueueID)

func (*JobQueues) Get

func (jq *JobQueues) Get(id QueueID) (*JobQueue, bool)

func (*JobQueues) Insert

func (jq *JobQueues) Insert(id QueueID, jobQueue *JobQueue)

type LessFn

type LessFn func(interface{}, interface{}) bool

LessFn is the func declaration used by sort or priority queue.

type PFJob

type PFJob struct {
	ID        string
	Name      string
	Namespace string
	UserName  string
	// JobType of job, such as TypeSingle, TypeDistributed, and TypeWorkflow
	JobType   schema.JobType
	Framework schema.Framework
	// TODO: use Framework and Tasks.Role instead of JobMode
	JobMode string
	Status  string
	// compute resource request resource for job
	// ClusterID and QueueID of job
	ClusterID    ClusterID
	QueueID      QueueID
	Resource     *resources.Resource
	Priority     int32
	MinAvailable int32
	// PriorityClassName defines job info on cluster
	PriorityClassName string
	// storage resource for job
	FSID string
	// Tasks for TypeDistributed job
	Tasks []models.Member
	// ExtRuntimeConf define extra runtime conf
	ExtRuntimeConf []byte
	// ExtensionTemplate records the extension template of job
	ExtensionTemplate string
	// Conf for job
	Conf schema.Conf

	// Labels for job to update
	Labels      map[string]string
	Annotations map[string]string

	// extend field
	Tags   []string
	LogUrl string

	WaitingTime *time.Duration
	CreateTime  time.Time
	StartTime   time.Time
	EndTIme     time.Time
}

PFJob will have all info of a Job

func NewJobInfo

func NewJobInfo(job *models.Job) (*PFJob, error)

func (*PFJob) UpdateAnnotations

func (pfj *PFJob) UpdateAnnotations(annotations map[string]string)

func (*PFJob) UpdateJobPriority

func (pfj *PFJob) UpdateJobPriority(priorityClassName string)

func (*PFJob) UpdateLabels

func (pfj *PFJob) UpdateLabels(labels map[string]string)

type PFJobInterface

type PFJobInterface interface {
	CreateJob() (string, error)
	StopJobByID(string) error
	UpdateJob([]byte) error
	GetID() string
}

type PolicyFactory

type PolicyFactory = func(configuration Arguments) (SortPolicy, error)

PolicyFactory is a function that builds a sort policy.

type PriorityQueue

type PriorityQueue struct {
	// contains filtered or unexported fields
}

PriorityQueue implements a scheduling queue.

func NewPriorityQueue

func NewPriorityQueue(lessFn LessFn) *PriorityQueue

NewPriorityQueue returns a PriorityQueue

func (*PriorityQueue) Empty

func (q *PriorityQueue) Empty() bool

Empty check if queue is empty

func (*PriorityQueue) Len

func (q *PriorityQueue) Len() int

Len returns Len of the priority queue

func (*PriorityQueue) Pop

func (q *PriorityQueue) Pop() interface{}

Pop pops element in the priority Queue

func (*PriorityQueue) Push

func (q *PriorityQueue) Push(it interface{})

Push pushes element in the priority Queue

type QueueID

type QueueID string

QueueID is UID type, serves as unique ID for each queue

type QueueInfo

type QueueInfo struct {
	UID       QueueID
	Name      string
	Namespace string
	// ClusterID for queue
	ClusterID ClusterID
	Type      string
	Status    string

	// Priority for queue
	Priority int32
	Weight   int32

	// SortPolicy for queue job
	SortPolicyNames []string
	SortPolicies    []SortPolicy

	// SchedulerName for queue job
	SchedulerName string

	//
	Permissions []string

	// Resource range of queue
	Max  *resources.Resource
	Min  *resources.Resource
	Used *resources.Resource
}

QueueInfo will have all details about queue

func NewQueueInfo

func NewQueueInfo(q models.Queue) *QueueInfo

func (*QueueInfo) JobOrderFn

func (q *QueueInfo) JobOrderFn(l, r interface{}) bool

type Registry

type Registry map[string]PolicyFactory

Registry is a collection of all available sort polices.

func (Registry) Register

func (r Registry) Register(name string, factory PolicyFactory) error

Register adds a new sort policy to the registry. If a sort policy with the same name exists, it returns an error.

func (Registry) Unregister

func (r Registry) Unregister(name string) error

Unregister removes an existing sort policy from the registry. If no sort policy with the provided name exists, it returns an error.

type SortPolicy

type SortPolicy interface {
	Name() string
	OrderFn(interface{}, interface{}) int
}

func NewRegistry

func NewRegistry(policyNames []string) []SortPolicy

NewRegistry registry sort policy for queue