https://github.com/kushaldas/qubes_ansible

Ansible module and connection plugin for Qubes OS
https://github.com/kushaldas/qubes_ansible

Last synced: about 1 month ago
JSON representation

Ansible module and connection plugin for Qubes OS

• Host: GitHub
• URL: https://github.com/kushaldas/qubes_ansible
• Owner: kushaldas
• License: gpl-3.0
• Created: 2018-10-15T04:10:33.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-02-07T10:07:19.000Z (9 months ago)
• Last Synced: 2024-02-08T00:25:28.224Z (9 months ago)
• Language: Python
• Homepage: https://qubes-ansible.readthedocs.io/en/latest/index.html
• Size: 110 KB
• Stars: 8
• Watchers: 5
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Ansible connection and module for QubesOS

This is a written from scratch project to have a default Ansible connection

plugin to interact with [Qubes OS](https://qubes-os.org). There is also an

Ansible module to create/destroy/maintain state of the VM(s). 

## Documentation

Read it [online](https://qubes-ansible.readthedocs.io/en/latest/), it has

better commands and setup instructions than the README file.

## How to setup?

Put the ``ansible_module`` directory in a known place; in our example,

we will put it in ``/usr/share/ansible_module``.

Remember that this project will only from **dom0** or any VM with AdminAPI

access.

## Installing Ansible and setup of the our module/connection

Install Ansible whichever way you like. In **Qubes 4.2 dom0** it would be,

```

sudo qubes-dom0-update ansible

```

Update your ``/etc/ansible/ansible.cfg`` to have the following two lines.

```

[defaults]

library = /usr/share/ansible_module/

connection_plugins = /usr/share/ansible_module/conns/ 

```

### How to write playbooks/roles tasks etc?

Just keep in mind that creating/destroying vms will require a **local** 

connection and will use the *qubesos* module.

To work on a remote VM, use **qubes** connection and use standard playbooks.

## Examples

Check the [examples](examples/) directory in this repo.

## Under development

This project is still very young, and, the **qubesos** module is under

heavy development so the syntax/keywords may change in future.

### License GPLv3+

Please see the [LICENSE](LICENSE) file for a complete copy of License.