Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

 

Note

Please remember to do backup first, before installing an update in case of any problems that may occur. To do backup please follow instructions below.

 

Please perform the following steps to create a backup using the Web Interface:
  1. Insert excerpt
    _OpenAdminWeb
    _OpenAdminWeb
    nopaneltrue
     > System > Backup

  2. Choose all listed components (addon_data, logfiles, monitoring, performance_data, system) for the inclusion and tick persistent backup (backup is excluded for the regular rotation)

  3. Choose Create new backup including components. The backup creation starts immediately in the background. The new backup file will appear in the list of available backups after the creation is finalized.
  4. Download the created backup by choosing   and store the created backup on an external drive 
Info

SONARPLEX generation 5 contains new features which aren´t available in SONARPLEX generation 4. This means that the SONARPLEX generation 5 does not support generation 4 backups anymore.

In order to perform a rollback, a backup must be created before updating to generation 5.

Enable Large Installation Tweaks

Please enable Use large installation tweaks before the upgrade, this option deactivates automatic backups upon startup. This is highly recommended as otherwise the upgrade can take a long time and most installations can easily rely on SONARBACKUP or the regular auto backups.

To enable the large installation tweaks:

  1. Insert excerpt
    _OpenAdminWeb
    _OpenAdminWeb
    nopaneltrue
     > Configuration > System > Load Configuration
  2. Activate Use large installation tweaks
Info
You can activate this option whenever you are doing maintenance tasks and want to avoid the automatic start up backup. Of course you can activate it afterwards again.

Disable Notifications

Notifications should be disabled globally during the upgrade process to avoid any unnecessary notifications or even possible alert floods. 

Disable notifications globally:

  • Open the Web GUI > Status > Processes
  • Choose Image Removed Disable notifications and press Commit in the next screen

    Insert excerpt
    _UserWebDisableNotificationsGlobally
    _UserWebDisableNotificationsGlobally
    nopaneltrue

    Info

    This disables the notifications persistently, so even reboots and Monitor process restarts will keep the notification system disabled. Check Re-Enable the Notifications after the upgrade.

    Upgrade Installation

    Upgrade to SONARPLEX version 4.2.x

    Info

    You must download the SONARPLEX image(s) for the following upgrades form the azeti Portal specifically for your device(s), see the previous section Individual File Download for details.

    To upgrade to 4.2.x do the following:

    1. Insert excerpt
      _OpenAdminWeb
      _OpenAdminWeb
      nopaneltrue
       > Update
    2. Choose Manual Update and Browse to select the SONARPLEX version 4.2.0 image file (extension .aup) you downloaded previously
    3. Select the update icon  to start the update, the SONARPLEX will reboot which takes up to 10 minutes

    Install necessary updates for 4.2.x

    To allow the upgrade to SONARPLEX Generation 5 you must install a patch.

    Info
    Minimum patch level for the upgrade from SONARPLEX 4.2 is base 7, named update-4.2.0b-base-7.tar.

    Even if you decide to stay with SONARPLEX release 4.2 the patch fixes some major bugs and it is recommended to be installed.

     

    ...

     

    After the SONARPLEX Upgrade

    SONARPLEX 5 is a major release and thus some minor system configuration changes must be done right after the upgrade. 

    Updating the LOAD Configuration

    The following step assures that the global LOAD Configuration is properly updated and is mandatory.

    1. Insert excerpt
      _OpenAdminWeb
      _OpenAdminWeb
      nopaneltrue
       > Configuration > System > Load Configuration
    2. Choose  to save the current configuration and apply it with the following 

    Configure the global Log Level

    A whole new logging framework was introduced with the upgrade. See

    Insert excerpt
    _AdminWeb
    _AdminWeb
    nopaneltrue
     > Configuration > System > Logging Configuration.

     By default the Debug log level is set to OFF. We recommend turning it to INFO for all hardware types except the azeti NG.

    Note

    The azeti NG runs on SD flash storage and debug log levels can lead to decreased lifetime of the storage due to large amounts of write operations through logging. Therefore leave the Debug log level set to OFF.

    Flush the Retention File

    To warrant a consistent status among the old and new plugins, delete the retention file. 

    Info

    Deleting the retention file leads to a flush of all status information, this will set every host and service object into state PENDING. This is expected and the objects will be checked during the normal check intervals and return into a non-PENDING state.

    Deleting the retention file:

    Insert excerpt_OpenAdminWeb_OpenAdminWebnopaneltrue > Status > Monitor
  • Choose Image Removed Delete state retention file (read online help before using), the Monitor process will be restarted automatically
  • Flush the Mail Queue

    It is

    Insert excerpt
    _AdminWebDeleteRetention
    _AdminWebDeleteRetention
    nopaneltrue

    Flush the Mail Queue

    It is possible that during the upgrade system messages are created and stored in the email queue. Those would be sent out whenever you enable the SMTP configuration and you can flush those if you don't want to receive such mails from the upgrade.

    Flushing queued e-mails:

    1. Insert excerpt
      _OpenAdminWeb
      _OpenAdminWeb
      nopaneltrue
       > System > Email Queue
    2. Choose  Delete all messages in queue and press OK

    Re-Enable the Notifications

    When all upgrade steps are done and the system behaves properly, it is save to enable the notifications again. Check that not too many service and host checks are in Non-OK states to avoid notification floods.

    Enable notifications globally:

  • Open the Web GUI > Status > Processes
  • Choose Image Removed Enable notifications and press Commit in the next screen

    Insert excerpt
    _UserWebEnableNotificationsGlobally
    _UserWebEnableNotificationsGlobally
    nopaneltrue

     

    Plugin Migration

    Info

    Note that most of the plugins will show up Installation problems(s) (see screenshot above) in

    Insert excerpt
    _AdminWeb
    _AdminWeb
    nopaneltrue
    > Configuration > My Plugins, this is normal as you now must upgrade the plugins for compatibility.

    Follow one of the below described ways, automatic or manual, to update all plugins.

    Installing the Plugin Update Package

    As most of the plugins are not compatible between SONARPLEX 4.x.x and 5.x.x, these must be updated. 

    Info

    We highly recommend to use the upgrade patch as it will upgrade the plugins automatically. You can find the plugin update, named plugin-updates-003_v4.2.0b_to_v5.1.1a.tar in the azeti Portal > Downloads > SONARPLEX Generation 5 > Updates

    After the download you must install the plugin updates package:

    1. Insert excerpt
      _OpenAdminWeb
      _OpenAdminWeb
      nopaneltrue
       > System > Patch
    2. Choose Browse to select the proper patch file and elect the apply icon  to start the installation, the SONARPLEX will reboot which can take up to 10 minutes
    Tip
    If you performed all necessary steps as noted in this guide you have successfully updated to SONARPLEX 5.1.1a.