Quick Start Guide

Red Hat Gluster Storage 3.4

Getting Started with Web Administration

Rakesh Ghatvisave

Red Hat Customer Content Services

Abstract

This guide provides essential installation and getting started instructions to set up Red Hat Gluster Storage Web Administration for monitoring purposes.

Chapter 1. Overview

Red Hat Gluster Storage Web Administration provides monitoring and metrics infrastructure for Red Hat Gluster Storage 3.4.0 and is the primary method to monitor your Red Hat Gluster Storage environment. The Red Hat Gluster Storage Web Administration environment is based on the Tendrl upstream project and utilizes Ansible automation for installation. The key goal of Red Hat Gluster Storage Web Administration is to provide deep metrics and visualization of Red Hat Storage Gluster clusters and the associated storage elements such as storage nodes, volumes, and bricks.

Key Features

  1. Monitoring dashboards for Clusters, Hosts, Volumes, and Bricks
  2. Top-level list views of Clusters, Hosts, and Volumes
  3. SNMPv3 Configuration and Alerting
  4. User Management
  5. Importing Gluster cluster

1.1. Web Administration System Concepts

The Red Hat Gluster Storage Web Administration environment consists of the following system components.

Web Administration Server

The Web Administration server system hosts the Web Administration user interface, the API and etcd. The Web Administration server is the system on which the Ansible installation process is run.

Red Hat Gluster Storage Node

The system on which Red Hat Gluster Storage is installed. Web Administration node agents are installed on the storage nodes.

Client System

Any external system that accesses the Web Administration user interface on a compatible web browser.

1.2. Web Administration Architecture

Figure 1.1. Web Administration Architecture

Gluster WA Architecture gimp

The components of the Web Administration architecture are described below:

Web Administration Server Components

  • Web Administration UI: the primary user interface for monitoring Red Hat Gluster Storage clusters.
  • Grafana Dashboard: a third party integrated dashboard that displays real-time metrics and monitoring data.
  • Monitoring Integration: service that enables monitoring and alerting via integration with external systems such as Graphite and Grafana.
  • Graphite Web Service: repository of (Gluster) telemetry data collected using collectd.
  • Carbon Service: set of services dealing with receiving data from collectors (collectd), replication and sharding, and interfacing with Grafana.
  • Whisper Database: database for storing time-series numeric metrics.
  • Web Administration API: the Web Administration northbound API.
  • etcd Key-value Store: central store that contains all the configuration state information for storage subsystems managed by Web Administration
  • Notifier: notification service that enables various types of notifications and alerts including SMTP and SNMP

Red Hat Gluster Storage Server Components

Red Hat Gluster Storage server is a system with Red Hat Gluster Storage installed. Multiple Red Hat Gluster Storage servers form a Red Hat Gluster Storage cluster. The components are as follows:

  • collectd Service: host-based system statistics collection daemon that gathers metrics from various sources such as the operating system, applications, log files and devices, Red Hat Gluster Storage clusters, etc.
  • Gluster Integration: component that fetches data from Red Hat Gluster Storage cluster to be sent to the Web Administration server.
  • Node Agent: takes care of node-specific flows and tasks to be performed.

Chapter 2. System Requirements

This chapter outlines the minimum hardware and software requirements to install Red Hat Gluster Storage Web Administration.

Important

Ensure that all the requirements are met before the installation starts. Missing requirements can result in Red Hat Gluster Storage Web Administration environment not functioning as expected.

The Red Hat Gluster Storage Web Administration environment requires:

  • One machine to act as the management server
  • One or more machines to act as storage servers. At least three machines are required to support replicated volumes
  • One or more machines to be used as clients to access the Web Administration interface

2.1. Requirements for Web Administration Server System

On the system to be designated as the Web Administration server, verify that these recommended hardware and software requirements are met.

2.1.1. Hardware Requirements

The following are the different hardware requirements based on different cluster configurations:

