Skip to content
Ceph is a distributed object, block, and file storage platform
C++ Terra C Python Shell Assembly Other
Latest commit 2cd0475 Jun 27, 2016 @ukernel ukernel committed on GitHub Merge pull request #9742 from xiexingguo/xxg-wip-server_cmode
mds/server: fix rare race when waitting for osdmap
Failed to load latest commit information.
admin admin/build-doc: use doc_deps.deb.txt for build-deps instead May 24, 2016
bin rename from bin/ May 31, 2015
ceph-erasure-code-corpus @ c332279 submodules: revert an accidental change Mar 4, 2016
ceph-object-corpus @ 47fbf8c Revert "common/*Formatters: Split Formatters" Jan 15, 2016
cmake/modules Merge pull request #9119 from runsisi/wip-fix-cmake-desc Jun 18, 2016
debian debian: move libcephfs-jni to section "java" Jun 18, 2016
doc Merge pull request #9813 from jcsp/wip-kernel-doc Jun 22, 2016
etc set 128MB tcmalloc cache size by bytes Apr 29, 2016
examples Fix Makefile in example/librados file. Oct 19, 2015
fusetrace remove superfluous second semicolons at end of lines May 8, 2014
keys new release key Sep 17, 2015
m4 crc32c: add aarch64 optimized crc32c implementation Mar 17, 2015
man doc,cmake: do not scan non-man pages when building man pages May 24, 2016
mirroring mirrors: Change contact e-mail address for Mar 9, 2016
qa Merge pull request #9248 from xiexingguo/xxg-wip-expose-requirejewel Jun 23, 2016
selinux selinux: allow chown for self and setattr for /var/run/ceph Jun 13, 2016
share CodingStyle: Fix coding-style on PG related Monitor files Dec 10, 2015
src Merge pull request #9742 from xiexingguo/xxg-wip-server_cmode Jun 27, 2016
systemd systemd: fix typo in preset file Apr 30, 2016
udev rpm: drop udev/95-ceph-osd-alt.rules May 6, 2016
.gitignore gitignore: ignore backup files from editors etc. Jan 27, 2016
.gitmodule_mirrors remove libs3 submodule Jul 30, 2015
.gitmodules .gitmodules: use clone Mar 8, 2016
.mailmap mailmap: Luo Runbing affiliation (was "runsisi", name normalization b… May 19, 2016
.organizationmap mailmap: Victor Denisov affiliation Jun 16, 2016
.peoplemap mailmap: Abhishek Lekshmanan affiliation Feb 8, 2016
AUTHORS AUTHORS: update email Mar 1, 2016
CMakeLists.txt cmake: fix mis-matched arguments to if warning Jun 10, 2016
CONTRIBUTING.rst doc: rename SubmittingPatches to SubmittingPatches.rst Jan 20, 2016
COPYING SIGPIPE suppression for platforms without SO_NOSIGPIPE or MSG_NOSIGNAL Nov 13, 2015
COPYING-GPL2 Add GPLv2 text file Feb 27, 2015
COPYING-LGPL2.1 COPYING: note licenses for all files, not just the default Jan 12, 2012
ChangeLog first pass at autoconf and automake Jan 27, 2008
CodingStyle CodingStyle: fix broken URLs Nov 30, 2015
Doxyfile doc: do not doxgen src/civetweb May 24, 2016
INSTALL doc: INSTALL redirect to online documentation Dec 1, 2015 rpm: drop udev/95-ceph-osd-alt.rules May 6, 2016
NEWS first pass at autoconf and automake Jan 28, 2008
PendingReleaseNotes Merge pull request #7741 from rjfd/wip-14527 Jun 14, 2016
README README: symlink from Aug 6, 2014
README.FreeBSD FreeBSD/build: Files specific for building on FreeBSD May 10, 2016
README.aix aix shared library build Nov 25, 2015 Change implementation to use a documented CACHE variable, and allow Jun 7, 2016 note about builds (they are for development!) Jun 23, 2016
README.solaris aix gcc librados port Nov 23, 2015
README.xio xio: Update README.xio with dependencies Mar 17, 2015
SubmittingPatches.rst doc: amend Fixes instructions in SubmittingPatches Mar 25, 2016 rocksdb: build rocksdb with its own Makefile Oct 17, 2015 FreeBSD/build: Files specific for building on FreeBSD May 10, 2016 Merge pull request #8818 from SUSE/wip-drop-ceph-ra Jun 23, 2016 Merge pull request #8818 from SUSE/wip-drop-ceph-ra Jun 23, 2016 tools: fix -R Sep 2, 2015 simple cmake helper Jun 22, 2016 FreeBSD/build: Files specific for building on FreeBSD May 10, 2016
doc_deps.deb.txt admin/build-doc: use doc_deps.deb.txt for build-deps instead May 24, 2016 use mk-build-deps instead of processing control Jun 21, 2016 avoid creating recursive conf dir May 10, 2016
make-dist make-dist: rename from Jun 10, 2016
pom.xml update license for libcephfs Aug 26, 2014 cmake: add arguments to cmake invocation to support cache configuration Jun 16, 2016 tests: rm -fr /tmp/*virtualenv* May 20, 2016

Ceph - a scalable distributed storage system

Please see for current info.

Contributing Code

Most of Ceph is licensed under the LGPL version 2.1. Some miscellaneous code is under BSD-style license or is public domain. The documentation is licensed under Creative Commons Attribution-ShareAlike (CC BY-SA). There are a handful of headers included here that are licensed under the GPL. Please see the file COPYING for a full inventory of licenses by file.

Code contributions must include a valid "Signed-off-by" acknowledging the license for the modified or contributed file. Please see the file SubmittingPatches.rst for details on what that means and on how to generate and submit patches.

We do not require assignment of copyright to contribute code; code is contributed under the terms of the applicable license.

Checking out the source

You can clone from github with

    git clone

or, if you are not a github user,

    git clone git://

Ceph contains many git submodules that need to be checked out with

    git submodule update --init --recursive

Build Prerequisites

The list of Debian or RPM packages dependencies can be installed with:


Building Ceph

Note that these instructions are meant for developers who are compiling the code for development and testing. To build binaries suitable for installation we recommend you build deb or rpm packages, or refer to the or debian/rules to see which configuration options are specified for production builds.

Prerequisite: CMake 2.8.11

Build instructions:

cd build

This assumes you make your build dir a subdirectory of the ceph.git checkout. If you put it elsewhere, just replace .. above with a correct path to the checkout.

Building packages

You can build packages for Debian or Debian-derived (e.g., Ubuntu) systems with

sudo apt-get install dpkg-dev
dpkg-checkbuilddeps        # make sure we have all dependencies

For RPM-based systems (Red Hat, SUSE, etc.),


Running a test cluster

To run a functional test cluster,

cd build
../src/ -d -n -x -l
./bin/ceph -s

Almost all of the usual commands are available in the bin/ directory. For example,

./bin/rados -p rbd bench 30 write
./bin/rbd create foo --size 1000

To shut down the test cluster,


To start or stop individual daemons, the sysvinit script can be used:

./bin/init-ceph restart osd.0
./bin/init-ceph stop

Running unit tests

To run build and run all tests, use ctest:

cd build
ctest -j$(nproc)

To run an individual test manually, run the ctest command with -R (regex matching):

    ctest -R [test name]

To run an individual test manually and see all the tests output, run the ctest command with the -V (verbose) flag:

    ctest -V -R [test name]

To run an tests manually and run the jobs in parallel, run the ctest command with the -j flag:

    ctest -j [number of jobs]

There are many other flags you can give the ctest command for better control over manual test execution. To view these options run:

    man ctest

Building the Documentation


The list of package dependencies for building the documentation can be found in doc_deps.deb.txt:

sudo apt-get install `cat doc_deps.deb.txt`

Building the Documentation

To build the documentation, ensure that you are in the top-level `/ceph directory, and execute the build script. For example:

Something went wrong with that request. Please try again.