[Doc] Move README doc into manifests round2

Author: Johan De Wit

lib/puppet/type/mongodb_conn_validator.rb

@@ -8,6 +8,7 @@
           purposes such as monitoring."
 
   ensurable do
+    desc 'Ensure to verify the connection to mongodb'
     defaultvalues
     defaultto :present
   end

lib/puppet/type/mongodb_replset.rb

@@ -8,6 +8,7 @@
   @doc = 'Manage a MongoDB replicaSet'
 
   ensurable do
+    desc 'Ensure the replicaset is iether present or absent'
     defaultto :present
 
     newvalue(:present) do

lib/puppet/type/mongodb_shard.rb

@@ -8,6 +8,7 @@
   @doc = 'Manage a MongoDB Shard'
 
   ensurable do
+    desc 'Ensure the shard is iether present or absent'
     defaultto :present
 
     newvalue(:present) do

manifests/mongos.pp

@@ -9,7 +9,7 @@
 #  }
 #
 # @param config
-#  Path of the config file. If not specified, the module will use the default for your OS distro.
+#   Path of the config file. If not specified, the module will use the default for your OS distro.
 #
 # @param config_content
 #   Config content if the default doesn't match one needs.
@@ -52,7 +52,7 @@
 #
 # @param package_name
 #   This setting can be used to specify the name of the package that should be installed.
-#    If not specified, the module will use whatever service name is the default for your OS distro.
+#   If not specified, the module will use whatever service name is the default for your OS distro.
 #
 # @param unixsocketprefix
 #   The path for the UNIX socket. If this option has no value, the mongos process creates a socket with /tmp as a prefix.

manifests/mongos/config.pp

@@ -1,4 +1,48 @@
-# PRIVATE CLASS: do not call directly
+# @private
+# @summary Configs mongos
+#
+# @param package_ensure
+#   This setting can be used to specify if puppet should install the package or not
+#
+# @param config
+#   Path of the config file. If not specified, the module will use the default for your OS distro.
+#
+# @param config_content
+#   Config content if the default doesn't match one needs.
+#
+# @param config_template
+#   Path to the config template if the default doesn't match one needs.
+#
+# @param service_manage
+#   Whether or not the MongoDB sharding service resource should be part of the catalog.
+#
+# @param configdb
+#   Array of the config servers IP addresses the mongos should connect to.
+#
+# @param bind_ip
+#   Set this option to configure the mongod or mongos process to bind to and listen for connections from applications on this address.
+#   If not specified, the module will use the default for your OS distro.
+#
+# @param port
+#   Specifies a TCP port for the server instance to listen for client connections.
+#
+# @param fork
+#   Set to true to fork server process at launch time. The default setting depends on the operating system.
+#
+# @param pidfilepath
+#   Specify a file location to hold the PID or process ID of the mongod process.
+#   If not specified, the module will use the default for your OS distro.
+#
+# @param logpath
+#   Specify the path to a file name for the log file that will hold all diagnostic logging information.
+#   Unless specified, mongod will output all log information to the standard output.
+#
+# @param unixsocketprefix
+#   The path for the UNIX socket. If this option has no value, the mongos process creates a socket with /tmp as a prefix.
+#
+# @param config_data
+#   Hash containing key-value pairs to allow for additional configuration options to be set in user-provided templ ate.
+#
 class mongodb::mongos::config (
   $package_ensure   = $mongodb::mongos::package_ensure,
   $config           = $mongodb::mongos::config,

manifests/mongos/install.pp

@@ -1,4 +1,14 @@
-# PRIVATE CLASS: do not call directly
+# @private
+#
+# @summary Installs mongos
+#
+# @param package_ensure
+#   This setting can be used to specify if puppet should install the package or not
+#
+# @param package_name
+#   This setting can be used to specify the name of the package that should be installed.
+#   If not specified, the module will use whatever service name is the default for your OS distro.
+#
 class mongodb::mongos::install (
   $package_ensure = $mongodb::mongos::package_ensure,
   $package_name   = $mongodb::mongos::package_name,

manifests/mongos/service.pp

@@ -1,4 +1,41 @@
-# PRIVATE CLASS: do not call directly
+# @private
+#
+# @summary Manages the mongos service.
+#
+# @param package_ensure
+#   This setting can be used to specify if puppet should install the package or not.
+#
+# @param service_manage
+#   Whether or not the MongoDB sharding service resource should be part of the catalog.
+#
+# @param service_name
+#   This setting can be used to override the default Mongos service name.
+#   If not specified, the module will use whatever service name is the default for your OS distro.
+#
+# @param service_enable
+#   This setting can be used to specify if the service should be enable at boot.
+#
+# @param service_ensure
+#   This setting can be used to specify if the service should be running.
+#
+# @param service_status
+#   This setting can be used to override the default status check command for your Mongos service.
+#   If not specified, the module will use whatever service name is the default for your OS distro.
+#
+# @param service_provider
+#   This setting can be used to override the default Mongos service provider.
+#   If not specified, the module will use whatever service provider is the default for your OS distro.
+#
+# @param bind_ip
+#   Set this option to configure the mongod or mongos process to bind to and listen for connections from applicati ons on this address.
+#   If not specified, the module will use the default for your OS distro.
+#
+# @param port
+#   Specifies a TCP port for the server instance to listen for client connections.
+#
+# @param service_template
+#   Path to the service template if the default doesn't match one needs.
+#
 class mongodb::mongos::service (
   $package_ensure   = $mongodb::mongos::package_ensure,
   $service_manage   = $mongodb::mongos::service_manage,