2.1.1.1. Small Cluster Configuration

  • Number of nodes: upto 8 nodes
  • Number of volumes: upto 6-8 volumes per cluster
  • Number of bricks per node for replicated volumes: upto 2-3 bricks
  • Number of bricks per node for Erasure Coded volumes: upto 12-36 bricks

Recommended Requirements

  • 4 vCPUs
  • 4 GB of available system RAM
  • One Network Interface Card (NIC) with bandwidth of at least 1 Gbps

Additional Storage Devices

For hosting etcd data directory:

  • Storage disk size: 20 GB per cluster
  • Filesystem format: XFS
  • Mounting directory: /var/lib/etcd

For hosting time-series data from Graphite, Carbon, and Whisper applications:

  • Storage disk size: 200 GB per cluster
  • Filesystem format: XFS
  • Mounting directory: /var/lib/carbon
Note

For more information on how to prepare and mount the additional disks, see the Creating a Partition and Mounting a File System sections in the Red Hat Enterprise Linux Storage Administration Guide.

2.1.1.2. Medium Cluster Configuration

  • Number of nodes: 9-16 nodes
  • Number of volumes: upto 6-8 volumes per cluster
  • Number of bricks per node for replicated volumes: upto 2-3 bricks
  • Number of bricks per node for Erasure Coded volumes: upto 12-36 bricks

Recommended Requirements

  • 4 vCPUs
  • 6 GB of available system RAM
  • One Network Interface Card (NIC) with bandwidth of at least 1 Gbps

Additional Storage Devices

For hosting etcd data directory:

  • Storage disk size: 20 GB per cluster
  • Filesystem format: XFS
  • Mounting directory: /var/lib/etcd

For hosting time-series data from Graphite, Carbon, and Whisper applications:

  • Storage disk size: 350 GB per cluster
  • Filesystem format: XFS
  • Mounting directory: /var/lib/carbon

2.1.1.3. Large Cluster Configuration

  • Number of nodes: 17-24 nodes
  • Number of volumes: upto 6-8 volumes per cluster
  • Number of bricks per node for replicated volumes: upto 2-3 bricks
  • Number of bricks per node for Erasure Coded volumes: upto 12-36 bricks

Recommended Requirements

  • 6 vCPUs
  • 6 GB of available system RAM
  • One Network Interface Card (NIC) with bandwidth of at least 1 Gbps

Additional Storage Devices

For hosting etcd data directory:

  • Storage disk size: 20 GB per cluster
  • Filesystem format: XFS
  • Mounting directory: /var/lib/etcd

For hosting time-series data from Graphite, Carbon, and Whisper applications:

  • Storage disk size: 500 GB per cluster
  • Filesystem format: XFS
  • Mounting directory: /var/lib/carbon

2.1.2. Software Requirements

Red Hat Gluster Storage Web Administration is supported on Red Hat Enterprise Linux 7.5 64-bit version.

Table 2.1. Software Requirements

SoftwareName and Version

Operating System

Red Hat Enterprise Linux 7.5

2.2. Requirements for Red Hat Gluster Storage Nodes

Ensure the following requirements are met on the Red Hat Gluster Storage nodes:

  1. Red Hat Enterprise Linux 7.5
  2. Red Hat Gluster Storage servers updated to the latest Red Hat Gluster Storage version 3.4 or greater. For detailed instructions on the upgrade process, see the Upgrading Red Hat Storage section in the Red Hat Gluster Storage Installation Guide.
  3. Minimum hardware requirements

    Note

    For more information, see the knowledge base article on Red Hat Gluster Storage Hardware Compatibility.

  4. Network Time Protocol (NTP) setup
  5. Firewall access to ports

For detailed information on prerequisites and setting up Red Hat Gluster Storage server, see the Red Hat Gluster Storage 3.4.0 Installation Guide.

2.3. Requirements for the Client System

The Red Hat Gluster Storage Web Administration environment can be accessed by a client machine with the following web browser compatibility:

Table 2.2. Web Browser Compatibility

SoftwareName and Version

Web Browser

Mozilla Firefox 38.7.0 or later

Web Browser

Google Chrome 46 or later

2.4. Firewall Configuration

