STEP

Run Bolt

This step performs a Bolt run.

Specification

type

Required

string
The type of Bolt action to perform.
name

Required

string
The name of the Bolt task to plan to run.
parameters
Optional
object
The task- or plan-specific parameter data to use for this run.
projectDir
Optional
string
When the `git` setting is specified, the relative directory within the git repository to use as the Bolt project.
modulePaths[]
Optional
array
A list of additional directories outside of the project directory to add to the Bolt module path.
installModules
Optional
boolean
Download and install modules listed in a `Puppetfile`.
transport
Optional
object
The default transport to use when connecting to the target nodes.
transport.type
Optional
string
The transport type.
transport.user
Optional
string
The username to use to connect.
transport.password
Optional
string
The password to use to connect.
transport.privateKey
Optional
string
The name of a key in the `credentials` setting to use as the default SSH private key.
transport.useSSL
Optional
boolean
If using the WinRM transport, whether to use SSL to connect.
transport.verifyHost
Optional
boolean
Whether to verify host integrity when connecting to remote nodes.
targets[]
Optional
stringarray
The list of target nodes to connect to, either in the same format as Bolt expects (a comma-separated string), or as a list.
credentials
Optional
object
A map of sensitive credential file names to content encoded using Base64.
git
Optional
object
A map of git configuration. If you're using HTTPS, only name and repository are required.
git.ssh_key

Required

string
The SSH key to use when cloning the git repository. You can pass the key to Relay as a secret.
git.known_hosts
Optional
string
SSH known hosts file. Use a Relay secret to pass the contents of the file into the workflow as a base64-encoded string.
git.name

Required

string
A directory name for the git clone.
git.branch
Optional
string
The Git branch to clone.
git.repository

Required

string
The git repository URL.

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.