From 928dbaa62bcc37092ddec36b1f715365576eae6d Mon Sep 17 00:00:00 2001
From: Raphaël Pinson <raphael.pinson@camptocamp.com>
Date: Fri, 12 Apr 2013 14:11:44 +0200
Subject: doc

---
 manifests/server.pp | 54 +++++++++++++++++++++++++++--------------------------
 1 file changed, 28 insertions(+), 26 deletions(-)

(limited to 'manifests/server.pp')

diff --git a/manifests/server.pp b/manifests/server.pp
index 1c77cf2..a44cfe1 100644
--- a/manifests/server.pp
+++ b/manifests/server.pp
@@ -1,35 +1,37 @@
-# = Class: dhcp::server
-# Simple OS wrapper. Include this to install a dhcp server on your host.
+# Class: dhcp::server
 #
-# Requires:
-#   module "common": git://github.com/camptocamp/puppet-common.git
+# Installs and configures a DHCP server.
 #
-# facultative argument:
-#   *$ddns_update*   : ddns-update-style option (defaults to 'none')
-#   *$authoritative* : a boolean setting whether the DHCP server is
-#                      authoritative (defaults to false)
-#   *$opts*          : an array of DHCPD valid options
+# Parameters:
+#   ['ddns_update']   : ddns-update-style option (defaults to 'none')
+#   ['authoritative'] : a boolean setting whether the DHCP server is
+#                       authoritative (defaults to false)
+#   ['opts']          : an array of DHCPD valid options
 #
-# Example:
-# node "dhcp.toto.ltd" {
-#   class { 'dhcp::server':
-#     opts => ['domain-name "toto.ltd"',
-#              'domain-name-servers 192.168.21.1'],
-#   }
+# Sample usage:
+#   node "dhcp.toto.ltd" {
+#     class { 'dhcp::server':
+#       opts => ['domain-name "toto.ltd"',
+#                'domain-name-servers 192.168.21.1'],
+#     }
 #
-#   dhcp::subnet {"10.27.20.0":
-#     ensure     => present,
-#     broadcast  => "10.27.20.255",
-#     other_opts => ['filename "pxelinux.0";', 'next-server 10.27.10.1;'],
-#   }
+#     dhcp::subnet {"10.27.20.0":
+#       ensure     => present,
+#       broadcast  => "10.27.20.255",
+#       other_opts => ['filename "pxelinux.0";', 'next-server 10.27.10.1;'],
+#     }
 #
-#   dhcp::host {"titi-eth0":
-#     ensure        => present,
-#     mac           => "0e:18:fa:fe:d9:00",
-#     subnet        => "10.27.20.0",
-#     fixed_address => "10.27.10.52",
+#     dhcp::host {"titi-eth0":
+#       ensure        => present,
+#       mac           => "0e:18:fa:fe:d9:00",
+#       subnet        => "10.27.20.0",
+#       fixed_address => "10.27.10.52",
+#     }
 #   }
-# }
+#
+# Requires:
+#   - puppetlabs/stdlib
+#   - ripienaar/concat
 #
 class dhcp::server (
   $ddns_update = 'none',
-- 
cgit v1.2.3