Versions Compared

Version Old Version 24 New Version 25
Changes made by

Marc Ray (Deactivated)

Marc Ray (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Prerequisites

  • Ensure you meet system requirements for Zephyr Enterprise 6.1
    • Zephyr Server
    • Zephyr Data Centert (multi-node deployment)
    • Zephyr Cloud
  • Ensure you have your Zephyr Enterprise and any plugin license files 
  • Download the required software
    • Java: 
      • Java JDK 8u101 or higher
        • Downloaded from here
      • MySQL:
    • 5.6.33 or higher
      • Downloaded from here
    • MySQL Connector/J 5.1.41
      • Downloaded from here
      • Elastic Search (5.5.0Download from : Download here
    • Zephyr Enterprise 6.1 Linux Software: Download from here

Steps to Install the Required Software

The following sections need to be reviewed and will need to be completed to get Zephyr Enterprise up and running:

Expand
titleSystem Requirements
Panel

System Requirements

Zephyr Enterprise Server (for Linux On-Premise Installations only)

OS

RedHat Enterprise 64-bit

RHEL 7

.

0

CentOS 64-bit
Ubuntu/Debian 64-bit 
SUSE/openSUSE 64-bit

CPU

Quad-core CPU Intel Pentium or AMD Opteron (2Ghz or higher)

RAM

Minimum 8GB; Preferred 12GB

Disk Space

At least 5GB Free (250GB-1TB recommended for large enterprise installations)

Networking

Wired Ethernet
Static IP address
REQUIRED† Ports: 80, 443 (if HTTPS), 8005, 3306, 9300, 5701, 5702, 37000, 37001
Firewall (if present): Allow ports 80, 443 (if HTTPS). Must support WebSocket protocol
Proxy (if present): Must support WebSocket protocol

Account

Superuser (root) access to the machine 
Installer and services needs to run as "root"

Software

Java: Oracle JDK 8
Connector: JDBC 5.1.40
Note: NO other Tomcat or MySQL can be installed on the machine. JRE is not supported

Database

Embedded MySQL and remote MySQL only. All other supported databases use Zephyr Enterprise Data CenterDatabase property 'global_max_connections' must be set to 500 or above

Zephyr Client

OS

Any Desktop OS

Browser

Any one of these three with versions that support Web Sockets:

  • Chrome
  • Internet Explorer
  • Firefox

Networking

Client machine must have access to port 80 for HTTP connection (or 443 for HTTPS) to the Zephyr Server

OtherScreen resolution of 1280x1024 (1280x900 for widescreen) or higherZBots

OS

Windows Server 2008 / 2012 / 2016
Windows 7 Enterprise / Windows 8 Enterprise / Windows 10 Enterprise
Linux (RedHat, Fedora, Ubuntu, CentOS, SUSE) 
MacOS 
Only 32 bit supported

CPU

Dual-core CPU Intel Pentium or AMD Opteron (2Ghz or higher)

RAM

Minimum 1GB

Disk Space

At least 100MB Free

Networking

Wired Ethernet

Account

Administrator access to the machine 
Installer and services needs to "Run As Administrator"

Software

Oracle JDK 8. JRE is not supported. 32-bit only

Info
titleAdditional Notes

All port numbers mentioned are by default, and can be configured to fit your specific environment setup. If any firewalls or proxies are present, it is required that they support the WebSocket protocol.

Ports Explained:

  • 80, 443(if HTTPS), 8005 and 8009 are used by tomcat and can be configured in the server.xml file under zephyr\tomcat\conf\
  • 3306 is used by MySQL in Linux and configured in the my.cnf
  • 9300 is used by Elastic search
  • 5701, 5702, 37000, 37001 are used by Hazelcast

Software Version Explained:

  • The MySQL software has to be the major/minor (5.6.X) version
  • No other MySQL should be present on the server instance
  • Oracle JDK must be JDK 8u101 or higher. JRE is not supported
  • Zephyr Enterprise Server for Windows includes MySQL in the installation package on top of allowing remote MySQL
  • Zephyr Enterprise Server for Linux requires a separate installation of MySQL not included in the installation package on top of allowing remote MySQL
Expand
titleInstalling Java
Anchoranchor1anchor1 Panel

Installing Java

Step 1.) Execute the Java JDK installation with the command:

Code Block
themeEmacs
shell> rpm –ivh  jdk-8u101-linux-x64.rpm

Step 2.) Set the /usr/bin/java (also: javac javaws javadoc jar jcontrol) symbolic links to point to where the rpm installed the JDK.

Code Block
themeEmacs
shell> cd /usr/bin 
shell> rm -f java
shell> ln -s /usr/java/default/bin/java java

Step 3.) Add the JAVA_HOME environment variable to point to the location where Sun/Oracle Java version 8 Update 101 was installed.

Code Block
themeEmacs
shell> export JAVA_HOME=/usr/java/default

