RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
go-ceph/docs/api-status.md

88 lines
2.7 KiB
Markdown
Raw Normal View History

docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
<!-- GENERATED FILE: DO NOT EDIT DIRECTLY -->
# go-ceph API Stability
## Package: cephfs
cephfs: promote some file apis to stable Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-10-03 14:12:10 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
contrib/apiage: Do not leave empty sections for packages in markdown For those packages without any preview/deprecated APIs we used to include a header despite any content under it. We could instead mention the state in a meaningful sentence. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2022-08-06 09:09:18 +00:00
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: cephfs/admin
cephfs/admin: API for quiesceing io on a cephfs cephfs has new quiesce feature for cephfs volume. This change add the feature to go-ceph. Signed-off-by: Manish <myathnal@redhat.com>
2024-02-08 03:28:38 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
docs: fix version numbers for apis added prior to v0.27 Signed-off-by: John Mulligan <jmulligan@redhat.com>
2024-04-08 14:06:06 +00:00
FSAdmin.FSQuiesce | v0.27.0 | v0.29.0 |
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-20 18:01:44 +00:00
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: rados
rados: read & write op exec added Signed-off-by: Vladimir Kavlakan <vkavlakan@gmail.com>
2024-05-15 10:49:37 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
ReadOpExecStep.Bytes | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
ReadOp.Exec | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
WriteOp.Exec | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
rados: implement binding for rados_write_op_cmpext This commit implements binding for rados_write_op_cmpext RADOS Write operation. Includes a unit test. Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2021-09-27 12:08:50 +00:00
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: rbd
librbd exposes rbd_resize2, which allows clients to pass in a boolean controlling whether or not the allocation should be allowed to shrink, and a progress-tracking callback. This contribution extends go-ceph to be able to call rbd_resize2. Closes #933 Signed-off-by: Khayyam Saleem <khayyam.saleem@gmail.com>
2023-11-08 11:09:36 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
docs: fix version numbers for apis added prior to v0.27 Signed-off-by: John Mulligan <jmulligan@redhat.com>
2024-04-08 14:06:06 +00:00
Image.GetSnapGroupNamespace | v0.27.0 | v0.29.0 |
rbd: add support for CloneImageByID() RBD image groups can be used to create consistent snapshots of all images that are part of the group. The new rbd_clone4() API makes it possible to create a new RBD image from a single snapshot that was created as part of the group snapshot. Signed-off-by: Niels de Vos <ndevos@ibm.com>
2024-06-21 09:25:37 +00:00
CloneImageByID | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
librbd exposes rbd_resize2, which allows clients to pass in a boolean controlling whether or not the allocation should be allowed to shrink, and a progress-tracking callback. This contribution extends go-ceph to be able to call rbd_resize2. Closes #933 Signed-off-by: Khayyam Saleem <khayyam.saleem@gmail.com>
2023-11-08 11:09:36 +00:00
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
### 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
contrib/apiage: Do not leave empty sections for packages in markdown For those packages without any preview/deprecated APIs we used to include a header despite any content under it. We could instead mention the state in a meaningful sentence. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2022-08-06 09:09:18 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: rgw/admin
rgw/admin: Promote {Get,Set}BucketQuota APIs to stable Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2024-06-07 13:48:33 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
docs: add common/admin/manager to API docs These APIs already existed, and were considered stable in cephfs/admin before getting moved. I initially was going to mark them preview but then realized that cephfs/admin depends on them and having them marked preview with the ceph_preview tag would break cephfs/admin. Due to the above, I think an exception to the policy is warranted here as there is not much new except the package itself. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-01-25 21:07:45 +00:00
## Package: common/admin/manager
contrib/apiage: Do not leave empty sections for packages in markdown For those packages without any preview/deprecated APIs we used to include a header despite any content under it. We could instead mention the state in a meaningful sentence. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2022-08-06 09:09:18 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
common/log: add missing api-status entries Signed-off-by: Sven Anderson <sven@redhat.com>
2022-04-11 21:10:38 +00:00
## Package: common/log
go-ceph: change mature preview APIs to stable Signed-off-by: Sven Anderson <sven@redhat.com>
2022-08-16 11:19:18 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
common/log: add missing api-status entries Signed-off-by: Sven Anderson <sven@redhat.com>
2022-04-11 21:10:38 +00:00
docs: add API statuses for nfs admin api Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-05-17 14:49:12 +00:00
## Package: common/admin/nfs
docs: fix common/admin/nfs section of api-status.md It now reports "No Preview/Deprecated APIs found. All APIs are considered stable." rather than leaving a blank section. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-01-11 14:49:47 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
docs: add new rados/striper package to api status Signed-off-by: John Mulligan <jmulligan@redhat.com>
2024-07-29 19:00:38 +00:00
## Package: rados/striper
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
Striper.Read | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.Stat | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
New | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
NewWithLayout | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.Destroy | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.SetObjectLayoutStripeUnit | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.SetObjectLayoutStripeCount | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.SetObjectLayoutObjectSize | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.Write | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.WriteFull | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.Append | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.Remove | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.Truncate | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.GetXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.SetXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.RmXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
Striper.ListXattrs | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |