Commit Graph

104 Commits

Author SHA1 Message Date
Zac Dover
36478fd539 doc/glossary: define "RGW"
Add definition under the headword "RGW".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-20 13:39:22 +10:00
Zac Dover
dfddc388fd doc/glossary: add "RADOS" definition
Define "RADOS" in the glossary. We will return in the next month to beef
this entry up.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-19 11:37:40 +10:00
Zac Dover
918f539399 doc/glossary: rewrite "Ceph File System"
Improve the definition of "Ceph File System".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-17 07:28:45 +10:00
Zac Dover
6e0be8b936 doc/glossary: define "Ceph Object Gateway"
Define "Ceph Object Gateway" and link to more information.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-16 12:39:53 +10:00
Zac Dover
8e53e08bc2 doc/glossary: improve "Ceph Point Release" entry
Improve the English in the "Ceph Point Release" entry in the glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-15 11:25:19 +10:00
Zac Dover
75de28e9b2 doc/glossary: add "mds" term
Improve "MDS" glossary term. Link to MDS information.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-14 14:24:19 +10:00
Zac Dover
4dfb0fd184 doc/glossary: update "pool/pools"
Update the "pool" and "pools" entries and link to the part of the
documentation related to pools.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-12 03:37:11 +10:00
Zac Dover
00fb911f78 doc/glossary: remove "Ceph Test Framework"
Remove "Ceph Test Framework" because it doesn't actually refer to
anything.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-11 13:50:52 +10:00
Zac Dover
f5e3eb2ffe doc/glossary: redirect entries to "Ceph OSD"
Redirect "Ceph OSD Daemon" and "Ceph OSD Daemons" to the entry for "Ceph
OSD", which is already defined.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-11 06:31:59 +10:00
Zac Dover
a2cb2f0dbe doc/glossary: improve "Ceph Manager Dashboard"
Redirect "Ceph Manager Dashboard" to the glossary term "Ceph Dashboard".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-10 12:24:12 +10:00
Zac Dover
5d2ae39465 doc/glossary: improve "ceph" term
Define "ceph" in glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-10 08:39:31 +10:00
Zac Dover
fc1ce7b10b doc/glossary: improve "Ceph Manager" term
Improve the glossary entry "Ceph Manager" by correcting the grammar and
properly linking to the "Ceph Manager" section of the Architecture
Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-09 23:12:54 +10:00
Zac Dover
998e6059e8 doc/glossary: update "Cluster Map"
Improve "Cluster Map" in the glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-08 23:11:15 +10:00
zdover23
d58f27419e
Merge pull request #48769 from zdover23/wip-doc-2022-11-08-glossary-OSD
doc/glossary: disambiguate "OSD"

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2022-11-08 22:34:41 +10:00
zdover23
86c300c787
Merge pull request #48775 from zdover23/wip-doc-2022-11-08-glossary-OSD-link
doc/glossary: link to OSD material

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2022-11-08 12:58:08 +10:00
Zac Dover
e7d0d59a8b doc/glossary: link to OSD material
Link to the OSD material in RADOS Configuration
"Storage Devices".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-08 12:33:18 +10:00
Zac Dover
77da4e66b0 doc/glossary: add "BlueStore"
Define "BlueStore" in the glossary and link to the BlueStore
section in the RADOS Configuration "Storage Devices" chapter.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-08 12:25:35 +10:00
Zac Dover
02360acb25 doc/glossary: disambiguate "OSD"
Distinguish "object storage device" from "object storage daemon".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-08 09:31:28 +10:00
Zac Dover
1d2c3bb8f6 doc/glossary: define "Ceph OSD"
Define "Ceph OSD", using Sage's own description.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-08 09:05:10 +10:00
Zac Dover
d0db2e0c6b doc/glossary.rst: define "Ceph Manager"
Add a definition for Ceph Manager (ceph-mgr).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-07 23:55:53 +10:00
Zac Dover
95154ed492 doc/glossary: define "OSD"
Define "OSD" as "Object Storage Device", distinct from
"object storage daemon".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-07 04:04:04 +10:00
Zac Dover
f85fb97a43 doc/glossary.rst: remove old front matter
Remove two paragraphs from May 2013 that no longer apply.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-06 17:41:20 +10:00
Zac Dover
add6cc2a91 doc/glossary: improve wording
Remove "e.g." and "etc." and improve the wording of a definition.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-06 03:04:27 +10:00
Zac Dover
796bc17ddf doc/glossary.rst: add "Ceph Dashboard" term
Add a definition for "Ceph Dashboard".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-06 02:22:25 +10:00
Zac Dover
09e4df6a52 doc/glosary.rst: add "Ceph Block Device" term
Add a definition for "Ceph Block Device".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-05 15:34:20 +10:00
Zac Dover
8f4ad5dc9d doc/glossary: add "ceph monitor" entry
This commit adds information to the "ceph monitor" entry in
glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-12 03:20:07 +10:00
Zac Dover
0692b22354 doc/glossary.rst: remove duplicates
This commit removes similar but distinct entries for the following:
   * CephFS
   * Ceph Client

