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


clustercontrol (15) Versions 0.1.10

Installs/Configures Severalnines Clustercontrol

cookbook 'clustercontrol', '= 0.1.10', :supermarket
cookbook 'clustercontrol', '= 0.1.10'
knife supermarket install clustercontrol
knife supermarket download clustercontrol
Quality 17%

Clustercontrol Cookbook

Installs ClusterControl for your new database node/cluster deployment or on top of your existing database node/cluster. ClusterControl is a management and automation software for database clusters. It helps deploy, monitor, manage and scale your database node/cluster.

Supported database clusters:

  • Galera Cluster for MySQL
  • Percona XtraDB Cluster
  • MariaDB Galera Cluster
  • MySQL/MariaDB Replication
  • MySQL/MariaDB single instance
  • MySQL Cluster (NDB)
  • MongoDB Replica Set
  • MongoDB Sharded Cluster
  • PostgreSQL Streaming Replication

Details at Severalnines website.

This cookbook is a replacement for the deprecated cmon cookbook that we have built earlier. It manages and configures ClusterControl and all of its components:

  • Install ClusterControl controller, cmonapi and UI via Severalnines package repository.
  • Install and configure MySQL, create CMON DB, grant cmon user and configure DB for ClusterControl UI.
  • Install and configure Apache, check permission and install SSL.
  • Copy the generated SSH key to all nodes (optional).

If you have any questions, you are welcome to get in touch via our contact us page or email us at



  • CentOS, Redhat, Fedora, Oracle Linux
  • Debian, Ubuntu
  • x86_64 architecture only

Tested on Chef Server 11.1/12.0 on following platforms (x86_64 only):

  • CentOS 6.5
  • CentOS 7
  • CentOS 8
  • Ubuntu 12.04
  • Ubuntu 14.04
  • Ubuntu 16.04
  • Ubuntu 18.04
  • Debian 7
  • Debian 8
  • Debian 9
  • Debian 10

Make sure you meet the following criteria prior to the deployment:

  • ClusterControl node must run on a clean dedicated host with internet connection.
  • If you want to add an existing cluster, ensure your database cluster is up and running.
  • SELinux/AppArmor must be turned off. Services or ports to be enabled are listed here.


Please refer to attributes/default.rb

Data Bags

Data items are used by the recipe to configure SSH public key on database hosts, grants cmon database user and setting up CMON configuration file. We provide a helper script located under clustercontrol/files/default/ Please run this script prior to the deployment.

Helper script -

$ cd ~/chef-repo/cookbooks/clustercontrol/files/default
$ ./
Helper script for ClusterControl Chef cookbook

ClusterControl will install a MySQL server and setup the MySQL root user.
Enter the password for MySQL root user [default: 's3cr3tcc'] : R00tP4ssw0rd

ClusterControl will create a MySQL user called 'cmon' for automation tasks.
Enter the password for user cmon [default: 's3cr3tcc'] : Bj990sPkj

ClusterControl will need a sudo user (from ClusterControl to all managed nodes) to perform automation tasks via SSH.
Enter the SSH user [default: root] : dbadmin

Generating config.json..
    "id" : "config",
    "mysql_root_password" : "R00tP4ssw0rd",
    "cmon_password" : "Bj990sPkj",
    "cmon_ssh_user" : "dbadmin",
    "cmon_user_home" : "/home/dbadmin",
    "clustercontrol_api_token" : "fe74e6d6918b71a48eb039e495b68b41d19e49ad"

Data bag file generated at /home/vagrant/.chef/cookbooks/clustercontrol/files/default/config.json
To upload the data bag, you can use following command:
$ knife data bag create clustercontrol
$ knife data bag from file clustercontrol /home/vagrant/.chef/cookbooks/clustercontrol/files/default/config.json

Reupload the cookbook since it contains a newly generated SSH key:
$ knife cookbook upload clustercontrol

Answer all questions and at the end of the wizard, it will generate a data bag file called config.json and a set of command that you can use to create and upload the data bag. If you run the script for the first time, it will ask to re-upload the cookbook since it contains a newly generated SSH key:

$ knife data bag create clustercontrol
Created data_bag[clustercontrol]

$ knife data bag from file clustercontrol /home/ubuntu/chef-repo/cookbooks/clustercontrol/files/default/config.json
Updated data_bag_item[clustercontrol::config]

$ knife cookbook upload clustercontrol
Uploading clustercontrol [0.1.8]
Uploaded 1 cookbook.

We highly recommend you to use encrypted data bag since it contains confidential information

Then, create a role, cc_controller:

