Versions Compared

Key

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


Table of Contents
maxLevel2


Info

This section describes how to upgrade from Abiquo 5.2.0 or above to an Abiquo 5.4.x version. 

For your convenience, we have also prepared the following concise upgrade document that groups the commands by servers. However, we encourage you to use this Upgrade Abiquo document as your main reference, especially for the provider ID migration:

Please contact Abiquo Support for further information.

...

Minor version upgrade table

To version

From version

Upgrade type

Notes

5.4.1

5.4.0

Standard

See Standard Abiquo minor or patch version update

5.4.2

5.4.1

Standard

See Standard Abiquo minor or patch version update

5.4.3

5.4.2

Standard

See Standard Abiquo minor or patch version update


Warnings and notices

Warning

Abiquo YUM repositories are no longer open, please contact Abiquo Support to obtain your credentials

This upgrade process starts from Abiquo 5.2.0 or above. To upgrade from earlier versions, please see Upgrade Abiquo from 4.7 to 5.2.x

There is no upgrade path from NSX-V to NSX-T because VMware does not support this upgrade


Note
  • The upgrade will overwrite lang_en_US_labels.json. If you have customized labels or translations, back them up before the upgrade and restore them afterwards accordingly.

  • The upgrade will overwrite the SAML login configuration for multiple IdPs. If you use SAML with multiple IdPs, back up the configuration files before the upgrade and add the multiple IdPs afterwards accordingly. See Restore SAML security beans after upgrade


Warning

The upgrade to Abiquo 5.3 includes a migration to provider ID as the identifier of a deployed VM.

See Provider ID as VM identifier upgrade

Prepare the provider ID migration before your upgrade. See Create a test VM and run PIM planner on a database dump


Prevent cloud users from performing VM operations

  1. In the UI in the Infrastructure view, select each physical machine and click Disable

  2. Using the API, set the state of each physical machine to DISABLED


...


Check for operations in progress on the platform

Before you shut down the platform servers you should check that no operations are in progress.

Include Page
Check for operations in progress on the platform
Check for operations in progress on the platform


...

Back up the main platform elements

Include Page
Back up the main platform elements
Back up the main platform elements


...

Stop platform services

Include Page
Stop platform services for minor upgrade
Stop platform services for minor upgrade


...


Make snapshots and backups of all platform servers

...

Prepare yum repositories for 5.4

Include Page
Prepare yum repositories on all servers for v5.4.0
Prepare yum repositories on all servers for v5.4.0

Prepare yum repositories for 5.4.x

Include Page
Prepare yum repositories on all servers for minor upgrade
Prepare yum repositories on all servers for minor upgrade

...

Upgrade packages on ALL servers

These instructions are for monolithic, distributed, and HA environments.

...

  1. Check in your RS server(s) if there is an NFS shared folder for the NARS results (related to the system property abiquo.nars.async.fileresults.path):

    Code Block
    languagebash
    $ mount | grep -i "nfs\|results" | grep -v sunrpc
    10.60.37.87:/abq-pro-nfs on /opt/abiquo/results-nars type nfs4 (rw,nosuid,nodev,noexec,relatime,sync,vers=4.1,rsize=1048576,wsize=1048576,namlen=255,hard,proto=tcp,timeo=600,retrans=2,sec=sys,clientaddr=10.60.37.77,local_lock=none,addr=10.60.37.87,user)


  2. Unmount the previous shared folder if you have it mounted:

    Code Block
    languagebash
    sudo umount /opt/abiquo/results-nars


  3. Update Abiquo packages:

    Code Block
    yum clean all && yum makecache && yum update 'abiquo-*'


  4. Mount again the shared folder from the second step.

    Code Block
    languagebash
    sudo mount -a


  5. The Abiquo services must run as the tomcat user (not root), so set the required permissions and enforce the use of the package configuration files.
    If you have a MONOLITHIC SERVER do all of the following steps on the Monolithic server

    1. On Abiquo Server and Remote Services

      Code Block
      chown -R tomcat /opt/abiquo


    2. On the Remote Services with Appliance Manager and the V2V Server (i.e. servers that mount the NFS repository)

      Code Block
      chown -R tomcat /opt/vm_repository
      chmod -R a+r /opt/vm_repository


    3. On the V2V server, check the /etc/sysconfig/abiquo/ec2-api-tools file exists.
      The file must contain the following configuration. If the file does not exist, create it and add this configuration.

