Ceph is a distributed object, block, and file storage platform
Go to file
Patrick Donnelly df62f2d91d
qa: remove libcephfs-java tests
These have bit-rotted and no longer work. No cycles from interested parties
available to fix.

Fixes: https://tracker.ceph.com/issues/38487
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-02-28 13:32:15 -08:00
.github .github/stale.yml: configure probot/stale to automatically close stale issues 2018-10-15 17:37:03 -05:00
admin doc: bump up sphinx and pyyaml versions 2019-01-21 23:22:42 +08:00
alpine src/tools: fix compile error (master version issue) 2019-02-07 00:06:27 +09:00
bin scripts: fix bash path in shebangs (part 2) 2017-09-25 17:20:40 -06:00
ceph-erasure-code-corpus@2d7d78b9cc tests: erasure-code: add k=2, m=2 for isa & jerasure 2016-12-08 12:44:21 +01:00
ceph-menv ceph-menv: mrun shell environment 2018-05-21 13:51:16 -07:00
ceph-object-corpus@e32bf8ca3d ceph-object-corpus: update to fix make check 2018-04-05 10:50:32 -07:00
cmake/modules cmake: find_package(RabbitMQ) instead of just checking its header 2019-02-21 19:00:24 +08:00
debian 14.1.0 2019-02-22 18:07:07 +00:00
doc qa: remove libcephfs-java tests 2019-02-28 13:32:15 -08:00
etc cmake: only create sysctl file on linux 2017-11-20 15:45:03 +08:00
examples librados: revert librados3/libradoscc back to librados2 2019-02-20 14:59:26 -05:00
fusetrace remove superfluous second semicolons at end of lines 2014-05-08 10:09:25 +02:00
keys new release key 2015-09-17 12:28:25 -04:00
man man: skip directive starting with ".." 2018-08-15 13:28:54 +08:00
mirroring doc: remove CZ mirror 2018-05-04 10:46:14 +02:00
monitoring/grafana mgr/dashboard: Fixed performance details context for host list row selection 2019-01-18 13:36:49 +09:00
qa qa: remove libcephfs-java tests 2019-02-28 13:32:15 -08:00
selinux igw: Add selinux support for ceph iscsi 2018-11-05 13:05:19 -06:00
share ceph-post-file: migrate to RSA SSH keys 2016-08-22 10:27:36 -04:00
src Merge pull request #26627 from jan--f/c-v-38472 2019-02-26 10:35:22 -06:00
sudoers.d osd: OSD device smart data include additional nvme data 2019-01-03 18:10:26 -06:00
systemd systemd: lock down privileges more 2019-02-07 08:45:00 -08:00
udev udev: remove parttypeuuid rules for ceph-disk 2018-06-13 15:16:22 -04:00
.gitattributes githubmap: define merge conflict resolution 2017-10-10 12:06:34 -07:00
.githubmap Merge PR #26112 into master 2019-02-01 12:40:56 -06:00
.gitignore mgr: Ignore __pycache__ and wheelhouse dirs 2019-02-19 10:09:55 +01:00
.gitmodule_mirrors Replace gmock/gtest with googletest 2016-07-12 17:18:09 -07:00
.gitmodules fmt: remove fmt submodule 2018-12-17 21:05:05 +08:00
.mailmap mailmap,orgnization: Update sangfor affiliation 2018-11-26 17:03:14 +08:00
.organizationmap mailmap,orgnization: Update sangfor affiliation 2018-11-26 17:03:14 +08:00
.peoplemap mailmap: update affiliation for Mykola Golub 2017-12-24 16:49:38 +02:00
AUTHORS AUTHORS: Update Component Technical Leads and maintainers to canonical location of ceph.com. 2017-10-18 18:48:37 +08:00
ceph.spec.in Merge PR #26617 into master 2019-02-25 16:41:40 -06:00
CMakeLists.txt 14.1.0 2019-02-22 18:07:07 +00:00
CodingStyle mgr/dashboard: Add reference to prettier in CodingStyle 2018-07-26 13:38:12 +01:00
CONTRIBUTING.rst doc: Fixes a typo. 2017-03-15 13:10:27 -05:00
COPYING Separate diskprediction local plugin from the diskprediction plugin 2018-11-05 14:09:10 +08:00
COPYING-GPL2 Add GPLv2 text file 2015-02-27 10:43:26 -07:00
COPYING-LGPL2.1
do_cmake.sh do_cmake: Warn user about slow debug performance by default. 2018-12-12 12:09:57 -06:00
do_freebsd.sh install-deps,do_freebsd: disable amqp support 2019-02-22 10:30:25 +08:00
doc_deps.deb.txt admin/build-doc: use doc_deps.deb.txt for build-deps instead 2016-05-24 14:08:11 +08:00
Doxyfile Replace gmock/gtest with googletest 2016-07-12 17:18:09 -07:00
install-deps.sh install-deps,do_freebsd: disable amqp support 2019-02-22 10:30:25 +08:00
make-apk.sh make-apk.sh: alpine packaging helper 2016-12-20 20:25:48 -05:00
make-debs.sh make-debs.sh: clean dir to avoid build deb packages error 2018-11-24 13:17:12 +08:00
make-dist mgr/dashboard: Update Node.js to current LTS 2018-11-07 20:10:25 +00:00
make-srpm.sh Pass first parameter to make-dist for building SRPM 2017-02-17 12:23:10 +01:00
PendingReleaseNotes doc/releases/nautilus: draft notes 2019-02-25 08:39:23 -06:00
pom.xml update license for libcephfs 2014-08-26 15:52:37 -04:00
README.aix aix shared library build 2015-11-25 18:30:31 -05:00
README.alpine.md Remove embedded 'cephd' code 2018-05-11 13:10:26 -07:00
README.FreeBSD doc: fix typos 2018-09-21 12:41:42 +08:00
README.md README.md: Add note about default do_cmake.sh debug builds. 2018-12-12 12:09:57 -06:00
README.solaris aix gcc librados port 2015-11-23 00:03:16 -05:00
README.xio xio: Update README.xio with dependencies 2015-03-17 05:13:57 -07:00
run-make-check.sh install-deps.sh: selectively enable deps on deb distros 2019-02-17 02:27:07 +08:00
SubmittingPatches.rst SubmittingPatches: added inline markup to important references 2019-01-15 22:42:05 -05:00

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 3.5.1

Build instructions:

./do_cmake.sh
cd build
make

(Note: do_cmake.sh 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 do_cmake.sh 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 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