Ceph is a distributed object, block, and file storage platform
C++ Terra Python C Shell Assembly Other
Latest commit 8962f2c Feb 28, 2017 @liewegas liewegas committed on GitHub Merge pull request #13138 from liewegas/wip-vstart
vstart: clean up usage a bit

Reviewed-by: Kefu Chai <kchai@redhat.com>
Failed to load latest commit information.
admin doc: add doc for pybind of rgw Nov 9, 2016
bin git-archive-all.sh: use an actually unique tmp dir Nov 16, 2016
ceph-erasure-code-corpus @ 2d7d78b tests: erasure-code: add k=2, m=2 for isa & jerasure Dec 8, 2016
ceph-object-corpus @ 47fbf8c Revert "common/*Formatters: Split Formatters" Jan 15, 2016
cmake/modules Merge pull request #12977 from weixiaowilliam/crc32c_opt Feb 18, 2017
debian debian: Add missing tp files in deb packaging Feb 20, 2017
doc doc/release-notes: choose terms carefully Feb 27, 2017
etc set 128MB tcmalloc cache size by bytes Apr 29, 2016
examples librados examples: link and include from current source tree by default. Mar 17, 2016
fusetrace remove superfluous second semicolons at end of lines May 8, 2014
keys new release key Sep 17, 2015
man doc/man: avoid file builtin to solve build error Nov 15, 2016
mirroring doc: added new UK Ceph mirror to doc and mirroring Aug 1, 2016
qa Merge pull request #13663 from tchaikov/wip-ceph-git-for-workunit Feb 28, 2017
selinux selinux: Allow ceph to manage tmp files Sep 29, 2016
share ceph-post-file: migrate to RSA SSH keys Aug 22, 2016
src Merge pull request #13138 from liewegas/wip-vstart Feb 28, 2017
systemd rbdmap: unmap RBDMAPFILE images unless called with unmap-all Feb 16, 2017
udev Merge pull request #10135 from david-z/wip-enhance-ceph-disk-bluestore Sep 22, 2016
.gitignore tests: save 9 characters for asok paths Nov 18, 2016
.gitmodule_mirrors Replace gmock/gtest with googletest Jul 13, 2016
.gitmodules add src/zstd submodule Jan 25, 2017
.mailmap mailmap: Yankun Li affiliation Feb 8, 2017
.organizationmap Affiliation updates Feb 11, 2017
.peoplemap mailmap: Update OVH contributors Feb 2, 2017
AUTHORS AUTHORS: update email Mar 1, 2016
CMakeLists.txt CMakeLists.txt: suppress unneeded warningiabout jemalloc Feb 12, 2017
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 28, 2008
CodingStyle CodingStyle: fix broken URLs Nov 30, 2015
Doxyfile Replace gmock/gtest with googletest Jul 13, 2016
INSTALL doc: INSTALL redirect to online documentation Dec 1, 2015
NEWS first pass at autoconf and automake Jan 28, 2008
PendingReleaseNotes osd: remove copy-get-classic Feb 23, 2017
README README: symlink from README.md Aug 6, 2014
README.FreeBSD README.FreeBSD: update current status Nov 21, 2016
README.aix aix shared library build Nov 25, 2015
README.md README: hint at where to look to diagnose test failures Nov 10, 2016
README.solaris aix gcc librados port Nov 23, 2015
README.xio xio: Update README.xio with dependencies Mar 17, 2015
SubmittingPatches.rst doc: clarify SubmittingPatches.rst Jan 18, 2017
ceph.spec.in Merge pull request #13515 from smithfarm/wip-17613 Feb 21, 2017
do_cmake.sh do_cmake.sh: set BOOST_J to $(nproc) Nov 7, 2016
do_freebsd.sh do_freebsd.sh: the EMBEDDED target is not (yet) working for FreeBSD Feb 24, 2017
doc_deps.deb.txt admin/build-doc: use doc_deps.deb.txt for build-deps instead May 24, 2016
install-deps.sh build/install-deps.sh: Add sphinx package for DOCS Feb 1, 2017
make-debs.sh make-debs.sh: use make-dist Oct 3, 2016
make-dist make-dist: do not use make_version (and remove it) Oct 31, 2016
make-srpm.sh Pass first parameter to make-dist for building SRPM Feb 17, 2017
pom.xml update license for libcephfs Aug 26, 2014
run-make-check.sh build/ops: add sanity checks to run-make-check.sh Dec 27, 2016


Ceph - a scalable distributed storage system

Please see http://ceph.com/ 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 git@github.com:ceph/ceph

or, if you are not a github user,

git clone git://github.com/ceph/ceph

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 ceph.spec.in 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.

To build only certain targets use:

    make [target name]

To install:

    make install

CMake Options

If you run the cmake command by hand, there are many options you can set with "-D". For example the option to build the RADOS Gateway is defaulted to ON. To build without the RADOS Gateway:

    cmake -DWITH_RADOSGW=OFF [path to top level ceph directory]

Another example below is building with debugging and alternate locations for a couple of external dependencies:

    cmake -DLEVELDB_PREFIX="/opt/hyperleveldb" -DOFED_PREFIX="/opt/ofed" \
    -DCMAKE_INSTALL_PREFIX=/opt/accelio -DCMAKE_C_FLAGS="-O0 -g3 -gdwarf-4" \

To view an exhaustive list of -D options, you can invoke cmake with:

    cmake -LH

If you often pipe make to less and would like to maintain the diagnostic colors for errors and warnings (and if your compiler supports it), you can invoke cmake with:

    cmake -DDIAGNOSTICS_COLOR=always ..

Then you'll get the diagnostic colors when you execute:

    make | less -R

Other available values for 'DIAGNOSTICS_COLOR' are 'auto' (default) and 'never'.

Building a source tarball

To build a complete source tarball with everything needed to build from source and/or build a (deb or rpm) package, run


This will create a tarball like ceph-$version.tar.bz2 from git. (Ensure that any changes you want to include in your working directory are committed to git.)

Running a test cluster

To run a functional test cluster,

cd build
make vstart        # builds just enough to run vstart
../src/vstart.sh -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 build and run all tests (in parallel using all processors), use ctest:

cd build
ctest -j$(nproc)

(Note: Many targets built from src/test are not run using ctest. Targets starting with "unittest" are run in make check and thus can be run with ctest. Targets starting with "ceph_test" can not, and should be run by hand.)

When failures occur, look in build/Testing/Temporary for logs.

To build and run all tests and their dependencies without other unnecessary targets in Ceph:

    cd build
    make check -j$(nproc)

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

ctest -R [regex matching test name(s)]

(Note: ctest does not build the test it's running or the dependencies needed to run it)

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

ctest -V -R [regex matching test name(s)]

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

ctest -j [number of jobs]

There are many other flags you can give ctest 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: