Ceph is a distributed object, block, and file storage platform
Go to file
David Zafman 81dca503f2 doc: Fix .gitignore for man directory
Caused by: 301fe6cbf2

Signed-off-by: David Zafman <dzafman@redhat.com>
2015-04-02 11:47:18 -07:00
admin doc: Switch doxygen integration back to breathe 2015-03-20 17:17:16 +08:00
ceph-erasure-code-corpus@f1f95a1de9
ceph-object-corpus@da43eb1195
cmake/modules
debian doc: generate man pages in man/Makefile 2015-03-24 12:36:41 +08:00
doc Merge pull request #4142 from ceph/wip-no-more-dot-8 2015-04-02 17:42:23 +02:00
examples
fusetrace
keys
m4 crc32c: add aarch64 optimized crc32c implementation 2015-03-17 13:56:52 -05:00
man doc: Fix .gitignore for man directory 2015-04-02 11:47:18 -07:00
qa java: libcephfs_jni.so is in /usr/lib64 on rhel 2015-03-27 19:34:12 -07:00
rpm
share
src mon: Add MIN_READ_RECENCY_FOR_PROMOTE to ONLY_TIER_CHOICES 2015-04-02 11:36:27 -07:00
systemd ceph.spec.in: fix handling of /var/run/ceph 2015-03-17 12:28:28 -06:00
udev
.gitignore
.gitmodule_mirrors
.gitmodules
.mailmap mailmap: Thomas Johnson affiliation 2015-03-20 21:06:58 +00:00
.organizationmap mailmap: Wuxingyi affiliation 2015-03-20 21:33:27 +00:00
.peoplemap Some sanitization work on .mailmap, .organizationmap, .peoplemap : Sorting , Duplicate removal 2015-03-16 21:02:34 +00:00
AUTHORS
autogen.sh autogen.sh: do not submodule --force if git does not support it 2015-03-07 17:11:58 +01:00
ceph.spec.in Merge pull request #4142 from ceph/wip-no-more-dot-8 2015-04-02 17:42:23 +02:00
ChangeLog
CMakeLists.txt
CodingStyle
configure.ac Merge pull request #4142 from ceph/wip-no-more-dot-8 2015-04-02 17:42:23 +02:00
CONTRIBUTING.rst
COPYING
COPYING-GPL2
COPYING-LGPL2.1
do_autogen.sh
doc_deps.deb.txt
Doxyfile
INSTALL
install-deps.sh install-deps: support OpenSUSE 2015-03-24 14:11:47 +01:00
make-debs.sh
Makefile.am
NEWS
PendingReleaseNotes doc/release-notes: more hammer release notes 2015-03-19 17:24:33 -07:00
pom.xml
README
README.cmake
README.md
README.xio xio: Update README.xio with dependencies 2015-03-17 05:13:57 -07:00
run-make-check.sh
SubmittingPatches be gender neutral 2015-03-23 16:59:55 -07: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