Commit Graph

100 Commits

Author SHA1 Message Date
Zac Dover
35d168826f doc/glossary.rst: add "Monitor Store"
Add the term "Monitor Store" to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-30 08:08:00 +01:00
Zac Dover
c2f6a770bf doc/glossary: add "Quorum" to glossary
Add the term "Quorum" to the glossary and link to the part of
architecture.rst concerning Monitors. The sticky header at the top of
the docs.ceph.com website gets in the way of the location linked to in
this commit, but fatigue and disgust prevent me from spending time today
trial-and-erroring my way through the hostile and ill-documented
wilderness of scroll-margin so that the link goes where it should.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-11-15 15:45:11 +10:00
Zac Dover
8713cca328 doc/glossary: improve "BlueStore" entry
Initially s/backend/back end/ but then I added a little more information
about BlueStore's use of RocksDB to map object names to block locations
on disk.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-10-31 19:25:40 +10:00
Zac Dover
f3a3f10e9c doc/glossary: add "primary affinity" to glossary
Add "Primary Affinity" to the glossary and link to the information in
the RADOS documentation that (more or less) explains it.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-12 20:56:03 +10:00
Zac Dover
fd9c8c9e2f doc/glossary: link to "ceph clients" from entry
Link to the "Ceph Clients" section of doc/architecture.rst from the
"Ceph Clients" entry in the glossary. A glossary entry should be a short
summary of the topic with which it deals, and it should direct the
reader to further and more detailed reading if the reader is interested.
This does that.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-11 15:18:40 +10:00
Zac Dover
bcee264276 doc/glossary: update bluestore entry
Update the BlueStore entry in the glossary, explaining that as of Reef
BlueStore and only BlueStore (and not FileStore) is the storage backend
for Ceph.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-23 12:07:34 +10:00
Zac Dover
9f37ea651f doc/glossary: add "Placement Groups" definition
Add a definition of "Placement Groups" to the Glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-04-22 16:54:41 +02:00
Nitzan Mordechai
d79f2a8154 docs: warning and remove few docs section for Filestore
Update docs after filestore removal.

