Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Introduction

This guide is intended to help you through the migration process from SONARPLEX Version 4.1.x and 4.2.x to SONARPLEX release 5.1. SONARPLEX Generation 5 is a major release, and contains essential changes of the software especially for the plugins. This requires from the user additional steps in the upgrade procedure. 

Important Notes and Restrictions

There are minor restrictions to be aware of, before starting with the upgrade.

This guide assumes you want to upgrade from SONARPLEX release 4.1 to SONARPLEX release 5.1. 

Status Update

The system configuration, performance data and event-log will be upgraded to the new version. Due to the major software change the status file will not take over to the new version. This means it will take a while until the status will be updated.

Plugin Upgrade

Plugins need to be upgraded manually. The Plugin configuration will be automatically upgraded during the installation of the new plugins.

The auto-upgrade function for plugins is not supported to upgrade from SONARPLEX generation 4 to SONARPLEX generation 5.

 For all plugins (except the *.pl plugins) you already installed on your appliances you should find a new version in the portal. If you miss any of your plugins please do not continue and contact the azeti technical support. Still, the upgrade patch will take care of the versions and the plugins upgrade if you follow the "upgrade patch" route.

Upgrade Preparations

Upgrade path

The  SONARPLEX can be upgraded from release 4.2 to 5.1. When you have a previous version you have to upgrade to release 4.2 first.


Order of upgrades in distributed monitoring (DM) environments

When upgrading in a distributed monitoring environment, you can decide the upgrade order that fits your organization. The distributed monitoring environment will work in an environment that have both SONARPLEX generation 4 and generation 5.

Order of upgrades in high-availability (HA) configurations

If you have a HA system installed, first you have to upgrade the master and second the slave.

Download necessary upgrade files

Please download following files from the azeti Portal. These are the minimum required files for the upgrade procedure.

  • SONARPLEX 4.2 patch level - 7
  • SONARPLEX 4.2 upgrade file - azeti Portal (see My Appliances).
  • SONARPLEX 5.1 upgrade file - azeti Portal (see My Appliances).
  • SONARPLEX 5 compatible plugins -if you did not receive the latests version plugins with the migration package, contact support.
  • SONARMANAGER 2.7.3.17 - if you did not receive this version with the migration package, contact support.
  • when neccesary, SONARPLEX 4.1.3 downgrade patch.

System Backup

 

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. Open the Administration GUI
  2. Browse to "Backup" (left site menue) 
  3. Ensure that all backup options are ticked as shown in the screenshot above
  4. Click on Create new backup including components
  5. SONARPLEX will start to create the backup in the background (will take some time depending of the size of the backup)
  6. Once created it will appear in the list with available backups

 

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 should be created before updating to SONARPLEX generation 5.

Store the created backup on an external drive. To download click on the disk icon in the row of the created backup.

Upgrade Installation


Most of the plugins you are using in your appliance are not compatible with the SONARPLEX generation 5 and need to be updated as well. Before starting the upgrade process, you should have a new version for each one of your already installed plugins. If you miss a new version for a plugin please do not continue and contact the azeti technical support.

Before the installation

In the Admin GUI, go to Configuration::system::Load Configuration option. Select the option "Use large installation tweaks" and confirm the changes. This option will avoid the automatic backup that is done every time that the SONARPLEX reboots, reducing the time neccesary to perform the upgrades.

 

You can activate this option whenever you are doing maintenance tasks and want to avoid the automatic start up backup.

 

Upgrade to SONARPLEX version 4.2

Please perform the following steps to install SONARPLEX version 4.2.0 using the Web Interface:

  • open the Administration GUI (IPADDRESS:81)
  • browse to "Update" (left side menu)
  • go to manual update section and click on "browse" to select the SONARPLEX version 4.2.0 upgrade file
  • click on "upload the selected file" icon on the right side of the upgrade file name to start the upgrade process
  • the upgrade process will takes some minutes and will reboot when finished
  • now the SONARPLEX runs the version 4.2.0

Install Patch to allow upgrade to SONARPLEX generation 5

To allow the upgrade to SONARPLEX Generation 5 please install patch level update-4.2.0b-base-7 or higher on your appliance. 

Minimum patch level for the upgrade from SONARPLEX 4.2 is base 7.

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

 

