Upgrading Harmony Controller deployed on Custom Resources

When Harmony Controller was deployed initially on custom resources, it may have been deployed in one of the following two ways:

  • On Single Node

  • On Three Nodes

Steps for upgrading them are little different and are described in different sections.

Upgrading 5.1.0-Px Harmony Controller Deployed on Single Node

Many components have changed from HC-5.1.0 to HC-5.3.0-P1. Hence, upgrade may take about 1 hour to complete for single node controller installation on a physical or virtual machine.

It is recommended to read the steps completely and plan accordingly. Entire procedure is divided into multiple phases.

Planning Phase

  • Check the Controller version

    You need to have an existing installation of HC-5.1.0 for using these instructions.

    Check the Harmony Controller version in Harmony Portal at Help Center > About Harmony Controller > Version.

  • Check Thunder software version

    It is recommended to upgrade controller only when the new version is compatible with the ACOS version Thunders are running. For compatibility information, refer to Compatibility with Thunder ACOS Versions section.

  • Root privilege on the node

    You must have root privilege to run the upgrade script.

Download Upgrade Bundle

Upgrade script bundle needs to be downloaded from the sharefile location provided in the email from A10. The sharefile location contains Release Notes and Getting Started guide for the requested version of software. Read them carefully as the information (options, requirements, compatibility etc.) specified in Getting Started guide take precedence over the information provided in this documentation.

Required Docker images and other packages also need to be downloaded and placed in the Node before running the upgrade script. To avoid running out of space during upgrade, the downloaded files should be kept in the same storage volume where the upgrade is planned. Download location is available in Getting Started Guide that is at the same place where the installer package is.

For example, all three downloaded files can be placed in /root/a10hc-5.3.0-P1 directory on the Linux machine running Harmony Controller.

Before You Begin

  • Make sure all tasks in Planning Phase are complete and Download Upgrade Bundle is done.

  • Keep following information ready:

    • Password for super-admin

      Any password can be kept as per the password policy displayed.

    • Tar File Path

      Path of the directory where Docker images and other package are kept on the NodeZero.

Upgrade Procedure

On a working Harmony Controller HC-5.1.0 deployment, follow the below steps:

  1. Log in (SSH) to the Linux machine as admin where Harmony Controller is installed:

    $ sudo ssh root@<controller IP address>
    
  2. Go to the directory where downloaded files are placed:

    $ cd /home/a10hc-5.3.0-P1
    
  3. Untar the file using:

    $ tar -xvzf HC-5.3.0-P1-install-GA.tar.gz
    
  4. Go to a10-harmony-controller-HC-5.3.0/upgrade_package directory:

    $ cd a10-harmony-controller-HC-5.3.0-P1/upgrade_package/
    
  5. Run the upgrade script:

    $ sudo ./UpgradeHC.sh
    

The script is interactive and will prompt for information. Follow the on-screen instructions and provide the values.

Note: After upgrade script completes, Harmony Controller services will be available. However, old analytics data will be migrated to new format in the background. This will take long time (a few hours) based on the amount of configuration data.

During the data migration, Harmony portal will display the newly collected data accurately, but old data may not represent the correct state at that point in time because all the data is still not available for display.

Warning

Do not restart or reboot the Harmony Controller when migration is still in progress.

Next Steps

  • If not already done, configure SSL certificates for FQDN using A10 Harmony Controller Operator Console in the Certificate section under Configuration Management.

  • Map FQDN to Node IP address in the DNS manager.

  • Complete Email Server Configuration using A10 Harmony Controller Operator Console in the Email section under Configuration Management.

  • Setup scripts for transferring scheduled backup files to external storage as described in maintenance information.

  • Manually reset the provider-admin password using Adding a Provider, once the upgrade is complete.

  • Back up all the registered devices.


Upgrading Harmony Controller deployed on Three Nodes

Many components have changed from HC-5.1.0 to HC-5.3.0-P1. Hence, upgrade may take about 3 hours to complete for three node controller installation on a physical or virtual machine.

It is recommended to read the steps completely and plan accordingly. Entire procedure is divided into multiple phases.

