doc: update docs for enabling mgr modules

Signed-off-by: Sage Weil <sage@redhat.com>

diff --git a/doc/mgr/administrator.rst b/doc/mgr/administrator.rst
index e636c80ed86385af4ab67e06cf1e01a5b9ec272d..5b900c0e8f32a59c8d4884e20f1ffdd16628cc39 100644 (file)
--- a/doc/mgr/administrator.rst
+++ b/doc/mgr/administrator.rst
@@ -76,12 +76,6 @@ OPTION(mgr_module_path, OPT_STR, CEPH_PKGLIBDIR "/mgr") // where to load python
 :Type: String
 :Default: ``"<library dir>/mgr"``
 
-``mgr modules``
-
-:Description: List of python modules to load
-:Type: String
-:Default: ``"rest"`` (Load the REST API module only)
-
 ``mgr data``
 
 :Description: Path to load daemon data (such as keyring)

diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst
index b200e1349d693e2e630e3cb0aac0fafc37f43f24..8a3f8579379b73de3a3bddf658f92c8822b1af8d 100644 (file)
--- a/doc/mgr/dashboard.rst
+++ b/doc/mgr/dashboard.rst
@@ -22,11 +22,9 @@ If the port is not configured, the web app will bind to port ``7000``.
 Setting the IP to ``::`` makes the dashboard bind to all available IPv4 and IPv6
 addresses.
 
-In addition, make sure that the *dashboard* module is enabled in the ceph.conf
-configuration file:
+In addition, make sure that the *dashboard* module is enabled with::
 
-  [mgr]
-  mgr_modules = dashboard
+  ceph mgr module enable dashboard
 
 Please note that the dashboard will *only* start on the manager which is active
 at that moment. Query the Ceph cluster status to see which manager is active.

diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst
index 89f74469b7470b8ab06d8640789a5834b9b3c45a..b5a13cc3eada1b9ef4964b880a2c1cae706ad229 100644 (file)
--- a/doc/mgr/plugins.rst
+++ b/doc/mgr/plugins.rst
@@ -21,13 +21,10 @@ Installing a plugin
 -------------------
 
 Once your module is present in the location set by the
-``mgr module path`` configuration setting, add its name
-to the ``mgr modules`` configuration setting and restart the ceph-mgr
-daemon to load it.
+``mgr module path`` configuration setting, you can enable it
+via the ``ceph mgr module enable`` command::
 
-If you're working within a Ceph vstart cluster then your module
-should be found in the default pybind/mgr location, and you only
-have to add it to ``mgr modules`` to get it loaded.
+  ceph mgr module enable mymodule
 
 Note that the MgrModule interface is not stable, so any modules maintained
 outside of the Ceph tree are liable to break when run against any newer

diff --git a/doc/release-notes.rst b/doc/release-notes.rst
index 66cfe0330a1830a3d6546cc0e01114ed0ff50b84..3a335e5881ed02fd28947d4517a321d7c2ce8ab0 100644 (file)
--- a/doc/release-notes.rst
+++ b/doc/release-notes.rst
@@ -195,6 +195,11 @@ Major Changes from Kraken
       log.
     - ``ceph mgr dump`` will dump the MgrMap, including the currently active
       ceph-mgr daemon and any standbys.
+    - ``ceph mgr module ls`` will list active ceph-mgr modules.
+    - ``ceph mgr module {enable,disable} <name>`` will enable or
+      disable the named mgr module.  The module must be present in the
+      configured `mgr_module_path` on the host(s) where `ceph-mgr` is
+      running.
     - ``ceph osd crush swap-bucket <src> <dest>`` will swap the
       contents of two CRUSH buckets in the hierarchy while preserving
       the buckets' ids.  This allows an entire subtree of devices to

diff --git a/src/pybind/mgr/dashboard/README.rst b/src/pybind/mgr/dashboard/README.rst
index b52fea5dc54849bec18f4a5eb6cad91c2c5e792a..34158849c9e6852d6f371cce8517c822b088a89d 100644 (file)
--- a/src/pybind/mgr/dashboard/README.rst
+++ b/src/pybind/mgr/dashboard/README.rst
@@ -24,12 +24,13 @@ If you had already enabled the module, restart ceph-mgr after installing depende
 Enabling
 ========
 
-Add this to your ceph.conf on nodes where you run ceph-mgr:
+Enable the module with::
 
-::
+  ceph mgr module enable dashboard
+
+You can see currently enabled modules with::
 
-    [mgr]                                                                           
-        mgr modules = dashboard
+  ceph mgr module ls
 
 If you use any other ceph-mgr modules, make sure they're in the list too.