STEP

Start a Puppet run

This step requests a new Puppet run using the Relay API. It does not wait for the run to complete. Use the run-wait step if you need to wait on the run.

Specification

connection

Required

!Connection {type: puppet, name: my-puppet-connection}
environment
Optional
string
The Puppet environment to use for the run
scope

Required

noop
Optional
boolean
Whether this should be a dry run
debug
Optional
boolean
Whether the `debug` agent flag should be used for this run
trace
Optional
boolean
Whether the `trace` agent flag should be used for this run
evaltrace
Optional
boolean
Whether the `evaltrace` agent flag should be used for this run

Outputs

id

Required

string
The Relay API identifier for the Puppet run
jobID
Optional
string
If using Puppet Enterprise, the orchestrator job ID for the Puppet run

Integrations in this step

Install the Relay CLI

Relay CLI is an essential companion for authoring and managing workflows. You can install it with a package manager or download it.
brew install puppetlabs/puppet/relay
Learn more about setting up Relay.

How to contribute

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.