Graphical user interface

There are several ways you can manage and monitor your StorPool cluster. Based on how you can access the cluster you can do the following:

  • Use the Command Line Interface (CLI reference). It has an integrated help system that provides useful information on every step. You can process the results from the storpool command with other CLI tools as needed.

  • The REST API exposes all the available functionality. You can use it to integrate StroPool with any existing management system.

  • Use the Web interface to perform some of the most important operations via a browser.

This document provides information on how you can access and use the Web interface.

Accessing the Web interface

The installation of the Web interface is performed by the StorPool support team. After it is installed you can access it in the following way:

  1. Open an address like https://host:port/ with your Web browser.

    The host and port are configured during the installation of the GUI using the SP_GUI_HTTP_HOST and SP_GUI_HTTP_PORT configuration settings (see Host and port for the Web interface). For example, the address can be something like https://10.11.12.13:8765.

  2. Log in with a user name and a password.

    They can be those of the administrator provided during the installation of the GUI, or other user accounts created by your administrator.

Once logged in you can do the following:

  • View the overall cluster status on the dashboard, and other details like disk and template lists; for details, see Viewing cluster details.

  • Manage volume, snapshot, and iSCSI parameters; for details, see Managing the cluster.

  • View and modify the GUI settings; for details, see UI settings.

Viewing cluster details

The dashboard is the section of the StoPool Web interface you see after you log in. It provides the following details:

  • Visualization of the storage capacity, available, and used space.

  • I/O performance graph, with read and write speeds.

  • Cluster health status.

  • Number of nodes and clients, service status, and other common details.

There are a few other sections for viewing cluster details:

  • Templates

    See the available templates and their parameters. You can also obtain this information on the CLI with storpool template list; for details, see Listing templates.

  • Disks

    See the drives used in the cluster and their parameters. You can also obtain this information on the CLI with storpool disk list; for details, see Listings disks.

  • Tree view

    Get a visual representation of the volumes and snapshots in the cluster. You can also obtain this information on the CLI with storpool_tree; for details, see StorPool tree.

  • Networks

    View the network interfaces (see Network communication) of the nodes in the cluster and their parameters. You can also obtain this information on the CLI with storpool net list; for details, see Network.

For all of these sections, you can choose the ‘column settings’ button on the top right and select which columns should be displayed.

Managing the cluster

The StoPool Web interface features a few sections where you can both view and manage cluster details.

Volumes

Here you can see the volumes in the cluster and their parameters. You can perform the following actions:

  • For each volume you can choose to edit its parameters, create a snapshot, attach or detach it, export it to initiators, or delete it.

  • To create a volume you need to enter its name, specify its size, and choose a template.

  • To create a snapshot you enter its name and choose a volume.

For more information about listing and creating volumes on the CLI, see Listing all volumes and Creating a volume. For creating snapshots, see Creating snapshots.

Snapshots

Here you can see the snapshots in the cluster and their parameters. For each snapshot you can choose to attach or detach it, or to delete it. For more information about performing these actions using the CLI, see Attachments and Deleting snapshots.

iSCSI

Here you can add iSCSI initiators, export volumes, add targets, and manage portal groups. For more information about adding initiators and exporting volumes using the storpool iscsi command, see iSCSI.

UI settings

Using the gear icon in the top right part of Web interface you can open the Settings panel, where you can do do the following:

  • Set whether analytics data should be used or not (Toggle Influx data).

  • Switch on or off debug mode.

  • If you are logged in as administrator you can add or remove users.

  • Change your password.

  • Sign out of the Web interface.