Commit Graph

25 Commits

Author SHA1 Message Date
Kefu Chai
1f975d78a8 doc: add :orphan: to orphaned docs
we should remove the deprecated ones once it's safe to remove them.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-16 16:39:40 +08:00
Kefu Chai
425b468ad0 doc/dev/osd_internals: fix sphinx warnings
silences errors like

erasure_coding/proposals.rst:236: ERROR: Unexpected indentation.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-16 16:34:53 +08:00
Samuel Just
6f8e4b3810 src: rename ReplicatedPG to PrimaryLogPG
It's been confusing for a long time that EC pools are implemented by
ReplicatedPG.  What PG/ReplicatedPG really implement is the concept
of a PG where consistency is managed by the primary via a log.

Signed-off-by: Samuel Just <sjust@redhat.com>
2016-12-14 10:18:27 -08:00
Samuel Just
4740fe46ec doc/dev/osd_internals: add some docs for ECBackend
Also, clean up some old ones.

Signed-off-by: Samuel Just <sjust@redhat.com>
2016-11-17 10:41:34 -08:00
Brad Hubbard
370e4a71a2 doc: remove duplicate word in Motivation section.
Remove to\nto typo in doc/dev/osd_internals/erasure_coding/pgbackend.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-10 11:51:49 +10:00
Loic Dachary
d8d608d671 erasure-code: update links to jerasure upstream
It moved from bitbucket to jerasure.org

Signed-off-by: Loic Dachary <ldachary@redhat.com>
2015-01-15 21:30:25 +01:00
Loic Dachary
487105df10 erasure-code: add directory to plugin init functions
The prototype of the init functions of erasure coded plugins is changed
from

   int __erasure_code_init(char *plugin_name)

to

   int __erasure_code_init(char *plugin_name, char *directory)

The jerasure plugin will find optimized variants in this directory and
load them. The load() and preload() functions of
ErasureCodePluginRegistry only use a directory instead of a more generic
parameters map. The parameters map was only used for the directory entry
anyway.

Signed-off-by: Loic Dachary <loic-201408@dachary.org>
2014-08-28 11:09:29 +02:00
Loic Dachary
e47049ba83 erasure-code: fix URL in developer notes
add missing ..

http://tracker.ceph.com/issues/8388 Fixes: #8388

Reported-by: koleosfuscus <koleosfuscus@yahoo.com>
Signed-off-by: Loic Dachary <loic@dachary.org>
2014-05-19 18:41:37 +02:00
Loic Dachary
ff51d3ff56 doc: pgbackend dev doc outdated notice
* Warn the reader that the implementation is ahead and may differ
* Update the links to the Firefly branch
* Remove links to issues used during development to avoid confusion

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-30 10:31:13 +02:00
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
Loic Dachary
402e10473f doc: erasure code developer notes updates
Update the introduction to explain erasure code profiles. Remove
obsolete explanations about partial writes etc. Remove links to tickets
used during development. Update permalinks to be closer to
Firefly (v0.78).

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-30 10:31:07 +02:00
Danny Al-Gaaf
72ee3389af doc: s/osd/OSD/ if not part of a command
First attempt to unify usage of OSD over rst files.

Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-09 00:01:40 +01:00
Samuel Just
4a25951633 osd_types: introduce spg_t, pg_shard_t
Signed-off-by: Samuel Just <sam.just@inktank.com>
2014-02-17 20:11:05 -08:00
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
b8bdbd92d0 doc: update erasure code development doc
With a link to the tracker issue implementing the new indep mode.

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-12-09 15:19:19 +01: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
Samuel Just
62a1eb6f69 osd/: add PGBackend interfaces and stubs
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-09-26 11:24:25 -07:00
John Wilkins
ff9beb2cf5 doc: Syntax fixes to stop gitbuilder warnings.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 11:19:59 -07:00
Loic Dachary
3c9f8498c8 doc: erasure code ghobject is made of gen_t + shard_t
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-09-04 12:33:15 +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
bebba3c858 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-21 18:09:03 +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