Quick Start Guide

1. Red Hat Enterprise Linux 7.5 or later.
2. Red Hat Gluster Storage servers updated to the latest Red Hat Gluster Storage version 3.5 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

1. Open the required ports before continuing the installation process

2. Set the variable configure_firewalld_for_tendrl to False in the [all:vars] section of the inventory file which will be applied to both the groups: tendrl_server and gluster_servers. See sample variables described in Sample Inventory Variables at the end of 3.5 Web Administration Installation procedure of this guide.

   Note

   The inventory file is created as part of the Web Administration Ansible installation process.

3. Follow Web Administration Installation procedure of this guide.

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.

5. If the httpd package is already installed on the Web Administration server, stop the httpd service before continuing with the installation:

   # systemctl stop httpd

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.

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

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.

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 that the latest Ansible package is obtained from the rhel-7-server-ansible-2-rpms channel before executing the following steps. Additionally, ensure that the Ansible version is the same on the Web Administration server as available on the storage nodes.

   Note

   Latest version of Web Administration is compatible with the latest version of Ansible. Web Administration is not compatible with versions below Ansible 2.5.

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. Set up SSH password-less connection from the Web Administration server system to the remote Gluster servers.

   Note

   For information about 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.

8. 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.

9. 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.

10. 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

11. Log in to the Web Administration environment. For login instructions, see the Web Administration Login chapter of this guide.

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.5.

On Web Administration Server

1. Upgrade Red Hat Enterprise Linux on the Web Administration Server.
2. Import the Gluster 3.5 cluster.

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

   5. To stop the etcd service:

      # systemctl stop etcd

   6. To stop the carbon-cache service:

      # systemctl stop carbon-cache

2. Update all packages on the Web Administration server:

   # yum update

3. Run the tendrl-upgrade script:

   # tendrl-upgrade

4. Run the tendrl-ansible playbooks with the same initial installation configuration. For instructions, see section Web Administration Installation, steps 2 to 9.

5. If updates to the kernel package occurred, reboot the server system. If not, restart the Web Administration services:

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