Installation with Ansible

Introduction

This manual describes the installation procedures for GBDS.

Installation Preparation

This section covers the essential steps required to install GBDS.

All steps must be performed with root privileges on all nodes, unless otherwise indicated.

To fully install GBDS, you will need:

• Root permission on the server

• GBDS Tools package link

• Ambari Ansible package link

• OpenCV package link

• GBDS .rpm and .sql files

• Griaule Biometric Suite software .war and .sql files (optional)

If you do not have the repository links or the files, contact the Griaule support team.

Next, you must follow the steps shown below. These steps will be fully described in their sections.

1. Log in to the server as root

2. Install GBDS Tools

3. Configure the GBDS Tools configuration files

4. Run the automatic GBDS Tools environment setup

5. Install the RDB

6. Install Ambari via Ansible

7. Install GBDS

8. Install the GBS applications (optional)

Before you start, make sure the hostname of the machine is correct. To check it, run the command:

hostname

If it is not correct, run the command:

hostnamectl set-hostname <desired-hostname>
                         ^^^^^^^^^^^^^^^^^^^

If the hostname is changed, restart the machine before proceeding.

GBDS Tools

GBDS Tools is a collection of bash scripts with specific features and dynamic usability. The main purpose of the tool is to facilitate, improve, and speed up the creation, configuration, and management of environment applications.

All scripts use a single configuration file called properties.ini and a single list file called cluster.list, which must contain all server cluster information.

Before you start, make sure the wget is installed:

wget --version

If not, run the command:

yum install wget -y

Installing GBDS Tools

You have two methods to choose from to install GBDS Tools, one if you already have the Griaule repository configured on your server and another if you do not. These are explained below.

Choose only one alternative. After finishing one, there is no need to do the other.

Repository already configured

If you have already configured the Griaule repository on your server, you can complete all installations with just one command.

yum install gbds-tools

If the Griaule repository is not configured, running the command above will result in the following error:

No package gbds-tools available
Error: Nothing to do

In this case, proceed to Repository not configured.

Repository not configured

If you do not have the repository configured, you must ensure the tool works properly. To do this, you MUST place the tool in the /opt/griaule.

directory. Start by creating the directory:

mkdir -p /opt/griaule

Enter the created directory:

cd /opt/griaule

Then, download the GBDS Tools package:

wget <GBDS Tools package link>
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you do not have the link, contact the Griaule Support Team.

In the commands below, make sure to replace <version> with the version of the package that was downloaded.

Then, install it:

rpm -ivh gbds-tools-<version>.el7.noarch.rpm
                    ^^^^^^^^

And create a symbolic link:

ln -s /opt/griaule/gbds-tools-<version>/ /opt/griaule/tools
                              ^^^^^^^^

After a successful installation, proceed to the configuration section.

Configuring GBDS Tools

The configuration files used by GBDS Tools are located in the directory: /opt/griaule/tools/shared. In this directory, there are three files that must be edited:

• properties.ini - main configuration file

• cluster.list - main hostname list file

• ip.list- secondary hostname file

The files are preconfigured with default values for most parameters. Check whether anything needs to be changed to meet the needs of your environment.

Change the hostnames in the files to match those of the environment is imperative.

In the properties.inifile, look for the SPECIFIC TO settings and make the necessary changes to match your environment.

In the SPECIFIC TO AUTO_ENVSETUPsection, make sure the username and password are configured correctly in usernm, userpw and rootpw.

In the SPECIFIC TO INSTALL_MYSQL, note the RDB password, configured in dbuspw, as it will be used later.

In the cluster.list, make sure to change the hostnames and adapt the number of hosts in each component so that it matches the environment.

By default, the file is configured for a cluster of three nodes. If the environment has, for example, only one node, remove the references to nodes 2 and 3 and replace all names with your server hostname.

In the ip.list, make sure to change the hostnames and the IP addresses to match the environment, following the format <hostname>|<IP address> on each line.

Running the automatic environment setup

The automatic environment setup, called auto_envsetup.sh, is the automation for configuring the environment. You need to run this script when building a new server from scratch.

To run the script, execute the following command:

/opt/griaule/tools/auto_envsetup/auto_envsetup.sh --all

Then, it is recommended to update all packages, if possible:

yum update -y

Installing the RDB

To use GBDS, you will need a relational database installed and configured. You can choose between MySQL Server or NDB Cluster.

You only need to perform one RDB installation.

MySQL Server

It is recommended to install MySQL on the master node.

To install MySQL Server, run:

/opt/griaule/tools/install_mysql/install_mysql.sh --single

Then, proceed to Configuring the RDB password.

NDB Cluster

The NDB installation MUST be on the MASTER.

nodeOr, if you choose to install NDB Cluster, run:

/opt/griaule/tools/install_mysql/install_mysql.sh --cluster

Then, proceed to Configuring the RDB password.

Configuring the RDB password

After the installation, try logging in to MySQL by running the command:

