Reference documentation

Workflow reference

Use a Relay workflow to define the distinct steps in the task you're automating.

Relay workflows use four top-level maps: description, parameters, steps, and triggers. Of these, only steps is required.

Description

Start your workflow with the description key. For example:

description: This workflow prints out a hello message to the logs. It also runs some simple terminal commands and prints their results to the logs.

Parameters

Parameters enable Relay to provide outside data into the workflow as it runs. You can optionally provide a default value for each parameter, which a user-specified value will override at runtime. If you do not provide a default and do not supply a value, the workflow run will fail.

Relay currently only supports parameters whose values are strings.

parameters:
  myparam:
    description: "A typical user supplied parameter"
    default: defaultvalue

Steps

The steps key makes up the body of your workflow. It contains an array of steps, where each step must consist of a name, image, and spec, plus an optional dependsOn key.

name

(string) The name of the step. Must be unique across the workflow.

name: echo

image

(string) The container image and tag you're using for the step. Relay's default registry is Docker hub, so if the image is hosted there you can use the short imagename:tag syntax. Otherwise, use the long form like gcr.io/account/image:tag

image: alpine:latest

spec

(array) Short for 'specification'; this section provides context that's specific to the step. The contents of spec will depend on the implementation of the task container; programmers may find it useful to think of it as providing values to a function. For example, a step which uses the projectnebula/jira-resolve container to close a Jira ticket requires url and issue keys in its spec. For a list of step containers curated by Puppet see step containers.

dependsOn

(string or array of strings) As the name suggests, dependsOn indicates that this step depends on another step in the workflow. Each value must be a valid name attribute for another step. This key is useful if you need to set an explicit sequential order for your steps. Without dependsOn or implicit ordering requirements (see the !Output type), Relay will run your steps in parallel to speed up execution.

dependsOn:
- deploy_test_cluster

Triggers

Triggers map incoming events to workflows. The triggers key contains an array of individual triggers, any of which can cause the workflow to run. Each trigger must have name and source keys, and may optionally have binding and when keys.

name

(string) A name for this trigger; must be unique to the workflow.

source

(map) The source for the trigger is a description of the event which will cause the workflow to run. There are currently three kinds of sources available; source requires a type attribute to indicate which one to use, and each type has additional required fields.

schedule

A Schedule trigger type works, as the name suggests, on a time-based schedule. It needs a key named schedule whose value is a string in the standard Unix 'cron' syntax. There's a handy crontab syntax generator that can help you build a schedule if you're not familiar with cron.

triggers:
 - name: my-schedule-trigger
   source:
     type: schedule
     schedule: '*/5 * * * *'   # runs every 5 minutes

webhook

A Webhook trigger matches an incoming webhook payload from an external service to the workflow. Relay runs a container image in reponse to the webhook payload, so it requires an image field that is a reference to a container image hosted on a registry, same as the image field in a step definition.

triggers:
  - name: my-webhook-trigger
    source:
      type: webhook
      image: projectnebula/dockerhub-push-trigger

This example runs the dockerhub-push-trigger container in response to receiving a webhook. The hook itself is configured in the Connections section of the app.

push

A push trigger matches events that come into Relay through its API. It requires a schema field, whose value is not yet documented. Sorry.

binding

The binding key of a trigger definition maps incoming data from the event to parameters in the workflow. This allows you, for example, extract a field from the json payload of a webhook. A binding has one field, parameters, which is a map whose keys must match the names of parameters inside the workflow. The values can use Functions or Data types in order to extract and manipulate data into the form the workflow parameter expects.

The !Data custom type is particularly helpful here, because it will be populated with the keys from an incoming webhook or push event.

triggers:
  - name: my-webhook-trigger
    source:
      type: webhook
      image: projectnebula/dockerhub-push-trigger
    binding:
      parameters:
        dockerTagName: !Data tag
parameters:
  dockerTagName:
    default: latest

Expanding on the Docker hub example, this trigger extracts the tag field from the incoming webhook and maps it to the parameter dockerTagName, which is used in the workflow to override the default value of latest.

when

The same syntax that Relay uses to provide conditional execution of steps is also available for triggers. This uses the when key, whose value is an expression that must evaluate to "true" in order for the workflow to run. See the Conditional execution docs for more details on the syntax and usage.

Similar to the binding map, it's handy to make decisions about execution based on the contents of the incoming event. The !Data custom type allows you to extract fields from webhooks and push events as a basis for comparison.

triggers:
  - name: conditional-trigger
    source:
      type: webhook
      image: projectnebula/core
    when: !Fn.equals[!Data environment, 'production']

The Relay functions reference has more examples of the !Fn.* syntax.