RepoMirrors/go-ceph
1
0
Fork 0
mirror of https://github.com/ceph/go-ceph synced 2024-12-22 06:10:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

cephfs/admin: Make subvolume snapshot metadata APIs stable

Browse Source 
Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
This commit is contained in:
Anoop C S 2023-06-08 11:11:52 +05:30 committed by mergify[bot]
parent c2e03fe3bb
commit 37b9a31fd0
4 changed files with 34 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cephfs/admin/snapshot_metadata.go
View File

@ -1,5 +1,5 @@
//go:build !(nautilus || octopus || pacific) && ceph_preview
// +build !nautilus,!octopus,!pacific,ceph_preview
//go:build !(nautilus || octopus || pacific)
// +build !nautilus,!octopus,!pacific
package admin

4
cephfs/admin/snapshot_metadata_test.go
View File

@ -1,5 +1,5 @@
//go:build !(nautilus || octopus || pacific) && ceph_preview
// +build !nautilus,!octopus,!pacific,ceph_preview
//go:build !(nautilus || octopus || pacific)
// +build !nautilus,!octopus,!pacific
package admin

60
docs/api-status.json
View File

@ -564,6 +564,36 @@
"comment": "ListMetadata lists custom metadata (key-value pairs) set on the subvolume\nin a volume belonging to an optional subvolume group.\n\nSimilar To:\n\n\tceph fs subvolume metadata ls <vol_name> <sub_name> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"became_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.GetSnapshotMetadata",
"comment": "GetSnapshotMetadata gets custom metadata on the subvolume snapshot in a\nvolume belonging to an optional subvolume group based on provided key name.\n\nSimilar To:\n\n\tceph fs subvolume snapshot metadata get <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"became_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.SetSnapshotMetadata",
"comment": "SetSnapshotMetadata sets custom metadata on the subvolume snapshot in a\nvolume belonging to an optional subvolume group as a key-value pair.\n\nSimilar To:\n\n\tceph fs subvolume snapshot metadata set <vol_name> <sub_name> <snap_name> <key_name> <value> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"became_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.RemoveSnapshotMetadata",
"comment": "RemoveSnapshotMetadata removes custom metadata set on the subvolume\nsnapshot in a volume belonging to an optional subvolume group using the\nmetadata key.\n\nSimilar To:\n\n\tceph fs subvolume snapshot metadata rm <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"became_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.ForceRemoveSnapshotMetadata",
"comment": "ForceRemoveSnapshotMetadata attempt to forcefully remove custom metadata\nset on the subvolume snapshot in a volume belonging to an optional\nsubvolume group using the metadata key.\n\nSimilar To:\n\n\tceph fs subvolume snapshot metadata rm <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>] --force\n",
"added_in_version": "v0.20.0",
"became_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.ListSnapshotMetadata",
"comment": "ListSnapshotMetadata lists custom metadata (key-value pairs) set on the subvolume\nsnapshot in a volume belonging to an optional subvolume group.\n\nSimilar To:\n\n\tceph fs subvolume snapshot metadata ls <vol_name> <sub_name> <snap_name> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"became_stable_version": "v0.22.0"
}
],
"deprecated_api": [
@ -575,36 +605,6 @@
}
],
"preview_api": [
{
"name": "FSAdmin.GetSnapshotMetadata",
"comment": "GetSnapshotMetadata gets custom metadata on the subvolume snapshot in a\nvolume belonging to an optional subvolume group based on provided key name.\n\nSimilar To:\n ceph fs subvolume snapshot metadata get <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.SetSnapshotMetadata",
"comment": "SetSnapshotMetadata sets custom metadata on the subvolume snapshot in a\nvolume belonging to an optional subvolume group as a key-value pair.\n\nSimilar To:\n ceph fs subvolume snapshot metadata set <vol_name> <sub_name> <snap_name> <key_name> <value> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.RemoveSnapshotMetadata",
"comment": "RemoveSnapshotMetadata removes custom metadata set on the subvolume\nsnapshot in a volume belonging to an optional subvolume group using the\nmetadata key.\n\nSimilar To:\n ceph fs subvolume snapshot metadata rm <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.ForceRemoveSnapshotMetadata",
"comment": "ForceRemoveSnapshotMetadata attempt to forcefully remove custom metadata\nset on the subvolume snapshot in a volume belonging to an optional\nsubvolume group using the metadata key.\n\nSimilar To:\n ceph fs subvolume snapshot metadata rm <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>] --force\n",
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.ListSnapshotMetadata",
"comment": "ListSnapshotMetadata lists custom metadata (key-value pairs) set on the subvolume\nsnapshot in a volume belonging to an optional subvolume group.\n\nSimilar To:\n ceph fs subvolume snapshot metadata ls <vol_name> <sub_name> <snap_name> [--group_name <subvol_group_name>]\n",
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "FSAdmin.PinSubVolume",
"comment": "PinSubVolume pins subvolume to ranks according to policies. A valid pin\nsetting value depends on the type of pin as described in the docs from\nhttps://docs.ceph.com/en/latest/cephfs/multimds/#cephfs-pinning and\nhttps://docs.ceph.com/en/latest/cephfs/multimds/#setting-subtree-partitioning-policies\n\nSimilar To:\n\n\tceph fs subvolume pin <vol_name> <sub_name> <pin_type> <pin_setting>\n",

5
docs/api-status.md
View File

@ -20,11 +20,6 @@ MountInfo.Futimes | v0.22.0 | v0.24.0 |
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
FSAdmin.GetSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.SetSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.RemoveSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.ForceRemoveSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.ListSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.PinSubVolume | v0.21.0 | v0.23.0 |
FSAdmin.PinSubVolumeGroup | v0.21.0 | v0.23.0 |
FSAdmin.FetchVolumeInfo | v0.21.0 | v0.23.0 |