Skip to content

Commit

Permalink
cephfs/admin: Make subvolume snapshot metadata APIs stable
Browse files Browse the repository at this point in the history
Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
  • Loading branch information
anoopcs9 authored and mergify[bot] committed Jun 8, 2023
1 parent c2e03fe commit 37b9a31
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 31 deletions.
4 changes: 2 additions & 2 deletions cephfs/admin/snapshot_metadata.go
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions cephfs/admin/snapshot_metadata_test.go
Original file line number Diff line number Diff line change
@@ -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

Expand Down
44 changes: 22 additions & 22 deletions docs/api-status.json
Original file line number Diff line number Diff line change
Expand Up @@ -564,47 +564,47 @@
"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"
}
],
"deprecated_api": [
{
"name": "New",
"comment": "New creates an FSAdmin automatically based on the default ceph\nconfiguration file. If more customization is needed, create a\n*rados.Conn as you see fit and use NewFromConn to use that\nconnection with these administrative functions.\n\nDeprecated: Use NewFromConn instead of New. The New function does not expose\nthe rados connection and therefore can not be deterministically cleaned up.\n",
"deprecated_in_version": "v0.21.0",
"expected_remove_version": "v0.24.0"
}
],
"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",
"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",
"expected_stable_version": "v0.22.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 ceph fs subvolume snapshot metadata set <vol_name> <sub_name> <snap_name> <key_name> <value> [--group_name <subvol_group_name>]\n",
"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",
"expected_stable_version": "v0.22.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 ceph fs subvolume snapshot metadata rm <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>]\n",
"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",
"expected_stable_version": "v0.22.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 ceph fs subvolume snapshot metadata rm <vol_name> <sub_name> <snap_name> <key_name> [--group_name <subvol_group_name>] --force\n",
"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",
"expected_stable_version": "v0.22.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 ceph fs subvolume snapshot metadata ls <vol_name> <sub_name> <snap_name> [--group_name <subvol_group_name>]\n",
"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",
"expected_stable_version": "v0.22.0"
},
"became_stable_version": "v0.22.0"
}
],
"deprecated_api": [
{
"name": "New",
"comment": "New creates an FSAdmin automatically based on the default ceph\nconfiguration file. If more customization is needed, create a\n*rados.Conn as you see fit and use NewFromConn to use that\nconnection with these administrative functions.\n\nDeprecated: Use NewFromConn instead of New. The New function does not expose\nthe rados connection and therefore can not be deterministically cleaned up.\n",
"deprecated_in_version": "v0.21.0",
"expected_remove_version": "v0.24.0"
}
],
"preview_api": [
{
"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",
Expand Down
5 changes: 0 additions & 5 deletions docs/api-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down

0 comments on commit 37b9a31

Please sign in to comment.