Difference between revisions of "Retain Linux Install"
|  (→Post-install Tasks) |  (→MySQL JDBC driver install) | ||
| (63 intermediate revisions by 3 users not shown) | |||
| Line 10: | Line 10: | ||
| ==Prerequisites == | ==Prerequisites == | ||
| ===Database=== | ===Database=== | ||
| − | For Retain 4.x you need to manually download and install a database.   | + | For Retain 4.x you need to manually download and install a database. Retain can use MySQL, Oracle, MS SQL server, PostGres or MariaDB. For training use MySQL because it's free. | 
| ====Download MySQL ==== | ====Download MySQL ==== | ||
| − | You can  | + | You can use MySQL 5.5, 5.6, or 5.7 | 
| − | + | ===MySQL 5.6=== | |
| − | + | [[MySQL56_SLES11_Installation]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | === | + | ===MySQL 5.7=== | 
| − | + | [[MySQL57_SLES12_Installation]] | |
| − | + | ||
| − | === | + | ===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. | |
| − | + | ||
| − | + | <code>Log into MySQL: </code> | |
| + |  mysql -u root -p | ||
| − | + | <code>Create the retain database by typing in: </code> | |
| + |  CREATE DATABASE retain DEFAULT CHARACTER SET 'utf8' DEFAULT COLLATE 'utf8_bin'; | ||
| − | + | Create a new user by typing in:  | |
| + |  CREATE USER 'retainuser' @'localhost' IDENTIFIED BY 'P@ssw0rd'; | ||
| + | *For internal GWAVA test systems you may go ahead and use the ''root'' user for MySQL. For customers it is recommended to create a new user.   | ||
| − | + | <code>Give the user the necessary right to the Retain database. After creating the database type in: </code> | |
| − | + |  GRANT ALL PRIVILEGES ON retain.* TO '(UserName)'@'%' IDENTIFIED BY '(P@ssw0rd)'; | |
| − | + |  GRANT ALL PRIVILEGES ON retain.* TO '(Username)'@'localhost' IDENTIFIED BY '(P@ssw0rd)'; | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | After the  | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| + | <code>Example:</code> | ||
| + |  GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'%'  IDENTIFIED BY 'P@ssw0rd'; | ||
| + |  GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'localhost' IDENTIFIED BY 'P@ssw0rd'; | ||
| ===Webserver=== | ===Webserver=== | ||
| Line 126: | Line 79: | ||
| ===Post-install Tasks=== | ===Post-install Tasks=== | ||
| ====MySQL JDBC driver install==== | ====MySQL JDBC driver install==== | ||
| − | If using MySQL  | + | If using MySQL: | 
| The MySQL Connector/J  driver must be provided to the Retain Server and/or the Reporting and Monitoring Server and/or the Stubbing Server. | The MySQL Connector/J  driver must be provided to the Retain Server and/or the Reporting and Monitoring Server and/or the Stubbing Server. | ||
| Line 134: | Line 87: | ||
| #Copy the mysql-connector-java-5.1.39-bin.jar file to   | #Copy the mysql-connector-java-5.1.39-bin.jar file to   | ||
| #*...RetainServer/WEB-INF/lib (for Retain Server)   | #*...RetainServer/WEB-INF/lib (for Retain Server)   | ||
| + | If the Reporting and Monitoring and Stubbing Servers are installed add the JDBC file into those as well.  | ||
| #*...RetainStatsServer/WEB-INF/lib (for the Reporting and Monitoring Server)   | #*...RetainStatsServer/WEB-INF/lib (for the Reporting and Monitoring Server)   | ||
| #*...RetainStubbingServer/WEB-INF/lib (for the Stubbing Server) | #*...RetainStubbingServer/WEB-INF/lib (for the Stubbing Server) | ||
| − | #Change the ownership of the jar file to match the other files with <code>chown tomcat:www mysql-connector-java-5.1.39-bin.jar</code> | + | #Change the ownership of the jar file to match the other files with <code>'''chown tomcat:www mysql-connector-java-5.1.39-bin.jar'''</code> | 
| − | #Change the permissions of the jar file to match the other files with <code>chmod 755 mysql-connector-java-5.1.39-bin</code> | + | #Change the permissions of the jar file to match the other files with <code>'''chmod 755 mysql-connector-java-5.1.39-bin.jar'''</code> | 
| #Start Tomcat | #Start Tomcat | ||
| Line 149: | Line 103: | ||
| ## Change ownership on ARCHIVE to <code>chown -R tomcat:tomcat /ARCHIVE </code> | ## Change ownership on ARCHIVE to <code>chown -R tomcat:tomcat /ARCHIVE </code> | ||
| ## Change permissions on ARCHIVE to <code>chmod -R 777 /ARCHIVE </code> | ## Change permissions on ARCHIVE to <code>chmod -R 777 /ARCHIVE </code> | ||
| − | ## Start tomcat <code>rcretain- | + | ## Start tomcat <code>rcretain-tomcat7 start</code> | 
| + | |||
| + | =====Change Log Location===== | ||
| + | To change the location of the log files, simply create a symbolic link (somewhat synonymous with Windows shortcuts).  Retain, by default, gives you the option during installation to store the logs at /var/log/retain-tomcat7 or at /opt/beginfinite/retain/tomcat7.  If stored at /var/log/retain-tomcat7, then Retain creates a symbolic link at /opt/beginfinite/retain/tomcat7 directory called 'logs" that points to the /var/... location. | ||
| + | # Create the directory in the location you wish to use | ||
| + | # Stop tomcat | ||
| + | # Move the current logs to the new location:  mv /var/log/retain-tomcat7/* /[path to new directory] | ||
| + | # Make tomcat the owner of the new directory path:  chown -R tomcat:tomcat /[path to new directory] | ||
| + | # Set the appropriate file *permissions for the tomcat user and group:  chmod -R 664 /[path to new directory] | ||
| + | #* If you are moving them to a separate volume, the file permissions must be 774 | ||
| + | # Create a symbolic link in the parent directory of the default logs directory and point it to the new location: | ||
| + | ## Change to the /var/log directory | ||
| + | ## Remove the current log directory:  rm -r retain-tomcat7 | ||
| + | ## Create a new symbolic link called retain-tomcat7 that points to your new log location:  ln -s [path to new directory] ./retain-tomcat7 (and press ENTER) | ||
| + | # Set the new Start tomcat | ||
| ---- | ---- | ||
Latest revision as of 19:32, 6 December 2017
| Contents | 
[edit] 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)
 
 
[edit] Prerequisites
[edit] Database
For Retain 4.x you need to manually download and install a database. Retain can use MySQL, Oracle, MS SQL server, PostGres or MariaDB. For training use MySQL because it's free.
[edit] Download MySQL
You can use MySQL 5.5, 5.6, or 5.7
[edit] MySQL 5.6
[edit] MySQL 5.7
[edit] 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.
Log into MySQL: 
mysql -u root -p
Create the retain database by typing in: 
CREATE DATABASE retain DEFAULT CHARACTER SET 'utf8' DEFAULT COLLATE 'utf8_bin';
Create a new user by typing in:
CREATE USER 'retainuser' @'localhost' IDENTIFIED BY 'P@ssw0rd';
- For internal GWAVA test systems you may go ahead and use the root user for MySQL. For customers it is recommended to create a new user.
Give the user the necessary right to the Retain database. After creating the database type in: 
GRANT ALL PRIVILEGES ON retain.* TO '(UserName)'@'%' IDENTIFIED BY '(P@ssw0rd)'; GRANT ALL PRIVILEGES ON retain.* TO '(Username)'@'localhost' IDENTIFIED BY '(P@ssw0rd)';
Example:
GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'%' IDENTIFIED BY 'P@ssw0rd'; GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'localhost' IDENTIFIED BY 'P@ssw0rd';
[edit] Webserver
All versions of Retain need a webserver installed, which tomcat will be installed onto.
[edit] 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.
[edit] Install
[edit] Download Retain
-  Create Retain download directory
- md /software/retain[version] directory and change to it
 
