Repository files navigation

Please seehttp://ceph.com/ for current info.

Most of Ceph is licensed under the LGPL version 2.1. Somemiscellaneous code is under BSD-style license or is public domain.The documentation is licensed under Creative CommonsAttribution Share Alike 3.0 (CC-BY-SA-3.0). There are a handful of headersincluded here that are licensed under the GPL. Please see the fileCOPYING for a full inventory of licenses by file.

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

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

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

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

./install-deps.sh

Note that these instructions are meant for developers who arecompiling the code for development and testing. To build binariessuitable for installation we recommend you build deb or rpm packages,or refer to theceph.spec.in ordebian/rules to see whichconfiguration options are specified for production builds.

Prerequisite: CMake 2.8.11

Build instructions:

./do_cmake.shcd buildmake

This assumes you make your build dir a subdirectory of the ceph.gitcheckout. If you put it elsewhere, just replace.. in do_cmake.sh with acorrect path to the checkout.

To build only certain targets use:

    make [target name]

To install:

    make install

If you run thecmake command by hand, there are many options you canset with "-D". For example the option to build the RADOS Gateway isdefaulted 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 locationsfor 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 invokecmake with:

    cmake -LH

If you often pipemake toless and would like to maintain thediagnostic colors for errors and warnings (and if your compilersupports it), you can invokecmake 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'.

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

./make-dist

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

To run a functional test cluster,

cd buildmake 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,

../src/stop.sh

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

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

To build and run all tests (in parallel using all processors), usectest:

cd buildmakectest -j$(nproc)

(Note: Many targets built from src/test are not run usingctest.Targets starting with "unittest" are run inmake check and thus canbe run withctest. Targets starting with "ceph_test" can not, and shouldbe run by hand.)

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

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

    cd build    make check -j$(nproc)

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

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

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

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

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

To run an tests manually and run the jobs in parallel, runctest withthe-j flag:

ctest -j [number of jobs]

There are many other flags you can givectest for better controlover manual test execution. To view these options run:

man ctest

The list of package dependencies for building the documentation can befound indoc_deps.deb.txt:

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

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

admin/build-doc