mirror of
https://github.com/dawidd6/action-ansible-playbook.git
synced 2024-11-29 19:35:19 +00:00
38 lines
1,020 B
Markdown
38 lines
1,020 B
Markdown
# Run Ansible playbook GitHub Action
|
|
|
|
An Action that executes given Ansible playbook on selected hosts.
|
|
|
|
Should work on any OS, if `ansible-playbook` command is available in `PATH`.
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
- name: Run playbook
|
|
uses: dawidd6/action-ansible-playbook@v2
|
|
with:
|
|
# Required, playbook filepath
|
|
playbook: deploy.yml
|
|
# Optional, directory where playbooks live
|
|
directory: ./
|
|
# Optional, SSH private key
|
|
key: ${{secrets.SSH_PRIVATE_KEY}}
|
|
# Optional, literal inventory file contents
|
|
inventory: |
|
|
[all]
|
|
example.com
|
|
|
|
[group1]
|
|
example.com
|
|
# Optional, SSH known hosts file content
|
|
known_hosts: .known_hosts
|
|
# Optional, encrypted vault password
|
|
vault_password: ${{secrets.VAULT_PASSWORD}}
|
|
# Optional, galaxy requirements filepath
|
|
requirements: galaxy-requirements.yml
|
|
# Optional, additional flags to pass to ansible-playbook
|
|
options: |
|
|
--inventory .hosts
|
|
--limit group1
|
|
--extra-vars hello=there
|
|
--verbose
|
|
```
|