src/ceph/doc/dev/osd_internals/erasure_coding/jerasure.rst

   1 ===============
   2 jerasure plugin
   3 ===============
   4
   5 Introduction
   6 ------------
   7
   8 The parameters interpreted by the jerasure plugin are:
   9
  10 ::
  11
  12   ceph osd erasure-code-profile set myprofile \
  13      directory=<dir>         \ # plugin directory absolute path
  14      plugin=jerasure         \ # plugin name (only jerasure)
  15      k=<k>                   \ # data chunks (default 2)
  16      m=<m>                   \ # coding chunks (default 2)
  17      technique=<technique>   \ # coding technique
  18
  19 The coding techniques can be chosen among *reed_sol_van*,
  20 *reed_sol_r6_op*, *cauchy_orig*, *cauchy_good*, *liberation*,
  21 *blaum_roth* and *liber8tion*.
  22
  23 The *src/erasure-code/jerasure* directory contains the
  24 implementation. It is a wrapper around the code found at
  25 `https://github.com/ceph/jerasure <https://github.com/ceph/jerasure>`_
  26 and `https://github.com/ceph/gf-complete
  27 <https://github.com/ceph/gf-complete>`_ , pinned to the latest stable
  28 version in *.gitmodules*. These repositories are copies of the
  29 upstream repositories `http://jerasure.org/jerasure/jerasure
  30 <http://jerasure.org/jerasure/jerasure>`_ and
  31 `http://jerasure.org/jerasure/gf-complete
  32 <http://jerasure.org/jerasure/gf-complete>`_ . The difference
  33 between the two, if any, should match pull requests against upstream.