Commit Graph

402 Commits

Author SHA1 Message Date
Neha Ojha
c2a3676b29
Merge pull request #44003 from zdover23/wip-doc-2021-11-17-start-documenting-ceph-python-pip-update
doc/start: update python-pip to python3-pip

Reviewed-by: Kefu Chai <tchaikov@gmail.com>
2022-02-03 15:36:22 -08:00
Sebastian Schmid
4842140311 docs/start: fixes typo and empty headline in hardware recommendation docs
Signed-off-by: Sebastian Schmid <mail@sebastian-schmid.de>
2022-01-04 17:15:51 +01:00
Dimitri Papadopoulos
7677651618
doc,man: typos found by codespell
Signed-off-by: Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
2021-12-15 12:04:36 +01:00
Zac Dover
276bbd8f2b doc/start: remove journal info from hardware recs
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>
2021-12-09 01:20:57 +10:00
zdover23
9e8bc32cdd
Merge pull request #44189 from zdover23/wip-doc-2021-12-02-documenting-ceph
doc/start: update documenting-ceph.rst (1 of x)

Reviewed-by: Laura Flores <lflores@redhat.com>
2021-12-04 15:53:42 +10:00
Zac Dover
63e5d0f545 doc/start: update documenting-ceph.rst (1 of x)
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>
2021-12-04 02:20:03 +10:00
Dan van der Ster
27fa51234a doc: add disk benchmarking and cache recommendations
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>
2021-12-02 10:44:26 +01:00
Zac Dover
3e6d21deb8 doc/start: update python-pip to python3-pip
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>
2021-11-19 01:27:39 +10:00
Jos Collin
722f95e7ff
doc: update dev list and kernel client
Signed-off-by: Jos Collin <jcollin@redhat.com>
2021-11-09 16:38:12 +05:30
Jos Collin
5bec0dd750
doc: update #cephfs channel
Signed-off-by: Jos Collin <jcollin@redhat.com>
2021-11-09 16:38:12 +05:30
Sebastian Wagner
a6254beff6
doc/start: documenting-ceph: Remove email to ceph-docs@redhat.com
Instead get in touch with the component lead.

Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-10-20 14:18:20 +02:00
Sebastian Wagner
260ed919fc
doc/start: documenting-ceph: Improve template of commits
by properly linking the corresponding tracker issue.

Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-10-20 14:18:20 +02:00
Zac Dover
14151f2abe docs/start: fix min. hardware rec. typo
The minimum hardware recommendations said that we
recommended a minimum of "24GB+ per daemon".

I changed this to read "2-4GB+ per daemon".

Reddit actually caught this one:
https://www.reddit.com/r/ceph/comments/q14ey2/cephs_mon_minimum_requirements/

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-10-05 02:57:51 +10:00
Kefu Chai
90c4995c99 admin/build-doc: s/virtualenv/python3 -m venv/
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>
2021-07-31 22:34:05 +08:00
Bobby Alex Philip
0a87c47d4d doc/start/hardware-recommendations.rst: Corrected typo
129GB - >128GB
Signed-off-by: Bobby Philip bobbyphilip@gmail.com
2021-06-15 22:53:27 +02:00
Casey Bodley
a335304042 rgw: remove the fcgi frontend
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2021-05-17 15:00:33 -04:00
Kefu Chai
27bcb291ee doc/start: fix the link pointing to ceph doc
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>
2021-03-10 12:28:28 +08:00
Kefu Chai
bb17a4fc1d
Merge pull request #39564 from tchaikov/wip-doc-layout
doc: consolidate the layout settings using CSS

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-02-24 11:36:14 +08:00
Kefu Chai
702f376601 doc: consolidate the layout settings using CSS
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>
2021-02-19 11:29:39 +08:00
Sebastian Wagner
318cb12e08 doc/rados/operations: Remove upstart
Followup on 2c755cef69

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-15 13:13:36 +01:00
Zac Dover
2b90e77802 doc/start: update prompts in documenting-ceph.rst
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>
2020-11-17 00:13:05 +10:00
Anthony D'Atri
32375cb789 doc: misc clarity and capitalization
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-12 13:41:46 -07:00
Robert Sander
1b42759e19 doc: remove references to ceph-deploy
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>
2020-09-02 21:14:36 +02:00
Kefu Chai
ca1cca0abc doc: fix broken hyper link
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08:00
Kefu Chai
84e2808afb doc: fix broken hyper link
this link was broken in 1427905c47

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08:00
Nathan Cutler
d4b9203519 doc/start/os-recommendations: current state of openSUSE
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>
2020-06-30 16:03:22 +02:00
Kefu Chai
4eb64d38a6
Merge pull request #34251 from JackSlateur/doc-os-recommendations
doc/start/os-recommendations.rst: add Octopus' platform

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-04-29 17:43:39 +08:00
Alexandre Bruyelles
443c12070c
doc/start/os-recommendations.rst: add opensuse, comment centos7
Signed-off-by: Alexandre Bruyelles <jack@jack.fr.eu.org>
2020-04-29 11:12:20 +02:00
Kefu Chai
8b8bd736dd
Merge pull request #34360 from gouthampacha/doc-fix
doc: fix broken link for cephfs kernel recommendations

