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

cephfs admin: mark general mgr module funcs as deprecated 

The versions in cluster/admin/manager should be used instead.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2022-01-30 11:29:08 -05:00 committed by mergify[bot]
parent aaea0f85db
commit f705d41c96
3 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cephfs/admin/mgrmodule.go
View File

@ -8,6 +8,8 @@ const mirroring = "mirroring"
// EnableModule will enable the specified manager module. // EnableModule will enable the specified manager module.
// //
// Deprecated: use the equivalent function in cluster/admin/manager.
//
// Similar To: // Similar To:
// ceph mgr module enable <module> [--force] // ceph mgr module enable <module> [--force]
func (fsa *FSAdmin) EnableModule(module string, force bool) error { func (fsa *FSAdmin) EnableModule(module string, force bool) error {
@ -17,6 +19,8 @@ func (fsa *FSAdmin) EnableModule(module string, force bool) error {
// DisableModule will disable the specified manager module. // DisableModule will disable the specified manager module.
// //
// Deprecated: use the equivalent function in cluster/admin/manager.
//
// Similar To: // Similar To:
// ceph mgr module disable <module> // ceph mgr module disable <module>
func (fsa *FSAdmin) DisableModule(module string) error { func (fsa *FSAdmin) DisableModule(module string) error {

14
docs/api-status.json
View File

@ -495,6 +495,20 @@
"name": "FSAdmin.VolumeStatus", "name": "FSAdmin.VolumeStatus",
"comment": "VolumeStatus returns a VolumeStatus object for the given volume name.\n\nSimilar To:\n ceph fs status cephfs <name>\n" "comment": "VolumeStatus returns a VolumeStatus object for the given volume name.\n\nSimilar To:\n ceph fs status cephfs <name>\n"
} }
],
"deprecated_api": [
{
"name": "FSAdmin.EnableModule",
"comment": "EnableModule will enable the specified manager module.\n\nDeprecated: use the equivalent function in cluster/admin/manager.\n\nSimilar To:\n ceph mgr module enable <module> [--force]\n",
"deprecated_in_version": "v0.14.0",
"expected_remove_version": "v0.16.0"
},
{
"name": "FSAdmin.DisableModule",
"comment": "DisableModule will disable the specified manager module.\n\nDeprecated: use the equivalent function in cluster/admin/manager.\n\nSimilar To:\n ceph mgr module disable <module>\n",
"deprecated_in_version": "v0.14.0",
"expected_remove_version": "v0.16.0"
}
] ]
}, },
"rados": { "rados": {

7
docs/api-status.md
View File

@ -6,6 +6,13 @@
## Package: cephfs/admin ## Package: cephfs/admin
### Deprecated APIs
Name | Deprecated in Version | Expected Removal Version |
---- | --------------------- | ------------------------ |
FSAdmin.EnableModule | v0.14.0 | v0.16.0 |
FSAdmin.DisableModule | v0.14.0 | v0.16.0 |
## Package: rados ## Package: rados
### Preview APIs ### Preview APIs