$ cat cc_controller.rb
name "cc_controller"
description "ClusterControl Controller"
run_list ["recipe[clustercontrol]"]

Add the defined roles into Chef Server:

$ knife role from file cc_controller.rb
Updated Role cc_controller!

Assign the roles to the relevant nodes:

$ knife node run_list add "role[cc_controller]"

Finally, on the client side (ClusterControl host), apply the cookbook:

$ sudo chef-client

ClusterControl general options

Following options are used for the general ClusterControl set up:


  • The data item identifier. Do not change this value.


  • Specify the MySQL password for user cmon. The recipe will grant this user with specified password, and is required by ClusterControl.
  • Default: 's3cr3tcc'


  • Specify the MySQL root password. This recipe will install a fresh MySQL server and it will create a MySQL user.
  • Default: 's3cr3tcc'


  • 40-character ClusterControl token generated from s9s_helper script.
  • Example: 'b7e515255db703c659677a66c4a17952515dbaf5'


  • SSH user that will be used by ClusterControl to connect to all managed nodes. This user must be able to escalate as super-user.
  • Default: 'root'


clustercontrol::default, clustercontrol::controller

For ClusterControl host, just include clustercontrol or clustercontrol::controller in your node's run_list:

  "run_list": [


For database hosts, include clustercontrol::db_hosts in your node's run_list:

  "run_list": [

** Do not forget to generate databag before the deployment begins! Once the cookbook is applied to all nodes, open ClusterControl web UI at https://[ClusterControl IP address]/clustercontrol and create the default admin user with a valid email address.

License and Authors

Ashraf Sharif ( Derived from Opscode, Inc cookbook recipes examples.

Copyright (c) 2014 Severalnines AB.

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, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Please report bugs or suggestions via our support channel:

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

clustercontrol CHANGELOG

This file is used to list changes made in each version of the clustercontrol cookbook.


  • 26-Mar-2020 -- Tested with Oracle Enterprise 7 -- Added gpg installation for Debian -- Added flag checks for MySQL/Apache/CMON to restart only when necessary -- Removed sql directory after setup


  • 16-Mar-2020 -- Updated README


  • 16-Mar-2020 -- Tested with ClusterControl 1.7.5 version. -- Updated the default password values. -- Added /etc/default/cmon -- Use s9s.conf and s9s-ssl.conf for RHEL-based servers. -- Removed all CMONAPI references. -- Improvements on -- Support new OSes: RHEL8, Debian 10, Ubuntu 18.04


-- Tested with ClusterControl 1.7.2 version.
-- Fixed some minor bugs where adding a cluster does not shows up in the dashboard due to absence of cmon API configuration in the database
-- Fixed bug when automating an installation of CC then afterwards, automate and create a Cluster. It needs to restart the cmon daemon in order to reload the configuration such as the RPC token into the memory.


  • 16-Jul-2018 -- Tested with ClusterControl v1.6.1 on Chef 12. -- Added s9s cli installation via package manager -- Converted node.set to node.override -- Added cmon-cloud, cmon-ssh, cmon-events


  • 7-Jun-2016 - Tested with ClusterControl v1.3.1 on Chef 12.


  • 8-Dec-2015 - Follow install-cc installation method. Tested with ClusterControl v1.2.11 on Chef 12. Support RHEL/CentOS 7, Debian 8 (Jessie).


  • 19-Dec-2014 - Add datadir into s9s_helper


  • 19-Dec-2014 - Fixed sudoer with password


  • 19-Dec-2014 - Cleaning up and updated README


  • 17-Dec-2014 - Initial recipes based on ClusterControl v1.2.8

Collaborator Number Metric

0.1.10 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

0.1.10 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.1.10 failed this metric

FC043: Prefer new notification syntax: clustercontrol/recipes/controller.rb:116
FC043: Prefer new notification syntax: clustercontrol/recipes/controller.rb:169
FC043: Prefer new notification syntax: clustercontrol/recipes/controller.rb:220
FC043: Prefer new notification syntax: clustercontrol/recipes/controller.rb:273
FC043: Prefer new notification syntax: clustercontrol/recipes/controller.rb:281
FC043: Prefer new notification syntax: clustercontrol/recipes/controller.rb:307
FC043: Prefer new notification syntax: clustercontrol/recipes/controller.rb:316
FC064: Ensure issues_url is set in metadata: clustercontrol/metadata.rb:1
FC065: Ensure source_url is set in metadata: clustercontrol/metadata.rb:1
FC066: Ensure chef_version is set in metadata: clustercontrol/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: clustercontrol/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric

0.1.10 passed this metric

Testing File Metric

0.1.10 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.1.10 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