Applies to platform: All UTM 3.0, except for ARM
Updated on: 13th June 2018
This document lists the requirements and shows the steps to successfully upgrade your Endian UTM Appliance from the 3.0.5 to the 5.0 version. Since the 5.0 is a 64bits release based on a new platform, to complete the upgrade it is mandatory to reinstall the operating system and therefore to schedule a period of downtime of the appliance, whose length depends on the services to restore and the type of appliance.
Warning for special setups
- If you have a 3.0 HA cluster that you want to migrate to 5.0, please follow this article
- If you have an appliance with switchboard module,please open a ticket.
- If you have hotspots configured as Master and Satellites, it is mandatory that all the systems run the same software version and therefore be migrated at the same time. If you have such a setup, it is suggested to open a ticket with Endian support for directions.
UTM Appliances that can be upgraded
This is the full list of the UTM appliances that can be upgraded to EndianOS:
Mini 25, Mini 25 WiFi, Mercury 50, Mercury 100, Macro 250, Macro 500, Macro 1000, Macro 2500, Virtual, and Software.
For the following models: Mercury (2011 Edition), Macro X1 (2011 Edition) and Macro X2 (2011 Edition), the upgrade is available only if the serial number of the appliance is TSBxxxxxx.
To be able to upgrade to 5.0, it is mandatory to have:
- A full up-to-date Endian Appliance 3.0 or 3.0.5, with all packages updated to their latest version.
- A valid maintenance.
- A valid Endian Network account.
System Requirements for Virtual and Software UTM Appliances
The minimum requirements to upgrade to the 5.0 are the following:
- CPU Intel x86_64 compatible / 1GHz Minimum (Dual-core 2 GHz Recommended).
- Multi-Processor Symmetric Multi-Processor (SMP) support included.
- RAM 2GB minimum (4 GB recommended).
- Hard Disk 8GB Minimum (20 GB Recommended) Support for full virtualization and paravirtualization.
- CD-ROM Physical and virtual drives as supported by the hypervisor.
- Network Cards 2 Virtual NICs Minimum / Support for full virtualization and paravirtualization.
- Supported Hypervisors: Xen, Vmware, KVM, and Hyper-V.
The whole upgrade procedure is divided into two parts: A Preparation step and the Installation step.
The initial steps of the procedure are much like in the previous upgrades:
- Make a full update of the appliance, using the GUI (System > Updates) or issuing this command from the CLI:
root@endian:~ # efw-update upgrade
- Download a 3.0 ISO image to be used for disaster recovery, in case something goes wrong during the upgrade process. Software/Virtual Images can be downloaded from https://download.endian.com/your-ac-code. for hardware appliance can be found in the dedicated download section of network.endian.com
- Make a full backup of the appliance, which can then be copied from the Endian appliance and saved in a safe place. This backup can be stored also for legal reasons, since it contains all of the data (configuration settings, database dump, all log files) present on the Endian appliance.
- Make a backup of the appliance which includes only the current settings and database dumps (options Current configuration and Include database dumps) and use this one as the backup to restore on the migrated appliance. This is suggested for several reasons: the whole procedure will bes quicker, since the least amount of data is being restored, resulting in shorter downtime, it will be less error-prone (in case the backup becomes corrupted for any reasons)
- (optional) If you have a virtual appliance, make a snapshot of the current state of the VM, to be restored if you experience problems during or after the installation.
- Switch the channel of the appliance on Endian Network from 3.0 to 5.0
NoteThe button will not show up in Endian Network, if the appliance is not eligible for the update or if there are updates to be installed.
- Download from the dedicated section on Endian Network the installation image corresponding to your model.
NoteIf you have a virtual or a software appliance, download the 5.0 image from http://download.endian.com/your-ac-code The 5.0 image will be available after you switch the channel on Endian Network, and will be an .ISO file for a software appliance or a .ZIP file for a virtual appliance.
- If you have an hardware appliance, burn the image on an USB stick (do not create it for virtual appliances). Please refer to this article for directions on how to create such a USB stick.
- If you have a virtual appliance, proceed directly to Installation steps
For installation procedure, these are the steps to be followed:
- If you have a hardware appliance (Mini, Mercury, Macro), make sure you boot it from the USB drive. To make sure the boot order is correct, please follow this howto.
- If you have a virtual appliance, the procedure is very similar to a normal operating system installation on a VM. Into the virtual appliance .ZIP file you downloaded before, you will find both the .ISO file that you can import into virtual CD drive of your blank VM to start the installation, or all the already prepared virtual appliances files for different hypervisors. Based on the hypervisors you will need, you can refer to related .TXT file inside virtual appliance .ZIP file for the installation steps.
- Start the installation process normally.
- Follow the instructions that appear on the screen.
Reboot and Registration to Endian Network
After the successful installation, the appliance will reboot. At this point you should:
- Import the backup to your appliance and start the restore procedure with this imported backup. The system will be automatically registered and will show the new version in the GUI.
- Update the appliance with the latest available packages.
At this point you have a full up to date Appliance equipped with latest 5.0 version. Enjoy!