clustercontrol (15) Versions 0.1.4 Follow4

Installs/Configures Severalnines Clustercontrol

Policyfile

Berkshelf

Knife

cookbook 'clustercontrol', '= 0.1.4', :supermarket

cookbook 'clustercontrol', '= 0.1.4'

knife supermarket install clustercontrol

knife supermarket download clustercontrol

README

Dependencies

Changelog

Quality 0%

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 Replication
MySQL single instance
MySQL Cluster
MongoDB Replica Set
MongoDB Sharded Cluster
TokuMX Cluster
PostgreSQL single instance

Details at Severalnines website.

This cookbook is a replacement for 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 info@severalnines.com.

Requirements

Platform

CentOS, Redhat, Fedora
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
Ubuntu 12.04
Ubuntu 14.04
Debian 7
Debian 8

Make sure you meet 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.
If you are running as sudo user, make sure the user is able to escalate to root with sudo command.
SELinux/AppArmor must be turned off. Services or ports to be enabled are listed here.

Attributes

Please refer to attributes/default.rb

Data Bags

Data items are used by the ClusterControl controller 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/s9s_helper.sh. Please run this script prior to the deployment.

Helper script - s9s_helper.sh

$ cd ~/chef-repo/cookbooks/clustercontrol/files/default
$ ./s9s_helper.sh

Answer all the 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:
bash $ knife cookbook upload clustercontrol

Example data bag - clustercontrol/files/default/config.json

{
  "id"                      : "config",
  "cmon_password"           : "cmonP4ss",
  "mysql_root_password"     : "myR00tP4ssword",
  "clustercontrol_api_token": "b7e515255db703c659677a66c4a17952515dbaf5"
}

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

ClusterControl general options

Following options are used for the general ClusterControl set up:

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

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

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

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

Usage

clustercontrol::default, clustercontrol::controller

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

{
  "name":"clustercontrol_node",
  "run_list": [
    "recipe[clustercontrol]"
  ]
}

clustercontrol::db_hosts

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

{
  "name":"database_nodes",
  "run_list": [
    "recipe[clustercontrol::db_hosts]"
  ]
}

** 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 valid email address.

Limitations

This module has been tested on following platforms:

Debian 7 (wheezy)
Debian 8 (jessie)
Ubuntu 14.04 LTS (trusty)
Ubuntu 12.04 LTS (precise)
RHEL 6/7
CentOS 6/7

ClusterControl known issues and limitations.

Change History

v0.1.4 - Follow install-cc installation method. Tested with ClusterControl v1.2.11 on Chef 12. Support RHEL/CentOS 7, Debian 8 (Jessie).
v0.1.3 - Add datadir into s9s_helper
v0.1.2 - Fixed sudoer with password
v0.1.1 - Cleaning up and updated README
v0.1.0 - Initial recipes based on ClusterControl v1.2.8

License and Authors

Ashraf Sharif (ashraf@severalnines.com) Derived from Opscode, Inc cookbook recipes examples.

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

http://www.apache.org/licenses/LICENSE-2.0

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: https://support.severalnines.com

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.

0.1.4

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

0.1.3

19-Dec-2014 - Add datadir into s9s_helper

0.1.2

19-Dec-2014 - Fixed sudoer with password

0.1.1

19-Dec-2014 - Cleaning up and updated README

0.1.0

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

Foodcritic Metric

0.1.4 failed this metric

FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:47
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/attributes/default.rb:65
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:42
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:68
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:72
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:77
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:78
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:84
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:86
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:87
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:94
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:95
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:99
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:103
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:104
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:114
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:121
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:128
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:139
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:145
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:151
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:157
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:165
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:169
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:180
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:183
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:237
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:261
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:17
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:27
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:43
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:46
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:48
FC002: Avoid string interpolation where not required: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:60
FC019: Access node attributes in a consistent manner: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:47
FC023: Prefer conditional attributes: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:187
FC023: Prefer conditional attributes: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:188
FC023: Prefer conditional attributes: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:204
FC023: Prefer conditional attributes: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:46
FC041: Execute resource used to run curl or wget commands: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:28
FC043: Prefer new notification syntax: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:117
FC043: Prefer new notification syntax: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:168
FC043: Prefer new notification syntax: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:211
FC043: Prefer new notification syntax: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/controller.rb:244
FC043: Prefer new notification syntax: /tmp/cook/acb5c256cb09865b36ac7e38/clustercontrol/recipes/db_hosts.rb:47

Chef Supermarket

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

clustercontrol (15) Versions 0.1.4 Follow4

clustercontrol Cookbook

Requirements

Platform

Attributes

Data Bags

Helper script - s9s_helper.sh

Example data bag - clustercontrol/files/default/config.json

ClusterControl general options

Usage

clustercontrol::default, clustercontrol::controller

clustercontrol::db_hosts

Limitations

Change History

License and Authors

Dependent cookbooks

Contingent cookbooks

clustercontrol CHANGELOG

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Details

Updated December 11, 2015 Created on December 17, 2014

Supported Platforms

License

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

clustercontrol (15) Versions 0.1.4 2.0.3 2.0.2 2.0.1 2.0.0 1.0.0 0.1.10 0.1.9 0.1.8 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0 Follow4

clustercontrol Cookbook

Requirements

Platform

Attributes

Data Bags

Helper script - s9s_helper.sh

Example data bag - clustercontrol/files/default/config.json

ClusterControl general options

Usage

clustercontrol::default, clustercontrol::controller

clustercontrol::db_hosts

Limitations

Change History

License and Authors

Dependent cookbooks

Contingent cookbooks

clustercontrol CHANGELOG

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Details

Updated December 11, 2015 Created on December 17, 2014

Supported Platforms

License

clustercontrol (15) Versions 0.1.4 Follow4