Action: Ansible Playbook
Github Action for running Ansible Playbooks.
galaxy_file
Name of the galaxy file in your workspace.
inventory
Required inventory
Name of the inventory file in your workspace.
playbook
Required playbook
Name of the playbook in your workspace.
limit
Further limit selected hosts to an additional pattern.
Only run plays and tasks whose tags do not match these values.
start_at_task
Start the playbook at the task matching this name.
Only run plays and tasks tagged with these values.
Set additional variables as key=value.
module_path
Prepend paths to module library.
check
Run a check, do not apply any changes.
diff
When changing (small) files and templates, show the differences in those files; works great with –check.
flush_cache
Clear the fact cache for every host in inventory.
force_handlers
Run handlers even if a task fails.
list_hosts
Outputs a list of matching hosts.
List all available tags.
list_tasks
List all tasks that would be executed.
syntax_check
Perform a syntax check on the playbook.
forks
Specify number of parallel processes to use.
vault_id
The vault identity to use.
vault_password
The vault password to use. This should be stored in a Secret on Github.
See https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables
verbose
Level of verbosity, 0 up to 4.
private_key
Use this key to authenticate the connection. This should be stored in a Secret on Github.
See https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables
user
Connect as this user.
connection
Connection type to use.
timeout
Override the connection timeout in seconds.
ssh_common_args
Specify common arguments to pass to sftp/scp/ssh.
Specify extra arguments to pass to sftp only.
Specify extra arguments to pass to scp only.
Specify extra arguments to pass to ssh only.
become
Run operations with become.
become_method
Privilege escalation method to use.
become_user
Run operations as this user.
required: false
Example Usage
- name: Ansible Playbook
uses: arillso/action.playbook@master
with:
playbook: tests/playbook.yml
inventory: tests/hosts.yml
galaxy_file: tests/requirements.yml
env:
ANSIBLE_HOST_KEY_CHECKING: 'false'
ANSIBLE_DEPRECATION_WARNINGS: 'false'
Contributors
License
This project is under the MIT License. See the LICENSE file for the full license text.
Copyright
(c) 2020, Arillso