Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status

The mongodb cookbook has been deprecated

Author provided reason for deprecation:

The mongodb cookbook has been deprecated and is no longer being maintained by its authors. Use of the mongodb cookbook is no longer recommended.

You may find that the sc-mongodb cookbook is a suitable alternative.


mongodb (11) Versions 0.16.2

Installs and configures mongodb

cookbook 'mongodb', '~> 0.16.2', :supermarket
cookbook 'mongodb', '~> 0.16.2'
knife supermarket install mongodb
knife supermarket download mongodb
Quality 33%

MongoDB Cookbook

Installs and configures MongoDB, supporting:

  • Single MongoDB instance
  • Replication
  • Sharding
  • Replication and Sharding
  • 10gen repository package installation
  • 10gen MongoDB Monitoring System

Build Status


This cookbook depends on these external cookbooks

  • apt
  • python
  • runit
  • yum

As of 0.16 This Cookbook requires

  • Chef > 11
  • Ruby > 1.9


Currently we 'actively' test using test-kitchen on Ubuntu, Debian, CentOS, Redhat


This cookbook contains a definition mongodb_instance which can be used to configure
a certain type of mongodb instance, like the default mongodb or various components
of a sharded setup.

For examples see the USAGE section below.


Mongodb Configuration

Basically all settings defined in the Configuration File Options documentation page can be added to the node['mongodb']['config'][<setting>] attribute:

  • node['mongodb']['config']['dbpath'] - Location for mongodb data directory, defaults to "/var/lib/mongodb"
  • node['mongodb']['config']['logpath'] - Path for the logfiles, default is "/var/log/mongodb/mongodb.log"
  • node['mongodb']['config']['port'] - Port the mongod listens on, default is 27017
  • node['mongodb']['config']['rest'] - Enable the ReST interface of the webserver
  • node['mongodb']['config']['smallfiles'] - Modify MongoDB to use a smaller default data file size
  • node['mongodb']['config']['oplogsize'] - Specifies a maximum size in megabytes for the replication operation log
  • node['mongodb']['config']['bind_ip'] - Configure from which address to accept connections
  • node['mongodb']['config'][<setting>] - General MongoDB Configuration File option

Cookbook specific attributes

  • node[:mongodb][:reload_action] - Action to take when MongoDB conf files are modified, default is "restart"
  • node[:mongodb][:package_version] - Version of the MongoDB package to install, default is nil
  • node[:mongodb][:client_role] - Role identifying all external clients which should have access to a mongod instance

Sharding and replication attributes

  • node['mongodb']['config']['replSet'] - Define name of replicaset
  • node[:mongodb][:cluster_name] - Name of the cluster, all members of the cluster must reference to the same name, as this name is used internally to identify all members of a cluster.
  • node[:mongodb][:shard_name] - Name of a shard, default is "default"
  • node['mongodb']['sharded_collections'] - Define which collections are sharded
  • node[:mongodb][:replica_arbiter_only] - Set to true to make node an arbiter.
  • node[:mongodb][:replica_build_indexes] - Set to false to omit index creation.
  • node[:mongodb][:replica_hidden] - Set to true to hide node from replicaset.
  • node[:mongodb][:replica_slave_delay] - Number of seconds to delay slave replication.
  • node[:mongodb][:replica_priority] - Node priority.
  • node[:mongodb][:replica_tags] - Node tags.
  • node[:mongodb][:replica_votes] - Number of votes node will cast in an election.

