Enterprise Service Bus/RabbitMQ

Manual Download (recommended)

• Download your target version of Erlang OTP: https://www.erlang.org/downloads 
• Download your target version of RabbitMQ Server: https://github.com/rabbitmq/rabbitmq-server/releases 

Once the packages have been downloaded, there should be two installation packages like:

• otp_win64_26.2.5.2.exe
• rabbitmq-server-3.13.6.exe

PowerShell Download (optional)

You can use the following PowerShell script to automate the process of downloading the software.

# Download Erlang OTP
$erlangUrl = "https://github.com/erlang/otp/releases/download/OTP-24.3.4.8/otp_win64_26.2.5.2.exe"
$erlangFile = "otp_win64_26.2.5.2.exe"
Invoke-WebRequest -Uri $erlangUrl -OutFile $erlangFile

# Download RabbitMQ Server
$rabbitUrl = "https://github.com/rabbitmq/rabbitmq-server/releases/download/v3.9.27/rabbitmq-server-3.13.6.exe"
$rabbitFile = "rabbitmq-server-3.13.6.exe"
Invoke-WebRequest -Uri $rabbitUrl -OutFile $rabbitFile

Backup Config Files

• Open PowerShell as an Administrator
• Navigate to your RabbitMQ folder, e.g. C:\Program Files\RabbitMQ Server\rabbitmq_server-\3.9.5\sbin
• Now execute the following command: 

.\rabbitmq-diagnostics status

• Locate the Config files section that would look like this:

Config files

* /etc/rabbitmq/advanced.config
* /etc/rabbitmq/rabbitmq.conf

• Navigate to the path(s) and copy your config files to a different location, e.g into your user profile (C:\Users\vvalentine)
• Keep the paths in mind or note the paths down as you will need them later for restoring the files

Backup Definitions

• To create a backup of the definitions (queues and users) execute the following in a PowerShell command line: 

.\rabbitmqctl.bat export_definitions $env:USERPROFILE\rabbitmq.definitions.json​

Backup Messages (optional)

Skip the export and later the import of messages as you like, they are considered disposable and if there is no load at the time of the update couple messages get lost, which is fine. To create a backup of all current messages, make an export using the PowerShell script below which is utilizing the RabbitMQ Managment REST API. Replace the username, password, and virtual host ($baseUrl/queues/matrix42) with your current values.

$username = "rabbitmq" 
$password = "Password" 
$baseUrl = "http://localhost:15672/api" 

# Get all queues 
$queues = (Invoke-RestMethod -Uri "$baseUrl/queues" -Credential (New-Object System.Management.Automation.PSCredential($username, (ConvertTo-SecureString $password -AsPlainText -Force)))) 

# Iterate through all queues 
foreach($queue in $queues)
{
    # Get all messages in the queue
    $messages = (Invoke-RestMethod -Method POST -Body '{"count":100000,"ackmode":"ack_requeue_true","encoding":"auto","truncate":5000000}' -Uri "$baseUrl/queues/matrix42/$($queue.name)/get" -Credential (New-Object System.Management.Automation.PSCredential($username, (ConvertTo-SecureString $password -AsPlainText -Force)))) 
    $messages | ConvertTo-Json -Depth 10 | Out-File -FilePath "$env:USERPROFILE\queue_$($queue.name)_messages.json" -Encoding utf8 
    Write-Host "Exported $count messages from queue $($queue.name)"
}

Stop RabbitMQ Server

• Run the following command to stop the RabbitMQ node and service on the host:

.\rabbitmqctl.bat shutdown

Upgrade Erlang

• Run the downloaded Erlang installer, e.g. otp_win64_26.2.5.2.exe
• Press Next (2x) and Install
• Wait until the installation is finished and press close
• Update the Environment Variable
  • Open Control Panel > System > Advanced system settings > Environment Variables
  • Locate the ERLANG_HOME variable and and check that it matches the current installation path (e.g. C:\Program Files\Erlang OTP)
  • In case you need to adjust the variable, press edit and proceed with Browse Directory

Upgrade RabbitMQ

Before starting with the RabbitMQ upgrade, close all explorer windows and command line prompts that access current RabbitMQ directory

• Run the downloaded RabbitMQ installer, e.g. rabbitmq-server-3.13.6.exe
• Press OK to confirm to remove the previous version
• Press Next and press Install
• Wait until the installation is finished and press Next
• Press Finish
• Update the Environment Variable
  • Open Control Panel > System > Advanced system settings > Environment Variables
  • Locate the RABBITMQ_BASE variable and and check that it matches the current installation path (e.g. C:\Program Files\RabbitMQ Server\rabbitmq_server-3.13.6)
  • In case you need to adjust the variable, press edit and  proceed with Browse Directory
• Reboot your server

Restore Config Files

• Open PowerShell as an Administrator
• Navigate to your updated RabbitMQ folder, e.g. C:\Program Files\RabbitMQ Server\rabbitmq_server-\3.13.6\sbin
• Now execute the following commands and take actions step by step:

.\rabbitmq-service stop

.\rabbitmq-service remove

• Now copy your config files back to the path(s) locations

.\rabbitmq-service install

.\rabbitmq-service start

• Enable Management UI

.\rabbitmq-plugins enable rabbitmq_management

Restore Definitions

• Import Definitions (attention: PowerShell syntax is used here)

.\rabbitmqctl import_definitions $env:USERPROFILE\rabbitmq.definitions.json

Restore Messages

Skip the import of messages as you like, they are considered disposable and if there is no load at the time of the update couple messages get lost, which is fine.

• Import Messages using the PowerShell script below:

$username = "vvalentine" 
$password = "Matrix42" 
$baseUrl = "http://localhost:15672/api" 

# Get all queues
$queues = (Invoke-RestMethod -Uri "$baseUrl/queues" -Credential (New-Object System.Management.Automation.PSCredential($username, (ConvertTo-SecureString $password -AsPlainText -Force))))

# Iterate through all queues
foreach($queue in $queues)
{
    $messages = Get-Content "$env:USERPROFILE\queue_$($queue.name)_messages.json" | ConvertFrom-Json
    foreach($message in $messages)
    {
        Invoke-RestMethod -Method Post -Uri "$baseUrl/exchanges/matrix42/$($message.exchange)/publish" -Body ($message | ConvertTo-Json -Depth 10) -Credential (New-Object System.Management.Automation.PSCredential($username, (ConvertTo-SecureString $password -AsPlainText -Force))) | Out-Null    
    }
}