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 database cookbook has been deprecated

Author provided reason for deprecation:

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


database (52) Versions 1.3.4

provides LWRPs for common database tasks

cookbook 'database', '= 1.3.4', :supermarket
cookbook 'database', '= 1.3.4'
knife supermarket install database
knife supermarket download database
Quality -%

Database Cookbook

The main highlight of this cookbook is the database and
database_user resources for managing databases and database users in
a RDBMS. Providers for MySQL, PostgreSQL and SQL Server are also
provided, see usage documentation below.

This cookbook also contains recipes to configure mysql database
masters and slaves and uses EBS for storage, integrating together with
the application cookbook utilizing data bags for application related
information. These recipes are written primarily to use MySQL and the
Opscode mysql cookbook. Other RDBMS may be supported at a later date.
This cookbook does not automatically restore database dumps, but does
install tools to help with that.


Chef version 0.10.10+.


  • Debian, Ubuntu
  • Red Hat, CentOS, Scientific, Fedora


The following Opscode cookbooks are dependencies:

  • mysql
  • postgresql
  • xfs
  • aws


These resources aim to expose an abstraction layer for interacting
with different RDBMS in a general way. Currently the cookbook ships
with providers for MySQL, PostgreSQL and SQL Server. Please see
specific usage in the Example sections below. The providers use
specific Ruby gems installed under Chef's Ruby environment to execute
commands and carry out actions. These gems will need to be installed
before the providers can operate correctly. Specific notes for each
RDBS flavor:

  • MySQL: leverages the mysql gem which is installed as part of the mysql::ruby recipe. You can use database::mysql to include this, too.
  • PostgreSQL: leverages the pg gem which is installed as part of the postgresql::ruby recipe. You can use database::postgresql to include this, too. Currently does not work in Chef "omnibus" full stack installs, see COOK-1406.
  • SQL Server: leverages the tiny_tds gem which is installed as part of the sql_server::client recipe.


Manage databases in a RDBMS. Use the proper shortcut resource
depending on your RDBMS: mysql_database, postgresql_database or


  • :create: create a named database
  • :drop: drop a named database
  • :query: execute an arbitrary query against a named database

Attribute Parameters

  • database_name: name attribute. Name of the database to interact with
  • connection: hash of connection info. valid keys include :host, :port, :username, :password
  • sql: string of sql or a block that executes to a string of sql, which will be executed against the database. used by :query action only


  • Chef::Provider::Database::Mysql: shortcut resource mysql_database
  • Chef::Provider::Database::Postgresql: shortcut resource postgresql_database
  • Chef::Provider::Database::SqlServer: shortcut resource sql_server_database


# create a mysql database
mysql_database 'oracle_rules' do
  connection ({:host => "localhost", :username => 'root', :password => node['mysql']['server_root_password']})
  action :create

# create a sql server database
sql_server_database 'mr_softie' do
  connection ({:host => "", :port => node['sql_server']['port'], :username => 'sa', :password => node['sql_server']['server_sa_password']})
  action :create

# create a postgresql database
postgresql_database 'mr_softie' do
  connection ({:host => "", :port => 5432, :username => 'postgres', :password => node['postgresql']['password']['postgres']})
  action :create

# create a postgresql database with additional parameters
postgresql_database 'mr_softie' do
  connection ({:host => "", :port => 5432, :username => 'postgres', :password => node['postgresql']['password']['postgres']})
  template 'DEFAULT'
  encoding 'DEFAULT'
  tablespace 'DEFAULT'
  connection_limit '-1'
  owner 'postgres'
  action :create

# externalize conection info in a ruby hash
mysql_connection_info = {:host => "localhost", :username => 'root', :password => node['mysql']['server_root_password']}
sql_server_connection_info = {:host => "localhost", :port => node['sql_server']['port'], :username => 'sa', :password => node['sql_server']['server_sa_password']}
postgresql_connection_info = {:host => "", :port => 5432, :username => 'postgres', :password => node['postgresql']['password']['postgres']}

# same create commands, connection info as an external hash
mysql_database 'foo' do
  connection mysql_connection_info
  action :create
sql_server_database 'foo' do
  connection sql_server_connection_info
  action :create
postgresql_database 'foo' do
  connection postgresql_connection_info
  action :create

# create database, set provider in resource parameter
database 'bar' do
   connection mysql_connection_info
   provider Chef::Provider::Database::Mysql
   action :create
database 'bar' do
  connection sql_server_connection_info
  provider Chef::Provider::Database::SqlServer
  action :create
database 'bar' do
  connection postgresql_connection_info
  provider Chef::Provider::Database::Postgresql
  action :create

# drop a database
mysql_database "baz" do
  connection mysql_connection_info
  action :drop

# query a database
mysql_database "flush the privileges" do
  connection mysql_connection_info
  sql "flush privileges"
  action :query

# query a database from a sql script on disk
mysql_database "run script" do
  connection mysql_connection_info
  sql {"/path/to/sql_script.sql").read }
  action :query

# vacuum a postgres database
postgres_database "vacuum databases" do
  connection postgresql_connection_info
  database_table "template1"
  action :query


