]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: update jerasure plugin
authorLoic Dachary <loic@dachary.org>
Sat, 29 Mar 2014 10:29:22 +0000 (11:29 +0100)
committerLoic Dachary <loic@dachary.org>
Sun, 30 Mar 2014 08:31:13 +0000 (10:31 +0200)
* 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>
doc/dev/osd_internals/erasure_coding/jerasure.rst

index 312eac52e5d883043b9f56a33b2d1d317dd8e9e4..af7631c16f111715f5a393d73693e880442659d7 100644 (file)
@@ -9,14 +9,25 @@ The parameters interpreted by the jerasure plugin are:
 
 ::
  
-  ceph osd pool create <pool> \
-     erasure-code-directory=<dir>         \ # plugin directory absolute path
-     erasure-code-plugin=jerasure         \ # plugin name (only jerasure)
-     erasure-code-k=<k>                   \ # data chunks (default 2)
-     erasure-code-m=<m>                   \ # coding chunks (default 2)
-     erasure-code-technique=<technique>   \ # coding technique
+  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.