Commit Graph

237 Commits

Author SHA1 Message Date
Luis Pabón
20b27661f6 Update vstart to setup users for s3-tests
vstart.sh now creates the users for the default configuration
for the s3-tests, available on https://github.com/ceph/s3-tests.

Also updated the documentation to show the correct RadosGW port.

Signed-off-by: Luis Pabón <lpabon@redhat.com>
2014-10-13 10:18:03 -04:00
Loic Dachary
0fb0967e95 documentation: tiering typo
Signed-off-by: Loic Dachary <loic-201408@dachary.org>
2014-09-19 15:05:27 +02: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
Luis Pabón
df3b6fc472 Fix syntax error in rst documentation
Signed-off-by: Luis Pabón <lpabon@redhat.com>
2014-08-25 14:44:01 -04:00
Luis Pabón
4fa4553de8 Merge branch 'master' into rgw-doc
Conflicts:
	src/vstart.sh
2014-08-20 14:15:58 -04:00
Luis Pabón
98b24f3970 vstart.sh to enable support for simple RadosGW
Signed-off-by: Luis Pabón <lpabon@redhat.com>
2014-08-20 12:21:36 -04:00
John Wilkins
acee2e5833 doc: Move wireshark documentation to dev.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-18 14:28:38 -07:00
Kevin Cox
281159bf3b doc: Initial network docs.
Signed-Off-By: Kevin Cox <kevincox@kevincox.ca>
2014-08-09 15:52:38 -04:00
Luis Pabón
a923e2c9eb Renamed README to README.md to render in markdown
Signed-off-by: Luis Pabón <lpabon@redhat.com>
2014-08-05 14:51:16 -04:00
Luis Pabón
52cf693e8d Developer quick start guide
Signed-off-by: Luis Pabón <lpabon@redhat.com>
2014-08-05 14:48:47 -04:00
Abhishek Lekshmanan
1682e62eeb doc: typo s/loose/lose
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-08-05 10:35:03 +05:30
Abhishek Lekshmanan
cc5c33f566 doc: fix a few typos in the dev docs
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-09 11:05:46 +05:30
Sage Weil
55e297ad9a Merge pull request #2046 from ceph/wip-8670
mon: OSDMonitor: 'osd pool' - if we can set it, we must be able to get it

Reviewed-by: Loic Dachary <loic@dachary.org>
Reviewed-by: Sage Weil <sage@redhat.com>
2014-07-02 17:44:56 -07:00
Loic Dachary
1dfe913af2 erasure-code: add definitions to the glossary
and fix a typo

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-06-30 11:35:31 +02:00
Joao Eduardo Luis
12079a7c7c doc: dev: cache-pool.rst: fix typo s/objets/objects/
Signed-off-by: Joao Eduardo Luis <joao.luis@inktank.com>
2014-06-28 14:44:09 +01:00
Loic Dachary
db90d86ee4 Merge pull request #1824 from dachary/wip-documentation
erasure-code: fix URL in developer notes

Reviewed-by: koleosfuscus <koleosfuscus@yahoo.com>
2014-05-27 11:41:18 +02:00
Christian Theune
107821fe9b Fix formatting of header
The header was displaying the newline as a simple "n" due to quoting in the doc.

Signed-off-by: Christian Theune <ct@gocept.com>
2014-05-20 10:38:01 +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
John Wilkins
c3833d7c41 doc: Fixed syntax to include 'pool'.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-04-21 15:43:23 -07:00
Dmitry Smirnov
f22e2e9a02 spelling corrections 2014-04-17 12:43:30 +10:00
Loic Dachary
db3e0b5129 erasure-code: document the ruleset-root profile parameter
If unspecified it is ruleset-root=default and will translate into

   take default

