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>
This commit is contained in:
John Mulligan 2022-01-25 16:07:45 -05:00 committed by mergify[bot]
parent f27408f8bf
commit aaea0f85db
2 changed files with 30 additions and 1 deletions

View File

@ -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 <module> [--force]\n"
},
{
"name": "MgrAdmin.DisableModule",
"comment": "DisableModule will disable the specified manager module.\n\nSimilar To:\n ceph mgr module disable <module>\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"
}
]
}
}
}

View File

@ -37,3 +37,5 @@ Snapshot.Set | v0.10.0 | |
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
## Package: common/admin/manager