workflow

Documentation

Index

• func ActionListCRDToProto(wf *v1alpha1.Workflow) *proto.WorkflowActionList
• func ToWorkflowContext(wf *v1alpha1.Workflow) *proto.WorkflowContext
• func YAMLToStatus(wf *Workflow) *v1alpha1.WorkflowStatus
• type Action
• type Reconciler
  • func NewReconciler(client ctrlclient.Client) *Reconciler
  • func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
  • func (r *Reconciler) SetupWithManager(mgr manager.Manager) error
• type Task
• type Workflow

Functions

func ActionListCRDToProto

func ActionListCRDToProto(wf *v1alpha1.Workflow) *proto.WorkflowActionList

func ToWorkflowContext

func ToWorkflowContext(wf *v1alpha1.Workflow) *proto.WorkflowContext

func YAMLToStatus

func YAMLToStatus(wf *Workflow) *v1alpha1.WorkflowStatus

Types

type Action

type Action struct {
	Name        string            `yaml:"name"`
	Image       string            `yaml:"image"`
	Timeout     int64             `yaml:"timeout"`
	Command     []string          `yaml:"command,omitempty"`
	OnTimeout   []string          `yaml:"on-timeout,omitempty"`
	OnFailure   []string          `yaml:"on-failure,omitempty"`
	Volumes     []string          `yaml:"volumes,omitempty"`
	Environment map[string]string `yaml:"environment,omitempty"`
	Pid         string            `yaml:"pid,omitempty"`
}

Action is the basic executional unit for a workflow.

type Reconciler

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

Reconciler is a type for managing Workflows.

func NewReconciler

func NewReconciler(client ctrlclient.Client) *Reconciler

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)

func (*Reconciler) SetupWithManager

func (r *Reconciler) SetupWithManager(mgr manager.Manager) error

type Task

type Task struct {
	Name        string            `yaml:"name"`
	WorkerAddr  string            `yaml:"worker"`
	Actions     []Action          `yaml:"actions"`
	Volumes     []string          `yaml:"volumes,omitempty"`
	Environment map[string]string `yaml:"environment,omitempty"`
}

Task represents a task to be executed as part of a workflow.

type Workflow

type Workflow struct {
	Version       string `yaml:"version"`
	Name          string `yaml:"name"`
	ID            string `yaml:"id"`
	GlobalTimeout int    `yaml:"global_timeout"`
	Tasks         []Task `yaml:"tasks"`
}

Workflow represents a workflow to be executed.