Adoptable Cookbooks List

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.

Ceph-Chef Cookbook

DESCRIPTION

Installs and configures Ceph, a distributed network storage and filesystem designed to provide excellent performance, reliability, and scalability. Supports Hammer and higher releases (nothing below Hammer is supported in this repo).

The current version is focused on installing and configuring Ceph for Ubuntu, CentOS and RHEL.

For documentation on how to use this cookbook, refer to the USAGE section.

Recommendation

Also, you can look at https://github.com/bloomberg/chef-bcs. That Chef App (repo) uses this repo for Bloomberg's large clusters. The chef-bcs repo is an S3 Object Store Cluster used in multiple data centers.

Note: The documentation is a WIP along with a few other features. This repo is actively managed.

NOTE: Users of ceph-cookbook

The original ceph-cookbook will remain and may continue to be updated (see that repo for specifics). We tried to use some of the interesting features of ceph-cookbook but we added a lot of enhancements and simplifications. Simply replacing ceph-cookbook with ceph-chef will not work without a few modifications. Also, ceph-chef only works with Chef 12.5+ and Hammer and higher. Nothing below the Hammer release of Ceph is supported in this repo. In addition, only civitweb is used going forward (not Apache).

NOTE: The current LWRP are using the style prior to Chef version 12.5. There will a new release shortly that will support the now recommended way of handling custom resources. To make that change easier we will be using a helper cookbook called Poise. Using Poise makes creating custom resources and common services very simple.

NOTE: The recommendation above on the Bloomberg Cluster repo will give you a solid design and/or provide ideas and guidance on laying out your Ceph cluster at scale.

This cookbook can be used to implement a chosen cluster design. Most of the configuration is retrieved from node attributes, which can be set by an environment json file or by a wrapper cookbook that updates the attributes directly. A basic cluster configuration will need most of the following attributes:

node['ceph']['config']['fsid'] - the cluster UUID

