projects / ceph.git / blame
| 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 | |
| f67539c2 TL |
16 | documentation <https://ceph.readthedocs.io/en/latest/dev/quick_guide/>`_ for |
| 17 | details on how to accomplish this. | |
| 31f18b77 | 18 | |
| 11fdf7f2 TL |
19 | If you use the ``vstart.sh`` script to start up your development cluster, it |
| 20 | will configure and enable the dashboard automatically. The URL and login | |
| 21 | credentials are displayed when the script finishes. | |
| 31f18b77 | 22 | |
| 11fdf7f2 | 23 | Please see the `Ceph Dashboard documentation |
| f67539c2 TL |
24 | <https://ceph.readthedocs.io/en/latest/mgr/dashboard/>`_ for details on how to |
| 25 | enable and configure the dashboard manually and how to configure other settings, | |
| 26 | e.g. access to the Ceph object gateway. | |
| 31f18b77 | 27 | |
| 11fdf7f2 TL |
28 | Working on the Dashboard Code |
| 29 | ----------------------------- | |
| 31f18b77 | 30 | |
| 11fdf7f2 | 31 | If you're interested in helping with the development of the dashboard, please |
| f67539c2 TL |
32 | see ``/doc/dev/dev_guide/dash_devel.rst`` or the `online version |
| 33 | <https://ceph.readthedocs.io/en/latest/dev/developer_guide/dash-devel/>`_ for | |
| 34 | details on how to set up a development environment and other development-related | |
| 35 | topics. |