Commit Graph

67 Commits

Author SHA1 Message Date
Anthony D'Atri
154d05fe11 doc: object -> file -> disk is wrong for bluestore
Address tracker 23443

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>

doc: object -> file -> disk is wrong for bluestore

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-19 22:43:59 -08:00
Kefu Chai
8aac5d2785
Merge pull request #32682 from lorenzen-b1/patch-1
doc/architecture.rst: clarify scrubbing

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-05-16 19:45:15 +08:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
nagpavan-chilakam
3ddac762f8 doc/architecture.rst: fix a typo in EC section
In erasure coding section under Architecture, there is a mention of k = 2 + M =1 for
number of data copies and redundancy copies respectively, which is a bit ambiguous.
The proposal is to change to k = 2, M = 1 as the + sign is not needed here.

Signed-off-by: Nag Pavan Chilakam <nagpavan.chilakam@gmail.com>
2020-02-13 20:01:37 +08:00
Oluf Lorenzen
cbeb5f78e4
docs: architecture: clarify scrubbing
Signed-off-by: Oluf Lorenzen <lorenzen@b1-systems.de>
Co-Authored-By: Jens Sandmann <25345569+B1Sandmann@users.noreply.github.com>
Co-Authored-By: Jens Sandmann <sandmann@b1-systems.de>
2020-01-17 10:07:58 +01:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
Arthur Liu
8da2291e7d doc: fix typo in erasure coding example
Signed-off-by: Arthur Liu <arthurhsliu@gmail.com>
2019-01-26 08:44:42 +11:00
Kefu Chai
5ee1fd2c32 doc: fix typos
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-09-21 12:41:42 +08:00
Jos Collin
152f4fba1e
doc: s/Ceph FS/CephFS
Fixes: https://github.com/ceph/ceph/pull/22784#discussion_r200755460
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-28 19:59:33 +05:30
Jos Collin
81c0a328ac doc: new label and glossary url
Let the other docs link Ceph Filesystem glossary from outside.
If the user wants then let him visit the Ceph Filesystem doc(s)
from the glossary.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-07 07:23:15 +05:30
Nathan Cutler
aea9fa01ae doc: globally change CRUSH ruleset to CRUSH rule
Since kraken, Ceph enforces a 1:1 correspondence between CRUSH ruleset and
CRUSH rule, so effectively ruleset and rule are the same thing, although
the term "ruleset" still survives - notably in the CRUSH rule itself, where it
effectively denotes the number of the rule.

This commit updates the documentation to more faithfully reflect the current
state of the code.

Fixes: http://tracker.ceph.com/issues/20559
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-12-11 17:15:23 +01:00
Kefu Chai
127d25ccbd doc: fix warning reported by "build-doc linkcheck"
all the HTTP 301 (moved permanently) should be killed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-24 15:58:48 +08:00
Frank Yu
94af0d3ea4 doc: the client inputs the pool name instead of pool ID
Signed-off-by: Frank Yu <flyxiaoyu@gmail.com>
2017-09-12 23:04:14 +08:00
liuchang0812
998ee1d190 doc: kill some broken links
Signed-off-by: liuchang0812 <liuchang0812@gmail.com>
2017-06-07 16:13:45 +08:00
Nathan Cutler
9a10c5c7c6 doc: doc/architecture.rst: unify initial caps in term Ceph Monitor
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-05-23 16:56:53 +02:00
Nathan Cutler
d54d80958b doc: fix factual inaccuracy in doc/architecture.rst
Signed-off-by: Sage Weil <sage@redhat.com>
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-05-23 16:56:48 +02:00
Tahia Khan
a92171ebb8 doc: fixes a broken hyperlink to RADOS paper in architecture
Signed-off-by: Tahia Khan <tahia.khan@gmail.com>
2017-02-27 22:44:58 -05:00
Patrick Donnelly
4323d47122
mds: remove deprecated commands from docs
This mostly is just removing the commands from the man page ceph(1). I
left the legacy section in doc/cephfs/administration.rst as-is.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2016-10-12 10:58:38 -04:00
Leo Zhang
c387c87434 doc: fix dead link "Hardware Recommendations"
Signed-off-by: Leo Zhang <nguzcf@gmail.com>
2016-10-08 22:41:59 +08:00
luokexue
6d69636ee9 doc: Fixes all "Qemu" to "QEMU"
Signed-off-by: luokexue <luo.kexue@zte.com.cn>
2016-04-16 11:42:19 +08:00
Zhao Junwang
c399d3187e doc/architecture.rst: remove redundant word "across"
Signed-off-by: Zhao Junwang <zhjwpku@gmail.com>
2016-03-17 17:34:51 +08:00
Rachana Patel
d2c145e66c doc :- fixing image in section ERASURE CODING
Description:- When write is completed successfully and previous chunks of previous version of object is removed - log should show 1,2 and no need of indicating - write operation.
Signed-off-by: Rachana Patel <rachana83.patel@gmail.com>
2016-01-20 13:38:34 -05:00
Abhishek Lekshmanan
437c9e1e25 doc: architecture minor fixes in watch notify
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
2015-06-09 00:21:58 +05:30
Adam Spiers
11aa383179 doc: fix typos in diagram for incomplete write
In this example of a write of v2 of the object being interrupted, OSD2
would never have any version of the D1 chunk.  It only has the old v1
version of the D2 chunk.

