From f90c1113880d05159641b6923d6e09c489b7861a Mon Sep 17 00:00:00 2001 From: Lenz Grimmer Date: Wed, 22 May 2019 12:55:47 +0200 Subject: [PATCH] doc: Improved dashboard feature overview Added some newly added features, improved wording. Signed-off-by: Lenz Grimmer --- doc/mgr/dashboard.rst | 52 ++++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst index 14e79964d7c..32087211b5b 100644 --- a/doc/mgr/dashboard.rst +++ b/doc/mgr/dashboard.rst @@ -53,49 +53,52 @@ The dashboard provides the following features: * **Auditing**: the dashboard backend can be configured to log all PUT, POST and DELETE API requests in the Ceph audit log. See :ref:`dashboard-auditing` for instructions on how to enable this feature. -* **Internationalization (I18N)**: use the dashboard in different languages. +* **Internationalization (I18N)**: the dashboard can be used in different + languages that can be selected at run-time. Currently, Ceph Dashboard is capable of monitoring and managing the following aspects of your Ceph cluster: -* **Overall cluster health**: Displays overall cluster status, performance +* **Overall cluster health**: Display overall cluster status, performance and capacity metrics. * **Embedded Grafana Dashboards**: Ceph Dashboard is capable of embedding `Grafana `_ dashboards in many locations, to display additional information and performance metrics gathered by the :ref:`mgr-prometheus`. See :ref:`dashboard-grafana` for details on how to configure this functionality. -* **Cluster logs**: Display the latest updates to the cluster's event and audit - log files. -* **Hosts**: Provides a list of all hosts associated to the cluster, which +* **Cluster logs**: Display the latest updates to the cluster's event and + audit log files. Log entries can be filtered by priority, date or keyword. +* **Hosts**: Display a list of all hosts associated to the cluster, which services are running and which version of Ceph is installed. -* **Performance counters**: Displays detailed service-specific statistics for +* **Performance counters**: Display detailed service-specific statistics for each running service. -* **Monitors**: Lists all MONs, their quorum status, open sessions. -* **Configuration Editor**: View all available configuration options, +* **Monitors**: List all MONs, their quorum status, open sessions. +* **Configuration Editor**: Display all available configuration options, their description, type and default values and edit the current values. -* **Pools**: List all Ceph pools and their details (e.g. applications, placement - groups, replication size, EC profile, CRUSH ruleset, etc.) -* **OSDs**: Lists all OSDs, their status and usage statistics as well as - detailed information like attributes (OSD map), metadata, performance counters - and usage histograms for read/write operations. Mark OSDs as up/down/out, - perform scrub operations. Select between different recovery profiles to adjust - the level of backfilling activity. -* **iSCSI**: Lists all hosts that run the TCMU runner service, displaying all +* **Pools**: List all Ceph pools and their details (e.g. applications, + placement groups, replication size, EC profile, CRUSH ruleset, etc.) +* **OSDs**: List all OSDs, their status and usage statistics as well as + detailed information like attributes (OSD map), metadata, performance + counters and usage histograms for read/write operations. Mark OSDs + up/down/out, purge and reweight OSDs, perform scrub operations, modify + various scrub-related configuration options, select different profiles to + adjust the level of backfilling activity. +* **iSCSI**: List all hosts that run the TCMU runner service, display all images and their performance characteristics (read/write ops, traffic). Create, modify and delete iSCSI targets (via ``ceph-iscsi``). See :ref:`dashboard-iscsi-management` for instructions on how to configure this feature. -* **RBD**: Lists all RBD images and their properties (size, objects, features). - Create, copy, modify and delete RBD images. Create, delete and rollback - snapshots of selected images, protect/unprotect these snapshots against - modification. Copy or clone snapshots, flatten cloned images. +* **RBD**: List all RBD images and their properties (size, objects, features). + Create, copy, modify and delete RBD images. Define various I/O or bandwidth + limitation settings on a global, per-pool or per-image level. Create, delete + and rollback snapshots of selected images, protect/unprotect these snapshots + against modification. Copy or clone snapshots, flatten cloned images. * **RBD mirroring**: Enable and configure RBD mirroring to a remote Ceph server. Lists all active sync daemons and their status, pools and RBD images including their synchronization state. -* **CephFS**: Lists all active filesystem clients and associated pools, +* **CephFS**: List all active filesystem clients and associated pools, including their usage statistics. -* **Object Gateway**: Lists all active object gateways and their performance +* **Object Gateway**: List all active object gateways and their performance counters. Display and manage (add/edit/delete) object gateway users and their details (e.g. quotas) as well as the users' buckets and their details (e.g. owner, quotas). See :ref:`dashboard-enabling-object-gateway` for configuration @@ -357,8 +360,7 @@ Grafana on your preferred hosts, proceed with the following steps. $ ceph mgr module enable prometheus -More details can be found on the `documentation `_ of the prometheus module. +More details can be found in the documentation of the :ref:`mgr-prometheus`. #. Add the corresponding scrape configuration to Prometheus. This may look like:: @@ -422,7 +424,7 @@ The format of url is : `::` can't see the embedded Grafana dashboards after enabling them as outlined above, check your browser's documentation on how to unblock mixed content. Alternatively, consider enabling SSL/TLS support in Grafana. - + You can directly access Grafana Instance as well to monitor your cluster. .. _dashboard-sso-support: