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>
This PR removes mentions of journaling from the hardware
recommendations.
Journaling was a FileStore-related practice. BlueStore is
the default backend for Ceph OSDs and has been since
Luminous. The documentation should reflect that.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR updates the content on documenting-ceph,
which is, as of December 2021, in need of an
update.
This is the first of what I estimate to be three
to five PRs against this .rst file.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Advise operators on how to benchmark devices for BlueStore, and how to
tune the volatile write cache for optimal OSD performance.
Fixes: https://tracker.ceph.com/issues/53161
Signed-off-by: Dan van der Ster <daniel.vanderster@cern.ch>
This updates the package "python-pip" to "python3-pip"
in the instructions for Ubuntu/Debian distributions.
I have just attempted to install the dependencies necessary
before building the source, and I discovered that the package
that provides this has changed.
I tested this on 18 Nov 2021.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
so we don't need to use virtualenv python package for creating a
virtualenv, the "venv" module in Python3 would suffice.
see also https://docs.python.org/3/library/venv.html
Signed-off-by: Kefu Chai <kchai@redhat.com>
use https instead of http, the latter cannot be redirected to the valid
docs. also, we don't have "next" branch, so remove the document
mentioning it.
Signed-off-by: Kefu Chai <kchai@redhat.com>
instead of inlining the layout related settings, move them to a single
place. and do the layout using the flex box instead using tables.
Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit adds the ".. prompt:: bash $" directive
to the commands in "documenting-ceph.rst" so that
the permissions level of each command is evident
(through the presentation of the $ or the #), and
so that when the reader cuts and pastes the commands
from the documentation, they don't have to delete
the prompt (because that's how this directive
renders).
This commit also instructs the reader to add the
directory containing "build-doc" and
"serve-doc" to the PATH environment variable
in order to run the commands.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Co-authored-by: Kefu Chai <tchaikov@gmail.com>
The documentation still has many traces of ceph-deploy. This tool has
been deprecated with the Octopus release. This commit tries to remove
most of ceph-deploy occurences.
Signed-off-by: Robert Sander <r.sander@heinlein-support.de>