Upgrade to SONARPLEX version 5.1

Please perform the following steps to install SONARPLEX generation 5 using the Web Interface:

  • open the Administration GUI (IPADDRESS:81)
  • browse to "Update" (left side menu)
  • go to manual update section and click on "browse" to select the SONARPLEX generation 5 upgrade file
  • click on "upload the selected file" icon on the right side of the upgrade file name to start the upgrade process
  • the upgrade process will takes some minutes and will reboot when finished

To check if the update to SONARPLEX generation 5 was successfully installed, simply open the appliance GUI using its IP Address. SONARPLEX 5 was redesigned with different colors, which is is easiest way to verify your update. To check which version of SONARPLEX is running on your appliance visit section Status - Summary.

Due to the caching of your Web Browser it might be necessary to manual reload of the SONARPLEX Web page; most browsers support CTLR-F5 to reload.

SONARPLEX 4 


SONARPLEX 5


Plugin Migration

Preparation

Most of the plugins you are using in your appliance are not compatible with the SONARPLEX generation 5 and need to be updated. Therefore after the upgrade, you will find most of the plugins in red (See image below.). This means they have to be upgraded. The new version of the plugins can be found in the azeti portal. 

 


To migrate all installed plugins you can choose three different ways:

  • Plugin upgrade patch (recommended) 
  • the SONARMANAGER
  • the SONARPLEX Administration GUI

Different types of plugins require different handling. With both the SONARPLEX Administration GUI and the SONARMANAGER you are able to migrate and both guides describe all necessary steps.

  • Perl plugins (plugins with extension *.pl)
    OK, nothing to do. Normally this type of plugins should run under the new version without any migration activities.
  • *.tar.gz plugins
    These type of plugins is not supported anymore. To migrate it to new version the corresponding *.azsp successor need to be installed. The new *.azsp version automatically takes over the configuration from the old version. The obsolete tar.gz should be deinstalled.
  • *.azse plugins (addons)
    These type of plugins need to be replaced by the new version. The new version automatically takes over the configuration from the old version.
  • *.azsp plugins (checks)
    These type of plugins need to be replaced by the new version. The new version automatically takes over the configuration from the old version.
  • modbus daemon and modbus plugins; see section modbus migration

Migration of MODBUS daemon if you choose not to use the patch:

  1. Deinstall both plugins modbus_fastd-COM1.azse and modbus_fastd-COM2.azse
  2. Install modbus_fastd_<version>_INTEL.azse. (version stands for the plugin version number. Please choose the most recent.)
  3. Installation of the new versions of MODBUS check plugins (if check_modbus_fast_write3 was installed please install the new version of it check_modbus_fast_write4)
  4. Migration of MODBUS configuration: simply install modbus_active_to_passive_converter-<version>.azse. Once installed the migration is done and the plugin can be deinstalled.
  5. Adapt configuration to the new plugins (see below). 
  6. If check_modbus_fast_write3 was installed please deinstall it.

Automatic Plugin Upgrade (recommended)

This is the recommended way. Please install the patch update-5.1.0b-base-1.tar. It will automate the whole upgrade process and will migrate the MODBUS configuration to apply to the new generation 5 feature set.

 

 

Manual Plugin Upgrade (complex and fragile)

 

The manual plugin upgrade should only be considered if the automatic upgrade is not suitable or cannot be done. Please contact support@azeti.net for assistance.

 

Updating Plugins with SONARMANAGER


