]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
docs: set, get, list and remove custom metadata for snapshot
authorNikhilkumar Shelke <nshelke@redhat.com>
Wed, 27 Apr 2022 16:41:07 +0000 (22:11 +0530)
committerNikhilkumar Shelke <nshelke@redhat.com>
Thu, 16 Jun 2022 11:33:11 +0000 (17:03 +0530)
commitdf8e2383f676a3b1e7bea54e9667fad702954ed2
treec0f79e18f01b3e6de9a93463d63fb9991b9d7b0e
parent7b6b456a628a10f8dd73c3afaf7d79f97e7f1514
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>
(cherry picked from commit 59a0cbc14bf2832080e983729de5c462ddc70bb3)
doc/cephfs/fs-volumes.rst