mysql -u root -p

And entering the password configured in the file properties.ini in dbuspw, as mentioned in the previous step.

If you can log in, the installation and password configuration were successful and you can proceed to Configuring MySQL.

---

If you cannot log in and you see the following error:

Error: Access denied for user '<username>'@'<host>' (using password: YES)

You will need to change the password manually. To do this, use the following command to obtain the temporary password created during installation:

grep "temporary password" /var/log/mysqld.log

Copy the temporary password shown.

Then, change the password using the following command:

Make sure to replace <desired_password> with the desired password. Keep the quotes.

mysqladmin -u root -p password "<desired_password>"
                                ^^^^^^^^^^^^^^^^

When prompted, enter the temporary password.

Then, try logging in to MySQL again using the new password.

If you can log in, the installation and password configuration were successful and you can proceed to Configuring MySQL.

Configuring MySQL

Finally, configure the database for your environment.

The configuration file is located at: /etc/my.cnf.

The default RDB installation settings may not be the desired settings. Check them in the configuration file my.cnf and adapt them to meet the needs of the environment.

After making the necessary changes, apply them by restarting the service:

systemctl restart mysqld

Installing Ambari

To install Ambari via Ansible, it is necessary to access the Griaule repository.

If your GBDS RDB is not on the MASTERnode, it is recommended to start another RDB instance for Ambari.

The installation requires an internet connection and may take 45 minutes to complete without errors. Before installing, check that your connection is stable.

To start the Ambari installation, enter the Ansible directory:

cd /etc/ansible

Then, download the package:

wget <Ambari Ansible package link>
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you do not have the link, contact the Griaule Support Team.

Next, extract the files into the main Ansible directory, /etc/ansible, with the following command:

In the command below, make sure to replace <version> with the version of the package that was downloaded.

tar -xvf ansible_hdp-<version>.tar
                     ^^^^^^^^

Enter the extracted directory:

cd /etc/ansible/ansible-hadoop

Since the process takes some time to complete, it is recommended to run the installation script using screen to avoid interruptions.

To do this, install screen:

yum install screen -y

Start a new session in screen:

screen -S ambari-install

Then, proceed with running the installation script as described below.

—

If the connection to the server is lost, the script will not be interrupted and you can resume the session by reconnecting to the server and running:

screen -r ambari-install

Then, run the installation script:

./full-hadoop.sh

Answer the installation questions and proceed until finished.

Once started, DO NOT interrupt any of the scripts. If any problem occurs, contact the Griaule support team.

Installing GBDS

To install GBDS, you will need:

• GBDS Cluster .rpm

• GBDS Distribution .rpm

• GBDS RDB dump script .sql

• OpenCV package link

Start by moving the two .rpm files to the /opt/griaule/tools/deploy_application/files.

The .sql dump script file must be saved in another directory.

After running the following script, all contents of the /opt/griaule/tools/deploy_application/files directory will be deleted.

Then, run the following command to install GBDS:

/opt/griaule/tools/deploy_application/deploy_application.sh --gbds

After trying to run the script above, if you get the error:

[ERROR] No OPENCV RPM found to be deployed. Make sure to stage the desired RPM

Enter the files:

cd /opt/griaule/tools/deploy_application/files

And download the OpenCV package:

wget <OpenCV package link>
     ^^^^^^^^^^^^^^^^^^^^^

Then, try running the deploy_application.sh script again.

Next, run the RDB dump script on the SQL server.

mysql -u root -p < /PATH/TO/FILE/clear-rdb-<version>.sql
                   ^^^^^^^^^^^^^^^^^          ^^^^^^^^

The RDB password was configured here.

After finishing the GBDS installation, configure it by running:

/opt/griaule/tools/auto_appconfig/auto_appconfig.sh --gbds

To review or manually change the settings, edit the configuration file located at: /etc/griaule/conf/gbds/application.conf. For more information about the settings, see the GBDS Configuration Manual.

Make sure that the hostname in the configuration file (application.conf) matches the hostname of the server.

Then, start the GBDS API:

service gbsapid start

Test whether the API is running:

curl http://<host-ip>:8085/gbds/v2/operations/ping
            ^^^^^^^^^

The expected response is:

{
	"data": "pong!"
}

Finally, start GBDS:

gbdsstart

And monitor the execution log :

gbdslogt

Installing GBS applications

To install the GBS Applications, you will need:

• File .war for each application

• Dump script .sql for each application

First, install and configure Tomcat for the web applications. This should only be done on the server that will host the web applications. Use the following command:

/opt/griaule/tools/install_services/install_services.sh

Then, move the files .war files to the /opt/griaule/tools/deploy_application/files and run the command:

/opt/griaule/tools/deploy_application/deploy_application.sh --services

After that, configure the applications with the following command:

/opt/griaule/tools/auto_appconfig/auto_appconfig.sh --services

To explore the individual settings of each application, consult the corresponding configuration manuals listed here.