ansible-qubes/README.md
Manuel Amador (Rudd-O) 03b2ae2ddd enhance docs
2015-06-15 12:12:41 -07:00

35 lines
1.1 KiB
Markdown

Ansible connection plugin for Qubes
===================================
This is an experimental plug-in mechanism that enables Ansible to connect
to Qubes VMs, either from another Qubes VM, or from a remote host via SSH
(assuming there exists a proxy Qubes VM with SSH listening on it).
**Warning: this is a massive hack.** Please be *absolutely sure* you
have reviewed this code before using it. Contributions welcome.
How to use this
---------------
You integrate it into your Ansible setup by:
1. placing the `qubes.py` connection plugin in your Ansible
`connection_plugins` directory, then
2. placing the `qrun` and `qrun-bridge` executables in one of two locations:
* Anywhere on your Ansible machine's `PATH`.
* In a `../../bin` directory relative to the `qubes.py` file.
After having done that, you can add Qubes VMs to your Ansible `hosts` file:
```
workvm ansible_connection=qubes
vmonremotehost ansible_connection=qubes management_proxy=1.2.3.4
```
License
-------
This code is available to you under the terms of the GNU LGPL version 2
or later. The license terms are available on the FSF's Web site.