job

Documentation

Index

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

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.Unit
	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) IsOneshot

func (j *Job) IsOneshot() bool

IsOneshot 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. 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 JobOffer

type JobOffer struct {
	Job Job

	// This field is ignored, but kept around because it is part of the
	// legacy datastructure stored in the Registry.
	MachineIDs []string
}

func NewOfferFromJob

func NewOfferFromJob(j Job) *JobOffer

type JobState

type JobState string

func ParseJobState

func ParseJobState(s string) (JobState, error)