Skip to content

Commit

Permalink
Remove duplicated data type from parameter documentation
Browse files Browse the repository at this point in the history
Corrects two parameters to the more specific type from the docs, and
permits any data in `additional_options` to match usage in existing
tests.
  • Loading branch information
domcleal authored and mmoll committed Apr 11, 2017
1 parent d86bd65 commit 87df08c
Showing 1 changed file with 2 additions and 30 deletions.
32 changes: 2 additions & 30 deletions manifests/init.pp
Expand Up @@ -4,95 +4,67 @@
#
# === Parameters:
# $namedconf_path:: Path of the named config
# type:Stdlib::Absolutepath
#
# $dnsdir:: Directory holding the named configs
# type:Stdlib::Absolutepath
#
# $dns_server_package:: Name of the package to install
# type:String
#
# $rndckeypath:: Path of the RNDC key
# type:Stdlib::Absolutepath
#
# $optionspath:: Path of the named options
# type:Stdlib::Absolutepath
#
# $publicviewpath:: Path of the config file holding all the zones
# type:Stdlib::Absolutepath
#
# $vardir:: Directory holding the variable or working files
# type:Stdlib::Absolutepath
#
# $namedservicename:: Name of the service
# type:String
#
# $zonefilepath:: Directory containing zone files
# type:Stdlib::Absolutepath
#
# $localzonepath:: File holding local zones like RFC1912 or RFC1918 files.
# type:Optional[Stdlib::Absolutepath]
#
# $forward:: The forward option
# type:Optional[Enum['only', 'first']]
#
# $forwarders:: The forwarders option
# type:Array[String]
#
# $listen_on_v6:: The listen-on-v6 option
# type:Optional[Variant[String, Boolean]]
#
# $recursion:: The recursion option
# type:Enum[yes, no]
#
# $allow_recursion:: The allow-recursion option
# type:Array[String]
#
# $allow_query:: The allow-query option
# type:Array[String]
#
# $empty_zones_enable:: The empty-zones-enable option
# type:Enum[yes, no]
#
# $dns_notify:: The notify option in named.conf
# type:Enum[yes, no, explicit]
#
# $dnssec_enable:: The dnssec-enable option
# type:Enum[yes, no]
#
# $dnssec_validation:: The dnssec-validation option
# type:Enum[yes, no, auto]
#
# $namedconf_template:: The template to be used for named.conf
# type:String
#
# $acls:: Specify a hash of ACLs. Each key is the
# name of a network, and its value is
# an array of subnet strings.
# type:Hash[String, Array[String]]
#
# $optionsconf_template:: The template to be used for options.conf
# type:String
#
# $controls:: Specify a hash of controls. Each key is the
# name of a network, and its value is a hash
# containing 'port' => integer, 'keys' => array
# and 'allowed_addresses' => array
# type:Hash[String, Hash[String, Data]]
#
# $service_ensure:: The ensure attribute on the service
# type:Enum[running, stopped]
#
# $service_enable:: Whether to enable the service (start at boot)
# type:Boolean
#
# $additional_options:: Additional options
# type:Hash[String, String]
#
# $additional_directives:: Additional directives. These are free form
# strings that allow for full customization. Use
# with caution.
# type:Array[String]
#
# === Usage:
#
Expand Down Expand Up @@ -127,8 +99,8 @@
Hash[String, Hash[String, Data]] $controls = $::dns::params::controls,
Variant[Enum['running', 'stopped'], Boolean] $service_ensure = $::dns::params::service_ensure,
Boolean $service_enable = $::dns::params::service_enable,
Hash $additional_options = $::dns::params::additional_options,
Array $additional_directives = $::dns::params::additional_directives,
Hash[String, Data] $additional_options = $::dns::params::additional_options,
Array[String] $additional_directives = $::dns::params::additional_directives,
) inherits dns::params {

class { '::dns::install': }
Expand Down

0 comments on commit 87df08c

Please sign in to comment.