Ceph is a distributed object, block, and file storage platform
Clone or download
jdurgin Merge pull request #25080 from smithfarm/wip-37089
tests: make ceph-admin-commands.sh log what it does

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Latest commit bc2c80f Nov 14, 2018
Failed to load latest commit information.
.github .github/stale.yml: configure probot/stale to automatically close stal… Oct 15, 2018
admin doc: install build-doc deps without git clone Oct 3, 2018
alpine include/memory.h: remove memory.h Jun 26, 2018
bin scripts: fix bash path in shebangs (part 2) Sep 25, 2017
ceph-erasure-code-corpus @ 2d7d78b tests: erasure-code: add k=2, m=2 for isa & jerasure Dec 8, 2016
ceph-menv ceph-menv: mrun shell environment May 21, 2018
ceph-object-corpus @ e32bf8c ceph-object-corpus: update to fix make check Apr 5, 2018
cmake/modules cmake: update dpdk drivers/modules to accomodate dpdk submodule Oct 26, 2018
debian rpm,deb: libradospp1-dev should depend on librados-dev Nov 8, 2018
doc doc/governance: reference the new Ceph Foundation Nov 12, 2018
etc cmake: only create sysctl file on linux Nov 20, 2017
examples examples/librados: link c++ samples against libradospp Nov 8, 2018
fusetrace remove superfluous second semicolons at end of lines May 8, 2014
keys new release key Sep 17, 2015
man man: skip directive starting with ".." Aug 15, 2018
mirroring doc: remove CZ mirror May 4, 2018
monitoring/grafana cmake: Support grafana dashboard installation Oct 25, 2018
qa tests: make ceph-admin-commands.sh log what it does Nov 13, 2018
selinux ceph-fuse: add to selinux profile Sep 20, 2018
share ceph-post-file: migrate to RSA SSH keys Aug 22, 2016
src Merge pull request #25083 from iridescent-rsy/fix-typo Nov 14, 2018
sudoers.d sudoers.d/ceph-osd-smartctl: allow user ceph to run smartctl as root Jun 27, 2018
systemd Merge pull request #22349 from gregsfortytwo/wip-24368-osd-restarts Oct 19, 2018
udev udev: remove parttypeuuid rules for ceph-disk Jun 13, 2018
.gitattributes githubmap: define merge conflict resolution Oct 10, 2017
.githubmap .githubmap, .mailmap, .organizationmap: update contributors Oct 26, 2018
.gitignore mgr/dashboard: Ignore .idea directory (created by PyCharm for example) Sep 25, 2018
.gitmodule_mirrors Replace gmock/gtest with googletest Jul 13, 2016
.gitmodules c-ares: add c-ares submodule Jul 25, 2018
.mailmap .githubmap, .mailmap, .organizationmap: update contributors Oct 26, 2018
.organizationmap .githubmap, .mailmap, .organizationmap: update contributors Oct 26, 2018
.peoplemap mailmap: update affiliation for Mykola Golub Dec 24, 2017
AUTHORS AUTHORS: Update Component Technical Leads and maintainers to canonica… Oct 18, 2017
CMakeLists.txt cmake: Support grafana dashboard installation Oct 25, 2018
CONTRIBUTING.rst doc: Fixes a typo. Mar 15, 2017
COPYING Separate diskprediction local plugin from the diskprediction plugin Nov 5, 2018
COPYING-GPL2 Add GPLv2 text file Feb 27, 2015
COPYING-LGPL2.1 Squashed 'src/dmclock/' changes from 6f9250b4e9..5538352024 Mar 21, 2018
CodingStyle mgr/dashboard: Add reference to prettier in CodingStyle Jul 26, 2018
Doxyfile Replace gmock/gtest with googletest Jul 13, 2016
PendingReleaseNotes pybind: enable --keyword=arguments in ceph_argparse Nov 2, 2018
README.FreeBSD doc: fix typos Sep 21, 2018
README.aix aix shared library build Nov 25, 2015
README.alpine.md Remove embedded 'cephd' code May 11, 2018
README.md README.md: bump up required cmake to 3.5.1 Oct 9, 2018
README.solaris aix gcc librados port Nov 23, 2015
README.xio xio: Update README.xio with dependencies Mar 17, 2015
SubmittingPatches.rst SubmittingPatches: fix the spelling error May 31, 2018
ceph.spec.in rpm,deb: libradospp1-dev should depend on librados-dev Nov 8, 2018
do_cmake.sh do_cmake.sh: default to Debug build Sep 21, 2018
do_freebsd.sh FreeBSD: update build script to current state Aug 6, 2018
doc_deps.deb.txt admin/build-doc: use doc_deps.deb.txt for build-deps instead May 24, 2016
install-deps.sh install-deps.sh: install libtool-ltdl-devel for building python-saml Nov 13, 2018
make-apk.sh make-apk.sh: alpine packaging helper Dec 21, 2016
make-debs.sh make-debs.sh: Changed make-debs.sh to use current architecture Mar 27, 2018
make-dist Merge PR #23432 into master Aug 7, 2018
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 run-make-check,do_cmake: set BOOST_J if !WITH_SYSTEM_BOOS Sep 11, 2018


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 Share Alike 3.0 (CC-BY-SA-3.0). 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 3.5.1

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 .. in do_cmake.sh with a correct path to the checkout. Any additional CMake args can be specified setting ARGS before invoking do_cmake. See cmake options for more details. Eg.

ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh

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 --debug --new -x --localhost --bluestore
./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: