]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: mgr/dashboard.rst: mention ceph.conf and ceph mgr services
authorNathan Cutler <ncutler@suse.com>
Mon, 19 Mar 2018 13:21:14 +0000 (14:21 +0100)
committerNathan Cutler <ncutler@suse.com>
Tue, 27 Mar 2018 19:43:25 +0000 (21:43 +0200)
Also break down the "Configuration" section into three separate sub-sections
for clarity.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
doc/mgr/dashboard.rst

index 9030056ff1eea4ea3bb061c8053339ed679eb6fb..a863e2e6bf6e5bd295fc193c453ba05fc831e8f9 100644 (file)
@@ -38,9 +38,17 @@ The *dashboard* module is enabled with::
 
   ceph mgr module enable dashboard
 
+This can be automated (e.g. during deployment) by adding the following to ceph.conf::
+
+  [mon]
+          mgr initial modules = dashboard
+
 Configuration
 -------------
 
+Host name and port
+^^^^^^^^^^^^^^^^^^
+
 Like most web applications, dashboard binds to a host name and port.
 By default, the ``ceph-mgr`` daemon hosting the dashboard (i.e., the
 currently active manager) will bind to port 7000 and any available
@@ -66,6 +74,13 @@ If the port is not configured, the web app will bind to port ``7000``.
 If the address it not configured, the web app will bind to ``::``,
 which corresponds to all available IPv4 and IPv6 addresses.
 
+If in doubt which URL to use to access the dashboard, the ``ceph mgr services``
+command will show the endpoints currently configured (look for the "dashboard"
+key).
+
+Username and password
+^^^^^^^^^^^^^^^^^^^^^
+
 In order to be able to log in, you need to define a username and password, which
 will be stored in the MON's configuration database::
 
@@ -74,6 +89,9 @@ will be stored in the MON's configuration database::
 The password will be stored in the configuration database in encrypted form
 using ``bcrypt``. This is a global setting that applies to all dashboard instances.
 
+Accessing the dashboard
+^^^^^^^^^^^^^^^^^^^^^^^
+
 You can now access the dashboard using your (JavaScript-enabled) web browser, by
 pointing it to the selected TCP port and any of the host names or IP addresses
 where a manager instance runs on, e.g. ``http://<$IP>:<$PORT>/``.
@@ -95,4 +113,4 @@ to use hyperlinks that include your prefix, you can set the
 
   ceph config-key set mgr/dashboard/url_prefix $PREFIX
 
-so you can access the dashboard at ``http://$IP:$PORT/$PREFIX/``.
\ No newline at end of file
+so you can access the dashboard at ``http://$IP:$PORT/$PREFIX/``.