Manage users and user privileges in a RDBMS. Use the proper shortcut
resource depending on your RDBMS: mysql_database_user or


  • :create: create a user
  • :drop: drop a user
  • :grant: manipulate user privileges on database objects

Attribute Parameters

  • username: name attribute. Name of the database user
  • password: password for the user account
  • database_name: Name of the database to interact with
  • connection: hash of connection info. valid keys include :host, :port, :username, :password
  • privileges: array of database privileges to grant user. used by the :grant action. default is :all
  • host: host where user connections are allowed from. used by MySQL provider only. default is 'localhost'
  • table: table to grant privileges on. used by :grant action and MySQL provider only. default is '*' (all tables)


  • Chef::Provider::Database::MysqlUser: shortcut resource mysql_database_user
  • Chef::Provider::Database::SqlServerUser: shortcut resource sql_server_database_user


# create connection info as an external ruby hash
mysql_connection_info = {:host => "localhost", :username => 'root', :password => node['mysql']['server_root_password']}
sql_server_connection_info = {:host => "localhost", :port => node['sql_server']['port'], :username => 'sa', :password => node['sql_server']['server_sa_password']}

# create a mysql user but grant no priveleges
mysql_database_user 'disenfranchised' do
  connection mysql_connection_info
  password 'super_secret'
  action :create

# do the same but pass the provider to the database resource
database_user 'disenfranchised' do
  connection mysql_connection_info
  password 'super_secret'
  provider Chef::Provider::Database::MysqlUser
  action :create

# create a sql server user but grant no priveleges
sql_server_database_user 'disenfranchised' do
  connection sql_server_connection_info
  password 'super_secret'
  action :create

# drop a mysql user
mysql_database_user "foo_user" do
  connection mysql_connection_info
  action :drop

# bulk drop sql server users
%w{ disenfranchised foo_user }.each do |user|
  sql_server_database_user user do
    connection sql_server_connection_info
    action :drop

# grant select,update,insert privileges to all tables in foo db from all hosts
mysql_database_user 'foo_user' do
  connection mysql_connection_info
  password 'super_secret'
  database_name 'foo'
  host '%'
  privileges [:select,:update,:insert]
  action :grant

# grant all privelages on all databases/tables from localhost
mysql_database_user 'super_user' do
  connection mysql_connection_info
  password 'super_secret'
  action :grant

# grant select,update,insert privileges to all tables in foo db
sql_server_database_user 'foo_user' do
  connection sql_server_connection_info
  password 'super_secret'
  database_name 'foo'
  privileges [:select,:update,:insert]
  action :grant



Note: This recipe does not currently work on RHEL platforms due to
the xfs cookbook not supporting RHEL yet.

Loads the aws information from the data bag. Searches the applications
data bag for the database master or slave role and checks that role is
applied to the node. Loads the EBS information and the master
information from data bags. Uses the aws cookbook LWRP,
aws_ebs_volume to manage the volume.

On a master node:
* if we have an ebs volume already as stored in a data bag, attach it.
* if we don't have the ebs information then create a new one and
attach it.
* store the volume information in a data bag via a ruby block.

On a slave node:
* use the master volume information to generate a snapshot.
* create the new volume from the snapshot and attach it.

Also on a master node, generate some configuration for running a
snapshot via chef-solo from cron.

