1
0
mirror of https://github.com/ceph/ceph synced 2024-12-23 20:03:56 +00:00

Merge pull request from smithfarm/wip-dashboard-rst

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

Reviewed-by: Ricardo Dias <rdias@suse.com>
This commit is contained in:
Lenz Grimmer 2018-03-28 14:31:25 +02:00 committed by GitHub
commit 5a65671fbe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -38,9 +38,23 @@ 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
Note that ``mgr initial modules`` takes a space-separated list of modules, so
if you wanted to include other modules in addition to dashboard, just make it
a list like so::
mgr initial modules = balancer 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 +80,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,9 +95,12 @@ 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>/``.
pointing it to any of the host names or IP addresses and the selected TCP port
where a manager instance is running: e.g., ``http://<$IP>:<$PORT>/``.
You should then be greeted by the dashboard login page, requesting your
previously defined username and password. Select the **Keep me logged in**
@ -95,4 +119,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/``.