doc: Mgr Dashboard docs update

More instructions on how to deploy the dashboard using ceph-mgr

Signed-off-by: Wido den Hollander <wido@42on.com>

diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst
index 7f837f26dbe41da7199efdacd1db1416c555590b..b200e1349d693e2e630e3cb0aac0fafc37f43f24 100644 (file)
--- a/doc/mgr/dashboard.rst
+++ b/doc/mgr/dashboard.rst
@@ -11,5 +11,22 @@ configuration key facility. So we can configure them like::
   ceph config-key put mgr/dashboard/$name/server_port $PORT
 
 where ``$name`` is the ID of the ceph-mgr who is hosting this dashboard web app.
-If they are not configured, the web app will be bound to ``127.0.0.1:7000``.
 
+These settings can also be configured cluster-wide and not manager specific, eg:
+
+  ceph config-key put mgr/dashboard/server_addr $IP
+  ceph config-key put mgr/dashboard/server_port $PORT
+
+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:
+
+  [mgr]
+  mgr_modules = 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/src/pybind/mgr/dashboard/README.rst b/src/pybind/mgr/dashboard/README.rst
index 1b0276632c2feddfd38919b01ec0138f0ee95b14..b52fea5dc54849bec18f4a5eb6cad91c2c5e792a 100644 (file)
--- a/src/pybind/mgr/dashboard/README.rst
+++ b/src/pybind/mgr/dashboard/README.rst
@@ -33,6 +33,13 @@ Add this to your ceph.conf on nodes where you run ceph-mgr:
 
 If you use any other ceph-mgr modules, make sure they're in the list too.
 
+An address where the dashboard will listen on needs to be configured as well, set this to ``::`` to listen on all
+IPv4 and IPv6 addresses.
+
+::
+
+    ceph config-key put mgr/dashboard/server_addr ::
+
 Restart the ceph-mgr daemon after modifying the setting to load the module.
 
 Accessing