scheduler

Documentation

Index

• Variables
• type Job
• type JobManager
  • func NewDAGJobManager(dir string, client client.Client, executable, workDir string) JobManager
• type ScheduleType
  • func (s ScheduleType) String() string
• type ScheduledJob
  • func NewScheduledJob(next time.Time, job Job, typ ScheduleType) *ScheduledJob
• type Scheduler
  • func New(cfg *config.Config, manager JobManager) *Scheduler
  • func (s *Scheduler) Start(ctx context.Context) error
  • func (s *Scheduler) Stop(ctx context.Context)

Variables

var (
	ErrJobRunning      = errors.New("job already running")
	ErrJobIsNotRunning = errors.New("job is not running")
	ErrJobFinished     = errors.New("job already finished")
	ErrJobSkipped      = errors.New("job skipped")
	ErrJobSuccess      = errors.New("job already successful")
)

Error variables for job states.

Types

type Job

type Job interface {
	// Start starts the DAG.
	Start(ctx context.Context) error
	// Stop stops the DAG.
	Stop(ctx context.Context) error
	// Restart restarts the DAG.
	Restart(ctx context.Context) error
}

Job is the interface for the actual DAG.

type JobManager

type JobManager interface {
	// Start initializes and starts the process of managing scheduled Jobs.
	Start(ctx context.Context, done chan any) error
	// Next returns the next scheduled jobs.
	Next(ctx context.Context, now time.Time) ([]*ScheduledJob, error)
}

JobManager is responsible for managing scheduled Jobs.

func NewDAGJobManager

func NewDAGJobManager(dir string, client client.Client, executable, workDir string) JobManager

NewDAGJobManager creates a new DAG manager with the given configuration.

type ScheduleType

type ScheduleType int

ScheduleType is the type of schedule (start, stop, restart).

const (
	ScheduleTypeStart ScheduleType = iota
	ScheduleTypeStop
	ScheduleTypeRestart
)

func (ScheduleType) String

func (s ScheduleType) String() string

type ScheduledJob

type ScheduledJob struct {
	Next time.Time // Next is the time when the job should be run.
	Job  Job
	Type ScheduleType // start, stop, restart
}

ScheduledJob stores the next time a job should be run and the job itself.

func NewScheduledJob

func NewScheduledJob(next time.Time, job Job, typ ScheduleType) *ScheduledJob

NewScheduledJob creates a new ScheduledJob.

type Scheduler

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

func New

func New(cfg *config.Config, manager JobManager) *Scheduler

func (*Scheduler) Start

func (s *Scheduler) Start(ctx context.Context) error

func (*Scheduler) Stop

func (s *Scheduler) Stop(ctx context.Context)