diff --git a/cephfs/admin/fsadmin.go b/cephfs/admin/fsadmin.go index 28f39f3..8ff2327 100644 --- a/cephfs/admin/fsadmin.go +++ b/cephfs/admin/fsadmin.go @@ -21,6 +21,9 @@ type FSAdmin struct { // configuration file. If more customization is needed, create a // *rados.Conn as you see fit and use NewFromConn to use that // connection with these administrative functions. +// +// Deprecated: Use NewFromConn instead of New. The New function does not expose +// the rados connection and therefore can not be deterministically cleaned up. func New() (*FSAdmin, error) { conn, err := rados.NewConn() if err != nil { diff --git a/docs/api-status.json b/docs/api-status.json index 18e4246..d90e3cc 100644 --- a/docs/api-status.json +++ b/docs/api-status.json @@ -345,10 +345,6 @@ "name": "FSAdmin.CancelClone", "comment": "CancelClone stops the background processes that populate a clone.\nCancelClone does not delete the clone.\n\nSimilar To:\n ceph fs clone cancel --group_name= \n" }, - { - "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" - }, { "name": "NewFromConn", "comment": "NewFromConn creates an FSAdmin management object from a preexisting\nrados connection. The existing connection can be rados.Conn or any\ntype implementing the RadosCommander interface. This may be useful\nif the calling layer needs to inject additional logging, error handling,\nfault injection, etc.\n" @@ -516,7 +512,14 @@ "became_stable_version": "v0.18.0" } ], - "deprecated_api": [], + "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.GetMetadata", diff --git a/docs/api-status.md b/docs/api-status.md index 3385370..7d70568 100644 --- a/docs/api-status.md +++ b/docs/api-status.md @@ -31,6 +31,12 @@ FSAdmin.PinSubVolume | v0.21.0 | v0.23.0 | FSAdmin.PinSubVolumeGroup | v0.21.0 | v0.23.0 | FSAdmin.FetchVolumeInfo | v0.21.0 | v0.23.0 | +### Deprecated APIs + +Name | Deprecated in Version | Expected Removal Version | +---- | --------------------- | ------------------------ | +New | v0.21.0 | v0.24.0 | + ## Package: rados No Preview/Deprecated APIs found. All APIs are considered stable.