Automated Firewall Setup

In this version of Red Hat Gluster Web Administration, firewall configuration is automated by Ansible automation. The tendrl-ansible installer configures the firewall during Web Administration installation as the variable *configure_firewalld_for_tendrl* is set to True by default. This automation opens all the required ports for the Web Administration environment.

To automatically configure the firewall, follow the Web Administration installation process. See the Web Administration installation section in the Quick Start Guide for details.

Note

For tendrl-ansible to automate firewall setup, ensure the firewalld service is configured and enabled. For instructions, see Configuring Firewalld section in the Red Hat Enterprise Linux Security guide.

Manual Firewall Setup

To manually configure firewall for Web Administration services:

  • Open the ports before manually configuring firewall
  • Set the variable configure_firewalld_for_tendrl to False in the site.yml playbook.
Note

The site.yml playbook file is created as part of the Web Administration Ansible installation process. For details, see the Web Administration Installation process of this guide.

  • Run the site.yml playbook file.

The list of the ports and the port numbers are given in the table below:

Table 2.3. Web Administration Port Numbers

TCP Port NumbersUsage

2379

For etcd

2003

For Graphite

10080

For GraphiteWeb

80 or 443

For tendrl http or https

8789

For tendrl-monitoring-integration

To use Firewalld to open a particular port, run:

# firewall-cmd --zone=zone_name --add-port=5667/tcp
# firewall-cmd --zone=zone_name --add-port=5667/tcp --permanent

To use iptables to open a particular port, run:

# iptables -A INPUT -m state --state NEW -m tcp -p tcp --dport 5667 -j ACCEPT
# service iptables save
Note

To be able to execute the iptables commands successfully, ensure the iptables-services package is installed. To install the iptables-services package, run yum install iptables-services.

Chapter 3. Installing Web Administration

This chapter covers installing Red Hat Gluster Web Administration using Ansible automation.

3.1. Prerequisites

Before installing Red Hat Gluster Web Administration, ensure the following prerequisites are met:

  1. Enable the following repositories on the Web Administration server and all the Gluster storage servers:

    # subscription-manager repos --enable=rhel-7-server-rpms
    
    # subscription-manager repos --enable=rhel-7-server-ansible-2-rpms
  2. Enable the following repository on the Web Administration server:

    # subscription-manager repos --enable=rh-gluster-3-web-admin-server-for-rhel-7-server-rpms
  3. Enable the following repositories on all the Gluster storage servers:

    # subscription-manager repos --enable=rh-gluster-3-for-rhel-7-server-rpms
    # subscription-manager repos --enable=rh-gluster-3-web-admin-agent-for-rhel-7-server-rpms
  4. Set up SSH password-less connection from the Web Administration server system to the remote Gluster servers in addition to localhost (SSH to localhost).

    Note

    For information on how to set up SSH key-based authentication, see the Using Key-based Authentication section in the Red Hat Enterprise Linux System Administrator’s Guide.

3.2. Installation Workflow

To install Web Administration, follow the sequence outlined below. For detailed instructions to execute the following sequence, see the next section entitled 3.3. Web Administration Installation of this Guide.

  1. Installing the latest version of Ansible and tendrl-ansible on the Web Administration server.
  2. Creating inventory file with required groups: tendrl_server and gluster_servers with mandatory and optional ansible variables.
  3. Executing the site.yml playbook and accessing the Web Administration environment.
Note

See also the README file from tendrl-ansible package available at the following path: /usr/share/doc/tendrl-ansible-1.6.3/README.md

Ansible Groups

The site.yml playbook from tendrl-ansible package expects the hosts to be divided into two groups according to its functionality:

  1. tendrl_server: contains one machine acting as Web Administration server.
  2. gluster_servers: contains all the Red Hat Gluster Storage nodes.

Ansible Roles

