syslog-ng Store Box 5.2.0 - Upgrade Guide

Preface

Welcome to syslog-ng Store Box (SSB) version 5.2.0 and thank you for choosing our product. This document describes the process to upgrade existing SSB installations to SSB 5.2.0. The main aim of this paper is to aid system administrators in planning the migration to the new version of SSB.

Caution:

Read the entire document thoroughly before starting the upgrade.

Upgrading to SSB 5.2.0 is not supported if you have SSB deployed on any of the following Pyramid hardware: SSB N1000, SSB N1000d, SSB N5000, SSB N10000. For details, see Prerequisites and Notes.

As of June 2011, the following release policy applies to syslog-ng Store Box:

  • Long Term Supported or LTS releases (for example, SSB 4 LTS) 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 4.0.1). Maintenance releases to LTS releases contain only bugfixes and security updates.

  • Feature releases (for example, SSB 4 F1) 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).

Caution:

Downgrading from a feature release to an earlier (and thus unsupported) feature release, or to the previous LTS release is not supported.

Prerequisites and Notes

Upgrade path to SSB 5.2.0

Upgrading to SSB 5.2.0 is tested and supported using the following upgrade path:

  • The latest SSB 5 LTS maintenance version (for example, 5.0.2) -> SSB 5.2.0

    Always upgrade to the latest available maintenance version of SSB 5 LTS before upgrading to SSB 5.2.0.

From older releases, upgrade to 5 LTS first. For details, see How to upgrade to syslog-ng Store Box 5 LTS.

Caution:

SNMP destinations and SQL sources have been removed in the current feature release

Do not upgrade to SSB 5.2.0 if you are currently using and want to continue to use:

  • SNMP destinations
  • SQL sources

These functionalities have been removed from SSB starting with version 5.2.0. Upgrading from 5 LTS and its minor versions would mean that you would have to upgrade to 5.2.0 - to continue to receive support for the product.

Staying on 5 LTS and its minor versions means that you will not have access to the HDFS destination functionality available in SSB starting with version 5.1.0, however, you will continue to get support for 3 years after the original publication date of 5 LTS (December 2017) and for 1 year after the next LTS release is published (whichever date is later).

If you wish to carry on using SNMP destinations or SQL sources, contact zoltan.szasz@oneidentity.com.

Pyramid hardware is not supported

SSB 5 LTS is not supported on the following hardware: SSB N1000, SSB N1000d, SSB N5000, SSB N10000.

In case you have SSB deployed on other, newer hardware or you have SSB 4 LTS, those will not be affected in any way. The version policy applies to those. For details, open the SSB product page on the Support Portal and navigate to Product Life Cycle & Policies > Product Support Policies > Software Product Support Lifecycle Policy.

If you wish to take advantage of new features and remain supported beyond the end date of the Extended Support phase, you need to upgrade your hardware. For assistance with your hardware upgrade, contact our Sales Team. For further inquiries, contact our Support Team.

If you do not know the type of your hardware or when it was purchased, complete the following steps:

  1. Log in to SSB.

  2. Navigate to Basic Settings > Troubleshooting > System debug, click COLLECT AND SAVE CURRENT SYSTEM STATE INFO, and save the file.

  3. Log in to the support portal and submit a ticket.

  4. In the Summary field, enter Determining hardware type.

  5. Upload the file you downloaded from SSB in Step 2.

  6. We will check the type of your hardware and notify you.

Upgrade checklist

The following list applies to all configurations:

  • 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 files, 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 5.2.0 license file from support portal. As license files are specific to each long term release, upgrading to SSB 5.2.0 removes any earlier license.

    Caution:

    SSB now strictly checks if you have a High Availability license when running SSB in High Availability mode. You cannot upgrade to 5 LTS or later when using a single-node license in a HA environment. After upgrading to 5 LTS or later, an SSB node can be converted to HA only if a valid HA license is installed. HA licenses include the following line:

    Licensed-Options: Highavailability

    To buy a valid HA license, contact your sales representative or contact our Sales Team.

  • You have downloaded the latest SSB core firmware and boot firmware from the Downloads page.

    For a detailed description of the different firmwares, 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 Downloads 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:

  • 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 master-slave synchronization, and the slave node might not be able to sync the new firmware from the master node on time.

If you are upgrading SSB in a virtual environment:

  • 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-productive (virtual, etc.) environment first.

Upgrading SSB requires a reboot. We strongly suggest that you perform the upgrade on the productive appliance during maintenance hours only, to avoid any potential data loss.

Upgrading to SSB 5.2.0

Upgrading SSB (single node)

Purpose:

If you want to upgrade a SSB cluster, see Upgrading an SSB cluster. To upgrade a standalone SSB node to version 5.2.0, complete the following steps.

Prerequisites:

Read the following warnings before starting the upgrade process.

Steps:
  1. Update the core firmware of SSB using the web interface.

    1. Navigate to Basic Settings > System > Core firmwares.

    2. Upload the new core firmware.

    3. When the upload is finished, select the After reboot option for the new firmware.

      Do not reboot SSB yet.

  2. Upload the boot firmware of SSB using the web interface.

    1. Navigate to Basic Settings > System > Boot firmwares.

    2. Upload the new boot firmware.

    3. When the upload is finished, select the After reboot option for the new firmware.

  3. 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.

  4. 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.

  5. Log in to the SSB web interface to verify that the upgrade was successful.

    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.

  6. Upload the new license file. For details, see Updating the SSB license.

Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents