resolvconf

Table of Contents

1. Description
2. Setup - The basics of getting started with resolvconf
   • Beginning with resolvconf
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

Module for managing resolv.conf on RedHat and Debian based systems

Setup

Beginning with resolvconf

include resolvconf is enough to get you up and running with the module if you would like a default setup using Google’s resolvers and the $::domain fact as the search domain.

Usage

All parameters are available in the main resolvconf class. See the common usages below for examples.

Configure a default resolv.conf with Google nameservers as the $::domain fact as the search path

include ::resolvconf

Pass in parameters for which nameservers to use

class { ‘::resolvconf’:
  nameservers => [‘8.8.8.8’, ‘8.8.4.4’],
}

Pass in nameservers plus domains for the search path

class { ‘::resolvconf’:
  nameservers => [‘8.8.8.8’, ‘8.8.4.4’],
  domains     => [‘domain.tld’, ‘sub.domain.tld’],
}

Reference

Classes

Public classes

• resolvconf: Main class, includes all other classes

Private classes

• resolvconf::config: Handles the configuration of resolv.conf
• resolvconf::service: Handles the resolvconf service for debian based systems
• resolvconf::install: Handles package installation for debian based systems

Parameters

nameservers

Optional.

Data type: Array

Allows you to specify an array of nameservers to use in resolv.conf. Default value: [‘8.8.8.8’, ‘8.8.4.4’]

domains

Optional.

Data type: Array

Allows you to specify an array of domains to include in the search path in resolv.conf. Default value: [$::domain]

use_local

Optional.

Data type: Boolean

Allows you to use a local nameserver such as named/bind. Will set a nameserver entry of 127.0.0.1 as the first entry in resolv.conf. Default value: false

Limitations

This module has only been tested on the following distros:

• Ubuntu
  • Trusty
  • Xenial
• Debian
  • Jessie
  • Stretch
• CentOS 7

This module uses a custom Hiera 5 backend and requires at least Puppet 4.9 due to this.

Development

If you would like to contribute to the module, fork it and create a pull request when you're satisfied with your changes.

Changelog

All notable changes to this project will be documented in this file.

Release 1.0.0

Features

• Add support for Puppet 6
• Add support for Ubuntu 18.04 & Ubuntu 20.04

Removed Features

• Remove support for Ubuntu 14.04

Release 0.1.0

Features

• Initial featureset and management of resolv.conf

Bugfixes

Known Issues