Important
Zephyr must run in an isolated instance where no Jira or any other Tomcat is running.
Zephyr should only be installed on its server. If you are running a Jira instance, it should be installed on a different server.
We recommend installing Zephyr on a separate instance from where you install Jira or Tomcat.
RabbitMQ and ZE Services should be installed on a separate server as you require Java 17 (optional).
OS | Windows Server 2016 and 2019 |
CPU | Quad-core CPU Intel Pentium or AMD Opteron (2GHz or higher) |
RAM | Minimum 8GB; Preferred 12GB RAM recommendations, see Zephyr Usage Requirements |
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, 9300, 5701, 5702, 37000, 37001 Firewall (if present): Allow ports 80 and 443 (if HTTPS). Must support WebSocket protocol Proxy (if present): Must support WebSocket protocol Nodes should have at least 1Gbps Ethernet connectivity (10Gbps recommended) |
Account | Administrator access to the machine Installer and services need to "Run As Administrator" |
Software | Java: Oracle JDK 17 and Open JDK 17.0.13 Note: No other Tomcat can be installed on the machine. |
ElasticSearch | v. 8.6.2: Download - here / Installation instructions - here |
RabbitMQ (optional) | Currently, installing RabbitMQ is optional RabbitMQ 3.12.10 (Java 17) / Download - here / Installation instructions - here |
ZE-Services (optional) | Currently, installing ZE-Services is optional ZE-Services (Java 17.0.13): |
OS | Red Hat Enterprise 64-bit (the latest supported version is RHEL 8) 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 (for root user) and 1024, 8443 (for non-root user), 8005, 9300, 5701, 5702, 37000, 37001 Firewall (if present): Allow ports 80 and 443 (if HTTPS). Must support WebSocket protocol Proxy (if present): Must support WebSocket protocol Nodes should have at least 1Gbps Ethernet connectivity (10Gbps recommended) |
Account | The installer and services will be installed as the current user. |
Software | Java: Oracle JDK 17.0.13 and Open JDK 17.0.13 Note: No other Tomcat can be installed on the machine. |
ElasticSearch | v. 8.6.2: Download - here / Installation instructions - here |
RabbitMQ (optional) | Currently, installing ZE-Services is optional |
ZE-Services (optional) | Currently, installing ZE-Services is optional. ZE-Services (Java 17.0.13 is required): |
MySQL | Database Version: MySQL 8.0.35 series JDBC Driver Version: mysql-connector-java-8.0.32.jar or the latest Microsoft |
Microsoft SQL Server | Version 2017 or 2019 JDBC Driver Version: 4.2 |
Oracle | Database Version: 19c JDBC Driver : ojdbc7.jar |
OS | Any Desktop OS |
Browser | Any one of these three with versions that support Web Sockets:
|
Networking | The client machine must have access to port 80 for HTTP connection (or 443 for HTTPS) to the Zephyr Server. |
Other | Screen resolution of 1280×1024 (1280×900 for widescreen) or higher |
OS | Windows Server 2016 and 2019 Linux (Red Hat, Ubuntu, CentOS, SUSE) macOS |
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 need to "Run As Administrator" |
Software | Java: Oracle JDK 17.0.13 and Open JDK 17.0.13 |
Important
Additional 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, they must support the WebSocket protocol.
Ports Explained:
80, 443 (for the root user), 1024, 8443 (for the non-root user), 8005, and 8009 are used by Tomcat and can be configured in the server.xml file under zephyr\tomcat\conf\
Elasticsearch uses 9200
Hazelcast uses 5701, 5702, 37000, 37001
Database system - 3306 (unless changed) for MySQL and 1433 (unless changed) for Microsoft SQL Server
Elasticsearch - 9200 on all nodes of the cluster, including the one where Elasticsearch is installed
Zephyr Instances - 5701, 5702 (inbound ports) and 37000, 37001 (outbound ports)
Load Balancer - 80 (unless changed) for load balancer access
RabbitMQ uses 5672, 15672
ZE-Webhook Service uses 8081
ZE-Consumer Service uses 8082
ZE-AuditService uses 8083
8084 is used by ZE-AuditProcessor
Software Version Explained:
Elasticsearch is strictly required to install the Zephyr Data Center. The supported version is 8.6.2.
Oracle JDK 17.0.13 or later is required.
No other database should be present on the server node.
RabbitMQ 3.12.10 is
CES is optional for the users. Java 17.0.13 is required to use ZE-Services.
ZE-Webhook Service is the component responsible for accepting the incoming events from Jira and enqueues them to the message broker for further processing.
ZE-Consumer Service is the component that picks the enqueued events from the message broker and updates ZE with the incoming data.
ZE-AuditService is the component that acts as the incoming endpoint for the Audit Logs generated during the incoming webhook event processing and enqueues them to the message broker.
ZE-AuditProcessor is the component responsible for reading the enqueued audit logs from the message broker and inserting them into ZE.
Additional deployment requirements
The Zephyr instances need to be able to access shared storage for storing common data (for example, attachments and so on) with a capacity of 100GB, which could be part of an HA cluster on its own since this device is to be available without fail to all the nodes as long as the cluster is functional.
Configure the nodes in the same time zone and synchronize the current time. It is recommended that you use Network Time Protocol Daemon (NTPD) or similar services.
Nodes must be able to communicate with each other based on IP address (the host file needs to be updated as required for this communication to work).