RepoMirrors/go-ceph
1
0
Fork 0
mirror of https://github.com/ceph/go-ceph synced 2024-12-19 04:45:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add new rbd admin functions to api-status (post rebase)

Browse Source 
While working on this patch series new APIs were added to the rbd/admin
package. This patch includes them in the initial set of apis being
tracked.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2021-09-30 08:55:27 -04:00 committed by mergify[bot]
parent 3f32efcf56
commit 3fef124e9d
2 changed files with 71 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/api-status.json
View File

@ -1587,6 +1587,62 @@
"name": "MirrorSnashotScheduleAdmin.Status",
"comment": "Status returns the status of the snapshot (eg. when it will next take place)\nmatching the supplied level spec.\n\nSimilar To:\n rbd mirror snapshot schedule status <level_spec>\n"
}
],
"preview_api": [
{
"name": "NewImageSpec",
"comment": "NewImageSpec is used to construct an ImageSpec given an image name/id\nand optional namespace and pool names.\nNewImageSpec constructs an ImageSpec to identify an RBD image and thus\nrequires image name/id, whereas NewLevelSpec constructs LevelSpec to\nidentify entire pool, pool namespace or single RBD image, all of which\nrequires pool name.\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "NewRawImageSpec",
"comment": "NewRawImageSpec returns a ImageSpec directly based on the spec string\nargument without constructing it from component values. This should only be\nused if NewImageSpec can not create the imagespec value you want to pass to\nceph.\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "RBDAdmin.Task",
"comment": "Task returns a TaskAdmin type for\nmanaging ceph rbd task operations.\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "TaskAdmin.AddFlatten",
"comment": "AddFlatten adds a background task to flatten a cloned image based on the supplied image spec.\n\nSimilar To:\n rbd task add flatten <image_spec>\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "TaskAdmin.AddRemove",
"comment": "AddRemove adds a background task to remove an image based on the supplied image spec.\n\nSimilar To:\n rbd task add remove <image_spec>\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "TaskAdmin.AddTrashRemove",
"comment": "AddTrashRemove adds a background task to remove an image from the trash based on the\nsupplied image id spec.\n\nSimilar To:\n rbd task add trash remove <image_id_spec>\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "TaskAdmin.List",
"comment": "List pending or running asynchronous tasks.\n\nSimilar To:\n rbd task list\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "TaskAdmin.GetTaskByID",
"comment": "GetTaskByID returns pending or running asynchronous task using id.\n\nSimilar To:\n rbd task list <task_id>\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
},
{
"name": "TaskAdmin.Cancel",
"comment": "Cancel a pending or running asynchronous task.\n\nSimilar To:\n rbd task cancel <task_id>\nPREVIEW\n",
"added_in_version": "v0.12.0",
"expected_stable_version": "v0.13.0"
}
]
},
"rgw/admin": {
@ -1674,4 +1730,4 @@
}
]
}
}
}

14
docs/api-status.md
View File

@ -20,6 +20,20 @@ Snapshot.Set | v0.10.0 | |
## Package: rbd/admin
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
NewImageSpec | v0.12.0 | v0.13.0 |
NewRawImageSpec | v0.12.0 | v0.13.0 |
RBDAdmin.Task | v0.12.0 | v0.13.0 |
TaskAdmin.AddFlatten | v0.12.0 | v0.13.0 |
TaskAdmin.AddRemove | v0.12.0 | v0.13.0 |
TaskAdmin.AddTrashRemove | v0.12.0 | v0.13.0 |
TaskAdmin.List | v0.12.0 | v0.13.0 |
TaskAdmin.GetTaskByID | v0.12.0 | v0.13.0 |
TaskAdmin.Cancel | v0.12.0 | v0.13.0 |
## Package: rgw/admin
### Preview APIs