RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-02-21 01:47:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: mgr/dashboard.rst: mention ceph.conf and ceph mgr services

Browse Source 
Also break down the "Configuration" section into three separate sub-sections
for clarity.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
This commit is contained in:
Nathan Cutler 2018-03-19 14:21:14 +01:00
parent b2fc3fac30
commit 83d4a3c53f
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/mgr/dashboard.rst
View 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/``.
so you can access the dashboard at ``http://$IP:$PORT/$PREFIX/``.