Upgrading From a Previous Neuron Release

The procedures in this topic show you how to upgrade from Neuron 2.6, to Neuron ESB 3.0.  For assistance with upgrades from earlier versions of Neuron ESB, please contact support for guidance.

Upgrading from a previous release of Neuron ESB is fairly straight-forward.  The basic steps are below.  This sequence of steps needs to be repeated for each instance of Neuron ESB on the same server.  The only exception would be step 6, upgrading the Neuron Auditing Server.  If multiple instances are using the same auditing database you only need to upgrade it once.  Note, however, that if multiple instances are utilizing the same auditing database, you will need to complete each of the steps below for every one of those instances before moving to the next step.  This is because once you upgrade the database, other instances utilizing that database will stop running.

Upgrading Neuron ESB:

1. Download Neuron ESB 3.0
2. Complete message processing
3. Backup configuration files
4. Uninstall previous version
5. Upgrade Dependencies for Neuron 3.0
6. Install new version
7. Replace backed-up files
8. Upgrade Neuron Auditing Database (optional, only required if using features that require the use of a database)
9. Migrate Neuron ESB Configurations
10. Upgrade considerations

Once you complete step 4 - Install New Version, do not start the ESB Service until you've completed all the steps.

Download Neuron ESB 3.0

You can download Neuron ESB 3.0 from here: Neuron ESB 3.0

Complete Message Processing

Before taking the steps to upgrade a Neuron ESB Server, make sure all in-flight messages have completed processing.  This typically involves making sure all of the publishers stop publishing messages to the ESB, and if you're using MSMQ-based topics, letting all of the queues empty.  

Backup Configuration Files

Any Neuron ESB configuration files you have modified should be backed up prior to upgrading.  One reason for this is that the uninstall process will remove any standard configuration files that are normally installed (i.e. esbservice.exe.config).  Some of the files to back-up are any application configuration files (esbservice.exe.config, neuronpipelines.config), any custom assemblies (adapters, processes or other assemblies you've copied to the installation folder) and all Neuron ESB Configuration folders you've created for your solutions.  You can copy these files back to the installation directory after reinstalling Neuron ESB.

Uninstall Previous Version

The Neuron ESB installer does not perform an in-place upgrade.  You have to uninstall the current version prior to installing the new version.  Use Add/Remove Programs to uninstall Neuron ESB.

Upgrade Dependencies for Neuron 3.0

Prerequisites

In order to install and run Neuron ESB 3.0, the following software needs to be installed on your computer. The Neuron ESB 3.0 installer will attempt to locate these software packages on your computer.  Please use the hyperlinks below to download the software packages and install them on your computer prior to installing Neuron ESB 3.0.

• Microsoft .NET Framework 4
• Windows Installer 4.5

Additional Software

Neuron ESB 3.0 introduces a new channel type that is based on RabbitMQ Server. Installation of RabbitMQ Server is optional and is not required to use Neuron ESB 3.0. If RabbitMQ Server is not installed, the Neuron ESB 3.0 installer will give you the option of automatically downloading and installing Erlang and RabbitMQ Server. If you want to use the new AMQP channel type, but your computer does not have Internet access, please download and install the following software packages before installing Neuron ESB 3.0.

• Erlang
• RabbitMQ Server

Install New Version

Neuron ESB 3.0 is now installed using a new bootstrapper installer, Setup.exe.  This installation wraps the “old” .msi and includes the installations of RabbitMQ and Erlang.  Setup.exe also gives you the ability to install multiple instances.  To install Neuron ESB 3.0, run Setup.exe.  Do not start the Neuron ESB Service yet!

Replace Backed-Up Files

Replace all of the files you previously backed-up.

Upgrade The Neuron Auditing Database

You must upgrade your Neuron Auditing Database before starting the Neuron ESB Service.  There is a SQL script you can use to upgrade a 2.6 version of the database to 3.0.  After installing Neuron 3.0, that script will be found at C:\Program Files\Neudesic\Neuron ESB v3\Sql\Updates\Update_To_3.0.sql.  

Migrate Neuron ESB Configurations

Before configuring and starting the Neuron ESB 3.0 service, your ESB Configurations need to be migrated.  In Neuron ESB 3.0, the Neuron ESB Configurations are now saved in a folder structure instead of a single .esb file.  Instructions on how to migrate your current Neuron ESB Configurations can be found here : http://forum.neuronesb.com/forum/topics/migrating-from-2-6-to-neuro...

Upgrade Considerations

Side-by-Side Support

Neuron ESB 3.0 and 2.6 is supported when installed side-by-side.  However, some precautions need to be taken into consideration before configuring this scenario. 

• Discovery Services – When you install either version of Neuron ESB, a Discovery Service is also installed for that version.  The Discovery Services are used by Neuron ESB Explorer to discover the various instances of that version of Neuron.  By default the 2.6 version of the discovery service is configured to use a different TCP port than the 3.0 version. There should be no issues when running side by side.

• ESB Configurations – ESB Configurations are created with a set of default port values which are defined in the Zones.  When you install Neuron 2.6 and 3.0 for side-by-side execution, one of the ESB configurations will need to be modified to change these port values.  If you fail to do this, the first ESB Instance you start will start just fine.  The second instance will fail to start and report port conflicts.