Resources / WorkflowType

WorkflowType

Defaults for a workflow type: the task queue, timeouts and retry policy used when a start request leaves them out. The code of the workflow is in the workers, not here.

Overview

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

Minimal example

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

Spec

FieldTypeRequiredDefaultAllowedDescription
namespaceRefreference to WorkflowNamespaceyesThe namespace the type belongs to.
namestringyeslength 1 to 255The workflow type name workers register and starts use.
descriptionstringup to 1000 charactersWhat the workflow does, for people.
taskQueuestringup to 255 charactersTask queue used when a start names none.
executionTimeoutSecondsinteger0 to 157680000Longest a workflow may run in all, with its retries and continuations. 0 is one year.
runTimeoutSecondsinteger0 to 157680000Longest one run may take. 0 is no limit besides the execution timeout.
taskTimeoutSecondsinteger101 to 120How long a worker has to answer a workflow task.
retryPolicyobjectRetries of the whole workflow when it fails; unset means it is not retried.
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.
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
Type.spec.name
Queue.spec.taskQueue
Phase.status.phase

All resources