Workflow

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

WorkflowSpec defines the desired state of Workflow

Args defines the argument schema for workflow execution validation.

Description provides a human-readable description of the workflow’s purpose.

OnFailure defines best-effort cleanup/rollback steps that run when the workflow fails on a step that does not allow failure. The steps execute sequentially and their own failures are tolerated.

WorkflowSubStep is a tool-call step used inside forEach bodies, parallel groups, and onFailure handlers. Unlike WorkflowStep it cannot itself contain forEach or parallel, which keeps the CRD schema structural (non-recursive).

AllowFailure defines if in case of an error execution continues.

Args provides arguments for the tool execution (supports templating).

Condition defines an optional condition that determines whether this sub-step should execute.

Args provides the arguments to pass to the condition tool. Values may be any JSON type.

Expect defines positive health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

ExpectNot defines negative health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

FromStep specifies the step ID to reference for condition evaluation.

Template is a boolean Go-template gate. When set, the step executes only if the template renders to “true” (e.g. “{{ eq .input.env \“production\” }}“). Mutually exclusive with Tool/FromStep; when present, Expect/ExpectNot are ignored.

Tool specifies the name of the tool to execute for condition evaluation. Optional when FromStep or Template is used.

Description provides human-readable documentation for this sub-step’s purpose.

ID is the unique identifier for this sub-step.

Output indicates whether this sub-step’s result is included in the workflow’s returned document. The result is always referenceable by later steps regardless of this flag. When unset, the deprecated Store flag is used as a fallback.

Store is a deprecated alias for Output, kept for backwards compatibility. Prefer Output.

Tool specifies the name of the tool to execute.

Output is an optional output template that shapes the workflow’s returned document. It is rendered once after all steps complete, against .input / .results / .vars, and replaces the default {execution_id, workflow, status, input, steps[], …} response. Each leaf is a Go-template/sprig expression; JSON structure is preserved so numbers stay numbers and arrays stay arrays (e.g. “{{ .results.pods.items }}” or “{{ len .results.events.items }}”). A leaf’s type comes from the value it evaluates to, not from how its rendered text looks: a single-action leaf keeps its real type (a number stays a number, “{{ len .x }}” is a number), and a computed string keeps its exact string form, so values whose form matters (leading zeros, versions, IDs like “08” or “1.20”) are preserved without any coercion or workaround. Every step result is referenceable here regardless of its output flag. When omitted, the default response is returned unchanged.

Steps defines the sequence of workflow steps defining the execution flow.

WorkflowStep defines a single step in the workflow execution. A step is exactly one of: a tool call (tool), a sequential loop (forEach), or a concurrent group (parallel).

AllowFailure defines if in case of an error the next step is executed or not.

Args provides arguments for the tool execution (supports templating). Values may be any JSON type (string, integer, boolean, number, object, array) because the schema uses x-kubernetes-preserve-unknown-fields. Templated strings such as “{{.input.namespace}}” are resolved server-side at execution time.

Condition defines an optional condition that determines whether this step should execute.

Args provides the arguments to pass to the condition tool. Values may be any JSON type.

Expect defines positive health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

ExpectNot defines negative health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

FromStep specifies the step ID to reference for condition evaluation.

Template is a boolean Go-template gate. When set, the step executes only if the template renders to “true” (e.g. “{{ eq .input.env \“production\” }}“). Mutually exclusive with Tool/FromStep; when present, Expect/ExpectNot are ignored.

Tool specifies the name of the tool to execute for condition evaluation. Optional when FromStep or Template is used.

Description provides human-readable documentation for this step’s purpose.

ForEach executes a body of sub-steps once per item of a list. Mutually exclusive with tool and parallel.

As is the loop variable name made available to the body as “{{ .vars. }}”. Defaults to “item”.

Items is a template expression that must resolve to an array, e.g. “{{ .input.clusters }}”. Each element is bound to the loop variable for the duration of one iteration.

Steps is the body executed for each item.

