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>
Tumbleweed is on Octopus nowadays. The kernel version of Tumbleweed is
constantly changing, so leave it blank in the table.
Signed-off-by: Nathan Cutler <ncutler@suse.com>
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.
also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.
Signed-off-by: Kefu Chai <kchai@redhat.com>
Content was moved around in commit c74a261e5b, this
commit updates the name of the file that contains the
kernel recommendations for cephfs users.
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
* refs/pull/33491/head:
mount.ceph: add "fs=<fs_name>" mount options support
Reviewed-by: Jeff Layton <jlayton@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
"client_fs" is one alias for "client_mds_namespace=" and it will be
cleaner and be more user-friendly to use. "client_mds_namespace="
will be kept and backwards compatibility used.
Update the documents at the same time.
Fixes: https://tracker.ceph.com/issues/44212
Signed-off-by: Xiubo Li <xiubli@redhat.com>
"fs" is one alias for "mds_namespace=" and it will be cleaner and
be more user-friendly to use. The "fs" will be translated to
"mds_namespace" before sending it to kernel space.
And the "mds_namespace" will be deprecated to use any more.
Update the documents at the same time.
Fixes: https://tracker.ceph.com/issues/44214
Signed-off-by: Xiubo Li <xiubli@redhat.com>
This PR removes the now-very-old (2012) production cluster
examples from the hardware recommendations page.
Sage requested this change in IRC on 14 Jan 2020. There is no issue link.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This small change adds "mds map" to a list of things that the
Ceph monitor keeps track of, and this PR satisfies the issue here:
Fixes: https://tracker.ceph.com/issues/14251
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit removes the material in the documentation
pertaining to the use of "kube-helm". The "kube-helm"
installation page has been deleted, and its entry in
the side-pane menu removed.
This commit fixes Bug number 3 in the list here:
https://pad.ceph.com/p/Report_Documentation_Bugs
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit updates the "Install NTP" section of the preflight
checklist, instructing readers who are using Ubuntu 18.04 to
use the package name "chrony" where elsewhere the package name
"ntp" would be used. "chrony" has replaced "ntp" in Ubnutu 18.04.
This commit fixes Bug number 8 in the list here:
https://pad.ceph.com/p/Report_Documentation_Bugs
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit updates the "Create a Cluster" section of the
"Storage Cluster Quick Start" document. Ubuntu 18.04 does
not have Python 2 installed by default. This commit instructs
users of Python 18.04 to install the package "python-minimal"
to provide Python 2 prior to running "ceph-deploy".
This commit fixes Bug number 9 in the list here:
https://pad.ceph.com/p/Report_Documentation_Bugs
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* Hard Disk Drive: Replaced word 'accelerate' with 'optimize'
* Networks: Replaced word 'have' with 'has'
Fixes: https://tracker.ceph.com/issues/42379
Signed-off-by: Amrita Sakthivel <asakthiv@redhat.com>
Also, skip the details about CephX user's keyring and monitor's socket
since the kernel driver can figure out these details automatically now.
Fixes: https://tracker.ceph.com/issues/41872
Signed-off-by: Rishabh Dave <ridave@redhat.com>
* refs/pull/28643/head:
doc: removed old EOL Ceph versions from the list
doc: added openSUSE distros to the list and updated the releases
doc: updated the OS recommendations to reflect the Nautilus release
Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
now that Ceph uses async messenger, setting kernel.pid_max = 4194303 should not be necessary anymore. Even if kernel thread limit is 32K and we have 100 drives, that's 320 threads per OSD, I think that should be enough.
Signed-off-by: Ben England <bengland@redhat.com>
Added note about the requirement for the latest ceph-iscsi version
3 to the dashboard documentation. Added some doc references
and replaced some URLs in the iSCSI docs with reST labels instead.
Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
The documentation currently refers to Ceph Manager Modules as
"plugins" in many places, while the command line interface uses
"module" to enable/disable modules. Replaced all occurences
of "plugin" with "module" in the docs, to avoid confusion and to
be in alignment with the CLI. Also fixed the capitalizations of some
module chapters.
Fixes: https://tracker.ceph.com/issues/38481
Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
``ceph-deploy osd create --data {device} {ceph-node}`` command
is not displayed properly because of missing double colons.
Signed-off-by: Alexey Stupnikov <aleksey.stupnikov@gmail.com>
unless creating the default pool named to be "rbd",
it will fail without pointing the pool name when
using rbd command.
Signed-off-by: Changcheng Liu <changcheng.liu@intel.com>
The rbd-mirror daemon will require permission to read config-keys
from the "rbd/mirror/" prefix. These new profiles (and the new
associated bootstrap-rbd-mirror user) provide the required
permissions.
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
This commit also fixes some incorrect indentation that was causing
previous steps in the same section to be incorrectly numbered.
Signed-off-by: David Wahler <dwahler@gmail.com>
Also drop all release-specific upgrading instructions (they only go up to
Firefly, anyway - none of the current releases are covered).
Note that all of this verbiage I am removing here can still be accessed
on docs.ceph.com via e.g. http://docs.ceph.com/docs/firefly/
Signed-off-by: Nathan Cutler <ncutler@suse.com>
Drop 4.4 -- even though it is an "Extended LTS" release, it predates
the OSD client rewrite and should no longer be recommended.
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
