Commit Graph

880 Commits

Author SHA1 Message Date
TruongSinh Tran-Nguyen
13c7c9d998 doc/cephfs: use 'p' flag to set layouts or quotas
Remind users that clients must use the 'p' flag when writing file
layouts.

This PR is made in response to
https://www.reddit.com/r/ceph/comments/1gbad51/comment/ltkgd5v/

Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: TruongSinh Tran-Nguyen <i@truongsinh.pro>
2024-10-25 10:42:35 +10:00
Zac Dover
3e043a903c doc/cephfs: edit "Disabling Volumes Plugin"
Improve the English language in the section 'Disabling Volumes Plugin"
(which here becomes "Disabling the Volumes Plugin") in the
doc/cephfs/troubleshooting.rst file.

The change here is similar to a change introduced in
https://github.com/ceph/ceph/pull/60448/. That PR seems to be unable to
pass the "make check", and this PR is part of a test to see if breaking
the changes in that PR into several smaller changes results in mergeable
PRs.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-10-24 14:52:58 +10:00
Hemanth
fca07e95ea
Merge pull request #58647 from rishabh-d-dave/mgr-vol-mod-disable
mgr: allow disabling always-on modules
2024-10-23 17:57:50 +05:30
Indira Sawant
f6cf7ae528 doc/cephfs: rearrange subvolume group information
Rearranging the documentation to align it with CephFS encapsulation design.

Signed-off-by: Indira Sawant <indira.sawant@ibm.com>
2024-10-22 16:45:10 -05:00
Rishabh Dave
373910de34 doc/cephfs: add doc for disabling mgr/volumes plugin
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2024-10-19 16:57:16 +05:30
Rishabh Dave
8978b85bb0
Merge pull request #59420 from rishabh-d-dave/max-mds-confirm
mon,cephfs: require confirmation when changing max_mds on unhealthy cluster

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-10-18 20:04:18 +05:30
Jos Collin
1b535c011f
doc: update 'header get' output in cephfs-journal-tool.rst
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-10-09 15:46:00 +05:30
Venky Shankar
eb2183136d Merge PR #58966 into main
* refs/pull/58966/head:
	qa: test 'ceph fs snapshot mirror ls' command
	doc: update docs for 'fs snapshot mirror ls' command
	cephfs_mirror: ceph fs snapshot mirror ls command

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2024-10-07 12:48:52 +05:30
Rishabh Dave
2d28faaeea doc/cephfs: update about changing max_mds FS setting variable
Update the documentation for CephFs admininstration as well
troubleshooting.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2024-10-01 12:45:31 +05:30
Venky Shankar
592a19993c
Merge pull request #59875 from joscollin/wip-B68131-revert-sync-duration
cephfs_mirror: revert sync_duration to seconds

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-10-01 09:38:40 +05:30
Avan Thakkar
5b2378104a doc: update doc for subvolumes earmarking mentioning valid formats
Signed-off-by: Avan Thakkar <athakkar@redhat.com>
2024-09-24 12:31:01 +05:30
Jos Collin
42d89dfb64
doc: revert sync_duration to seconds
Fixes: https://tracker.ceph.com/issues/68131
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-09-23 14:43:47 +05:30
Avan Thakkar
174b9d4abe doc: document earmark option for subvolume and new commands
Signed-off-by: Avan Thakkar <athakkar@redhat.com>
2024-09-17 13:18:25 +05:30
Piotr Parczewski
332804bad5
doc/mds: improve wording
Signed-off-by: Piotr Parczewski <piotr@stackhpc.com>
2024-09-03 13:25:26 +02:00
Jos Collin
e60d82ab7c
doc: update docs for 'fs snapshot mirror ls' command
Fixes: https://tracker.ceph.com/issues/67292
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-08-29 17:19:22 +05:30
Venky Shankar
409001969e
Merge pull request #54620 from rishabh-d-dave/mgr-vol-clone-stats
mgr/vol: show progress and stats for the subvolume snapshot clones

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-08-26 15:44:53 +05:30
Venky Shankar
6b1d0de80e Merge PR #56816 into main
* refs/pull/56816/head:
	doc: mention the peer status failed when snapshot created on the remote filesystem.
	qa: add test_cephfs_mirror_remote_snap_corrupt_fails_synced_snapshot
	cephfs_mirror: update peer status for invalid metadata in remote snapshot

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
2024-08-22 14:52:33 +05:30
Anthony D'Atri
fda2db5ac7 doc: Harmonize 'mountpoint'
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2024-08-18 11:23:39 -04:00
Zac Dover
a0f81cfb50 doc/cephfs: s/mountpoint/mount point/
Change the string "mountpoint" to "mount point" in English-language
strings (as opposed to in commands, where the string "mountpoint"
sometimes appears and is correct).

