Skip to content
Ceph is a distributed object, block, and file storage platform
C++ Python Terra C TypeScript Shell Other
Branch: master
Clone or download

Latest commit

liewegas Merge PR #34062 into master
* refs/pull/34062/head:
	cephadm: update check-host() to return all problems

Reviewed-by: Sebastian Wagner <>
Latest commit 9f3f05c Mar 28, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github .github: Rename orchestrator_cli to orchestrator Feb 17, 2020
admin Merge pull request #33911 from tchaikov/wip-cephfs-doc Mar 24, 2020
alpine alphine: remove urcu Oct 5, 2019
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 @ e9bd1db ceph-object-corpus: forward_incompat pg_missing_item and pg_missing_t May 9, 2019
cmake cmake: Don't enable BOOST_USE_VALGRIND when not requested Mar 21, 2020
debian rgw: remove unused librgw_admin_user Mar 25, 2020
doc Merge pull request #34209 from smithfarm/wip-doc-multi-cluster-follow… Mar 27, 2020
etc packaging: remove SuSEfirewall2 support Jul 12, 2019
examples Merge pull request #33063 from theanalyst/boto3-ext-append Feb 28, 2020
fusetrace fusetrace: s/Mutex/ceph::mutex/ Aug 3, 2019
keys new release key Sep 17, 2015
man man: skip directive starting with ".." Aug 15, 2018
mirroring docs: Update maintainers, update to include Mir… Jan 24, 2020
monitoring Merge pull request #32749 from james58899/fix-capacity Mar 27, 2020
qa Merge pull request #33279 from rishabh-d-dave/fs-move-run_shell-and-r… Mar 27, 2020
selinux selinux: Allow ceph to setsched Feb 19, 2020
share ceph-post-file: migrate to RSA SSH keys Aug 22, 2016
src Merge PR #34062 into master Mar 28, 2020
sudoers.d files,rpm,deb: rename ceph-daemon -> cephadm Dec 12, 2019
systemd systemd: Wait 5 seconds before attempting a restart of an OSD Nov 12, 2019
udev udev: remove parttypeuuid rules for ceph-disk Jun 13, 2018
.gitattributes githubmap: define merge conflict resolution Oct 10, 2017
.githubmap Merge PR #33850 into octopus Mar 10, 2020
.gitignore .gitignore: Add .mypy-cache to .gitignore Feb 24, 2020
.gitmodule_mirrors Replace gmock/gtest with googletest Jul 13, 2016
.gitmodules remove cephadm-adoption-corpus as submodule Feb 27, 2020
.mailmap mailmap: sort entries Mar 21, 2019
.organizationmap .organizationmap: Wido 42on -> 42on Dec 15, 2019
.peoplemap mailmap: updates for nautilus Mar 21, 2019
AUTHORS AUTHORS: Update Component Technical Leads and maintainers to canonica… Oct 18, 2017
CMakeLists.txt Merge remote-tracking branch 'gh/octopus' Mar 24, 2020
CONTRIBUTING.rst doc: Fixes a typo. Mar 15, 2017
COPYING relicense LGPL-2.1 code as LGPL-2.1 or LGPL-3.0 Apr 22, 2019
COPYING-GPL2 Add GPLv2 text file Feb 27, 2015
COPYING-LGPL2.1 Squashed 'src/dmclock/' changes from 6f9250b4e9..5538352024 Mar 21, 2018
COPYING-LGPL3 relicense LGPL-2.1 code as LGPL-2.1 or LGPL-3.0 Apr 22, 2019
CodingStyle coding-style: update a link and fix typos. Feb 7, 2020
Doxyfile Replace gmock/gtest with googletest Jul 13, 2016
PendingReleaseNotes mon/OSDMonitor: add flag `--yes-i-really-mean-it` for setting pool si… Mar 9, 2020
README.FreeBSD doc: fix typos Sep 21, 2018
README.aix aix shared library build Nov 25, 2015 Remove embedded 'cephd' code May 11, 2018 remove stale cmake prerequisite Jan 21, 2020
README.solaris aix gcc librados port Nov 23, 2015 [win32] Add build scripts Feb 19, 2020
SubmittingPatches-backports.rst doc: Small update of SubmittingPatches-backports Oct 25, 2019
SubmittingPatches-kernel.rst doc: split up SubmittingPatches.rst Oct 17, 2019
SubmittingPatches.rst doc: split up SubmittingPatches.rst Oct 17, 2019 rgw: remove unused librgw_admin_user Mar 25, 2020 bail out if something goes wrong Jan 31, 2020 rgw/pubsub: add kafka notification endpoint Nov 5, 2019
doc_deps.deb.txt doc: missing virtualenv for build-doc Nov 26, 2019 remove the workaround to bootstrap a new venv Mar 12, 2020 alpine packaging helper Dec 21, 2016 clean dir to avoid build deb packages error Nov 24, 2018
make-dist cmake: Integrate Rook client generation Feb 13, 2020 Pass first parameter to make-dist for building SRPM Feb 17, 2017
pom.xml update license for libcephfs Aug 26, 2014 WITH_SEASTAR on demand Mar 4, 2020 update default container images Mar 17, 2020 [win32] Add build scripts Feb 19, 2020 [win32] Add build scripts Feb 19, 2020

Ceph - a scalable distributed storage system

Please see for current info.

Contributing Code

Most of Ceph is dual licensed under the LGPL version 2.1 or 3.0. 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

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.

Build instructions:

cd build

(Note: now defaults to creating a debug build of ceph that can be up to 5x slower with some workloads. Please pass "-DCMAKE_BUILD_TYPE=RelWithDebInfo" to to create a non-debug release.)

(Note: make alone will use only one CPU thread, this could take a while. use the -j option to use more threads. Something like make -j$(nproc) would be a good start.

This assumes you make your build dir a subdirectory of the ceph.git checkout. If you put it elsewhere, just point CEPH_GIT_DIRto the 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.


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/ --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:

You can’t perform that action at this time.