Difference between revisions of "Retain Linux Install"

From GWAVA Technologies Training
Jump to: navigation, search
(→‎Prerequisites for Retain 3.5:)
(→‎MySQL JDBC driver install)
 
(97 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
==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 for Retain 3.5: ==
+
==Prerequisites ==
 +
===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.
  
−
# Create disks for best practices
+
====Download MySQL ====
−
#* OS
+
You can use MySQL 5.5, 5.6, or 5.7
−
#* ARCHIVE
+
 
−
#* INDEX
+
===MySQL 5.6===
−
#* LOGS
+
[[MySQL56_SLES11_Installation]]
−
#* DATA
+
 
 +
===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)';
 +
 
 +
<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===
 +
All versions of Retain need a webserver installed, which tomcat will be installed onto.
 +
 
 +
====Install HTTP Server====
 
# Install http server (apache2) from YaST
 
# Install http server (apache2) from YaST
 
# If connecting to Exchange:
 
# If connecting to Exchange:
 
## Set DNS to Exchange server, in YaST/Network Settings
 
## Set DNS to Exchange server, in YaST/Network Settings
−
# Create MySQL download directory
+
 
−
##* md /software/mysql directory and change to it
+
The Retain installer will download Java and MySQL if you wish.
−
## download MySQL Community Server '''5.5.42''' [http://dev.mysql.com/downloads/mysql/] direct? [http://dev.mysql.com/downloads/file.php?id=455557] to that mysql directory
+
 
−
##* <code>wget "http://dev.mysql.com/get/archives/mysql-5.5/MySQL-5.5.42-1.sles11.x86_64.rpm-bundle.tar"</code>
+
==Install==
−
## Extract the MySQL client and MySQL server or just untar the whole thing
+
===Download Retain===
−
##* <code>tar -xf MySQL-5.5.42-1.sles11.x86_64.rpm-bundle.tar</code>
+
 
# Create Retain download directory
 
# Create Retain download directory
 
##* md /software/retain[version] directory and change to it
 
##* md /software/retain[version] directory and change to it
Line 25: Line 63:
 
##* <code>chmod +x *.sh</code>
 
##* <code>chmod +x *.sh</code>
  
−
== Install: ==
+
===Install Retain===
−
 
+
# <code>./RetainInstall.sh</code> Retain 4 requires extensive resources the lab doesn't have, see your mentor about provisioning.
−
# <code>./RetainInstall.sh</code>
+
# Install typical modules:
−
# install modules:
+
 
#* Retain Server
 
#* Retain Server
 
#* Reporting & Monitoring
 
#* Reporting & Monitoring
 
#* Worker
 
#* Worker
−
# setup database, using MySQL
+
#* 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 it the path from above
 
#* give mysql root user a password (remember this)
 
#* give mysql root user a password (remember this)
−
#* create a database, username and password
+
#* create a database (retain), username (retain) and password
−
# take the defaults
+
# Take the defaults and finish the install
 +
 
 +
===Post-install Tasks===
 +
