This section provides general guidelines for supported direct upgrade paths in syslog-ng Store Box (SSB).
For more information about possible upgrade scenarios, and their recommended upgrade paths for upgrading from LTS or Feature releases to LTS or Feature releases, see Possible upgrade path scenarios, and their recommended upgrade paths.
For more information about specific upgrade paths to the current release of SSB (version 7.4.0), see Upgrade paths to the current version of SSB.
General guidelines for direct upgrade paths
The following general guidelines apply for direct upgrade paths in SSB at all times:
-
Maintenance version prerequisites
Before you upgrade from any LTS or Feature release version, always make sure that the release you are using has the latest available maintenance version installed. Otherwise, always upgrade directly to the latest available maintenance version of the release version you are using.
Examples: meeting maintenance version prerequisites before upgrading
The following examples illustrate two different upgrade scenarios when you can not upgrade directly and have to meet the maintenance requirements first.
Feature release version
If your SSB appliance is at Feature release version M.F.0 (where M is the major version and F is the minor feature version), while a maintenance Feature release version of M.F.1 exists, you must perform a direct upgrade to M.F.1 (that is, to the latest available M.F maintenance version) before upgrading forward.
LTS version
If your SSB appliance is at LTS version M.0.Y (where M is the major version and Y is the maintenance version), while a maintenance LTS version M.0.Z exists (where Y < Z), One Identity recommends to perform a direct upgrade to version M.0.Z (that is, to the latest available LTS maintenance version of major version M) before upgrading forward.
-
Supported direct upgrade scenarios
Direct upgrade scenarios are only available to a succeeding version number. For example, upgrading from Feature release version M.F.0 to LTS version M.0.X is not supported, as 0 < F.
For LTS release versions, direct upgrade is only available to the LTS versions of the same or next major release, and to the Feature release versions of the same major release.
One Identity recommends to first upgrade to the latest LTS release version of the same major version.
Example: Direct upgrade from LTS versions
NOTE:The following upgrade paths are examples to demonstrate the general guidelines of upgrade paths. For more information about specific upgrade paths to the current release of SSB (version 7.4.0), see Upgrade paths to the current version of SSB.
For example, from version M.0.X, you can jump directly to Feature release versions M.1.0, M.2.0, and so on, or to LTS versions M.0.X+1 and M+1.0.1.
However, you cannot perform a single-step, direct upgrade to a version that is larger than the next LTS release (for example, from version M.0.X to version M+2.0.1).
For feature release versions, direct upgrade path is available to the Feature release versions of the same major release, and the LTS versions of the next major version.
Example: Direct upgrade from Feature release versions
NOTE:The following upgrade paths are examples to demonstrate the general guidelines of upgrade paths. For more information about specific upgrade paths to the current release of SSB (version 7.4.0), see Upgrade paths to the current version of SSB.
For example, from version M.F.0, you can jump directly to Feature release versions M.F+1.0, M.F+2.0, and so on, or to LTS versions M+1.0.1 and M+1.0.2.
However, you cannot perform a single-step, direct upgrade to a version that is larger than the next LTS release (for example, from version M.F.0 to version M+2.0.1).
NOTE: While you cannot perform a single-step upgrade (for example, directly upgrading from version M.F.0 to version M+1.G.0), you can upgrade from version M.F.0 to version M+1.G.0 in two steps. First, upgrade to the latest available maintenance version of M+1 LTS, then upgrade to version M+1.G.0.
NOTE: Starting from version 7.0.1 LTS, syslog-ng Store Box (SSB) supports the SSB 4000 appliance. The usual upgrade path to the newest feature version is supported only if the feature version to which you want to upgrade also supports the SSB 4000 appliance. Because of this, for example, you cannot upgrade from version 7.0.1 LTS to version 7.2F. However, SSB Feature release version 7.3F or later already supports the SSB 4000 appliance, so you can upgrade from version 7.0.1 LTS to version 7.3F or succeeding versions.
The following examples illustrate possible upgrade scenarios, and their recommended upgrade paths for upgrading from LTS or Feature releases to LTS or Feature releases:
NOTE:The following upgrade paths are examples to demonstrate the general guidelines of upgrade paths. For more information about specific upgrade paths to the current release of SSB (version 7.4.0), see Upgrade paths to the current version of SSB.
|
Example for |
From |
To |
Recommended (optimal) upgrade path |
|
LTS to next LTS upgrade |
6.0.0 |
7.0.2 |
6.0.0 to 6.0.5, then to 7.0.2 |
|
Complex upgrade, with several upgrade steps |
4.9.0 |
7.3.0 |
4.9.0 to 4.9.1, then to 5.0.4, then to 6.0.5, then to 7.0.2, then to 7.3.0 |
|
Direct, single-step upgrade |
7.1.0 |
7.3.0 |
7.1.0 to 7.3.0 |
From older releases, upgrade to 6 LTS first, then to 7 LTS. For details, see How to upgrade to syslog-ng Store Box 5 LTS.
For more information about specific upgrade paths to the current release of SSB (version 7.4.0), see Upgrade paths to the current version of SSB.
For more information about guidelines for supported direct upgrade paths in SSB, see Guidelines and support for direct upgrade paths in SSB.
This section contains detailed information about the possible upgrade paths to the current version of syslog-ng Store Box (SSB). The most recent SSB version is 7.4.0.
For more information about the versioning system in SSB, see Version numbering in SSB.
For more information about guidelines for supported direct upgrade paths in SSB, see Guidelines and support for direct upgrade paths in SSB.
Upgrade paths to the current version of SSB (version 7.4.0)
Upgrading to SSB version 7.4.0 is tested and supported using the following upgrade path scenarios:
-
The latest SSB 7 LTS maintenance version (for example, 7.0.x) to version SSB 7.4.0.
NOTE: Always upgrade to the latest available maintenance version of SSB 7 LTS before upgrading to SSB version 7.4.0.
-
The latest maintenance versions of the previous, not yet discontinued feature releases to version SSB 7.4.0.
NOTE: Starting from version 7.0.1 LTS, syslog-ng Store Box (SSB) supports the SSB 4000 appliance. The usual upgrade path to the newest feature version is supported only if the feature version to which you want to upgrade also supports the SSB 4000 appliance. Because of this, for example, you cannot upgrade from version 7.0.1 LTS to version 7.2F. However, SSB Feature release version 7.3F or later already supports the SSB 4000 appliance, so you can upgrade from version 7.0.1 LTS to version 7.3F or succeeding versions.
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.
-
For added safety, you have also exported the current configuration of SSB.
For detailed instructions, refer to Exporting the configuration of SSB.
-
You have a valid support portal account.
To download the required firmware file and the new license 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 new 7.4.0 license file from support portal. As license files are specific to each long term release, upgrading to SSB 7.4.0 removes any earlier license.
-
You have downloaded the latest SSB firmware file from the Downloads page.
For a details about the firmware file, see Firmware in SSB.
-
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:
-
|
|
CAUTION: Before upgrading to SSB version 7.4.0 in High Availability (HA) mode, ensure that the nodes have already been restarted since the last upgrade. Otherwise, you have to restart the nodes before upgrading SSB to version 7.4.0. |
-
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, 3500 and 4000, see Knowledge Base Article Latest IPMI firmware for Syslog-ng Store Box 3000/3500/4000 and One Identity Safeguard for Privileged Sessions 3000/3500/4000 appliances.
-
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.
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.
