Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

quincy: mgr/volumes: set, get, list and remove metadata of subvolume #45994

Merged
merged 3 commits into from May 10, 2022
+717 −26
Merged

quincy: mgr/volumes: set, get, list and remove metadata of subvolume #45994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4856a3d
mgr/volumes: set, get, list and remove custom metadata for subvolume
nmshelke Mar 17, 2022
1dab0bd
docs: set, get, list and remove custom metadata for subvolume
nmshelke Mar 23, 2022
26d53df
qa: set, get, list and remove custom metadata for subvolume
nmshelke Mar 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 26 additions & 1 deletion doc/cephfs/fs-volumes.rst
View file
Open in desktop
Expand Up @@ -212,7 +212,7 @@ Fetch the absolute path of a subvolume using::

$ ceph fs subvolume getpath <vol_name> <subvol_name> [--group_name <subvol_group_name>]

Fetch the metadata of a subvolume using::
Fetch the information of a subvolume using::

$ ceph fs subvolume info <vol_name> <subvol_name> [--group_name <subvol_group_name>]

Expand Down Expand Up @@ -260,6 +260,31 @@ List subvolumes using::

.. note:: subvolumes that are removed but have snapshots retained, are also listed.

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.

Create a snapshot of a subvolume using::

$ ceph fs subvolume snapshot create <vol_name> <subvol_name> <snap_name> [--group_name <subvol_group_name>]
Expand Down