Skip to content
Ceph is a distributed object, block, and file storage platform
Branch: master
Clone or download
liewegas Merge PR #27566 into master
* refs/pull/27566/head:
	auth: kill AuthUnknownSessionHandler
	auth: kill AuthUnknown* (except AuthUnknownSessionHandler)
	msg: remove old ms_* auth methods from Dispatcher interface
	mon/MonClient: discard old challenge if authorizer is bad
	msg/async/ProtocolV1: use AuthServer and AuthClient
	mon/Monitor: handle v1 call into handle_auth_request
	msg/Connection: add is_msgr2()
	mon/MonClient: tolerate lack of authorizer for some dispatchers

Reviewed-by: Ricardo Dias <>
Latest commit 66dac9d Apr 25, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update .github/stale.yml Apr 10, 2019
admin tools: pin the version of breathe that works with Python2 Apr 23, 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-object-corpus @ e32bf8c ceph-object-corpus: update to fix make check Apr 5, 2018
cmake/modules cmake/FindRocksDB: fix IMPORTED_LOCATION for ROCKSDB_LIBRARIES Mar 27, 2019
debian rpm,deb: let immutable-object-cache depend on librados2 Mar 25, 2019
doc Merge pull request #21154 from mslovy/rgw-admin-api Apr 24, 2019
examples librados: revert librados3/libradoscc back to librados2 Feb 20, 2019
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 mgr/dashboard: Fixed performance details context for host list row se… Jan 18, 2019
qa Merge pull request #27279 from dzafman/wip-divergent Apr 24, 2019
selinux igw: Add selinux support for ceph iscsi Nov 5, 2018
share ceph-post-file: migrate to RSA SSH keys Aug 22, 2016
sudoers.d osd: OSD device smart data include additional nvme data Jan 4, 2019
systemd build/ops: adding build spec for immutable object cache daemon Mar 21, 2019
.gitattributes githubmap: define merge conflict resolution Oct 10, 2017
.gitmodule_mirrors Replace gmock/gtest with googletest Jul 13, 2016
.gitmodules fmt: add fmt submodule back Mar 21, 2019
.organizationmap mailmap: sort organizationmap Mar 21, 2019
AUTHORS AUTHORS: Update Component Technical Leads and maintainers to canonica… Oct 18, 2017
CMakeLists.txt Merge pull request #24678 from rouming/master Mar 28, 2019
CONTRIBUTING.rst doc: Fixes a typo. Mar 15, 2017
COPYING Add function2 header Apr 8, 2019
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 PendingReleaseNotes: 14.2.1 note on crush required version Apr 17, 2019
README.FreeBSD doc: fix typos Sep 21, 2018
README.aix Remove embedded 'cephd' code May 11, 2018
README.solaris aix gcc librados port Nov 23, 2015
README.xio xio: Update README.xio with dependencies Mar 17, 2015
SubmittingPatches.rst SubmittingPatches: added inline markup to important references Jan 16, 2019 rpm: add "Provides: python3-*" for python packages Apr 9, 2019 build: FreeBSD does not have /etc/os-release Mar 4, 2019 build: LLVM ld does not like the versioning scheme Mar 6, 2019
doc_deps.deb.txt admin/build-doc: use doc_deps.deb.txt for build-deps instead May 24, 2016 alpine packaging helper Dec 21, 2016 clean dir to avoid build deb packages error Nov 24, 2018
make-dist mgr/dashboard: Update Node.js to current LTS Nov 7, 2018 Pass first parameter to make-dist for building SRPM Feb 17, 2017
pom.xml update license for libcephfs Aug 26, 2014 selectively enable deps on deb distros Feb 16, 2019

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 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.

Prerequisite: CMake 3.5.1

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.)

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


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.