src/ceph/README.md

   1 # Ceph - a scalable distributed storage system
   2
   3 Please see http://ceph.com/ for current info.
   4
   5
   6 ## Contributing Code
   7
   8 Most of Ceph is licensed under the LGPL version 2.1.  Some
   9 miscellaneous code is under BSD-style license or is public domain.
  10 The documentation is licensed under Creative Commons
  11 Attribution-ShareAlike (CC BY-SA).  There are a handful of headers
  12 included here that are licensed under the GPL.  Please see the file
  13 COPYING for a full inventory of licenses by file.
  14
  15 Code contributions must include a valid "Signed-off-by" acknowledging
  16 the license for the modified or contributed file.  Please see the file
  17 SubmittingPatches.rst for details on what that means and on how to
  18 generate and submit patches.
  19
  20 We do not require assignment of copyright to contribute code; code is
  21 contributed under the terms of the applicable license.
  22
  23
  24 ## Checking out the source
  25
  26 You can clone from github with
  27
  28         git clone git@github.com:ceph/ceph
  29
  30 or, if you are not a github user,
  31
  32         git clone git://github.com/ceph/ceph
  33
  34 Ceph contains many git submodules that need to be checked out with
  35
  36         git submodule update --init --recursive
  37
  38
  39 ## Build Prerequisites
  40
  41 The list of Debian or RPM packages dependencies can be installed with:
  42
  43         ./install-deps.sh
  44
  45
  46 ## Building Ceph
  47
  48 Note that these instructions are meant for developers who are
  49 compiling the code for development and testing.  To build binaries
  50 suitable for installation we recommend you build deb or rpm packages,
  51 or refer to the `ceph.spec.in` or `debian/rules` to see which
  52 configuration options are specified for production builds.
  53
  54 Prerequisite: CMake 2.8.11
  55
  56 Build instructions:
  57
  58         ./do_cmake.sh
  59         cd build
  60         make
  61
  62 This assumes you make your build dir a subdirectory of the ceph.git
  63 checkout. If you put it elsewhere, just replace `..` in do_cmake.sh with a
  64 correct path to the checkout.
  65
  66 To build only certain targets use:
  67
  68         make [target name]
  69
  70 To install:
  71
  72         make install
  73
  74 ### CMake Options
  75
  76 If you run the `cmake` command by hand, there are many options you can
  77 set with "-D". For example the option to build the RADOS Gateway is
  78 defaulted to ON. To build without the RADOS Gateway:
  79
  80         cmake -DWITH_RADOSGW=OFF [path to top level ceph directory]
  81
  82 Another example below is building with debugging and alternate locations
  83 for a couple of external dependencies:
  84
  85         cmake -DLEVELDB_PREFIX="/opt/hyperleveldb" -DOFED_PREFIX="/opt/ofed" \
  86         -DCMAKE_INSTALL_PREFIX=/opt/accelio -DCMAKE_C_FLAGS="-O0 -g3 -gdwarf-4" \
  87         ..
  88
  89 To view an exhaustive list of -D options, you can invoke `cmake` with:
  90
  91         cmake -LH
  92
  93 If you often pipe `make` to `less` and would like to maintain the
  94 diagnostic colors for errors and warnings (and if your compiler
  95 supports it), you can invoke `cmake` with:
  96
  97         cmake -DDIAGNOSTICS_COLOR=always ..
  98
  99 Then you'll get the diagnostic colors when you execute:
 100
 101         make | less -R
 102
 103 Other available values for 'DIAGNOSTICS_COLOR' are 'auto' (default) and
 104 'never'.
 105
 106
 107 ## Building a source tarball
 108
 109 To build a complete source tarball with everything needed to build from
 110 source and/or build a (deb or rpm) package, run
 111
 112         ./make-dist
 113
 114 This will create a tarball like ceph-$version.tar.bz2 from git.
 115 (Ensure that any changes you want to include in your working directory
 116 are committed to git.)
 117
 118
 119 ## Running a test cluster
 120
 121 To run a functional test cluster,
 122
 123         cd build
 124         make vstart        # builds just enough to run vstart
 125         ../src/vstart.sh -d -n -x -l
 126         ./bin/ceph -s
 127
 128 Almost all of the usual commands are available in the bin/ directory.
 129 For example,
 130
 131         ./bin/rados -p rbd bench 30 write
 132         ./bin/rbd create foo --size 1000
 133
 134 To shut down the test cluster,
 135
 136         ../src/stop.sh
 137
 138 To start or stop individual daemons, the sysvinit script can be used:
 139
 140         ./bin/init-ceph restart osd.0
 141         ./bin/init-ceph stop
 142
 143
 144 ## Running unit tests
 145
 146 To build and run all tests (in parallel using all processors), use `ctest`:
 147
 148         cd build
 149         make
 150         ctest -j$(nproc)
 151
 152 (Note: Many targets built from src/test are not run using `ctest`.
 153 Targets starting with "unittest" are run in `make check` and thus can
 154 be run with `ctest`. Targets starting with "ceph_test" can not, and should
 155 be run by hand.)
 156
 157 When failures occur, look in build/Testing/Temporary for logs.
 158
 159 To build and run all tests and their dependencies without other
 160 unnecessary targets in Ceph:
 161
 162         cd build
 163         make check -j$(nproc)
 164
 165 To run an individual test manually, run `ctest` with -R (regex matching):
 166
 167         ctest -R [regex matching test name(s)]
 168
 169 (Note: `ctest` does not build the test it's running or the dependencies needed
 170 to run it)
 171
 172 To run an individual test manually and see all the tests output, run
 173 `ctest` with the -V (verbose) flag:
 174
 175         ctest -V -R [regex matching test name(s)]
 176
 177 To run an tests manually and run the jobs in parallel, run `ctest` with
 178 the `-j` flag:
 179
 180         ctest -j [number of jobs]
 181
 182 There are many other flags you can give `ctest` for better control
 183 over manual test execution. To view these options run:
 184
 185         man ctest
 186
 187
 188 ## Building the Documentation
 189
 190 ### Prerequisites
 191
 192 The list of package dependencies for building the documentation can be
 193 found in `doc_deps.deb.txt`:
 194
 195         sudo apt-get install `cat doc_deps.deb.txt`
 196
 197 ### Building the Documentation
 198
 199 To build the documentation, ensure that you are in the top-level
 200 `/ceph` directory, and execute the build script. For example:
 201
 202         admin/build-doc
 203