pipelines

Documentation

Index

• type Job
  • func (j *Job) String() string
• type Scheduler
  • func NewScheduler(name string) (*Scheduler, error)
  • func (s *Scheduler) Close()
  • func (s *Scheduler) Run(job *Job)

Types

type Job

type Job struct {
	Image        string   `json:"image,omitempty"`
	Tag          string   `json:"tag,omitempty"`
	Args         []string `json:"args,omitempty"`
	Dependencies []Job    `json:"dependencies,omitempty"`
}

Job stores the information about a Docker image that contain the job to run, the arguments to pass to it and the dependencies it relies on.

func (*Job) String

func (j *Job) String() string

type Scheduler

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

Scheduler is the structure responsible of running the jobs in order, accordingly to their dependency graph, and stores information about their status.

func NewScheduler

func NewScheduler(name string) (*Scheduler, error)

NewScheduler returns a properly configured Scheduler.

func (*Scheduler) Close

func (s *Scheduler) Close()

Close should be called at the end of every program using a Scheduler.

func (*Scheduler) Run

func (s *Scheduler) Run(job *Job)

Run starts the scheduling of jobs.