Removal of a glossary term that is referred to in the body of the
documentation suite requires the alteration of the text string
that refers to the glossary term. Alterations of this kind have
been made to doc/architecture.rst and doc/rados/api/index.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-03 22:51:35 +10:00
Zac Dover
10b33bdabe doc/glossary.rst: alphabetize glossary terms
This commit (finally) alphabetizes the terms in the glossary.
This is not a grammar-correcting or usage-correcting commit.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-03 09:54:26 +10:00
Thomas Lamprecht
023c32c99b docs: fix case and spelling of Proxmox VE
There's no such thing as ProxMox, the hypervisor product with build
in ceph server management and RBD client access is named `Proxmox VE`
and the company behind it is named Proxmox Server Solutions GmbH

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-10-18 12:10:26 +02: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
Servesha Dudhgaonkar
324426c966 doc: fixed caps
Signed-off-by: Servesha Dudhgaonkar <sdudhgao@redhat.com>
2019-04-05 17:29:05 +05:30
Lenz Grimmer
48282cb9f9 doc: Updated Ceph Dashboard documentation
Renamed "Ceph Manager Dashboard" to "Ceph Dashboard" in
various locations, replaced "plugin" with "module".
Overhauled the feature list, added more references to configuration
instructions and related components.
Fixed capitalization of subchapters.
Added note about mixed content blocking to the Grafana section.
Removed duplicate content from the dashboard's `README.rst`,
moved some parts (supported browser list) into the documentation
instead.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2019-02-28 17:14:37 +01: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
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
Jos Collin
a703e22bc4 doc: s/doc/ref for dashboard urls
Replaced :doc: with :ref: as per https://github.com/ceph/ceph/pull/22750#discussion_r198895040.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-29 20:19:56 +05:30
Jos Collin
22f205718a doc: updated the overview and glossary for dashboard
* Updated the overview of dashboard to avoid many paragraphs,
some outdated statements, etc.
* Updated glossary, glossary references and urls
* Dropped unnecessary term *module* in possible places
* Unified the new dashboard name as *Ceph Manager Dashboard*

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-28 16:01:30 +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
Yao Zongyou
9eb9b8f3da doc: fix typo e.g,. => e.g.,
Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
2017-10-28 09:06:24 +08: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
Alfredo Deza
7d0c3e3eb4 doc: add LVM tag term to the glossary
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:44:54 -04:00
Alfredo Deza
302d79d772 doc/glossary add terminology used by ceph-volume
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:44:53 -04:00
Kefu Chai
75fa7622ec doc/glossary: add "Ceph Manager" and "OSD Daemons" to glossary
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-16 16:39:40 +08:00
Kevin Dalley
dcf9568b67 doc: Define RADOS in glossary
Signed-off-by: Kevin Dalley <kevin@kelphead.org>
2014-05-29 14:03:30 -07:00
Kevin Dalley
5986f746dc :doc Ceph OSD is standard name
This is a method of standardizing the usage of OSD so that "Ceph OSD"
is the daemon, and OSD maintains its industry standard usage of Object
Storage Device.

Signed-off-by: Kevin Dalley <kevin@kelphead.org>
2014-05-08 14:58:02 -07:00
Nikola Kotur
2826fdad47 doc: fix typos in glossary 2014-03-31 16:24:28 +02:00
John Wilkins
0da9621a89 doc: Adds additional terms for use with librados.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-02-11 13:28:04 -08:00
John Wilkins
5c4b4f0f65 doc: Added another instance term to the glossary.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-17 15:58:25 -07:00
John Wilkins
5737d032bf doc: Added cluster map and CRUSH definitions.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-16 13:57:53 -07:00
John Wilkins
8f3fb97256 Added OSD to glossary, removed parenthetical.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-14 17:06:12 -07:00
John Wilkins
473aae9616 doc: Added glossary.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-07 07:57:40 -07:00
Tommi Virtanen
76fbdfb3dd doc: Add index entries, remove glossary as it's practically replaced by the index.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-23 15:55:00 -07:00
Sage Weil
6f8f140350 c* -> ceph-*
Hopefully I didn't miss too much...

Signed-off-by: Sage Weil <sage@newdream.net>
2011-09-22 15:08:25 -07:00
Tommi Virtanen
b68eaf1875 doc: Say "radosgw" not "rgw".
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-14 08:42:06 -07:00
Tommi Virtanen
f1d8964499 First draft of the documentation overhaul.
To build the docs, run ./admin/build-doc. To browse them, either get
them on any static website, or just run ./admin/serve-doc to serve
them quickly off of port 8080.

build-doc sets up a virtualenv to avoid needing Sphinx installed
system-wide. serve-doc needs thttpd installed.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00