The tendrl-ansible package contains two Ansible roles with tasks intended for a particular component:

  1. tendrl-ansible.tendrl-server: contains tasks for Web Administration server belonging to the tendrl_server group in the inventory file.

    Note

    For more information about this role and the variables, see the README file from tendrl-ansible package available at the following path: /usr/share/ansible/roles/tendrl-ansible.tendrl-server/README.md

  2. tendrl-ansible.tendrl-storage-node: contains tasks for Red Hat Gluster Storage nodes belonging to the gluster_servers group in the inventory file.
Note

For more information on this role and the variables, see the README file from tendrl-ansible package available on the following path: /usr/share/ansible/roles/tendrl-ansible.tendrl-storage-node/README.md

3.3. Web Administration Installation

The following procedure outlines the steps to install Web Administration the Ansible way.

Procedure. Installing Web Administration

  1. Install the latest version of Ansible and tendrl-ansible on the Web Administration server:

    # yum install tendrl-ansible
    Note

    Verify the version installed by running ansible --version. Web Administration supports Ansible version 2.x or greater.

  2. Create an Ansible inventory file with two Ansible groups: tendrl_server and gluster_servers. Ensure to use FQDNs for all the hosts in the inventory file as shown in the following example:

    Sample Inventory groups

    [tendrl_server]
    tendrl.example.com
    
    [gluster_servers]
    
    gl1.example.com
    gl2.example.com
    gl3.example.com
    gl4.example.com
    Note

    For instructions on setting up an inventory file, see Ansible Inventory file setup in Ansible documentation.

  3. Add the following required Ansible variables with their corresponding values in the inventory file:

    • etcd_ip_address: configures where etcd instance is listening
    • etcd_fqdn: configures Web Administration components to be able to connect to the etcd
    • graphite_fqdn: configures Web Administration components to be able to connect to graphite

      Sample Inventory variables

      [all:vars]
      
      etcd_ip_address=192.0.2.1
      etcd_fqdn=tendrl.example.com
      graphite_fqdn=tendrl.example.com
      Note

      For more detail, see the Sample Inventory variables at the end of this installation workflow.

  4. Add any other optional variables in the inventory file as required. The other variables are listed in the Ansible roles README files at the following paths. Enable or disable features by specifying values to the variables such as etcd-tls client authentication. For detailed TLS configuration instructions, see Chapter 5. TLS Encryption Configuration of this Guide.

    # /usr/share/ansible/roles/tendrl-ansible.tendrl-server/README.md
    # /usr/share/ansible/roles/tendrl-ansible.tendrl-storage-node/README.md
    Note

    The firewall configuration variable is enabled by default.

    Note

    For detailed inventory file configuration, see the README.md file provided with the installation at the following path:

    # less /usr/share/doc/tendrl-ansible-1.6.3/README.md
  5. Copy the site.yml playbook into the working directory where the inventory file is stored.

    # cp /usr/share/doc/tendrl-ansible-1.6.3/site.yml .
  6. Copy the prechecks.yml file into the inventory file directory:

    # cp /usr/share/doc/tendrl-ansible-1.6.3/prechecks.yml .
  7. Verify SSH connection to all the nodes from the inventory file without asking for password or validation of public key by running:

    # ansible -i <inventory_file> -m ping all

    Example

    # ansible -i <inventory_file> -m ping all
    gl3.example.com | SUCCESS => {
        "changed": false,
        "failed": false,
        "ping": "pong"
    }
    Note

    Ansible should return SUCCESS and pong message for all the nodes as shown in the example above. Do not proceed until the SSH connection is successfully established.

  8. To check if Web Administration minimal requirements and setup are met, run the prechecks playbook:

    # ansible-playbook -i <inventory_file> prechecks.yml
    Note

    If there are any missing requirements, the prechecks playbook will detect it immediately, and direct your attention to the specific problem before running the installation.

  9. Run the prepared site.yml playbook using the following command to set up the Web Administration server and the Storage nodes:

    # ansible-playbook -i <inventory_file> site.yml
  10. Log in to the Web Administration environment. For login instructions, see the Web Administration Login chapter of this guide.
Note

The tendrl-ansible.tendrl-server role creates the default user as admin and default password as adminuser. The default password is stored in the /root/password file of the Web Administration server.

