Welcome to syslog-ng Store Box (SSB) version 6.4 and thank you for choosing our product. This document describes the process to upgrade existing SSB installations to SSB 6.4. The main aim of this paper is to aid system administrators in planning the migration to the new version of SSB.
Read the entire document thoroughly before starting the upgrade.
As of June 2011, the following release policy applies to syslog-ng Store Box:
Long Term Supported or LTS releases (for example, SSB 5.0) are supported for 3 years after their original publication date and for 1 year after the next LTS release is published (whichever date is later). The second digit of the revisions of such releases is 0 (for example, SSB 5.0.1). Maintenance releases to LTS releases contain only bugfixes and security updates.
Feature releases (for example, SSB 5.1) are supported for 6 months after their original publication date and for 2 months after succeeding Feature or LTS Release is published (whichever date is later). Feature releases contain enhancements and new features, presumably 1-3 new features per release. Only the last of the feature releases is supported (for example, when a new feature release comes out, the last one becomes unsupported).
Downgrading from a feature release to an earlier (and thus unsupported) feature release, or to the previous LTS release is not supported.
Upgrading to SSB 6.4 is tested and supported using the following upgrade path:
The latest SSB 6 LTS maintenance version (for example, 6.0) -> SSB 6.4
Always upgrade to the latest available maintenance version of SSB 6 LTS before upgrading to SSB 6.4.
The latest maintenance versions of the previous three feature releases (in this case, SSB 6.1 or 6.2) -> SSB 6.4
From older releases, upgrade to 6 LTS first. For details, see How to upgrade to syslog-ng Store Box 5 LTS.
The following list applies to all configurations:
The firmware of your SSB appliance is not tainted (that is, none of its files were modified locally). If the firmware is tainted, a warning is displayed on the Basic Settings > System > Version details page.
Upgrading is not supported if the firmware is tainted. If your firmware is tainted, contact our Support Team.
You have backed up your configuration and your data.
For more information on creating configuration and data backups, see "Data and configuration backups" in the Administration Guide.
For added safety, you have also exported the current configuration of SSB.
For detailed instructions, refer to "Exporting the configuration of SSB" in the Administration Guide.
You have a valid support portal account.
To download the required firmware file, you need a valid support portal account. To create an account, navigate to the support portal and follow the instructions on screen (you will need to enter your product's asset number, which is the license number or serial number you have been provided previously).
You have downloaded the latest SSB firmware file from the Downloads page.
For a details about the firmware file, see "Firmware in SSB" in the Administration Guide.
You have read the Release Notes (changelog) of the firmware(s) before updating. The Release Notes might include additional instructions specific to the firmware version.
The Release Notes are available on the syslog-ng Store Box Documentation page.
If you have a high availability cluster:
You have IPMI access to the slave node. You can find detailed information on using the IPMI interface in the following documents:
For syslog-ng Store Box (SSB) Appliance 3000 and 3500, see the Latest IPMI firmware for Syslog-ng Store Box 3000/3500 and One Identity Safeguard for Privileged Sessions 3000/3500 appliances.
For syslog-ng Store Box (SSB) T1 and syslog-ng Store Box (SSB) T4, see the IPMI User's Guide.
You have verified on the Basic Settings > High Availability page that the HA status is not degraded.
If you have a high availability cluster with geoclustering enabled: Perform the firmware upload steps an hour before the actual upgrade. Geoclustering can introduce delays in the synchronization between the primary and the secondary node, and the secondary node might not be able to sync the new firmware from the primary node on time.
If you are upgrading SSB in a virtual environment:
NOTE: When setting up a virtual environment, carefully consider the configuration aspects such as CPU, memory availability, I/O subsystem, and network infrastructure to ensure the virtual layer has the necessary resources available. Please consult One Identity's Product Support Policies for more information on environment virtualization.
You have created a snapshot of the virtual machine before starting the upgrade process.
You have configured and enabled console redirection (if the virtual environment allows it).
During the upgrade, SSB displays information about the progress of the upgrade and any possible problems to the console, which you can monitor with IPMI (ILOM) or console access.
We recommend that you test the upgrade process in a non-production (virtual) environment first.
Upgrading SSB requires a reboot. We strongly suggest that you perform the upgrade on the production appliance during maintenance hours only, to avoid any potential data loss.
For details on upgrading your syslog-ng Store Box (SSB) installation to 6.4, see the following procedures.
If you want to upgrade a SSB cluster, see Upgrading an SSB cluster.
Read the following warnings before starting the upgrade process.
To upgrade a standalone SSB node to version 6.4
Stop SSB from accepting the incoming log traffic. Navigate to Basic Settings > System > Service control and click Disable.
Update the firmware of SSB using the web interface.
Navigate to Basic Settings > System > Upgrade.
Upload the new .ISO file.
When the upload is finished, click Upgrade and reboot node.
Navigate to Basic Settings > System > System Control > This node, and choose Reboot.
SSB attempts to boot with the new firmware. Wait for the process to complete.
Recommended step. To help troubleshoot potential issues following the upgrade, collect and save system information (create a debug bundle) now.
Navigate to Basic Settings > Troubleshooting > System debug and choose Collect and save current system state info.
Navigate to Basic Settings > System > Version details and check the version numbers of SSB. In case you encounter problems, you can find common troubleshooting steps in Troubleshooting.
Enable SSB to receive the incoming log traffic. Navigate to Basic Settings > System > Service control and click Enable.