when a ruleset is created for an erasure-code pool.

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-04-11 13:51:46 +02:00
Dan Mick
3c54a49e39 Wordsmith the erasure-code doc a bit
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2014-04-10 19:55:52 -07: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
Loic Dachary
fd28ad55a9 doc: erasure-code development complete
remove the note explaining that it is not yet available.

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-29 11:25:59 +01:00
Loic Dachary
72eaa5e885 doc: fix typos in tiering dev doc
Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-28 14:02:25 +01:00
Sage Weil
f1e3bc9a9b doc/dev/cache-pool: describe the tiering agent
Signed-off-by: Sage Weil <sage@inktank.com>
2014-03-18 13:09:29 -07:00
Loic Dachary
eac224a4ab doc: update the erasure-code dev documentation
Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-18 00:23:42 +01:00
Sage Weil
5ec493600e Merge remote-tracking branch 'gh/firefly' 2014-03-13 15:15:49 -07:00
Sage Weil
c55da14a3d Merge pull request #1362 from dachary/wip-7548
doc: erasure coded pool developer and operations documentation

Reviewed-by: Sage Weil <sage@inktank.com>
2014-03-11 21:54:02 -07:00
Sage Weil
004bf3b20a Merge pull request #1415 from ceph/wip-build-doc
doc: release-process documentation updates

Reviewed-by: Sage Weil <sage@inktank.com>
2014-03-11 21:29:53 -07:00
Sage Weil
b70db7e735 Merge remote-tracking branch 'gh/firefly' 2014-03-11 19:20:27 -07:00
Ken Dreyer
2e420f9d4a doc: rm duplicate info from release-process
The "just push the new tag" bit is already done in the list of commands
above. Remove this piece, since it's duplicated by the "git push"
command above.

The ceph-deploy and backports-sections were empty. Remove them.
2014-03-10 16:06:48 -06:00
Ken Dreyer
52a2d6923e doc: fix reST formatting in release-process
Signed-off-by: Ken Dreyer <ken.dreyer@inktank.com>
2014-03-10 15:14:55 -06:00
Gary Lowell
bb737117b3 doc: update release-process for packages
New script to sign rpms in the repo and create the indexes, and
some description of additional packages that might need to be added.

Signed-off-by: Gary Lowell  <gary.lowell@inktank.com>
Reviewed-by: Ken Dreyer <ken.dreyer@inktank.com>
2014-03-10 15:14:34 -06:00
Gary Lowell
dd5a378d43 doc: misc updates for release-process
Signed-off-by: Gary Lowell  <gary.lowell@inktank.com>
Reviewed-by: Ken Dreyer <ken.dreyer@inktank.com>
2014-03-10 15:14:21 -06:00
Danny Al-Gaaf
87618d4508 session_authentication.rst: fix some typos
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-09 00:19:08 +01:00
Danny Al-Gaaf
682c695898 release-process.rst: fix some typos
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-09 00:07:39 +01: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
Danny Al-Gaaf
e666019434 doc/dev/logs.rst; fix some typos
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-08 23:31:11 +01:00
Danny Al-Gaaf
bbd1c4bab5 filestore-filesystem-compat.rst: fix typo
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-08 23:25:53 +01:00
Danny Al-Gaaf
ae123a6dd5 corpus.rst: fix typo
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-08 23:22:38 +01:00
Danny Al-Gaaf
cf9f017d4e config.rst: fix typo
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-08 23:16:24 +01:00
Danny Al-Gaaf
5aaecc7210 cephx_protocol.rst: fix typo
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-08 23:11:25 +01:00
Loic Dachary
74614106c8 doc: erasure coded pool developer documentation
With a structure similar to doc/dev/cache-pool.rst

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

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-03-04 09:52:11 +01:00
Sage Weil
a850a38711 doc/dev/cache-pool: fix notes
Signed-off-by: Sage Weil <sage@inktank.com>
2014-02-28 08:11:57 -08: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
00ee9a5289 doc: improve ceph-mon usage, fix ceph tell examples
The ceph-mon command usage is updated to document all of the ceph-mon
specific options.

