Versions Compared

Old Version 27

changes.mady.by.user Edward Stolyar (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Dominik Trygar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFBDAD

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation---upgrade-guides/zephyr-on-premise-production-installation/set-up-zephyr-data-center-cluster/install-zephyr-enterprise-on-nodes/on-windows.html

Table of Contents
Note

When installing Zephyr on your nodes, keep in mind the following:

  • Install Zephyr on any drive other than drive C: to avoid permission issues, as administrator permissions may be required to work with this drive.

  • Use the same Zephyr version and build on all the nodes.

  • Zephyr installed on all the nodes must have the same license.

Prerequisites (apply to each node)

  • Make sure the computer meets the system requirements.

  • Ensure you have the license file (license.lic), as it will be required during the installation process. If you do not have it, please contact your Zephyr Account Manager or contact Zephyr Sales at sales@getzephyr.com.

  • Download the installation file of Zephyr Enterprise for Windows.

  • Download a JDBC driver and place it on each node where Zephyr will be installed.

  • Download and install Java JDK 8u101 or later. After you install itJDK. You can use one of the following:

    • OpenJDK 17.0.10 (recommended) - download and unzip the archive.

    • Oracle JDK 17.0.10 - download and install according to the Oracle documentation.

  • After you install JDK, set the PATH and JAVA_HOME environment variables. To do that:

    • PATH variable:

      1. Navigate to Start > Control Panel > System.

      2. Click Advanced > Environment Variables.

      3. Add the path to the bin folder to the PATH variable in the System variables section. A typical path looks

      like the following

      1. as follows:

        • for OpenJDK: C:\some_folder\jdk-17\bin

        • for Oracle JDK: C:\Program Files\Java\JDK_

      1

        • 17.

      8

        • 0.

      0_

        • <version>\bin

    • JAVA_HOME variable:

      1. Navigate to Start > Control Panel > System.

      2. Click Advanced > Environment Variables.

      3. Find the JAVA_HOME variable in the System

      variables

      1. Variables section. If you cannot find it, add it to the System variables.

      2. Add the path to the JDK root folder to the JAVA_HOME variable. A typical path looks

      like this

      1. as follows:

        • for OpenJDK: C:\some_folder\jdk-17\bin

        • for Oracle JDK: C:\Program Files\Java\JDK_

      1

        • 17.

      8.0_<version>

        • 0.<version>\bin

Note

Make sure you have specified the correct paths for PATH and JAVA_HOME.

Zephyr installation steps

...

1. Install Zephyr Enterprise on the first node (the installation steps on the first node differ from the steps you perform on the other nodes):

Expand
titleInstallation steps on the first node
Note

If you use an external database other than MySQL, please refer to Zephyr Data Center Requirements and Connecting to an External Database.

1. Double-click the installation file and select Install in the Welcome screen:

Image Removed7f179c9b-b00e-466b-8482-1d6eda2a2369.pngImage Added

2. View the requirements, if needed, and ensure all requirements appearing on the screen is available on the system, and then click Next:

Image Removed

.

3. Read the license agreement and accept its terms:

Image Removed1f629147-4400-4c35-9ba6-1414eb01b0e3.pngImage Added

4. Specify the location where you want to install Zephyr. Make sure the disk has enough free space:

Image Removedaecaf783-f5c7-4b4f-aa5a-3ad6298ffccb.pngImage Added

5. Choose Data Center deployment, as you are installing Zephyr on a cluster node:

Image Removedc4de05e1-94b1-4b1f-aba2-52f62599bfad.pngImage Added

6. Add the license file you received from Zephyr Sales:

Image Removed9d840daf-1d08-4a12-afc7-5928bb65825d.pngImage Added

7. Select the Standard installation type to use predefined ports, or Custom to use some other ports:

Image Removedd8d3e86a-e7cc-4005-a458-87ae225734d0.pngImage Added

8. In the subsequent window, select the type of the external database you set up earlier, specify the username and password you use to connect to it, the database URL, and the database driver file:

Image Removed86ea4109-3dd8-4ed6-853b-823974697fb7.pngImage Added

9. Click Test Connection to check that Zephyr can connect to the database:

Image Removed617e9f51-64c5-4704-88b1-f9b241e81ae2.pngImage Added

10. In the next window, Specify specify the host name or the IP address and port used by Elasticsearch. If you have several Elasticsearch nodes, separate their addresses with commas:

Image Removedee5def1a-94e9-4484-a280-ee43803f1917.pngImage Added

11. In the subsequent window, configure shortcuts and click Next:

Image Removed0722321c-ae30-466b-8492-2907d7f4fc60.pngImage Added

12. Wait for the installer to finish the product installation:

Image Removed43e3ba36-9988-4a54-9b61-3c65674b70d7.pngImage Added

13. After you install Zephyr, make sure it is up and running, and then stop the node.

2. Install Zephyr Enterprise on another node:

  • Perform the steps described in Prerequisites.

  • Open the Command Prompt window as an admin and run the following command:

    Code Block
    languagebash
    zephyr_6.6_xxx_setup_iRev_xxx.exe  -VzSkipStartupData=true
Note

The command is case-sensitive.

...

Info

Write down the IP address of each node – you will need them at the next step 7. 

...

4. After you install Zephyr Enterprise on all the nodes, you need to modify the following files file on each node:

...

titleZephyr\tomcat\conf\server.xml

<Zephyr Directory>/tomcat/webapps/flex/WEB-INF/classes/hazelcast.properties

In this file, find the following

...

Code Block
languagexml
<Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster"/>

and replace it with the following:

Code Block
languagexml
<Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster"channelSendOptions="8">
<Manager className="org.apache.catalina.ha.session.DeltaManager"
expireSessionsOnShutdown="false"
notifyListenersOnReplication="true"/>
<Channel className="org.apache.catalina.tribes.group.GroupChannel">
<Membership className="org.apache.catalina.tribes.membership.McastService"
address="228.0.0.22"
port="45564"
frequency="500"
dropTime="3000"/>
<Receiver className="org.apache.catalina.tribes.transport.nio.NioReceiver"
address="auto"
port="4000"
autoBind="100"
selectorTimeout="5000"
maxThreads="6"/>
<Sender className="org.apache.catalina.tribes.transport.ReplicationTransmitter">
<Transport className="org.apache.catalina.tribes.transport.nio.PooledParallelSender"/>
</Sender>
<Interceptor className="org.apache.catalina.tribes.group.interceptors.TcpFailureDetector"/>
<Interceptor className="org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor"/>
</Channel>
<Valve className="org.apache.catalina.ha.tcp.ReplicationValve"
filter=""/>
<Valve className="org.apache.catalina.ha.session.JvmRouteBinderValve"/>
<Deployer className="org.apache.catalina.ha.deploy.FarmWarDeployer"
tempDir="/tmp/war-temp/"
deployDir="/tmp/war-deploy/"
watchDir="/tmp/war-listen/"
watchEnabled="false"/>
<ClusterListener className="org.apache.catalina.ha.session.ClusterSessionListener"/>
</Cluster>
Expand
titlezephyr/tomcat/webapps/flex/WEB-INF/template/hazelcast.xml.tmpl

  1. Find the line –

<member>127.0.0.1:5701</member>

– and add the IPs of all the nodes instead of 127.0.0.1. For example:

<member>172.17.18.141:5701</member>
<member>172.17.18.157:5701</member>
<member>172.17.18.223:5701</member>
<member>172.17.18.201:5701</member>

  1. Find the line –

interface>127.0.0.1</interface>

– and replace it with an IP address that has an asterisk instead of the last component. For example:

<interface>172.17.18.*</interface>

...

titlezephyr/tomcat/webapps/flex/WEB-INF/classes/hazelcast-hibernate.xml

  1. In this file, find the line –

<member>127.0.0.1:5702</member>

– and add the IP addresses of all the nodes instead of 127.0.0.1. For example:

<member>172.17.18.141:5702</member>
<member>172.17.18.157:5702</member>
<member>172.17.18.223:5702</member>
<member>172.17.18.201:5702</member>

  1. Find the line –

<interface>127.0.0.1</interface>

...

lines and change the values as shown below:

zephyr.hz.cluster.enabled=false - set it totrue.
zephyr.hz.cluster.name=zephyr-hazelcast-cluster - specify a unique name for each cluster, for example, zephyr-hazelcast-cluster_smartbear.
zephyr.hz.interfaces.enabled=false - set to true.
zephyr.hz.interface=127.0.0.1 - This is the IP of the IP interface. Replace it with an IP address that has

...

asterisks instead of the last

...

two components. For example:

...

<interface>172.17.18.*</interface>

Expand
titlezephyr/tomcat/webapps/flex/html5/index.html

Find the line –

<input type="hidden" id="notificationConType" value="websocket" />

– and replace websocket with sse:

<input type="hidden" id="notificationConType" value="sse" />

Expand
titlezephyr/tomcat/conf/web.xml

In the file, before the web-app tag, add the tag <distributable />:

Image Removed

5. On all the nodes, open the folder

...

6. Make the following changes in the

cluster.properties file:

  • Remove the following lines:

Code Block
#unique identifier for the cluster node
cluster.aws.enable=false
HAZELCAST_PASSWORD=huser
HAZELCAST_USERNAME=hpass

  • Update the following information:

Code Block
cluster.key=node1 (this should be a unique name of the node)
cluster.node.1.key=node1
cluster.node.1.url=172.17.18.141 (the IP address of node 1)
cluster.node.count=4
cluster.node.2.key=node2
cluster.node.2.url= 172.17.18.157(the IP address of node 2)
cluster.node.3.key=node3
cluster.node.3.url=172.17.18.223 (the IP address of node 3)
cluster.node.4.key=node4
cluster.node.4.url=172.17.18.201 (the IP address of node 4)

...

titleExample
Code Block
cluster.key=node2 (this should be a unique name of the node)
cluster.node.1.key=node1
cluster.node.1.url=172.17.18.141 (the IP address of node 1)
cluster.node.count=4
cluster.node.2.key=node2
cluster.node.2.url= 172.17.18.157(the IP address of node 2)
cluster.node.3.key=node3
cluster.node.3.url=172.17.18.223 (the IP address of node 3)
cluster.node.4.key=node4
cluster.node.4.url=172.17.18.201 (the IP address of node 4)
Note

The cluster.key name must be unique in each file.

7zephyr.hz.interface= 192.168.*.*
zephyr.hz.tcp-ip.enabled=false - set it to true.
zephyr.hz.members=127.0.0.1 - specify the IP addresses and port number of each node separated by a comma. For example: zephyr.hz.members=192.168.0.1:5701,192.168.0.2:5701

5. Start Zephyr on the first node. When Zephyr starts, you will see the following line in the log file zephyrlocation/tomcat/logs/thedinc.log:

Code Block
*****************
Zephyr Started
*****************

After Zephyr is launched, the HAZELCAST_USERNAME and HAZELCAST_PASSWORD values will be generated in the zephyr/tomcat/webapps/flex/WEB-INF/classes/cluster.properties file.

8. Copy the HAZELCAST_USERNAME and HAZELCAST_PASSWORD values and paste them to the zephyr/tomcat/webapps/flex/WEB-INF/classes/cluster.properties file on the 6. Start the other nodes.

97. Stop all the first nodenodes.

Now you can set up a shared folder. To learn how to do that, click Next Step below.

< Prev Step Next Step >

See Also

Set Up Zephyr Data Center
Troubleshooting/wiki/spaces/ZE/pages/1558445859