Commit Graph

918 Commits

Author SHA1 Message Date
Xavi Hernandez
d9704c0073 doc: update documentation for normalization and case sensitivity
Signed-off-by: Xavi Hernandez <xhernandez@gmail.com>
2025-03-25 14:52:22 +01:00
Kotresh HR
6b42c07417
Merge pull request #60684 from salieri11/wip-igolikov-asok-56442
mds: add MDS asok command for dumping stray directories
2025-03-24 18:06:36 +05:30
Rishabh Dave
3044bf7e4b doc/cephfs: mention new options for "fs volume create" cmd
Command "ceph fs volume create" accepts 2 new options to allow users to
pass data and metadata pool name. Update docs to include mention of both
the options.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2025-03-20 12:39:55 +05:30
Patrick Donnelly
37b70581d8
doc: add clarification note on how charmap is applied
There was confusion about whether setting the charmap on a directory also
affects the name of the directory itself.

Signed-off-by: Patrick Donnelly <pdonnell@ibm.com>
2025-03-18 11:24:52 -04:00
Rishabh Dave
1f0bfe1c59 doc/cephfs: add note for config option pause_purging and pause_cloning
Update documentation for add information about mgr/vol config options
"pause_purging" and "pause_cloning".

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2025-03-13 00:17:44 +05:30
Igor Golikov
f858fa958a doc: add dump stray folder command to the docs
Fixes: https://tracker.ceph.com/issues/56442
Signed-off-by: Igor Golikov <igolikov@ibm.com>
2025-03-03 13:19:57 +00:00
Patrick Donnelly
404d7e3278
doc: add docs for volumes interface for charmap
Signed-off-by: Patrick Donnelly <pdonnell@ibm.com>
2025-02-27 19:55:46 -05:00
Patrick Donnelly
d862d74a09
doc: add docs for CephFS charmap config
Signed-off-by: Patrick Donnelly <pdonnell@ibm.com>
2025-02-27 19:55:45 -05:00
Zac Dover
5670054bd0 doc/cephfs: edit disaster-recovery-experts (6 of x)
In doc/cephfs/disaster-recovery-experts.rst, incorporate Anthony's
suggestions in

https://github.com/ceph/ceph/pull/61462#discussion_r1923917812
and
https://github.com/ceph/ceph/pull/61462#discussion_r1923920724

and reword the sentences in the section "Using an alternate metadata
pool for recovery" to be in the imperative mood, which better suits the
ordered list format that was introduced in
https://github.com/ceph/ceph/pull/61493.

Follows https://github.com/ceph/ceph/pull/61493.

https://tracker.ceph.com/issues/69557

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-26 02:30:27 +10:00
Zac Dover
9af7d9786a doc/cephfs: edit disaster-recovery-experts (5 of x)
Put the procedure in the section called "Using an alternate metadata
pool for recovery" into an ordered list, so that it is in a proper
procedure format.

This commit is meant only to break the procedure into steps. The English
language in each of these steps could be improved, but that improvement
will be done after this formatting has been merged and backported.

Follows https://github.com/ceph/ceph/pull/61462.

https://tracker.ceph.com/issues/69557

Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-23 19:49:26 +10:00
Zac Dover
f2529d1174 doc/cephfs: edit disaster-recovery-experts (4 of x)
Edit the seventh and final section of
doc/cephfs/disaster-recovery-experts.rst in preparation for adding
deeper explanations of the contexts in which one should use the various
commands listed on that page.

The section edited in this commit is

 * Using an alternate metadata pool for recovery

A future commit might beneficially put this section into the format of
an ordered list. If so, such a commit should only reformat the
content and should not make any changes to the English. It's enough to
verify content or format. Let's not overload our editorial faculties by
forcing ourselves to walk and chew gum at the same time.

Follows https://github.com/ceph/ceph/pull/61442

https://tracker.ceph.com/issues/69557

Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-21 19:41:47 +10:00
Zac Dover
1fca95541f
Merge pull request #61249 from zdover23/wip-doc-2025-01-07-cephfs-snapshots
doc/cephfs: edit grammar in snapshots.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2025-01-21 15:26:08 +10:00
Zac Dover
a69c4142b7 doc/cephfs: edit disaster-recovery-experts (3 of x)
Edit the fifth and sixth sections of
doc/cephfs/disaster-recovery-experts.rst in preparation for adding
deeper explanations of the contexts in which one should use the various
commands listed on that page.

