Upgrading to Zephyr Enterprise Server 5.0 on Linux
This section applies specifically to the Zephyr Enterprise product. The information below is generally used to ensure that system administrators can update their Zephyr Enterprise product instance on a Linux environment.
This section provides step by step instructions to upgrade from Zephyr Enterprise Edition version 4.8 (Build 13818) to Zephyr Enterprise Server 5.0.
Note that with the introduction of version 4.8, Zephyr Community Edition is now retired. If interested in upgrading to Zephyr Enterprise Server 4.8 from Community Edition, please contact your Zephyr Sales Account Manager or send an email to sales@getzephyr.com for information on purchasing Zephyr Enterprise Server licenses.
Prerequisites
Review all system requirements thoroughly
Download required software that matches your Zephyr server configuration:
Zephyr version 5.0 (Build 14587) installation file
Zephyr Upgrade Utility
If your Zephyr server has SSL setup, backup these files:
server.xml (%Zephyr_Home%/tomcat/conf)
setenv.sh (%Zephyr_Home%/tomcat/bin)
You will replace these files with your backup once the upgrade is complete
Backup any file that has been manually customized after the original Zephyr installation. These files will be overwritten during the upgrade process.
It is recommend that you read the entire upgrade instruction set prior to beginning the upgrade process. If you have any questions, please contact our Technical Support team. The time taken to complete the upgrade mode process is mainly dependent on the size of your Zephyr 4.8 (Build 13818) backup, but shouldn’t take more than 3 hours to complete.
The process of upgrading your Zephyr Enterprise Server instance consists of four major parts:
Create a full backup with attachments
Verify that the backup file can be migrated to version 5.0 (Build 14587)
Uninstall the current version of Zephyr Enterprise and install Zephyr Enterprise Server version 5.0
Upgrade and restore 4.8 (Build 13818) backup file to 5.0 (Build 14587)
Note
If you are running Zephyr 4.5 or Zephyr 4.6 (Build 7993 or 8411 or 8521), you need to upgrade them to 4.7 (Build 9213) before attempting this upgrade process. If you have any questions, please contact our Technical Support team.
The Linux Upgrader Utility is available in 2 offerings - GUI and Console.
Both follow the same basic workflow but console mode inputs must be typed in via keyboard and the output is displayed in a terminal window.
Running the upgrade via Linux GUI
Step 1: Create a full backup with attachments
Open a command line and run:
backupAll.sh Y
Store the backup file that is created with the above command where the upgrade utility is located
Any work done in Zephyr after this backup is made WILL NOT be migrated to the new Zephyr Enterprise 5.0 instance
Step 2: Launch upgrader utility:
|
Step 3: Identify location of the backup file.
Step 4: Upgrade utility confirms installation location of Zephyr (during the verification process, no actual upgrade will occur)
Step 5: Select “Check Mode” to ensure the integrity of the backup file
Step 6: Click “Next” to begin verification
Step 7: Once verification is completed, the following dialog box is displayed identifying either a successful or unsuccessful verification of the backup files. If unsuccessful, view the logs, identify and address the issue or contact Technical Support for assistance.
Step 8: Follow the steps below to uninstall the current version of Zephyr - 4.8 (Build 13818):
Step 9: Install Zephyr Enterprise Server 5.0 (build 14587). Follow the instructions for installation on Linux:
Step 10: Launch the Upgrader from the Command Prompt with the following required parameters:
VzMySQLPath
VzMySQLCnfFilePath
|
Both parameters highlighted in red above are using the default locations mentioned in our installation guides. However, these locations can be customized during installation and may be different than shown. Once started, the first prompt is simply confirming the user wishes to continue or cancel the upgrade
Once the Upgrader is launched, follow steps 2 through 4 above
Select “Upgrade Mode” in Select Mode dialog box to run the upgrade utility
Step 11: Click Next to continue after reading the prompt
Step 12: Progress will be visible above the progress bar. Logs can be viewed from the 'View Logs' link
Step 13: Once the upgrade process is complete, a result window will appear. Successful upgrades will have a 'successful' label for each area and you can select 'Next' to finalize the process. If unsuccessful, view the logs, identify and address the issue or contact Technical Support for assistance.
Step 14: Select 'Finish' to close the upgrader utility window. Zephyr server will automatically startup once this window is reached. However, startup time may vary. Please allow up to a few minutes before the Zephyr Desktop can be reached.