Ceph is a distributed object, block, and file storage platform
Go to file
Nilamdyuti Goswami 8b79617306 doc: Changes format style in ceph to improve readability as html.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 17:11:22 +05:30
admin
ceph-erasure-code-corpus@f1f95a1de9
ceph-object-corpus@bb3cee6b85
debian debian: enable libgoogle-perftools-dev on arm64 2014-12-11 12:03:30 -07:00
doc doc: Changes format style in ceph to improve readability as html. 2014-12-18 17:11:22 +05:30
examples
fusetrace
keys
m4
man Merge pull request #3165 from nilamdyuti/wip-doc-ceph 2014-12-16 08:13:53 -08:00
qa Merge pull request #3146 from ceph/wip-9323 2014-12-15 16:36:08 +00:00
rpm
share
src MDS: do not allow invocation of most commands on an inactive MDS 2014-12-17 15:32:23 -08:00
systemd
udev
.gitignore
.gitmodule_mirrors
.gitmodules
.mailmap mailmap: Sandon Van Ness name normalization 2014-12-15 11:22:46 +05:30
.organizationmap mailmap: Blaine Gardner affiliation 2014-12-15 11:22:46 +05:30
.peoplemap
AUTHORS
autogen.sh
ceph.spec.in ceph.spec.in: quote %files macro in comment 2014-12-17 13:06:58 -07:00
ChangeLog
CodingStyle
configure.ac jemalloc-support: Added --with-jemalloc configure option 2014-12-15 11:22:29 +05:30
CONTRIBUTING.rst
COPYING
COPYING-LGPL2.1
do_autogen.sh jemalloc-support: Added --with-jemalloc configure option 2014-12-15 11:22:29 +05:30
doc_deps.deb.txt
Doxyfile
INSTALL
install-deps.sh
Makefile.am
NEWS
PendingReleaseNotes Merge remote-tracking branch 'gh/master' into wip-watch-notify 2014-12-16 14:02:32 -08:00
pom.xml
README
README.md
run-make-check.sh documentation: simplify running make check 2014-12-13 15:01:40 +01:00
SubmittingPatches documentation: simplify running make check 2014-12-13 15:01:40 +01: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-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 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.

Build Prerequisites

debian-based

The list of debian packages dependencies can be installed with:

./install-deps.sh

Note: libsnappy-dev and libleveldb-dev are not available upstream for natty, oneiric, and squeeze. Backports for Ceph can be found at ceph.com/debian-leveldb.

rpm-based

The list of RPM packages dependencies can be installed with:

     ./install-deps.sh

Building Ceph

Developers, please refer to the Developer Guide for more information, otherwise, you can build the server daemons, and FUSE client, by executing the following:

./autogen.sh
./configure
make

(Note that the FUSE client will only be built if libfuse is present.)

Dependencies

The configure script will complain about any missing dependencies as it goes. You can also refer to debian/control or ceph.spec.in for the package build dependencies on those platforms. In many cases, dependencies can be avoided with --with-foo or --without-bar switches. For example,

./configure --with-nss         # use libnss instead of libcrypto++
./configure --without-radosgw  # do not build radosgw
./configure --without-tcmalloc # avoid google-perftools dependency

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

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