go-ceph/docs/api-status.md
John Mulligan ad61049254 cephfs admin: deprecate the New function
The New function created a rados connection object but did not expose it
via a public api, making it impossible to deterministically sever / clean up
the connection. This commit assumes that the patch will be merged prior
to the go-ceph v0.21 release so that we can plan to remove the function
three versions later (v0.24).  I chose three versions so that it is one
release longer than our typical stabilization period as this function
has been around for a while.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-03-27 17:55:51 +00:00

3.1 KiB

go-ceph API Stability

Package: cephfs

Preview APIs

Name Added in Version Expected Stable Version
MountInfo.SelectFilesystem v0.20.0 v0.22.0
MountInfo.MakeDirs v0.21.0 v0.23.0

Package: cephfs/admin

Preview APIs

Name Added in Version Expected Stable Version
FSAdmin.GetMetadata v0.20.0 v0.22.0
FSAdmin.SetMetadata v0.20.0 v0.22.0
FSAdmin.RemoveMetadata v0.20.0 v0.22.0
FSAdmin.ForceRemoveMetadata v0.20.0 v0.22.0
FSAdmin.ListMetadata v0.20.0 v0.22.0
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

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.

Package: rbd

Preview APIs

Name Added in Version Expected Stable Version
MigrationPrepare v0.20.0 v0.22.0
MigrationPrepareImport v0.20.0 v0.22.0
MigrationExecute v0.20.0 v0.22.0
MigrationCommit v0.20.0 v0.22.0
MigrationAbort v0.20.0 v0.22.0
MigrationStatus v0.20.0 v0.22.0
SiteMirrorImageStatus.UnmarshalDescriptionJSON v0.21.0 v0.23.0
SiteMirrorImageStatus.DescriptionReplayStatus v0.21.0 v0.23.0
AddMirrorPeerSite $NEXT_RELEASE $NEXT_RELEASE_STABLE
RemoveMirrorPeerSite $NEXT_RELEASE $NEXT_RELEASE_STABLE
GetAttributesMirrorPeerSite $NEXT_RELEASE $NEXT_RELEASE_STABLE
SetAttributesMirrorPeerSite $NEXT_RELEASE $NEXT_RELEASE_STABLE
ListMirrorPeerSite $NEXT_RELEASE $NEXT_RELEASE_STABLE
SetMirrorPeerSiteClientName $NEXT_RELEASE $NEXT_RELEASE_STABLE
SetMirrorPeerSiteName $NEXT_RELEASE $NEXT_RELEASE_STABLE
SetMirrorPeerSiteDirection $NEXT_RELEASE $NEXT_RELEASE_STABLE

Deprecated APIs

Name Deprecated in Version Expected Removal Version
MirrorImageGlobalStatusIter.Close v0.11.0
Image.Open v0.2.0
Snapshot.Set v0.10.0

Package: rbd/admin

No Preview/Deprecated APIs found. All APIs are considered stable.

Package: rgw/admin

Preview APIs

Name Added in Version Expected Stable Version
API.ListBucketsWithStat v0.20.0 v0.22.0

Package: common/admin/manager

No Preview/Deprecated APIs found. All APIs are considered stable.

Package: common/log

No Preview/Deprecated APIs found. All APIs are considered stable.

Package: common/admin/nfs

No Preview/Deprecated APIs found. All APIs are considered stable.