WorkflowSubStep is a tool-call step used inside forEach bodies, parallel groups, and onFailure handlers. Unlike WorkflowStep it cannot itself contain forEach or parallel, which keeps the CRD schema structural (non-recursive).

AllowFailure defines if in case of an error execution continues.

Args provides arguments for the tool execution (supports templating).

Condition defines an optional condition that determines whether this sub-step should execute.

Args provides the arguments to pass to the condition tool. Values may be any JSON type.

Expect defines positive health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

ExpectNot defines negative health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

FromStep specifies the step ID to reference for condition evaluation.

Template is a boolean Go-template gate. When set, the step executes only if the template renders to “true” (e.g. “{{ eq .input.env \“production\” }}“). Mutually exclusive with Tool/FromStep; when present, Expect/ExpectNot are ignored.

Tool specifies the name of the tool to execute for condition evaluation. Optional when FromStep or Template is used.

Description provides human-readable documentation for this sub-step’s purpose.

ID is the unique identifier for this sub-step.

Output indicates whether this sub-step’s result is included in the workflow’s returned document. The result is always referenceable by later steps regardless of this flag. When unset, the deprecated Store flag is used as a fallback.

Store is a deprecated alias for Output, kept for backwards compatibility. Prefer Output.

Tool specifies the name of the tool to execute.

ID is the unique identifier for this step within the workflow.

Output indicates whether this step’s result is included in the workflow’s returned document (what the caller receives). Every step result is always referenceable by later steps via {{ .results.. }} regardless of this flag; Output only controls visibility in the returned result. When unset, the deprecated Store flag is used as a fallback.

Parallel executes a group of sub-steps concurrently. Each sub-step resolves its arguments from the workflow state as it was before the group started; siblings cannot reference each other’s results. Mutually exclusive with tool and forEach.

WorkflowSubStep is a tool-call step used inside forEach bodies, parallel groups, and onFailure handlers. Unlike WorkflowStep it cannot itself contain forEach or parallel, which keeps the CRD schema structural (non-recursive).

AllowFailure defines if in case of an error execution continues.

Args provides arguments for the tool execution (supports templating).

Condition defines an optional condition that determines whether this sub-step should execute.

Args provides the arguments to pass to the condition tool. Values may be any JSON type.

Expect defines positive health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

ExpectNot defines negative health check expectations.

JsonPath defines JSON path conditions to check in the result. Values may be any JSON type (typically scalars compared to a result field).

Success indicates whether the tool call should succeed.

FromStep specifies the step ID to reference for condition evaluation.

Template is a boolean Go-template gate. When set, the step executes only if the template renders to “true” (e.g. “{{ eq .input.env \“production\” }}“). Mutually exclusive with Tool/FromStep; when present, Expect/ExpectNot are ignored.

Tool specifies the name of the tool to execute for condition evaluation. Optional when FromStep or Template is used.

Description provides human-readable documentation for this sub-step’s purpose.

ID is the unique identifier for this sub-step.

Output indicates whether this sub-step’s result is included in the workflow’s returned document. The result is always referenceable by later steps regardless of this flag. When unset, the deprecated Store flag is used as a fallback.

Store is a deprecated alias for Output, kept for backwards compatibility. Prefer Output.

Tool specifies the name of the tool to execute.

Store is a deprecated alias for Output. It originally also controlled whether a step result was referenceable by later steps, but referencing is now always available; Store now only affects result visibility and is kept for backwards compatibility. Prefer Output.

Tool specifies the name of the tool to execute for this step. Mutually exclusive with forEach and parallel.

WorkflowStatus defines the observed state of Workflow

Conditions represent the latest available observations of the workflow’s state.

Condition contains details for one aspect of the current state of this API Resource.

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status of the condition, one of True, False, Unknown.

type of condition in CamelCase or in foo.example.com/CamelCase.

ReferencedTools lists all tools mentioned in the Workflow steps. This is informational only; actual availability depends on the user’s session. See ADR 007 for details on session-scoped tool visibility.

StepCount is the number of steps in the workflow.

Valid indicates whether the Workflow spec passes structural validation.

ValidationErrors contains any spec validation error messages.