Commit Graph

97 Commits

Author SHA1 Message Date
Ken Dreyer
05d5fda821 doc/cephfs: simplify ceph fs volume create command
Make it easy for new users to choose a sensible default "cephfs"
filesystem name.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2022-12-15 10:05:04 -05:00
Patrick Donnelly
4b1e101571
Merge PR #42295 into master
* refs/pull/42295/head:
	doc/cephfs: recover file system after recovering

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-07-21 13:13:43 -07:00
Ramana Raja
ffe5cfb687 doc/cephfs: recover file system after recovering
... monitor stores using OSDs. The steps are valid only to recover
single active MDS file systems.

Partially-fixes: https://tracker.ceph.com/issues/51341
Signed-off-by: Ramana Raja <rraja@redhat.com>
2021-07-16 17:20:35 -04:00
Varsha Rao
ce7fef695b doc/mgr/nfs: update nfs links
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Kefu Chai
1c04ce6f3a doc/man: build and install cephfs-shell manpage
otherwise the manpage of cephfs-shell is not built and installed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-05 14:41:50 +08:00
Patrick Donnelly
52faaf848e
Revert "Merge PR #41134 into master"
This reverts commit 93bca2d0e9, reversing
changes made to 7e70b15c43.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-05-04 14:46:47 -07:00
Kefu Chai
5191008aa4 doc/man: build and install cephfs-shell manpage
otherwise the manpage of cephfs-shell is not built and installed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-04 15:11:22 +08:00
Venky Shankar
c22d239fcc doc: document CephFS Snapshot Mirroring
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-01 19:09:09 +05:30
Jan Fajerski
96556f1fbc doc: snap-schedule documentation
Fixes: https://tracker.ceph.com/issues/48017

Signed-off-by: Jan Fajerski <jfajerski@suse.com>
2021-03-10 18:24:03 +01:00
Lucian Petrut
eaa415f169 doc: add ceph-dokan documentation
This change documents ceph-dokan, describing the prerequisites,
usage and limitations.

Some of this was mentioned in README.windows.rst but is now being
moved to the Ceph doc pages.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-03-05 13:15:45 +00:00
Venky Shankar
c513422ec5 doc: document cephfs-top utility
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-01-11 06:15:53 -05:00
Patrick Donnelly
0376ce721a
doc: add documentation for new multifs feature
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2020-12-15 06:46:49 -08:00
Patrick Donnelly
cb9b2e5815
doc: document MDS cache configuration
Fixes: https://tracker.ceph.com/issues/48010
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2020-10-28 13:26:14 -07:00
Varsha Rao
48c8e8b546 doc: Add document about fs nfs interface to create CephFS exports
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-04-08 17:21:09 +05:30
Kefu Chai
7357fde070 doc/cephfs: add python binding doc
and restructure cephfs/api to move the javadoc for cephfs to this
directory

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-03-12 18:46:48 +08:00
Sebastian Wagner
59d54f3df1 doc: rename orchestrator_cli -> orchestrator
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-02-17 10:24:01 +01:00
Gregory Farnum
548fc13549 doc: remove the CephFS-Hadoop instructions
These have not aged gracefully, and in particular include instructions
for setting pool size 1 to let Hadoop control the replication — but I've
heard reports of users setting up multiple size-1 pools and then wondering
where their data went when an OSD dies.

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2020-01-30 03:14:45 -08:00
Rishabh Dave
07cd0e7d31 doc/cephfs: improve wording in mount-prerequisites.rst
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-21 14:44:02 +05:30
Rishabh Dave
7067776658 doc: migrate best practices recommendations to relevant docs
Also, move the common part from "Mount using FUSE" doc and "Mount using
kernel" doc to "Mount CephFS" page to avoid repetitions.

Fixes: https://tracker.ceph.com/issues/43154
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-21 14:42:18 +05:30
Rishabh Dave
f6ea1ca36f doc/cephfs: rename doc/cephfs/kernel.rst & doc/cephfs/fuse.rst
Rename to mount-using-kernel.rst and mount-using-fuse.rst respectively
so that it's easier to find them in doc/cephfs directory.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-20 10:32:06 +05:30
Jos Collin
9f4a20e653
doc: fix Getting Started with CephFS
Signed-off-by: Jos Collin <jcollin@redhat.com>
2020-01-02 12:04:50 +05:30
Patrick Donnelly
7141cf6db9
doc: reorganize CephFS landing page and ToC
Fixes: https://tracker.ceph.com/issues/42016
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-12-06 12:15:52 -08:00
Rishabh Dave
ab9185187d doc/cephfs: merge fstab doc with respective mount docs
Fixes: https://tracker.ceph.com/issues/42601
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2019-11-14 10:02:01 +05:30
Rishabh Dave
03d8fdbb49 doc: update and improve "mount using kernel driver" doc
Move the examples of mount command for Ceph cluster with CephX enabled
to the top of page, since it is enabled by default, improve explanation
around Ceph with multiple FSs, get rid of hash symbols before every
command (without them it's clear that the text is command and with them
the reader cannot use the commands directly), link fstab page, add how
mount in general looks, add prerequisites required for kernel mounts and
expand explanation wherever possible.

Fixes: https://tracker.ceph.com/issues/42220
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2019-11-13 11:10:47 +05:30
Rishabh Dave
cd34b96e4d doc: update and improve "mount using FUSE" doc
Recommend keyring permission to be 600 instead of 644, show examples
for `-k`, `-r`, `-m` and `--client_mds_namespace` options, move
references to the bottom of the page,  show how to unmount FUSE-mounted
CephFS, copy the tip about unmounting from "mount using kernel" page to
"mount using FUSE" page, correct commands for automating FUSE mounts,
add sub-headings to the document and add how ceph-fuse command looks in
general.

