1
0
mirror of https://github.com/ceph/ceph synced 2024-12-23 11:54:11 +00:00
Ceph is a distributed object, block, and file storage platform
Go to file
Loic Dachary 1798803292 Merge pull request from bveuille/wip-documentation
doc: Change Availability text in all of the man pages

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-01-26 12:42:32 +01:00
admin be nitpicky about missing references 2014-03-24 13:01:38 -04:00
ceph-erasure-code-corpus@f1f95a1de9 erasure-code: workunit to check for encoding regression 2014-11-10 14:56:43 +01:00
ceph-object-corpus@da43eb1195 ceph-object-corpus: drop compat with old ObjectStore::Transaction 2015-01-06 13:29:41 -08:00
cmake/modules Combined CMake Build for Hammer 2015-01-14 16:40:05 -05:00
debian Merge pull request from ceph/wip-cephfs-tabletool 2015-01-15 21:58:17 -08:00
doc Merge pull request from bveuille/wip-documentation 2015-01-26 12:42:32 +01:00
examples rbd-replay: Convert prep-for-replay.py to rbd-replay-prep.cc 2014-08-21 10:57:33 -07:00
fusetrace remove superfluous second semicolons at end of lines 2014-05-08 10:09:25 +02:00
keys
m4 autotools: ARM/AArch64 NEON detection similar to x86 2014-11-25 14:17:37 +01:00
man doc: Change Availability text in all of the man pages 2015-01-22 15:53:46 +01:00
qa doc: Some files still use http://ceph.newdream.net 2015-01-23 12:28:58 +01:00
rpm Move fedora patch file (used by ceph.spec.in) to rpm/ subdir 2014-08-27 12:56:43 -07:00
share
src librados_test_stub: add IoCtx::get_instance_id() 2015-01-24 23:12:18 -08:00
systemd better systemd support 2014-12-01 14:45:31 +01:00
udev
.gitignore examples: Add example for the librados C API 2014-08-21 10:57:28 -07:00
.gitmodule_mirrors build: add ceph-erasure-code-corpus to gitmodule_mirrors 2014-10-08 21:22:02 +02:00
.gitmodules .gitmodules: update ceph-object-corpus auth repo to github 2014-12-18 14:09:21 -08:00
.mailmap mailmap: Loic Dachary name normalization 2015-01-15 11:14:06 +01:00
.organizationmap mailmap: David Zhang affiliation 2015-01-15 11:14:01 +01:00
.peoplemap mailmap: Alfredo Deza affiliation : Fix Typo. 2014-12-27 01:11:31 +01:00
AUTHORS AUTHORS 2014-07-17 21:33:22 -07:00
autogen.sh autogen.sh: git submodule sync 2014-11-24 12:35:50 +01:00
ceph.spec.in ceph.spec.in: use wildcards to capture man pages 2015-01-23 15:08:34 -07:00
ChangeLog
CMakeLists.txt cmake: add xio 2015-01-14 16:43:36 -05:00
CodingStyle
configure.ac Merge pull request from yuyuyu101/wip-10172 2015-01-19 12:38:01 -08:00
CONTRIBUTING.rst doc: Add a contributing file at the root of repo 2014-09-06 00:23:24 +05:30
COPYING erasure-code: HTML display of benchmark results 2014-08-04 11:42:05 +02:00
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 doc: The dot package is included in graphviz package 2014-10-20 10:47:51 -07:00
Doxyfile
INSTALL Update INSTALL to mention the submodules/recursive 2014-05-31 11:22:41 +02:00
install-deps.sh install-deps: fix LC_ALL setting 2015-01-25 11:45:48 -08:00
make-debs.sh debian: create a repository from sources 2015-01-02 12:14:39 +01:00
Makefile.am documentation: replace deps.{deb,rpm}.txt with scripts 2014-12-01 16:15:21 +01:00
NEWS
PendingReleaseNotes doc/release-notes: v0.91 2015-01-14 15:11:19 -08:00
pom.xml update license for libcephfs 2014-08-26 15:52:37 -04:00
README README: symlink from README.md 2014-08-06 08:15:35 -07:00
README.cmake Combined CMake Build for Hammer 2015-01-14 16:40:05 -05:00
README.md documentation: replace deps.{deb,rpm}.txt with scripts 2014-12-01 16:15:21 +01:00
README.xio Accelio Autotools glue. 2015-01-14 16:43:43 -05:00
run-make-check.sh tests: run-make-check.sh arguments are passed to configure 2014-12-21 17:53:00 +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