Retain Linux Install
Multiple Disks
Create multiple disks to follow Retain best practices. This is optional but recommended.
- Create the disks in the VM software
- Format the disks in the VM itself using YaST/Partitioner, these values should be large enough for a few million small messages
- ARCHIVE (60-80GB)
- INDEX (15-30GB)
- LOGS (6-15GB)
- DATABASE (20-40GB)
Prerequisites
Database
For Retain 4.x you need to manually download and install a database.
Download MySQL
You can use MySQL 5.5 or 5.6, this will use 5.6
- Create a directory and download it md /software/mysql directory and change to it
- download MySQL Community Server 5.5 [1] direct [2] or 5.6[3] direct [4] to that mysql directory
Unzip MySQL
Unzip the MySQL package:
tar –xvf MySQL-5.6.33-1.sles11.x86_64.rpm-bundle.tar
Install the MySQL server and client
Install with rpm:
rpm –ivh MySQL-client-5.6.33-1.sles11.x86_64.rpm
rpm –ivh MySQL-server-5.6.33-1.sles11.x86_64.rpm
Changing the Data Directory for MySQL (optional)
By default the location of the MySQL data is going to go into the /var/lib/mysql directory. If you wish to change where the database is installed, follow these instructions. If not skip this step.
To change the where MySQl database gets installed follow these steps:
Create a directory where you want the MySQL database stored.
- <code>Change the ownership rights to the newly created directory to mysql: <code>chown –r mysql:mysql /directory
Start MySQL.
This will create the database files in the default location found in /var/lib/mysql directory.
- <code>Stop MySQL
- <code>Copy all of the MySQL files from the /var/lib/mysql directory to the new directory that was created.
- <code>Edit the my.cnf file.
This is usually found in the /etc directory. Find the section [mysqld] and underneath type in:
datadir=[new directory path]
Note: If you cannot find the my.cnf file, create one and add in the [mysqld] section yourself, and the datadir= line.
Double check the ownership and permissions.
- <code> Start MySQL. <code>service mysql start
Change Root Password in MySQL (Post-Installation)
After the installation, MySQL 5.6 will create a random password for the root user.
To access this password type: cd [ENTER]. This will take you back to the root directory.
Then type: cat .mysql_secret. This will display the random password. You will need this to change the root password.
To change the root password follow these steps: [5]
- Start MySQL
rcmysql start
- Type:
mysql_secure_installation
- Enter in the password that you got from the /root/.mysql_secret file.
- When it asks to change the password say yes, and make the change.
- Proceed through the rest of the prompts and say yes to all of them.
- Log into MySQL by typing:
mysql –u root –p
and type in the new root password.
Create a New User (Not Required)
You can use the root user and password for Retain. However, if you’d like to create a new user instead, follow these steps:
Log into MySQL: mysql –u root –p
and enter in the password.
Type: use MySQL
Create a new user by typing in: create user ‘retainuser’ @’localhost’ identified by ‘password’;
Create Retain Database and Assign Rights and Permission to User
Create your database according to the documentation: Type in the follow commands one at a time.
CREATE DATABASE retain DEFAULT CHARACTER SET 'utf8' DEFAULT COLLATE 'utf8_bin';
Create a new user by typing in: create user ‘retainuser’ @’localhost’ identified by ‘password’;
GRANT ALL PRIVILEGES ON retain.* TO '(UserName)'@'%' IDENTIFIED BY '(Password)';
GRANT ALL PRIVILEGES ON retain.* TO '(Username)'@'localhost' IDENTIFIED BY '(Password)';
Webserver
All versions of Retain need a webserver installed, which tomcat will be installed onto.
Install HTTP Server
- Install http server (apache2) from YaST
- If connecting to Exchange:
- Set DNS to Exchange server, in YaST/Network Settings
The Retain installer will download Java and MySQL if you wish.
Install
Download Retain
- Create Retain download directory
- md /software/retain[version] directory and change to it
- download the current version of Retain [6] or the beta.
- Unzip Retain
-
chmod +x *.sh
-
Install Retain
-
./RetainInstall.sh
Retain 4 requires extensive resources the lab doesn't have, see your mentor about provisioning. - Install typical modules:
- Retain Server
- Reporting & Monitoring
- Worker
- Skip Stubbing as very few customers use that functionality
- Skip the Router as that should be installed on its own server in the network DMZ
- Setup database, using MySQL
- give it the path from above
- give mysql root user a password (remember this)
- create a database (retain), username (retain) and password
- Take the defaults and finish the install
Post-install Tasks
MySQL JDBC driver install
If using MySQL on Linux:
The MySQL Connector/J driver must be provided to the Retain Server and/or the Reporting and Monitoring Server and/or the Stubbing Server.
- Download Connector/J 5.1.21 or higher [7]
- Extract Connector/J
tar –xzvf mysql-connector-java-5.1.39.tar.gz
- Stop Tomcat [8]
- Copy the mysql-connector-java-5.1.39-bin.jar file to
- ...RetainServer/WEB-INF/lib (for Retain Server)
- ...RetainStatsServer/WEB-INF/lib (for the Reporting and Monitoring Server)
- ...RetainStubbingServer/WEB-INF/lib (for the Stubbing Server)
- Change the ownership of the jar file to match the other files with
chown tomcat:www mysql-connector-java-5.1.39-bin.jar
- Change the permissions of the jar file to match the other files with
chmod 755 mysql-connector-java-5.1.39-bin
- Start Tomcat
Set Disk Permissions if using Multiple Data Volumes
- If using multiple disks:
- Stop tomcat
rcretain-tomat7 stop
- Change ownership on INDEX and LOGS to
chown -R tomcat:tomcat /[volume]
- Change permissions on INDEX and LOGS to
chmod -R 774 /[volume]
- Change ownership on DATABASE to
chown -R mysql:mysql /DATABASE
- Change permissions on DATABASE to
chmod -R 774 /DATABASE
- Change ownership on ARCHIVE to
chown -R tomcat:tomcat /ARCHIVE
- Change permissions on ARCHIVE to
chmod -R 777 /ARCHIVE
- Start tomcat
rcretain-tomat7 start
- Stop tomcat
Next Step
Retain Post Install Configuration
Return to Retain Training