Fixes: https://tracker.ceph.com/issues/42205
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2019-11-13 11:10:41 +05:30
Yan, Zheng
2328698995 doc/cephfs: add doc for cephfs io path
Fixes: https://tracker.ceph.com/issues/41738
Signed-off-by: "Yan, Zheng" <zyan@redhat.com>
2019-10-23 16:01:07 +08:00
Varsha Rao
1b5ce8e779 doc: Update requirements for using CephFS
Fixes: https://tracker.ceph.com/issues/41470
Signed-off-by: Varsha Rao <varao@redhat.com>
2019-10-03 13:12:32 +05:30
Patrick Donnelly
4154eae83a
Merge PR #30542 into master
* refs/pull/30542/head:
	doc: cleanup CephFS Landing Page

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2019-10-02 04:09:22 -07:00
Milind Changire
a86b7bff58 doc: cleanup CephFS Landing Page
Fixes: https://tracker.ceph.com/issues/41952
Signed-off-by: Milind Changire <mchangir@redhat.com>
2019-10-01 12:41:32 +05:30
Venky Shankar
0a5032138b doc: document mds journaling
Fixes: http://tracker.ceph.com/issues/41783
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2019-09-27 12:51:30 +05:30
Sidharth Anupkrishnan
05bdceb1f7 doc: Add a new document on Dynamic Metadata Management in CephFS
Signed-off-by: Sidharth Anupkrishnan <sanupkri@redhat.com>
2019-09-23 19:57:26 +05:30
Ramana Raja
aebf75c9df doc: add ceph fs volumes and subvolumes documentation
Fixes: https://tracker.ceph.com/issues/40689
Signed-off-by: Ramana Raja <rraja@redhat.com>
2019-09-17 15:56:47 +05:30
Patrick Donnelly
b50295e3ef
Merge PR #30265 into master
* refs/pull/30265/head:
	doc: add a new document on CephFS distributed metadata cache

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-16 11:36:10 -07:00
Jeff Layton
29bb00c8e8 doc: add a new document on CephFS distributed metadata cache
Fixes: https://tracker.ceph.com/issues/41451
Signed-off-by: Jeff Layton <jlayton@redhat.com>
2019-09-16 14:35:07 -04:00
Patrick Donnelly
d2f705a2f2
doc: update CephFS overview in introductory page
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 09:37:41 -07: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
Jos Collin
9db12b5fe8
doc: Update mount CephFS index
Updated based on the discussion:
https://github.com/ceph/ceph/pull/28900#discussion_r301812933

Signed-off-by: Jos Collin <jcollin@redhat.com>
2019-07-25 07:09:26 +05:30
Patrick Donnelly
a256c42d47
doc/cephfs: improve add/remove MDS section
Include hardware details and update language for modern tools.

Fixes: http://tracker.ceph.com/issues/39620
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-07-12 17:11:12 -07:00
Yan, Zheng
8ebd0fb74a doc: add doc for cephfs lazyio
Fixes: http://tracker.ceph.com/issues/38729
Signed-off-by: "Yan, Zheng" <zyan@redhat.com>
2019-03-27 10:29:07 +08:00
Venky Shankar
a83c0f8953 doc: add cephfs scrub related admin document
Fixes: http://tracker.ceph.com/issues/38728
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2019-03-15 15:05:27 +05:30
Patrick Donnelly
e78115ef3b
Merge PR #23728 into master
* refs/pull/23728/head:
	doc: suppored features of kernel client

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2018-09-11 10:44:04 -07:00
Yan, Zheng
f7ace59e53 doc: suppored features of kernel client
Fixes: http://tracker.ceph.com/issues/27209
Signed-off-by: "Yan, Zheng" <zyan@redhat.com>
2018-09-11 21:40:20 +08:00
John Spray
8279d8713e doc/cephfs: add notes on application best practices
Signed-off-by: John Spray <john.spray@redhat.com>
2018-09-10 15:53:42 +01:00
Patrick Donnelly
05eac20821
doc: add cephfs-shell to cephfs doc index
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2018-08-03 09:20:45 -07:00
Patrick Donnelly
6962b4eb9b
doc: create mds state documentation
Fixes: http://tracker.ceph.com/issues/22989

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2018-07-24 13:17:21 -07:00
Patrick Donnelly
c05a7473d0
Merge PR #22784 into master
* refs/pull/22784/head:
	doc: fix Ceph FS
	doc: new label and glossary url
	doc: drop linking to itself

Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2018-07-10 14:23:53 -07:00
John Spray
82f9960162 doc/cephfs: make scary DR bits less prominent
I'm sure people will still find them, but let's at least
force people to click through one more time to get to the
commands that can damage your cluster.

Also, the ".. danger" directive at the top of the page
wasn't actually getting special formatting, so I changed
it to a ".. warning" which is red.

Signed-off-by: John Spray <john.spray@redhat.com>
2018-07-10 10:52:52 +01:00
Jos Collin
1660ef0569 doc: fix Ceph FS
s/Ceph FS/CephFS

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-07 07:23:22 +05:30
Jos Collin
81c0a328ac doc: new label and glossary url
Let the other docs link Ceph Filesystem glossary from outside.
If the user wants then let him visit the Ceph Filesystem doc(s)
from the glossary.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-07 07:23:15 +05:30
Jos Collin
1ea691f313 doc: drop linking to itself
drop unnecessary linking to its own smaller definition.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-07 07:03:58 +05:30