mongodb puppet module

Table of Contents

1. Overview
2. Module Description - What does the module do?
3. Setup - The basics of getting started with mongodb
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

Installs MongoDB on RHEL/Ubuntu/Debian from OS repo, or alternatively from MongoDB community/enterprise repositories.

Module Description

The MongoDB module manages mongod server installation and configuration of the mongod daemon. For the time being it supports only a single MongoDB server instance, without sharding functionality.

The MongoDB module also manages Ops Manager setup and the mongdb-mms daemon.

Setup

What MongoDB affects

• MongoDB package.
• MongoDB configuration files.
• MongoDB service.
• MongoDB client.
• MongoDB sharding support (mongos)
• MongoDB apt/yum repository.
• Ops Manager package.
• Ops Manager configuration files.

Beginning with MongoDB

If you just want a server installation with the default options you can run include mongodb::server. If you need to customize configuration options you need to do the following:

class {'mongodb::server':
  port    => 27018,
  verbose => true,
}

For Red Hat family systems, the client can be installed in a similar fashion:

class {'mongodb::client':}

Note that for Debian/Ubuntu family systems the client is installed with the server. Using the client class will by default install the server.

If one plans to configure sharding for a Mongo deployment, the module offer the mongos installation. mongos can be installed the following way :

class {'mongodb::mongos' :
  configdb => ['configsvr1.example.com:27018'],
}

Although most distros come with a prepacked MongoDB server, you may prefer to use a more recent version. To install MongoDB from the community repository:

class {'mongodb::globals':
  manage_package_repo => true,
  version             => '3.6',
}
-> class {'mongodb::client': }
-> class {'mongodb::server': }

If you don't want to use the MongoDB software repository or the OS packages, you can point the module to a custom one. To 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': }

Having a local copy of MongoDB repository (that is managed by your private modules) you can still enjoy the charms of mongodb::params that manage packages. 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': }

Usage

Most of the interaction for the server is done via mongodb::server. For more options please have a look at mongodb::server. Also in this version we introduced mongodb::globals, which is meant more for future implementation, where you can configure the main settings for this module in a global way, to be used by other classes and defined resources. On its own it does nothing.

Create MongoDB database

To install MongoDB server, create database "testdb" and user "user1" with password "pass1".

class {'mongodb::server':
  auth => true,
}

mongodb::db { 'testdb':
  user          => 'user1',
  password_hash => 'a15fbfca5e3a758be80ceaf42458bcd8',
}

Parameter 'password_hash' is hex encoded md5 hash of "user1:mongo:pass1". Unsafe plain text password could be used with 'password' parameter instead of 'password_hash'.

Ops Manager

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       => 'opsmanager@yourdomain.com',
  reply_to_email_addr   => 'replyto@yourdomain.com',
  admin_email_addr      => 'admin@yourdomain.com',
  $smtp_server_hostname => 'email-relay.yourdomain.com'
}

The default settings will not set useful email addresses. You can also just run include mongodb::opsmanager and then set the emails later.

Ops Manager Usage

Most of the interaction for the server is done via mongodb::opsmanager. For more options please have a look at mongodb::opsmanager.

Reference

Classes

Public classes

• mongodb::server: Installs and configure MongoDB
• mongodb::client: Installs the MongoDB client shell (for Red Hat family systems)
• mongodb::globals: Configure main settings in a global way
• mongodb::mongos: Installs and configure Mongos server (for sharding support)
• mongodb::opsmanager: Installs and configure Ops Manager

Private classes

• mongodb::repo: Manage MongoDB software repository
• mongodb::repo::apt: Manage Debian/Ubuntu apt MongoDB repository
• mongodb::repo::yum: Manage Redhat/CentOS yum MongoDB repository
• mongodb::server::config: Configures MongoDB configuration files
• mongodb::server::install: Install MongoDB software packages
• mongodb::server::service: Manages service
• mongodb::client::install: Installs the MongoDB client software package
• mongodb::mongos::config: Configures Mongos configuration files
• mongodb::mongos::install: Install Mongos software packages
• mongodb::mongos::service: Manages Mongos service

Class: mongodb::globals

Note: most server specific defaults should be overridden in the mongodb::server class. This class should only be used if you are using a non-standard OS or if you are changing elements such as version or manage_package_repo that can only be changed here.

This class allows you to configure the main settings for this module in a global way, to be used by the other classes and defined resources. On its own it does nothing.

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.

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.

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.

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.

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.

mongos_service_manage

This setting can be used to override the default management of the mongos service. By default the module will manage the mongos process.

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.

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.

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.

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.

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).

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.

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.

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

proxy_username

This sets the username for the proxyserver, should authentication be required

proxy_password

This sets the password for the proxyserver, should authentication be required

Class: mongodb::server

Most of the parameters manipulate the mongod.conf file.

For more details about configuration parameters consult the MongoDB Configuration File Options.

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. Valid values are true/false/present/absent/purged.

config

Path of the config file. If not specified, the module will use the default for your OS distro.

dbpath

Set this value to designate a directory for the mongod instance to store it's data. If not specified, the module will use the default for your OS distro.

dbpath_fix

Set this value to true if you want puppet to recursively manage the permissions of the files in the dbpath directory. If you are using the default dbpath, this should probably be false. Set this to true if you are using a custom dbpath. The default is false.

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.

manage_pidfile

Should puppet create the pidfile. Mondod 6.2.10 will not start if pidfile exists

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.

ipv6

This setting has to be true to configure MongoDB to turn on ipv6 support. If not specified and ipv6 address is passed to MongoDB bind_ip it will just fail.

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. Example: bind_ip=['127.0.0.1', '192.168.0.3'] Note: bind_ip accepts an array as a value.

logappend

Set to true to add new entries to the end of the logfile rather than overwriting the content of the log when the process restarts. Default: True

system_logrotate

Set to reopen for mongo to close a log file then reopen it so that logrotations handled outside of mongo perform as expected. Default: undef

fork

Set to true to fork server process at launch time. The default setting depends on the operating system.

port

Specifies a TCP port for the server instance to listen for client connections. Default: 27017

journal

Set to true to enable operation journaling to ensure write durability and data consistency. Default: on 64-bit systems true and on 32-bit systems false

nojournal

Set nojournal = true to disable durability journaling. By default, mongod enables journaling in 64-bit versions after v2.0. Default: on 64-bit systems false and on 32-bit systems true

Note: You must use journal to enable journaling on 32-bit systems.

smallfiles

Set to true to modify MongoDB to use a smaller default data file size. Specifically, smallfiles reduces the initial size for data files and limits them to 512 megabytes. Default: false

cpu

Set to true to force mongod to report every four seconds CPU utilization and the amount of time that the processor waits for I/O operations to complete (i.e. I/O wait.) Default: false

auth

Set to true to enable database authentication for users connecting from remote hosts. If no users exist, the localhost interface will continue to have access to the database until you create the first user. Default: false

noauth

Disable authentication. Currently the default. Exists for future compatibility and clarity.

verbose

Increases the amount of internal reporting returned on standard output or in the log file generated by logpath. Default: false

verbositylevel

MongoDB has the following levels of verbosity: v, vv, vvv, vvvv and vvvvv. Default: None

objcheck

Forces the mongod to validate all requests from clients upon receipt to ensure that clients never insert invalid documents into the database.

quota

Set to true to enable a maximum limit for the number of data files each database can have. The default quota is 8 data files, when quota is true. Default: false

quotafiles

Modify limit on the number of data files per database. This option requires the quota setting. Default: 8

diaglog

Creates a very verbose diagnostic log for troubleshooting and recording various errors. Valid values: 0, 1, 2, 3 and 7. For more information please refer to MongoDB Configuration File Options.

directoryperdb

Set to true to modify the storage pattern of the data directory to store each database’s files in a distinct folder. Default: false

profile

Modify this value to changes the level of database profiling, which inserts information about operation performance into output of mongod or the log file if specified by logpath.

maxconns

Specifies a value to set the maximum number of simultaneous connections that MongoDB will accept. Default: depends on system (i.e. ulimit and file descriptor) limits. Unless set, MongoDB will not limit its own connections.

oplog_size