shared MMS Agent attributes

  • node['mongodb']['mms_agent']['api_key'] - MMS Agent API Key. No default, required.
  • node['mongodb['mms_agent']['monitoring']['version'] - Version of the MongoDB MMS Monitoring Agent package to download and install. Default is '', required.
  • node['mongodb['mms_agent']['monitoring'][<setting>] - General MongoDB MMS Monitoring Agent configuration file option.
  • node['mongodb['mms_agent']['backup']['version'] - Version of the MongoDB MMS Backup Agent package to download and install. Default is '', required.
  • node['mongodb['mms_agent']['backup'][<setting>] - General MongoDB MMS Monitoring Agent configuration file option.

User management attributes

  • node['mongodb']['config']['auth'] - Require authentication to access or modify the database
  • node['mongodb']['admin'] - The admin user with userAdmin privileges that allows user management
  • node['mongodb']['users'] - Array of users to add when running the user management recipe

Monitoring Agent Settings

The defaults values installed by the package are:

throttlePassesShardChunkCounts = 10
throttlePassesDbstats = 20
throttlePassesOplog = 10

Backup Agent Settings

The defaults values installed by the package are:



Adds the stable 10gen repo for the
corresponding platform. Currently only implemented for the Debian and Ubuntu repository.

Usage: just add recipe[mongodb::10gen_repo] to the node run_list before any other
MongoDB recipe, and the mongodb-10gen stable packages will be installed instead of the distribution default.

Single mongodb instance

Simply add

include_recipe "mongodb::default"

to your recipe. This will run the mongodb instance as configured by your distribution.
You can change the dbpath, logpath and port settings (see ATTRIBUTES) for this node by
using the mongodb_instance definition:

mongodb_instance "mongodb" do
  port node['application']['port']

This definition also allows you to run another mongod instance with a different
name on the same node

mongodb_instance "my_instance" do
  port node['mongodb']['port'] + 100
  dbpath "/data/"

The result is a new system service with

  /etc/init.d/my_instance <start|stop|restart|status>


Add mongodb::replicaset (instead of mongodb::default) to the node's run_list. Also choose a name for your
replicaset cluster and set the value of node[:mongodb][:cluster_name] for each
member to this name.


You need a few more components, but the idea is the same: identification of the
members with their different internal roles (mongos, configserver, etc.) is done via
the node[:mongodb][:cluster_name] and node[:mongodb][:shard_name] attributes.

Let's have a look at a simple sharding setup, consisting of two shard servers, one
config server and one mongos.

First we would like to configure the two shards. For doing so, just use
mongodb::shard in the node's run_list and define a unique mongodb[:shard_name]
for each of these two nodes, say "shard1" and "shard2".

Then configure a node to act as a config server - by using the mongodb::configserver

And finally you need to configure the mongos. This can be done by using the
mongodb::mongos recipe. The mongos needs some special configuration, as these
mongos are actually doing the configuration of the whole sharded cluster.
Most importantly you need to define what collections should be sharded by setting the
attribute mongodb[:sharded_collections]:

  "mongodb": {
    "sharded_collections": {
      "test.addressbook": "name",
      "mydatabase.calendar": "date"

Now mongos will automatically enable sharding for the "test" and the "mydatabase"
database. Also the "addressbook" and the "calendar" collection will be sharded,
with sharding key "name" resp. "date".
In the context of a sharding cluster always keep in mind to use a single role
which is added to all members of the cluster to identify all member nodes.
Also shard names are important to distinguish the different shards.
This is esp. important when you want to replicate shards.

Sharding + Replication

The setup is not much different to the one described above. All you have to do is add the
mongodb::replicaset recipe to all shard nodes, and make sure that all shard
nodes which should be in the same replicaset have the same shard name.

For more details, you can find a tutorial for Sharding + Replication in the wiki.

MMS Agent

This cookbook also includes support for
MongoDB Monitoring System (MMS)
agent. MMS is a hosted monitoring service, provided by 10gen, Inc. Once
the small python agent program is installed on the MongoDB host, it
automatically collects the metrics and uploads them to the MMS server.
The graphs of these metrics are shown on the web page. It helps a lot
for tackling MongoDB related problems, so MMS is the baseline for all
production MongoDB deployments.

To setup MMS, simply set your keys in
node['mongodb']['mms_agent']['api_key'] and then add the
mongodb::mms-agent recipe to your run list. Your current keys should
be available at your MMS Settings page.

User Management

An optional recipe is mongodb::user_management which will enable authentication in
the configuration file by default and create any users in the node['mongodb']['users'].
The users array expects a hash of username, password, roles, and database. Roles should be
an array of roles the user should have on the database given.

By default, authentication is not required on the database. This can be overridden by setting
the node['mongodb']['config']['auth'] attribute to true in the chef json.

If the auth configuration is true, it will try to create the node['mongodb']['admin'] user, or
update them if they already exist. Before using on a new database, ensure you're overwriting
the node['mongodb']['admin']['username'] and node['mongodb']['admin']['password'] to
something besides their default values.

There's also a user resource which has the actions :add, :modify and :delete. If modify is
used on a user that doesn't exist, it will be added. If add is used on a user that exists, it
will be modified.


Author:: Markus Korn

Copyright:: 2011-2014, edelight GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

apt >= 1.8.2
yum >= 3.0
python >= 0.0.0
runit >= 1.5.0

Contingent cookbooks

cloudfoundry-mongodb-service Applicable Versions
cloudless-box Applicable Versions
cube Applicable Versions
errbit Applicable Versions
errbit-server Applicable Versions
graylog Applicable Versions
graylog2 Applicable Versions
greysystems-mongodb Applicable Versions
nodestack Applicable Versions
pa11y Applicable Versions
phpstack Applicable Versions
pythonstack Applicable Versions
razor Applicable Versions
rocketchat Applicable Versions
seyren Applicable Versions
stack_commons Applicable Versions
stackstorm Applicable Versions
tyk Applicable Versions
uptime Applicable Versions
======================== Chef-MongoDB Cookbook Changelog Last-Update: Tue Nov 4 11:48:54 PST 2014 ======================== Pending 0.16.3 Changes -------------------------- Version 0.16.2 Release Tue Nov 4 11:48:54 PST 2014 -------------------------- * start doing even patches = release, odd = dev. * removed unmaintained freebsd support file * pass `--force-yes` to apt to bypass issue with package/config conflict #305 * bumped mms_agent version for `monitoring` and `backup` #312 * added user management/auth support, and patches #313, #317 * fix patches on logpath #310 * allow changing mongos service name #319 * update upstart config for debian #323 * added fixes for installation prereqs, sasl * fix systemd usecase for redhat (#352, #350) Version 0.16.1 -------------------------- * remove old `mms_agent.rb` and `mms-agent.rb` in favor of new mms_*_agent.rb * Update mms_*_agent.rb to use template instead of ruby-block, nothing, but call restart * DEPRECATE '10gen_repo' for 'mongodb_org_repo' #287 * node['mongodb']['install_method'] can now be '10gen' (DEPRECATE) or 'mongodb_org' * allow `node['mongodb']['config']['logpath'] to be nil for syslog #288 Version 0.16.0 -------------------------- * BREAKING CHANGE - drop support for Ruby < 1.9, Chef < 11 * cookbook dependency change - yum >= 3.0 - remove <= limit for all other dep * update to Berkshelf 3 * #280 fix install for centos (missing build-essentials) Version 0.15.2 End of Ruby 1.8, Chef 10 support --------------------------- * update test-kitchen for mongos * update MMS version * update rubocop * minor typo fixes Version 0.15.1 --------------------------- * 'potentially' BREAKING CHANGES, cookbook dependency pinned - yum < 3.0 - runit < 1.5 - python < 1.4.5 * DEPRECATION: explicitly drop support for 'unsupported' platforms - must be freebsd, rhel, fedora, debian * DEPRECATION: recipe mms-agent.rb/mms_agent.rb - see #261 for new-recipes * use node.set to make sure is_* attributes are available for search * 'key_file' -> 'key_file_content' * allow pinning for gems, pip packages * #261 new mms agent recipe based on new packaging in upstream * #256 Allow mms_agent to be run as non-root user - replSet is not set automatically Version 0.15.0 --------------------------- * DEPRECATION: backward compatability for dbconfig variables in node['mongodb'] - use node['mongodb']['config'][variable] = value Version 0.14.10 DEVELOPMENTAL RELEASE --------------------------- * Final 0.14 release * move node['mongodb']['config']['configsrv'] auto update to the top * Drop using Chef.Version as it is not rc/beta compatible * installs gem bson_ext Version 0.14.8 DEVELOPMENTAL RELEASE --------------------------- * Rubocop (cherry pick of #220) Version 0.14.7 DEVELOPMENTAL RELEASE --------------------------- * Automatically install bson_ext gem * Add check/protection for empty shard * Force node['mongodb']['config']['configsrv'] == true when set as configserver Version 0.14.6 DEVELOPMENTAL RELEASE --------------------------- * try to autoconfigure 'configsrv' from configserver_nodes * remove `include 'mongodb::default'` from definition * allow chef-run without restarting mongo * comment cleanup Version 0.14.X DEVELOPMENTAL RELEASES --------------------------- * Split out install into separate recipe * Adds more testing * Fixes mms-agent installation/runtime * Preliminary Work being done to convert completely to Resource style * patches to Replicaset * patches to fix upstart service * patches to configserver install Version 0.13.2, RELEASED --------------------------- add support for chef_gem on newer versions of chef Version 0.13.1, RELEASED --------------------------- Add keyfileSupport Version 0.13.0, RELEASED --------------------------- Bunch of stuff... Version 0.1.0 ---------------------------- Initial release of the cookbooks for the chef configuration management system developed at edelight GmbH. With this first release we publish the mongodb cookbook we use for our systems. This cookbook helps you to configure single node mongodb instances as well as more complicated cluster setups (including sharding and replication).

Collaborator Number Metric

0.16.2 passed this metric

Contributing File Metric

0.16.2 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Foodcritic Metric

0.16.2 failed this metric

FC064: Ensure issues_url is set in metadata: mongodb/metadata.rb:1
FC065: Ensure source_url is set in metadata: mongodb/metadata.rb:1
FC066: Ensure chef_version is set in metadata: mongodb/metadata.rb:1
FC069: Ensure standardized license defined in metadata: mongodb/metadata.rb:1
FC072: Metadata should not contain "attribute" keyword: mongodb/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: mongodb/resources/user.rb:1
FC104: Use the :run action in ruby_block instead of :create: mongodb/definitions/mongodb.rb:22
FC104: Use the :run action in ruby_block instead of :create: mongodb/definitions/mongodb.rb:202
FC104: Use the :run action in ruby_block instead of :create: mongodb/definitions/mongodb.rb:232
FC109: Use platform-specific package resources instead of provider property: mongodb/recipes/mms_backup_agent.rb:27
FC109: Use platform-specific package resources instead of provider property: mongodb/recipes/mms_monitoring_agent.rb:27
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric

0.16.2 passed this metric

Testing File Metric

0.16.2 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Version Tag Metric

0.16.2 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must include a tag that matches this cookbook version number