Signed-off-by: Nitzan Mordechai <nmordech@redhat.com>
2023-04-20 05:01:53 +00:00
Zac Dover
dc8148d072 doc/glossary: add "Hybrid Storage"
Add "Hybrid Storage" to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-04-16 08:42:04 +02:00
Zac Dover
02e3a5cb76 doc/glossary: improve "CephX" entry
Improve the glossary entry for "CephX".

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-28 18:54:07 +10:00
Zac Dover
4a66819da4 doc/glossary: add "Scrubbing"
Add "Scrubbing" to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-28 08:07:30 +10:00
Zac Dover
fd6bfaf3fe doc/glossary: add "User"
Add "User" to glossary.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-25 06:50:00 +10:00
Zac Dover
495eb97fd7 doc/glossary: Add "zone" to glossary.rst
Add "Zone" to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-27 04:23:34 +10:00
Zac Dover
2dc6f56f26 doc/glossary: add "client" to glossary
Add a definition of "client" to doc/glossary.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-26 05:51:07 +10:00
Zac Dover
235d2e8b67 doc/glossary: add "application" to the glossary
Add an admittedly-stub definition of "application" to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-26 04:50:48 +10:00
Zac Dover
d16ed970e9 doc/glossary: add AWS/OpenStack bucket info
Add links to AWS's documentation of buckets, in accordance with Casey
Bodley's suggestions here:
https://github.com/ceph/ceph/pull/50221#discussion_r1115900879

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-24 11:57:58 +10:00
Zac Dover
ffbc5ea2b9 doc/glossary: add "Bucket"
Add "Bucket" to the glossary. The definition added here is just a first
attempt, but a man's reach must exceed his grasp, or what's a heaven
for?

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-23 15:53:39 +10:00
Zac Dover
bd9bc3adb3 doc/glossary: add "Period" to glossary
Add definition for "period" to glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-18 08:09:39 +10:00
Zac Dover
5e8aed3367 doc/glossary: add "realm" to glossary
Add the term "Realm" to the glossary, and link to the section in the RGW
documentation that provides more information about realms.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-15 17:51:41 +10:00
Zac Dover
6bede3505f doc/glossary: Clean up "Ceph Object Storage"
Remove redundant material under the "Ceph Object Storage" headword and
add a "See 'Ceph Object Store'" link. A future PR will provide a couple
of sentences that explain how object storage is what's really supporting
both CephFS and RBD.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-09 03:43:35 +10:00
Zac Dover
7c70a66414 doc/glossary: capitalize "DAS" correctly
Correctly capitalize "Direct-Attached Storage" in the glossary. (And
test the "Quincy" branch, which seems lately not to have picked up any
docs backports.)

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-31 14:22:26 +10:00
Zac Dover
39377f7db1 doc/glossary: collate "releases" entries
Collect the "Releases"-related entries together under the "Releases"
headword, in order to give readers a sense at a glance of how the
different kinds of releases relate to one another.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-30 11:32:31 +10:00
Zac Dover
40a9f1594c doc/glossary: s/an/each/ where it's needed
s/an/each/ in accordance with the suggestion made by Anthony D'Atri
here: https://github.com/ceph/ceph/pull/49590/files#r1058390357

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-29 14:42:25 +10:00
Zac Dover
e16fe73530 doc/glossary: clean OSD id-related entries
Tidy up the sentences under the headwords "OSD fsid", "OSD id", and "OSD
uuid".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-27 15:28:31 +10:00
Zac Dover
643f430a0f doc/glossary: disambiguate clauses
Disambiguate various clauses, most of which contain forms of the verb
"to require".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-26 16:13:19 +10:00
Zac Dover
28191fddd7 doc/glossary: improve glossary entries
Improve multiple glossary entries.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-26 07:03:50 +10:00
Zac Dover
36a8f27e96 doc/glossary: link to CephX Config ref
Link to the CephX Configuration Reference in the "CephX" entry in the
glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-20 04:16:19 +10:00
Zac Dover
e919941036 doc/glossary: add "FQDN" entry
Add "FQDN" definition to doc/glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-14 16:42:59 +10:00
Zac Dover
a36409d3de doc/glossary - add "secrets"
Add "secrets" to doc/glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-13 14:39:35 +10:00
Zac Dover
acdb2a6ee3 doc/glossary: add matter to "RBD"
Clarify that "RBD" and "Ceph Block Device" and "RADOS Block Device" all
refer to the same thing.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-06 14:15:43 +10:00
Zac Dover
a1f53a0fc0 doc/glossary: add DAS
Add a definition for "DAS" (directly attached storage).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-06 02:07:15 +10:00
Zac Dover
399b68cca8 doc/glossary: add "Dashboard Module"
Define "Dashboard Module" in doc/glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-30 03:26:04 +10:00
Zac Dover
4b6914d13d doc/glossary: add "RADOS Cluster"
Define "RADOS Cluster" in the glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-30 02:59:49 +10:00
Zac Dover
ff6bc1b664 doc/glossary: s/Ceph System/Ceph Cluster/
Remove "Ceph System" and replace it with "Ceph Cluster".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-28 09:45:25 +10:00
Zac Dover
f665c25ede doc/glossary: remove "Ceph System"
"Ceph System" appears only in definitions where "Ceph Cluster" should
be, so I'm removing the headword. A future commit will scrub the
glossary of the phrase "Ceph System".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-26 23:16:18 +10:00
Zac Dover
e469a169a8 doc/glossary: link to "Ceph Manager"
Add link to "Ceph Manager" material.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-26 10:06:34 +10:00
zdover23
73401e5d63
Merge pull request #49025 from zdover23/wip-doc-2022-11-23-glossary-ceph-client
doc/glossary: fix "Ceph Client"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-11-24 01:16:20 +10:00
Zac Dover
0631633667 doc/glossary: add "Ceph Object Store"
Add a definition for "Ceph Object Store".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-23 23:09:47 +10:00
Zac Dover
42ed450f98 doc/glossary: fix "Ceph Client"
Add detail to and clean the syntactics and semantics of "Ceph Client".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-23 18:16:47 +10:00
Zac Dover
0855959503 doc/glossary: s/comprising/consisting of/
s/comprising/consisting of/ - Make the text easier to read for
non-native or weak readers of English.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-23 04:04:48 +10:00
Zac Dover
1fd6be8b6b doc/glossary: define "Ceph Storage Cluster"
Add "Ceph Storage Cluster" to the glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-22 14:25:52 +10:00
zdover23
4df8f2900e
Merge pull request #48989 from zdover23/wip-doc-2022-11-22-glossary-node
doc/glossary: Define "Ceph Node"

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-11-22 04:05:10 +10:00
Zac Dover
75b567d8e5 doc/glossary: add oxford comma to "Cluster Map"
Add an Oxford comma to a list under the "Cluster Map" headword in the
glossary, so that it doesn't read like "I'd like to thank my parents,
Ayn Rand and God."

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-22 02:52:23 +10:00
Zac Dover
24dcf00ac7 doc/glossary: Define "Ceph Node"
Add a definition of "Ceph Node" to the glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-22 02:49:49 +10:00
Zac Dover
ec61f6764f doc/glossary: Add "SDS"
Add "SDS" to the glossary.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-21 04:09:46 +10:00
Zac Dover
a2343c5958 doc/glossary: beef up "Ceph Block Storage"
Beef up the "Ceph Block Storage" entry.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-20 15:05:10 +10:00
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