ansible-role-wireguard/CHANGELOG.md

Changelog

14.0.0

• BREAKING CentOS7: Introduce wireguard_centos7_kernel_plus_reboot and wireguard_centos7_standard_reboot variables. Both are set to "true" by default. This will cause the host to be rebooted in case the "wireguard" kernel module was installed the very first time. If wireguard_centos7_installation_method: "kernel-plus" is set and the host wasn't booted with a kernel-plus kernel already you most probably need to reboot. For the standard kernel this might not be needed.
• CentOS7: Add reboot to the standard mode to make sure the WireGuard kernel module is available (contribution by @mofelee)
• BREAKING Introduce wireguard_update_cache variable to control if package manager caches should be updated before the installation (contribution by @sebix). Before this release the package manager cache wasn't updated for AlmaLinux 9, Archlinux, Fedora and openSUSE. With wireguard_update_cache set to true by default those OSes are now also update the package manager cache. If you don't want that set wireguard_update_cache to false for the host in question.
• variable wireguard_ubuntu_update_cache is deprecated

13.0.1

• fix in README

13.0.0

• add IPv6 support (contribution by @DiscowZombie)
• introduce wireguard_addresses variable (contribution by @DiscowZombie)

12.0.0

• remove Fedora 35 support (reached EOL)
• remove openSUSE 15.3 support (reached EOL)
• remove Debian 10 (Buster) support (reached EOL)
• fix Molecule prepare for Archlinux
• fix ansible-lint issue in tasks/setup-debian-raspbian-buster.yml

11.1.0

• add support for elementary OS 6
• ignore some minor linter warnings

11.0.0

