| | 1 | Ceph Dashboard |
| | 2 | ============== |
| | 3 | |
| | 4 | Overview |
| | 5 | -------- |
| | 6 | |
| | 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. |
| | 10 | |
| | 11 | Enabling and Starting the Dashboard |
| | 12 | ----------------------------------- |
| | 13 | |
| | 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 |
| | 16 | documentation <https://ceph.readthedocs.io/en/latest/dev/quick_guide/>`_ for |
| | 17 | details on how to accomplish this. |
| | 18 | |
| | 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. |
| | 22 | |
| | 23 | Please see the `Ceph Dashboard documentation |
| | 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. |
| | 27 | |
| | 28 | Working on the Dashboard Code |
| | 29 | ----------------------------- |
| | 30 | |
| | 31 | If you're interested in helping with the development of the dashboard, please |
| | 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. |
projects / ceph.git / blame_incremental