From: Zac Dover Date: Mon, 6 May 2024 15:16:51 +0000 (+1000) Subject: doc/mgr: edit "Overview" in dashboard.rst X-Git-Tag: v20.0.0~1999^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=6cf06c60f7c3f87707c7dc47cde2346cec7cf00f;p=ceph.git doc/mgr: edit "Overview" in dashboard.rst Edit and update the "Overview" section in doc/mgr/dashboard.rst. Signed-off-by: Zac Dover Co-authored-by: Anthony D'Atri Signed-off-by: Zac Dover --- diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst index 2f396350956be..afd463018589a 100644 --- a/doc/mgr/dashboard.rst +++ b/doc/mgr/dashboard.rst @@ -6,33 +6,29 @@ Ceph Dashboard Overview -------- -The Ceph Dashboard is a built-in web-based Ceph management and monitoring -application through which you can inspect and administer various aspects -and resources within the cluster. It is implemented as a :ref:`ceph-manager-daemon` module. - -The original Ceph Dashboard that was shipped with Ceph Luminous started -out as a simple read-only view into run-time information and performance -data of Ceph clusters. It used a very simple architecture to achieve the -original goal. However, there was growing demand for richer web-based -management capabilities, to make it easier to administer Ceph for users that -prefer a WebUI over the CLI. - -The new :term:`Ceph Dashboard` module adds web-based monitoring and -administration to the Ceph Manager. The architecture and functionality of this new -module are derived from -and inspired by the `openATTIC Ceph management and monitoring tool -`_. Development is actively driven by the -openATTIC team at `SUSE `_, with support from -companies including `Red Hat `_ and members of the Ceph -community. - -The dashboard module's backend code uses the CherryPy framework and implements -a custom REST API. The WebUI implementation is based on -Angular/TypeScript and includes both functionality from the original dashboard -and new features originally developed for the standalone version -of openATTIC. The Ceph Dashboard module is implemented as an -application that provides a graphical representation of information and statistics -through a web server hosted by ``ceph-mgr``. +The Ceph Dashboard is a web-based Ceph management-and-monitoring tool that can +be used to inspect and administer resources in the cluster. It is implemented +as a :ref:`ceph-manager-daemon` module. + +The original Ceph Dashboard shipped with Ceph Luminous and was a simple +read-only view into the run-time information and performance data of Ceph +clusters. It had a simple architecture. However, demand grew for richer, +web-based management capabilities for users who prefer a WebUI over the CLI. + +The :term:`Ceph Dashboard` module adds web-based monitoring and administration +to the Ceph Manager. The architecture and functionality of this new module are +derived from the `openATTIC Ceph management and monitoring tool +`_. Development was originally driven by the openATTIC +team at `SUSE `_, with support from members of the Ceph +community and from companies including `Red Hat `_. + +The dashboard module's backend code uses the CherryPy framework, and implements +a custom REST API. The WebUI implementation is based on Angular/TypeScript and +includes both functionality from the original dashboard and new features +originally developed for the standalone version of openATTIC. The Ceph +Dashboard module is implemented as an application that provides a graphical +representation of information and statistics through a web server hosted by +``ceph-mgr``. Feature Overview ^^^^^^^^^^^^^^^^