cookbook 'ceph', '= 0.8.0'
ceph (4) Versions 0.8.0 Follow6
Installs/Configures the Ceph distributed filesystem
cookbook 'ceph', '= 0.8.0', :supermarket
knife supermarket install ceph
knife supermarket download ceph
Chef cookbook
DESCRIPTION
Installs and configures Ceph, a distributed network storage and filesystem designed to provide excellent performance, reliability, and scalability.
The current version is focused towards deploying Monitors and OSD on Ubuntu.
For documentation on how to use this cookbook, refer to the USAGE section.
For help, use Gitter chat, mailing-list or issues
REQUIREMENTS
Chef
>= 11.6.0
Platform
Tested as working:
- Debian Wheezy (7)
- Ubuntu Precise (12.04)
- Ubuntu Trusty (14.04)
Cookbooks
The ceph cookbook requires the following cookbooks from Chef:
TEMPLATES
USAGE
Ceph cluster design is beyond the scope of this README, please turn to the
public wiki, mailing lists, visit our IRC channel, or contact Inktank:
http://ceph.com/docs/master
http://ceph.com/resources/mailing-list-irc/
http://www.inktank.com/
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 or by a wrapper cookbook. 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']['cluster network']
- a CIDR specification of a separate cluster replication 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 to find other mons in the same environment.
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/sde', 'dmcrypt' => true} - Store the data encrypted by passing --dmcrypt to
ceph-disk-prepare
- {'device' => '/dev/sdc', 'journal' => '/dev/sdd2'} - use a full disk for the OSD with a custom partition for the journal
Ceph Monitor
Ceph monitor nodes should use the ceph-mon role.
Includes:
- ceph::default
Ceph Metadata Server
Ceph metadata server nodes should use the ceph-mds role.
Includes:
- ceph::default
Ceph OSD
Ceph OSD nodes should use the ceph-osd role
Includes:
- ceph::default
Ceph Rados Gateway
Ceph Rados Gateway 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']['extras_repo']
- whether to install the ceph extras repo. The tgt recipe requires thisnode['ceph']['config']['fsid']
- the cluster UUIDnode['ceph']['config']['global']['public network']
- a CIDR specification of the public networknode['ceph']['config']['global']['cluster network']
- a CIDR specification of a separate cluster replication networknode['ceph']['config']['config-sections']
- add to this hash to add extra config sections to the ceph.conf
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.70'
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
-
node['ceph']['radosgw']['api_fqdn']
- what vhost to configure in the web server -
node['ceph']['radosgw']['admin_email']
- the admin email address to configure in the web server -
node['ceph']['radosgw']['rgw_addr']
- the web server's bind address, such as *:80 -
node['ceph']['radosgw']['rgw_port']
- if set, connects to the radosgw fastcgi over this port instead of a unix socket -
node['ceph']['radosgw']['webserver_companion']
- defaults to 'apache2', but can be set to false to not configure anything -
node['ceph']['radosgw']['path']
- where to save the s3gw.fcgi file -
node['ceph']['config']['global']['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 RadosGW, 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
ifas_keyring
and/etc/ceph/ceph.client.#{name}.#{hostname}.secret
if notas_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 - mounts CephFS
- :umount - unmounts CephFS
- :remount - remounts 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
DEVELOPING
Style Guide
This cookbook requires a style guide for all contributions. Travis will automatically verify that every Pull Request follows the style guide.
- Install ChefDK
- Activate ChefDK's copy of ruby:
eval "$(chef shell-init bash)"
bundle install
bundle exec rake style
Testing
This cookbook uses Test Kitchen to verify functionality. A Pull Request can't be merged if it causes any of the test configurations to fail.
- Install ChefDK
- Activate ChefDK's copy of ruby:
eval "$(chef shell-init bash)"
bundle install
bundle exec kitchen test aio-debian-74
bundle exec kitchen test aio-ubuntu-1204
bundle exec kitchen test aio-ubuntu-1404
LICENSE AND AUTHORS
Author: Kyle Bader kyle.bader@dreamhost.com
Copyright 2013, DreamHost Web Hosting and Inktank Storage 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
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.
Dependent cookbooks
apache2 >= 1.1.12 |
apt >= 0.0.0 |
yum >= 3.0 |
yum-epel >= 0.0.0 |
Contingent cookbooks
ceph
v0.2.0 (2014-03-03)
- Add tests and fixes related.
- Add ceph-extra
- Fix searching feature
- Refactor RPM part
- Add iscsi tgt
v0.1.0 (2013-07-18)
- Initial changelog
Foodcritic Metric
0.8.0 failed this metric
FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/30dc79b0e1a61f6c35698b41/ceph/libraries/default.rb:9
FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/30dc79b0e1a61f6c35698b41/ceph/libraries/default.rb:35
FC031: Cookbook without metadata file: /tmp/cook/30dc79b0e1a61f6c35698b41/ceph/metadata.rb:1
FC045: Consider setting cookbook name in metadata: /tmp/cook/30dc79b0e1a61f6c35698b41/ceph/metadata.rb:1
0.8.0 failed this metric
FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/30dc79b0e1a61f6c35698b41/ceph/libraries/default.rb:35
FC031: Cookbook without metadata file: /tmp/cook/30dc79b0e1a61f6c35698b41/ceph/metadata.rb:1
FC045: Consider setting cookbook name in metadata: /tmp/cook/30dc79b0e1a61f6c35698b41/ceph/metadata.rb:1