Resources / WorkflowActivity

WorkflowActivity

Defaults for an activity type that workflows call: its task queue, timeouts and retry policy, used when a workflow's call leaves them out, and the last execution the engine reports. The code of the activity is in the workers; one execution of it is recorded in the history of the workflow that called it.

Overview

APIworkflow.etorm.com/v1alpha1
Resourceworkflowactivities (cluster-scoped inside its cluster)
Short nameswfa
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: workflow.etorm.com/v1alpha1
kind: WorkflowActivity
metadata:
  name: example
spec:
  namespaceRef:
    name: "<name>"
  name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
namespaceRefreference to WorkflowNamespaceyesThe namespace the activity belongs to.
workflowTypeRefreference to WorkflowTypeThe workflow type that calls this activity, when only one does (informational).
namestringyeslength 1 to 255The activity type name workers register and workflows call.
descriptionstringup to 1000 charactersWhat the activity does, for people.
taskQueuestringup to 255 charactersTask queue used when a call names none.
inputstringup to 65536 charactersAn example input, as JSON text, shown to people; not used when a workflow calls the activity.
startToCloseTimeoutSecondsinteger0 to 157680000Longest one attempt may take. 0 means unset.
scheduleToCloseTimeoutSecondsinteger0 to 157680000Longest the whole call may take, with all its attempts. 0 means unset.
scheduleToStartTimeoutSecondsinteger0 to 157680000Longest a call may wait for a worker. 0 means unset.
heartbeatTimeoutSecondsinteger0 to 3600Longest a running attempt may stay silent; at least 2 when set. 0 means no heartbeat is required.
retryPolicyobjectRetries of a failed attempt.
retryPolicy.initialIntervalSecondsinteger11 to 86400Wait before the first retry.
retryPolicy.backoffCoefficientnumber21 to 10Each wait is this many times the one before.
retryPolicy.maximumIntervalSecondsinteger0 to 86400Longest wait; 0 is 100 times the initial one.
retryPolicy.maximumAttemptsinteger0 to 1000Most attempts; 0 is no limit.
retryPolicy.nonRetryableErrorTypeslist of stringup to 20 itemsError types that end retrying at once.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringReady once the namespace exists.
lastExecutionobjectThe most recent execution of this activity, reported by the engine.
lastExecution.workflowIdstringThe workflow that called it.
lastExecution.attemptintegerThe attempt number it ended on.
lastExecution.statestringCompleted, Failed or TimedOut.
lastExecution.outputstringThe result as JSON text, when it completed and is small.
lastExecution.atstringWhen it ended (RFC 3339).
conditionslist of objectDetailed state, one entry per aspect.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Namespace.spec.namespaceRef.name
Activity.spec.name
Workflow.spec.workflowTypeRef.name
Queue.spec.taskQueue
Phase.status.phase

All resources