Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updating numbered headings
Table of Contents

1.1. Introduction

This section describes how to upgrade from Abiquo 5.4.x or Abiquo 6.0.x to an Abiquo 6.1.x version. 

...


1.2. Warnings and notices

  • Before you begin, contact Abiquo Platform and Customer Success department to obtain your credentials because Abiquo YUM repositories require a login.

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

  • 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.

...

Note

Changes to enterprise properties for AWS billing

  • Before you upgrade to Abiquo 6.0.0, add the amazon_bucket_region as an enterprise property. The value is the code for the AWS region where your billing bucket is located (for example, us-east-1). This property applies to AWS resellers and standard accounts with billing dashboard configurations



1.3. 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


...


1.4. Check for operations in progress on the platform

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

...

When user VM operations are blocked and all of the above checks show that no tasks are running, it is safe to halt the platform.

...

1.5. Back up the main platform elements

To perform a basic backup of the platform, run the following backups:

...

Code Block
languagebash
# On DB server, back up the Abiquo MySQL DBs
mysqldump --routines --triggers kinton            > kinton.sql-$(date +%Y%m%d_%H%M%S)
mysqldump --routines --triggers kinton_accounting > kinton_accounting.sql-$(date +%Y%m%d_%H%M%S)

# On the Monitoring server, back up Watchtower DB
mysqldump --routines --triggers watchtower            > watchtower.sql-$(date +%Y%m%d_%H%M%S)

# On the Abiquo API Server or UI server, back up the UI
tar cvfz /var/www/html/ui.tgz-$(date +%Y%m%d_%H%M%S) /var/www/html/ui

# If you are using SAML authentication with multiple IdPs, on ALL Abiquo API Servers, back up this file
cp 
/opt/abiquo/tomcat/webapps/api/WEB-INF/classes/springresources/security/saml/security-saml-generated-beans.xml /opt/abiquo/tomcat/webapps/api/WEB-INF/classes/springresources/security/saml/security-saml-generated-beans.xml-$(date
 +%Y%m%d_%H%M%S)

# On ALL servers, back up the /opt/abiquo folder
tar cvfz /opt/abiquo.tgz-$(date +%Y%m%d_%H%M%S) /opt/abiquo

# On Abiquo Monolithic or API Server, Remote Services, or Datanode, back up Redis
redis-cli save
cp -a /var/lib/redis /var/lib/redis-$(date +%Y%m%d_%H%M%S)


...

1.6. Stop platform services

This section describes how to stop platform services on all servers.

...

All processes on platform servers should now be halted.

...

1.7. Make snapshots and backups of all platform servers

This is a major upgrade, so we recommend that you make a snapshot and/or a backup of your platform servers.

...

1.8. Prepare yum repositories for 6.0 or 6.0.x or 6.1 or 6.1.x

Check that you have the repository URL and credentials

...

  1. Check that you have the repository URL and credentials

  2. To upgrade to the latest version with a patch number that is not zero, for example, version 6.0.x or version 6.1.x, enable both repositories:

    Code Block
    yum-config-manager --enable abiquo-base
    yum-config-manager --enable abiquo-updates
  3. Optionally add your username and password to the Abiquo repos

    Code Block
    yum-config-manager --save --setopt=abiquo-*.username=MYUSERNAME
    yum-config-manager --save --setopt=abiquo-*.password=MYPASSWORD

    Don't forget to use a backslash to escape any shell special characters. For more details, see https://www.oreilly.com/library/view/learning-the-bash/1565923472/ch01s09.html

  4. Clean yum and make cache

    Code Block
    yum clean all && yum makecache
  5. If you did not make snapshots of all servers already, then you could do this now.

...

1.9. 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 Abiquo configuration 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 the shared folder from the second step again.

    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.

      For CentOS 7

      Code Block
      EC2_HOME=/opt/aws

1.10. 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: The Abiquo reports server now runs with JasperReports v7.8.0

...


1.11. 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/

...

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

If you are using the Abiquo billing integration, to avoid issues with duplicate billing data, deactivate on-premise billing until after you bill for the previous month.

To deactivate on-premise billing:

  1. Log in to the Abiquo database server as administrator

  2. In MySQL, as an administrator, run the following command

    update kinton.system_properties set value = 0 where name = "client.billing.onpremise.enabled";

When you are ready to activate on-premise billing, you can do this in the Abiquo UI, in Configuration view on the Billing tab. See Configure on premise billing


1.12. 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 and Changes to UI configuration
    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.

1.13. Start Abiquo server and services


To start the Abiquo platform servers and services, do these steps:

...