• add support for Rocky Linux 9 (original PR from @vincentDcmps: https://github.com/githubixx/ansible-role-wireguard/pull/163)
• add support for AlmaLinux 9 (original PR from @trunet: https://github.com/githubixx/ansible-role-wireguard/pull/164)
• add EL9 to meta/main.yml
• require Ansible >= 2.11 as Rocky Linux is only supported with this version or above
• ansible-lint: use community.general.pacman module instead of ansible.builtin.pacman for Archlinux setup

10.0.0

• remove Fedora 34 + add Fedora 36 to Molecule test
• remove support for Fedora 35 / add support for Fedora 36
• add Molecule setup for openSUSE 15.4
• add Github release action to push new release to Ansible Galaxy
• add .yamllint
• tasks/main.yml: names should start with an uppercase letter
• handlers/main.yml: names should start with an uppercase letter
• improve the task key order to: name, when, tags, block
• fix Jinja2 spacing

9.3.0

• add support for Ubuntu 22.04 (Jammy Jellyfish)

9.2.0

• add wireguard_interface_restart variable. This allows the user to decide if the WireGuard interface should be restarted or not in case of changes to the interface. The default is (and was) to use wg syncconf which applies the changes to the interface without the need to restart the interface. Restarting the interface was only done if wg's syncconf command wasn't available. But that's basically only true for very old (and outdated) WireGuard tools. For more information on this have a look at the README (initial PR by @lmm-git)
• on Debian lsb-release is no longer needed (contribution by @blackandred)
• WireGuard is directly supported by Raspbian 11 (Bullseye) and higher. So Raspbian 11 and Raspbian 10 (Buster) (and lower) needs to be handled a little bit differently. (contribution by @penguineer)
• implement a very basic Molecule unit test

9.1.0

• For Rocky Linux 8 only: Added variable wireguard_rockylinux8_installation_method. Set wireguard_rockylinux8_installation_method to dkms to build WireGuard module from source, with wireguard-dkms. This is required if you use a custom kernel and/or your arch is not x86_64. The default of standard will install the kernel module with kmod-wireguard from ELRepo (contribution by @gitouche-sur-osm)

9.0.1

• FIX: The template rendering the WireGuard configuration only checked if wireguard_save_config was set and if so sets SaveConfig = true. So setting wireguard_save_config: "false" had no effect.

9.0.0

• set minimally required Ansible version to 2.9 (contribution by @8ware)
• fully qualify modules names (requires Ansible >= 2.9) (contribution by @8ware)
• rearrange hooks to match lifecycle order (contribution by @8ware)
• remove CentOS 8 support (reached end of life) - use AlmaLinux or Rocky Linux instead
• remove Fedora 33 support (reached end of life)
• remove openSUSE Leap 15.2 support (reached end of life)
• add openSUSE 15.3 support
• add Fedora 35 support
• remove Proxmox from Molecule test (Vagrant boxes for Proxmox are not useable)
• Remove unnecessary check if value is an integer on wireguard_port (see #112 (contribution by @abelfodil)

8.4.0

• add support for installing wireguard in pve lxc guest (contribution by @tobias-richter)

8.3.0

• add Molecule test for CentOS 7 kernel-plus

8.2.0

• add support for kernel-plus for CentOS 7 (contribution by @john-p-potter)

8.1.0

• add Rocky Linux support
• add AlmaLinux support
• add Molecule tests for Rocky Linux and AlmaLinux

8.0.0

• add Debian 11 (Bullseye) support
• add 'Fedora 34` support
• remove Fedora 32 support (EOL was in May 2021)
• fix various issues reported by ansible-lint
• Archlinux: As linux-lts is using kernel 5.10 now there is no need to install wireguard-lts + WireGuard DKMS packages any longer (and this packages are gone anyway)

7.12.0

• Refactor wg-install tag handling. For more details see Fix tag "wg-install" & Add no_log and [Tag wg-install is not applied properly](Tag wg-install is not applied properly) (contribution by @moonrail)
• Default verbosity of 0 or slight increases up to 2 will now not print any private keys to output (contribution by @moonrail)

7.11.0

• Introduce new variables wireguard_service_enabled and wireguard_service_state (contribution by @tjend)

7.10.0

• Support for Proxmox
• Check if wireguard_endpoint exists before checking if it is empty

7.9.0

• Added support for Fedora 33 (contribution by @wzzrd)
• Removed support for Fedora 31 (reached end of life)

7.8.0

• Added support for openSUSE Leap 15.2

7.7.0

• Use wireguard packages from Debian Backports instead of Debian Sid, these packages are more suitable for a stable distribution and have less impact on the system. Packages from unstable must be removed manually (including kernel) to make the switch on an existing system. Upgrading the role has no effect other than adding Debian Backports to the Apt repositories.
• Fix reboot mechanism in Raspbian role, now also works without molly-guard

7.6.0

• Added wireguard_private_key variable (contribution by @j8r)
• Fix check mode for Debian (contribution by @j8r)

7.5.0

• wireguard package is now available for Ubuntu 18.04 in universe repository. Before that ppa:wireguard/wireguard was used but that one isn't available anymore. The install procedure for Ubuntu 18.04 and 20.04 is now the same as both can use wireguard metapackage now. The role takes care to remove wireguard-dkms package in favour of wireguard metapackage but it leaves the configuration file for ppa:wireguard/wireguard repository untouched. So it's up to you to remove that PPA. Either use apt-add-repository --remove ppa:wireguard/wireguard or remove the file manually at /etc/apt/sources.list.d/ directory (you man need to run apt-get update afterwards).

7.4.0

• Added initial molecule infrastructure
• Remove useless block for single task in setup-debian-vanilla.yml (contribution by @rubendibattista)

7.3.1

• Debian only: Ensure the headers for the currently running kernel are installed instead of the latest one which might not be running yet. This allows DKMS to build the module for the current kernel version and avoids the need for an reboot to load the module. (contribution by @ldelelis and @ypid)

7.3.0

• Fix spelling and typos in docs. (contribution by @ypid)

• Drop Debian Stretch from the list of tested Linux distributions. Actual support was dropped/broken in 6.0.4 without updating the docs. (contribution by @ypid)

• Remove obsolete .reload-module-on-update file. It does not serve any function anymore after support for module reloading has been removed from the postinst script in 0.0.20200215-2 on 2020-02-24. A module update is properly signaled via /run/reboot-required so that the admin can (automatically) schedule a reboot when convenient. This will also be more in line with future Debian releases because starting with Debian bullseye, the kernel ships the module. (contribution by @ypid)

• Add ansible_managed header to WireGuard configuration file (wg0.conf by default). This will most probably change the WireGuard configuration file but only the formatting. But since the Ansible registers this file as changed Ansible will sync/restart WireGuard service. For newer WireGuard versions (since Nov. 2019) this isn't a problem normally as wg syncconf command is used (also see handlers/main.yml). (contribution by @ypid)

• Behind the scenes coding style improvements and cleanup without user impact. (contribution by @ypid)

7.2.0

• Basic MacOS X support (contribution by @rubendibattista)
• Introduce variables wireguard_conf_owner, wireguard_conf_group and wireguard_conf_mode (contribution by @rubendibattista)
• Fixed a typo bug in handlers/main.yml (contribution by @gabriel-v). But it looks like this had no impact on the "sync/restart" functionality.
• Proper formatting of WireGuard configuration file (wg0.conf by default). This will most probably change the WireGuard configuration file but only the formatting. But since the Ansible registers this file as changed Ansible will sync/restart WireGuard service. For newer WireGuard versions (since Nov. 2019) this isn't a problem normally as wg syncconf command is used (also see handlers/main.yml).
• Introduce wireguard_dc variable. This is an alpha feature and subject to change and may be even removed in future releases again. Therefore no documentation for this variable yet.

7.1.0

• Add support for unmanaged peers with wireguard_unmanaged_peers (contribution by @joneskoo)

7.0.0

• Switched to install from ELRepo KMOD package for CentOS (see WireGuard installation). This change may break installation for systems with custom kernels. The role previously supported custom kernel implicitly because it was using DKMS package (contribution by @elcomtik)
• Role removes DKMS WireGuard package, however it doesn't remove jdoss-wireguard-epel-7 repository. If you don't need this repository, do cleanup by removing /etc/yum.repos.d/wireguard.repo

6.3.1

• Support Openstack Debian images (contribution by @pallinger)

6.3.0

• Support Raspbian (contribution by @penguineer)

6.2.0

• Support Ubuntu 20.04 (Focal Fossa)
• Introduce wireguard_ubuntu_update_cache and wireguard_ubuntu_cache_valid_time variables to specify individual Ubuntu package cache settings. Default values are the same as before.
• As kernel >= 5.6 (and kernel 5.4 in Ubuntu 20.04) now have wireguard module included wireguard-dkms package is no longer needed in that case. That's why WireGuard package installation is now part of the includes for the specific OS to make it easier to handle various cases.

6.1.0

• Archlinux: Linux kernel >= 5.6 contains wireguard module now. No need to install wireguard-dkms anymore in this case. Installations with LTS kernel installs wireguard-lts package now instead of wireguard-dkms. Installations with kernel <= 5.6 will still install wireguard-dkms package.

6.0.4

• Use the buster-backports repository on Debian Buster (or older), use package standard repositories on sid/bullseye. standard repositories on sid/bullseye.

  The role no longer adds the unstable repo nor the apt preference for that repo. There is no need to clean the preference and unstable repository, since packages from your release have a higher priority.

  If you remove the apt preference (/etc/apt/preferences.d/limit-unstable) updates from unstable are accepted by apt. This likely is not what you want and may lead to an unstable state.

  If you want to clean up:

  • remove /etc/apt/preferences.d/limit-unstable and
  • remove deb http://deb.debian.org/debian/ unstable main from /etc/apt/sources.list.d/deb_debian_org_debian.list.

  The backports repository has a lower priority and does not need an apt preference.

6.0.3

• If wg syncconf command is not available do stop/start service instead of restart (contribution by @cristichiru)

6.0.2

• Debian: install gnupg package instead of gpg. (contribution by @zinefer)

6.0.1

• add shell options to syncconf handler to fail fast in case of error

6.0.0

• Newer versions of WireGuard (around November 2019) introduced wg syncconf subcommand. This has the advantage that changes to the WireGuard configuration can be applied without disturbing existing connections. With this change this role tries to use wg syncconf subcommand when available. This even works if you have hosts with older and newer WireGuard versions.

5.0.0

• wireguard_(preup|postdown|preup|predown) settings are now a list. If more iptables commands needs to be specified e.g. then this changes makes it more readable. The commands are executed in order as described in wg-quick.8. Also see README for more examples. (contribution by @Madic-)

4.2.0

• Add support for Fedora (contribution by @ties)

4.1.1

• Install GPG to be able to import WireGuard key (Debian)

4.1.0

• Allow to specify additional Wireguard interface options: fwmark, mtu, table, preup and predown (for more information and examples see wg-quick.8)
• Add host comments in Wireguard config file

4.0.0

• While the changes introduced are backwards compatible in general if you stay with your current settings some variables are no longer needed. So this is partly a breaking change and therefore justifies a new major version.
• Support multiple Wireguard interfaces. See README for examples (contribution by fbourqui)
• Make role stateless: In the previous versions the private and public keys of the Wireguard hosts were stored locally in the directory defined with the wireguard_cert_directory variable. This is no longer the case. The variables wireguard_cert_directory, wireguard_cert_owner and wireguard_cert_group are no longer needed and were removed. If you used this role before this release it's safe to remove them from your settings. The directory that was defined with the wireguard_cert_directory variable will be kept. While not tested it may enable you to go back to an older version of this role and it should still work (contribution by fbourqui)
• Reminder: wireguard_cert_directory default was ~/wireguard/certs. Public and Private keys where stored on the host running ansible playbook. As a security best practice private keys of all your WireGuard endpoints should not be kept locally.

3.2.2

• remove unneeded with_inventory_hostnames loops (thanks to @pierreozoux for initial PR)

3.2.1

• remove unnecessary files (contribution by @pierreozoux)

3.2.0

• add support for RHEL/CentOS (contribution by @ahanselka)

3.1.0

• pass package list directly to some modules by using the new and preferred syntax instead loop or with_items (contribution by @ahanselka)

3.0.1

• fix address in README

3.0.0

• support for Debian added (contribution by @ties)

2.0.1

• make Ansible linter happy

2.0.0

• use correct semantic versioning as described in Semantic versioning. Needed for Ansible Galaxy importer as it now insists on using semantic versioning.
• moved changelog entries to separate file
• make Ansible linter happy
• no major changes but decided to start a new major release as versioning scheme changed quite heavily

v1.0.2

• update README

v1.0.1

• update README

v1.0.0

• initial implementation