Sample Inventory Variables

If there is a single network interface on all machines, the example inventory variables would be as follows:

[all:vars]

etcd_ip_address=192.0.2.1
etcd_fqdn=tendrl.example.com
graphite_fqdn=tendrl.example.com

In the above example:

  • 192.0.2.1 is the IP address of the Web Administration server
  • tendrl.example.com is the hostname of the Web Administration server
  • tendrl.example.com hostname is translated to IP address 192.0.2.1.

See the full description in the README file of tendrl-ansible.tendrl-server role and pay attention to the values you specify there when you use multiple network interfaces on the machines.

You can define these variables in variable files or from the command line directly, but including them into the inventory file provides you with a single file with a full description of tendrl-ansible setup for future reference.

The consolidated variables in the inventory file can be used for the cluster expansion process and also to ensure the installation configuration is intact. The inventory file does not contain the grafana admin password which is stored in the grafana_admin_passwd file generated during tendrl-ansible execution.

Chapter 4. Upgrading Red Hat Gluster Storage Web Administration

4.1. Red Hat Gluster Storage Web Administration 3.3 to 3.4

This chapter describes the procedure to upgrade Web Administration to version 3.4.0 from previous versions.

To upgrade your Web Administration environment to version 3.4, execute the following actions on the Gluster nodes and the Web Administration server:

On Gluster storage nodes

  1. Stop and disable all Web Administration services on storage nodes.
  2. Enable the Ansible repository and ensure the other required repositories are enabled.
  3. Upgrade Red Hat Gluster Storage to version 3.4.0.

On Web Administration server

  1. Reinstall Red Hat Enterprise Linux on the Web Administration Server.
  2. Install Web Administration 3.4.0
  3. Import the Gluster 3.4.0 cluster.

On Gluster storage nodes

Stopping and disabling Web Administration Services

Stop and disable the following services on the storage nodes by executing the commands given below.

To stop and disable the tendrl-node-agent service:

# systemctl stop tendrl-node-agent
# systemctl disable tendrl-node-agent

To stop and disable the collectd service:

# systemctl stop collectd
# systemctl disable collectd

To stop and disable the tendrl-gluster-integration service:

# systemctl stop tendrl-gluster-integration
# systemctl disable tendrl-gluster-integration
Note

The tendrl-node-agent service is enabled and started during execution of the tendrl-ansible site.yml playbook. The collectd and tendrl-gluster-integration services are enabled and started after importing a cluster into the Web Administration environment.

Enabling Web Administration Repositories

Enable the Ansible repository by running the following command:

# subscription-manager repos --enable=rhel-7-server-ansible-2-rpms

Additionally, ensure that the other required Web Administration repositories are enabled. Run the following command to check if all the required repositories are enabled:

# yum repolist
Note

To check the required repositories, see the Prerequisites section of the Quick Start Guide.

After the repositories are enabled, clear yum cache:

# yum clean all

Upgrading Red Hat Gluster Storage

After enabling the required repositories, upgrade your Red Hat Gluster Storage environment to 3.4. For detailed upgrade instructions, see the Upgrading to Red Hat Gluster Storage 3.4 chapter in the Red Hat Gluster Storage 3.4 Installation Guide. After a successful upgrade, resume the following steps.

On Web Administration server

Reinstalling Red Hat Enterprise Linux on the Web Administration Server After upgrading Red Hat Gluster Storage, reinstall Red Hat Enterprise Linux on the host system. For detailed installation instructions, see the Red Hat Enterprise Linux Installation Guide.

Installing Web Administration

After reinstalling Red Hat Enterprise Linux, install Web Administration and its associated components on the Web Administration server and the Gluster Storage servers using tendrl-ansible.

Note

The Web Administration components already installed on the Gluster Storage servers will be reconfigured for the new installation. For detailed instructions on installation, see Chapter 3. Installing Web Administration, the preceding chapter of this Guide.

After installation, import the Gluster 3.4 cluster in the Web Administration environment. For detailed import procedure, see the Import Cluster chapter of the Web Administration 3.4 Monitoring Guide.