Signed-off-by: Adam Spiers <aspiers@suse.com>
2014-11-16 16:03:24 -05:00
Adam Spiers
2379c57a3c doc: fix incorrect equalities
The previous punctuation accidentally implied that K == 1 and M == -1.

Signed-off-by: Adam Spiers <aspiers@suse.com>
2014-11-16 16:03:18 -05:00
Adam Spiers
625dd4040f doc: fix typo (superfluous "no")
Signed-off-by: Adam Spiers <aspiers@suse.com>
2014-11-16 16:02:57 -05:00
John Wilkins
2fbe82dfeb doc: Fixed syntax error.
Signed-off-by: John Wilkins <jowilki@redhat.com>
2014-09-11 10:50:42 -07:00
John Wilkins
5db51d6f2a doc: Added a few comments and links to other relevant docs.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-25 11:02:27 -07:00
John Wilkins
3faf37a308 doc: Put architectural details of authentication in to architecture doc.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-13 20:27:31 -07:00
Abhishek Lekshmanan
bb881e53da doc: fix a few typos in architecture page
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-09 10:28:35 +05:30
Venky Shankar
ef06515659 doc: fix typo in erasure coding section
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2014-06-09 15:04:53 +05:30
John Wilkins
f153bc186e doc: Made additional changes s/CRUSH/Ceph for pull request #1855
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-05-28 17:49:21 -07:00
Kai Zhang
d3af8fa880 Update architecture.rst:Calculating PG IDs
To Calculate PG ID, if I didn't get it wrong, CRUSH calculates the hash modulo 
the number of PGs instead of OSDs, according to osd/osd_types.cc:963 
ceph_stable_mod(pg.ps(), pg_num, pg_num_mask).

Signed-off-by: Kai Zhang <zakir.exe@gmail.com>
2014-05-22 17:37:16 -07:00
John Wilkins
515827223f doc: Added erasure coding and cache tiering notes. Special thanks to Loic Dachary.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-05-06 03:53:03 -07:00
Danny Al-Gaaf
2cbb0a402b architecture.rst: fix typos
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-08 11:27:15 +01:00
John Wilkins
c19935cd09 doc: Fixed typo.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-10-03 13:30:18 -07:00
John Wilkins
8f8fd7a915 doc: Updated index tags.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-14 16:52:25 -07:00
John Wilkins
58a880bd14 doc: Fixing index references.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-16 13:57:23 -07:00
John Wilkins
f36ec02f93 doc: Updated architecture document.
fixes: #2968

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-14 17:05:43 -07:00
John Wilkins
b71ec9c25a doc: Added some detail. Calculating PGs, maps; reorganized a bit.
fixes: #2968

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-22 21:02:45 -07:00
John Wilkins
b76f12d499 doc: Edited striping section. Modified stripe graphic to pretty print. Also modified replication graphic to pretty print.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-04 10:58:02 -08:00
John Wilkins
a74a4acf50 doc: Added a striping section for Architecture.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-03 20:48:02 -08:00
John Wilkins
f2c7a60c90 doc: Fixed many hyperlinks, a few typos, and some minor clarifications.
fixes: #3564

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-03 12:22:37 -08:00
John Wilkins
15b3d98fc4 doc: Minor edits and added reference to Cephx intro.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-05 11:02:55 -08:00
John Wilkins
b3651dac76 doc: Cleanup, spell check, grammar check mostly.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-09-19 16:22:38 -07:00
John Wilkins
3d86194f9e :doc: Rewrote architecture paper. Still needs some work.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-09-18 11:08:23 -07:00
John Wilkins
812989bf35 doc: misc updates
doc/architecture.rst - removed broken reference.
doc/config-cluster - cleanup and added chef
doc/install - Made generic to add Chef, OpenStack and libvert installs
doc/init - Created light start | stop and health section
doc/source - Removed $ from code examples. Trimmed paras to 80 char
doc/images - Added preliminary diagram for Chef.
doc/rec - Added reference to hardware. Added filesystem info.

Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
2012-05-21 16:39:15 -07:00
Mark Kampe
48165af5c2 Doc: complete reversion of architecture.rst
(abandon in progress improvements until everything works)

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:12:34 -08:00
Mark Kampe
fdf3f7bd7d Doc: Restore the previous version of architecture.rst
it was accidentally overwritten with a version of the product
had a somewhat different audience/focus and a few sphinx
formatting errors.

I will cherry-pick the corrections in a subsequent commit.

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:11:05 -08:00
Sondra.Menthers
ed839f5a41 fixed graphic reference and headings 2011-10-27 14:04:56 -07:00