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 Share Alike 3.0 (CC-BY-SA-3.0).  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 3.5.1
  55
  56 Build instructions:
  57
  58         ./do_cmake.sh
  59         cd build
  60         make
  61
  62 (Note: do_cmake.sh now defaults to creating a debug build of ceph that can
  63 be up to 5x slower with some workloads. Please pass
  64 "-DCMAKE_BUILD_TYPE=RelWithDebInfo" to do_cmake.sh to create a non-debug
  65 release.)
  66
  67 This assumes you make your build dir a subdirectory of the ceph.git
  68 checkout. If you put it elsewhere, just replace `..` in do_cmake.sh with a
  69 correct path to the checkout. Any additional CMake args can be specified
  70 setting ARGS before invoking do_cmake. See [cmake options](#cmake-options)
  71 for more details. Eg.
  72
  73     ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh
  74
  75 To build only certain targets use:
  76
  77         make [target name]
  78
  79 To install:
  80
  81         make install
  82
  83 ### CMake Options
  84
  85 If you run the `cmake` command by hand, there are many options you can
  86 set with "-D". For example the option to build the RADOS Gateway is
  87 defaulted to ON. To build without the RADOS Gateway:
  88
  89         cmake -DWITH_RADOSGW=OFF [path to top level ceph directory]
  90
  91 Another example below is building with debugging and alternate locations
  92 for a couple of external dependencies:
  93
  94         cmake -DLEVELDB_PREFIX="/opt/hyperleveldb" -DOFED_PREFIX="/opt/ofed" \
  95         -DCMAKE_INSTALL_PREFIX=/opt/accelio -DCMAKE_C_FLAGS="-O0 -g3 -gdwarf-4" \
  96         ..
  97
  98 To view an exhaustive list of -D options, you can invoke `cmake` with:
  99
 100         cmake -LH
 101
 102 If you often pipe `make` to `less` and would like to maintain the
 103 diagnostic colors for errors and warnings (and if your compiler
 104 supports it), you can invoke `cmake` with:
 105
 106         cmake -DDIAGNOSTICS_COLOR=always ..
 107
 108 Then you'll get the diagnostic colors when you execute:
 109
 110         make | less -R
 111
 112 Other available values for 'DIAGNOSTICS_COLOR' are 'auto' (default) and
 113 'never'.
 114
 115
 116 ## Building a source tarball
 117
 118 To build a complete source tarball with everything needed to build from
 119 source and/or build a (deb or rpm) package, run
 120
 121         ./make-dist
 122
 123 This will create a tarball like ceph-$version.tar.bz2 from git.
 124 (Ensure that any changes you want to include in your working directory
 125 are committed to git.)
 126
 127
 128 ## Running a test cluster
 129
 130 To run a functional test cluster,
 131
 132         cd build
 133         make vstart        # builds just enough to run vstart
 134         ../src/vstart.sh --debug --new -x --localhost --bluestore
 135         ./bin/ceph -s
 136
 137 Almost all of the usual commands are available in the bin/ directory.
 138 For example,
 139
 140         ./bin/rados -p rbd bench 30 write
 141         ./bin/rbd create foo --size 1000
 142
 143 To shut down the test cluster,
 144
 145         ../src/stop.sh
 146
 147 To start or stop individual daemons, the sysvinit script can be used:
 148
 149         ./bin/init-ceph restart osd.0
 150         ./bin/init-ceph stop
 151
 152
 153 ## Running unit tests
 154
 155 To build and run all tests (in parallel using all processors), use `ctest`:
 156
 157         cd build
 158         make
 159         ctest -j$(nproc)
 160
 161 (Note: Many targets built from src/test are not run using `ctest`.
 162 Targets starting with "unittest" are run in `make check` and thus can
 163 be run with `ctest`. Targets starting with "ceph_test" can not, and should
 164 be run by hand.)
 165
 166 When failures occur, look in build/Testing/Temporary for logs.
 167
 168 To build and run all tests and their dependencies without other
 169 unnecessary targets in Ceph:
 170
 171         cd build
 172         make check -j$(nproc)
 173
 174 To run an individual test manually, run `ctest` with -R (regex matching):
 175
 176         ctest -R [regex matching test name(s)]
 177
 178 (Note: `ctest` does not build the test it's running or the dependencies needed
 179 to run it)
 180
 181 To run an individual test manually and see all the tests output, run
 182 `ctest` with the -V (verbose) flag:
 183
 184         ctest -V -R [regex matching test name(s)]
 185
 186 To run an tests manually and run the jobs in parallel, run `ctest` with
 187 the `-j` flag:
 188
 189         ctest -j [number of jobs]
 190
 191 There are many other flags you can give `ctest` for better control
 192 over manual test execution. To view these options run:
 193
 194         man ctest
 195
 196
 197 ## Building the Documentation
 198
 199 ### Prerequisites
 200
 201 The list of package dependencies for building the documentation can be
 202 found in `doc_deps.deb.txt`:
 203
 204         sudo apt-get install `cat doc_deps.deb.txt`
 205
 206 ### Building the Documentation
 207
 208 To build the documentation, ensure that you are in the top-level
 209 `/ceph` directory, and execute the build script. For example:
 210
 211         admin/build-doc
 212