Update "Quincy" to "Reef" and "Pacific" to "Quincy" in the section
"Viewing Old Ceph Documentation" in /doc/start/documenting-ceph.rst.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Explain the initialism "OSD" and link to its definition in the glossary.
This PR is raised in response to an anonymous documentation bug that reads
"Paragraph 2 uses the acronym OSD without any explanation.
This makes it very difficult to understand this part of
the documentation as there is no indication of what this
acronym is until much further into the documentation. Replace
first occurence of OSD with Object Storage Daemon (OSD) or
link it to the glossary."
-- https://pad.ceph.com/p/Report_Documentation_Bugs
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Improve the grammar in one sentence of the "Platforms" section of
doc/start/os-recommendations.rst. Improving that grammar involved
splitting the sentence into two sentences, but that's life. Update:
Anthony substantially rewrote this, so credit for this should rightly
go to him.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Refactor the ABC test chart so that the information about which tests
have been run is presented in the center of the chart instead of, as it
was before, in a superscript.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Update the table that reports which versions of which Linux releases
have been used in tests of Ceph.
Fixes: https://tracker.ceph.com/issues/62354
Signed-off-by: Zac Dover <zac.dover@proton.me>
Update linking conventions in doc/start/documenting-ceph.rst, as
requested in
https://github.com/ceph/ceph/pull/49889#issuecomment-1657750905 by
bluikko. This commit introduces a convention that could be read as
inconsistent with other conventions mentioned on the page altered by
this commit. Future PRs will attenuate this inconsistency.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add KRBD feature flag support note to doc/start/os-recommendations.rst.
This change was suggested by Anthony D'Atri in https://github.com/ceph/ceph/pull/51485.
Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
The 4.14 LTS kernel has less than a year left in terms of maintenance,
drop it.
Also, the current wording with an explicit list of kernels tends to go
stale: it's missing the latest 6.1 LTS kernel.
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
Rewrite the first paragraph in doc/start/intro.rst.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Edit the first 150 lines of doc/start/documenting-ceph.rst. This is part
of an initiative to harvest the fruits of Cephalocon 2023, at which
documentation proved to be in demand to a surprising degree.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add a link to the landing page of docs.ceph.com to direct documentation
contributors to documentation-related information.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Rewrite the "Notify Us" section in doc/start/documenting-ceph.rst so
that it is written in English sentences.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add a procedure to doc/start/documenting-ceph.rst that explains how to
perform an interactive rebase to squash commits.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Add two kinds of link-related metadocumentation (documentation about how
to write documentation) to the "Documenting Ceph" section of the "Intro
to Ceph" document: 1. metadocumentation about external links, and 2.
metadocumentation about internal links.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Improve the grammar and the pragmatics of the "TOC and Hyperlinks"
section of start/documenting-ceph.rst.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR updates the branch names in the
documenting-ceph.rst file. It gets rid of all references
to the "master" branch, and updates the language to
reflect the state of play in 2022.
inb4: This PR merely removes the most egregious inaccuracies,
the ones that were most readily evident on a cursory perusal.
The full text remains to be carefully read and fitted together
with care.
I had to start somewhere.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR picks up the parts of
https://github.com/ceph/ceph/pull/44466
that were not merged back in January, when that
pull request was raised.
Matters added here:
* improved organzation of matter
* emphasis of IOPs per core over cores per OSD
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Harmonize network throughput notation, minor tweaks to wording.
Followup to #46637
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
This rewrites the first two-thirds of the "Networks"
section of the Hardware Recommendations page in the
Intro to Ceph document. I have tried to divide the
techincal content in this section into subsections
that foreground the various subjects covered.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR makes the "Ceph OSDs" and "MDSs" bullet points
parallel by naming "object storage daemon" before referring
to the (admittedly more common and colloquial, but surely
unknown to people who genuinely require a document called
'Intro') acronym "OSD".
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR supersedes https://github.com/ceph/ceph/pull/46584
and makes changes suggested by Anthony D'Atri that improve
the coherence and consistency of the paragraph that explains
the basics of the CRUSH algorithm.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR corrects some usage errors in the "Memory" section
of the hardware-recommendations.rst file. It also closes
some opened but never closed parentheses.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
I'm changing "3" to "three" for two reasons:
1. It's correct.
2. This allows me to test backports into Octopus, Pacific, and Quincy.
I am particularly interested to see what happens when I attempt
the backport into Octopus, because backports into Octopus have
failed. This will provide me with another unit of data.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR removes tables that contained outdated
information about Ceph's supported operating
systems. Ernesto Puerta had the idea to consolidate
the information that was in those tables into a single
table, and we're doing that.
Part of that process involves removing the old tables.
That's what this PR does.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR alphabetizes the internal and external
references at the bottom of the Restructured
Text.
(This is really just a PR made so that I can
show how to make a documentation pull request.)
(In a video.)
(For people who prefer step-by-step instructions
in video form.)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR restores material about partition alignment
and material about separating OS and OSD data that
was removed in an earlier rewrite. The restoration
of this information was requested by Anthony D'Atri in
https://github.com/ceph/ceph/pull/45123/
This PR also includes several refinements to the language
that could not be made to this text until now, owing to my
(Zac's) ignorance and illiteracy.
I call upon Mark Nelson (and anyone else with sufficient
command of the current state of storage technology) to advise
me on whether the Ceph Foundation feels comfortable in the year
2022 referring to QLC as an emerging technology.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
(squash) more notes and revisions
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR removes the tables for Luminous and Nautilus,
in order to keep the documentation as current as possible.
This is one a series of PRs intended to update the OS
Recommendations page. The scope of this PR is confined to
the removal of these two tables. Other PRs will update the
information elsewhere on the OS Recommendations page.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
