Commit Graph

709 Commits

Author SHA1 Message Date
Rishabh Dave
cd3f9575af doc/cephfs: describe conf opt "client quota df" in quota doc
The ceph config file option (from the client section) "client quota df"
is mentioned in "CephFS Client Capabilities" document but not in the
"CephFS Quota" document. Adding information about this option to this
document too would make it easier for CephFS users to discover,
understand and use this option.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-02-22 21:17:36 +05:30
Rishabh Dave
57335e8a4f doc/cephfs: rearrange CephFS Quota document
CephFS users, especially new users, would find it easier to discover,
understand and use CephFS Quota when basic information (like setting,
viewing and removing CephFS quota from a CephFS directory) is mentioned
in the documentation before advanced information (like limitations &
implementation details of CephFS Quota).

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-02-22 21:17:36 +05:30
Jos Collin
247f81e5b4
doc: updates --dump and --dumpfs
Fixes: https://tracker.ceph.com/issues/57014
Signed-off-by: Jos Collin <jcollin@redhat.com>
2023-02-16 15:13:19 +05:30
Zac Dover
7f23dde6be doc/cephfs: add note about CephFS extended attributes and getfattr
Supersedes https://github.com/ceph/ceph/pull/50060

Add a note on the fact that CephFS extended attributes are not printed
by "getfattr /some/cephfs/dir/ -d -m -" even when the CephFS directory
has some extended attributes set on it.

https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/6ENI42ZMHTTP2OONBRD7FDP7LQBC4P2E/

Primary Author: Rishabh Dave <ridave@redhat.com>
Co-author: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-10 09:20:27 +10:00
Neeraj Pratap Singh
87215ab3e4 doc: add the damage types that scrub can repair
Fixes: https://tracker.ceph.com/issues/51459
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2023-01-30 21:55:49 +05:30
Jos Collin
86f8fa19e5
doc: document the relevance of mds_namespace mount option
Fixes: https://tracker.ceph.com/issues/57673
Signed-off-by: Jos Collin <jcollin@redhat.com>
2023-01-10 14:48:20 +05:30
Anthony D'Atri
d8986dd252
Merge pull request #49203 from ktdreyer/doc-simple-cephfs-create
doc/cephfs: simplify ceph fs volume create command
2022-12-19 01:46:06 -05:00
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
Zac Dover
ac20eb83fe doc/cephfs: fix "e.g." in posix.rst
Remove "e.g." and replace it with "for example".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-15 14:29:42 +10:00
colemitchell
d40d0cc7d6
Merge pull request #49441 from zdover23/wip-doc-2022-12-15-cephfs-homophone-error
doc/cephfs - s/yet to here/yet to hear/ posix.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-12-14 23:06:11 -05:00
Zac Dover
e1c5bcd73b doc/cephfs: s/all of there are/all of these are/
s/all of there are/all of these are/ in posix.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-15 07:07:44 +10:00
Zac Dover
03bfcb134b doc/cephfs - s/yet to here/yet to hear/ posix.rst
Correct "yet to here" to "yet to hear" in posix.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-15 06:51:29 +10:00
Venky Shankar
dfe10da454
Merge pull request #49155 from joscollin/wip-cephfs-top-doc-update-filters
doc: updated doc for Filters

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-12-07 10:05:10 +05:30
Ken Dreyer
db4cd72479 doc/cephfs: monospace "ceph fs set-default" command
Fix the rst syntax here to make this command match everything else.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2022-12-06 15:24:43 -05:00
Jos Collin
19c38d65c4
doc: updated doc for Filters
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-11-30 16:52:53 +05:30
Patrick Donnelly
812090390f
doc/cephfs: correct names for fs/meta
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-11-22 12:08:06 -05:00
Zac Dover
75de28e9b2 doc/glossary: add "mds" term
Improve "MDS" glossary term. Link to MDS information.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-14 14:24:19 +10:00
Jos Collin
fafe3d4d12
Revert "doc: update cephfs-top.png"
This reverts commit 2233b68fe0.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-11-08 20:06:12 +05:30
Jos Collin
2233b68fe0
doc: update cephfs-top.png
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-11-05 06:18:57 +05:30
Neeraj Pratap Singh
bc360a4503 doc: addition of sort and limit features in doc
Fixes: https://tracker.ceph.com/issues/55121
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-11-03 17:36:49 +05:30
Jos Collin
1e794901b6
Merge pull request #48090 from joscollin/wip-F55197-cephfs-top-scroll
cephfs-top: make cephfs-top display scrollable

