Table of Contents


Prerequisites

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.

  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 Elastic Search
  5. Install and configure Zephyr Enterprise


Configuring MySQL

Configure MySQL with the following settings below and restart the MySQL server.

[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



Install Elastic Search

Step 1.) Download the Elastic Search 5.5.0 file.

Step 2.) Navigate to the installation path (etc/elasticsearch/elasticsearch.yml)

Step 3.) Edit the elasticsearch.yml file

  • Change and update the following parameters:
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: [(host IP:transport port)]

indices.query.bool.max_clause_count: 4096


Step 4.) Save the file.

Step 5.) Start the service 

sudo -i service elasticsearch start
sudo -i service elasticsearch stop



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.