cf. https://github.com/ceph/ceph/pull/58908#discussion_r1697715486 in
which page 345 of The IBM Style Guide is referenced to back up this
change.

This commit alters only English-language text and example commands in
which the string "{mount point}" is meant to be replaced. No commands
meant for cutting-and-pasting have been altered in this commit.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-17 13:48:06 +10:00
Zac Dover
4887e20f48
Merge pull request #59167 from zdover23/wip-doc-2024-08-12-cephfs-file-layouts
doc/cephfs: improve "layout fields" text

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2024-08-16 19:20:01 +10:00
Rishabh Dave
645cc6e6a8 doc/cephfs: add release notes and docs for clone progress report
Update docs and add release notes about the progress report that is
printed in output of "ceph fs clone status" command and progress bars
that is/are printed in output of "ceph status" command.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2024-08-14 15:05:46 +05:30
Zac Dover
aa3bdae231 doc/cephfs: improve cache-configuration.rst
Improve the text in the section about dealing with cache-pressure alerts
that was added in https://github.com/ceph/ceph/pull/59077. The changes
in this commit were suggested by Anthony D'Atri.

Co-authored-by: Patrick Donnelly <pdonnelly@redhat.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-13 01:43:13 +10:00
Zac Dover
0949b41043 doc/cephfs: improve "layout fields" text
Improve "layout fields" text in doc/cephfs/file-layouts.rst, as suggesed
by Anthony D'Atri in these comments:

https://github.com/ceph/ceph/pull/59021#discussion_r1704108581
https://github.com/ceph/ceph/pull/59021#discussion_r1704112320

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-12 22:38:14 +10:00
Jos Collin
ce10e5e424
doc: mention the peer status failed when snapshot created on the remote filesystem.
* Update the docs for the failed status, when the snapshot is created on the remote fs.
* Mention the read-only restrictions of the remote fs.

Fixes: https://tracker.ceph.com/issues/65317
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-08-12 11:48:04 +05:30
Zac Dover
bf26274ae4 doc/cephfs: add cache pressure information
Add information to doc/cephfs/cache-configuration.rst about how to deal
with a message that reads "clients failing to respond to cache
pressure". This procedure explains how to slow the growth of the
recall_caps value so that it does not exceed the
mds_recall_warning_threshold.

The information in this commit was developed by Eugen Block. See
https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/5ROH5CWKKOEIQMVXOVRT5OO7CWK2HPM3/#J65DFUPP4BY57MICPANXKI7KAXSZ5Z5P
and https://www.spinics.net/lists/ceph-users/msg73188.html.

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

Co-authored-by: Eugen Block <eblock@nde.ag>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-09 10:58:26 +10:00
Venky Shankar
c77bd7e432 Merge PR #59040 into main
* refs/pull/59040/head:
	doc: documenting the feature that scrub clear the entries from damage table on repair

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2024-08-07 11:00:05 +05:30
Venky Shankar
c9ab079494
Merge pull request #56782 from joscollin/wip-B65171-support-replication-start-end-notifications
cephfs_mirror: provide metrics for last successful snapshot sync

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-08-07 09:51:36 +05:30
neeraj pratap singh
140e77638d doc: documenting the feature that scrub clear the entries from damage table on repair
Fixes: https://tracker.ceph.com/issues/67337
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2024-08-07 08:57:16 +05:30
Zac Dover
9607b66e97 doc/cephfs: edit "Layout Fields" text
Improve the English in the "Layout Fields" section of
doc/cephfs/file-layouts.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-08-01 13:12:12 +10:00
Jos Collin
091625e6fe
doc: update 'sync_bytes' in peer status
Fixes: https://tracker.ceph.com/issues/65629
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-07-30 14:31:56 +05:30
Jos Collin
3fd00ebc57
doc: update current_syncing_snap in peer status
Fixes: https://tracker.ceph.com/issues/67251
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-07-30 14:24:38 +05:30
Jos Collin
7c32d15996
doc: document labelled perf metrics for mds/cephfs-mirror
Fixes: https://tracker.ceph.com/issues/64483
Fixes: https://tracker.ceph.com/issues/65171
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-07-30 14:09:23 +05:30
Zac Dover
d14119e37e doc/cephfs: edit "Dynamic Subtree Partitioning"
Edit the section "Dynamic Subtree Partitioning" in
doc/cephfs/multimds.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-30 01:05:57 +10:00
Zac Dover
74b03a8cb2 doc/cephfs: fix "OSD capabilities" link
Fix a broken link from the "OSD capabilites" reference on
doc/cephfs/client-auth.rst.

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-28 17:27:53 +10:00
Zac Dover
6bb5ce94c6 doc/cephfs: fix "file layouts" link
Fix a broken link to the "File Layouts" page on
doc/cephfs/client-auth.rst.

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-26 17:15:12 +10:00
Zac Dover
820f8ead89 doc/cephfs: streamline a paragraph
Streamline a paragraph in doc/cephfs/index.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-18 15:28:51 +10:00
Zac Dover
55b4ea7ba5 doc/cephfs: improve mount-using-fuse
Improve the first twenty percent of doc/cephfs/mount-using-fuse.rst.
This commit changes the text so that it is clearer that FUSE is an
alternative to mounting CephFS with the kernel driver. This commit also
links to the kernel driver page from the "FUSE-mount" page.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-17 17:02:35 +10:00
Patrick Donnelly
7290bdce6f
doc: elide superuser discussion from mount prereq
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-07-15 10:18:15 -04:00
Patrick Donnelly
d100de9c9c
doc: clarify superuser note for ceph-fuse
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-07-15 10:12:52 -04:00
Zac Dover
0ebfb3eda8 doc/cephfs: edit "is mount helper present"
Edit the section called "Is mount helper present?", the title of which
prior to this commit was "Is mount helper is present?". Other small
disambiguating improvements have been made to the text in the section.
An unselectable prompt has been added before a command.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-14 16:40:14 +10:00
spdfnet
d94f90b757 doc/cephfs: fix typo
blanacer -> balancer