Reviewed-by: Rishabh Dave <ridave@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-04-15 07:43:54 +08:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
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>
2020-04-10 08:38:06 +08:00
Goutham Pacha Ravi
ddb60ed587 doc: link to the specific section in the cephfs doc
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-04-05 18:59:03 -07:00
Alexandre Bruyelles
7f1f07a8e0
doc/start/os-recommendations.rst: add Octopus' platform
Signed-off-by: Alexandre Bruyelles <jack@jack.fr.eu.org>
2020-04-03 17:46:24 +02:00
Goutham Pacha Ravi
8221a73503 doc: Fix link text for kernel recommendations with cephfs
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-04-02 15:32:57 -07:00
Goutham Pacha Ravi
e3d7916ba2 doc: fix broken link for cephfs kernel recommendations
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>
2020-04-01 17:16:58 -07:00
Alexandre Bruyelles
ed8cc0ca7f
doc/start/os-recommendations.rst: recommend bluestore
Signed-off-by: Alexandre Bruyelles <jack@jack.fr.eu.org>
2020-03-27 22:00:16 +01:00
Mark Nelson
3305a07324 doc/start: Update hardware recommendations.
Signed-off-by: Mark Nelson <mnelson@redhat.com>
2020-03-26 15:07:50 -05:00
Sebastian Wagner
d231eb90ce doc: Move ceph-deploy docs to doc/install/ceph-deploy
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-03-13 15:52:41 +01:00
Sage Weil
8251598d81 Merge PR #33890 into octopus
* refs/pull/33890/head:
	doc/install: rethink docs install page (similar to PR#33613)
	doc/install: Rethink doc/install

Reviewed-by: Sebastian Wagner <swagner@suse.com>
2020-03-12 10:40:43 -05:00
Patrick Donnelly
4e90fbbcdf
Merge PR #33491 into master
* 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>
2020-03-02 16:59:51 -08:00
Sebastian Wagner
ba5cefa5fb doc/install: Rethink doc/install
What about having a list of the various installation possibilities?

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-02-28 14:19:40 +01:00
Xiubo Li
1a58e64299 client: add client_fs mount option support
"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>
2020-02-27 19:30:31 -05:00
Xiubo Li
7367382ef2 mount.ceph: add "fs=<fs_name>" mount options support
"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>
2020-02-25 21:37:56 -05:00
Tim
3f367ce718 doc: quick-rbd.rst de-duplicate
Remove code duplication from the dependency.

Signed-off-by: Tim <elatllat@gmail.com>
2020-02-10 10:44:14 -05:00
Patrick Donnelly
f2796b75f3
Merge PR #32631 into master
* refs/pull/32631/head:
	doc: add mds map to list of monitor assets

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-01-20 17:40:05 -08:00
Zac Dover
dc46a8e90a doc: remove prod cluster examples from hardware recs
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>
2020-01-16 13:14:50 +10:00
Zac Dover
3500db53e8 doc: add mds map to list of monitor assets
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>
2020-01-14 22:51:57 +10:00
Clément Hampaï
df88b072cb Added fresh Centos install's python dependencies
Fixes: https://tracker.ceph.com/issues/43545

Signed-off-by: Clément Hampaï <clement.hampai@cypressxt.net>
2020-01-10 14:26:21 +01:00
Sage Weil
64b69572b5 Merge PR #32009 into master
* refs/pull/32009/head:
	doc: removes kube-helm installation instructions

Reviewed-by: Sebastian Wagner <swagner@suse.com>
2019-12-09 08:23:44 -06:00
Zac Dover
01fc9bd33a doc: removes kube-helm installation instructions
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>
2019-12-05 02:55:41 +10:00
Zac Dover
c0e09de50b doc: add "chrony" to preflight checklist for Ubuntu 18.04
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>
2019-12-05 00:07:24 +10:00