ceph/doc/dev/osd_internals/erasure_coding/jerasure.rst
Loic Dachary d5973aaf7e doc: update jerasure plugin
* The parameters come from the erasure code profile
* Add a note about the upstream submodules gf-complete / jerasure

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-30 10:31:13 +02:00

34 lines
1.2 KiB
ReStructuredText

===============
jerasure plugin
===============
Introduction
------------
The parameters interpreted by the jerasure plugin are:
::
ceph osd erasure-code-profile set myprofile \
directory=<dir> \ # plugin directory absolute path
plugin=jerasure \ # plugin name (only jerasure)
k=<k> \ # data chunks (default 2)
m=<m> \ # coding chunks (default 2)
technique=<technique> \ # coding technique
The coding techniques can be chosen among *reed_sol_van*,
*reed_sol_r6_op*, *cauchy_orig*, *cauchy_good*, *liberation*,
*blaum_roth* and *liber8tion*.
The *src/erasure-code/jerasure* directory contains the
implementation. It is a wrapper around the code found at
`https://github.com/ceph/jerasure <https://github.com/ceph/jerasure>`_
and `https://github.com/ceph/gf-complete
<https://github.com/ceph/gf-complete>`_ , pinned to the latest stable
version in *.gitmodules*. These repositories are copies of the
upstream repositories `https://bitbucket.org/jimplank/jerasure
<https://bitbucket.org/jimplank/jerasure>`_ and
`https://bitbucket.org/jimplank/gf-complete
<https://bitbucket.org/jimplank/gf-complete>`_ . The difference
between the two, if any, should match pull requests against upstream.