====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 [https://dev.mysql.com/downloads/connector/j/]
 +
#Extract Connector/J <code>tar –xzvf  mysql-connector-java-5.1.39.tar.gz</code>
 +
#Stop Tomcat [http://support.gwava.com/kb/?View=entry&EntryID=1436]
 +
#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 <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.jar'''</code>
 +
#Start Tomcat
 +
 
 +
====Set Disk Permissions if using Multiple Data Volumes====
 
# If using multiple disks:
 
# If using multiple disks:
 
## Stop tomcat <code>rcretain-tomat7 stop</code>
 
## Stop tomcat <code>rcretain-tomat7 stop</code>
 
## Change ownership on INDEX and LOGS to <code>chown -R tomcat:tomcat /[volume]</code>
 
## Change ownership on INDEX and LOGS to <code>chown -R tomcat:tomcat /[volume]</code>
 
## Change permissions on INDEX and LOGS to <code>chmod -R 774 /[volume]</code>
 
## Change permissions on INDEX and LOGS to <code>chmod -R 774 /[volume]</code>
−
## Change ownership on DATA to <code>chown -R mysql:mysql /DATA </code>
+
## Change ownership on DATABASE to <code>chown -R mysql:mysql /DATABASE </code>
−
## Change permissions on DATA to <code>chmod -R 774 /DATA </code>
+
## Change permissions on DATABASE to <code>chmod -R 774 /DATABASE </code>
 
## 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-tomat7 start</code>
+
## Start tomcat <code>rcretain-tomcat7 start</code>
−
# Otherwise, configure the server.
+
−
 
+
−
== Server Configuration ==
+
  
−
# Browse to [retain server]/RetainServer
+
=====Change Log Location=====
−
# If using a single disk, take the defaults
+
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.
−
# Otherwise, use advanced options to specify multiple disks.
+
−
# Set DB User to retain
+
−
# Set DB ROOT User to root
+
−
# Set Search engine to Lucene
+
  
−
== Retain Configuration ==
+
# 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
  
−
# Module Configuration and set up a module
+
----
−
## GroupWise
+
−
### Go to GWAdmin
+
−
### Go to System/Trusted Applications
+
−
#### Create new: Retain
+
−
#### Copy Trusted Application Key (save someplace safe)
+
−
### Go to Retain/Module Configuration/GroupWise
+
−
#### SOAP:
+
−
##### Copy Trusted Application Key to field
+
−
##### Set POA Host name to IP|domain name of post office
+
−
##### Test Connection
+
−
##### Save Changes
+
  
−
# Reporting and Monitoring Configuration and set up R&M
+
==Next Step==
−
## Core Settings:
+
[[Retain Post Install Configuration]]
−
### Enable: Disable the disk usage statistics
+
−
### Enable: Disable the number of messages statistics
+
−
## Connection:
+
−
### Set server host names to IP or domain name, not localhost
+
−
## Save bootstrap
+
−
## Click on Reporting and install bootstrap
+
  
−
== Job Configuration ==
+
Return to [[Retain Training]]
−
# Create Initial Dredge Schedule
+
−
## Single for Initial Dredge
+
−
## Save Changes
+
−
# Create Initial Dredge Profile
+
−
## Scope tab:
+
−
### All Messages
+
−
### Try to publish all messages (SLOW)
+
−
### Enable Retention and Item Store Flag
+
−
### Save Changes
+
−
# Create Worker
+
−
## Local Worker is good, if the worker is remote name it after the server it is on.
+
−
## Polling:
+
−
### Poll for configuration every 60 minutes is usually enough
+
−
## Logging:
+
−
### Diagnostic (so we don't have to try to reproduce the issue, which may take hours)
+
−
## Module specific
+
−
### POA Host Name should be blank
+
−
## Save Changes
+
−
### Save Bootstrap
+
−
### Open Worker web page (http://[Workerhost]/RetainWorker
+
−
### Upload
+
−
# Create Initial Dredge Job
+
−
## Core Settings:
+
−
### Set Schedule, Profile and Worker as created above
+
−
## Mailboxes:
+
−
### Select Mail Server(s) to dredge
+
−
## Notification:
+
−
### Enable Mail when errors occur and Mail summary when job is complete
+
−
## Save Changes
+
−
# Run Job
+
−
## Go to Schedules and set the minutes back 1 min.
+
−
## Go to Worker Web Console and click on "Refresh job cache now"
+
−
## Go to Status and determine if job is running properly.
+

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.

  1. Create the disks in the VM software
  2. 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

MySQL56_SLES11_Installation

[edit] MySQL 5.7

MySQL57_SLES12_Installation

[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

  1. Install http server (apache2) from YaST
  2. If connecting to Exchange:
    1. 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

  1. Create Retain download directory
      • md /software/retain[version] directory and change to it
    2. download the current version of Retain [1] or the beta.
  2. Unzip Retain
      • chmod +x *.sh

[edit] Install Retain

  1. ./RetainInstall.sh Retain 4 requires extensive resources the lab doesn't have, see your mentor about provisioning.
  2. 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
  3. 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
  4. 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.

  1. Download Connector/J 5.1.21 or higher [2]
  2. Extract Connector/J tar –xzvf mysql-connector-java-5.1.39.tar.gz
  3. Stop Tomcat [3]
  4. 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)
  2. Change the ownership of the jar file to match the other files with chown tomcat:www mysql-connector-java-5.1.39-bin.jar
  3. Change the permissions of the jar file to match the other files with chmod 755 mysql-connector-java-5.1.39-bin.jar
  4. Start Tomcat

[edit] Set Disk Permissions if using Multiple Data Volumes

  1. If using multiple disks:
    1. Stop tomcat rcretain-tomat7 stop
    2. Change ownership on INDEX and LOGS to chown -R tomcat:tomcat /[volume]
    3. Change permissions on INDEX and LOGS to chmod -R 774 /[volume]
    4. Change ownership on DATABASE to chown -R mysql:mysql /DATABASE
    5. Change permissions on DATABASE to chmod -R 774 /DATABASE
    6. Change ownership on ARCHIVE to chown -R tomcat:tomcat /ARCHIVE
    7. Change permissions on ARCHIVE to chmod -R 777 /ARCHIVE
    8. Start tomcat rcretain-tomcat7 start
[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.

  1. Create the directory in the location you wish to use
  2. Stop tomcat
  3. Move the current logs to the new location: mv /var/log/retain-tomcat7/* /[path to new directory]
  4. Make tomcat the owner of the new directory path: chown -R tomcat:tomcat /[path to new directory]
  5. 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
  6. Create a symbolic link in the parent directory of the default logs directory and point it to the new location:
    1. Change to the /var/log directory
    2. Remove the current log directory: rm -r retain-tomcat7
    3. 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)
  7. Set the new Start tomcat

[edit] Next Step

Retain Post Install Configuration

Return to Retain Training

Retrieved from "https://traininggwava.microfocus.net/index.php?title=Retain_Linux_Install&oldid=314753"
Personal tools
Namespaces

Variants
Actions
Home
Exchange
GroupWise
JAVA
Linux
MTK
Retain
GW Monitoring and Reporting (Redline)
GW Disaster Recovery (Reload)
GW Forensics (Reveal)
GWAVA
Secure Messaging Gateway
GW Mailbox Management (Vertigo)
Windows
Other
User Experience
Toolbox
Languages
Toolbox