Ceph Puppet Module
Go to file
XinxinShen a733e34266 setup.cfg: Replace dashes with underscores
Setuptools v54.1.0 introduces a warning that the use of
dash-separated options in 'setup.cfg' will not be supported
in a future version [1].
Get ahead of the issue by replacing the dashes with underscores.
Without this, we see 'UserWarning' messages
like the following on new enough
versions of setuptools:

  UserWarning: Usage of dash-separated 'description-file' will not be
  supported in future versions. Please use the underscore name
  'description_file' instead

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Change-Id: I83fc7f428b179e038b57e8c2f0bbc7be6879cacb
2021-05-12 01:52:11 +00:00
doc Update sphinx to the latest version 2021-03-27 15:31:56 +08:00
examples Change default version to Ceph Nautilus 2019-04-04 14:40:37 +02:00
lib/puppet Set lowercase for ceph_config values 2017-06-12 14:57:05 -03:00
manifests Fix lint errors with the latest lint packages 2021-05-12 10:43:30 +09:00
releasenotes Set openstackdocs_auto_name to use 'project' as name 2020-09-16 11:05:05 +08:00
spec Remove beaker 2020-09-11 10:28:20 +00:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:23 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:31:41 +00:00
.zuul.yaml Make p-o-i jobs voting again for puppet-ceph 2019-04-24 10:42:26 +02:00
CONTRIBUTING.rst [ussuri][goal] Add CONTRIBUTING.rst 2020-05-10 22:32:11 +02:00
Gemfile Use openstack_spec_helper from zuul checkout 2020-08-30 22:53:44 +02:00
LICENSE Add project files 2013-10-20 22:45:54 -07:00
README.md Remove beaker 2020-09-11 10:28:20 +00:00
Rakefile Re-boostrap beaker tests 2016-07-07 16:27:14 -04:00
USECASES.md Remove Puppetfile in favor of metadata.json 2016-04-12 14:34:29 +00:00
bindep.txt Add Puppet package to bindep, for module build 2017-10-30 23:50:26 +00:00
metadata.json Merge "Bump dependency in metadata.json" 2021-04-13 11:10:32 +00:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-12 01:52:11 +00:00
setup.py Prepare puppet-ceph for 1.0.0 2016-05-06 17:54:13 -04:00
tox.ini Replace deprecated UPPER_CONSTRAINTS_FILE variable 2020-11-11 09:08:35 +08:00

README.md

Team and repository tags

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. Contributors - Those with commits
  9. Release Notes - Notes on the most recent updates to the module
  10. 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

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:

Mailing lists:

IRC channels:

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

Development

Developer documentation for the entire puppet-openstack project.

Contributors

Release Notes

Repository