job

Documentation

Index

• Constants
• type Job
  • func NewJob(name string, unit unit.Unit) *Job
  • func (j *Job) Conflicts() []string
  • func (j *Job) IsBatch() bool
  • func (j *Job) Peers() []string
  • func (j *Job) RequiredTarget() (string, bool)
  • func (j *Job) RequiredTargetMetadata() map[string][]string
  • func (j *Job) Requirements() map[string][]string
  • func (j *Job) Resources() resource.ResourceTuple
• type JobBid
  • func NewBid(jobName string, machID string) *JobBid
• type JobOffer
  • func NewOfferFromJob(j Job, machineIDs []string) *JobOffer
  • func (jo *JobOffer) OfferedTo(machineID string) bool
• type JobState
  • func ParseJobState(s string) *JobState

Constants

const (
	JobStateInactive = JobState("inactive")
	JobStateLoaded   = JobState("loaded")
	JobStateLaunched = JobState("launched")
)

Types

type Job

type Job struct {
	Name      string
	State     *JobState
	Unit      unit.Unit
	UnitHash  unit.Hash
	UnitState *unit.UnitState
}

func NewJob

func NewJob(name string, unit unit.Unit) *Job

NewJob creates a new Job based on the given name and Unit. The returned Job has a populated UnitHash and empty JobState and UnitState. nil is returned on failure.

func (*Job) Conflicts

func (j *Job) Conflicts() []string

Conflicts returns a list of Job names that cannot be scheduled to the same machine as this Job.

func (*Job) IsBatch

func (j *Job) IsBatch() bool

IsBatch identifies whether the Job is intended to execute once, and, on completion, not be migrated around the cluster. This is determined by whether the unit file associated with the Job is a Service of type "oneshot".

func (*Job) Peers

func (j *Job) Peers() []string

Peers returns a list of Job names that must be scheduled to the same machine as this Job.

func (*Job) RequiredTarget

func (j *Job) RequiredTarget() (string, bool)

RequiredTarget determines whether or not this Job must be scheduled to a specific machine. If such a requirement exists, the first value returned represents the ID of such a machine, while the second value will be a bool true. If no requirement exists, an empty string along with a bool false will be returned.

func (*Job) RequiredTargetMetadata

func (j *Job) RequiredTargetMetadata() map[string][]string

RequiredTargetMetadata return all machine-related metadata from a Job's requirements

func (*Job) Requirements

func (j *Job) Requirements() map[string][]string

Requirements returns all relevant options from the [X-Fleet] section of a unit file. Relevant options are identified with a `X-` prefix in the unit. This prefix is stripped from relevant options before being returned.

func (*Job) Resources

func (j *Job) Resources() resource.ResourceTuple

type JobBid

type JobBid struct {
	JobName   string
	MachineID string
}

func NewBid

func NewBid(jobName string, machID string) *JobBid

type JobOffer

type JobOffer struct {
	Job Job

	// MachineIDs represents a set of machines for which this offer is valid.
	// If nil or len == 0 then all machines. Must be sorted.
	MachineIDs []string
}

func NewOfferFromJob

func NewOfferFromJob(j Job, machineIDs []string) *JobOffer

func (*JobOffer) OfferedTo

func (jo *JobOffer) OfferedTo(machineID string) bool

OfferedTo returns true if job is being offered to specified machine.

type JobState

type JobState string

func ParseJobState

func ParseJobState(s string) *JobState