4.2. Red Hat Gluster Storage Web Administration 3.4.x to 3.4.y

This chapter describes the procedure to update Web Administration from version 3.4.x to 3.4.y.

Note

The Web Administration update path outlined here is part of the overall Red Hat Gluster Storage offline update. Updating Web Administration as a standalone component is not supported. Execute the Web Administration update procedure as per the update sequence outlined in the 7.2. Updating Red Hat Gluster Storage in the Offline Mode section of the Red Hat Gluster Storage Installation Guide.

To update your Web Administration environment to version 3.4.y, follow the steps outlined below.

On Red Hat Gluster Storage Servers (Part I):

  1. Stop all Web Administration services.

    1. To stop the tendrl-gluster-integration service:

      # systemctl stop tendrl-gluster-integration
    2. To stop the tendrl-node-agent service:

      # systemctl stop tendrl-node-agent
    3. To stop the collectd service:

      # systemctl stop collectd
  2. Follow the steps from 1 - 9 under the heading Updating Red Hat Gluster Storage 3.4 in the offline mode in the 7.2. Updating Red Hat Gluster Storage in the Offline Mode section of the Red Hat Gluster Storage Installation Guide.

After executing all the steps from step 1 to step 9 under 7.2. Updating Red Hat Gluster Storage in the Offline Mode, return to this section and continue with the following steps.

On Web Administration Server:

  1. Stop all Web Administration services:

    1. To stop the tendrl-monitoring-integration service:

      # systemctl stop tendrl-monitoring-integration
    2. To stop the tendrl-node-agent service:

      # systemctl stop tendrl-node-agent
    3. To stop the tendrl-notifier service:

      # systemctl stop tendrl-notifier
    4. To stop the tendrl-api service:

      # systemctl stop tendrl-api
  2. Update all packages on the Web Administration server:

    # yum update
  3. Run the tendrl-upgrade script:

    # tendrl-upgrade
  4. If updates to the kernel package occurred, reboot the server system. If not, restart the Web Administration services:

    # systemctl restart tendrl-node-agent
    # systemctl restart tendrl-monitoring-integration
    # systemctl restart tendrl-notifier
    # systemctl restart tendrl-api
    # systemctl restart httpd

On Red Hat Gluster Storage servers (Part II):

  1. Restart the following Web Administration services:
# systemctl restart tendrl-node-agent
# systemctl restart tendrl-gluster-integration
# systemctl restart collectd

After successful completion of all the steps, your Red Hat Gluster Storage and Web Administration environment should be updated to the latest version.

Chapter 5. TLS Encryption Configuration

Red Hat Gluster Storage Web Administration supports etcd’s TLS-based security model which supports authentication and encryption of traffic between etcd and Web Administration system components.

By default, etcd functions without authentication and encryption but it is recommended to use TLS authentication for client-server encryption.

5.1. Prerequisites

The tendrl-ansible installation of Web Administration does not generate and deploy encryption certificates and keys. To configure etcd TLS client-server authentication, generate and deploy encryption certificates on all the nodes of the cluster before executing tendrl-ansible based Web Administration installation.

Before setting up the Transport Layer Security (TLS ) encryption, ensure the following encryption components are generated:

Certificate Authority (CA) Certificate

Generate a CA certificate either self-signed or signed by a trusted Certificate Authority (CA). For instructions on generating a CA certificate, see Creating Your Own Certificates section of the Red Hat AMQ Security Guide.

Private Keys

Generate a private key and a client certificate for each storage node and the Web Administration server. For more information, see the Creating and Managing Encryption Keys section of the Red Hat Enterprise Linux Security Guide. On each Web Administration managed storage node, and on the Web Administration server, place the PEM-encoded private key and the client/CA certificates in a secure place that is only accessible by the Web Administration server’s root user.

5.2. Configuring TLS Encryption

After generating and placing the TLS certificate files in the preferred directory, update the value of the Ansible variables in the site.yml file with the respective file paths of the certificate files.

