Versions Compared

Old Version 11

changes.mady.by.user Gill Houghton

Saved on

compared with

New Version Current

changes.mady.by.user Gill Houghton

Saved on

Key

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


Warning

During this upgrade process your MQTT broker will be offline.

If you are performing license deactivation/reactivation online, then typical update time is less than 10 minutes.

If you are performing license deactivation/activation offline, you will need to send the deactivation/activation requests to support@cirrus-link.com in order to receive the Activation Code required to complete the upgrade. Cirrus Link support hours are 8am - 5pm PST. To minimize downtime during your upgrade, we recommend letting Cirrus Link know ahead of time so we ensure support availability during your upgrade period. 


Note
The following upgrade instructions for each of the supported platforms Linux and Windows requires the user has superuser/admin privileges and can execute any scripts at the command line in the directories where these servers are installed

...

Warning
During this upgrade process your MQTT broker will be offline. Typical update time is less than 10 minutes.

Linux - Upgrading Chariot MQTT Server

  1. Following the Licensing Procedure, deactivate your existing license on the

    v2.1.0

    Chariot MQTT Server.

    Tip
    If deactivating offline, make sure to send the generated Deactivation Request text to support@cirrus-link.com


  2. Backup your Chariot configuration using the Backup/Restore feature. To do this navigate to System in the left menu bar of the Chariot MQTT UI, select Backup/Restore and Export Backup

  3. If configured for SSL, copy ssl.jks keystore from <OLD_chariot_install_folder>/security directory
     
  4. Save the backup.tgz file created from Step 2 and the ssl.jks keystore from Step 3 in a safe, known location as you will need to restore it after the upgrade.

  5. Stop the v2.1.0 Chariot service. From a command prompt, run the Chariot service stop script in the v2.1.0 installed directory

    Code Block
    # Use this command for Chariot versions prior to 2.4.1
sudo /etc/init.d/chariot stop

# Use this command for Chariot v2.4.2 and later
sudo systemctl stop chariot


  6. Install the new version of Chariot Install v2.2.* following the Chariot MQTT Server Installation instructions in a new Chariot directory. 

    Warning
    Do not overwrite the old version of Chariot when extracting the Chariot ZIP package, but instead create a new Chariot directory and extract the new Chariot package into that new directory. For example:
    • Old version of Chariot is installed in /opt/chariotv2.1.0*
    • New version of Chariot should be installed in /opt/chariotv2.2.1.*.*


  7. If configuring SSL, copy ssl.jks keystore from Step 3 to <NEW_chariot_install_folder>/security

    Warning

    If you fail to do the copy BEFORE you start Chariot for the first time, the certs will not get picked up dynamically.


  8. Start the new version of Start the v2.2.* Chariot service. From a command prompt, run the Chariot service start script in the v2.2*.* directory.

    Code Block
    # Use this command for Chariot versions prior to 2.4.1
sudo /etc/init.d/chariot start

# Use this command for Chariot v2.4.2 and later
sudo systemctl start chariot


  9. Clear your web browser cache after upgrading Chariot to pick up the latest Chariot UI features and updates.

  10. Verify the Chariot Version. Navigate to the server URL accessing the Chariot portal on port 8080 and viewing the Version under the Chariot Systems Status. For example: http://localhost:8080/ or http://18.206.192.214:8080/

  11. Restore your Chariot configuration using the Backup/Restore feature. To do this navigate to System in the left menu bar of the Chariot MQTT UI, select Backup/Restore and Restore from Backup. When prompted, navigate to the backup.tgz file created earlier and import.

  12. Confirm that any configuration items have been imported correctly.
    If configured for SSL, reload any SSL certificates.

  13. Following the Licensing Procedure, activate your existing license on the v2.2.* new Chariot MQTT Server to complete the upgrade. 

    Tip
    If activating offline, make sure to send the generated Activation Request to support@cirrus-link.com. They will return the Activation Code required to complete the upgrade.



Windows - Upgrading Chariot MQTT Server

  1. Following the Licensing Procedure, deactivate your existing license on the

    v2.1.0

    Chariot MQTT Server.

    Tip
    If deactivating offline, make sure to send the generated Deactivation Request text to support@cirrus-link.com


  2. Backup your Chariot configuration using the Backup/Restore feature. To do this navigate to System in the left menu bar of the Chariot MQTT UI, select Backup/Restore and Export Backup.

  3. If configured for SSL, copy ssl.jks keystore from <OLD_chariot_install_folder>\security directory

  4. Save the backup.zip file downloaded created from Step 2 and the ssl.jks keystore from Step 3 in a safe, known location as you will need to restore it after the upgrade.

  5. Stop the v2.1.0 Chariot service. From a command prompt, run the Chariot service stop script in the v2.1.0 installed directory.

    Code Block
    serviceStop.bat


  6. Install v2.2.* the new version of Chariot following the Chariot MQTT Server Installation instructions in a new Chariot directory. 

    Warning
    Do not overwrite the old version of Chariot when extracting the Chariot ZIP package, but instead create a new Chariot directory and extract the new Chariot package into that new directory. For example:
    • Old version of Chariot is installed in C:\Program Files\Chariotv2.1.0*
    • New version of Chariot should be installed in C:\Program Files\Chariotv2.2.1.*.*


  7. If configuring SSL, copy ssl.jks keystore from Step 3 to <NEW_chariot_install_folder>\security

    Warning

    If you fail to do the copy BEFORE you start Chariot for the first time, the certs will not get picked up dynamically.


  8. Start the new version of Start the v2.2.* Chariot service. From a command prompt, run the Chariot service start script in the v2.2*.* directory.

    Code Block
    serviceStart.bat


  9. Clear your web browser cache after upgrading Chariot to pick up the latest Chariot UI features and updates.

  10. Verify the Chariot Version. Navigate to the server URL accessing the Chariot portal on port 8080 and viewing the Version under the Chariot Systems Status. For example: http://localhost:8080/ or http://18.206.192.214:8080/

  11. Restore your Chariot configuration using the Backup/Restore feature. To do this navigate to System in the left menu bar of the Chariot MQTT UI, select Backup/Restore and Restore from Backup. When prompted, navigate to the backup.zip file created earlier and import.

  12. Confirm that any configuration items have been imported correctly.

  13. If configured for SSL, reload any SSL certificates.

  14. Following the Licensing Procedure, activate your existing license on the

    v2.2.*

    new Chariot MQTT Server to complete the upgrade. 

    Tip
    If activating offline, make sure to send the generated Activation Request to support@cirrus-link.com. They will return the Activation Code required to complete the upgrade.