Specifies a maximum size in megabytes for the replication operation log (e.g. oplog.) mongod creates an oplog based on the maximum amount of space available. For 64-bit systems, the oplog is typically 5% of available disk space.

nohints

Ignore query hints. Default: None

nohttpinterface

Set to true to disable the HTTP interface. This command will override the rest and disable the HTTP interface if you specify both. Default: false

noscripting

Set noscripting = true to disable the scripting engine. Default: false

notablescan

Set notablescan = true to forbid operations that require a table scan. Default: false

noprealloc

Set noprealloc = true to disable the preallocation of data files. This will shorten the start up time in some cases, but can cause significant performance penalties during normal operations. Default: false

nssize

Use this setting to control the default size for all newly created namespace files (i.e .ns). Default: 16

mms_token

MMS token for mms monitoring. Default: None

mms_name

MMS identifier for mms monitoring. Default: None

mms_interval

MMS interval for mms monitoring. Default: None

configsvr

Use this setting to enable config server mode for mongod.

shardsvr

Use this setting to enable shard server mode for mongod.

replset

Use this setting to configure replication with replica sets. Specify a replica set name as an argument to this set. All hosts must have the same set name.

replset_members

An array of member hosts for the replica set. Mutually exclusive with replset_config param.

replset_config

A hash that is used to configure the replica set. Mutually exclusive with replset_members param.

class mongodb::server {
  replset        => 'rsmain',
  replset_config => { 'rsmain' => { ensure  => present, settings => { heartbeatTimeoutSecs => 15, getLastErrorModes => { ttmode => { dc => 1 } } }, members => [{'host'=>'host1:27017', 'tags':{ 'dc' : 'east'}}, { 'host' => 'host2:27017'}, 'host3:27017']  }  }

}

config_data

A hash to allow for additional configuration options to be set in user-provided template.

rest

Set to true to enable a simple REST interface. Default: false

quiet

Runs the mongod or mongos instance in a quiet mode that attempts to limit the amount of output. This option suppresses : "output from database commands, including drop, dropIndexes, diagLogging, validate, and clean", "replication activity", "connection accepted events" and "connection closed events". Default: false

For production systems this option is not recommended as it may make tracking problems during particular connections much more difficult.

slowms

Sets the threshold for mongod to consider a query “slow” for the database profiler. Default: 100 ms

keyfile

Specify the path to a key file to store authentication information. This option is only useful for the connection between replica set members. Default: None

key

Specify the key contained within the keyfile. This option is only useful for the connection between replica set members. Default: None

master

Set to true to configure the current instance to act as master instance in a replication configuration. Default: False Note: deprecated – use replica sets

set_parameter

Specify extra configuration file parameters (i.e. textSearchEnabled=true). Default: None

syslog

Sends all logging output to the host’s syslog system rather than to standard output or a log file. Default: None Important: You cannot use syslog with logpath. Set logpath to false to disable it.

slave

Set to true to configure the current instance to act as slave instance in a replication configuration. Default: false Note: deprecated – use replica sets

only

Used with the slave option, only specifies only a single database to replicate. Default: <> Note: deprecated – use replica sets

source

Used with the slave setting to specify the master instance from which this slave instance will replicate. Default: <> Note: deprecated – use replica sets

ssl

Set to true to enable ssl. Default: <> Important: You need to have ssl_key set as well, and the file needs to pre-exist on node. If you wish to use certificate validation, ssl_ca must also be set.

ssl_key

Default: <>

ssl_ca

Default: <>

ssl_weak_cert

Set to true to disable mandatory SSL client authentication Default: False

ssl_invalid_hostnames

Set to true to disable fqdn SSL cert check Default: False

ssl_mode

Ssl authorization mode. Valid options are: requireSSL, preferSSL, allowSSL. Default: requireSSL

tls

Set to true to enable tls. Default: <> Important: You need to have tls_key set as well, and the file needs to pre-exist on node. If you wish to use certificate validation, tls_ca must also be set.

tls_key

Default: <>

tls_ca

Default: <>

tls_conn_without_cert

Set to true to disable mandatory TLS client authentication Default: False

tls_invalid_hostnames

Set to true to disable fqdn TLS cert check Default: False

tls_mode

Tls authorization mode. Valid options are: requireTLS, preferTLS, allowTLS. Default: requireTLS

service_manage

Whether or not the MongoDB service resource should be part of the catalog. Default: true

storage_engine

Only needed for MongoDB 3.x versions, where it's possible to select the 'wiredTiger' engine in addition to the default 'mmapv1' engine. If not set, the config is left out and mongo will default to 'mmapv1'. You should not set this for MongoDB versions < 3.x

restart

Specifies whether the service should be restarted on config changes. Default: 'true'

create_admin

Allows to create admin user for admin database. Redefine these parameters if needed:

admin_username

Administrator user name

admin_password

Administrator user password

admin_auth_mechanism

Administrator authentication mechanism. scram_sha_256 password synchronization verification is not supported. Default: 'scram_sha_1'

admin_update_password

Update password. Used with SCRAM-SHA-256 because password verification is not supported. Default: false

admin_roles

Administrator user roles

store_creds

Store admin credentials in mongorc.js file. Uses with create_admin parameter

handle_creds

Set this to false to avoid having puppet handle .mongorc.js in case you wish to deliver it by other means. This is needed for facts to work if you have auth set to true. Default is true.

Class: mongodb::mongos

class. 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.

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. Valid values are true/false/present/absent/purged.

config

Path of the config file. If not specified, the module will use the default for your OS distro.

config_content

Config content if the default doesn't match one needs.

config_template

Path to the config template if the default doesn't match one needs.

config_data

Hash containing key-value pairs to allow for additional configuration options to be set in user-provided template.

configdb

Array of the config servers IP addresses the mongos should connect to.

service_manage

Whether or not the MongoDB sharding service resource should be part of the catalog. Default: true

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.

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.

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.

service_enable

This setting can be used to specify if the service should be enable at boot

service_ensure

This setting can be used to specify if the service should be running

package_ensure

This setting can be used to specify if puppet should install the package or not

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.

restart

Specifies whether the service should be restarted on config changes. Default: 'true'

Definitions

Definition: mongodb:db

Creates database with user. Resource title used as database name.

user

Name of the user for database

password_hash

Hex encoded md5 hash of "$username:mongo:$password". For more information please refer to MongoDB Authentication Process.

password

Plain-text user password (will be hashed)

auth_mechanism

Authentication mechanism. Can be either 'scram_sha_1' or 'scram_sha_256'. scram_sha_256 password synchronization verification is not supported. Default: 'scram_sha_1'

update_password

Update password. Used with SCRAM-SHA-256 because password verification is not supported. Default: false

roles

Array with user roles as string. Roles will be granted to user's database if no alternative database is explicitly defined. Example: ['dbAdmin', 'readWrite@other_database'] Default: ['dbAdmin']

Providers

Provider: mongodb_database

'mongodb_database' can be used to create and manage databases within MongoDB.

mongodb_database { testdb:
  ensure   => present,
  tries    => 10,
  require  => Class['mongodb::server'],
}

tries

The maximum amount of two second tries to wait MongoDB startup. Default: 10

Provider: mongodb_user

'mongodb_user' can be used to create and manage users within MongoDB database.

Note: if replica set is enabled, replica initialization has to come before any user operations.

mongodb_user { testuser:
  name          => 'testuser',
  ensure        => present,
  password_hash => mongodb_password('testuser', 'p@ssw0rd'),
  database      => testdb,
  roles         => ['readWrite', 'dbAdmin'],
  tries         => 10,
  require       => Class['mongodb::server'],
}

username

Name of the mongodb user.

password_hash

Hex encoded md5 hash of "$username:mongo:$password". Only available on MongoDB 3.0 and later.

password

Plaintext password of the user.

database

Name of database. It will be created, if not exists.

roles

Array with user roles as string. Roles will be granted to user's database if no alternative database is explicitly defined. Example: ['dbAdmin', 'readWrite@other_database'] Default: ['dbAdmin']

tries

The maximum amount of two second tries to wait MongoDB startup. Default: 10

Provider: mongodb_replset