The sections edited in this commit are

 - MDS Map Reset
 - Recovery From Mission Metadata Objects

Follows https://github.com/ceph/ceph/pull/61427

https://tracker.ceph.com/issues/69557

Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-20 16:42:46 +10:00
Zac Dover
dceaab9a1a doc/cephfs: disaster-recovery-experts cleanup
Properly wrap a poorly-formatted paragraph that looks just awful in an
80-column viewport and change MDS to "MDS daemons" where the latter
makes the sentence a lot clearer.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-19 22:49:52 +10:00
Zac Dover
2b085e843c
Merge pull request #61427 from zdover23/wip-doc-2025-01-17-cephfs-disaster-recovery-experts-2
doc/cephfs: edit disaster-recovery-experts (2 of x)

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2025-01-19 17:31:28 +10:00
Zac Dover
4f3a69eb91 doc/cephfs: edit disaster-recovery-experts (2 of x)
Edit the third and fourth sections of
doc/cephfs/disaster-recovery-experts.rst in preparation for adding
deeper explanations of the contexts in which one should use the various
commands listed on that page.

Follows https://github.com/ceph/ceph/pull/61426

https://tracker.ceph.com/issues/69557

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-18 13:48:33 +10:00
Zac Dover
6652ac6729 doc/cephfs: remove link to undeveloped tool
Remove a link to a tracker for a planned-but-never-developed tool that
would have facilitated the importation or exportation of a RADOS pool to
a file. This is a part of a project to improve the CephFS Disaster
Recovery documentation, which was requested by Eugen Block. See the
tracker issue below for more on this project.

Follows https://github.com/ceph/ceph/pull/61411

See https://github.com/ceph/ceph/pull/61411#discussion_r1918525109

https://tracker.ceph.com/issues/69557

Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-17 22:23:17 +10:00
Zac Dover
cc8cfeddbd doc/cephfs: edit disaster-recovery-experts
Edit the first two sections of doc/cephfs/disaster-recovery-experts.rst
in preparation for adding deeper explanations of the contexts in which
one should use the various commands listed on that page.

https://tracker.ceph.com/issues/69557

Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-16 21:51:46 +10:00
Zac Dover
9a34ae55ed doc/cephfs: edit grammar in snapshots.rst
This commit improves the grammar in doc/cephfs/snapshots.rst. The PR
associated with this commit follows from
https://github.com/ceph/ceph/pull/61240, the PR raised by Neeraj Pratap
Singh to introduce information about snapshots into the CephFS
documentation.

See also https://tracker.ceph.com/issues/68974.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2025-01-08 00:24:19 +10:00
neeraj pratap singh
885b1bf88e doc: add snapshots in docs under Cephfs concepts
Fixes: https://tracker.ceph.com/issues/68974
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2025-01-06 18:25:37 +05:30
Zac Dover
ff1134f8c1
Merge pull request #60794 from dparmar18/wip-68571
doc/cephfs: document purge queue and its perf counters

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-12-30 17:26:45 +10:00
Venky Shankar
2215d554be Merge PR #55616 into main
* refs/pull/55616/head:
	PendingReleaseNotes: add note for replay completion warning
	qa: test to verify `MDS_ESTIMATED_REPLAY_TIME` warning
	doc: add a note for `MDS_ESTIMATED_REPLAY_TIME` MDS warning
	mds: emit warning for estinated replay time

Reviewed-by: Patrick Donnelly <pdonnell@ibm.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
2024-12-27 16:36:10 +05:30
Dhairya Parmar
ae92773988 doc/cephfs: document purge queue and its perf counters
Fixes: https://tracker.ceph.com/issues/68571
Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2024-12-26 12:09:13 +05:30
Venky Shankar
56bc82bfdb
Merge pull request #55145 from mchangir/mgr-snap_schedule-handle-volume-delete
mgr/snap_schedule: handle volume delete

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-12-26 09:34:15 +05:30
Zac Dover
9c7580a293 doc/cephfs: edit 3rd 3rd of mount-using-kernel-driver
Edit the third third of doc/cephfs/mount-using-kernel-driver.rst in
preparation for correcting mount commands that may not work in Reef as
described in this documentation.

