quincy: mgr/volumes: set, get, list and remove metadata of subvolume #45994
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If CephFS in ODF configured in external mode, user like to use
volume / subvolume metadata to store some Openshift specific
information, as the PVC / PV / namespace the volumes / subvolumes
are coming from. For RBD volumes, it's possible to add metadata
information to the images using the 'rbd image-meta' command.
However, this feature is not available for CephFS volumes.
We'd like to request this capability.
Adding following commands:
ceph fs subvolume metadata set <vol_name> <sub_name> <key_name> <value> [<group_name>]
ceph fs subvolume metadata get <vol_name> <sub_name> <key_name> [<group_name>]
ceph fs subvolume metadata ls <vol_name> <sub_name> [<group_name>]
ceph fs subvolume metadata rm <vol_name> <sub_name> <key_name> [<group_name>] [--force]
Fixes: https://tracker.ceph.com/issues/54472
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
(cherry picked from commit fb88651)
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>
(cherry picked from commit 88adfe9)
Following test are added: 1. Set custom metadata for subvolume. 2. Set custom metadata for subvolume(Idempotency). 3. Get custom metadata for specified key. 4. Get custom metadata if specified key not exist (Expecting error ENOENT). 5. Get custom metadata if no any key-value is added means section not exist (Expecting error ENOENT). 6. Update value for existing key in custom metadata. 7. List custom metadata of subvolume. 8. List custom metadata of subvolume if no any key-value is added (Expect empty json/dictionary) 9. Remove custom metadata for specified key. 10. Remove custom metadata if specified key not exist (Expecting error ENOENT). 11. Remove custom metadata if no any key-value is added means section not exist (Expecting error ENOENT). 12. Remove custom metadata with --force option. 13. Remove custom metadata with --force option if specified key not exist (Expecting command to succeed because of '--force' option) 14. Set and Get custom metadata for legacy subvolume. 15. List and Remove custom metadata from legacy subvolume. Fixes: https://tracker.ceph.com/issues/54472 Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com> (cherry picked from commit d1f4ecd)
vshankar
approved these changes
May 10, 2022
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
backport tracker: https://tracker.ceph.com/issues/55376
backport of #45603
parent tracker: https://tracker.ceph.com/issues/54472
this backport was staged using ceph-backport.sh version 16.0.0.6848
find the latest version at https://github.com/ceph/ceph/blob/master/src/script/ceph-backport.sh