Firmware Updates
Versioning
The following outlines the versioning principles to help administrators understand the significance and impact of CyberEdge firmware updates.
-
Major Release: A major release is indicated by a change to the first number in the version. These releases typically occur 1-2 times per year and introduce significant new features, system updates, and fixes for known issues. Major release updates must be initiated by the user.
-
Minor Release: A minor release is indicated by a change to the second number in the version. These releases occur more frequently and are intended to deliver smaller new features, enhancements to existing features, critical system and security updates, and fixes for known issues. Minor release updates are initiated by the user.
-
Micro Release: A micro release is indicated by a change to the third number in the version. These releases occur frequently and focus on delivering security updates, system improvements, and fixes for known issues. Micro releases are typically managed through automatic updates but can also be initiated by the user if needed.
Versioning Example
The following is an example of the CyberEdge versioning logic to consider when updating firmware.
Example Version 5.1.7 firmware update
- Major update from version 5.1.7 to 6.0.0 (Major Release - user initiated)
- Minor update from version 5.1.7 to 5.2.0 (Minor Release - user initiated)
- Micro update from version 5.1.7 to 5.1.8 (Micro Release - automatic update)
Firmware Update
CyberEdge firmware updates provide several advantages, helping to maintain system reliability, enhance security, and keep features up to date. It is advised that system administrators regularly apply updates to stay current.
-
Schedule Update: A system administrator can schedule a firmware update to run in the configured update window. To schedule updates, go to System > Updates > Update Actions > Schedule Update
-
Update Now: In certain scenarios, a system administrator may be required to run a CyberEdge firmware update immediately. To run an available update, go to System > Updates > Update Action > Update Now. This process will trigger the firmware download and start the installation, bypassing any configured update schedules. It's important to note that once this update process begins, it cannot be stopped.
-
Download Update: In cases where internet bandwidth may be a concern, system administrators have the option to download a firmware update in advance. This option allows the firmware to be downloaded without immediately initiating the installation. The installation will then take place during the scheduled update window. To initiate the firmware download, go to System > Updates > Update Actions > Download Update data
-
Cancel Update Jobs: An administrator can cancel a firmware update that is scheduled to run during the designated update window, including automatically scheduled updates. To cancel a firmware update go to System > Updates > Update Actions > Cancel update job
Important note
- After a CyberEdge firmware update, it is not possible to revert to a previous version.
- All CyberEdge firmware updates require a reboot.
- Superloop does not store customer system configuration backups off the device. Prior to applying updates, configuration backups are automatically created and stored locally on the device. It is recommended that system administrators regularly create and securely store additional configuration backups.
Schedule Update
A system administrator can configure an update window to control when a CyberEdge firmware update will be installed.
-
The update window is respected for both customer-initiated firmware updates and automatic updates.
-
An update window requires a minimum of 2 hours. If for any reason an update cannot run during the scheduled time, the update will hold over until the next update window
-
A scheduled, customer-initiated firmware update can be cancelled via System > Updates > Updates Action
Automatic Updates
Automatic Firmware Updates are used to distribute micro release versions. Micro releases can be identified in the version numbering system by changes to the last number. For example, an update from version 0.1.2 to version 0.1.3 is considered a micro release and will be distributed to all devices with automatic updates enabled. Micro release updates are typically small and aimed at resolving known issues, providing security updates or small bespoke features.
Automatic updates will be scheduled with 72 hours notice, and will include an email notification of the scheduled update version and time, so that the system administrator can cancel or reschedule the update manually if desired.
It is recommended that automatic updates be enabled on your CyberEdge. To manage your automatic update configuration, go to System > Updates > Automatic Updates
HA Firmware Update
When the CyberEdge is configured in a HA Active/Passive cluster, the firmware update procedure for CyberEdge takes on the responsibility of managing updates across both nodes. This automated process is designed to simplify tasks for network administrators and maintain uninterrupted network performance. To initiate a firmware update for CyberEdge HA, follow these steps:
- Navigate to System > Updates
- Whilst the recommended firmware update will be displayed, manually click "Check for Updates" to scan for the latest available update
- Click "Update Now". This will initiate the update processes, which cannot be stopped. The update will start with the secondary (passive) node. After the secondary node's firmware update has completed successfully, it will automatically become the primary (active) node
- The demoted secondary (passive) node will now be automatically updated. Upon completion, the HA cluster will synchronize, with both nodes running the same firmware version
Following a HA firmware update, a network administrator can decide which node should become the primary (active) one. To ensure the cluster reverts to its original HA Active/Passive configuration, navigate to System > Nodes > High Availability _Settings and set "Fallback to Primary". However, it is recommended to say in the original primary active node for consolidated reporting.
Important information
- Always read the release notes prior to initiating a firmware update
- The HA firmware update process may take up to 20 minutes to complete, and possibly longer with low bandwidth internet connections
- The firmware updates are always completed on the secondary (passive) node
- If the firmware update process fails on the secondary (passive) node, the update job will cease to prevent any impact on the primary (active) node
- Throughout the HA update process, neither node in the cluster will accept configuration changes until the entire update process is completed
- To monitor the status of your HA nodes, go to Dashboard > System Health or System > Nodes > Status
- The HA update progress status can be viewed within the management user interface