From aaea0f85dbe6a1d156ce0fea4e8471d0ebd88a76 Mon Sep 17 00:00:00 2001 From: John Mulligan Date: Tue, 25 Jan 2022 16:07:45 -0500 Subject: [PATCH] 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 --- docs/api-status.json | 29 ++++++++++++++++++++++++++++- docs/api-status.md | 2 ++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/api-status.json b/docs/api-status.json index 9e517e1..e2561f4 100644 --- a/docs/api-status.json +++ b/docs/api-status.json @@ -1740,5 +1740,32 @@ "comment": "RemoveUserCap removes the capabilities from a user.\nOn Success, it returns the updated list of UserCaps for the user.\n" } ] + }, + "common/admin/manager": { + "name": "common/admin/manager", + "summary": { + "total": 0, + "found": 0, + "missing": 0, + "deprecated": 0 + }, + "stable_api": [ + { + "name": "NewFromConn", + "comment": "NewFromConn creates an new management object from a preexisting\nrados connection. The existing connection can be rados.Conn or any\ntype implementing the RadosCommander interface.\n" + }, + { + "name": "MgrAdmin.EnableModule", + "comment": "EnableModule will enable the specified manager module.\n\nSimilar To:\n ceph mgr module enable [--force]\n" + }, + { + "name": "MgrAdmin.DisableModule", + "comment": "DisableModule will disable the specified manager module.\n\nSimilar To:\n ceph mgr module disable \n" + }, + { + "name": "MgrAdmin.ListModules", + "comment": "ListModules returns a module info struct reporting the lists of\nenabled, disabled, and always-on modules in the Ceph mgr.\n" + } + ] } -} \ No newline at end of file +} diff --git a/docs/api-status.md b/docs/api-status.md index 3802c6f..52b9455 100644 --- a/docs/api-status.md +++ b/docs/api-status.md @@ -37,3 +37,5 @@ Snapshot.Set | v0.10.0 | | Name | Added in Version | Expected Stable Version | ---- | ---------------- | ----------------------- | +## Package: common/admin/manager +