Commit Graph

75 Commits

Author SHA1 Message Date
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
Jos Collin
08334cc2d5 doc: update toctree for add-remove-mds.rst
Fixes: http://tracker.ceph.com/issues/24093
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-01 18:49:58 +05:30
Ramana Raja
c33cba3230 Add config doc for exporting CephFS over NFS
... using NFS-Ganesha NFS server.

Fixes: https://tracker.ceph.com/issues/23271

Signed-off-by: Ramana raja <rraja@redhat.com>
2018-04-02 18:10:43 +05:30
Jos Collin
a925bb4520 doc: fix typo
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-01-05 19:37:31 +05:30
Jos Collin
db23f4ce30 doc: add mount.fuse.ceph to index
Added mount.fuse.ceph to index.rst

Fixes: http://tracker.ceph.com/issues/22595
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-01-05 19:29:55 +05:30
Barbora Ančincová
4f590990b0 doc: Add section about MDS cache limits
Signed-off-by: Bara Ancincova (bara@redhat.com)
2017-11-29 12:46:49 +01:00
Kefu Chai
9d32038222 doc/cephfs: add capabilities.rst to toc
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-16 16:39:40 +08:00
John Spray
76589ed9e1 doc: instructions and guidance for multimds
Inspired by http://tracker.ceph.com/issues/19135

Signed-off-by: John Spray <john.spray@redhat.com>
2017-03-07 14:08:22 +00:00
John Spray
15c6147f79 doc: explain directory fragmenation settings
...and update the config ref.

Includes the new mds_bal_fragment_fast_factor setting.

Signed-off-by: John Spray <john.spray@redhat.com>
2016-11-24 10:45:59 +00:00
John Spray
e7858ecf87 doc/cephfs: separate front page section for dev stuff
The "additional details" section was getting longer
and longer, and I don't want developer-only stuff
in there anyway.

Signed-off-by: John Spray <john.spray@redhat.com>
2016-11-04 13:07:30 +00:00
John Spray
1e7e2a94ce doc/cephfs: link in mantle doc
...and add a warning at the very top of the document
that it is not for ordinary user use.

Considered just not linking this in at all, but it
seems a shame to have it here but not be able to
e.g. google it and link to it.

Signed-off-by: John Spray <john.spray@redhat.com>
2016-11-04 13:07:28 +00:00
John Spray
4a648d2d4a Merge pull request #10573 from renhwztetecs/renhw-wip-doc-cephfs
doc/mds: fixup mds doc

Reviewed-by: John Spray <john.spray@redhat.com>
2016-08-05 12:26:21 +01:00
huanwen ren
d40e9aaead doc/mds: consistent with "../doc/rados/deployment/index.rst"
Signed-off-by: huanwen ren <ren.huanwen@zte.com.cn>
2016-08-02 16:50:15 +08:00
Patrick Donnelly
9ad2ccf298
doc: add client config ref
Fixes: http://tracker.ceph.com/issues/16743

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2016-07-27 17:21:40 -04:00
John Spray
ef1405ab19 doc/cephfs: explain the various health messages
Signed-off-by: John Spray <john.spray@redhat.com>
2016-07-21 12:32:05 +01:00
John Spray
e222a99ab1 doc/cephfs: rename early-adopters to best-practices
...and give it a link in the TOC (in addition
to where it is referenced from the top of index.rst)

Signed-off-by: John Spray <john.spray@redhat.com>
2016-06-30 23:56:39 +01:00
John Spray
f6ddfad6da doc/cephfs: remove some scary warnings
...and restructure the "early adopters" page
into a "best practices" guide.  Early adopters
are now just adopters :-)

Signed-off-by: John Spray <john.spray@redhat.com>
2016-06-30 23:56:39 +01:00
Greg Farnum
5d9cc299e6 doc: include link to CephFS' experimental features
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2016-06-06 14:46:44 -07:00
John Spray
97dd6897ef doc: add cephfs daemon management docs
Principally to tell people how to configure
standby, but more generally as a place to define
our terms for GIDs etc.

Signed-off-by: John Spray <john.spray@redhat.com>
2016-05-03 12:57:22 +01:00
John Spray
99c175097c doc: cephfs admin command list
Creating this skeleton to include the new
"ceph fs ..." commands.  Needs filling out
with prose about purpose and result of
commands.

Signed-off-by: John Spray <john.spray@redhat.com>
2016-03-10 11:18:28 +00:00
John Spray
e5641115e9 doc: add notes about upgrading cephfs
This is part of the run-up to removing all
TMAP code in the Jewel+1 cycle.

Signed-off-by: John Spray <john.spray@redhat.com>
2016-03-01 10:58:43 +00:00
Sage Weil
d5cee59b02 doc/cephfs/posix: update
Signed-off-by: Sage Weil <sage@redhat.com>
2015-12-14 10:45:30 -05:00
John Spray
2829e9dc78 doc: flesh out MDS auth docs
...including updating for 'rwp'.

Signed-off-by: John Spray <john.spray@redhat.com>
2015-11-13 14:18:44 +00:00