Ceph is a distributed object, block, and file storage platform
Go to file
Loic Dachary 0160d19aa4 mailmap: Tyler Brekke name normalization
Reviewed-by: Tyler Brekke <tyler.brekke@inktank.com>
Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-24 22:17:48 +01:00
admin build-doc: fix checks for required commands for non-debian 2014-03-12 18:09:59 +01:00
ceph-object-corpus@d9870cdfd8 ceph-object-corpus: prune some old releases 2014-02-21 13:57:24 -08:00
debian Merge remote-tracking branch 'gh/firefly' 2014-03-14 08:30:04 -07:00
doc doc/release-notes: stop confusing sphinx 2014-03-20 14:43:13 -07:00
examples/librados examples: add a librados/hello_world program 2013-08-19 14:55:09 -07:00
fusetrace libc++: use ceph:: namespaced data types 2014-01-18 14:03:20 -08:00
keys
m4 autotools: set SIMD_FLAGS with SSE flags 2014-03-10 08:24:20 +01:00
man doc: format man pages with s/2013/2014/ 2014-01-12 18:06:06 +01:00
qa Merge pull request #1465 from ceph/wip-s3pm-wusui 2014-03-20 16:05:48 -07:00
share ceph-post-file: single command to upload a file to cephdrop 2013-08-16 17:59:11 -07:00
src Merge pull request #1500 from ceph/wip-tid_t 2014-03-20 16:07:29 -07:00
udev
wireshark Merge pull request #1410 from ceph/wip-flock 2014-03-11 10:00:48 -07:00
.gitignore .gitignore gtags(1) generated files 2013-09-23 23:46:43 +02:00
.gitmodule_mirrors build: add gf-complete/jerasure to gitmodule_mirrors 2014-03-18 22:04:13 +01:00
.gitmodules erasure-code: add gf-complete / jerasure submodules 2014-03-19 08:02:12 +01:00
.mailmap mailmap: Tyler Brekke name normalization 2014-03-24 22:17:48 +01:00
.organizationmap mailmap: Tyler Brekke name normalization 2014-03-24 22:17:48 +01:00
AUTHORS
autogen.sh autogen: re-run aclocal after libtoolize 2014-01-15 10:43:49 -08:00
ceph.spec.in Merge remote-tracking branch 'gh/firefly' 2014-03-07 08:19:20 -08:00
ChangeLog
CodingStyle
configure.ac erasure-code: disable SSE extensions 2014-03-18 15:46:22 +01:00
COPYING Merge pull request #638 from ceph/wip-bloom 2013-10-03 12:13:41 -07:00
COPYING-LGPL2.1
do_autogen.sh autogen: test compare strings with != not -ne 2013-12-19 13:40:06 +01:00
Doxyfile
INSTALL
Makefile.am ceph-post-file: single command to upload a file to cephdrop 2013-08-16 17:59:11 -07:00
NEWS
PendingReleaseNotes osd: increase default leveldb write buffer, cache size 2014-02-23 10:05:39 -08:00
README doc: update build prerequisites 2014-03-10 16:54:22 -06:00
SubmittingPatches SubmittingPatches: clarify "github fork" in preference to "clone" 2014-03-06 21:11:18 -08: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.


Building Ceph
=============

To prepare the source tree after it has been git cloned,

	$ git submodule update --init

To build the server daemons, and FUSE client, execute 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 and avoid libfcgi-dev
$ ./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 (Redhat, Suse, etc.),

$ rpmbuild


Building the Documentation
==========================

Prerequisites
-------------
To build the documentation, you must install the following:

- python-dev
- python-pip
- python-virtualenv
- doxygen
- ditaa
- libxml2-dev
- libxslt-dev
- dot
- graphviz

For example:

	sudo apt-get install python-dev python-pip python-virtualenv doxygen ditaa libxml2-dev libxslt-dev dot graphviz

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


Build Prerequisites
===================

debian-based
------------
To build the source code, you must install the following:

- automake
- autoconf
- pkg-config
- gcc
- g++
- make
- libboost-dev
- libedit-dev
- libssl-dev
- libtool
- libfcgi
- libfcgi-dev
- xfslibs-dev
- libfuse-dev
- linux-kernel-headers
- libcrypto++-dev
- libaio-dev
- libgoogle-perftools-dev
- libkeyutils-dev
- uuid-dev
- libblkid-dev
- libatomic-ops-dev
- libboost-program-options-dev
- libboost-system-dev
- libboost-thread-dev
- libexpat1-dev
- libleveldb-dev
- libsnappy-dev
- libcurl4-gnutls-dev
- python-argparse
- python-flask

For example:

	$ apt-get install automake autoconf pkg-config gcc g++ make libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev xfslibs-dev libfuse-dev linux-kernel-headers libcrypto++-dev libaio-dev libgoogle-perftools-dev libkeyutils-dev uuid-dev libblkid-dev libatomic-ops-dev libboost-program-options-dev libboost-system-dev libboost-thread-dev libexpat1-dev libleveldb-dev libsnappy-dev libcurl4-gnutls-dev python-argparse python-flask python-nose

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
---------
These are the rpm packages needed to install in an rpm-based OS:

    autoconf
    automake
    gcc
    gcc-c++
    make
    libtool
    python-argparse
    python-flask
    libuuid-devel
    libblkid-devel
    keyutils-libs-devel
    cryptopp-devel
    nss-devel
    fcgi-devel
    expat-devel
    libcurl-devel
    xfsprogs-devel
    fuse-devel
    gperftools-devel
    libedit-devel
    libatomic_ops-devel
    snappy-devel
    leveldb-devel
    libaio-devel
    boost-devel

For example:

	$ yum install autoconf automake gcc gcc-c++ make libtool python-argparse python-flask libuuid-devel libblkid-devel keyutils-libs-devel cryptopp-devel nss-devel fcgi-devel expat-devel libcurl-devel xfsprogs-devel fuse-devel gperftools-devel libedit-devel libatomic_ops-devel snappy-devel leveldb-devel libaio-devel boost-devel python-nose