Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x86-39/ansible_role_wireguard
Ansible role to set up a Wireguard network with peers
https://github.com/x86-39/ansible_role_wireguard
Last synced: about 4 hours ago
JSON representation
Ansible role to set up a Wireguard network with peers
- Host: GitHub
- URL: https://github.com/x86-39/ansible_role_wireguard
- Owner: x86-39
- License: mit
- Created: 2023-03-17T20:06:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-07T11:28:44.000Z (6 months ago)
- Last Synced: 2024-11-08T10:54:55.167Z (11 days ago)
- Language: Jinja
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ansible Role Wireguard
=========
[](https://github.com/diademiemi/ansible_role_wireguard/actions/workflows/molecule.yml)
Ansible role to install and configure a Wireguard network. It can generate keys or use existing ones to connect to externally configured peers.
It will automatically use all hosts in the play as peers connecting to the given master node (`wireguard_master_inventory_hostname`). An additional list of peers can be added to the Wireguard interface with the `wireguard_additional_peers` variable.
You can use this just to connect to an existing host by omitting the `wireguard_master_inventory_hostname` variable and just using the `wireguard_additional_peers` variable.
Requirements
------------
These platforms are supported:
- Ubuntu 20.04
- Ubuntu 22.04
- Debian 11
- Debian 12
- EL 8 (Tested on Rocky Linux 8)
- EL 9 (Tested on Rocky Linux 9)
- Fedora 40
- openSUSE Leap 15.5
Networking requirements:
- Port 51820/UDP (or `wireguard_port`) must be accessible on the master host.
Role Variables
--------------
| Variable | Default | Description |
|----------|---------|-------------|
| `wireguard_master_inventory_hostname` | `""` | The inventory hostname of the master node. |
| `wireguard_master_ip` | IP of master | The IP address of the master node. |
| `wireguard_port` | `51820` | The port to use for Wireguard. |
| `wireguard_interface_name` | `"wg0"` | The name of the Wireguard interface. |
| `wireguard_private_key` | `""` | The private key to use for the Wireguard interface. Will be generated if not set. |
| `wireguard_public_key` | `""` | The public key to use for the Wireguard interface. Will be inferred from private key. |
| `wireguard_ip` | `"192.168.150.1/24"` | The IP address to use for the Wireguard interface. |
| `wireguard_iptables_forward` | `true` | Whether to enable iptables forwarding. |
| `wireguard_physical_interface` | `""` | The physical interface to forward to |
| `wireguard_additional_peers` | `[]` | A list of additional peers to add to the Wireguard interface. |
Dependencies
------------
None
Example Playbook
----------------
```yaml
- name: Use diademiemi.wireguard role
hosts: "{{ target | default('wireguard') }}"
roles:
- role: "diademiemi.wireguard"
tags: ['diademiemi', 'wireguard', 'setup']
```
License
-------
MIT
Author Information
------------------
- diademiemi (@diademiemi)
Role Testing
------------
This repository comes with Molecule that run in Podman on the supported platforms.
Install Molecule by running
```bash
pip3 install -r requirements.txt
```
Run the tests with
```bash
molecule test
```