]>
Commit | Line | Data |
---|---|---|
11fdf7f2 TL |
1 | Ceph Dashboard |
2 | ============== | |
31f18b77 | 3 | |
11fdf7f2 TL |
4 | Overview |
5 | -------- | |
31f18b77 | 6 | |
11fdf7f2 TL |
7 | The Ceph Dashboard is a built-in web-based Ceph management and monitoring |
8 | application to administer various aspects and objects of the cluster. It is | |
9 | implemented as a Ceph Manager module. | |
31f18b77 | 10 | |
11fdf7f2 TL |
11 | Enabling and Starting the Dashboard |
12 | ----------------------------------- | |
31f18b77 | 13 | |
11fdf7f2 TL |
14 | If you want to start the dashboard from within a development environment, you |
15 | need to have built Ceph (see the toplevel ``README.md`` file and the `developer | |
9f95a23c TL |
16 | documentation |
17 | <https://docs.ceph.com/docs/master/dev/developer_guide/#building-from-source>`_ | |
18 | for details on how to accomplish this. | |
31f18b77 | 19 | |
11fdf7f2 TL |
20 | Finally, you need to build the dashboard frontend code. See the file |
21 | ``HACKING.rst`` in this directory for instructions on setting up the necessary | |
22 | development environment. | |
31f18b77 | 23 | |
11fdf7f2 TL |
24 | If you use the ``vstart.sh`` script to start up your development cluster, it |
25 | will configure and enable the dashboard automatically. The URL and login | |
26 | credentials are displayed when the script finishes. | |
31f18b77 | 27 | |
11fdf7f2 | 28 | Please see the `Ceph Dashboard documentation |
9f95a23c | 29 | <https://docs.ceph.com/docs/master/mgr/dashboard/>`_ for details on how to enable |
11fdf7f2 TL |
30 | and configure the dashboard manually and how to configure other settings, e.g. |
31 | access to the Ceph object gateway. | |
31f18b77 | 32 | |
11fdf7f2 TL |
33 | Working on the Dashboard Code |
34 | ----------------------------- | |
31f18b77 | 35 | |
11fdf7f2 TL |
36 | If you're interested in helping with the development of the dashboard, please |
37 | see the file ``HACKING.rst`` for details on how to set up a development | |
38 | environment and other development-related topics. |