Commit Graph

7 Commits

Author SHA1 Message Date
Kun Huang
e0bae95240 Fix typos in erasure code documents
Signed-off-by: Kun Huang <academicgareth@gmail.com>
2013-12-31 06:17:52 -05:00
Loic Dachary
238a303cff ErasureCode: update PGBackend description
Based on a dialog with Sam ( as published at http://dachary.org/?p=2320 ).

* Remove PGBackend-h.rst because PGBackend.h is now in master.

* Fix typos caught by ispell

* Update recovery links to point to PGBackend recover methods

* Workaround formating warning
  developer_notes.rst:3: WARNING: Duplicate explicit target name:
  "erasurecodepluginexample" which should be legitimate.

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-10-02 15:58:01 +02:00
Loic Dachary
ff4887324a ErasureCode: doc updates
* Update to the current state of the ghobject implementaiton and the fact
  that they encode the shard_t Although the pool also contains the shard
  id, it is less relevant to understand the implementation.

* Update with the erasure code plugin infrastructure and the example
  plugin now in master.

* Move jerasure to a separate page to be expanded and link it from the
  toc

* Kill the partial read and writes notes as it will probably not be
  implemented in the near future. Kill some of the notes because they
  are no longer relevant.

* Add a definition for "chunk rank"

* Reword, update schemas, fix typos.

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-10-02 15:02:53 +02:00
Loic Dachary
14c31ddf10 doc : erasure code developer notes updates
* unify conventions to match those used by jerasure ( data chunk = K,
  coding chunk = M, use coding instead of parity, use erasures instead
  of erased )

* make lines 80 characters long

* modify the descriptions to take into account that the chunk rank
  will encoded in the pool name and not on a per object basis

* remove the doxygen link to ErasureCodeInterface because it fails
  doc: asphyxiate does not support class
  http://tracker.ceph.com/issues/6115

* only systematic codes are considered at this point ( all jerasure
  techniques are systematic). Although the API could be extended to
  include non systematic codes, it is probably a case of over
  engineering at this point.

* add link to
  http://tracker.ceph.com/issues/6113
  add ceph osd pool create [name] [key=value]

* update the plugin system description to match the proposed
  implementation http://tracker.ceph.com/issues/5877

http://tracker.ceph.com/issues/4929 refs #4929

Reviewed-by: Joao Eduardo Luis <joao.luis@inktank.com>

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-27 14:13:56 +02:00
Loic Dachary
157f2227f4 doc: fix erasure code formatting warnings and errors
http://tracker.ceph.com/issues/4929 refs #4929

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-22 17:45:39 +02:00
Loic Dachary
3a83129283 erasure code : plugin, interface and glossary documentation updates
* replace the erasure code plugin abstract interface with a doxygen link
  that will be populated when the header shows in master
* update the plugin documentation to reflect the current draft implementation
* fix broken link to PGBackend-h
* add a glossary to define chunk, stripe, shard and strip with a drawing

http://tracker.ceph.com/issues/4929 refs #4929

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-20 17:34:52 +02:00
Loic Dachary
8bf3971b7e rearrange the documentation to be inserted and maintained in master
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-09 23:26:49 +02:00