executor

Documentation

Index

• type Config
• type Duration
  • func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Executor
  • func NewExecutor(config Config, kubeConfig *rest.Config) (*Executor, error)
  • func (js *Executor) GetKnownJobs() (jobs []werftv1.JobStatus, err error)
  • func (js *Executor) Logs(name string) io.Reader
  • func (js *Executor) RegisterResult(jobname string, res *werftv1.JobResult) error
  • func (js *Executor) Run()
  • func (js *Executor) Start(podspec corev1.PodSpec, metadata werftv1.JobMetadata, options ...StartOpt) (status *werftv1.JobStatus, err error)
  • func (js *Executor) Stop(name, reason string) error
• type StartOpt
  • func WithAnnotation(key, value string) StartOpt
  • func WithAnnotations(annotations map[string]string) StartOpt
  • func WithBackoff(limit int) StartOpt
  • func WithCanReplay(canReplay bool) StartOpt
  • func WithMutex(name string) StartOpt
  • func WithName(name string) StartOpt
  • func WithSidecars(names []string) StartOpt
  • func WithWaitUntil(t time.Time) StartOpt

Types

type Config

type Config struct {
	Namespace       string    `yaml:"namespace"`
	EventTraceLog   string    `yaml:"eventTraceLog,omitempty"`
	JobPrepTimeout  *Duration `yaml:"preperationTimeout"`
	JobTotalTimeout *Duration `yaml:"totalTimeout"`
	LabelPrefix     string    `json:"labelPrefix"`
}

Config configures the executor

type Duration

type Duration struct {
	time.Duration
}

Duration is a JSON un-/marshallable type

func (*Duration) UnmarshalYAML

func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML parses a duration from its JSON representation

type Executor

type Executor struct {
	// OnUpdate is called when the status of a job changes.
	// Beware: this function can be called several times with the same status.
	OnUpdate func(pod *corev1.Pod, status *werftv1.JobStatus)

	Client     kubernetes.Interface
	Config     Config
	KubeConfig *rest.Config
	// contains filtered or unexported fields
}

Executor starts and watches jobs running in Kubernetes

func NewExecutor

func NewExecutor(config Config, kubeConfig *rest.Config) (*Executor, error)

NewExecutor creates a new job center instance

func (*Executor) GetKnownJobs

func (js *Executor) GetKnownJobs() (jobs []werftv1.JobStatus, err error)

GetKnownJobs returns a list of all jobs the executor knows about

func (*Executor) Logs

func (js *Executor) Logs(name string) io.Reader

Logs provides the log output of a running job. If the job is unknown, nil is returned.

func (*Executor) RegisterResult

func (js *Executor) RegisterResult(jobname string, res *werftv1.JobResult) error

RegisterResult registers a result produced by a job

func (*Executor) Run

func (js *Executor) Run()

Run starts the executor and returns immediately

func (*Executor) Start

func (js *Executor) Start(podspec corev1.PodSpec, metadata werftv1.JobMetadata, options ...StartOpt) (status *werftv1.JobStatus, err error)

Start starts a new job

func (*Executor) Stop

func (js *Executor) Stop(name, reason string) error

Stop stops a job

type StartOpt

type StartOpt func(*startOptions)

StartOpt configures a job at startup

func WithAnnotation

func WithAnnotation(key, value string) StartOpt

WithAnnotation sets a single annotation on a job

func WithAnnotations

func WithAnnotations(annotations map[string]string) StartOpt

WithAnnotations sets all annotations of a job

func WithBackoff

func WithBackoff(limit int) StartOpt

WithBackoff configures the backoff behaviour of a job

func WithCanReplay

func WithCanReplay(canReplay bool) StartOpt

WithCanReplay configures the if the job can be replayed

func WithMutex

func WithMutex(name string) StartOpt

WithMutex starts a job with a mutex (i.e. cancels all other jobs with that mutex)

func WithName

func WithName(name string) StartOpt

WithName sets the name of the job

func WithSidecars

func WithSidecars(names []string) StartOpt

WithSidecars makes some containers dependent on the lifecycle of others

func WithWaitUntil

func WithWaitUntil(t time.Time) StartOpt

WithWaitUntil starts the execution of a job at some later point