Ceph is a distributed object, block, and file storage platform
C++ Terra C Python Shell Assembly Other
Latest commit 2dbff88 Jul 25, 2016 @jcsp jcsp committed on GitHub Merge pull request #10243 from jcsp/wip-cephfs-cleanup
CephFS: misc. cleanups and remove legacy cephfs tool

Reviewed-by: Nathan Cutler <ncutler@suse.com>
Failed to load latest commit information.
admin admin/build-doc: use doc_deps.deb.txt for build-deps instead May 24, 2016
bin make_dist.sh: rename from bin/make_dist_tarball.sh May 31, 2015
ceph-erasure-code-corpus @ c332279 submodules: revert an accidental change Mar 4, 2016
ceph-object-corpus @ 47fbf8c Revert "common/*Formatters: Split Formatters" Jan 15, 2016
cmake/modules Merge pull request #10352 from wjwithagen/wip-wjw-freebsd-cmake-2 Jul 24, 2016
debian Merge pull request #10243 from jcsp/wip-cephfs-cleanup Jul 25, 2016
doc Merge pull request #10243 from jcsp/wip-cephfs-cleanup Jul 25, 2016
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
m4 automake, ssl: real openssl detection, fix ssl linkage w/NSS Jun 29, 2016
man doc,cmake: do not scan non-man pages when building man pages May 24, 2016
mirroring mirrors: Change contact e-mail address for se.ceph.com Mar 9, 2016
qa Merge pull request #10123 from trociny/wip-16449 Jul 24, 2016
selinux selinux: allow read /proc/<pid>/cmdline Jul 19, 2016
share CodingStyle: Fix coding-style on PG related Monitor files Dec 10, 2015
src Merge pull request #10243 from jcsp/wip-cephfs-cleanup Jul 25, 2016
systemd systemd: add osd id to service description Jul 1, 2016
udev udev: always populate /dev/disk/by-parttypeuuid Jun 23, 2016
.gitignore .gitignore: exclude coredumps, logfiles and temporary testresults May 29, 2016
.gitmodule_mirrors Replace gmock/gtest with googletest Jul 12, 2016
.gitmodules googletest: use ceph branch Jul 12, 2016
.mailmap mailmap: Luo Runbing affiliation (was "runsisi", name normalization b… May 19, 2016
.organizationmap mailmap: Victor Denisov affiliation Jun 16, 2016
.peoplemap mailmap: Abhishek Lekshmanan affiliation Feb 8, 2016
AUTHORS AUTHORS: update email Mar 1, 2016
CMakeLists.txt Merge pull request #10352 from wjwithagen/wip-wjw-freebsd-cmake-2 Jul 24, 2016
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 27, 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
Makefile.am Replace gmock/gtest with googletest Jul 13, 2016
NEWS first pass at autoconf and automake Jan 28, 2008
PendingReleaseNotes release: release notes update for objclass-perms Jul 15, 2016
README README: symlink from README.md Aug 6, 2014
README.FreeBSD README.FreeBSD: Cmake instructions Jul 20, 2016
README.aix aix shared library build Nov 25, 2015
README.md cmake: Removed README.cmake.md, edited README.md Jun 30, 2016
README.solaris aix gcc librados port Nov 23, 2015
README.xio xio: Update README.xio with dependencies Mar 17, 2015
SubmittingPatches.rst doc: amend Fixes instructions in SubmittingPatches Mar 25, 2016
autogen.sh Replace gmock/gtest with googletest Jul 13, 2016
autogen_freebsd.sh FreeBSD/build: Files specific for building on FreeBSD May 10, 2016
ceph.spec.in Merge pull request #10243 from jcsp/wip-cephfs-cleanup Jul 25, 2016
configure.ac Replace gmock/gtest with googletest Jul 13, 2016
do_autogen.sh tools: fix do_autogen.sh -R Sep 2, 2015
do_cmake.sh do_cmake.sh: create initial ceph.conf setting dirs Jun 30, 2016
do_freebsd-cmake.sh do_freebsd-cmake.sh: script to cmake on FreeBSD Jul 20, 2016
do_freebsd.sh FreeBSD/build: Files specific for building on FreeBSD May 10, 2016
doc_deps.deb.txt admin/build-doc: use doc_deps.deb.txt for build-deps instead May 24, 2016
install-deps.sh install-deps: Get the latest virtualenv in a temporary folder Jul 13, 2016
make-debs.sh make-debs.sh: avoid creating recursive conf dir May 10, 2016
make-dist make-dist: generate ceph.spec Jun 28, 2016
pom.xml update license for libcephfs Aug 26, 2014
run-cmake-check.sh cmake: add arguments to cmake invocation to support cache configuration Jun 16, 2016
run-make-check.sh Revert "run-make-check.sh: run tests in two steps" Jul 19, 2016

README.md

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:

./install-deps.sh

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:

./do_cmake.sh
cd build
make

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 packages

You can build packages for Debian or Debian-derived (e.g., Ubuntu) systems with

sudo apt-get install dpkg-dev
dpkg-checkbuilddeps        # make sure we have all dependencies
dpkg-buildpackage

For RPM-based systems (Red Hat, SUSE, etc.),

rpmbuild

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,

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

Running unit tests

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

cd build
make
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.)

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

Prerequisites

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:

admin/build-doc