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
    
    
  • MySQL Connector: 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. Upload Zephyr License: The Zephyr installer will need access to the license file provided. It will need to be first uploaded to the file system of the server.
   
   
6. Upload the MySQL Connector: The Zephyr installer will need access to the MySQL connector jar file downloaded. It will need to be first uploaded to the file system of the server.
   
   
7. 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:

   Code Block
   language java theme Midnight title 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 6.1

1. Ensure the installer file has the proper permissions to be executed:

   Code Block
   language bash theme Emacs
   shell> chmod +x zephyr_(Build Number)_linux_setup.sh

   
   

2. Launch the setup file with the '-c' command line option as shown below, and ensure to launch it as sudo or root: 

   Code Block
   language bash theme Emacs
   shell> sudo ./zephyr_(Build Number)_linux_setup.sh

   
   

3. You will be prompted to continue with the installer

   Code Block
   language bash theme Emacs
   Starting Installer... This will install Zephyr X.X on your computer OK [o, Enter], Cancel [c]

   
   

4. You may be prompted to choose between a new install or upgrade

   Code Block
   language bash theme Emacs
   Choose type: Install [1, Enter], Upgrade [2]

   
   

5. You will be prompted to confirm your system meets Zephyr Server Requirements 

   Code Block
   language bash theme Emacs
   Requirements Server OS: RedHat Enterprise CentOS Ubuntu/Debian SUSE/openSUSE CPU: Quad-core CPU Intel Pentium or AMD Opteron (2Ghz or higher) RAM: Minimum 16GB; Preferred 16GB Disk Space: At least 5GB Free Networking: Wired Ethernet Static IP address If Firewall exists, please allow ports 80, 443, 8005, 8009 , 3306 Account: Superuser (root) access to the machine Installer and services need to be installed as "root"

   
   

6. You will be prompted to agree to the Zephyr EULA

   Code Block
   language bash theme Emacs
   License Agreement D Software End User License Agreement IMPORTANT - PLEASE READ CAREFULLY: This End User License Agreement ("Agreement") constitutes a valid and binding agreement between D Software, INC. (”d software,” ”WE” or ”US”) and you, as either an individual or a single business entity ("you," "your" or "user") for the use of the Zephyr 6.1 software, ANY files that are delivered to you by d software to modify the Zephyr 6.1 software product, any online or enclosed documentation, and any updates, fixes and upgrades provided to you (collectively, the ”Software”). You must FIRST READ AND ACCEPT THE TERMS OF THIS LICENSE AGREEMENT by clicking on the ”i agree” checkbox below in order to install and use the Software.

   
   

7. Use the enter key till you see the following then choose 1 to agree.

   Code Block
   language bash theme Emacs
   I accept the terms of this license agreement [1], I do not accept the terms of this license agreement [2, Enter]

   
   

8. You will then be prompted to enter the path to place the Zephyr home directory.  

   Code Block
   language bash theme Emacs
   Select Destination Location Setup will install Zephyr into the following folder. To continue click Next. If you would like to select a different folder, click Browse [/usr/local/zephyr]

   
   

   
   

9. You will then be prompted to choose an installation type

   Code Block
   language bash theme Emacs
   Choose deployment type: Server deployment [1, Enter], Data Center deployment [2]

   
   

10. You will then be prompted to locate your license file

    Code Block
    language bash theme Emacs
    License File License Key File: [/home/zephyr/license.lic]

    
    

11. You will then be prompted to choose a port to run Zephyr on. By default Zephyr runs on port 80.

    Code Block
    language bash theme Emacs
    Customization Server Port : [80]

    
    

12. You will then be prompted to choose a Tomcat Server Shutdown port.  We recommend you leave it to the default

    Code Block
    language bash theme Emacs
    Tomcat Server Shutdown Port: [8005]

    
    

13. You will then be prompted to choose a database system. Use the default MySQL

    Code Block
    language bash theme Emacs
    Note: If you had just uninstalled. Please wait few miniutes for the port to get free and try again. Configure Database Database Type: MySQL [1, Enter]

    
    

14. You will then be prompted to provide a database username. Note this database user must have database create, update, and alter permissions.

    Code Block
    language bash theme Emacs
    Database Character Set: utf8 Username: []

    
    

15. You will then be prompted to provide a database password. 

    Code Block
    language bash theme Emacs
    Password: [] root

1. 
   

2. You will then be prompted to

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

Image Removed

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.

Image Removed

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

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

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.

Image Removed

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

1. provide a database connection string. If you installed MySQL on the same server as Zephyr you can use "jdbc:mysql://localhost:3306/"

   Code Block
   language bash theme Emacs
   Database URL Configuration: Sample URL: jdbc:mysql://localhost:3306/ Database URL: []

   
   

2. You will then be prompted to provide a connection string for Elasticsearch.  By default elastic search will bind to the IP configured in the elasticsearch.yml file edited earlier in the installation instructions. For example: "192.168.56.101:9300"

   Code Block
   language bash theme Emacs
   Configure Elasticsearch Enter the hostname or IP address and port used by Elasticsearch. For example: localhost:9300. Multiple Elasticsearch nodes should be separated by comma. For example: localhost:9300,localhost:9301 ES Host URL []

   
   

3. Zephyr will now install the required files and setup the MySQL database.

   Code Block
   language bash theme Emacs
   Extracting files .. # ************************************************************