In the site.yml file, add and modify the etcd TLS variables.

etcd_tls_client_auth: this variable is to enable or disable TLS authentication.

etcd_cert_file: certificate used for SSL/TLS connections to etcd. When this option is turned on, advertise-client-urls can use the HTTPS schema.

etcd_key_file: key for the certificate which must be unencrypted.

etcd_trusted_ca_file: the trusted Certificate Authority.

Configuring TLS

  1. Open the site.yml playbook file.
  2. Set the value for etcd_tls_client_auth variable to True for both the Ansible roles: tendrl_server and gluster_servers. By default, the value of this variable is False.
  3. Edit the file path for the etcd_cert_file variable as per required. The default value is: /etc/pki/tls/certs/etcd.crt
  4. Edit the file path for etcd_key_file variable as per required. The default value is: /etc/pki/tls/private/etcd.key
  5. Edit the file path for the etcd_trusted_ca_file variable. The default value is: /etc/pki/tls/certs/ca-etcd.crt
  6. Continue the Web Administration installation process by following the Web Administration Installation chapter.

Chapter 6. Web Administration Login

The Web Administration interface is accessed on a client system using a compatible web browser.

Procedure. Logging in the Web Administration interface

  1. Open the following URL in a web browser.

    http://web-admin-server.example.com
    Note

    Replace web-admin-server.example.com with the hostname or FQDN of the Web Administration server.

  2. The login page is displayed. Enter the default username admin and the default password adminuser, and click Log in.

    Figure 6.1. Login Page

    Login page
  3. The Clusters interface is displayed after logging in to the Web Administration interface. This interface is the starting point to initiate a cluster import.

    Figure 6.2. Landing Page

    Login page
    Note

    For instructions on how to import a Gluster cluster, see the import cluster chapter in the Red Hat Gluster Storage Web Administration Monitoring Guide.

Chapter 7. Web Administration Interface Navigation

7.1. Web Administration Default Landing Interface

After logging in to the Web Administration interface, all the managed and unmanaged clusters are displayed in a rows format with the corresponding cluster attributes.

Note

To identify the version of Red Hat Gluster Storage installed, see the Cluster Version attribute.

Managed cluster are the clusters that are successfully imported by Web administration for monitoring purposes. Unmanaged clusters are the clusters that are ready to be imported by Web Administration.

Cluster Attributes

cluster attributes

The following are the cluster attributes that are displayed in the cluster row:

  • Cluster name: the name of the cluster
  • Cluster Version: the version of Red Hat Gluster Storage installed
  • Managed: whether the cluster is imported or ready to be imported
  • Hosts: the number of hosts or nodes part of the cluster
  • Volumes: the number of volumes part of the hosts
  • Alerts: the number of alerts generated by the system for different tasks
  • Volume Profiling: whether enabled or disabled
  • Cluster Status: whether the cluster is ready for use or ready to be imported. The cluster state from the following:

    • Ready for Use
    • Ready to be Imported
    • Ready for expansion
    • Tasks in progress
  • Actionable Buttons: the Import button, monitoring Dashboard button and an inline menu for the following administrative operations:

    • Enable and disable volume profiling
    • Unmanage Cluster
    • Expand Cluster

To identify managed and unmanaged clusters, view the cluster attributes.

Unmanaged Cluster: An unmanaged cluster displays the Managed attribute as No.

Managed Cluster: A managed cluster displays the Managed attribute as Yes.

Accessing Monitoring Dashboard

The Clusters tab provides a shortcut button to access the Grafana Monitoring Dashboard. At the right hand side of a cluster row, click on Dashboard and you will be redirected to the Grafana Monitoring dashboard.

7.2. Web Administration Interface Switcher

The Web Administration interface provides a menu to select and switch interface views displaying a common clusters interface and a cluster-specific interface.

context sel1

Accessing Interface Switcher

At the top left of the default landing page, next to the label Red Hat Gluster Storage Web Administration, a drop-down menu is available.

context sl2

