Commit Graph

80 Commits

Author SHA1 Message Date
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
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
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
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
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
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
Zac Dover
b303417f65 doc/cephfs: s/subvolumegroups/subvolume groups
Use the term "subvolume groups" instead of "subvolumegroups" where the
term appears in plain English. The string "subvolumegroups" is correct
in commands, and remains unchanged.

Also add formatting to command output, to make clearer that the output
is indeed output.

Fixes: https://github.com/ceph/ceph/pull/57574#discussion_r1606988766

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-27 21:09:40 +10:00
Zac Dover
32155e2360 doc/cephfs: disambiguate two sentences
Rewrite two sentences so that they are unambgiuously in the indicative
mood and not, as they previously seemed, in the imperative mood.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-25 18:41:03 +10:00
Zac Dover
36499642a0
Merge pull request #57554 from zdover23/wip-doc-2024-05-20-cephfs-fs-volumes-fs-subvolumes-sections
doc/cephfs: separate commands into sections

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-05-24 00:47:54 +10:00
Zac Dover
5789fdef05
Merge pull request #57567 from zdover23/wip-doc-2024-05-20-cephfs-fs-volumes-cloning-snapshots
doc/cephfs: edit "Cloning Snapshots" in fs-volumes.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-05-24 00:21:54 +10:00
Zac Dover
b319ead00e doc/cephfs: edit "Pinning Subvolumes..."
Edit the section "Pinning Subvolumes and Subvolume Groups" in
doc/cephfs/fs-volumes.rst. This is merely a grammar edit.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-21 01:07:14 +10:00
Zac Dover
69941180e9 doc/cephfs: edit "Cloning Snapshots" in fs-volumes.rst
Edit the "Cloning Snapshots" section in doc/cephfs/fs-volumes.rst. This
commit represents only a grammar pass. A future commit (and future PR)
will separate this section into subsections by command.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-20 21:55:16 +10:00
Zac Dover
a84ec3a1c0 doc/cephfs: separate commands into sections
Separate commands so that each command has its own subsection in the
section "FS Subvolumes" in the file doc/cephfs/fs-volumes.rst.
Previously, the list of commands for manipulating subvolumes was one
long, unbroken list and the beginning of one section could easily be
mistaken for the end of the previous section.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-20 16:29:44 +10:00
Zac Dover
be63ca6d03 doc/cephfs: Squid and later - subvolume quiesce
Add a note to the "Subvolume quiesce" section that says that the
information in the section applies only to the Squid and later releases
of Ceph. This is included here so that I don't overwrite the Reef and
Quincy documentation with irrelevant information, and so that I don't
overwrite the Squid information with blank space where the "Subvolume
quiesce" section should be.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-19 10:00:29 +10:00
Zac Dover
0a3981a011 doc/cephfs: edit fs-volumes.rst (2 of x)
Edit doc/cephfs/fs-volumes to the section "Cloning Snapshots" (but not
including the section "Cloning Snapshots".

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-17 20:46:28 +10:00
Leonid S. Usov
a00caf87db
Merge pull request #57099 from ceph/wip-lusov-quiesce-await-eperm
mds/quiesce: db: quiesce-await should EPERM if a set is past QS_QUIESCED
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2024-05-15 14:35:27 +03:00
Zac Dover
cb700d804b doc/cephfs: edit fs-volumes.rst (1 of x) followup
Include the suggestions for improving doc/cephfs/fs-volumes.rst made by
Anthony D'Atri here
https://github.com/ceph/ceph/pull/57415#discussion_r1597362110

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-12 11:39:34 +10:00
Zac Dover
0acbb278fc doc/cephfs: edit fs-volumes.rst (1 of x)
Edit doc/cephfs/fs-volumes to the section "FS Subvolumes" (but not
including the section "FS Subvolumes").

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-11 14:57:23 +10:00
Leonid Usov
34ec2a4c6a doc/cephfs: expand the role of quiesce in consistent backups
Signed-off-by: Leonid Usov <leonid.usov@ibm.com>
Fixes: https://tracker.ceph.com/issues/65881
2024-05-09 17:57:18 +03:00
Leonid Usov
fd88b52d6f mds/quiesce: db: quiesce-await should EPERM if a set is past QS_QUIESCED
Fixes: https://tracker.ceph.com/issues/65669
Signed-off-by: Leonid Usov <leonid.usov@ibm.com>
2024-04-30 07:57:43 +03:00
neeraj pratap singh
906ff4e4c2 doc: fixing doc/cephfs/fs-volumes
Fixes: https://tracker.ceph.com/issues/65267
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2024-04-02 21:16:42 +05:30
Leonid Usov
629ffe1d31 doc/cephfs/fs-volumes: doc fixes and updates
Signed-off-by: Leonid Usov <leonid.usov@ibm.com>
2024-03-04 13:48:04 +02:00
Leonid Usov
09e08ac6a4 doc/cephfs/fs-volumes: Add info about the quiesce command
Signed-off-by: Leonid Usov <leonid.usov@ibm.com>
2024-03-04 13:48:03 +02:00
neeraj pratap singh
6a44322d59 doc: add the reject the clone when threads are not available feature in the document
Fixes: https://tracker.ceph.com/issues/59714
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2024-02-13 14:49:57 +05:30
Patrick Donnelly
3a5f9dc37a
doc: expand and consolidate mds placement
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2023-08-24 08:55:47 -04:00
Kotresh HR
b93b3364ae doc: Add a note on possible deadlock on volume deletion
Fixes: https://tracker.ceph.com/issues/62407
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2023-08-11 17:04:59 +05:30
Zac Dover
a1184070a1 doc/cephfs: edit fs-volumes.rst (1 of x)
Edit the syntax of the English language in the file
doc/cephfs/fs-volumes.rst up to (but not including) the section called
"FS Subvolumes".

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-13 01:49:14 +10:00
Zac Dover
1f88f10fe6 doc/cephfs: rectify prompts in fs-volumes.rst
Make sure all prompts are unselectable. This PR is meant to be
backported to Reef, Quincy, and Pacific, to get all of the prompts into
a fit state so that a line-edit can be performed on the Englsh language
in this file.

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-12 20:35:25 +10:00
Zac Dover
e019948783 doc/cephfs: fix prompts in fs-volumes.rst
Fixed a regression introduced in
e5355e3d66 that broke the unselectable
prompts in the RST.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-11 01:10:33 +10:00
Ville Ojamo
e5355e3d66 doc/cephfs: fix prompts in fs-volumes.rst
Modernize prompts in example commands in file
fs-volume.rst and use a root prompt correctly instead
of using a non-privileged prompt when privileges
are needed.

Indent all JSON in example command outputs with
four spaces consistently instead of a mix of four and
two spaces.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-04-02 16:36:44 +07:00
Anthony D'Atri
c8e1f3ac3d doc/cephfs: Improve fs-volumes.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2023-04-01 01:05:20 -04:00
Ville Ojamo
d5343396aa
doc/cephfs: refer to MDS and not NFS in fs-volumes.rst
Placement should talk about MDS placement and not NFS Ganesha placement.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-03-31 19:01:39 +07:00
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
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
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
Nikhilkumar Shelke
a8b819da71 docs: display in-progress clones for a snapshot
If any clone is in pending or in-progress state then
show these clones in 'fs subvolume snapshot info'
command output. This field only exists if clones are
in pending or in progress state.

Fixes: https://tracker.ceph.com/issues/55041
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-07-04 13:31:40 +05:30
Venky Shankar
c88a5c832e
Merge pull request #46635 from nmshelke/fix-55822
mgr/volumes: remove incorrect 'size' from output of 'snapshot info'

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>
2022-06-20 09:50:20 +05:30
Nikhilkumar Shelke
86f4cd3dca docs: remove incorrect 'size' from output of 'snapshot info'
The 'size' shown in the output of snapshot info command relies on
rstats which is incorrect snapshot size. It tracks size of the
subvolume from the snapshot has been taken instead of the snapshot
itself. Hence having the 'size' field in the output of 'snapshot info'
doesn't make sense until the rstats is fixed.

Fixes: https://tracker.ceph.com/issues/55822
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-06-12 17:16:49 +05:30
Kotresh HR
168b912b02 doc: Document subvolumegroup quota commands
Add documentation for subvolume group quota along
with 'subvolumegroup resize' and 'subvolumegroup info'
commands

Fixes: https://tracker.ceph.com/issues/53509
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2022-06-06 12:40:46 +05:30
Nikhilkumar Shelke
59a0cbc14b docs: set, get, list and remove custom metadata for snapshot
Set custom metadata on the snapshot as a key-value pair using
    $ ceph fs subvolume snapshot metadata set <vol_name> <subvol_name> <snap_name> <key_name> <value> [--group_name <subvol_group_name>]
    note: If the key_name already exists then the old value will get replaced by the new value.
    note: The key_name and value should be a string of ASCII characters (as specified in python's string.printable). The key_name is case-insensitive and always stored in lower case.
    note: Custom metadata on a snapshots is not preserved when snapshotting the subvolume, and hence, is also not preserved when cloning the subvolume snapshot.

Get custom metadata set on the snapshot using the metadata key::
    $ ceph fs subvolume snapshot metadata get <vol_name> <subvol_name> <snap_name> <key_name> [--group_name <subvol_group_name>]

List custom metadata (key-value pairs) set on the snapshot using::
    $ ceph fs subvolume snapshot metadata ls <vol_name> <subvol_name> <snap_name> [--group_name <subvol_group_name>]

Remove custom metadata set on the snapshot using the metadata key::
    $ ceph fs subvolume snapshot metadata rm <vol_name> <subvol_name> <snap_name> <key_name> [--group_name <subvol_group_name>] [--force]
    Using the '--force' flag allows the command to succeed that would otherwise fail if the metadata key did not exist.

Fixes: https://tracker.ceph.com/issues/55401
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-05-25 14:59:53 +05:30
Venky Shankar
3f13df8388
Merge pull request #45603 from nmshelke/feature-54472
mgr/volumes: set, get, list and remove metadata of subvolume

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2022-04-19 16:52:13 +05:30
Kotresh HR
555d361063 doc: Document the clone failure status
Fixes: https://tracker.ceph.com/issues/55190
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2022-04-13 14:26:28 +05:30
Nikhilkumar Shelke
88adfe9050 docs: set, get, list and remove custom metadata for subvolume
Set custom metadata on the subvolume as a key-value pair using
    $ ceph fs subvolume metadata set <vol_name> <subvol_name> <key_name> <value> [--group_name <subvol_group_name>]
    note: If the key_name already exists then the old value will get replaced by the new value.
    note: key_name and value should be a string of ASCII characters (as specified in python's string.printable). key_name is case-insensitive and always stored in lower case.
    note: Custom metadata on a subvolume is not preserved when snapshotting the subvolume, and hence, is also not preserved when cloning the subvolume snapshot.

Get custom metadata set on the subvolume using the metadata key
    $ ceph fs subvolume metadata get <vol_name> <subvol_name> <key_name> [--group_name <subvol_group_name>]

List custom metadata (key-value pairs) set on the subvolume using
    $ ceph fs subvolume metadata ls <vol_name> <subvol_name> [--group_name <subvol_group_name>]

Remove custom metadata set on the subvolume using the metadata key
    $ ceph fs subvolume metadata rm <vol_name> <subvol_name> <key_name> [--group_name <subvol_group_name>] [--force]
    Using the '--force' flag allows the command to succeed that would otherwise fail if the metadata key did not exist.

Fixes: https://tracker.ceph.com/issues/54472
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-04-06 23:46:44 +05:30
Ramana Raja
70697629bf mgr/volumes: Add fs volume rename command
The `fs volume rename` command renames the volume, i.e.,
orchestrator MDS service, file system, and the data and
metadata pool of the file system.

Fixes: https://tracker.ceph.com/issues/51162
Signed-off-by: Ramana Raja <rraja@redhat.com>
2022-01-13 10:36:46 -05:00
Dimitri Papadopoulos
7677651618
doc,man: typos found by codespell
Signed-off-by: Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
2021-12-15 12:04:36 +01:00
Patrick Donnelly
6e569bfd14
doc: document subvolume (group) pins
Fixes: https://tracker.ceph.com/issues/53236
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-11-11 12:30:02 -05:00