job

Documentation

Index

• Constants
• type Job
  • func NewJob(name string, unit unit.UnitFile) *Job
  • func (j *Job) Conflicts() []string
  • 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
  • func (j *Job) Scheduled() bool
• type JobState
  • func ParseJobState(s string) (JobState, error)
• type ScheduledUnit
• type Unit

Constants

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

Types

type Job

type Job struct {
	Name            string
	State           *JobState
	TargetState     JobState
	TargetMachineID string
	Unit            unit.UnitFile
	UnitState       *unit.UnitState
}

Job is a legacy construct encapsulating a scheduled unit in fleet

func NewJob

func NewJob(name string, unit unit.UnitFile) *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) 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. Furthermore, specifier substitution (using unitPrintf) is performed on all requirements.

func (*Job) Resources

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

func (*Job) Scheduled

func (j *Job) Scheduled() bool

type JobState

type JobState string

func ParseJobState

func ParseJobState(s string) (JobState, error)

type ScheduledUnit

type ScheduledUnit struct {
	Name            string
	State           *JobState
	TargetMachineID string
}

ScheduledUnit represents a Unit known by fleet and encapsulates its current scheduling state

type Unit

type Unit struct {
	Name        string
	Unit        unit.UnitFile
	TargetState JobState
}

Unit represents a Unit that has been submitted to fleet (list-unit-files)