Planning Phase

  • Check the Controller version

    You need to have an existing installation of HC-5.1.0 for using these instructions.

    Check the Harmony Controller version in Harmony Portal at Help Center > About Harmony Controller > Version.

  • Check Thunder software version

    It is recommended to upgrade controller only when the new version is compatible with the ACOS version Thunders are running. For compatibility information, refer to Compatibility with Thunder ACOS Versions section.

  • Root privilege on the node

    You must have root privilege to run the upgrade script.

  • Arrange additional storage

    Additional storage space is required as per hardware and storage-setup sections.

Download Upgrade Bundle

Upgrade script bundle needs to be downloaded from the sharefile location provided in the email from A10. The sharefile location contains Release Notes and Getting Started guide for the requested version of software. Read them carefully as the information (options, requirements, compatibility etc.) specified in Getting Started guide take precedence over the information provided in this documentation.

Required Docker images and other packages also need to be downloaded and placed in the NodeZero before running the upgrade script. To avoid running out of space during upgrade, the downloaded files should be kept in the same storage volume where the upgrade is planned. Download location is available in Getting Started Guide that is at the same place where the installer package is.

For example, all three downloaded files can be placed in /root/a10hc-5.3.0-P1 directory on the Linux machine running Harmony Controller.

Before You Begin

  • Make sure all Planning Phase and Download Upgrade Bundle points are met.

  • Keep following information ready:

    1. Tar File Path

      Path of the directory where Docker images and other package are kept on the NodeZero. This is asked only when files are not found in the parent directory of the installer.

    2. Password for super-admin

      Any password can be kept as per the password policy displayed.

    3. Unmounted partition or disks for NodeZero

      This storage partition is referred as Storage 3 in storage-setup section. This partition is required for HA and is to be kept unmounted while installing OS.

    4. Unmounted partition or disks for NodeOne

      This storage partition is referred as Storage 3 in storage-setup section. This partition is required for HA and is to be kept unmounted while installing OS. Unmounted partition or disks where A10 HarmonyTM Controller should be installed is to be provided for NodeOne.

    5. Unmounted partition or disks for NodeTwo

      This storage partition is referred as Storage 3 in storage-setup section. This partition is required for HA and is to be kept unmounted while installing OS. Unmounted partition or disks where A10 HarmonyTM Controller should be installed is to be provided for NodeTwo.

Upgrade Procedure

On a working Harmony Controller HC-5.1.0 deployment, follow the below steps:

  1. Log in (SSH) to the Linux machine as admin where Harmony Controller is installed:

    $ sudo ssh root@<controller IP address>
    
  2. Go to the directory where downloaded files are placed:

    $ cd /home/a10hc-5.3.0-P1
    
  3. Untar the file using:

    $ tar -xvzf HC-5.3.0-P1-install-GA.tar.gz
    
  4. Go to a10-harmony-controller-HC-5.3.0/upgrade_package directory:

    $ cd a10-harmony-controller-HC-5.3.0-P1/upgrade_package/
    
  5. Run the upgrade script:

    $ sudo ./UpgradeHC.sh
    

The script is interactive and will prompt for information. Follow the on-screen instructions and provide the values.

Note: After upgrade script completes, Harmony Controller services will be available. However, old analytics data will be migrated to new format in the background. This will take long time (a few hours) based on the amount of configuration data.

During the data migration, Harmony portal will display the newly collected data accurately, but old data may not represent the correct state at that point in time because all the data is still not available for display.

Warning

Do not restart or reboot the Harmony Controller when migration is still in progress.

Next Steps

  • If not already done, configure SSL certificates for FQDN using A10 Harmony Controller Operator Console in the Certificate section under Configuration Management.

  • Map FQDN to Node IP address in the DNS manager.

  • Complete Email Server Configuration using A10 Harmony Controller Operator Console in the Email section under Configuration Management.

  • Setup scripts for transferring scheduled backup files to external storage as described in maintenance information.

  • Manually reset the provider-admin password using Adding a Provider, once the upgrade is complete.

  • Back-up all the registered devices.