Bug 2095987

Summary: [Doc RFE]Adding metadata info to subvolume is missing
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Amarnath <amk>
Component: DocumentationAssignee: Ranjini M N <rmandyam>
Documentation sub component: File System Guide QA Contact: Amarnath <amk>
Status: CLOSED CURRENTRELEASE Docs Contact: Akash Raj <akraj>
Severity: high    
Priority: unspecified CC: akraj, rmandyam
Version: 5.2   
Target Milestone: ---   
Target Release: 5.3   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-01-19 15:33:22 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Amarnath 2022-06-11 16:00:43 UTC
Describe the issue:
Adding metadata info to subvolume is missing

Describe the task you were trying to accomplish:
we have feature for adding metadata info to subvolume.
Documentation is missing for this feature

Suggestions for improvement:

List of commands for the feature:
Listing Meta Data Info : 
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata ls cephfs subvol_1 --group_name subvolgroup_1
{}

Adding Metadata info for subvolume
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata set cephfs subvol_1 test_meta fsid --group_name subvolgroup_1
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata ls cephfs subvol_1 --group_name subvolgroup_1
{
    "test_meta": "fsid"
}
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata get cephfs subvol_1 test_meta --group_name subvolgroup_1
fsid

Adding metadata info with space in key 
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata set cephfs subvol_1 "test meta" fsid --group_name subvolgroup_1
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata ls cephfs subvol_1 --group_name subvolgroup_1
{
    "test meta": "fsid",
    "test_meta": "fsid"
}
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata get cephfs subvol_1 test meta --group_name subvolgroup_1
Invalid command: unused arguments: ['--group_name', 'subvolgroup_1']
fs subvolume metadata get <vol_name> <sub_name> <key_name> [<group_name>] :  Get custom metadata associated with the key of a CephFS subvolume in a volume, and optionally, in a specific subvolume group
Error EINVAL: invalid command
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata get cephfs subvol_1 "test meta" --group_name subvolgroup_1
fsid

Removing Metadata from the subvolume
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata rm cephfs subvol_1 "test meta" --group_name subvolgroup_1
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata ls cephfs subvol_1 --group_name subvolgroup_1
{
    "test_meta": "fsid"
}

Removing metadata which is not present
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata rm cephfs subvol_1 "test meta" --group_name subvolgroup_1
Error ENOENT: key 'test meta' does not exist.
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata rm cephfs subvol_1 "test meta" --group_name subvolgroup_1 --force
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]#

Setting same metadata twice
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata set cephfs subvol_1 "test_meta" fsid --group_name subvolgroup_1
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata ls cephfs subvol_1 --group_name subvolgroup_1
{
    "test_meta": "fsid"
}

Setting the same metadata with different value
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata set cephfs subvol_1 "test_meta" fsid2 --group_name subvolgroup_1
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph fs subvolume metadata ls cephfs subvol_1 --group_name subvolgroup_1
{
    "test_meta": "fsid2"
}
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# 

Ceph versions
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# ceph versions
{
    "mon": {
        "ceph version 16.2.8-31.el8cp (987e514460fd87ce0ea9f17fb81b8e2338a44215) pacific (stable)": 3
    },
    "mgr": {
        "ceph version 16.2.8-31.el8cp (987e514460fd87ce0ea9f17fb81b8e2338a44215) pacific (stable)": 2
    },
    "osd": {
        "ceph version 16.2.8-31.el8cp (987e514460fd87ce0ea9f17fb81b8e2338a44215) pacific (stable)": 12
    },
    "mds": {
        "ceph version 16.2.8-31.el8cp (987e514460fd87ce0ea9f17fb81b8e2338a44215) pacific (stable)": 3
    },
    "overall": {
        "ceph version 16.2.8-31.el8cp (987e514460fd87ce0ea9f17fb81b8e2338a44215) pacific (stable)": 20
    }
}
[root@ceph-amk-bz-2-v3o9mx-node7 volumes]# 


Document URL:

Chapter/Section Number and Title:

Product Version: 5.

Environment Details:

Any other versions of this document that also needs this update:

Additional information:

Comment 4 Amarnath 2022-09-08 04:48:51 UTC
Hi Ranjini,

Few changes to the examples:

4.4.3. Listing custom metadata on the file system subvolume

	Example has 
		 ceph fs subvolume metadata get cephfs sub0 test --group_name subgroup0
    Should be 
		 ceph fs subvolume metadata ls cephfs sub0 test --group_name subgroup0
		 
		 
4.4.4. Removing custom metadata from the file system subvolume

Actual : ceph fs subvolume metadata get cephfs sub0 test --group_name subgroup0
	
Expected : ceph fs subvolume metadata ls cephfs sub0 test --group_name subgroup

Regards,
Amarnath

Comment 6 Amarnath 2022-09-12 09:07:44 UTC
Hi Ranjini,

The updated document looks good.

Regards,
Amarnath