Dashboard's Web User Interface | Administration Guide

Applies to SUSE Enterprise Storage 6

5 Dashboard's Web User Interface #

5.1 Log In #

To log in to the dashboard Web application, point your browser to its URL including the port number. You can find its address by running

cephadm@adm > ceph mgr services | grep dashboard
"dashboard": "https://ses-dash-node.example.com:8443/",

Figure 5.1: Ceph Dashboard Login Screen #

You need a user account in order to log in to the dashboard Web application. DeepSea creates a default user 'admin' with administrator privileges for you. If you decide to log in with the default 'admin' user, retrieve the corresponding password by running

root@master # salt-call grains.get dashboard_creds

Tip: Custom User Account

If you do not want to use the default 'admin' account to access the Ceph Dashboard, create a custom user account with administrator privileges. Refer to Chapter 14, Managing Users and Roles on the Command Line for more details.

The dashboard user interface is graphically divided into several blocks: the utility menu, the main menu, and the main content pane.

Figure 5.2: Ceph Dashboard Home Page #

5.2 Utility Menu #

The top right part of the screen contains a utility menu. It includes general tasks related more to the dashboard than to the Ceph cluster. By clicking its items, you can access the following topics:

Change the language of the dashboard's user interface. You can choose from Czech, English, German, Spanish, French, Portuguese, Chinese, or Indonesian.
Display a list of Ceph related tasks that are running in the background.
View and erase recent dashboard notifications.
Display a list of links that refer to the information about the dashboard, its complete documentation, and an overview of its REST API.
Manage the dashboard's users and user roles. Refer to Chapter 14, Managing Users and Roles on the Command Line for more detailed command line descriptions.
Log out of the dashboard.

5.3 Main Menu #

The dashboard's main menu occupies the top left part of the screen. It covers the following topics:

Dashboard: Return to Ceph Dashboard's home page.
Cluster: View detailed information about overall cluster configuration and CRUSH Map, its hosts, Ceph OSDs, Ceph Monitors, and the content of a log file.
Pools: View and manage cluster pools.
Block: View and manage block devices and their iSCSI exports.
NFS: View and manage NFS Ganesha deployments.
Filesystems: View and manage CephFSs.
Object Gateway: View and manage Object Gateway's daemons, users, and buckets.

5.4 The Content Pane #

The content pane occupies the main part of the dashboard's screen. The dashboard home page shows plenty of helpful widgets to inform you briefly about the current status of the cluster, capacity, and performance information.

5.5 Common Web UI Features #

In Ceph Dashboard, you often work with lists—for example, lists of pools, OSD nodes, or RBD devices. All lists will automatically refresh themselves by default every 5 seconds. The following common widgets help you manage or adjust these list:

Click to trigger a manual refresh of the list.

Click to display or hide individual table columns.

Click and select how many rows to display on a single page.

Click inside and filter the rows by typing the string to search for.

Use to change the currently displayed page if the list spans across multiple pages.

5.6 Dashboard Widgets #

Each dashboard widget shows specific status information related to a specific aspect of a running Ceph cluster. Some widgets are active links and after clicking them, they will redirect you to a related detailed page of the topic they represent.

Tip: More Details on Mouse Over

Some graphical widgets show you more detail when you move the mouse over them.

5.6.1 Status Widgets #

Status widgets give you a brief overview about the cluster's current status.

Figure 5.3: Status Widgets #

Cluster Status: Presents basic information about the cluster's health.
Monitors: Shows the number of running monitors and their quorum.
OSDs: Shows the total number of OSDs, as well as the number of 'up' and 'in' OSDs.
Manager Daemons: Shows the number of active and standby Ceph Manager daemons.
Hosts: Shows the total number of cluster nodes.
Object Gateways: Shows the number of running Object Gateways.
Metadata Servers: Shows the number of Metadata Servers.
iSCSI Gateway: Shows the number of configured iSCSI gateways.

5.6.2 Performance Widgets #

Performance widgets refer to basic performance data of Ceph clients.

Figure 5.4: performance Widgets #

Client IOPS: The amount of clients' read and write operations per second.
Client Throughput: The sum of clients' read and write operations per second.
Client Read/Write: Visualizes clients' read/write ratio.
Recovery Throughput: The throughput of data recovered per second.
Scrub: Shows the scrub (see Section 20.4.9, “Scrubbing a Placement Group”) status. It is either disabled, enabled, or active.

5.6.3 Capacity Widgets #

Capacity widgets show brief information about the storage capacity.

Figure 5.5: Capacity Widgets #

Pools: Shows the number of pools in the cluster.
Raw Capacity: Shows the ratio of used and available raw storage capacity.
Objects: Shows the number of data objects stored in the cluster.
PGs per OSD: Shows the number of placement groups per OSD.
PG Status: Displays a chart of the placement groups according to their status.