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
| API | workflow.etorm.com/v1alpha1 |
| Resource | workflowactivities (cluster-scoped inside its cluster) |
| Short names | wfa |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: workflow.etorm.com/v1alpha1
kind: WorkflowActivity
metadata:
name: example
spec:
namespaceRef:
name: "<name>"
name: "<name>"
Spec
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
namespaceRef | reference to WorkflowNamespace | yes | The namespace the activity belongs to. | ||
workflowTypeRef | reference to WorkflowType | The workflow type that calls this activity, when only one does (informational). | |||
name | string | yes | length 1 to 255 | The activity type name workers register and workflows call. | |
description | string | up to 1000 characters | What the activity does, for people. | ||
taskQueue | string | up to 255 characters | Task queue used when a call names none. | ||
input | string | up to 65536 characters | An example input, as JSON text, shown to people; not used when a workflow calls the activity. | ||
startToCloseTimeoutSeconds | integer | 0 to 157680000 | Longest one attempt may take. 0 means unset. | ||
scheduleToCloseTimeoutSeconds | integer | 0 to 157680000 | Longest the whole call may take, with all its attempts. 0 means unset. | ||
scheduleToStartTimeoutSeconds | integer | 0 to 157680000 | Longest a call may wait for a worker. 0 means unset. | ||
heartbeatTimeoutSeconds | integer | 0 to 3600 | Longest a running attempt may stay silent; at least 2 when set. 0 means no heartbeat is required. | ||
retryPolicy | object | Retries of a failed attempt. | |||
retryPolicy.initialIntervalSeconds | integer | 1 | 1 to 86400 | Wait before the first retry. | |
retryPolicy.backoffCoefficient | number | 2 | 1 to 10 | Each wait is this many times the one before. | |
retryPolicy.maximumIntervalSeconds | integer | 0 to 86400 | Longest wait; 0 is 100 times the initial one. | ||
retryPolicy.maximumAttempts | integer | 0 to 1000 | Most attempts; 0 is no limit. | ||
retryPolicy.nonRetryableErrorTypes | list of string | up to 20 items | Error types that end retrying at once. |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
phase | string | Ready once the namespace exists. | |||
lastExecution | object | The most recent execution of this activity, reported by the engine. | |||
lastExecution.workflowId | string | The workflow that called it. | |||
lastExecution.attempt | integer | The attempt number it ended on. | |||
lastExecution.state | string | Completed, Failed or TimedOut. | |||
lastExecution.output | string | The result as JSON text, when it completed and is small. | |||
lastExecution.at | string | When it ended (RFC 3339). | |||
conditions | list of object | Detailed state, one entry per aspect. | |||
conditions[].type | string | Aspect. | |||
conditions[].status | string | True or False. | |||
conditions[].reason | string | Machine-readable reason. | |||
conditions[].message | string | Human-readable detail. |
Columns in listings
| Column | From |
|---|---|
| Namespace | .spec.namespaceRef.name |
| Activity | .spec.name |
| Workflow | .spec.workflowTypeRef.name |
| Queue | .spec.taskQueue |
| Phase | .status.phase |