'mongodb_replset' can be used to create and manage MongoDB replicasets.

mongodb_replset { rsmain:
  ensure  => present,
  members => ['host1:27017', 'host2:27017', 'host3:27017']
}

Ideally the mongodb_replset resource will be declared on the initial desired primary node (arbitrarily the first of the list) and this node will be processed once the secondary nodes are up. This will ensure all the nodes are in the first configuration of the replicaset, else it will require running puppet again to add them.

members

Array of 'host:port' of the replicaset members.

It currently only adds members without options.

Provider: mongodb_shard

'mongodb_shard' can be used to create and manage MongoDB shards. Note: Removing a shard is not yet supported. Shard can only be added.

mongodb_shard { 'rsmain':
  member => 'rsmain/host1:27017',
  keys   => [{'rsmain.foo' => {'name' => 1}}],
}

member

Member of the shard in the form;

• [hostname]
• [hostname]:[port]
• [replica-set-name]/[hostname]
• [replica-set-name]/[hostname]:port

keys

Sharding keys for a specific database. This variable should be an array of sharding keys.

Limitations

This module has been tested on:

• Debian 7.* (Wheezy)
• Debian 6.* (squeeze)
• Ubuntu 12.04.2 (precise)
• Ubuntu 10.04.4 LTS (lucid)
• RHEL 5/6/7
• CentOS 5/6/7

For a full list of tested operating systems please have a look at the .nodeset.xml definition.

This module should support service_ensure separate from the ensure value on Class[mongodb::server] but it does not yet.

Apt module support

While this module supports both 1.x and 2.x versions of the puppetlabs-apt module, it does not support puppetlabs-apt 2.0.0 or 2.0.1.

Development

This module is maintained by Vox Pupuli. Voxpupuli welcomes new contributions to this module, especially those that include documentation and rspec tests. We are happy to provide guidance if necessary.

Please see CONTRIBUTING for more details.

Authors

• Puppetlabs Module Team
• Voxpupuli Team

We would like to thank everyone who has contributed issues and pull requests to this module. A complete list of contributors can be found on the GitHub Contributor Graph for the puppet-mongodb module.

Reference

Table of Contents

Classes

Public Classes

• mongodb::client: Class for installing a MongoDB client shell (CLI). == Parameters $ensure:: Desired ensure state of the package. $package_name:: Name of th
• mongodb::globals: Class for setting cross-class global overrides. See README.md for more details.
• mongodb::mongos: This installs a Mongo Shard daemon. See README.md for more details.
• mongodb::mongos::config: PRIVATE CLASS: do not call directly
• mongodb::mongos::install: PRIVATE CLASS: do not call directly
• mongodb::mongos::params: PRIVATE CLASS: do not use directly
• mongodb::mongos::service: PRIVATE CLASS: do not call directly
• mongodb::opsmanager: This installs Ops Manager
• mongodb::params: PRIVATE CLASS: do not use directly
• mongodb::replset: Wrapper class useful for hiera based deployments
• mongodb::repo: PRIVATE CLASS: do not use directly
• mongodb::repo::apt: PRIVATE CLASS: do not use directly
• mongodb::repo::yum: PRIVATE CLASS: do not use directly
• mongodb::server: This installs a MongoDB server. See README.md for more details.
• mongodb::server::config: PRIVATE CLASS: do not call directly
• mongodb::server::install: PRIVATE CLASS: do not call directly
• mongodb::server::service: PRIVATE CLASS: do not call directly
• mongodb::shardsvr: Wrapper class useful for hiera based deployments

Private Classes

• mongodb::client::params
• mongodb::repo::zypper: This is a repo class for zypper

Defined types

• mongodb::db: == Class: mongodb::db Class for creating mongodb databases and users. == Parameters user - Database username. auth_mechanism - Authentic

Resource types

• mongodb_conn_validator: Verify that a connection can be successfully established between a node and the mongodb server. Its primary use is as a precondition to prev
• mongodb_database: Manage MongoDB databases.
• mongodb_replset: Manage a MongoDB replicaSet
• mongodb_shard: Manage a MongoDB Shard
• mongodb_user: Manage a MongoDB user. This includes management of users password as well as privileges.

Functions

• mongodb_password: Get the mongodb password hash from the clear text password.

Classes

mongodb::client

Class for installing a MongoDB client shell (CLI).

== Parameters

$ensure:: Desired ensure state of the package.

$package_name:: Name of the package to install the client from. Default is repository dependent.

Parameters

The following parameters are available in the mongodb::client class:

• ensure
• package_name

ensure

Data type: String[1]

Default value: $mongodb::client::params::package_ensure

package_name

Data type: String[1]

Default value: $mongodb::client::params::package_name

mongodb::globals

Class for setting cross-class global overrides. See README.md for more details.

Parameters

The following parameters are available in the mongodb::globals class:

• server_package_name
• client_package_name
• mongod_service_manage
• service_enable
• service_ensure
• service_name
• service_provider
• service_status
• user
• group
• ipv6
• bind_ip
• version
• manage_package_repo
• manage_package
• repo_proxy
• proxy_username
• proxy_password
• repo_location
• use_enterprise_repo
• pidfilepath
• pidfilemode
• manage_pidfile

server_package_name

Data type: Any

Default value: undef

client_package_name

Data type: Any

Default value: undef

mongod_service_manage

Data type: Any

Default value: undef

service_enable

Data type: Any

Default value: undef

service_ensure

Data type: Any

Default value: undef

service_name

Data type: Any

Default value: undef

service_provider

Data type: Any

Default value: undef

service_status

Data type: Any

Default value: undef

user

Data type: Any

Default value: undef

group

Data type: Any

Default value: undef

ipv6

Data type: Any

Default value: undef

bind_ip

Data type: Any

Default value: undef

version

Data type: Any

Default value:

fact('os.distro.codename') ? { # Debian 10 doesn't provide mongodb 3.6.
    'buster' => '4.4.8',
    default  => undef

manage_package_repo

Data type: Any

Default value:

fact('os.distro.codename') ? { # Debian 10 doesn't provide mongodb packages. So manage it!
    'buster' => true,
    default  => undef

manage_package

Data type: Any

Default value: undef

repo_proxy

Data type: Any

Default value: undef

proxy_username

Data type: Any

Default value: undef

proxy_password

Data type: Any

Default value: undef

repo_location

Data type: Any

Default value: undef

use_enterprise_repo

Data type: Any

Default value: undef

pidfilepath

Data type: Any

Default value: undef

pidfilemode

Data type: Any

Default value: undef

manage_pidfile

Data type: Any

Default value: undef

mongodb::mongos

This installs a Mongo Shard daemon. See README.md for more details.

Parameters

The following parameters are available in the mongodb::mongos class:

• config
• config_content
• config_template
• configdb
• config_data
• service_manage
• service_provider
• service_name
• service_template
• service_enable
• service_ensure
• service_status
• package_ensure
• package_name
• unixsocketprefix
• pidfilepath
• logpath
• fork
• bind_ip
• port
• restart

config

Data type: Stdlib::Absolutepath

Default value: $mongodb::mongos::params::config

config_content

Data type: Optional[String[1]]

Default value: $mongodb::mongos::params::config_content

config_template

Data type: Optional[String[1]]

Default value: $mongodb::mongos::params::config_template

configdb

Data type: Variant[String[1], Array[String[1]]]

Default value: $mongodb::mongos::params::configdb

config_data

Data type: Optional[Hash]

Default value: $mongodb::mongos::params::config_data

service_manage

Data type: Boolean

Default value: $mongodb::mongos::params::service_manage

service_provider

Data type: Optional[String]

Default value: $mongodb::mongos::params::service_provider

service_name

Data type: Optional[String]

Default value: $mongodb::mongos::params::service_name

service_template

Data type: Optional[String[1]]

Default value: $mongodb::mongos::params::service_template

service_enable

Data type: Boolean

Default value: $mongodb::mongos::params::service_enable

service_ensure

Data type: Stdlib::Ensure::Service

Default value: $mongodb::mongos::params::service_ensure

service_status

Data type: Optional[String]

Default value: $mongodb::mongos::params::service_status

package_ensure

Data type: Variant[Boolean, String]

Default value: $mongodb::mongos::params::package_ensure

package_name

Data type: String

Default value: $mongodb::mongos::params::package_name

unixsocketprefix

Data type: Optional[Stdlib::Absolutepath]

Default value: $mongodb::mongos::params::unixsocketprefix

pidfilepath

Data type: Optional[Stdlib::Absolutepath]

Default value: $mongodb::mongos::params::pidfilepath

logpath

Data type: Optional[Variant[Boolean, Stdlib::Absolutepath]]

Default value: $mongodb::mongos::params::logpath

fork

Data type: Optional[Boolean]

Default value: $mongodb::mongos::params::fork

bind_ip

Data type: Optional[Array[Stdlib::IP::Address]]

Default value: $mongodb::mongos::params::bind_ip

port

Data type: Optional[Stdlib::Port]

Default value: $mongodb::mongos::params::port

restart

Data type: Boolean

Default value: $mongodb::mongos::params::restart

mongodb::mongos::config

PRIVATE CLASS: do not call directly

Parameters

The following parameters are available in the mongodb::mongos::config class:

• package_ensure
• config
• config_content
• config_template
• service_manage
• configdb
• bind_ip
• port
• fork
• pidfilepath
• logpath
• unixsocketprefix
• config_data

package_ensure

Data type: Any

Default value: $mongodb::mongos::package_ensure

config

Data type: Any

Default value: $mongodb::mongos::config

config_content

Data type: Any

Default value: $mongodb::mongos::config_content

config_template

Data type: Any

Default value: $mongodb::mongos::config_template

service_manage

Data type: Any

Default value: $mongodb::mongos::service_manage

configdb

Data type: Any

Default value: $mongodb::mongos::configdb

bind_ip

Data type: Any

Default value: $mongodb::mongos::bind_ip

port

Data type: Any

Default value: $mongodb::mongos::port

fork

Data type: Any

Default value: $mongodb::mongos::fork

pidfilepath

Data type: Any

Default value: $mongodb::mongos::pidfilepath

logpath

Data type: Any

Default value: $mongodb::mongos::logpath

unixsocketprefix

Data type: Any

Default value: $mongodb::mongos::unixsocketprefix

config_data

Data type: Any

Default value: $mongodb::mongos::config_data

mongodb::mongos::install

PRIVATE CLASS: do not call directly

Parameters

The following parameters are available in the mongodb::mongos::install class:

• package_ensure
• package_name

package_ensure

Data type: Any

Default value: $mongodb::mongos::package_ensure

package_name

Data type: Any

Default value: $mongodb::mongos::package_name

mongodb::mongos::params

PRIVATE CLASS: do not use directly

mongodb::mongos::service

PRIVATE CLASS: do not call directly

Parameters

The following parameters are available in the mongodb::mongos::service class:

• package_ensure
• service_manage
• service_name
• service_enable
• service_ensure
• service_status
• service_provider
• bind_ip
• port
• service_template

package_ensure

Data type: Any

Default value: $mongodb::mongos::package_ensure

service_manage

Data type: Any

Default value: $mongodb::mongos::service_manage

service_name

Data type: Any

Default value: $mongodb::mongos::service_name

service_enable

Data type: Any

Default value: $mongodb::mongos::service_enable

service_ensure

Data type: Any

Default value: $mongodb::mongos::service_ensure

service_status

Data type: Any

Default value: $mongodb::mongos::service_status

service_provider

Data type: Any

Default value: $mongodb::mongos::service_provider

bind_ip

Data type: Any

Default value: $mongodb::mongos::bind_ip

port

Data type: Any

Default value: $mongodb::mongos::port

service_template

Data type: Any

Default value: $mongodb::mongos::service_template

mongodb::opsmanager

This installs Ops Manager

Parameters

The following parameters are available in the mongodb::opsmanager class:

• user
• group
• opsmanager_url
• opsmanager_mongo_uri
• ca_file
• pem_key_file
• pem_key_password
• ensure
• package_name
• package_ensure
• service_enable
• service_manage
• service_name
• download_url
• mongo_uri
• client_certificate_mode
• from_email_addr
• reply_to_email_addr
• admin_email_addr
• email_dao_class
• mail_transport
• smtp_server_hostname
• smtp_server_port
• ssl
• ignore_ui_setup
• user_svc_class
• snapshot_interval
• snapshot_interval_retention
• snapshot_daily_retention
• snapshot_weekly_retention
• snapshot_monthly_retention
• versions_directory

user

Data type: String[1]

The user that owns the config file

Default value: 'mongodb-mms'

group

Data type: String[1]

The group that owns the config file

Default value: 'mongodb-mms'

opsmanager_url

Data type: Stdlib::Httpurl

The fully qualified url where opsmanager runs. Must include the port.

Default value: "http://${facts['networking']['fqdn']}:8080"

opsmanager_mongo_uri

Full URI where the Ops Manager application mongodb server(s) can be found.

ca_file

Data type: Optional[String[1]]

Ca file for secure connection to backup agents.

Default value: undef

pem_key_file

Data type: Optional[String[1]]

Pem key file containing the cert and private key used for secure connections to backup agents.

Default value: undef

pem_key_password

Data type: Optional[String[1]]

The password to the pem key file.

Default value: undef

ensure

Data type: Enum['running', 'stopped']

Default value: 'running'

package_name

Data type: String[1]

Default value: 'mongodb-mms'

package_ensure

Data type: String[1]

Default value: 'present'

service_enable

Data type: Boolean

Default value: true

service_manage

Data type: Boolean

Default value: true

service_name

Data type: String[1]

Default value: 'mongodb-mms'

download_url

Data type: Stdlib::Httpurl

Default value: 'https://downloads.mongodb.com/on-prem-mms/rpm/mongodb-mms-4.0.1.50101.20180801T1117Z-1.x86_64.rpm'

mongo_uri

Data type: String[1]

Default value: 'mongodb://127.0.0.1:27017'

client_certificate_mode

Data type: String[1]

Default value: 'None'

from_email_addr

Data type: String[1]

Default value: 'from@example.com'

reply_to_email_addr

Data type: String[1]

Default value: 'reply-to@example.com'

admin_email_addr

Data type: String[1]

Default value: 'admin@example.com'

email_dao_class

Data type: String[1]

Default value: 'com.xgen.svc.core.dao.email.JavaEmailDao'

mail_transport

Data type: Enum['smtp','smtps']

Default value: 'smtp'

smtp_server_hostname

Data type: Stdlib::Host

Default value: 'smtp.example.com'

smtp_server_port

Data type: Stdlib::Port

Default value: 25

ssl

Data type: Boolean

Default value: false

ignore_ui_setup

Data type: Boolean

Default value: true

user_svc_class

Data type: Optional[String[1]]

Default value: undef

snapshot_interval

Data type: Optional[Integer]

Default value: undef

snapshot_interval_retention

Data type: Optional[Integer]

Default value: undef

snapshot_daily_retention

Data type: Optional[Integer]

Default value: undef

snapshot_weekly_retention

Data type: Optional[Integer]

Default value: undef

snapshot_monthly_retention

Data type: Optional[Integer]

Default value: undef

versions_directory

Data type: Optional[Integer]

Default value: undef

mongodb::params

PRIVATE CLASS: do not use directly

mongodb::replset

Wrapper class useful for hiera based deployments

Parameters

The following parameters are available in the mongodb::replset class:

• sets

sets

Data type: Any

Default value: undef

mongodb::repo

PRIVATE CLASS: do not use directly

Parameters

The following parameters are available in the mongodb::repo class:

• ensure
• version
• use_enterprise_repo
• repo_location
• proxy
• proxy_username
• proxy_password
• aptkey_options

ensure

Data type: Variant[Enum['present', 'absent'], Boolean]

Default value: 'present'

version

Data type: Optional[String]

Default value: undef

use_enterprise_repo

Data type: Boolean

Default value: false

repo_location

Data type: Optional[String]

Default value: undef

proxy

Data type: Optional[String]

Default value: undef

proxy_username

Data type: Optional[String]

Default value: undef

proxy_password

Data type: Optional[String]

Default value: undef

aptkey_options

Data type: Optional[String[1]]

Default value: undef

mongodb::repo::apt

PRIVATE CLASS: do not use directly

mongodb::repo::yum

PRIVATE CLASS: do not use directly

mongodb::server

This installs a MongoDB server. See README.md for more details.

Parameters

The following parameters are available in the mongodb::server class:

• tls
• tls_key
• tls_ca
• tls_conn_without_cert
• tls_invalid_hostnames
• tls_mode
• ensure
• user
• group
• config
• dbpath
• dbpath_fix
• pidfilepath
• pidfilemode
• manage_pidfile
• rcfile
• service_manage
• service_provider
• service_name
• service_enable
• service_ensure
• service_status
• package_ensure
• package_name
• logpath
• bind_ip
• ipv6
• logappend
• system_logrotate
• fork
• port
• journal
• nojournal
• smallfiles
• cpu
• auth
• noauth
• verbose
• verbositylevel
• objcheck
• quota
• quotafiles
• diaglog
• directoryperdb
• profile
• maxconns
• oplog_size
• nohints
• nohttpinterface
• noscripting
• notablescan
• noprealloc
• nssize
• mms_token
• mms_name
• mms_interval
• replset
• replset_config
• replset_members
• configsvr
• shardsvr
• rest
• quiet
• slowms
• keyfile
• key
• set_parameter
• syslog
• config_content
• config_template
• config_data
• ssl
• ssl_key
• ssl_ca
• ssl_weak_cert
• ssl_invalid_hostnames
• ssl_mode
• restart
• storage_engine
• create_admin
• admin_username
• admin_password
• admin_auth_mechanism
• admin_update_password
• handle_creds
• store_creds
• admin_roles

tls

Data type: Boolean

Ensure tls is enabled.

Default value: false

tls_key

Data type: Optional[Stdlib::Absolutepath]

Defines the path of the file that contains the TLS/SSL certificate and key.

Default value: undef

tls_ca

Data type: Optional[Stdlib::Absolutepath]

Defines the path of the file that contains the certificate chain for verifying client certificates.

Default value: undef

tls_conn_without_cert

Data type: Boolean

Set to true to bypass client certificate validation for clients that do not present a certificate.

Default value: false

tls_invalid_hostnames

Data type: Boolean

Set to true to disable the validation of the hostnames in TLS certificates.

Default value: false

tls_mode

Data type: Enum['requireTLS', 'preferTLS', 'allowTLS']

Defines if TLS is used for all network connections. Allowed values are 'requireTLS', 'preferTLS' or 'allowTLS'.

Default value: 'requireTLS'

ensure

Data type: Variant[Boolean, String]

Default value: $mongodb::params::ensure

user

Data type: String

Default value: $mongodb::params::user

group

Data type: String

Default value: $mongodb::params::group

config

Data type: Stdlib::Absolutepath

Default value: $mongodb::params::config

dbpath

Data type: Stdlib::Absolutepath

Default value: $mongodb::params::dbpath

dbpath_fix

Data type: Boolean

Default value: $mongodb::params::dbpath_fix

pidfilepath

Data type: Optional[Stdlib::Absolutepath]

Default value: $mongodb::params::pidfilepath

pidfilemode

Data type: String

Default value: $mongodb::params::pidfilemode

manage_pidfile

Data type: Boolean

Default value: $mongodb::params::manage_pidfile

rcfile

Data type: String

Default value: $mongodb::params::rcfile

service_manage

Data type: Boolean

Default value: $mongodb::params::service_manage

service_provider

Data type: Optional[String]

Default value: $mongodb::params::service_provider

service_name

Data type: Optional[String]

Default value: $mongodb::params::service_name

service_enable

Data type: Boolean

Default value: $mongodb::params::service_enable

service_ensure

Data type: Enum['stopped', 'running']

Default value: $mongodb::params::service_ensure

service_status

Data type: Optional[Enum['stopped', 'running']]

Default value: $mongodb::params::service_status

package_ensure

Data type: Variant[Boolean, String]

Default value: $mongodb::params::package_ensure

package_name

Data type: String

Default value: $mongodb::params::server_package_name

logpath

Data type: Variant[Boolean, Stdlib::Absolutepath]

Default value: $mongodb::params::logpath

bind_ip

Data type: Array[Stdlib::IP::Address]

Default value: $mongodb::params::bind_ip

ipv6

Data type: Optional[Boolean]

Default value: undef

logappend

Data type: Boolean

Default value: true

system_logrotate

Data type: Optional[String]

Default value: undef

fork

Data type: Optional[Boolean]

Default value: $mongodb::params::fork

port

Data type: Optional[Integer[1, 65535]]

Default value: undef

journal

Data type: Optional[Boolean]

Default value: $mongodb::params::journal

nojournal

Data type: Optional[Boolean]

Default value: undef

smallfiles

Data type: Optional[Boolean]

Default value: undef

cpu

Data type: Optional[Boolean]

Default value: undef

auth

Data type: Boolean

Default value: false

noauth

Data type: Optional[Boolean]

Default value: undef

verbose

Data type: Optional[Boolean]

Default value: undef

verbositylevel

Data type: Optional[String]

Default value: undef

objcheck

Data type: Optional[Boolean]

Default value: undef

quota

Data type: Optional[Boolean]

Default value: undef

quotafiles

Data type: Optional[Integer]

Default value: undef

diaglog

Data type: Optional[Integer[0, 7]]

Default value: undef

directoryperdb

Data type: Optional[Boolean]

Default value: undef

profile

Data type: Any

Default value: undef

maxconns

Data type: Optional[Integer]

Default value: undef

oplog_size

Data type: Optional[Integer]

Default value: undef

nohints

Data type: Any

Default value: undef

nohttpinterface

Data type: Optional[Boolean]

Default value: undef

noscripting

Data type: Optional[Boolean]

Default value: undef

notablescan

Data type: Optional[Boolean]

Default value: undef

noprealloc

Data type: Optional[Boolean]

Default value: undef

nssize

Data type: Optional[Integer]

Default value: undef

mms_token

Data type: Any

Default value: undef

mms_name

Data type: Any

Default value: undef

mms_interval

Data type: Any

Default value: undef

replset

Data type: Optional[String]

Default value: undef

replset_config

Data type: Optional[Hash]

Default value: undef

replset_members

Data type: Optional[Array]

Default value: undef

configsvr

Data type: Optional[Boolean]

Default value: undef

shardsvr

Data type: Optional[Boolean]

Default value: undef

rest

Data type: Optional[Boolean]

Default value: undef

quiet

Data type: Optional[Boolean]

Default value: undef

slowms

Data type: Optional[Integer]

Default value: undef

keyfile

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

key

Data type: Optional[Variant[String[6], Sensitive[String[6]]]]

Default value: undef

set_parameter

Data type: Optional[Variant[String[1], Array[String[1]]]]

Default value: undef

syslog

Data type: Optional[Boolean]

Default value: undef

config_content

Data type: Any

Default value: undef

config_template

Data type: Optional[String]

Default value: undef

config_data

Data type: Optional[Hash]

Default value: undef

ssl

Data type: Optional[Boolean]

Default value: undef

ssl_key

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

ssl_ca

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

ssl_weak_cert

Data type: Boolean

Default value: false

ssl_invalid_hostnames

Data type: Boolean

Default value: false

ssl_mode

Data type: Enum['requireSSL', 'preferSSL', 'allowSSL']

Default value: 'requireSSL'

restart

Data type: Boolean

Default value: $mongodb::params::restart

storage_engine

Data type: Optional[String]

Default value: undef

create_admin

Data type: Boolean

Default value: $mongodb::params::create_admin

admin_username

Data type: String

Default value: $mongodb::params::admin_username

admin_password

Data type: Optional[Variant[String, Sensitive[String]]]

Default value: undef

admin_auth_mechanism

Data type: Enum['scram_sha_1', 'scram_sha_256']

Default value: $mongodb::params::admin_auth_mechanism

admin_update_password

Data type: Boolean

Default value: false

handle_creds

Data type: Boolean

Default value: $mongodb::params::handle_creds

store_creds

Data type: Boolean

Default value: $mongodb::params::store_creds

admin_roles

Data type: Array

Default value: $mongodb::params::admin_roles

mongodb::server::config

PRIVATE CLASS: do not call directly

mongodb::server::install

PRIVATE CLASS: do not call directly

mongodb::server::service

PRIVATE CLASS: do not call directly

mongodb::shardsvr

Wrapper class useful for hiera based deployments

Parameters

The following parameters are available in the mongodb::shardsvr class:

• shards

shards

Data type: Any

Default value: undef

Defined types

mongodb::db

== Class: mongodb::db

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. update_password (default: false) - Force an update of the password when scram_sha_256 is used.

Parameters

The following parameters are available in the mongodb::db defined type:

• user
• auth_mechanism
• db_name
• password_hash
• password
• roles
• tries
• update_password

user

Data type: String

auth_mechanism

Data type: Enum['scram_sha_1', 'scram_sha_256']

Default value: 'scram_sha_1'

db_name

Data type: String

Default value: $name

password_hash

Data type: Optional[Variant[String[1], Sensitive[String[1]]]]

Default value: undef

password

Data type: Optional[Variant[String[1], Sensitive[String[1]]]]

Default value: undef

roles

Data type: Array[String]

Default value: ['dbAdmin']

tries

Data type: Integer[0]

Default value: 10

update_password

Data type: Boolean

Default value: false

Resource types

mongodb_conn_validator

Verify that a connection can be successfully established between a node and the mongodb server. Its primary use is as a precondition to prevent configuration changes from being applied if the mongodb server cannot be reached, but it could potentially be used for other purposes such as monitoring.

Properties

The following properties are available in the mongodb_conn_validator type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the mongodb_conn_validator type.

• name
• port
• provider
• server
• timeout

name

namevar

An arbitrary name used as the identity of the resource. It can also be the connection string to test (ie. 127.0.0.1:27017)

port

The port that the mongodb server should be listening on.

Default value: 27017

provider

The specific backend to use for this mongodb_conn_validator resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

server

An array containing DNS names or IP addresses of the server where mongodb should be running.

Default value: 127.0.0.1

timeout

The max number of seconds that the validator should wait before giving up and deciding that puppetdb is not running; defaults to 60 seconds.

Default value: 60

mongodb_database

Manage MongoDB databases.

Properties

The following properties are available in the mongodb_database type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the mongodb_database type.

• name
• provider
• tries

name

Valid values: %r{^[\w-]+$}

namevar

The name of the database.

provider

The specific backend to use for this mongodb_database resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

tries

Valid values: %r{^\d+$}

The maximum amount of two second tries to wait MongoDB startup.

Default value: 10

mongodb_replset

Manage a MongoDB replicaSet

Properties

The following properties are available in the mongodb_replset type.

ensure

Valid values: present

The basic property that the resource should be in.

Default value: present

members

The replicaSet members config

settings

The replicaSet settings config

Parameters

The following parameters are available in the mongodb_replset type.

• arbiter
• initialize_host
• name
• provider

arbiter

The replicaSet arbiter

initialize_host

Host to use for Replicaset initialization

Default value: 127.0.0.1

name

namevar

The name of the replicaSet

provider

The specific backend to use for this mongodb_replset resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

mongodb_shard

Manage a MongoDB Shard

Properties

The following properties are available in the mongodb_shard type.

ensure

Valid values: present

The basic property that the resource should be in.

Default value: present

keys

The sharding keys

member

The shard member

Parameters

The following parameters are available in the mongodb_shard type.

• name
• provider

name

namevar

The name of the shard

provider

The specific backend to use for this mongodb_shard resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

mongodb_user

Manage a MongoDB user. This includes management of users password as well as privileges.

Properties

The following properties are available in the mongodb_user type.

database

Valid values: %r{^[\w-]+$}

The user's target database.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

password

The plaintext password of the user.

password_hash

Valid values: %r{^\w+$}

The password hash of the user. Use mongodb_password() for creating hash. Only available on MongoDB 3.0 and later. SCRAM-SHA-256 authentication mechanism is not supported.

roles

Valid values: %r{^\w+(@\w+)?$}

The user's roles.

Default value: ['dbAdmin']

scram_credentials

The SCRAM-SHA-1 credentials of a user. These are read only and change when password or password_hash changes.

username

The name of the user.

Parameters

The following parameters are available in the mongodb_user type.

• auth_mechanism
• name
• provider
• tries
• update_password

auth_mechanism

Valid values: scram_sha_256, scram_sha_1

Authentication mechanism. Password verification is not supported with SCRAM-SHA-256.

Default value: scram_sha_1

name

namevar

The name of the resource.

provider

The specific backend to use for this mongodb_user resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

tries

Valid values: %r{^\d+$}

The maximum amount of two second tries to wait MongoDB startup.

Default value: 10

update_password

Update password. Used with SCRAM-SHA-256 because password verification is not supported.

Default value: false

Functions

mongodb_password

Type: Ruby 4.x API

Get the mongodb password hash from the clear text password.

mongodb_password(String[1] $username, Variant[String[1], Sensitive[String[1]]] $password, Optional[Boolean] $sensitive)

Get the mongodb password hash from the clear text password.

Returns: Variant[String, Sensitive[String]]

username

Data type: String[1]

password

Data type: Variant[String[1], Sensitive[String[1]]]

sensitive

Data type: Optional[Boolean]

Changelog

All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.

v4.2.0 (2022-12-07)

Full Changelog

Implemented enhancements:

• Add TLS options #645 (poloz-lab)
• SCRAM-SHA-256 support #643 (poloz-lab)

Fixed bugs:

• Auth in mongod 3.6 #437
• mongodb_user ignores database parameter when removing a user #644 (SeanHood)
• Fix ReplicaSet with Auth creation (new error message to handle) #632 (BDelacour)

v4.1.1 (2022-03-12)

Full Changelog

Fixed bugs:

• Do not manage the repository on RedHat when manage_package_repo is set to false #637 (fe80)

Closed issues:

• mongodb::repo is always include for some family #636

v4.1.0 (2021-10-28)

Full Changelog

Implemented enhancements:

• Add support for Suse Linux #624 (fbrehm)
• Add mongo 5.0 debian / ubuntu apt key #615 (xepa)

Fixed bugs:

• Run apt update before installing package #628 (malcyon)

Closed issues:

• Fails to install on Ubuntu 20.04 #627
• Missing key for Apt for installing 5.0 mongo #614
• Error: Could not prefetch mongodb_replset provider 'mongo': 765: unexpected token at 'WARNING: ) is deprecated and may be removed in the next major release. Please use secondaryOk() #612
• 4.x version. Initialization of replset and user creation problem. #583

v4.0.0 (2021-09-03)

Full Changelog

Breaking changes:

• Drop Puppet 5/Add puppet 7 support #617 (root-expert)
• Drop Ubuntu 16/Add Ubuntu 20 support #616 (root-expert)

Implemented enhancements:

• Support managing selinux #413
• Add Debian 10 support #619 (root-expert)
• Use Puppet-Datatype Sensitive for Passwords #611 (cocker-cc)
• Change set_parameter to be an array of strings #595 (ZloeSabo)
• Use rs.secondaryOk on versions that deprecated rs.slaveOk #594 (svenbs)
• Add MongoDB 4.4 repository signing key. #592 (dhs-rec)

Fixed bugs:

• Existence of /root/.mongorc.js triggers mongod restart #449
• Fix MongoDB installation on RedHat family #606 (hdep)
• Update mongodb-shard.conf.erb #591 (andreish)
• Fix mongorc.js file when authentication is not enabled. #590 (vladpetrus)
• Fix digestPassword typo mongodb.rb #589 (covidium)

Closed issues:

• MongoDB 4.2.10 starts to emit warnings about slaveOk() being deprecated, which breaks the module #596
• Can't use mongodb repository on debian 9 #529

Merged pull requests:

• puppet-lint: fix top_scope_facts warnings #621 (bastelfreak)
• Allow stdlib 8.x and apt 8.x #620 (smortex)
• modulesync 3.0.0 & puppet-lint updates #586 (bastelfreak)
• Describe disabling logpath to make syslog work #585 (lennartkoopmann)
• Use voxpupuli-acceptance #580 (ekohl)

v3.1.0 (2020-02-11)

Full Changelog

Implemented enhancements:

• restrict opsmanager conf file permissions for better security #563 (FLiPp3r90)
• rebased PR#308 to allow other databases in the format 'role@db' for mongodb_user #432 (pecharmin)

Fixed bugs:

• Wrong APT-key #546
• Mongo 4.0.x: unable to create user #525
• user creation idempotency issues #412
• fix(is_master-fact): use --ssl if --sslPEMKeyFile or --sslCAFile is s… #573 (buchstabensalat)
• Fixed the problem: the user was not created for Mongodb 4.x #561 (identw)
• Only create database and user when mongodb_is_master #558 (JvGinkel)

Closed issues:

• mongo 3.x replicaset init failed #554

Merged pull requests:

• Added keys for MongoDB 4.0 and 4.2. #557 (jgrancell)
• Refactor opsmanager handling #521 (ekohl)

v3.0.0 (2019-05-21)

Full Changelog

Breaking changes:

• modulesync 2.7.0 and drop puppet 4 #533 (bastelfreak)
• Refactor client handling #520 (ekohl)
• Refactor mongos handling #509 (ekohl)
• Drop support for mongodb versions before 2.6 #504 (ekohl)
• Drop EL6 support #503 (ekohl)
• Remove 10gen repository support #497 (ekohl)
• Move to Debian 9 and Ubuntu 16.04/18.04 #494 (ekohl)
• Remove init.pp #493 (ekohl)

Implemented enhancements:

• Deprecate (and then remove) 10gen requirement/pieces #416
• support percona mongodb version output #530 (h0tw1r3)
• Add aptkey_options parameter to mongodb::repo class #524 (JvGinkel)
• Set database permissions to 0750 #511 (ekohl)
• Convert mongodb_password into a Puppet 4 function #502 (ekohl)
• Add new classes for installing Ops Manager on a target machine. #500 (claycogg)

Fixed bugs:

• Fix undefined local variable or method `n' #537 (FunFR)
• Fix for MongoDB v4 Replica Set initialization #535 (radupantiru)
• Fix a dependency cycle caused by Apt::Source from puppetlabs-apt 6.3.0 #528 (thaiphv)

Merged pull requests:

• Allow puppetlabs/stdlib 6.x #538 (alexjfisher)
• Allow puppetlabs/apt 7.x #536 (dhoppe)
• #512: Current 'sharding.pp' example typo #513 (jeff1evesque)
• Remove old nodesets #510 (ekohl)
• Refactor mongos handling #508 (ekohl)
• Deduplicate & update params.pp #506 (ekohl)
• Clean up coding styles #505 (ekohl)
• Rewrite mocking and stubbing to only rspec #496 (ekohl)
• Refactor spec testing to not test private classes #495 (ekohl)
• Major cleanup to get the acceptance tests working #491 (ekohl)

v2.4.1 (2018-10-08)

Full Changelog

Fixed bugs:

• Revert "Fallback to monogb version from fact if no explicit version got provided" #498 (ekohl)
• Also autorequire mongod service in types #492 (ekohl)

Closed issues:

• invalid byte sequence in US-ASCII #426

v2.4.0 (2018-10-05)

Full Changelog

Fixed bugs:

• Fallback to monogb version from fact if no explicit version got provided #485 (fbrehm)

Merged pull requests:

• modulesync 2.1.0, allow puppet 6.x and puppetlabs/apt 6.x #490 (bastelfreak)
• allow puppetlabs/stdlib 5.x #484 (bastelfreak)
• add gsub to replace invalid json values with a 1 #468 (TomRitserveldt)
• add rs.slaveOk to run before the getDBs call #446 (TomRitserveldt)

v2.3.0 (2018-08-20)

Full Changelog

Implemented enhancements:

• Add advanced replica set configuration #478 (DeathBorn)

Merged pull requests:

• allow puppetlabs/apt 5.x #481 (bastelfreak)

v2.2.2 (2018-07-16)

Full Changelog

Fixed bugs:

• Could not find scope for mongodb::params #428
• Fix a circular loading issue with mongodb::repo #474 (ekohl)

v2.2.1 (2018-06-25)

Full Changelog

Fixed bugs:

• Undefined method 'get_config_options' in is_master.rb #471
• Use the correct function in is_master fact #472 (ekohl)

v2.2.0 (2018-06-16)

Full Changelog

Implemented enhancements:

• Repo for version 3.6 is using wrong key. #465
• This will add the correct apt key for version 3.6. #466 (noni73)

Fixed bugs:

• Handle non-existing config file #469 (ekohl)

Merged pull requests:

• Remove docker nodesets #463 (bastelfreak)
• drop EOL OSs; fix puppet version range #462 (bastelfreak)

v2.1.2 (2018-03-28)

Full Changelog

Fixed bugs:

• Notice on every run for password_hash #425
• Add check if scram credentials are insync with hash #455 (ctrox)

v2.1.1 (2018-03-27)

Full Changelog

Fixed bugs:

• Bump stdlib 4.4.0->4.13.0 #450 (dupgit)

Closed issues:

• Fact "mongodb_is_master" fails on mongodb clients #441

Merged pull requests:

• bump puppet to latest supported version 4.10.0 #452 (bastelfreak)

v2.1.0 (2018-02-27)

Full Changelog

Implemented enhancements:

• Allow setting of net.ssl.mode #300 (bond-os)

Fixed bugs:

• Fixed changing user password with MongoDB 2.6 #442 (webcompas)
• Fix password changing issue voxpupuli/puppet-mongodb#438 #440 (webcompas)
• Add a retry block when hosts are added to replset #436 (pkilambi)

Closed issues:

• Changing a user's password doesn't work #438

v2.0.0 (2018-01-04)

Full Changelog

Breaking changes:

• Add Data Types and remove deprecated parameters #406 (wyardley)

Implemented enhancements:

• Replace anchors with contain #420 (ekohl)
• Simplify the client class #419 (ekohl)

Fixed bugs:

• apt-transport-https required on Ubuntu when installing version >= 3.0.0. #417
• Fix compilation failures on RHEL when manage_package => true #431 (fatmcgav)

Closed issues:

• "Unknown variable 'mongodb::params::journal'" error when 'manage_package => true' #430
• package version override broken with yum #415
• create admin and repl set fail with password #414
• 10gen repo handling doesn't work #101

Merged pull requests:

• Set types for mongodb::db #421 (ekohl)
• Allow bind_ip to be an IP or array of IPs. Add data types for a coupl… #411 (wyardley)
• Some minor initial fixes for acceptance tests #409 (wyardley)
• Use raise Puppet::Error instead of Puppet.fail() #408 (wyardley)
• fix for rubocop issues introduced in 9e2c #407 (wyardley)
• Autorequire mongodb_database for mongodb_user #394 (ekohl)
• Set dbpath_fix to false by default #347 (mwhahaha)
• Fixed: create database admin only if service_ensure is true. #240 (pcheliniy)

v1.1.0 (2017-10-20)

Full Changelog

Implemented enhancements:

• Allow user-supplied configuration data #389 (blackophelia)
• MODULES-5483: Auth and FQDN certs => Fail #369 (ThoTischner)

Fixed bugs:

• Fix password on admin db #393 (benohara)
• fix issue MODULES-5545 #390 (bovy89)
• mongodb no longer provides the stable link #361 (attachmentgenie)

Closed issues:

• Can't change dbpath on Debian Stretch / Puppet5 with Hiera #398

Merged pull requests:

• Release 1.1.0 #403 (wyardley)
• correct spelling mistake #395 (EdwardBetts)
• (maint) modulesync 915cde70e20 #388 (glennsarti)
• (MODULES-5187) mysnc puppet 5 and ruby 2.4 #387 (eputnam)
• Update README.md #386 (LasseRafn)
• Release 1.0.0 mergeback #384 (eputnam)
• Only check if master if mongod installed #314 (benohara)

1.0.0 (2017-06-30)

Summary

Major release removing Puppet 3 support.

Added

• ssl_weak_cert param in mongodb::server type
• system_logrotate param in mongodb, mongodb::server, and mongodb::server::config
• handle_creds to handle credentials outside of Puppet (MODULES-1754)
• sslMode when SSL is used
• ability to use unencrypted passwords

Changed

• lower bound of Puppet requirement to 4.7.0
• use of sslMode to sslOnNormalPorts to determine if SSL is enabled

Fixed

• database property in mongodb_user to allow hyphens (MODULES-4444)
• gsub pattern for is_master fact
• mongodb_version fact
• selinux dbpath contexts in mongodb::server::config
• Debian-based repo paths
• $pidfilepath for Debian
• syntax error in net.ipv6 configuration option
• spec failure caused by Puppet 5
• is_master in mongodb provider

Unsupported Release 0.17.0

Summary

Adding features to improve spec testing, and added ability to manage pidfile creation

Fixed

• gettext and spec.opts
• msync Gemfile for 1.0 frozen strings (MODULES-3631)
• MongoDB 3.12 creates pid file and checks in init script (MODULES-3956)
• gemfile template to be identical (MODULES-3704)
• deprecation errors

Unsupported Release 0.16.0

Summary

We fixed a critical bug where we lost idempotency in 0.15.0. The patch that fix this problem will be part of this release.

Fixed

• Recursively manage only user/group for dbpath

Unsupported Release 0.15.0

Summary

The addition of several new functional features which will help with management and multiple bug fixes.

Added

• Added ability to set PID file mode.
• Recursively manage the contents of dbpath directory.
• Now alllows custom templates.
• Addition of mongo listen port before creating facter.

Fixed

• Now allows hyphens in database names.
• Now converts MongoDB ObjectID objects to generic JSON.
• Use the same regex that the mongodb provider does when correcting for ObjectID values in the isMaster response.
• Fixes to ensure that the auth property for config is parsed correctly.
• Now checks if mongo is up before evaluating is_master fact.

Unsupported Release 0.14.0

Summary

This breaking release increases the lower bound of the puppetlabs-apt dependency to the 2.x series of apt and puppetlabs-stdlib to >= 4.4.0. The operating system metadata is also updated to reflect modern systems.

Added

• Add mongodb_is_master fact
• Add mongodb::db::db_name parameter for exported resource deduplication
• Add Debian 8 compatibility
• Add Ubuntu 14.04 compatibility
• Add Ubuntu 16.04 compatibility
• Add puppet 3.x 4.x compatibility metadata

Changed

• Increase apt lower dependency to >= 2.1.0
• Increase stdlib lower dependency to >= 4.4.0
• Drop RHEL & Centos 5
• Drop Debian 6
• Drop Ubuntu 10.04

Fixed

• Catch unconfigured replset configuration queries
• Fix timestamp and other javascript object removal
• Correct permissions on .mongorc.js to 600

Unsupported Release 0.13.0

Summary

Adds several new large features, including the support of mongodb 3.x. Also applies numerous bugfixes, mainly around fixing errors being thrown and syntax issues.

Added

• Adds mongodb_version fact.
• Add mongodb 3.x.
• Update to current msync configs.
• Now ensures that the pidfile exists and is writable.
• Simplified configuration parsing.
• Made argument handling more extensible.
• Added SSL support.
• Made ssl_ca optional when using SSL.
• Added $maxconns to mongodb::server::config.
• Added Suse to operating systems.

Fixed

• Removes empty lines between doc and definition.
• Fix when using admin params : catalog: Found 1 dependency cycle: issue.
• Some syntax error fixes.
• Cleaned up provider formatting.
• Parse NumberLong data type from mongodb outputs to generate valid json.
• Checks if $version is defined before versioncmp.
• Fixed deprecation warning for use of configtimeout.

Unsupported Release 0.12.0

Summary

There are a number of bugfixes and features added in this release including, mongo db 3 engine support, ipv6 support and repo and yum improvements.

Added

• Distinguish between repo and package mgmt
• Immplement retries for MongoDB shell commands
• Initiate replica set creation from localhost if auth is enabled
• Added specific service provider for Debian
• mongo db 3 engine selection support
• added an option to set a custom repository location
• Improve support for MongoDB authentication and replicaset
• Add yum proxy options
• Enable IPv6 in mongodb provider

Fixed

• Fix mongodb_user username => name
• ensure that the client install does not start before the repo setup
• Fix replset not working on mongo 3.x
• Prealloc setting needs to be negated
• Add mongoDB >=3.x new yum repo location
• Add pidfilepath to globals when used in params
• Normalize spacing in template
• Switch to comparing current roles value with @property
• Fix versioncmp when version is undef
• Do not add blank parameter in ipv4
• Apply module sync

Unsupported Release 0.11.0

Summary

Added

• arbiter support to to mongodb_replset
• mongod_service_manage, mongos_service_manage, and ipv6 to mongodb::globals
• service_manage, unitxsocketprefix, pidfilepath, logpath, fork, bind_ip, port, and restart to mongodb::mongos class
• key, ipv6, service_manage, and restart to mongodb::server class
• Allow mongodb_conn_validator to take an array of nodes via composite namevar

Fixed

• Update to long apt repo key and bump compatibility to include apt 2
• Fix nohttpinterface on >= 2.6
• Fix connection validation when bind_ip is 0.0.0.0
• Fix mongodb_conn_validator to use default port in shard mode

Unsupported Release 0.10.0

Summary

This release adds a number of significant features and several bug fixes.

Added

• Adds support for sharding
• Adds support for RHEL 7
• Adds rudimentary support for SSL configuration
• Adds support for the enterprise repository

Fixed

• Fixes support for running on non-default ports
• Fixes the idempotency of password setting (for mongo 2.6)

Unsupported Release 0.9.0

Summary

This release has a number of new parameters, support for 2.6, improved providers, and several bugfixes.

Added

• New parameters: mongodb::globals
  • $service_ensure
  • $service_enable
• New parameters: mongodb
  • $quiet
• New parameters: mongodb::server
  • $service_ensure
  • $service_enable
  • $quiet
  • $config_content
• Support for mongodb 2.6
• Reimplement mongodb_user and mongodb_database provider
• Added mongodb_conn_validator type

Fixed

• Use hkp for the apt keyserver
• Fix mongodb database existence check
• Fix $server_package_name problem (MODULES-690)
• Make sure pidfilepath doesn't have any spaces
• Providers need the client command before they can work (MODULES-1285)

Unsupported Release 0.8.0

Summary

This feature features a rewritten mongodb_replset{} provider, includes several important bugfixes, ruby 1.8 support, and two new features.

Added

• Rewritten mongodb_replset{}, featuring puppet resource support, prefetching, and flushing.
• Add Ruby 1.8 compatibility.
• Adds syslog, allowing you to configure mongodb to send all logging to the hosts syslog.
• Add mongodb::replset, a wrapper class for hiera users.
• Improved testing!

Fixed

• Fixes the package names to work since 10gen renamed them again.
• Fix provider name in the README.
• Disallow nojournal and journal to be set at the same time.
• Changed - to = for versioned install on Ubuntu.

Unsupported Release 0.7.0

Summary

Added Replica Set Type and Provider

Unsupported Release 0.6.0

Summary

Added support for installing MongoDB client on RHEL family systems.

Unsupported Release 0.5.0

Summary

Added types for providers for Mongo users and databases.

Unsupported Release 0.4.0

Major refactoring of the MongoDB module. Includes a new 'mongodb::globals' that consolidates many shared parameters into one location. This is an API-breaking release in anticipation of a 1.0 release.

Unsupported Release 0.3.0

Summary

Adds a number of parameters and fixes some platform specific bugs in module deployment.

Unsupported Release 0.2.0

Summary

This release fixes a duplicate parameter.

Fixed

• Fix a duplicated parameter.

Unsupported Release 0.1.0

• Add support for RHEL/CentOS
• Change default mongodb install location to OS repo

Unsupported Release 0.0.2

• Fix Modulefile typo.
• Remove repo pin.
• Update spec tests and add travis support.

Unsupported Release 0.0.1

• Initial Release.

* This Changelog was automatically generated by github_changelog_generator