configurations-ansible/roles/yggdrasil/README.md

44 lines
909 B
Markdown
Raw Permalink Normal View History

yggdrasil
=========
This role install/ uninstall yggdrasil for target
Requirements
------------
.
Role Variables
--------------
Respond to:
- **yggdrasil_enabled** (boolean): If true install yggdrasil
- **yggdrasil_sshd_enabled** (boolean): If true enable sshd access through Yggdrasil
- **yggdrasil_peers_list_url** (url): a remote file that contains the `Peers` section of yggdrasil configuration
Role Tags
--------------
- **global.update_only**: If present will update only the peers
- **global.uninstall**: If present yggdrasil will be removed from the system (requires *yggdrasil_enabled to false*)
Dependencies
------------
.
Example Playbook
----------------
`ansible-playbook -i inventory/example.yml handbook.yml --extra-vars="target=example_target" --tags yggdrasil`
License
-------
GPLv3
Author Information
------------------
- [Claudio Maradonna](https://social.unitoo.it/claudio)