From 289f5ed0931fb0335d212184485b421d37f87507 Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Tue, 27 Jun 2017 16:00:26 -0400 Subject: [PATCH] doc: update docs for enabling mgr modules Signed-off-by: Sage Weil --- doc/mgr/administrator.rst | 6 ------ doc/mgr/dashboard.rst | 6 ++---- doc/mgr/plugins.rst | 9 +++------ doc/release-notes.rst | 5 +++++ src/pybind/mgr/dashboard/README.rst | 9 +++++---- 5 files changed, 15 insertions(+), 20 deletions(-) diff --git a/doc/mgr/administrator.rst b/doc/mgr/administrator.rst index e636c80ed86..5b900c0e8f3 100644 --- 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: ``"/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 b200e1349d6..8a3f8579379 100644 --- 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 89f74469b74..b5a13cc3ead 100644 --- 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 66cfe0330a1..3a335e5881e 100644 --- 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} `` 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 `` 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 b52fea5dc54..34158849c9e 100644 --- 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. -- 2.39.5