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

docs: fix api versions for new rbd migration apis 

As of d6bf51115d we've tried to make API
stability less burdensome on contributors by putting in placeholder
values in the status files. However, we haven't used it much yet. This
change executes `make api-fix-versions` in order to convert
the placeholder versions into real version numbers - both for the
real reason of tracking the values and also for a more real world test
of the apiage feature.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2023-01-11 09:50:58 -05:00 committed by mergify[bot]
parent 64d5ab403b
commit 122159ed21
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/api-status.json
View File

@ -1679,38 +1679,38 @@
{
"name": "MigrationPrepare",
"comment": "MigrationPrepare prepares a migration\ncreating a target image with a link\nto source and making source read-only.\n\nImplements:\n int rbd_migration_prepare(rados_ioctx_t ioctx,\n const char *image_name,\n rados_ioctx_t dest_ioctx,\n const char *dest_image_name,\n rbd_image_options_t opts);\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "MigrationPrepareImport",
"comment": "MigrationPrepareImport prepares a migration for import\nfrom a specified source to a new target image.\n\nImplements:\n int rbd_migration_prepare_import(const char *source_spec,\n rados_ioctx_t dest_ioctx,\n const char *dest_image_name,\n rbd_image_options_t opts);\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "MigrationExecute",
"comment": "MigrationExecute starts copying the image blocks\nfrom the source image to the target image.\n\nImplements:\n int rbd_migration_execute(rados_ioctx_t ioctx,\n const char *image_name);\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "MigrationCommit",
"comment": "MigrationCommit commits a migration after execution\nbreaking the relationship of image to the source.\n\nImplements:\n int rbd_migration_commit(rados_ioctx_t ioctx,\n const char *image_name);\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "MigrationAbort",
"comment": "MigrationAbort aborts a migration in progress\nbreaking the relationship of image to the source.\n\nImplements:\n int rbd_migration_abort(rados_ioctx_t ioctx,\n const char *image_name);\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "MigrationStatus",
"comment": "MigrationStatus retrieve status of a live migration\nfor the specified image.\n\nImplements:\n int rbd_migration_status(rados_ioctx_t ioctx,\n const char *image_name,\n rbd_image_migration_status_t *status,\n size_t status_size);\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
}
]
},

12
docs/api-status.md
View File

@ -20,12 +20,12 @@ No Preview/Deprecated APIs found. All APIs are considered stable.
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
MigrationPrepare | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
MigrationPrepareImport | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
MigrationExecute | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
MigrationCommit | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
MigrationAbort | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
MigrationStatus | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
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 |
### Deprecated APIs