Reviewed-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-10-29 07:39:55 +05:30
Venky Shankar
82f46b1fdc Merge PR #43284 into main
* refs/pull/43284/head:
	doc: describe bal_rank_mask configuration
	qa/cephfs: add bal_rank_mask test cases
	mds: add bal_rank_mask option for ceph fs set

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-10-26 11:28:25 +05:30
Jos Collin
19ef3f3c55
doc: Update cephfs-top.png
Fixes: https://tracker.ceph.com/issues/55197
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-10-26 09:56:21 +05:30
Yongseok Oh
a1a14edd50 doc: describe bal_rank_mask configuration
Signed-off-by: Yongseok Oh <yongseok.oh@linecorp.com>
2022-10-13 05:40:22 +00:00
Venky Shankar
296ba0641a
Merge pull request #48196 from neesingh-rh/wip-human-readable-volume-info
mgr/volumes: Add human-readable flag to volume info command

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
2022-10-11 16:48:19 +05:30
Venky Shankar
ae1f163816
Merge pull request #48319 from gregsfortytwo/wip-57737-cephfs-doc
doc: discuss the standard multi-tenant CephFS security model

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ken Dreyer <kdreyer@redhat.com>
2022-10-06 10:40:30 +05:30
Greg Farnum
91e7c7de6a doc: discuss the standard multi-tenant CephFS security model
Fixes: https://tracker.ceph.com/issues/57737

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2022-10-05 15:16:37 +00:00
Venky Shankar
b0021de5fa
Merge pull request #48292 from kotreshhr/doc-symlink-fix
doc: Fix disaster recovery doc

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2022-10-03 11:14:33 +05:30
Kotresh HR
b6898efcb7 doc: Fix disaster recovery doc
Fixes: https://tracker.ceph.com/issues/57734
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2022-09-30 12:07:26 +05:30
Neeraj Pratap Singh
2c8add629d doc: documenting the --human_readable flag for volume info cmd
Fixes: https://tracker.ceph.com/issues/57620
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-09-29 12:01:02 +05:30
Patrick Donnelly
da19a128ee
doc: update alternate meta pool recovery
Streamline, clarify, and use modern commands (notably: --recover).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-09-20 17:53:50 -04:00
Milind Changire
56178917a6 doc/cephfs: add note about cephfs-mirroring paths
Signed-off-by: Milind Changire <mchangir@redhat.com>
2022-09-20 13:47:09 +05:30
Venky Shankar
5128cf8e18
Merge pull request #46072 from neesingh-rh/fix_54978
cephfs-top: adding filesystem menu option

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2022-08-24 13:37:46 +05:30
Venky Shankar
d8ba839bcd
Merge pull request #46068 from neesingh-rh/change_perf_stats_o/p_structure
mgr/stats: change in structure of perf_stats o/p

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2022-08-24 11:13:07 +05:30
Venky Shankar
d1ca282f60
Merge pull request #45949 from neesingh-rh/feature-51434
mgr/volumes: Add volume info command

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
Reviewed-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-08-23 21:33:09 +05:30
Venky Shankar
b3b6a829e5
Merge pull request #44501 from SMIL-Infra/fix-mds-evicted
mon/MDSMonitor: fix standby-replay mds being removed from MDSMap unexpectedly

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2022-08-23 21:30:18 +05:30
Neeraj Pratap Singh
d3552e8107 doc: drop perf stats o/p string.
Dropping the output of this command entirely, as it is
difficult to maintain it in the docs.A minor change in
the command output invalidates the docs.

Fixes: https://tracker.ceph.com/issues/56162
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-08-18 14:31:38 +05:30
Venky Shankar
cd38fe3c85
Merge pull request #47477 from mchangir/doc-clarify-start-time-in-snap-schedule
doc/cephfs: note regarding start time time zone

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2022-08-17 12:36:10 +05:30
Milind Changire
5d281e9b88 doc/cephfs: note regarding start time time zone
Fixes: https://tracker.ceph.com/issues/56730
Signed-off-by: Milind Changire <mchangir@redhat.com>
2022-08-16 17:51:37 +05:30
Venky Shankar
c4d6729fb8
Merge pull request #44710 from joscollin/wip-F40633-dump-recent-extraordinary-events
mds: dump recent log events for extraordinary events

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
Reviewed-by: Xiubo Li <xiubli@redhat.com>
Reviewed-by: Greg Farnum <gfarnum@redhat.com>
2022-08-12 15:00:49 +05:30
胡玮文
969061e8d5 doc: complete MDS state diagram
Add missing rejoin -> stopped.
MDS can transit from replay-standy to damaged Since 20509bb6c8.

Signed-off-by: 胡玮文 <huww98@outlook.com>
2022-08-12 09:30:37 +08:00
胡玮文
b4cc22a57f mds: remove reference to mds-state-diagram.svg
We no longer generate that file since c783ae10aa

Signed-off-by: 胡玮文 <huww98@outlook.com>
2022-08-12 09:30:36 +08:00
Neeraj Pratap Singh
65a18142fb doc: documenting volume info command.
Fixes: https://tracker.ceph.com/issues/51434
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-08-05 12:46:15 +05:30
Nikhilkumar Shelke
c0c386b197 docs: minor doc fixes of showing in progress clones for a snapshot
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-08-04 19:16:39 +05:30
Neeraj Pratap Singh
1c5fe5188a doc: Add command to check the presence of any subvolumegroup/subvolume
Fixes: https://tracker.ceph.com/issues/55821
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-07-26 16:33:14 +05:30
Neeraj Pratap Singh
e9d43d7838 doc/cephfs-top: adding doc for menu options
Fixes: https://tracker.ceph.com/issues/54978
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-07-19 14:09:01 +05:30
Venky Shankar
8323b6fef5
Merge pull request #46950 from dparmar18/fix_dirfrags_doc
doc/cephfs/dirfrags: clarify the unit of threshold limits

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Rishabh Dave <ridave@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
2022-07-12 12:26:45 +05:30
Venky Shankar
e9b7e9b4ec
Merge pull request #46951 from dparmar18/fix_caps_doc
doc/cephfs/capabilities: Fixed some typos

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by:  Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Xiubo Li <xiubli@redhat.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2022-07-08 10:29:40 +05:30
dparmar18
0d094f8f52 doc/cephfs/dirfrags: clarify the unit of threshold limits
Rationale: There are many threshold limits for split and
           merge in this doc that just says like:
           "A directory fragment is eligible for splitting
           when its size exceeds `mds_bal_split_size`
           (default 10000)". Need to clarify what 10000 actually
           means. This applies to all other such entries in this
           doc.

Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2022-07-07 13:10:57 +05:30
Anthony D'Atri
f6a70c0e8e
Merge pull request #46868 from vshankar/wip-cephfs-mirror-ha-doc
doc: document deploying multiple cephfs-mirror daemons
2022-07-06 07:46:26 -07:00