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
Samuel Just
0c5f842e49
Merge branch 'wip-erasure-coded-doc'
2013-08-19 11:02:45 -07:00
Sage Weil
70790ab6b4
doc/dev/filestore-filesystem-compatibliity: remove outdated xattr notes
...
Signed-off-by: Sage Weil <sage@inktank.com>
2013-08-17 12:34:11 -07:00
Sage Weil
d7f1d166ea
Merge pull request #494 from kri5/wip-s3-compliance-doc
...
doc: complete S3 features status from existing doc page
2013-08-17 11:00:59 -07:00
Sage Weil
893331be9e
Merge pull request #490 from dachary/master
...
ant is missing from the list of packages to install
2013-08-15 10:52:17 -07:00
Christophe Courtaut
c566c03406
doc: complete S3 features status from existing doc page
...
Signed-off-by: Christophe Courtaut <christophe.courtaut@gmail.com>
2013-08-12 10:58:32 +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
Christophe Courtaut
5082fec18f
doc: Add a page about rgw S3 API compliance
...
Signed-off-by: Christophe Courtaut <christophe.courtaut@gmail.com>
2013-08-09 10:26:06 +02:00
Loic Dachary
fd0626108a
ant is missing from the list of packages to install
...
to build the documentation.
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-09 10:17:26 +02:00
Loic Dachary
980a07380d
document the write / read path for erasure encoding
...
Explains how objects are stored and used in erasure coded pools. It is
the result of discussions that occured on the ceph-devel mailing list
around june 2013. The rationale behind each change can be found in the
archive of the mailing list. For instance, the coding of the chunk
number with the object or the decision to decode using any K chunks
instead of trying to fetch the data chunks when possible because it
would allow simple concatenation when systematic codes are used.
http://tracker.ceph.com/issues/4929 refs #4929
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-09 09:42:31 +02:00
Loic Dachary
0304dfbc5f
Add links to OSD internals related tracker items.
...
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-05 15:36:28 +02:00
Loic Dachary
0d1040d798
Add links to scrub related tracker items.
...
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-05 15:32:17 +02:00
Loic Dachary
349e7900a9
Add links to peering related tracker items.
...
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-05 15:28:33 +02:00
Loic Dachary
423614777d
Add links to recovery related tracker items.
...
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-05 15:27:31 +02:00
Loic Dachary
128628824b
Add links to backfill related tracker items.
...
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-05 15:09:55 +02:00
Loic Dachary
160fa710ec
fix typo
...
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-05 15:09:42 +02:00
Loic Dachary
ac6f3b72a0
M+K means M data + K parity and implies M chunks necessary to recover
...
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-05 15:08:49 +02:00
Samuel Just
826478cfde
dev/osd_internals,src/osd: add erasure_coding.rst and PGBackend.h
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-08-02 16:05:50 -07:00
Loic Dachary
6256d681a4
Add the definition of PG temp to the glossary
...
it is not easy to figure out what a PG temp is just by reading the
code although it is easy to understand with an example.
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-02 00:47:13 +02:00
Sage Weil
a46f60afde
doc/dev/repo-lab-access: notes
...
Signed-off-by: Sage Weil <sage@inktank.com>
2013-07-28 16:17:50 -07:00
Sage Weil
b8fad05912
doc/dev: add corpus.rst
...
Structure of the corpus dir, how to add to it.
Signed-off-by: Sage Weil <sage@inktank.com>
2013-07-12 10:36:47 -07:00
Christophe Courtaut
eec903a6ec
doc: Fix env variables in vstart.sh documentation
...
Signed-off-by: Christophe Courtaut <christophe.courtaut@gmail.com>
2013-07-08 22:19:21 +02:00
Christophe Courtaut
a793e203fd
doc: Add a page to document vstart.sh script
...
Signed-off-by: Christophe Courtaut <christophe.courtaut@gmail.com>
2013-07-04 14:08:41 +02:00
Dan Mick
8c23d8cb46
dev/rbd-diff: make formats into bullet lists (solves linebreak probs)
...
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-06-04 17:24:16 -07:00
John Wilkins
72a6767eb3
doc: Added title. Suppresses no title warning messages.
...
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-04 15:33:42 -07:00
John Wilkins
145c480807
doc: Text of diagram for osd_throttles.
...
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-31 11:14:29 -07:00
John Wilkins
8d70c091d9
doc: Omitted text diagram, and used literal include to text file.
...
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-31 11:14:04 -07:00
Samuel Just
1c35556b56
doc/dev/osd_internals: add wbthrottle.rst
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-05-28 10:41:57 -07:00
Samuel Just
17a6e7faa7
doc/dev/osd_internals: add some info about throttles
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-05-21 12:51:20 -07:00
Loic Dachary
2a4425af0e
reflect recent changes in the pg deletion logic
...
No need to wait on DeletingStateRef for flush d3dd99b725
Fix typos
http://tracker.ceph.com/issues/5058 refs #5058
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-05-14 22:46:37 +02:00
Loic Dachary
1c53991e4c
fix typos and add hyperlink to peering
...
s/;/:/
s/up_acting_affected/acting_up_affected/
Add relative link to ../../peering
http://tracker.ceph.com/issues/5058 refs #5058
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-05-14 22:46:37 +02:00
Loic Dachary
b7d4012c06
typo s/come/some/
...
http://tracker.ceph.com/issues/5058 refs #5058
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-05-14 22:46:36 +02:00
Loic Dachary
dbddffef06
update op added to a waiting queue or discarded
...
The decision to discard an op happens either in OSD or in PG.
The operation queue goes to a single OpWQ object if waiting_map does not impose a delay op_queue.
The decision to add an op to a waiting queue regardless of its type is updated.
The decision to add a CEPH_MSG_OSD_OP to a waiting queue is described in full.
http://tracker.ceph.com/issues/5058 refs #5058
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-05-14 22:44:58 +02:00
David Zafman
ea0e0c7e34
Merge branch 'wip-4273'
...
Reviewed-by: Sam Just <sam.just@inktank.com>
2013-05-10 16:45:34 -07:00
Samuel Just
b353da6f68
Merge branch 'wip_pg_res'
...
Reviewed-by: Sage Weil <sage@inktank.com>
2013-05-09 22:24:31 -07:00
Samuel Just
0ef9b1e049
osd_internals/pg_removal.rst: update for pg resurrection
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-05-09 17:28:15 -07:00
John Wilkins
f1b13a1796
doc: Added the non-implemented bit for the gateway to the dev/radosgw TOC.
...
fixes : #4978
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-09 12:22:21 -07:00
John Wilkins
fe164e4438
doc: Republishing the admin operations API for the gateway.
...
fixes : #4978
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-09 12:08:28 -07:00
David Zafman
00e903160b
osd: prioritize recovery for degraded pgs
...
Three Reservation priorities from RECOVERY, BACKFILL_HIGH, BACKFILL_LOW
fixes : #4273
Signed-off-by: David Zafman <david.zafman@inktank.com>
2013-05-09 12:00:29 -07:00
David Zafman
09163a3bbc
Add priority option to AsyncReserver class
...
Add priority to request_reservation()
Change to map of lists by prioriry
Add priority to queue_pointers mappped type
Signed-off-by: David Zafman <david.zafman@inktank.com>
2013-05-09 12:00:29 -07:00
caleb miles
da271f7f78
doc: Document admin api web interface.
...
Signed-off-by: caleb miles <caleb.miles@inktank.com>
2013-05-09 11:15:01 -07:00
John Wilkins
452fb529fa
doc: Fixed typo.
...
fixes : #4422
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-07 16:11:29 -07:00
John Wilkins
4e99dca970
doc: Fixed usage typo.
...
fixes : #4923
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-07 07:57:16 -07:00
Sage Weil
5b0c68b928
doc/dev/rbd-diff: specify that metadata records come before data
...
Signed-off-by: Sage Weil <sage@inktank.com>
2013-03-31 23:32:41 -07:00
Sage Weil
7bbaa71a56
doc/dev/rbd-diff: update incremental file format
...
Signed-off-by: Sage Weil <sage@inktank.com>
2013-03-31 23:32:41 -07:00
Sage Weil
e7167433ae
rbd: implement 'export-diff' and 'import-diff' commands
...
Export a diff of an image from a previous snapshot to a file (or stdout).
Import a diff and apply it to an image, and then create the ending
snapshot.
Signed-off-by: Sage Weil <sage@inktank.com>
2013-03-31 23:32:40 -07:00
Samuel Just
78db663ec7
osd_internals/snaps.rst: update description to reflect SnapMapper
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-03-13 19:45:08 -07:00
Samuel Just
ba449ce031
osd_internals/snaps.rst: add a description of snaps and trimming
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-03-13 18:48:24 -07:00
David Zafman
8ce26eaf02
Document scrubbing behavior
...
Signed-off-by: David Zafman <david.zafman@inktank.com>
2013-03-11 12:44:47 -07:00
Gary Lowell
e694ea58c2
release-process.rst: Fix typos
...
Signed-off-by: Gary Lowell <gary.lowell@inktank.com>
2013-03-05 22:08:15 -08:00
Sage Weil
75ce88fb69
doc: fix rst for watch/notify internals
...
Signed-off-by: Sage Weil <sage@inktank.com>
2013-02-26 17:45:33 -08:00
Samuel Just
9a399afd71
doc: add some internal docs for watch/notify
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2013-02-20 13:29:20 -08:00
Gary Lowell
1867b81883
docs: fix typo in release-process doc
...
Signed-off-by: Gary Lowell <gary.lowell@inktank.com>
2012-12-28 14:05:56 -08:00
Gary Lowell
774a54cbdd
docs: update release process documentation.
...
Signed-off-by: Gary Lowell <gary.lowell@inktank.com>
2012-12-27 15:39:46 -08:00
Gary Lowell
98e7b59807
docs: remove extra release-process2 file.
...
This file mostly duplicated the existing release documentation. Differences
have been merged into the primary file.
Signed-off-by: Gary Lowell <gary.lowell@inktank.com>
2012-12-27 11:14:19 -08:00
Gary Lowell
cedea1391c
docs: Merge changes from release-process2 document.
2012-12-26 12:54:27 -08:00
John Wilkins
0a2a0c075c
doc: config-cluser move to new IA.
...
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-14 14:57:51 -08:00
Mike Ryan
cdd73bbab0
doc/: document recovery reservation process
...
Signed-off-by: Mike Ryan <mike.ryan@inktank.com>
2012-11-07 17:21:32 -08:00
John Wilkins
06c62c5217
doc: Added syntax fixes to Peter's session authentication doc.
...
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-10-30 11:20:51 -07:00
Peter Reiher
a67afa4b09
Merge branch 'wip-msgauth4'
...
Conflicts:
src/common/config_opts.h
Added a couple of options related to session authentication, accepted new values for option from master
2012-10-26 09:25:15 -07:00
Sage Weil
69a96bb513
doc: clean up doc build directions
...
Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-19 10:40:25 -07:00
Sage Weil
fcf6273d04
Merge remote-tracking branch 'gh/wip-msgauth4'
2012-10-15 20:57:19 -07:00
Tommi Virtanen
3ba7ab2ba5
doc: Whitespace cleanup.
...
Signed-off-by: Tommi Virtanen <tv@inktank.com>
2012-10-04 14:54:17 -07:00
Tommi Virtanen
790b508903
doc: rst syntax fixes.
...
Signed-off-by: Tommi Virtanen <tv@inktank.com>
2012-10-04 14:54:17 -07:00
Sage Weil
74ea0cb541
doc: update release-process.rst
...
Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-03 08:44:52 -07:00
Gary Lowell
2519bd3932
doc: Added description of ceph release process.
2012-10-02 23:41:35 -07:00
Peter Reiher
35488061a7
New documentation about Cephx protocol and session authentication.
...
Signed-off-by: Peter Reiher <reiher@inktank.com>
2012-10-01 13:12:14 -07:00
Sage Weil
a351f7a1f4
Merge remote-tracking branch 'gh/wip_backfill_full2'
...
Conflicts:
src/include/ceph_features.h
2012-09-27 13:21:23 -07:00
Josh Durgin
fa3a7472f9
doc: fix typo in dev layering notes
...
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-09-26 17:41:03 -07:00
Samuel Just
3ebf52dfb5
doc/: added documentation for backfill_reservation
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2012-09-25 11:43:51 -07:00
John Wilkins
441ae009fc
doc: Restored "Differences from Posix" to /doc/dev
...
Fixes : #3185
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-09-23 21:50:53 -07:00
Yehuda Sadeh
2f73c07511
docs: add radosgw internals and usage testing section
...
Document the current tests that are being done on the
radosgw usage feature.
Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-09-18 11:17:22 -07:00
Samuel Just
32892c1edd
doc/dev/osd_internals: add newlines before numbered lists
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2012-07-17 16:51:57 -07:00
Samuel Just
24df8b1d82
doc/dev: add osd_internals to toc
...
Signed-off-by: Samuel Just <sam.just@inktank.com>
2012-07-17 09:54:47 -07:00
Sage Weil
5ceb7c734a
doc: fix config metavariables discussion
...
Signed-off-by: Sage Weil <sage@inktank.com>
2012-07-12 10:00:41 -07:00
Sage Weil
d1054df6be
doc: perf counters
...
Signed-off-by: Sage Weil <sage@inktank.com>
2012-07-12 10:00:41 -07:00
Josh Durgin
31ad2639b2
doc: add design doc for rbd layering
...
I'm still not sure about the names for the command line
operations, but they can be changed later if better ones
come up.
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-06-30 21:45:28 -07:00
Sage Weil
d9e902f9c5
ceph.newdream.net -> ceph.com
...
wiki url -> docs url
2012-06-16 14:50:29 -07:00
Sage Weil
d93410c799
doc: document range of methods for cluster creation, expansion
...
This isn't quite complete, and should be integrated with the info in the
ops section on mon cluster expansion, but the raw content is here at least.
Signed-off-by: Sage Weil <sage@inktank.com>
2012-05-21 16:57:26 -07:00
Tommi Virtanen
5465e81097
doc: Whitespace cleanup.
...
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-03 10:15:21 -07:00
John Wilkins
a1b31ddfda
Initial cut of introduction, getting started, and installing. More to do on installation. RADOS gateway to follow.
...
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:54 -07:00
John Wilkins
d3a2c56566
doc: move documentation build instructions to doc/dev section
...
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 11:21:12 -07:00
Tommi Virtanen
1ec47db1bd
doc: Convert the mailing list mention to not be a section heading.
...
If toctree is inside a section, the subtree is inside the section too.
We don't want all of dev/* to be under "Mailing list".
I have not found a decent workaround for this. The toplevel toctree
avoids this purely by the fact that it is the topmost toctree. Right
now that means you should 1) avoid having more than a few paragraphs of
text before the toctree for that subtree (put most of the content after
the toctree; clumsy if the toctree is long), or 2) put the toptree
immediately after the document title, make it :hidden:, and let the
reader use links in the text or the ToC in the sidebar to navigate.
See start/index for an example of this.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-03-30 11:11:25 -07:00
Tommi Virtanen
b162696b32
doc: Fix reStructuredText syntax errors.
...
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-03-30 11:11:12 -07:00
Greg Farnum
1814aac175
Merge branch 'misc-fixes-for-review'
2012-03-27 13:57:54 -07:00
Greg Farnum
d0ba27ae50
doc: add a short thing on kernel client troubleshooting.
...
I just noticed this sitting uncommitted in my tree.
Signed-off-by: Greg Farnum <gregory.farnum@dreamhost.com>
2012-03-27 13:57:45 -07:00
Sage Weil
6db7715897
doc/dev/peering.rst: fix typo
...
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-03-26 10:15:07 -07:00
Sage Weil
21a170e8f3
doc: dev/peering.rst edits from Greg
...
Signed-off-by: Sage Weil <sage@newdream.net>
2012-03-22 14:41:30 -07:00
Sage Weil
8fa904a6ea
doc: update dev/peering document
...
- fix discussion of last epoch started
- define terms for current and past intervals
- describe role of pg info
- remove mention of the backlog
- fix discussion of up_thru
- etc.
Signed-off-by: Sage Weil <sage@newdream.net>
2012-03-22 08:33:09 -07:00
Alex Elder
ac28b6036d
ceph: document the way files are laid out
...
This adds a document that I wrote about how Ceph client file data
is striped across Ceph objects to the repository. It's a text
document. Someone with better document preparation skills than I
should use the content below as a basis for something prettier if
that's appropriate.
[Made a few edits... -sage]
Signed-off-by: Alex Elder <elder@dreamhost.com>
Signed-off-by: Sage Weil <sage@newdream.net>
2012-03-08 15:18:59 -08:00
Sage Weil
bd97923ceb
doc: fix misc typos, bad phrasing
...
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-03-06 21:03:58 -08:00
Sage Weil
70360f840e
github.com/NewDreamNetwork -> github.com/ceph
2012-03-02 11:00:08 -08:00
Sage Weil
f317028f42
doc: beginnings of documentation of stuck pgs and pg states
...
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
Reviewed-by: Sage Weil <sage@newdream.net>
2012-02-27 15:41:57 -08:00
Josh Durgin
dd31ff2e5c
doc: add short section on documenting code
...
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2012-01-09 19:10:10 -08:00
Tommi Virtanen
81feae12e1
doc: Add misc explanations of Ceph internals from email.
...
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-14 11:19:00 -08:00
Mark Kampe
06228716e3
Doc: add a conceptual overview of the peering process
...
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-02 11:28:38 -08:00
Mark Kampe
813523a681
Doc: delete gratuitous index.html
...
It was not an index, and seems to contain recommendations
for system configuration. I have renamed it to confusing.txt
and will merge it in a future commit.
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:13:12 -08:00
Mark Kampe
3c7a82a6dc
Doc: deleted gratuitious PlanningImplementation.html,
...
which was a copy of PlanningImplementation.txt
(and not html at all).
restored previous index.rst, which was overwritten with a copy
of PlanninImplementation.txt, but removed all of the recursively
included content from the document.
I will cherry-pick merge the new contents in a subsequent commit.
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:12:12 -08:00
Samuel Just
1c696b6566
doc: Add peering state diagram
...
Signed-off-by: Samuel Just <samuel.just@dreamhost.com>
2011-11-29 16:35:59 -08:00
Sondra.Menthers
d9dfd14761
rgw: handle swift PUT with incorrect etag
2011-10-27 11:16:51 -07:00