Team and repository tags

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. Use Cases - Examples of how to use this module
7. Development - Guide for contributing to the module
8. Beaker Integration Tests - Apply the module and test results
9. Contributors - Those with commits
10. Release Notes - Notes on the most recent updates to the module
11. Repository - Repository for 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 feature is tested with integration tests involving virtual machines to show 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

We follow the OS compatibility of Ceph. With the release of infernalis this is currently:

• CentOS 7 or later
• Debian Jessie 8.x or later
• Ubuntu Trusty 14.04 or later
• Fedora 22 or later

Use Cases

• I want to try this module, heard of ceph, want to see it in action
• I want to operate a production cluster
• I want to run benchmarks on three new machines

Development

git clone https://github.com/openstack/puppet-ceph.git
cd puppet-ceph
sudo gem install bundler
bundle install

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

• https://docs.openstack.org/puppet-openstack-guide/latest/

Mailing lists:

• puppet-openstack
• ceph-devel

IRC channels:

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

Beaker Integration Tests

Relies on rspec-beaker and tests are in spec/acceptance. It also requires Vagrant and Virtualbox .

bundle install
bundle exec rspec spec/acceptance

The BEAKER_set environment variable contains the resource set of linux distribution configurations for which integration tests are going to be run. Available values are

• two-centos-70-x64
• centos-70-x64
• two-ubuntu-server-1404-x64
• ubuntu-server-1404-x64

The default is

BEAKER_set=two-ubuntu-server-1404-x64 \
bundle exec rspec spec/acceptance

Development

Developer documentation for the entire puppet-openstack project.

• https://docs.openstack.org/puppet-openstack-guide/latest/

Contributors

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

Release Notes

• https://docs.openstack.org/releasenotes/puppet-ceph

Repository

• https://git.openstack.org/cgit/openstack/puppet-ceph