The drop-down menu provides:

  • All Clusters view: the default selection after logging in that displays all managed and unmanaged clusters.
  • Cluster-specific view: option to select a specific managed cluster.

To select a cluster-specific Interface, click on the down-down menu and select the specific managed cluster.

context sl2
Note

Only managed clusters are available to select in the drop-down menu

The cluster-specific interface is displayed with a left navigation pane for Hosts, Volumes, Tasks, and Events associated with the selected cluster.

context sel3

To switch back to the default landing interface view displaying all clusters, select All Clusters from the drop-down menu.

context sl5

7.3. Web Administration Cluster-specific Interface Navigation

The cluster-specific interface provides a vertical navigation pane available at the left hand side of the interface to conveniently access the different elements of the clusters.

navigationmenu

The navigation pane provides access to the following menus:

  • Hosts: hosts view and monitoring dashboard shortcut
  • Volumes: Volumes view and monitoring dashboard shortcut
  • Tasks: view completed and failed system tasks
  • Events: view all the system-wide events

7.3.1. Clusters View and Monitoring Dashboard Shortcut

The Clusters tab in the navigation pane lists all the imported clusters in a rows format. Each row shows the individual cluster attributes such as the version of the cluster, whether managed or unmanaged and the status of Volume Profiling whether enabled or disabled.

Figure 7.1. Clusters View

Clusters View

Accessing Monitoring Dashboard

The Clusters tab provides a shortcut button to access the Grafana Monitoring Dashboard. At the right hand side of a cluster row, click on Dashboard and you will be redirected to the Grafana Monitoring dashboard.

7.3.2. Hosts View and Monitoring Dashboard Shortcut

The Hosts tab in the navigation pane lists all the accepted hosts assigned to different clusters. The Hosts can be filtered by the Host Name or Status.

Figure 7.2. Hosts View

Hosts View

Accessing Monitoring Dashboard

The Hosts tab provides a shortcut button to access the Grafana Monitoring Dashboard. At the right hand side of a Host row, click on Dashboard, and you will be redirected to the Grafana Monitoring dashboard.

7.3.3. Events View

The Events view lists all the events occurred in the system. To view more detail of a specific event: copy the task ID or job ID, if available in the event listing to the task ID filter in the Tasks view interface.

Figure 7.3. Events View

Events View

7.3.4. Tasks View

The Web Administration consists of a sizeable number of user-initiated actions to accomplish operations such as importing clusters. It is crucial for Web Administration users to monitor and view the status of the actions they initiated.

A user can view the following task information:

  • The status of an initiated task whether completed or failed
  • The details of all past and present cluster-wide initiated actions
  • The timestamp of the initiated task
  • Retrieve a specific task by using the available filters

Figure 7.4. Tasks View

Tasks View

Tasks can filtered by Task ID, Task name, the status of the task and the time interval.

Note

The Task details will remain in the Web Administration interface for not more than the default Time to live (TTL) of 2 days. Once the timespan has elapsed, the task details will be discarded from the system.

7.3.5. Admin and Users

The Users tab lists all the users created to access the Web Administration interface. The interface provides user tasks such as adding, editing and deleting a user. For more user administration actions, see the Users and Roles Administration chapter of the Red Hat Gluster Storage Web Administration Monitoring Guide.

add user4

7.3.6. Alerts and User Settings

To view system-wide notifications and to change the user password, a menubar is available at the top right corner of the interface.

menubar

To view system-wide alerts, click on the bell icon at the top right menubar of the interface.

alerts menubar

Changing User Password

To change the user password:

  1. Click on the user icon from the menu bar.

    menubar
  2. Click My Settings.

    my settings
  3. A dialog window is opened. Enter the new password twice and click Save.
email notif
Note

Email notifications are disabled by default. To enable, check the Email Notifications box. For email notifications configuration instructions, see the SMTP Notifications Configuration section of the Red Hat Gluster Storage Web Administration Monitoring Guide.

Logging out from the interface

To log out from the interface:

  1. Click on the user icon from the menu bar.
  2. Click Logout.
my settings

Legal Notice

Copyright © 2018 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.