Table of Contents

Prerequisites

• Ensure your deployment can meet the system requirements for Zephyr 6.1
  • Zephyr Server System Requirements 
  • Zephyr Data Center System Requirements
  • Zephyr Cloud Deployment 
  • Zephyr Server Sizing & Utilization  
    
    
• Ensure you have your Zephyr and any plugin license files 
  
  
• Download and install the required software: 
  • JAVA JDK: Oracle Version 1.8 Download: here
    
    
  • MySQL: 5.6.x Series only Download: here
    
    
  • Elastic Search (5.5.0 only): Download here
    
    
  • Zephyr 6.1 Linux Installer: Download from here
    
    

Install Software Dependencies

The following software will need to be installed:

1. Install Oracle JAVA JDK 1.8: Please see the Oracle website or documentation for your Linux distribution for JAVA installation instructions.  
   
   
2. Install MySQL:  A database server is required to use Zephyr and MySQL is the default for single server installations. If you plan to use MS SQL or Oracle please see our Zephyr Data Center installation instructions.
   
   
3. Configure MySQL:  See the recommended database settings below.
   
   
4. Install Elasticsearch:  It is now a requirement to install Elasticsearch as a separate process. Zephyr Server installations you can install this on the same VM as the Zephyr server application. 
   
   
5. Install / Configure Zephyr server: The installer will walk you through the application configuration options necessary for a new installation.
   
   

Install & Configuring MySQL

1. Install MySQL Server according to the instructions for your Linux distribution: https://dev.mysql.com/downloads/mysql/5.6.html
   
   
2. Configure MySQL with the following settings below and restart the MySQL service. You will need to edit the my.cnf file and add the following configuration settings.  Depending on your linux distribution this may be in the /etc folder. 
   
   

[mysqld]
user=mysql
max_allowed_packet = 150M
max_connections = 600
default-storage-engine=INNODB
character-set-server=utf8
collation-server=utf8_unicode_ci
sql_mode=NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES

[mysqld_safe]
default-storage-engine=INNODB
character-set-server=utf8
collation-server=utf8_unicode_ci

[mysql]
max_allowed_packet = 150M

[mysqldump]
quick
max_allowed_packet = 150M

NOTE: You may run into an issue where the "max_connections" setting does not actually reflect in MySQL. This could be due to a file open limit built into the Linux operating system. Please see these instructions for how to setup MySQL and Systems to adjust for the "LimitNOFILE" setting.  https://dev.mysql.com/doc/refman/5.7/en/using-systemd.html

Install & Configure Elasticsearch

1. Download  Elasticsearch 5.5.0: https://www.elastic.co/downloads/past-releases
   
   
2. Install Elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/5.5/_installation.html
   
   
3. Navigate to the Elasticsearch installation path: etc/elasticsearch
   
   

4. Edit the elasticsearch.yml file to match the parameters below and save the file:

   Single node Elastic Search

   cluster.name: zephyr
   node.name: "Node1"
   node.master: true
   node.data: true
   script.inline: true
   script.indexed: true
   network.bind_host: (host IP of the server elastic search is installed)
   network.publish_host: (host IP of the server elastic search is installed)
   network.host: (host IP of the server elastic search is installed)
   transport.tcp.port: 9300
   http.port: 9200
   
   indices.query.bool.max_clause_count : 4096

5. Restart the Elasticsearch system service 
   
   
   

Install Zephyr Enterprise 6.1

Note: The user will be prompted to enter the Elastic Search server and port number as part of the installation process. Please ensure that the user has installed Elastic Search prior to installing Zephyr Enterprise.

Step 1.) Set the permissions.

• The name of the setup file below may be different and may correspond more to your Zephyr Enterprise 6.1.

shell> chmod +x zephyr_(Build Number)_linux_setup.sh

Step 2.) Launch the setup file with the '-c' command line option as shown below.

Step 3.) You'll be prompted with a quick reminder on the Requirements needed to install and run Zephyr successfully on Linux.

Step 4.) You'll be prompted with the full EULA.

• You must accept the terms presented before proceeding with the installation.
• Simply enter "1" to accept and "2" to decline.

Step 5.) You'll then be prompted to enter where to place the Zephyr Enterprise home directory.

• You'll also be notified of the required and available disk space as per the system requirements.

Step 6.) You'll then be prompted to enter the directory location of the license file that has been provided.

Step 7.) If you have any additional Zephyr plugins (Vortex, Cyclone, etc.) that you want to add, enter in the location of the license files for your Zephyr plugins.

• If you have Zephyr already installed:
  • Stop the Zephyr service
  • Go to the zephyr installation directory
  • Copy the license file in license folder
  • Restart the Zephyr service

Step 8.) This step allows you to customize any of the ports utilized by Zephyr Enterprise.

• The suggested ports are within the brackets.
• You are able to change the port usage by entering your own custom port numbers for each step.

Step 9.) You'll then be prompted to select your Database.

• For Zephyr Enterprise Server installation, MySQL is the default database option.
• If you are interested in using another database, please contact your Zephyr Account Manager for further information.

Step 10.) This step allows you to customize the MySQL parameters.

• Enter the URL for your MySQL Database.
• Enter the directory location of the JDBC driver.
  
  

Step 11.) Configuring Elastic Search

During this step you will be prompted to configure Elastic Search.  Input the following information when prompted:

transport.nodes = "IP address of the Elastic Search computer"
transport.nodes Port = "The default port is 9300"

#Example
transport.nodes=192.168.11.144:9300

• Note that the transport node IP address may be the same system upon which you are installing Zephyr.
• If you used a different port when configuring Elastic Search please use that port. 
  
  

Step 12.) Once configured and customized, the files should now be copied and there will be various services that may start. Wait until the services are complete.

• Once the additional services are complete, the installation process for Zephyr Enterprise 6.1 is complete.

Step 13.) You'll then be prompted to launch Zephyr Enterprise and you may launch Zephyr Desktop by entering "Y".

If you've already installed the Elastic Search, you must configure the Elastic Search to be able to use Zephyr Enterprise.