Zephyr must run in an isolated instance where no Jira is running or any other Tomcat.
- Zephyr should only be installed on its own server. If you are running a Jira instance, it should be installed on a different server.
- We recommend that you install Zephyr on a separate instance from where you install Jira or Tomcat.
RabbitMQ and ZE Services should be installed on a separate server as we require Java 17 (optional).
Zephyr Enterprise Data Center (for Windows On-Premise Installations only)
OS | Windows Server 2016 and 2019 |
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 |
Account | Administrator access to the machine |
Software | Java: Oracle JDK 17 and Open JDK 17.0.10 |
| ElasticSearch | v. 8.6.2: Download - here / Installation instructions - here |
| RabbitMQ (optional) | Currently, installing RabbitMQ is optional |
| ZE-Services (optional) | Currently, installing ZE-Services is optional ZE-Services (Java 17.0.10 required): |
Zephyr Data Center (for Linux On-Premise Installations only)
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 |
Account | Installer and services will be installed as the current user |
Software | Java: Oracle JDK 17.0.10 and Open JDK 17.0.10 |
| ElasticSearch | v. 8.6.2: Download - here / Installation instructions - here |
| RabbitMQ (optional) | Currently, installing RabbitMQ is optional |
| ZE-Services (optional) | Currently, installing ZE-Services is optional ZE-Services (Java 17.0.10 is required): |
Supported Databases
| MySQL | Database Version: MySQL 8.0.35 series |
| Microsoft SQL Server | Version 2017 or 2019 |
| Oracle | Database Version: 12c, 19c |
Zephyr Client
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 |
ZBots
OS | Windows Server 2016 or 2019 |
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 |
Software | Java: Oracle JDK 17.0.10 and Open JDK 17.0.10 |
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, it is required that they 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\
- 9200 is used by Elasticsearch
- 5701, 5702, 37000, 37001 are used by Hazelcast
- 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
- 5672, 15672 are used by RabbitMQ
- 8081 is used by ZE-Webhook Service
- 8082 is used by ZE-Consumer Service
- 8083 is used by ZE-AuditService
- 8084 is used by ZE-AuditProcessor
Software Version Explained:
- Elasticsearch is strictly required for installing Zephyr Data Center. The supported version is 8.6.2.
- Oracle JDK 17.0.10 is required.
- No other database should be present on the server node.
RabbitMQ 3.12.10 is a message broker software that receives messages from producers and forwards them to consumers, serving as middleware to alleviate loads and streamline delivery times on web application servers. Currently, installing RabbitMQ is optional for the users. Java 17 is required to use RabbitMQ.
- ZE-Services. Currently, installing ZE-Services is optional for the users. Java 17.0.10 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 a further 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.
- Nodes must be configured with the same time zone and keep the current time synchronized. Using NTPD (Network Time Protocol Daemon) or some similar service is a good way to arrange it.
- 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).