Forge Home

wireguard

Wireguard is a module for wireguard config managing. Both client and server configs are supported.

17,433 downloads

17,433 latest version

3.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.0 (latest)
released Dec 28th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'arrnorets-wireguard', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add arrnorets-wireguard
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install arrnorets-wireguard --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

arrnorets/wireguard — version 0.1.0 Dec 28th 2020

Table of contents

  1. Common purpose
  2. Compatibility
  3. Installation
  4. Config example in Hiera and result files

1. Common purpose

Wireguard is a module for wireguard config managing. Both client and server configs are supported.

2. Compatibility

This module was tested on CentOS 7. It also should work on Fedora 19 and higher and RHEL 7, but no tests were performed.

3. Installation

mod 'wireguard',
    :git => 'https://github.com/arrnorets/puppet-wireguard.git',
    :ref => 'main'

4. Config example in Hiera and result files

This module follows the concept of so called "XaaH in Puppet". The principles are described here and here.

Here is the example of config in Hiera:

---
wireguard:
  package: 'present'
  enable: true
  is_dkms_needed: 'no'
  is_wireguard_server: 'no'
  config:
    wg0:
      Interface:
        Address: 'define_in_module'
        ListenPort: 32700
        PrivateKey: 'define_in_module'
      Peer:
        PublicKey: "< public key of host wg-server.local >"
        AllowedIPs: "10.10.10.0/24"
        Endpoint: "192.168.1.10:32700"
        PersistentKeepalive: 10


wireguard_peer_info:
  wg0:
    wg-server.local:
      Address: "10.10.10.1/24"
      PrivateKey: '< private key of host wg-server.local >'
      PublicKey: '< public key of host wg-server.local >'
      Endpoint: "192.168.1.10:32700"
      PersistentKeepalive: 10
    wg-client.local:
      Address: '10.10.10.2/24'
      PrivateeKey: '< private key of host wg-client.local >'
      PublicKey: '< public key of host wg-client.local >'
      Endpoint: '192.168.1.11:32700'
      PersistentKeepalive: 10

It will install wireguard-tools package, enable service wg-quick@wg0 and produce the folowing file /etc/wireguard/wg0.conf:

  • On client:
    [Interface]
    Address = 10.10.10.2/24
    ListenPort = 32700
    PrivateKey = < private key of host wg-client.local >
      
    [Peer]
    PublicKey = < public key of host wg-server.local >
    AllowedIPs = 10.10.10.0/24
    Endpoint = 192.168.11.10:32700
    PersistentKeepalive = 10
    
  • On server:

    [Interface]
    Address = 10.10.10.1/24
    ListenPort = 32700
    PrivateKey = < private key of host wg-server.local >
    
    
    # /* Peer list */ 
    
    # // wg-client.local
    [Peer]
    AllowedIPs = 10.10.10.2/32
    PublicKey = < public key of host wg-client.local >
    PersistentKeepalive = 10
    
    # /* END BLOCK */