Skip to content

Commit dee6e6a

Browse files
authored
Merge pull request ceph#57298 from zdover23/wip-doc-2024-05-07-mgr-dashboard-overview
doc/mgr: edit "Overview" in dashboard.rst Reviewed-by: Anthony D'Atri <[email protected]>
2 parents 2d1715f + 6cf06c6 commit dee6e6a

File tree

1 file changed

+23
-27
lines changed

1 file changed

+23
-27
lines changed

doc/mgr/dashboard.rst

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,29 @@ Ceph Dashboard
66
Overview
77
--------
88

9-
The Ceph Dashboard is a built-in web-based Ceph management and monitoring
10-
application through which you can inspect and administer various aspects
11-
and resources within the cluster. It is implemented as a :ref:`ceph-manager-daemon` module.
12-
13-
The original Ceph Dashboard that was shipped with Ceph Luminous started
14-
out as a simple read-only view into run-time information and performance
15-
data of Ceph clusters. It used a very simple architecture to achieve the
16-
original goal. However, there was growing demand for richer web-based
17-
management capabilities, to make it easier to administer Ceph for users that
18-
prefer a WebUI over the CLI.
19-
20-
The new :term:`Ceph Dashboard` module adds web-based monitoring and
21-
administration to the Ceph Manager. The architecture and functionality of this new
22-
module are derived from
23-
and inspired by the `openATTIC Ceph management and monitoring tool
24-
<https://openattic.org/>`_. Development is actively driven by the
25-
openATTIC team at `SUSE <https://www.suse.com/>`_, with support from
26-
companies including `Red Hat <https://redhat.com/>`_ and members of the Ceph
27-
community.
28-
29-
The dashboard module's backend code uses the CherryPy framework and implements
30-
a custom REST API. The WebUI implementation is based on
31-
Angular/TypeScript and includes both functionality from the original dashboard
32-
and new features originally developed for the standalone version
33-
of openATTIC. The Ceph Dashboard module is implemented as an
34-
application that provides a graphical representation of information and statistics
35-
through a web server hosted by ``ceph-mgr``.
9+
The Ceph Dashboard is a web-based Ceph management-and-monitoring tool that can
10+
be used to inspect and administer resources in the cluster. It is implemented
11+
as a :ref:`ceph-manager-daemon` module.
12+
13+
The original Ceph Dashboard shipped with Ceph Luminous and was a simple
14+
read-only view into the run-time information and performance data of Ceph
15+
clusters. It had a simple architecture. However, demand grew for richer,
16+
web-based management capabilities for users who prefer a WebUI over the CLI.
17+
18+
The :term:`Ceph Dashboard` module adds web-based monitoring and administration
19+
to the Ceph Manager. The architecture and functionality of this new module are
20+
derived from the `openATTIC Ceph management and monitoring tool
21+
<https://openattic.org/>`_. Development was originally driven by the openATTIC
22+
team at `SUSE <https://www.suse.com/>`_, with support from members of the Ceph
23+
community and from companies including `Red Hat <https://redhat.com/>`_.
24+
25+
The dashboard module's backend code uses the CherryPy framework, and implements
26+
a custom REST API. The WebUI implementation is based on Angular/TypeScript and
27+
includes both functionality from the original dashboard and new features
28+
originally developed for the standalone version of openATTIC. The Ceph
29+
Dashboard module is implemented as an application that provides a graphical
30+
representation of information and statistics through a web server hosted by
31+
``ceph-mgr``.
3632

3733
Feature Overview
3834
^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)