The ceph tell usage examples for log and debug are using a deprecated syntax.

Signed-off-by: Loic Dachary <loic@dachary.org>
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2013-11-26 09:44:45 -08:00
John Wilkins
8a36503879 doc: Moved CPU Profiler docs to dev.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-10-22 13:22:17 -07: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
Wido den Hollander
991139bc0d doc: When bootstrapping mon set the correct caps for client.admin
Otherwise client.admin will be privilege-less and the admin can't
access the cluster.
2013-09-23 13:52:51 +02:00
John Wilkins
1e54d835cc doc: Syntax fixes to suppress gitbuilder warnings.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:27:12 -07:00
John Wilkins
68659a6563 doc: Syntax fixes to suppress gitbuilder warnings.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:26:47 -07:00
John Wilkins
1bb722550f doc: Syntax fixes to suppress gitbuilder warnings.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:23:24 -07:00
John Wilkins
a6a714064e doc: Syntax fixes to suppress gitbuilder warnings.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:22:59 -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
John Wilkins
9c0970168b doc: Syntax fixes to stop gitbuilder warnings.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 11:19:21 -07:00
Sage Weil
d33853d380 Merge pull request #555 from dachary/master
minor documentation fixes
2013-09-05 08:51:21 -07:00
Greg Farnum
f566102c3c doc: remove 'Unexpected indentation' from versions doc.
Signed-off-by: Greg Farnum <greg@inktank.com>
2013-09-04 10:10:03 -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
Dan Mick
dcbdeaf6d1 doc: Fix repo URL for Ceph cloning (dev/generatedocs)
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-09-03 15:56:53 -07:00
Greg Farnum
087800ee49 osd: provide better version bounds for cls_current_version and ENOENT replies
Following the changes to when we set or increase the user_version, we
want to continue to return the best lower bound we can on the version
of any newly-created object. For ENOENT replies that means returning
info.last_user_version instead of the (potentially-zero) ctx->user_at_version.

Similarly, for cls_current_version we want to return the last version on
the PG rather than the last update to the object in order to provide
sensible version ordering across object deletes and creates.

Update the versions doc so it continues to be precise.

Signed-off-by: Greg Farnum <greg@inktank.com>
Reviewed-by: Sage Weil <sage@inktank.com>
2013-09-03 10:54:23 -07:00
Gregory Farnum
b30a1b2889 Merge pull request #554 from ceph/wip-tier-interface
Specify a user and pg_pool_t interface for tiering/caching specifications

Reviewed-by: Samuel Just <sam.just@inktank.com>
Reviewed-by: Joao Eduardo Luis <joao.luis@inktank.com>
2013-08-30 14:13:25 -07:00
Sage Weil
cb2abad901 Merge pull request #539 from dachary/master
doc : erasure code developer notes updates
2013-08-28 10:29:17 -07:00
Sage Weil
61b40f481b doc/dev/cache-pool: document cache pool management interface
Signed-off-by: Sage Weil <sage@inktank.com>
2013-08-28 09:34:03 -07:00
Greg Farnum
9101433a88 Merge remote-tracking branch 'origin/master' into wip-6029
Conflicts:
	src/librados/AioCompletionImpl.h
2013-08-27 17:26:36 -07:00
Greg Farnum
6c432f1932 doc: update to describe new OSD version support as it actually exists
Signed-off-by: Greg Farnum <greg@inktank.com>
2013-08-27 17:24:51 -07:00
Greg Farnum
295a84b9d9 doc: include plan for new user_version support
Signed-off-by: Greg Farnum <greg@inktank.com>
2013-08-27 17:00:44 -07:00
Greg Farnum
b5ea74cec4 docs: document how the current OSD PG/object versions work
Signed-off-by: Greg Farnum <greg@inktank.com>
2013-08-27 15:08:28 -07: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
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