diff options
| author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-06-06 22:17:49 +0200 |
|---|---|---|
| committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-06-06 22:17:49 +0200 |
| commit | 2e9891be2e85cd77e2ad3bd7a1958bcc73805922 (patch) | |
| tree | 6f18a6ec8152971a9a30d5ccdd5775ef36c58abd | |
| parent | Remove now unused templates. (diff) | |
| download | dns-2e9891be2e85cd77e2ad3bd7a1958bcc73805922.tar.gz dns-2e9891be2e85cd77e2ad3bd7a1958bcc73805922.tar.xz | |
Documentation.
| -rw-r--r-- | manifests/init.pp | 2 | ||||
| -rw-r--r-- | manifests/key.pp | 2 | ||||
| -rw-r--r-- | manifests/record.pp | 9 | ||||
| -rw-r--r-- | manifests/zone.pp | 9 |
4 files changed, 21 insertions, 1 deletions
diff --git a/manifests/init.pp b/manifests/init.pp index ffb102d..a3e073a 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -1,3 +1,5 @@ +# @summary sets up a DNS server +# # @param config_file # Bind9 configuration file # @param directory diff --git a/manifests/key.pp b/manifests/key.pp index 01856a3..c5bdb55 100644 --- a/manifests/key.pp +++ b/manifests/key.pp @@ -1,6 +1,6 @@ # @summary A single dns key (for zone updates and the like) # -# TODO add stuff to autogenerate these, and insntead dump them to individual files. +# TODO add stuff to autogenerate these, and instead dump them to individual files. # # @param algorithm # Algorithm used, must match secret diff --git a/manifests/record.pp b/manifests/record.pp index 1b36a94..f94d1c8 100644 --- a/manifests/record.pp +++ b/manifests/record.pp @@ -1,3 +1,12 @@ +# @summary A single DNS record +# +# @example +# dns::record { 'A www.example.com': +# zone => 'example.com', +# key => 'www', +# value => '203.0.113.4', +# } +# # @param type # Record type (A, AAAA, ...) # @param cls diff --git a/manifests/zone.pp b/manifests/zone.pp index 1fee3d5..c30becf 100644 --- a/manifests/zone.pp +++ b/manifests/zone.pp @@ -1,3 +1,12 @@ +# @summary Sets up one DNS zone +# +# @example +# dns::zone { 'example.com': +# rname => 'ns1.example.com', +# mname => 'domainmaster.example.com', +# ns => [ 'ns1', 'ns2', ] +# } +# # @param zone # Domain this zone controls. # @param mname |