action-ansible-playbook/README.md

40 lines
1.1 KiB
Markdown
Raw Normal View History

2021-07-26 10:46:29 -06:00
# Run Ansible playbook GitHub Action
2020-03-21 09:36:23 -06:00
2021-07-26 10:46:29 -06:00
An Action that executes given Ansible playbook on selected hosts.
2020-03-22 06:01:58 -06:00
2020-05-03 10:04:31 -06:00
Should work on any OS, if `ansible-playbook` command is available in `PATH`.
2020-03-22 06:01:58 -06:00
## Usage
```yaml
- name: Run playbook
2020-05-03 03:59:16 -06:00
uses: dawidd6/action-ansible-playbook@v2
2020-03-22 06:01:58 -06:00
with:
2021-07-26 10:44:13 -06:00
# Required, playbook filepath
2020-03-22 06:01:58 -06:00
playbook: deploy.yml
2021-07-26 10:44:13 -06:00
# Optional, directory where playbooks live
2020-03-24 15:30:07 -06:00
directory: ./
2021-07-26 10:44:13 -06:00
# Optional, SSH private key
2020-03-22 06:01:58 -06:00
key: ${{secrets.SSH_PRIVATE_KEY}}
2021-07-26 10:44:13 -06:00
# Optional, literal inventory file contents
inventory: |
[all]
example.com
[group1]
example.com
2021-07-26 10:46:29 -06:00
# Optional, SSH known hosts file content
2023-04-06 01:11:50 -06:00
known_hosts: |
example.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl
2021-07-26 10:44:13 -06:00
# Optional, encrypted vault password
vault_password: ${{secrets.VAULT_PASSWORD}}
2021-07-26 10:44:13 -06:00
# Optional, galaxy requirements filepath
requirements: galaxy-requirements.yml
# Optional, additional flags to pass to ansible-playbook
2020-03-22 06:01:58 -06:00
options: |
2021-07-26 10:44:13 -06:00
--inventory .hosts
2020-04-06 16:07:48 -06:00
--limit group1
2020-03-22 06:01:58 -06:00
--extra-vars hello=there
--verbose
```