Commit Graph

119 Commits

Author SHA1 Message Date
Zac Dover
a1cec3de57 doc/glossary.rst: add "Dashboard Plugin"
Add an entry below the (Mimic-era and therefore outdated but
nonetheless historically important) Dashboard Plugin key word in the
glosssary, which before now had never been added to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-12-01 08:24:31 +01:00
Zac Dover
e595f353b5 doc/glossary: add "DC" (Data Center) to glossary
Add the initialism "DC" (Data Center) to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-11-28 10:23:24 +10:00
Zac Dover
599bdbf0a2 doc/glossary: add "PLP" to glossary
Add "PLP" to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-10-23 18:38:00 +10:00
Zac Dover
43057b8853 doc/glossary: add "object storage"
Add a (very basic) definition of object storage.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-23 22:36:16 +10:00
Zac Dover
1ca89e6ca3 doc/glossary: add "flapping OSD"
Add an entry for "Flapping OSD" to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-15 04:08:14 +10:00
Zac Dover
484e9d2b9d doc/glossary: add "ceph-ansible"
Add a "ceph-ansible" entry to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-03 15:31:32 +10:00
Zac Dover
1a76464999 doc/glossary: add "Prometheus"
Add a glossary entry for "Prometheus".

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-31 11:39:56 +10:00
Zac Dover
d1c049d24b doc/glossary: add "ceph-fuse" entry
Add a "ceph-fuse" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-30 01:51:35 +10:00
Zac Dover
be6d0645c4 doc/glossary: Add "S3"
Add "S3" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-12 09:11:35 +10:00
Zac Dover
b2d413ee9d doc/glossary.rst: add "OpenStack Swift" and "Swift"
Add "OpenStack Swift" and "Swift" entries to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-09 11:22:39 +10:00
Zac Dover
2a93a8e837 doc/glossary: add "librados" entry
Add a "librados" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-14 16:29:09 +10:00
Zac Dover
2223c89853 doc/glossary: improve "Crimson" entry
Improve the glossary entry for "Crimson" in accordance with Anthony
D'Atri's suggestions here:
https://github.com/ceph/ceph/pull/56068#discussion_r1518580402

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-10 20:43:52 +10:00
Zac Dover
b31e061cc0 doc/glossary: add "Crimson" entry
Add a "Crimson" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-09 14:34:06 +10:00
Zac Dover
2c6983d8b4 doc/glossary: improve "MDS" entry
Improve the entry for "MDS" in doc/glossary.rst by linking to the
"ceph-mds" man page and mentioning the relationship between clients and
MDS (or MDSes).

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-01 08:08:25 +10:00
Zac Dover
1d8baa1d4c doc/glossary: Add "OMAP" to glossary
Add an entry for "OMAP" to the glossary. This commit represents only the
first improvement to the documentation of OMAP in the Ceph docs suite.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-26 07:27:52 +10:00
Zac Dover
dec3d37307 doc/glossary: improve OSD definitions
Remove expletive construction from three OSD-id-related terms.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-15 13:10:41 +10:00
Ronen Friedman
f5a8b9be8b
Merge pull request #55533 from ronen-fr/wip-rf-sdocs-1
doc/osd: documentation changes related to scrub

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Samuel Just <sjust@redhat.com>
Reviewed-by: Zac Dover <zac.dover@proton.me>
2024-02-14 18:31:28 +02:00
Zac Dover
aa1e6352d0 doc/glossary: Add link to CRUSH paper
Add a link in the CRUSH definition to the original CRUSH paper.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-13 01:06:05 +10:00
Ronen Friedman
5ad6f16562 doc/osd: update the documentation of several scrub-related options
Signed-off-by: Ronen Friedman <rfriedma@redhat.com>
2024-02-11 21:30:05 +02:00
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