The minimum version of SONARMANAGER is 2.7.3.11. The recommended version is the latest available (at the moment of writing 2.7.3.17).  Please upgrade SONARMANAGER before the plugin migration.


  • Create a folder and store all SONARPLEX 5 compatible plugins into it. In case you have MODBUS please copy modbus_fastd-COM1.azse, modbus_fastd-COM2.azse and check_modbus_fast_write3.azsp inti the folder as well, in order that SONARMANAGER allow you to delete them from the appliance.
  • Open the project of the system that you are migrating. Please take into account that after the upgrade it can take some minutes to the agent to be active. Wait until you can see the agent in OK and with no timeout in the services list.
  • Download the configuration of your appliance
  • Click on "choose plugin directory" in setup menu

  • Once the plugin folder is specified, right click the appliance in status tree and select "Manage Plugins"
  • If you are using MODBUS: right click on you appliance and choose "Manage Plugins" and deinstall modbus_fastd-COM1.azse and modbus_fastd-COM2.azse. To do this, uncheck all other plugins, mark the "Remove" tick of the mod_bus_fastd-COM1 and COM2, and modbus_setup,  and press apply.

 

  • Install the modbus_fastd plugin (tick it an press apply)

 

  • Install all other plugins to be updated. Check all the new plugins and press apply. The old plugins "Modbus Fast Write Plug-In for fast MODBUS daemon", modbus_fastd-COM1 and 2, the new modbus_fastd and the modbus_active_to_passive_converter have to stay unchecked.


 

  • Migrate the Modbus configuration; tick the modbus_active_to_passive_converter and press apply

 

  • Close the Plugin Management box and open it again (this is because of a software bug)
  • Cleanup; deinstall the "Modbus Fast Write Plug-In for fast MODBUS daemon" and the modbus_active_to_passive_converter. Check the two and press apply.

  • Close the Plugin Management box 

Done!

Updating Plugins via the Administrative Interface

Remove old MODBUS-Daemons

If you are using Modbus deinstall modbus_fastd-COM1.azse, modbus_fastd-COM2.azse and modbus_setup:

  1. click on the triangle to expand the Plugin page
  2. click on the bin "Delete plugin" icon and confirm to deinstall it

Install the new MODBUS-Daemons

Install the new Modbus daemon, modbus_fastd.azse:

  1. Click browse to select modbus_fastd.azse
  2. Click on upload
  3. Wait for "install -ok"

Update incompatible Plugins

Incompatible/obsolete plugins are marked in red color and require a new version. Do following steps for all red marked plugins:

  1. Click browse to select the plugin
  2. Click on upload
  3. Wait for "install -ok"

Migrate the MODBUS Plugins

If you are using Modbus install MODBUS migration Plugin:

  1. Click browse to select the plugin modbus_active_to_passive_converter.azse
  2. Click on upload
  3. wait some seconds and press F5 to refresh your Web browser (this is because of a software bug)

For cleaning up your appliance delete check_modbus_fast_write3.azsp and modbus_active_to_passive_converter.azse:

  1. click on the triangle to expand the Plugin page
  2. click on the bin "Delete plugin" icon and confirm to deinstall it

Done!

At the end the MyPlugins page should look like this:

Configuration changes after upgrade

The new release introduced a whole new logging framework which allows a detailed logging configuration for single system components.

  • By default logging verbose level is OFF. We recommend turning it to INFO for all hardware types except the SONARPLEX NG as it runs on SD flash.
  • To warrant a consistent status among the old and new plugins, delete the retention file by going to the administrative interface; go to the Status::Monitor menu and press the icon for "Delete state retention file".
  • The modbus upgrade uses a plugin called "modbus_active_to_passive_converter". This is an script that adjusts for you the configuration of the modbus plugins that were installed in the system. If still in the system after the upgrade (when using the  patch upgrade, it should automatically removed from the system), search in Configuration::MyPlugins for the pluging "Modbus_active_to_passive_converter". This plugin can be safely removed from the system.

Downgrade to SONARPLEX 4.x.x

Following instruction guides you to perform a downgrade from SONARPLEX generation 5 to the previous version 4.x.x. Similar as for the upgrade you need to follow the upgrade path in the reverse direction. This means if you want to go to release 4.1.3 you need to install 4.2.0 first as an intermediate step.

The next steps are an example how to downgrade from SONARPLEX version 5.1.0 to version 4.1.3 with installed patch level 53

Preparations

  • you need the two upgrade images SONARPLEX version 4.2.0 and 4.1.3
  • you need the last patch for SONARPLEX version 4.1.3 update-4.1.3a-enhance-53-ir.tar
  • you need a backup created in SONARPLEX version 4.1.3
  • you need the downgrade patch update-4.1.3a-down-1.tar

Downgrade

  1. Update to SONARPLEX version 4.2.0
  2. Update to SONARPLEX version 4.1.3
  3. Install patch update-4.1.3a-down-1.tar --> Special patch to allow downgrade.
  4. Install patch update-4.1.3a-enhance-53-ir.tar
  5. Restore the backup you created in SONARPLEX version 4.1.3
  6. Done

 

 

  • No labels