puppet-ceph/README.md

ceph

Table of Contents

1. Overview - What is the ceph module?
2. Module Description - What does the module do?
3. Setup - The basics of getting started with ceph
4. Implementation - An under-the-hood peek at what the module is doing
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
7. Contributors - Those with commits
8. Integration - Apply the module and test restults
9. Release Notes - Notes on the most recent updates to the module

Overview

The ceph module is intended to leverage all Ceph has to offer and allow for a wide range of use case. Although hosted on the OpenStack infrastructure, it does not require to sign a CLA nor is it restricted to OpenStack users. It benefits from a structured development process that helps federate the development effort. Each component is unit tested and an integration test shows that it performs as expected when used with a realistic scenario.

Module Description

The ceph module deploys a Ceph cluster ( MON, OSD ), the Cephfs file system and the RadosGW object store. It provides integration with various environments ( OpenStack ... ) and components to be used by third party puppet modules that depend on a Ceph cluster.

Setup

Implementation

A blueprint contains an inventory of what is desirable. It was decided to start from scratch and implement one module at a time.

Limitations

Development

The developer documentation of the puppet-openstack project is the reference:

• https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation

Mailing lists:

• (puppet-openstack)[https://groups.google.com/a/puppetlabs.com/forum/#!forum/puppet-openstack]
• (ceph-devel)[http://ceph.com/resources/mailing-list-irc/]

IRC channels:

• irc.freenode.net#puppet-openstack
• irc.oftc.net#ceph-devel

Integration

Relies on rspec-system-puppet and tests are in spec/system. It runs virtual machines and requires 4GB of free memory and 10GB of free disk space.

• Install Vagrant and Virtualbox

• bundle install --path vendor/bundle

• bundle exec rake spec:system

On success it should complete with

...
=end=============================================================
Finished in 4 minutes 1.7 seconds
1 example, 0 failures

Contributors

• https://github.com/stackforge/puppet-ceph/graphs/contributors

Release Notes