Run one or more Ansible playbooks

step

Runs a set of Ansible playbooks from a Git repository against defined inventories.

Specification

ssh
Optional
object
The SSH configuration to use when connecting to hosts with Ansible.
ssh.connection
Optional
A Relay SSH connection to useConnection docs
${connections.ssh.my-ssh-connection}
git
Optional
object
A Git repository with one or more Ansible playbooks to run.
git.connection
Optional
A Relay SSH connection to useConnection docs
${connections.ssh.my-ssh-connection}
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.
directory
Optional
string
The subdirectory of the Git repository to switch to, if needed.
inventories[]

Required

array
A list of inventory targets (comma-separated hostnames, files, or directories) to connect to.
galaxy
Optional
object
Configuration for Ansible Galaxy.
galaxy.collections[]
Optional
array
A list of Ansible Galaxy collections to install.
extraVars
Optional
object
A mapping of additional variables to set when running the playbooks.
playbooks[]

Required

array
A list of playbook files to run against the given inventory targets.

Join our community

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.