...

    1. For CentOS 7

      Code Block
      EC2_HOME=/opt/aws


Update the Abiquo databases

  1. Check that your hostname is in your DNS or in your /etc/hosts file

  2. Upgrade the Abiquo API databases

    Code Block
    abiquo-db [-h DB hostname] [-P DB port] [-u user] [-p password] update


  3. If the liquibase update fails with a message similar to the following: 

    Code Block
    Liquibase update Failed: Validation Failed:
    1 change sets check sum
    src/X.X.X-XX/kinton-X.X.X.xml::ABICLOUDPREMIUM-XXXX-XxxxxxxxXXxXxxxxxxXxxxxx::XXXXXXXXX is now: 7:ee2fa6e058ec76c7abf801567898917d
    For more information, use the --logLevel flag

    Do the following steps:

    1. Clear the database checksums

      Code Block
      abiquo-db clearCheckSums


    2. Retry the above abiquo-db update command.


  4. To upgrade the Abiquo Watchtower database, on the monitoring appliance, run the command below:

    Code Block
    watchtower-db [-h DB hostname] [-P DB port] [-u user] [-p password] update


  5. Reporting changes: To upgrade the Abiquo Reports Server for the upgrade to Abiquo 5.3.x, contact Abiquo Support for more information.

    • The Abiquo Reports Server now runs with JasperReports v7.8.0


Perform the provider ID migration in an upgrade through 5.3 only

For an upgrade that passes through Abiquo 5.3, perform the provider ID migration using the PIM tools.

(warning) (warning) Please note that the PIM migration tools use Java version 11.

Run the PIM planner

Include Page
Run the PIM planner
Run the PIM planner

...


Run the PIM migrator

Include Page
Run the PIM migrator
Run the PIM migrator

...


Upgrade additional elements

By default, you will find the upgrade scripts (e.g. for Redis definitions) on the Abiquo Server under the folder: /usr/share/doc/abiquo-redis/redis/

For each upgrade step, run the Redis database script to remove old VSM definitions, which can be found in the 4.2.3 subfolder

...

Expand
titleClick here to show/hide the steps to upgrade from 5.2.0 or higher to 5.3.x
Include Page
Upgrade steps for 5.3.0
Upgrade steps for 5.3.0


Expand
titleClick here to show/hide the steps to upgrade from 5.3.0 or higher to 5.4.x
Include Page
Upgrade steps for 5.4.0
Upgrade steps for 5.4.0


Expand
titleClick here to show/hide the steps to upgrade from 5.4.0 or higher to 5.4.x
Include Page
Standard Redis database upgrade step
Standard Redis database upgrade step


Configure Abiquo after the upgrade

  1. Before you start the Abiquo tomcat server, add Abiquo configuration properties to the abiquo.properties file.
    By default the abiquo.properties file is found in the /opt/abiquo/config/ folder.
    See Changes to Abiquo configuration properties

  2. Configure the user interface. The default UI location is /var/www/html/ui.
    Optional: Add custom labels and translations in the lang_xx_XX_custom.json files in the lang folder
    Add custom configuration to client-config-custom.json. See Configure Abiquo UI
    If your API is not in the same domain as the UI, set the API endpoint pointing to your Abiquo API server:

    Code Block
    {
        "config.endpoint": "http://myAPIserver/api"
    }


  3. SAML: If you are using SAML with multiple IDPs, restore the configuration as described at Restore SAML security beans after upgrade.

  4. Reporting changes: To upgrade the Abiquo Reports Server for the upgrade to Abiquo 5.3.x, contact Abiquo Support.

Start Abiquo server and services

Include Page
Start Abiquo servers and services
Start Abiquo servers and services