- download the current version of Retain [1] or the beta.
 
-  Unzip Retain
-  chmod +x *.sh
 
-  
 
[edit] Install Retain
-  ./RetainInstall.shRetain 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
[edit] Post-install Tasks
[edit] MySQL JDBC driver install
If using MySQL:
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 [2]
- Extract Connector/J tar –xzvf mysql-connector-java-5.1.39.tar.gz
- Stop Tomcat [3]
- Copy the mysql-connector-java-5.1.39-bin.jar file to 
- ...RetainServer/WEB-INF/lib (for Retain Server)
 
If the Reporting and Monitoring and Stubbing Servers are installed add the JDBC file into those as well.
- ...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.jar
- Start Tomcat
[edit] 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-tomcat7 start
 
-  Stop tomcat 
[edit] Change Log Location
To change the location of the log files, simply create a symbolic link (somewhat synonymous with Windows shortcuts). Retain, by default, gives you the option during installation to store the logs at /var/log/retain-tomcat7 or at /opt/beginfinite/retain/tomcat7. If stored at /var/log/retain-tomcat7, then Retain creates a symbolic link at /opt/beginfinite/retain/tomcat7 directory called 'logs" that points to the /var/... location.
- Create the directory in the location you wish to use
- Stop tomcat
- Move the current logs to the new location: mv /var/log/retain-tomcat7/* /[path to new directory]
- Make tomcat the owner of the new directory path: chown -R tomcat:tomcat /[path to new directory]
-  Set the appropriate file *permissions for the tomcat user and group:  chmod -R 664 /[path to new directory]
- If you are moving them to a separate volume, the file permissions must be 774
 
-  Create a symbolic link in the parent directory of the default logs directory and point it to the new location:
- Change to the /var/log directory
- Remove the current log directory: rm -r retain-tomcat7
- Create a new symbolic link called retain-tomcat7 that points to your new log location: ln -s [path to new directory] ./retain-tomcat7 (and press ENTER)
 
- Set the new Start tomcat
[edit] Next Step
Retain Post Install Configuration
Return to Retain Training
