mirror of
https://github.com/ceph/ceph
synced 2024-12-23 20:03:56 +00:00
2651750498
Add libkrbd libtool convenience library to provide an interface for mapping and unmapping rbd images programmatically. This will be used by the rbd binary itself and the librbd_fsx testing tool. libkrbd takes care of the kernel module stuff (common/module.h) and makes use of libudev to be able to properly wait for block device creation and deletion and tell which block device got assigned by the kernel to the newly created mapping. Signed-off-by: Ilya Dryomov <ilya.dryomov@inktank.com>
180 lines
4.7 KiB
Plaintext
180 lines
4.7 KiB
Plaintext
============================================
|
|
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
|
|
- libudev-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 libudev-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
|
|
libudev-devel (systemd-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 systemd-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
|
|
|