Signed-off-by: spdfnet <32593931+spdfnet@users.noreply.github.com>
2024-07-08 09:03:35 +01:00
Zac Dover
4f8903cf80 doc/cephfs: update cephfs-shell link
Repair the link to cephfs-shell.rst in doc/cephfs/cephfs-shell.rst that
was broken in https://github.com/ceph/ceph/pull/41165/ when
doc/cephfs/cephfs-shell.rst was moved to doc/man/8/cephfs-shell.rst.

This commit is made in response to a request by Lander Duncan that was
made on the [ceph-users] mailing list, and can be seen here: https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/F7V4CWLIYCAJ4JXI2JLNY6QPCFPR4SLA/

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-01 15:57:40 +10:00
Zac Dover
7a78dda0a9 doc/cephfs: take Anthony's suggestion
Incorporate Anthony's suggestion in
https://github.com/ceph/ceph/pull/57567#discussion_r1607016050 into
doc/cephfs/fs-volumes.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-29 22:11:55 +10:00
Venky Shankar
cac7dcd634 Merge PR #53755 into main
* refs/pull/53755/head:
	PendingReleaseNotes: add note about CephFS set_vxattrs
	doc/cephfs: Update docs to match remove functionality and respective vxattrs
	qa: Add test coverage for vxattr behavior
	qa: Add removexattr to support setfattr removal.
	mds: Implement remove for ceph vxattrs

Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
2024-06-27 19:58:50 +05:30
Patrick Donnelly
cb5086ec82
doc/cephfs: add documentation for mds last-seen
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-06-20 21:32:56 -04:00
Zac Dover
9ce7f9bd6c doc/cephfs: edit vstart warning text
Improve the English in the vstart warning in doc/cephfs/mantle.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-01 05:34:43 +10:00
Zac Dover
559d4849ec doc/cephfs: edit front matter in mantle.rst
Improve the structure and grammar of the front matter in the
doc/cephfs/mantle.rst file.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-30 23:28:56 +10:00
Christopher Hoffman
7d3da6ecc9 doc/cephfs: Update docs to match remove functionality and respective vxattrs
Signed-off-by: Christopher Hoffman <choffman@redhat.com>
2024-05-29 13:43:32 +00:00
Venky Shankar
75bcfd1bbf Merge PR #55758 into main
* refs/pull/55758/head:
	doc: update 'journal reset' command with --yes-i-really-really-mean-it
	qa: fix cephfs-journal-tool command options and make fs inactive
	cephfs-journal-tool: Add warning messages during 'journal reset' and prevent execution on active fs

Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-05-29 15:04:58 +05:30
Zac Dover
607f68759c
Merge pull request #57720 from zdover23/wip-doc-2024-05-27-cephfs-fs-volumes
doc/cephfs: s/subvolumegroups/subvolume groups

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-05-28 20:14:22 +10:00