Commit Graph

381 Commits

Author SHA1 Message Date
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
Kefu Chai
080d5506ad
Merge pull request #31947 from zdover23/wip-doc-ubuntu-1804-python-minimal
doc: add Python 2 to Ubuntu 18.04 installations

Reviewed-by: Kefu Chai <kchai@redhat.com>
2019-12-03 12:07:42 +08:00
Zac Dover
5c5f312a5b doc: add Python 2 to Ubuntu 18.04 installations
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>
2019-12-03 02:21:27 +10:00
hrchu
aa01cd50f7 doc: Update mailing lists
Signed-off-by: hrchu <petertc.chu@gmail.com>
2019-11-15 15:26:56 +08:00
Zac Dover
cfaf5a4efa doc: Added a link to Ceph Community Calendar.
Co-Authored by: Neha Ojha <nojha@redhat.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2019-11-12 11:51:44 +10:00
Amrita42
1579e15ff7 doc/start/hardware-recommendations.rst: minor tweaks
* 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>
2019-10-22 17:07:49 +08:00
Rishabh Dave
26a18fca80 doc: move MDS deployment from main quick start to CephFS quick start
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2019-09-25 13:03:09 +05:30
Rishabh Dave
cd3e0acb8d doc: update CephFS Quick Start doc
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>
2019-09-25 13:02:23 +05:30
Sage Weil
7b988e9fe1 doc: remove all pg_num arguments to 'osd pool create'
Also, update the dicussion about pg_num and pool creation, with a reference
to the autoscaler.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-09-22 16:58:33 -05:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
Neha Ojha
07aef79693 doc/start/documenting-ceph.rst: make better doc recommendations
I do not think "Editors" is relevant anymore.

Signed-off-by: Neha Ojha <nojha@redhat.com>
2019-09-09 15:40:45 -07:00
Patrick Donnelly
6ebd517eab
Merge PR #28643 into master
* 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>
2019-07-11 15:05:41 -07:00
Sage Weil
8189007378 Merge PR #27965 into master
* refs/pull/27965/head:
	doc: remove recommendation for kernel.pid_max

Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Sage Weil <sage@redhat.com>
2019-07-09 11:19:12 -05:00
Kai Wagner
26b9e1b8e6 doc: removed old EOL Ceph versions from the list
Signed-off-by: Kai Wagner <kwagner@suse.com>
2019-06-19 23:58:07 +02:00
Kai Wagner
13fe90a829 doc: updated the OS recommendations to reflect the Nautilus release
Signed-off-by: Kai Wagner <kwagner@suse.com>
2019-06-19 23:58:07 +02:00
Kefu Chai
ee11e9b60b
Merge pull request #23312 from sylvia0409/master
doc: Fixes OSD node labels which based on the osd_devices name

Reviewed-by: Kefu Chai <kchai@redhat.com>
2019-06-09 21:26:38 +08:00
Ben England
c23369975d doc: remove recommendation for kernel.pid_max
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>
2019-05-06 19:39:42 +08:00
Lenz Grimmer
71e46887d4 doc: Updated dashboard iSCSI configuration, added labels
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>
2019-03-31 13:32:15 -05:00
Lenz Grimmer
c3149421bc doc: Replaced "plugin" with "module" in the Mgr documentation
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>
2019-02-27 13:49:47 +01:00
Sage Weil
b4e292ca9a doc/start/ceph.conf: trim the sample ceph.conf file
Signed-off-by: Sage Weil <sage@redhat.com>
2019-01-03 11:17:31 -06:00
Alexey Stupnikov
bff5a2122f doc: put command template into literal block
``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>
2018-11-09 10:48:40 +01:00
Liu Changcheng
be0ab24188 doc: give pool name if default pool rbd is not created
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>
2018-10-25 21:33:12 +08:00