Workflows
Workflow API Reference
Detailed reference for the Workflow CRD schema
This page provides a detailed reference for the
WorkflowTemplate, WorkflowRun, and WorkflowRunTemplate Custom Resource Definition (CRD) schemas.
WorkflowTemplate
AWorkflowTemplate is a reusable blueprint for a workflow.
WorkflowTemplateSpec
| Field | Type | Description |
|---|---|---|
version | string | The version of the workflow template schema. |
name | string | A human-readable name for the workflow template. |
parameterGroups | []ParameterGroup | A list of parameter groups that can be overridden at runtime. |
jobs | map[string]Job | A map of job definitions that constitute the workflow. |
Parameter
| Field | Type | Description |
|---|---|---|
name | string | The name of the parameter. |
description | string | A human-readable description of the parameter. |
type | ParameterType | The data type of the parameter (e.g., string, secretstore, generator[fake]). |
required | boolean | Specifies whether the parameter is mandatory. |
default | string | The default value for the parameter if not provided. |
allowMultiple | boolean | Allows multiple values for the parameter, treating it as an array. |
resourceConstraints | ResourceConstraints | Constraints for resource selection (e.g., for secretstore type). |
validation | ParameterValidation | Validation rules, such as minItems and maxItems for arrays. |
WorkflowRun
AWorkflowRun is an instance of a WorkflowTemplate that executes the defined jobs.
WorkflowRunSpec
| Field | Type | Description |
|---|---|---|
templateRef | object | A reference to the WorkflowTemplate to execute. Must contain a name field. |
arguments | object | A map of key-value pairs for the template parameters. Keys must match parameter names. |
WorkflowRunStatus
| Field | Type | Description |
|---|---|---|
workflowRef | object | A reference to the underlying Workflow resource created by the run. |
conditions | []metav1.Condition | The latest observations of the WorkflowRun’s state. |
phase | string | The current phase of the run (Pending, Running, Succeeded, Failed). |
startTime | metav1.Time | The time when the workflow run started. |
completionTime | metav1.Time | The time when the workflow run completed. |
WorkflowRunTemplate
AWorkflowRunTemplate automates the creation of WorkflowRun resources.
WorkflowRunTemplateSpec
| Field | Type | Description |
|---|---|---|
runSpec | WorkflowRunSpec | The specification for the WorkflowRun to be created. |
runPolicy | RunPolicy | The policy that determines when to create a new WorkflowRun. |
revisionHistoryLimit | int | The number of WorkflowRun resources to retain for history. Defaults to 3. |
RunPolicy
| Field | Type | Description |
|---|---|---|
once | object | Creates a WorkflowRun only once. This is an empty object {}. |
scheduled | object | Creates WorkflowRun resources on a schedule. Contains a cron field with a cron expression. |
onChange | object | Creates a WorkflowRun whenever the WorkflowRunTemplate spec changes. This is an empty object {}. |
WorkflowRunTemplateStatus
| Field | Type | Description |
|---|---|---|
lastRunTime | metav1.Time | The timestamp of the last WorkflowRun execution. |
runStatuses | []NamedWorkflowRunStatus | A list of statuses for recent WorkflowRun resources. |
conditions | []metav1.Condition | The latest observations of the WorkflowRunTemplate’s state. |