Skip to content

Step reference

Each step type below lists its fields. Headings use the type’s ID, which is what you’ll see in the YAML and the API. The step picker shows a friendlier label.

Free covers run-script, run-container, http-request, approval and the two Git steps. k8s-resource, ContainerSet and Plugin need Developer or above. On Free, Dagweave won’t save a workflow that uses them.

Every step has these as well as its own fields.

  • Name shows on the canvas and becomes the task and template name in the YAML. Leave it blank and it takes the step’s type, such as script, then script-2 and so on. Imported steps keep their names.
  • Only run this when… takes a condition, such as {{tasks.flip.outputs.result}} == heads. Blank means always run.
  • Run this once per item… repeats the step over a list, items you type, or a range of numbers. See Parameters and loops.
  • Advanced, on steps that run in a pod: resources, environment variables, node selectors, retries, timeouts, and a podSpecPatch for anything else. Empty fields stay out of the YAML.

Picker label: Script. Runs a script in the working tree at /work.

  • Language (required): bash (default), sh, python or node.
  • Script (required).
  • Inputs from other steps: each name becomes an input port. Read it in the script as {{inputs.parameters.NAME}}.

Picker label: Container. Runs an image in the working tree at /work.

  • Image (required).
  • Command: overrides the entrypoint. Leave it empty to use the image’s.
  • Args.
  • Working Directory: defaults to /work.
  • Environment: name and value pairs.
  • Result File: whatever the container writes here becomes the step’s result, which later steps can loop over or test. Defaults to /tmp/dagweave/result.
  • Inputs from other steps: as for run-script. Use them in args or env as {{inputs.parameters.NAME}}.

Picker label: HTTP. Sends a request and passes the response body on as result.

  • URL (required).
  • Method: GET (default), POST, PUT, DELETE or PATCH.
  • Body.
  • Timeout (seconds): Argo Workflows uses 30 if you leave it empty.

Picker label: Resource. Acts on a Kubernetes object.

  • Action: apply (default), create, delete, patch, replace or get.
  • Manifest (required): the object as YAML.
  • Success condition and Failure condition: checked against the object, such as status.phase == Running.
  • Merge strategy: strategic (default), merge or json. Only for patch.
  • Set owner reference: the object gets deleted along with the workflow.
  • kubectl flags: extra options, such as --validate=false.

Picker label: Suspend. Pauses the run. It compiles to an Argo suspend template.

  • Duration: carry on by itself after this long, such as 1h or 30m. Leave it blank to wait until someone resumes the run.

These two are the only steps that pass a working tree along. Catalog Git WorkflowTemplates have no ports, so later steps can’t use what they check out.

git-checkout (Git checkout) clones a repo and outputs its working tree.

  • Repository URL (required): the HTTPS clone URL.
  • Revision (required): branch, tag or SHA. Defaults to main.
  • Credentials secret: blank for a public repo. For a private one, a Kubernetes Secret with username and password keys.

git-commit-push (Git commit & push) commits the working tree it receives and pushes it back to the repo it came from. It needs a git-checkout before it.

  • Commit message (required).
  • Author name and Author email: default to workflow-bot and [email protected].
  • Target branch (required): defaults to main.
  • Credentials secret (required): a Secret with username and password keys.

On import, a template that clones through an Argo Git input artifact becomes a git-checkout. A container running git-commit-push’s push script becomes a git-commit-push.

  • ContainerSet runs several containers in one pod. Each has a name, an image, optional command and args, and the containers it waits for.
  • Plugin runs an Argo executor plugin. Give its name and a JSON config.
  • Plain script is an Argo script template kept as written, with image, command, source and environment editable. Import creates these, and the picker has one too.

Import turns plain Argo templates into editable steps of these types. You can’t add them from the picker. Use the counterpart instead:

Import-only type Argo template Use instead
container container run-container
resource resource k8s-resource
http http http-request
container-set-plain containerSet ContainerSet
data data No counterpart

See Import and round-trip.