node['ceph']['config]'['global']['public network'] - a CIDR specification of the public network

node['ceph']['config]'['global']['rgw dns name'] - the main domain of the radosgw daemon

Most notably, the configuration does NOT need to set the mon initial members, because the cookbook does a node search based on TAGS to find other mons in the same environment. However, you can add them to node['ceph']['config']['global']['mon initial members'] = <whatever mon ip list you want>

The other set of attributes that this recipe needs is node['ceph']['osd']['devices'], which is an array of OSD definitions, similar to the following:

{'device' => '/dev/sdb'} - Use a full disk for the OSD, with a small partition for the journal

{'type' => 'directory', 'device' => '/src/node/sdb1/ceph'} - Use a directory, and have a small file for the journal

{'device' => '/dev/sdc', 'journal' => '/dev/sdd2'} - use a full disk for the OSD with a custom partition for the journal on another device such as an SSD or NMVe

Trouble Shooting

Pools - After creating it appears that some of the PGs are stuck 'creating+peering'. This can be caused by a number of things. Most likely an OSD is not blocking the creation. Do something like:
ceph pg ls-by-pool <whatever the pool name> | grep creating

Something like: ceph pg ls-by-pool .rgw | grep creating

It should show you the PG number as the first column. Use that to query it to see if something is blocking it.
ceph pg <pg num> query

Something like: ceph pg 175.f7 query

This will return a lot of json data. You can grep or look for 'blocking'. If found then restart the given OSD. You can find the host for the OSD with: ceph osd find <OSD number>

Once you're on the host simply restart the specific OSD with: sudo service ceph restart osd.<whatever the number>

Using a Policy Wrapper Cookbook

To automate setting several of these node attributes, it is recommended to use a policy wrapper cookbook. This allows the ability to use Chef Server cookbook versions along with environment version restrictions to roll out configuration changes in an ordered fashion.

It also can help with automating some settings. For example, a wrapper cookbook could peek at the list of hard drives that ohai has found and populate node['ceph']['osd_devices'] accordingly, instead of manually typing them all in:

For best results, the wrapper cookbook's recipe should be placed before the Ceph cookbook in the node's runlist. This will ensure that any attributes are in place before the Ceph cookbook runs and consumes those attributes.

Ceph Monitor

Ceph monitor nodes should use the ceph-mon role.

Includes:

ceph-chef::default

Ceph Metadata Server

Ceph metadata server nodes should use the ceph-mds role.

Includes:

ceph-chef::default

Ceph OSD

Ceph OSD nodes should use the ceph-osd role

Includes:

ceph-chef::default

Ceph RADOS Gateway (RGW)

Ceph RGW nodes should use the ceph-radosgw role

ATTRIBUTES

General

node['ceph']['search_environment'] - a custom Chef environment to search when looking for mon nodes. The cookbook defaults to searching the current environment

node['ceph']['branch'] - selects whether to install the stable, testing, or dev version of Ceph

node['ceph']['version'] - install a version of Ceph that is different than the cookbook default. If this is changed in a wrapper cookbook, some repository urls may also need to be replaced, and they are found in attributes/repo.rb. If the branch attribute is set to dev, this selects the gitbuilder branch to install

node['ceph']['config']['config-sections'] - add to this hash to add extra config sections to the ceph.conf

node['ceph']['user_pools'] - an array of pool definitions, with attributes name, pg_num and create_options (optional), that are automatically created when a monitor is deployed

Ceph MON

node['ceph']['config']['mon'] - a hash of settings to save in ceph.conf in the [mon] section, such as 'mon osd nearfull ratio' => '0.75'

Ceph OSD

node['ceph']['osd_devices'] - an array of OSD definitions for the current node

node['ceph']['config']['osd'] - a hash of settings to save in ceph.conf in the [osd] section, such as 'osd max backfills' => 2

node['ceph']['config']['osd']['osd crush location'] - this attribute can be set on a per-node basis to maintain Crush map locations

Ceph MDS

node['ceph']['config']['mds'] - a hash of settings to save in ceph.conf in the [mds] section, such as 'mds cache size' => '100000'

node['ceph']['cephfs_mount'] - where the cephfs recipe should mount CephFS

node['ceph']['cephfs_use_fuse'] - whether the cephfs recipe should use the fuse cephfs client. It will default to heuristics based on the kernel version

Ceph RADOS Gateway (RGW)

Note: Only supports the newer 'civetweb' version of RGW (not Apache)

node['ceph']['radosgw']['port'] - Port of the rgw. Defaults to 80

node['ceph']['radosgw']['rgw_dns_name'] - the main domain of the radosgw daemon, to calculate the bucket name from a subdomain

Resources/Providers

ceph_client

The ceph_client LWRP provides an easy way to construct a Ceph client key. These keys are needed by anything that needs to talk to the Ceph cluster, including RGW, CephFS, and RBD access.

Actions

:add - creates a client key with the given parameters

Parameters

:name - name attribute. The name of the client key to create. This is used to provide a default for the other parameters

:caps - A hash of capabilities that should be granted to the client key. Defaults to { 'mon' => 'allow r', 'osd' => 'allow r' }

:as_keyring - Whether the key should be saved in a keyring format or a simple secret key. Defaults to true, meaning it is saved as a keyring

:keyname - The key name to register in Ceph. Defaults to client.#{name}.#{hostname}

:filename - Where to save the key. Defaults to /etc/ceph/ceph.client.#{name}.#{hostname}.keyring if as_keyring and /etc/ceph/ceph.client.#{name}.#{hostname}.secret if not as_keyring

:owner - Which owner should own the saved key file. Defaults to root

:group - Which group should own the saved key file. Defaults to root

:mode - What file mode should be applied. Defaults to '00640'

ceph_cephfs

The ceph_cephfs LWRP provides an easy way to mount CephFS. It will automatically create a Ceph client key for the machine and mount CephFS to the specified location. If the kernel client is used, instead of the fuse client, a pre-existing subdirectory of CephFS can be mounted instead of the root.

Actions

:mount - mount CephFS

:umount - unmount CephFS

:remount - remount CephFS

:enable - adds an fstab entry to mount CephFS

:disable - removes an fstab entry to mount CephFS

Parameters

:directory - name attribute. Where to mount CephFS in the local filesystem

:use_fuse - whether to use ceph-fuse or the kernel client to mount the filesystem. ceph-fuse is updated more often, but the kernel client allows for subdirectory mounting. Defaults to true

:cephfs_subdir - which CephFS subdirectory to mount. Defaults to '/'. An exception will be thrown if this option is set to anything other than '/' if use_fuse is also true

ceph_pool

The ceph_pool LWRP provides an easy way to create and delete Ceph pools.

It assumes that connectivity to the cluster is setup and that admin credentials are available from default locations, e.g. /etc/ceph/ceph.client.admin.keyring.

Actions

:add - creates a pool with the given number of placement groups

:delete - deletes an existing pool

Parameters

:name - the name of the pool to create or delete

:pg_num - number of placement groups, when creating a new pool

:create_options - arguments for pool creation (optional)

:force - force the deletion of an exiting pool along with any data that is stored in it

DEVELOPING

Style Guide

This cookbook requires a style guide for all contributions. Travis will automatically verify that every Pull Request follows the style guide.

LICENSE AND AUTHORS

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.

Contingent cookbooks

ceph-chef

v0.9.0 (2015-11-17)

BETA: Documentation needs more clarity and substance. There are still true OS agnostic testing going on. One major
change coming is an update to the newer Chef style of moving provider/resource into classes in the libraries folder.
This will simplify the cookbook structure going forward.

Support for Chef 12.5+

Complete Ceph functionality

Only supports Ceph Hammer and above

RADOS Gateway (RGW) only supports civetweb style (no Apache)

Foodcritic Metric

0.9.22 failed this metric

FC002: Avoid string interpolation where not required: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/erasure_profiles_set.rb:28FC002: Avoid string interpolation where not required: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/pools_remove.rb:28FC002: Avoid string interpolation where not required: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_federated.rb:119FC002: Avoid string interpolation where not required: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_federated.rb:120FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:567FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:576FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:585FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:594FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:603FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:612FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:621FC004: Use a service resource to start and stop services: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/mon_stop.rb:35FC004: Use a service resource to start and stop services: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/osd_stop_all.rb:34FC022: Resource condition within loop may not behave as expected: /tmp/cook/652424211ee951830c180cdf/ceph-chef/libraries/ceph_chef_helper.rb:140FC022: Resource condition within loop may not behave as expected: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_federated.rb:49FC022: Resource condition within loop may not behave as expected: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_federated.rb:58FC023: Prefer conditional attributes: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/maint_osd_remove_zap.rb:70FC023: Prefer conditional attributes: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/maint_osd_remove_zap.rb:85FC023: Prefer conditional attributes: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/maint_osd_remove_zap.rb:94FC023: Prefer conditional attributes: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/rpm.rb:37FC034: Unused template variables: /tmp/cook/652424211ee951830c180cdf/ceph-chef/templates/default/ceph.conf.erb:1FC048: Prefer Mixlib::ShellOut: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_users.rb:26FC048: Prefer Mixlib::ShellOut: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_users.rb:27FC048: Prefer Mixlib::ShellOut: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_users.rb:37FC048: Prefer Mixlib::ShellOut: /tmp/cook/652424211ee951830c180cdf/ceph-chef/recipes/radosgw_users.rb:38