[Docs] move README into the manifests

Author: Johan De Wit

manifests/client.pp

@@ -1,11 +1,14 @@
-# Class for installing a MongoDB client shell (CLI).
+# @summary Class for installing a MongoDB client shell (CLI).
 #
-# == Parameters
+# @example Basic usage
+# include mongodb::client
+
+# @param ensure
+#   Used to ensure that the package is installed, or that the package is absent/purged
 #
-# $ensure:: Desired ensure state of the package.
-#
-# $package_name:: Name of the package to install the client from. Default is
-#                 repository dependent.
+# @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::client (
   String[1] $ensure = $mongodb::client::params::package_ensure,

manifests/db.pp

@@ -1,16 +1,20 @@
-# == Class: mongodb::db
+# @summary Class for creating mongodb databases and users.
 #
-# Class for creating mongodb databases and users.
-#
-# == Parameters
-#
-#  user - Database username.
-#  auth_mechanism - Authentication mechanism. scram_sha_256 password verification is not supported. Defaults to 'scram_sha_1'.
-#  db_name - Database name. Defaults to $name.
-#  password_hash - Hashed password. Hex encoded md5 hash of "$username:mongo:$password".
-#  password - Plain text user password. This is UNSAFE, use 'password_hash' instead.
-#  roles (default: ['dbAdmin']) - array with user roles.
-#  tries (default: 10) - The maximum amount of two second tries to wait MongoDB startup.
+# @param user
+#   Database username.
+# @param
+#   auth_mechanism - Authentication mechanism. scram_sha_256 password verification is not supported. Defaults to 'scram_sha_1'.
+# @param
+#   db_name - Database name. Defaults to $name.
+# @param
+#   password_hash - Hashed password. Hex encoded md5 hash of "$username:mongo:$password".
+# @param
+#   password - Plain text user password. This is UNSAFE, use 'password_hash' instead.
+# @param
+#   roles (default: ['dbAdmin']) - array with user roles.
+# @param
+#   tries (default: 10) - The maximum amount of two second tries to wait MongoDB startup.
+# @param
 #  update_password (default: false) - Force an update of the password when scram_sha_256 is used.
 #
 define mongodb::db (

manifests/globals.pp

@@ -1,5 +1,120 @@
-# Class for setting cross-class global overrides. See README.md for more
-# details.
+# @summary Class for setting cross-class global overrides.
+#
+# @example  Use a more recent MongoDB version to install from the community repository.
+#
+#   class {'mongodb::globals':
+#     manage_package_repo => true,
+#     version             => '3.6',
+#   }
+#   -> class {'mongodb::client': }
+#   -> class {'mongodb::server': }
+#
+# @example Install MongoDB from a custom repository.
+#
+#   class {'mongodb::globals':
+#      manage_package_repo => true,
+#      repo_location       => 'http://example.com/repo'
+#   }
+#   -> class {'mongodb::server': }
+#   -> class {'mongodb::client': }
+#
+# @example To disable managing of repository, but still enable managing packages.
+#
+#   class {'mongodb::globals':
+#     manage_package_repo => false,
+#     manage_package    => true,
+#   }
+#   -> class {'mongodb::server': }
+#   -> class {'mongodb::client': }
+#
+# @param server_package_name
+#   This setting can be used to override the default MongoDB server package name.
+#   If not specified, the module will use whatever package name is the default for your OS distro.
+#
+# @param client_package_name
+#   This setting can be used to specify the name of the client package that should be installed.
+#   If not specified, the module will use whatever service name is the default for your OS distro.
+#
+# @param mongod_service_manage
+#   This setting can be used to override the default management of the mongod service.
+#   By default the module will manage the mongod process.
+# @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_name
+#   This setting can be used to override the default MongoDB service name.
+#   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 MongoDB service provider.
+#   If not specified, the module will use whatever service provider is the default for your OS distro.
+#
+# @param service_status
+#   This setting can be used to override the default status check command for your MongoDB service.
+#    If not specified, the module will use whatever service name is the default for your OS distro.
+#
+# @param user
+#   This setting can be used to override the default MongoDB user and owner of the service and related files in the file system.
+#   If not specified, the module will use the default for your OS distro.
+#
+# @param group
+#   This setting can be used to override the default MongoDB user group to be used for related files in the file system.
+#   If not specified, the module will use the default for your OS distro.
+#
+# @param ipv6
+#   This setting is used to configure MongoDB to turn on ipv6 support.
+#   If not specified and ipv6 address is passed to MongoDB bind_ip it will just fail.
+#
+# @param bind_ip
+#   This setting can be used to configure MonogDB 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.
+#   Note: This value should be passed as an array.
+#
+# @param version
+#   The version of MonogDB to install/manage. This is needed when managing repositories.
+#   If not specified, the module will use the default for your OS distro.
+#
+# @param mongosh_version
+#   The version of MonogDB-mongosh to install/manage. This package is mandatory to make this module work.
+#   If not specified, the module will use the default for your OS distro.
+#
+# @param manage_package_repo
+#   Whether to use the MongoDB software repository or the OS packages (True) or a Custom repo (False)
+#
+# @param manage_package
+#   wgether this module willm manage the mongoDB server package
+#
+# @param repo_proxy
+#   This will allow you to set a proxy for your repository in case you are behind a corporate firewall.
+#   Currently this is only supported with yum repositories
+#
+# @param proxy_username
+#   This sets the username for the proxyserver, should authentication be required.
+#
+# @param proxy_password
+#   This sets the password for the proxyserver, should authentication be required
+#
+# @param repo_location
+#   This setting can be used to override the default MongoDB repository location.
+#   If not specified, the module will use the default repository for your OS distro.
+#
+# @param use_enterprise_repo
+#   When manage_package_repo is set to true, this setting indicates if it will use the Community Edition
+#   (false, the default) or the Enterprise one (true).
+#
+# @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 pidfilemode
+#   The file mode of the pid file
+#
+# @param manage_pidfile
+#    If true, the pidfile will be managed by puppet
+#
 class mongodb::globals (
   $server_package_name   = undef,
   $client_package_name   = undef,

manifests/mongos.pp

@@ -1,4 +1,83 @@
-# This installs a Mongo Shard daemon. See README.md for more details.
+# @summary This installs a Mongo Shard daemon.
+#
+# This class should only be used if you want to implement sharding within your mongodb deployment.
+#  This class allows you to configure the mongos daemon (responsible for routing) on your platform.
+#
+# @example mongos can be installed the following way.
+#   class {'mongodb::mongos' :
+#    configdb => ['configsvr1.example.com:27018'],
+#  }
+#
+# @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 configdb
+#   Array of the config servers IP addresses the mongos should connect to.
+#
+# @param config_data
+#   Hash containing key-value pairs to allow for additional configuration options to be set in user-provided template.
+#
+# @param service_manage
+#   Whether or not the MongoDB sharding service resource should be part of the catalog.
+#
+# @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 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_template
+#   Path to the service template if the default doesn't match one needs.
+#
+# @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 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.
+#
+# @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 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 fork
+#   Set to true to fork server process at launch time. The default setting depends on the operating system.
+#
+# @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 restart
+#   Specifies whether the service should be restarted on config changes.
+#
 class mongodb::mongos (
   Stdlib::Absolutepath $config                              = $mongodb::mongos::params::config,
   Optional[String[1]] $config_content                       = $mongodb::mongos::params::config_content,

manifests/opsmanager.pp

@@ -1,16 +1,80 @@
-# This installs Ops Manager
+# @summary This installs Ops Manager
+#
+# @example To install Ops Manager and have it run with a local MongoDB application server do the following:
+#   class {'mongodb::opsmanager':
+#     opsmanager_url       => 'http://opsmanager.yourdomain.com'
+#     mongo_uri            => 'mongodb://yourmongocluster:27017,
+#     from_email_addr      => '[email protected]',
+#     reply_to_email_addr  => '[email protected]',
+#     admin_email_addr     => '[email protected]',
+#     smtp_server_hostname => 'email-relay.yourdomain.com'
+#   }
 #
 # @param user
 #   The user that owns the config file
 #
 # @param group
 #   The group that owns the config file
 #
+# @param ensure
+#   Used to ensure that the package is installed and the service is running, or that the package is absent/purged
+#   and the service is stopped.
+#
+# @param package_name
+#   his 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.
+#
+# @param package_ensure
+#   This setting can be used to specify if puppet should install the package or not.
+#
+# @param service_enable
+#   This setting can be used to specify if the service should be enable at boot.
+#
+# @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 download_url
+#   This setting can be used to override the default MongoDB Ops-Manager download location.
+#
+# @param mongo_uri
+#   Connection string to the mongod cluster.
+#
 # @param opsmanager_url
 #   The fully qualified url where opsmanager runs. Must include the port.
 #
-# @param opsmanager_mongo_uri
-#   Full URI where the Ops Manager application mongodb server(s) can be found.
+# @param client_certificate_mode
+#   Client certificate authorization mode.
+#
+# @param from_email_addr
+#   Email  address ussed as sender
+#
+# @param reply_to_email_addr
+#   Reply to email address to use
+#
+# @param admin_email_addr
+#   Adminsitrator's email address
+#
+# @param email_dao_class
+#   The email delivery agent class to use
+#
+# @param mail_transport
+#   The email transport type to use
+#
+# @param smtp_server_hostname
+#   Hostname of the email server to use.
+#
+# @param smtp_server_port
+#   email port on the email server to use.
+#
+# @param ssl
+#   Set to true to enable ssl.
+#
+# @param ignore_ui_setup
+#   Wheter to install ui or not.
 #
 # @param ca_file
 #   Ca file for secure connection to backup agents.
@@ -21,6 +85,30 @@
 # @param pem_key_password
 #   The password to the pem key file.
 #
+# @param user_svc_class
+#   The user svc class
+#   Default: com.xgen.svc.mms.svc.user.UserSvcDb
+#   External Source: com.xgen.svc.mms.svc.user.UserSvcCrowd
+#   Internal Database: com.xgen.svc.mms.svc.user.UserSvcDb
+#
+# @param snapshot_interval
+#   The snapshot interval to use
+#
+# @param snapshot_interval_retention
+#   The snapshot interval retention period
+#
+# @param snapshot_daily_retention
+#   The dayly snapshot interval retention period
+#
+# @param snapshot_weekly_retention
+#   The weekly snapshot interval retention period
+#
+# @param snapshot_monthly_retention
+#   The monthly snapshot interval retention period
+#
+# @param versions_directory
+#   The directory where to store the snapshot versions
+#
 class mongodb::opsmanager (
   String[1] $user                                = 'mongodb-mms',
   String[1] $group                               = 'mongodb-mms',

manifests/params.pp

@@ -1,4 +1,6 @@
-# PRIVATE CLASS: do not use directly
+# @summary Private class to set default values.
+#
+# @api private
 class mongodb::params inherits mongodb::globals {
   $ensure                = true
   $dbpath                = '/var/lib/mongo'