Ceph is a distributed object, block, and file storage platform
Go to file
Patrick Donnelly 716db6e2fd
qa: add .qa helper link
This utilizes the recent feature in teuthology [1] to skip hidden files in
suites when building the job matrix.

Idea of this change is to enable referring to the top-level qa directory in a
position-independent way such that copies of a suite to another location do not
break any symlinks.

[1] https://github.com/ceph/teuthology/pull/1185

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2018-06-26 11:33:48 -07:00
admin
alpine alpine: remove ceph-disk ceph-detect-init python files 2018-06-13 15:16:26 -04:00
bin
ceph-erasure-code-corpus@2d7d78b9cc
ceph-object-corpus@e32bf8ca3d ceph-object-corpus: update to fix make check 2018-04-05 10:50:32 -07:00
cmake/modules Merge pull request #22591 from tchaikov/wip-gcc-8.1 2018-06-26 12:41:57 +08:00
debian Merge PR #22586 into master 2018-06-22 13:00:35 -05:00
doc Merge pull request #22283 from rjfd/wip-dashboard-user-roles 2018-06-26 15:18:12 +02:00
etc
examples
fusetrace
keys
man legal: remove doc license ambiguity 2018-03-13 18:59:02 +01:00
mirroring doc: remove CZ mirror 2018-05-04 10:46:14 +02:00
monitoring/grafana add monitoring subdir and Grafana cluster dashboard 2018-05-07 14:25:29 +02:00
qa qa: add .qa helper link 2018-06-26 11:33:48 -07:00
selinux selinux: Allow ceph to block suspend 2018-05-14 12:24:19 +02:00
share
src Merge pull request #22715 from LenzGr/mgr-dashboard-24623 2018-06-26 15:31:23 +02:00
systemd systemd: remove ceph-disk from CMakeLists 2018-06-13 15:16:22 -04:00
udev udev: remove parttypeuuid rules for ceph-disk 2018-06-13 15:16:22 -04:00
.gitattributes
.githubmap Merge PR #22588 into master 2018-06-23 17:05:35 -05:00
.gitignore
.gitmodule_mirrors
.gitmodules seastar: add seastar as a submodule 2018-06-08 20:58:15 +08:00
.mailmap doc: add Xin Yuan and Yichao Li's affiliation 2018-04-12 09:09:43 +00:00
.organizationmap doc: add Xin Yuan and Yichao Li's affiliation 2018-04-12 09:09:43 +00:00
.peoplemap
AUTHORS
CMakeLists.txt cmake: only build extra boost libraries only if WITH_SEASTAR 2018-06-12 12:38:05 +08:00
CONTRIBUTING.rst
COPYING legal: remove doc license ambiguity 2018-03-13 18:59:02 +01:00
COPYING-GPL2
COPYING-LGPL2.1
CodingStyle CodingStyle: update my_type_t sample 2018-05-24 14:03:49 -05:00
Doxyfile
PendingReleaseNotes mon/OSDMonitor: change 'osd find' output to list all addrs 2018-06-01 08:08:20 -05:00
README.FreeBSD
README.aix
README.alpine.md Remove embedded 'cephd' code 2018-05-11 13:10:26 -07:00
README.md legal: remove doc license ambiguity 2018-03-13 18:59:02 +01:00
README.solaris
README.xio
SubmittingPatches.rst SubmittingPatches: fix the spelling error 2018-05-31 20:35:39 +08:00
ceph.spec.in Merge PR #22586 into master 2018-06-22 13:00:35 -05:00
do_cmake.sh build/ops: do_cmake.sh: get rid of which dependency 2018-04-23 10:50:04 +02:00
do_freebsd.sh build: remove ceph-disk from freebsd script 2018-06-13 15:16:23 -04:00
doc_deps.deb.txt
install-deps.sh install-deps: check the exit status for the $builddepcmd 2018-06-24 09:48:50 +08:00
librarytest.sh
make-apk.sh
make-debs.sh make-debs.sh: Changed make-debs.sh to use current architecture 2018-03-27 15:40:24 +08:00
make-dist cmake,make-dist: bump up boost version to 1.67 2018-04-21 09:02:28 +08:00
make-srpm.sh
pom.xml
run-make-check.sh run-make-check: enable WITH_GTEST_PARALLEL 2018-06-15 15:55:27 +02:00

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

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

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

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

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

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

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