On a new filesystem volume, create as XFS, then mount it in /mnt, and
also bind-mount it to the mysql data directory (default


This recipe no longer loads AWS specific information, and the database
position for replication is no longer stored in a databag because the
client might not have permission to write to the databag item. This
may be handled in a different way at a future date.

Searches the apps databag for applications, and for each one it will
check that the specified database master role is set in both the
databag and applied to the node's run list. Then, retrieves the
passwords for root, repl and debian users and saves them to the
node attributes. If the passwords are not found in the databag, it
prints a message that they'll be generated by the mysql cookbook.

Then it adds the application databag database settings to a hash, to
use later.

Then it will iterate over the databases and create them with the
mysql_database resource while adding privileges for application
specific database users using the mysql_database_user resource.


TODO: Retrieve the master status from a data bag, then start
replication using a ruby block. The replication status needs to be
handled in some other way for now since the master recipe above
doesn't actually set it in the databag anymore.


Run via Chef Solo. Retrieves the db snapshot configuration from the
specified JSON file. Uses the mysql_database resource to lock and
unlock tables, and does a filesystem freeze and EBS snapshot.

Deprecated Recipes

The following recipe is considered deprecated. It is kept for
reference purposes.


Older style of doing mysql snapshot and replication using Adam Jacob's
ec2_mysql script and library.

Data Bags

This cookbook uses the apps data bag item for the specified
application; see the application cookbook's It also
creates data bag items in a bag named 'aws' for storing volume
information. In order to interact with EC2, it expects aws to have a
main item:

  "id": "main",
  "ec2_private_key": "private key as a string",
  "ec2_cert": "certificate as a string",
  "aws_account_id": "",
  "aws_secret_access_key": "",
  "aws_access_key_id": ""

Note: with the Open Source Chef Server, the server using the database
recipes must be an admin client or it will not be able to create data
bag items. You can modify whether the client is admin by editing it
with knife.

knife client edit 
  "admin": true

This is not required if the Chef Server is Opscode Hosted Chef,
instead use the ACL feature to modify access for the node to be able
to update the data bag.


Aside from the application data bag (see the README in the application
cookbook), create a role for the database master. Use a role.rb in
your chef-repo, or create the role directly with knife.

% knife role show my_app_database_master -Fj
  "name": "my_app_database_master",
  "chef_type": "role",
  "json_class": "Chef::Role",
  "default_attributes": {
  "description": "",
  "run_list": [
  "override_attributes": {

Create a production environment. This is also used in the
application cookbook.

% knife environment show production -Fj
  "name": "production",
  "description": "",
  "cookbook_versions": {
  "json_class": "Chef::Environment",
  "chef_type": "environment",
  "default_attributes": {
  "override_attributes": {

The cookbook my_app_database is recommended to set up any
application specific database resources such as configuration
templates, trending monitors, etc. It is not required, but you would
need to create it separately in site-cookbooks. Add it to the
my_app_database_master role.

License and Author

Copyright 2009-2012, Opscode, Inc.

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

mysql >= 1.3.0
postgresql >= 1.0.0
aws >= 0.0.0
xfs >= 0.0.0

Contingent cookbooks

abiquo Applicable Versions
agilefant Applicable Versions
alfresco Applicable Versions
alfresco-db Applicable Versions
askbot Applicable Versions
automysqlbackup Applicable Versions
bacula Applicable Versions
bacula-backup Applicable Versions
bamboo Applicable Versions
boilerplate Applicable Versions
boxbilling Applicable Versions
bricks Applicable Versions
cacti Applicable Versions
chef-manageiq Applicable Versions
chef_crowd Applicable Versions
chef_jira Applicable Versions
cloudfoundry-cloud_controller Applicable Versions
cloudless-box Applicable Versions
co-cloudstack Applicable Versions
concourse Applicable Versions
config-driven-helper Applicable Versions
confluence Applicable Versions
crowd Applicable Versions
database_restore Applicable Versions
databox Applicable Versions
druid-example Applicable Versions
drupal-cookbook Applicable Versions
drupalbaseplus Applicable Versions
dvwa Applicable Versions
eulipion-cleanspeak Applicable Versions
fanfare Applicable Versions
ff_sync Applicable Versions
flyway-cli Applicable Versions
foreman Applicable Versions
frog Applicable Versions
gallery Applicable Versions
gerrit Applicable Versions
github_connector Applicable Versions
gitlab Applicable Versions
gitlab-server Applicable Versions
gitlab-shell Applicable Versions
gitlabhq Applicable Versions
gitorious Applicable Versions
gitrob Applicable Versions
gotcms Applicable Versions
guardian Applicable Versions
ignite-openfire Applicable Versions
imply-platform Applicable Versions
iptables_web Applicable Versions
jahia Applicable Versions
jenkins_build Applicable Versions
jira Applicable Versions
kloudspeaker Applicable Versions
lemur Applicable Versions
liquid-feedback Applicable Versions
magentostack Applicable Versions
mattermost Applicable Versions
mediacore Applicable Versions
mediawiki Applicable Versions
metarepo Applicable Versions
mirage Applicable Versions
moodle Applicable Versions
myface Applicable Versions
mysql-sys Applicable Versions
mysql_logrotate Applicable Versions
mysql_role Applicable Versions
myusa Applicable Versions
nephology Applicable Versions
nodestack Applicable Versions
noosfero Applicable Versions
oc-id Applicable Versions
omakase Applicable Versions
open-build-service Applicable Versions
openfire Applicable Versions
openstack-common Applicable Versions
openstack-mistral Applicable Versions
openstack-ops-database Applicable Versions
owncloud Applicable Versions
pagekit Applicable Versions
paramount Applicable Versions
pdns Applicable Versions
pentester Applicable Versions
percona-tools Applicable Versions
pg_repack Applicable Versions
phabricator Applicable Versions
phpbb Applicable Versions
phpstack Applicable Versions
postfixadmin Applicable Versions
poweradmin Applicable Versions
prestashop Applicable Versions
pythonstack Applicable Versions
q2a Applicable Versions
railsbox Applicable Versions
razor Applicable Versions
redmine2 Applicable Versions
repmgr Applicable Versions
rubycas Applicable Versions
singularity Applicable Versions
sogo Applicable Versions
sonarqube-mysql Applicable Versions
spinen-artifactory Applicable Versions
spree Applicable Versions
stack_commons Applicable Versions
stackstorm Applicable Versions
stash Applicable Versions
sugarcrm-ce Applicable Versions
symfony Applicable Versions
tango Applicable Versions
teampass Applicable Versions
tonicdns Applicable Versions
vicnum Applicable Versions
wordpress Applicable Versions
zabbix Applicable Versions
zabbix-pkg Applicable Versions
zabbix2 Applicable Versions
zabbix_lwrp Applicable Versions
zarafa Applicable Versions
zf2 Applicable Versions

No quality metric results found