workflow

Documentation

Index

• Constants
• type SucceededMessage
• type Workflow
  • func NewWorkflow(app *oamcore.Application, applicator apply.Applicator) Workflow

Constants

const (
	// CondTypeWorkflowFinish is the type of the Condition indicating workflow progress
	CondTypeWorkflowFinish = "workflow-progress"

	// CondReasonSucceeded is the reason of the workflow progress condition which is succeeded
	CondReasonSucceeded = "Succeeded"
	// CondReasonStopped is the reason of the workflow progress condition which is stopped
	CondReasonStopped = "Stopped"
	// CondReasonFailed is the reason of the workflow progress condition which is failed
	CondReasonFailed = "Failed"

	// CondStatusTrue is the status of the workflow progress condition which is True
	CondStatusTrue = "True"
)

Types

type SucceededMessage

type SucceededMessage struct {
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

SucceededMessage is the data json-marshalled into the message of `workflow-progress` condition when its reason is `succeeded`.

type Workflow

type Workflow interface {
	// ExecuteSteps executes the steps of an Application with given steps of rendered resources.
	// It returns done=true only if all steps are executed and succeeded.
	ExecuteSteps(ctx context.Context, appRevName string, steps []*unstructured.Unstructured) (done bool, err error)
}

Workflow is used to execute the workflow steps of Application.

func NewWorkflow

func NewWorkflow(app *oamcore.Application, applicator apply.Applicator) Workflow

NewWorkflow returns a Workflow implementation.