workflows

Documentation

Index

• func Parse(yamlWorkflow string) (*workflow, error)
• func ValidatedWorkflowJobSpec(tomlString string) (job.Job, error)
• type Config
• type Delegate
  • func NewDelegate(logger logger.Logger, registry core.CapabilitiesRegistry, store store.Store, ...) *Delegate
  • func (d *Delegate) AfterJobCreated(jb job.Job)
  • func (d *Delegate) BeforeJobCreated(spec job.Job)
  • func (d *Delegate) BeforeJobDeleted(spec job.Job)
  • func (d *Delegate) JobType() job.Type
  • func (d *Delegate) OnDeleteJob(context.Context, job.Job) error
  • func (d *Delegate) ServicesForSpec(_ context.Context, spec job.Job) ([]job.ServiceCtx, error)
• type Engine
  • func NewEngine(cfg Config) (engine *Engine, err error)
  • func (e *Engine) Close() error
  • func (e *Engine) Start(ctx context.Context) error

Functions

func Parse

func Parse(yamlWorkflow string) (*workflow, error)

func ValidatedWorkflowJobSpec

func ValidatedWorkflowJobSpec(tomlString string) (job.Job, error)

Types

type Config

type Config struct {
	Spec                 string
	WorkflowID           string
	WorkflowOwner        string
	WorkflowName         string
	Lggr                 logger.Logger
	Registry             core.CapabilitiesRegistry
	MaxWorkerLimit       int
	QueueSize            int
	NewWorkerTimeout     time.Duration
	MaxExecutionDuration time.Duration
	GetLocalNode         func(ctx context.Context) (capabilities.Node, error)
	Store                store.Store
	// contains filtered or unexported fields
}

type Delegate

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

func NewDelegate

func NewDelegate(
	logger logger.Logger,
	registry core.CapabilitiesRegistry,
	store store.Store,
	getLocalNode func(ctx context.Context) (capabilities.Node, error),
) *Delegate

func (*Delegate) AfterJobCreated

func (d *Delegate) AfterJobCreated(jb job.Job)

func (*Delegate) BeforeJobCreated

func (d *Delegate) BeforeJobCreated(spec job.Job)

func (*Delegate) BeforeJobDeleted

func (d *Delegate) BeforeJobDeleted(spec job.Job)

func (*Delegate) JobType

func (d *Delegate) JobType() job.Type

func (*Delegate) OnDeleteJob

func (d *Delegate) OnDeleteJob(context.Context, job.Job) error

func (*Delegate) ServicesForSpec

func (d *Delegate) ServicesForSpec(_ context.Context, spec job.Job) ([]job.ServiceCtx, error)

ServicesForSpec satisfies the job.Delegate interface.

type Engine

type Engine struct {
	services.StateMachine
	// contains filtered or unexported fields
}

Engine handles the lifecycle of a single workflow and its executions.

func NewEngine

func NewEngine(cfg Config) (engine *Engine, err error)

func (*Engine) Close

func (e *Engine) Close() error

func (*Engine) Start

func (e *Engine) Start(ctx context.Context) error