Step 4.) Update the PATH variable to point to the bin folder.

Code Block
themeEmacs
shell> export PATH=/usr/java/default/bin:$PATH

 
Step 5.) Optional: Verify the java installation version - Sun/Oracle Java JDK 8

Code Block
themeEmacs
shell> java –version

  1. Install Java (if not already installed)
  2. Install MySQL (if a database server is not already configured and available)
  3. Configure MySQL recommended settings (see below)
  4. Install and configure Elastic Search
  5. Install and configure Zephyr Enterprise







Expand
titleInstalling MySQL


Anchor
anchor2anchor2
Panel
Installing

Configuring MySQL

Step 1.) Install MySQL RPMs in the order shown below:

Code Block
themeEmacs
shell> rpm -ivh MySQL-client-5.6.33-1.linux_glibc2.5.x86_64.rpm
shell> rpm -ivh MySQL-shared-5.6.33-1.linux_glibc2.5.x86_64.rpm
shell> rpm -ivh MySQL-devel-5.6.33-1.linux_glibc2.5.x86_64.rpm
shell> rpm -ivh MySQL-server-5.6.33-1.linux_glibc2.5.x86_64.rpm

Step 2.) Set the MySQL root user password.  “server” rpm installation typically displays the following message. 

  • A random password has been set for the MySQL root user.
    • You can find the password in "/root/.mysql_secret".
    • When you first connect to the server, change the password.

Step 2.1) Start the MySQL Configure MySQL with the following settings below and restart the MySQL server.

Code Block
themeEmacs
shell> /etc/init.d/mysql start

Step 2.2.) Get the auto-generated password.

Code Block
themeEmacs
shell> cat /root/.mysql_secret

Step 3.) Connect to MySQL using the auto-generated password from the .mysql_secret file and change the root password using the following commands:

Code Block
themeEmacs
shell> mysql -uroot -p
mysql> SET PASSWORD FOR 'root'@'localhost' = PASSWORD('<ANYTHING YOU WANT>');
mysql> SET PASSWORD FOR 'root'@'127.0.0.1' = PASSWORD('<ANYTHING YOU WANT>');
mysql> flush privileges;
mysql> quit
Info
titleAdditional Notes

This specific major/minor version of MySQL is required with the root username as specified above. If you have other MySQL installations on the machine we recommend removing them or installing this version on top of them and upgrading their schemas to what is specified.

Step 4.) Create or modify the my.cnf file as shown below.

  • Typically the my.cnf file is in /etc/ folder
Code Block
themeEmacs
shell> vi /etc/my.cnf

[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
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]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid
default-storage-engine=INNODB
character-set-server=utf8
collation-server=utf8_unicode_ci

[mysql]
max_allowed_packet = 150M

[mysqldump]
quick
max_allowed_packet = 150M

Step 5.) Restart MySQL.

  • Based on the standard MySQL installation, a MySQL script is added to the init.d directory that you can use to Start and Stop the MySQL server.
Code Block
themeEmacs
shell> /etc/init.d/mysql start
shell> /etc/init.d/mysql stop





Expand
titleInstall Elastic Search

Anchor
anchor3
anchor3

Panel

Install Elastic Search

Step 1.) Download the .rpm file using either methods below:

  • Download using the linux shell command prompt
    • Run the following command:
      • sudo rpm -ivh elasticsearch-5.5.0.rpm
  • Download using the wget command from the linux shell command prompt
    • You can download the rpm file here.

Step 2.) Navigate to the installation path (Eetc/elasticsearch) >> elasticsearch.yml file

Step 3.) Edit the elasticsearch.yml file

  • Change and update the following parameters:
Code Block
languagejs
themeEmacs
cluster.name: zephyr
node.name: "Node1"
node.master: true
node.data: true

script.disable_dynamic: false
script.inline: true
script.indexed: true

index.number_of_shards: 2
index.number_of_replicas: 1

network.bind_host: (host IP)
network.publish_host: (host IP)
network.host: (host IP)
transport.tcp.port: 9300
http.port: 9200

discovery.zen.ping.timeout: 3s
discovery.zen.ping.unicast.hosts: ["192.168.45.21"]


Step 4.) Save the file.

Step 5.) Start the service by utilizing the following command:

  • sudo systemctl start elasticsearch.service


Configure Elastic Search

Step 1.) In JDBC, change the transport nodes in the properties to the following:

Code Block
languagejs
themeEmacs
#transport|node
transport.nodes=(host IP):9300





Expand
titleInstalling Zephyr Enterprise 6.1

Anchor
anchor4
anchor4

Panel

Install Zephyr Enterprise 6.1

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.
Code Block
themeEmacs
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.) 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 8.) 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 9.) 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 10.) 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 11.) You'll then be prompted to launch Zephyr Enterprise and you may launch Zephyr Desktop by entering "Y".