This commit edits only English-language strings in
doc/cephfs/mount-using-kernel-driver.rst. No technical content (that is,
no commands and no settings) have been altered in this commit.

Technical alterations to this file will be made only after the English
is unambiguous.

This PR follows the following two PRs:
https://github.com/ceph/ceph/pull/61048 - 1st 3rd
https://github.com/ceph/ceph/pull/61049 - 2nd 3rd

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-12-14 00:03:18 +10:00
Zac Dover
d555ab9493
Merge pull request #61049 from zdover23/wip-doc-2024-12-12-mount-using-kernel-driver-main-2
doc/cephfs: edit 2nd 3rd of mount-using-kernel-driver

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-12-12 03:23:04 +01:00
Zac Dover
0526124b60 doc/cephfs: edit 2nd 3rd of mount-using-kernel-driver
Edit the second third of doc/cephfs/mount-using-kernel-driver.rst in
preparation for correcting mount commands that may not work in Reef as
described in this documentation.

This commit edits only English-language strings in
doc/cephfs/mount-using-kernel-driver.rst. No technical content (that is,
no commands and no settings) have been altered in this commit.

Technical alterations to this file will be made only after the English
is unambiguous.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-12-12 09:42:36 +10:00
Zac Dover
7fc0ead36c doc/cephfs: edit first 3rd of mount-using-kernel-driver
Edit the first third of doc/cephfs/mount-using-kernel-driver.rst in
preparation for correcting mount commands that may not work in Reef as
described in this documentation.

This commit is a cherry-pick from a branch that targeted the Reef
release branch. After some thought I realized that there was no reason
that the Engliish grammar shouldn't be clean in this branch too.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-12-11 22:03:20 +01:00
Venky Shankar
761489329c doc: add a note for MDS_ESTIMATED_REPLAY_TIME MDS warning
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2024-11-29 16:21:21 +05:30
Patrick Donnelly
9d2b3aaa96
Merge PR #60381 into main
* refs/pull/60381/head:
	doc: remove refrences to `mds_log_major_segment_event_ratio`
	mds: start a new major segment after reaching minor segment threshold
	mds: make parts of mdlog reusable to be used by beacon

Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Patrick Donnelly <pdonnell@ibm.com>
2024-11-12 22:14:20 -05:00
Milind Changire
153a698c31
doc/cephfs: note about volume deletion affecting snap-schedule Manager module
Signed-off-by: Milind Changire <mchangir@redhat.com>
2024-11-04 18:45:10 +05:30
Anthony D'Atri
7f9a2ec38f
Merge pull request #60362 from mchangir/doc-add-note-about-vol-delete-wrt-snap-schedule
doc/cephfs: add note to remind user about snap-schedule during volume delete
2024-10-31 15:05:24 -04:00
Anthony D'Atri
9a027d921e
Merge pull request #60532 from joscollin/wip-mirroring-create-snapshot
doc: mention how to initiate snapshot mirroring
2024-10-29 11:13:48 -04:00
Jos Collin
1a895c9d12
doc: mention how to initiate snapshot mirroring
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-10-29 14:33:10 +05:30
Zac Dover
dbe3004e69
Merge pull request #60470 from joscollin/wip-doc-cephfs-mirroring-improve-note
doc: explain the consequence of enabling mirroring through monitor commands

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Zac Dover <zac.dover@proton.me>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-10-29 15:36:06 +10:00
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
Jos Collin
ed3ce72fbc
doc: explain the consequence of enabling mirroring through monitor commands
Signed-off-by: Jos Collin <jcollin@redhat.com>
2024-10-24 20:21:14 +05:30
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
Venky Shankar
f54be33382 doc: remove refrences to mds_log_major_segment_event_ratio
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2024-10-23 14:01:12 +00: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
Milind Changire
56a1a27a9f
doc/cephfs: add note to remind user about snap-schedule during volume delete
Signed-off-by: Milind Changire <mchangir@redhat.com>
2024-10-16 23:25:39 +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