workflow

Documentation

Index

• Constants
• Variables
• func ComputeWorkflowRevisionHash(rev string, app *oamcore.Application) (string, error)
• func IsFailedAfterRetry(app *oamcore.Application) bool
• type Workflow
  • func NewWorkflow(app *oamcore.Application, cli client.Client, mode common.WorkflowMode, ...) Workflow

Constants

const (

	// MessageTerminatedFailedAfterRetries is the message of failed after retries
	MessageTerminatedFailedAfterRetries = "The workflow terminates automatically because the failed times of steps have reached the limit"
	// MessageSuspendFailedAfterRetries is the message of failed after retries
	MessageSuspendFailedAfterRetries = "The workflow suspends automatically because the failed times of steps have reached the limit"
	// MessageInitializingWorkflow is the message of initializing workflow
	MessageInitializingWorkflow = "Initializing workflow"
)

Variables

var (
	// DisableRecorder optimize workflow by disable recorder
	DisableRecorder = false
	// StepStatusCache cache the step status
	StepStatusCache sync.Map
	// MaxWorkflowWaitBackoffTime is the max time to wait before reconcile wait workflow again
	MaxWorkflowWaitBackoffTime = 60
	// MaxWorkflowFailedBackoffTime is the max time to wait before reconcile failed workflow again
	MaxWorkflowFailedBackoffTime = 300
)

Functions

func ComputeWorkflowRevisionHash

func ComputeWorkflowRevisionHash(rev string, app *oamcore.Application) (string, error)

ComputeWorkflowRevisionHash compute workflow revision.

func IsFailedAfterRetry

func IsFailedAfterRetry(app *oamcore.Application) bool

IsFailedAfterRetry check if application is hang due to FailedAfterRetry

Types

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 monitorContext.Context, appRev *v1beta1.ApplicationRevision, taskRunners []types.TaskRunner) (state common.WorkflowState, err error)

	// Trace record workflow state in controllerRevision.
	Trace() error

	// GetBackoffWaitTime returns the wait time for next retry.
	GetBackoffWaitTime() time.Duration

	HandleSuspendWait(ctx monitorContext.Context) (bool, time.Duration, error)
}

Workflow is used to execute the workflow steps of Application.

func NewWorkflow

func NewWorkflow(app *oamcore.Application, cli client.Client, mode common.WorkflowMode, debug bool, rk resourcekeeper.ResourceKeeper) Workflow

NewWorkflow returns a Workflow implementation.