2801c1b52f
* Explain the development cycle and stable release cycle * Replace the 18 month duration with the LTS+2 overlap logic * Explain that the estimated retirement is an educated guess that depends on the stable release frequency * Replace Support with Stable in LTS to avoid confusion with professional services * Do not promise bugs will be handled, only that they will be triaged Signed-off-by: Loic Dachary <ldachary@redhat.com> |
||
|---|---|---|
| admin | ||
| ceph-erasure-code-corpus@f1f95a1de9 | ||
| ceph-object-corpus@da43eb1195 | ||
| cmake/modules | ||
| debian | ||
| doc | ||
| etc/sysconfig/SuSEfirewall2.d/services | ||
| examples | ||
| fusetrace | ||
| keys | ||
| m4 | ||
| man | ||
| qa | ||
| rpm | ||
| share | ||
| src | ||
| systemd | ||
| udev | ||
| .gitignore | ||
| .gitmodule_mirrors | ||
| .gitmodules | ||
| .mailmap | ||
| .organizationmap | ||
| .peoplemap | ||
| AUTHORS | ||
| autogen.sh | ||
| ceph.spec.in | ||
| ChangeLog | ||
| CMakeLists.txt | ||
| CodingStyle | ||
| configure.ac | ||
| CONTRIBUTING.rst | ||
| COPYING | ||
| COPYING-GPL2 | ||
| COPYING-LGPL2.1 | ||
| do_autogen.sh | ||
| doc_deps.deb.txt | ||
| Doxyfile | ||
| INSTALL | ||
| install-deps.sh | ||
| make-debs.sh | ||
| Makefile.am | ||
| NEWS | ||
| PendingReleaseNotes | ||
| pom.xml | ||
| README | ||
| README.cmake | ||
| README.md | ||
| README.xio | ||
| run-make-check.sh | ||
| SubmittingPatches | ||
============================================ 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 Debian 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