Zephyr On-Premise Upgrade Instructions
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-and-upgrade-guides/upgrade-zephyr-enterprise/zephyr-on-premise-upgrade-instructions.html
Download Zephyr
Download Zephyr on the following page: Zephyr Download.
Zephyr Enterprise currently supports only upgrades to the supported versions. See Zephyr End-of-Life Policy.
If you need to upgrade from an older version, contact support.Zephyr Enterprise Release 8.1 and later supports the latest Java 17 or OpenJDK 17.0.10 versions. You can download Java 17 and OpenJDK 17.0.10 from the respective download page.
As you transition to Zephyr Enterprise v7.19.0, please be aware that the upgrade process may take more time, especially with substantial data. Prepare for possible downtime. If you encounter any upgrade issues, like the "lock table size" error, review and adjust the MySQL settings. If you require further assistance or encounter additional issues, we encourage you to contact our support team for resolution.
Remember to take a full database backup before upgrading.
You need to restart the MySQL database before upgrading Zephyr Enterprise, as MySQL 8.0.30 and later versions have an issue.
Pre-upgrade steps
Step 1: Zephyr Enterprise supports MySQL v8.0.35, which is effective from Zephyr Enterprise v7.17. Therefore, if you use MySQL, upgrade your MySQL DB to v8.0.35 before upgrading your Zephyr Enterprise to v7.17 and above.
The current Elasticsearch settings, by default, allow automatic index creation if a document is pushed into a non-existent index. With this feature and a loophole in Zephyr's indexing process, users can create those indexes without intending to. This causes an indexing issue, as the indexing percentage will drop to ~1%, and the index-relate functionality is affected.
To stop this, configure Elasticsearch to disallow any index for Zephyr. As a result, any index that begins with the name "Zephyr" will not be allowed for automatic creation.
Step 2: Follow this step if you want to use ES 8.6.2
Step 3: Take a backup of the entire database: Steps to take database backup.
Step 4: Restart MySQL DB before doing the upgrade.
Step 5: Back up the attachments located in the file system (separate from the database).
We suggest you back up the entire folder, which can be found in Windows under the Zephyr Directory (ZephyrDir) or in Linux within /zephyrdata.
Step 6: Check the Server.xml file for the AJP connector.
Stop the Zephyr Server.
Open the file zephyr/tomcat/conf/server.xml and comment out the line below:
<!-- <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> -->
Save the file, exit, and then you can start the upgrade process.
Step 7: Replace the recommended connector jar file.
Refer to the steps below to replace the recommended connector jar file for MySQL or MSSQL. The instructions are provided separately for each connector:
Step 8: Take a backup of the node data located in the file system.
We suggest you take a backup of the entire folder, which can be found in Windows under the Zephyr Directory (ZephyrDir) or in Linux within /node data.
Step 9: Install RabbitMQ 3.12.10 (Optional):
RabbitMQ 3.12.10 is a robust messaging and streaming broker that's easily deployable across cloud environments and on-premises setups. Currently, installing RabbitMQ 3.12.10 is optional for the users. You can download RabbitMQ 3.12.10 - here.
Step 10: Install ZE-Services (Optional):
ZE-Webhook Service is the component responsible for accepting the incoming events from Jira and enqueues them to the message broker for further processing. You can download ZE-Webhook Service - here and find the installation instructions - here.
ZE-Consumer Service is the component that picks the enqueued events from the message broker and updates ZE with the incoming data. You can download ZE-Consumer Service - here and find the installation instructions - here.
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. You can download ZE-AuditService - here and find the installation instructions - here.
ZE-AuditProcessor is the component responsible for reading the enqueued audit logs from the message broker and inserting them into ZE. You can download ZE-AuditProcessor - here and find the installation instructions - here.
Upgrade on Linux from Root-to-Root user
Step 1: Stop the Zephyr Service.
sh /opt/zephyr/tomcat/bin/shutdown.sh
Step 2: Run the installation file of Zephyr Enterprise:
Step 3: Select the Upgrade option:
Step 4: Select the Zephyr installation folder where Zephyr was installed:
Starting Release 8.2, Zephyr Enterprise documentation is moving from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise Documentation page. https://support.smartbear.com/zephyr-enterprise/docs/en/welcome-to-zephyr-enterprise.html