From 33c9745d0d6427bf2476d230cf0c878249d165ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Fri, 17 Jul 2015 16:22:43 -0400 Subject: add simple README file --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c57dcff --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +resolv.conf Puppet module +========================= + +This module will manage `/etc/resolv.conf` through Puppet. + +resolvconf class +---------------- + +The main class (`resolvconf`) takes a simple list of nameservers as an +array. For example: + + class { 'resolvconf': + nameservers => [ '8.8.8.8' ], + } + +... will create a `resolv.conf` that searches the domain name of the +machine (the `$::domain` fact) and uses Google's recursive +nameservers. The domain name and search path can be overriden with the +`$domain` and `$search` parameters. + +Extra options can be added at the end of the `resolv.conf` file with +the `$tail` argument. + +resolvconf::dhcp class +---------------------- + +For machines that are configured with DHCP, the `resolvconf` class +should simply not be included, and the DHCP client will take care of +managing the config file. + +However, if you wish to add options to the resulting `resolv.conf` +file, you can use the `resolvconf::dhcp` class that will use the +`resolvconf` Debian package to apply extra options at the end of the +`resolv.conf` file. For example, this will ensure a faster fallback +in case of failures in the DHCP-provided nameservers: + + class { 'resolvconf::dhcp': + tail => 'options timeout:1 attempts:3 rotate', + } -- cgit v1.2.3