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

RSS

clustercontrol (11) Versions 1.0.0

Installs/Configures Severalnines Clustercontrol

Policyfile
Berkshelf
Knife
cookbook 'clustercontrol', '~> 1.0.0', :supermarket
cookbook 'clustercontrol', '~> 1.0.0'
knife supermarket install clustercontrol
knife supermarket download clustercontrol
README
Dependencies
Changelog
Quality 20%

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/TimescaleDB Streaming Replication
  • Redis Cluster
  • MSSQL Server 2019
  • Elasticsearch Cluster

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 info@severalnines.com.

Requirements

Platform

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

This has been tested on Chef with the most recently versions:

root@pupnode1   51:~# chef --version
Chef Workstation version: 23.7.1042
Chef Infra Client version: 18.2.7
Chef InSpec version: 5.22.3
Chef CLI version: 5.6.12
Chef Habitat version: 1.6.652
Test Kitchen version: 3.5.0
Cookstyle version: 7.32.2

and tested on Chef Server

root@pupnode150:~# chef-server-ctl version
15.8.0

Targetted supported platforms are the following:

  • RHEL/CentOS/Rocky Linux /AlmaLinux versions 7, 8, and 9
  • Ubuntu 18.04, 20.04, 22.04
  • Debian 8, 9, 10, 11, 12

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.

Attributes

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/s9s_helper.sh. Please run this script prior to the deployment.

Helper script - s9s_helper.sh

In every deployment if your ClusterControl using this S9S Cookbooks, make sure that you have properly configured it. Using the s9s_helper.sh script, this allows you to properly configure the parameters required to setup your environment.

Below is an example of a successful run using he s9s_helper.sh script.
```bash
$ cd ~/chef-repo/cookbooks/clustercontrol/files/default

root@pupnode151:~/chef-repo/cookbooks/clustercontrol/files/default# ./s9s_helper.sh

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'] : R00tP@55

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

ClusterControl will need a sudo user (from ClusterControl to all managed nodes) to perform automation tasks via SSH.
Enter the SSH user [default: root] : vagrant
Your desired ServerName in apache and your hostname in your cmon.
If you have multiple network device and IP addresses in your server, specify here your desired hostname/IP addresses.
Enter your desired IP address or hostname [default: set to FQDN detection by Chef] : 192.168.40.195

Generating config.json..
{
"id" : "config",
"mysql_root_password" : "R00tP@55",
"cmon_password" : "cm0nP@55w0rd",
"cmon_ssh_user" : "vagrant",
"cmon_user_home" : "/home/vagrant",
"cmon_server_host" : "192.168.40.195",
"clustercontrol_api_token" : "d22d3e7b210ab0dbe04de47afa9408c9a2d41243",
"clustercontrol_controller_id" : "bb47df956c69a4c24d8e24ce983b30f1be923a30"
}

Data bag file generated at /root/chef-repo/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 /root/chef-repo/cookbooks/clustercontrol/files/default/config.json

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

As mentioned, you must have to create a data bug to upload it to the Chef server repo. This means, doing that you have to run the following:
```
bash
$ knife data bag create clustercontrol
Created data_bag[clustercontrol]

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

$ cd /root/chef-repo/cookbooks/
$ knife cookbook upload clustercontrol
Uploading clustercontrol [0.1.8]
Uploaded 1 cookbook.
```

When using the s9s_helper.sh script, just make sure that you answer all questions prompted using the script 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.

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 clustercontrol.domain.com "role[cc_controller]"

where clustercontrol.domain.com is the hostname/FQDN/IP address of your ClusterController node.

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

$ sudo chef-client

Alternatively, you can also run this from the Workstation as follows,

bash
$ knife ssh 'name:clustercontrol.domain.com' 'sudo chef-client' -x vagrant

where in this example, vagrant is my OS user that both exist in my workstation and on the target client node (node to be setup for ClusterControl deployment).

ClusterControl general options

Following options are used for the general ClusterControl set up:

id

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

mysql_root_password

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

cmon_password

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

cmon_ssh_user

  • Specify the SSH user to be used for reaching out your client nodes from ClusterControl to your DB nodes. Make sure your SSH user has super and sudo access
  • Default: 'root'

cmon_user_home

Specify the SSH user's home directory. This shall be the user's home directory of your OS user from your CC controller node and the DB nodes.
- Default: '/root/'

cmon_server_host

Specify the hostname/FQDN/IP address of your CC controller node.
- Default: 'set to FQDN detection by Chef'

clustercontrol_api_token

  • 40-character ClusterControl token generated from s9s_helper script. Do not modify or do anything on this parameter. Let the script handles it for you.
  • Example: 'b7e515255db703c659677a66c4a17952515dbaf5'

clustercontrol_controller_id

  • 40-character ClusterControl token generated from s9s_helper script. Basically, this is your controller id.
  • Example: 'bb47df956c69a4c24d8e24ce983b30f1be923a30'

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

License and Authors

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

Copyright (c) 2023 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

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

  • 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

0.1.9

  • 16-Mar-2020 -- Updated README

0.1.8

  • 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 s9s-helper.sh -- Support new OSes: RHEL8, Debian 10, Ubuntu 18.04

0.1.7

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

0.1.6

  • 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

0.1.5

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

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

Collaborator Number Metric
            

1.0.0 failed this metric

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

Cookstyle Metric
            

1.0.0 failed this metric

Chef/Correctness/InvalidPlatformFamilyInCase: Use valid platform family values in case statements. (https://docs.chef.io/workstation/cookstyle/chef_correctness_invalidplatformfamilyincase): clustercontrol/recipes/controller.rb: 149
Chef/Correctness/InvalidPlatformHelper: Pass valid platforms to the platform? helper. (https://docs.chef.io/workstation/cookstyle/chef_correctness_invalidplatformhelper): clustercontrol/recipes/controller.rb: 596
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 351
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 419
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 585
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 586
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 737
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 738
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 740
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 742
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 745
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 746
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 747
Chef/Deprecations/LegacyNotifySyntax: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_legacynotifysyntax): clustercontrol/recipes/controller.rb: 748
Chef/Deprecations/NodeSet: Do not use node.set. Replace with node.normal to keep identical behavior. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_nodeset): clustercontrol/recipes/db_hosts.rb: 23
Chef/Deprecations/NodeSet: Do not use node.set. Replace with node.normal to keep identical behavior. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_nodeset): clustercontrol/recipes/db_hosts.rb: 25
Chef/Deprecations/NodeSet: Do not use node.set. Replace with node.normal to keep identical behavior. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_nodeset): clustercontrol/recipes/db_hosts.rb: 27
Chef/Modernize/ExecuteSleep: Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command. (https://docs.chef.io/workstation/cookstyle/chef_modernize_executesleep): clustercontrol/recipes/controller.rb: 278
Chef/RedundantCode/LongDescriptionMetadata: The long_description metadata.rb method is not used and is unnecessary in cookbooks. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_longdescriptionmetadata): clustercontrol/metadata.rb: 6

Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations

No Binaries Metric
            

1.0.0 passed this metric

Testing File Metric
            

1.0.0 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 https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

1.0.0 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 https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number