Page Comparison

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

• To upgrade from earlier versions, first see 

  • Upgrade Abiquo from 4.7 to 5.2.x

  • Upgrade Abiquo from 5.2 to 5.4.x

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

• Upgrade Abiquo 5.4 to 6.0.x distributed by servers

  •  This document is also valid to upgrade from Abiquo 5.4.x or Abiquo 6.0.x to an Abiquo 6.1.x version

Please contact Abiquo Support for further information.

...

Major version upgrade table

Minor version upgrade table

Warnings and notices

Table of contents

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 PageCheck for operations Before you shut down the platform servers you should check that no operations are in progress on the platform.

1. Check

...

Back up the main platform elements

...

Stop platform services

...

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.

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

...

Prepare yum repositories for 6.0.x or 6.1.x

...

Upgrade packages on ALL servers

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

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):

$ 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)

Unmount the previous shared folder if you have it mounted:

sudo umount /opt/abiquo/results-nars

Update Abiquo packages:

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

Mount again the shared folder from the second step.

sudo mount -a

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

On Abiquo server and remote services

chown -R tomcat /opt/abiquo

On the remote services with appliance manager and the V2V server (i.e. servers that mount the NFS repository)

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

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.

EC2_HOME=/opt/aws

Update the Abiquo databases

...

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

Upgrade the Abiquo API databases

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

If the Liquibase update fails with a message similar to the following: 

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

Clear the database checksums

abiquo-db clearCheckSums

...

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

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

...

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

On remote services server:

# cd /usr/share/doc/abiquo-redis/redis/
# bash ./4.2.3/00-old-vsm-definitions.sh

 If you have custom billing queries, please update them now.

...

...

...

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

Configure Abiquo after the upgrade

...

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

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:

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

...

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

...

Start Abiquo server and services

...

1. that the Abiquo RabbitMQ queues are empty on the Abiquo Monolithic Server, Abiquo Server or Datanode server

   The number of messages in all queues must be 0.

   Code Block
   # rabbitmqctl list_queues messages name

   Code Block

   # rabbitmqctl list_queues messages name Listing queues ... 0 abiquo.am.notifications 0 abiquo.bpm.notifications 0 abiquo.datacenter.requests.ADatacenter.bpm 0 abiquo.datacenter.requests.ADatacenter.virtualfactory 0 abiquo.ha.tasks 0 abiquo.nodecollector.notifications 0 abiquo.pcrsync.messages 0 abiquo.pcrsync.parking-expect-no-consumers 0 abiquo.scheduler.fast.requests 0 abiquo.scheduler.requests 0 abiquo.scheduler.slow.requests 0 abiquo.tracer.traces 0 abiquo.virtualfactory.notifications 0 abiquo.virtualmachines.definitionsyncs 0 abiquo.vsm.eventsynk ...done.

2. On the V2V Server, check for any active conversions by checking for the V2V or Mechadora processes

   Code Block
   $ ps aux | grep v2v $ ps aux | grep mechadora

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.

...

Back up the main platform elements

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

# 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)

...

Stop platform services

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

To stop platform services:

1. Stop the API on the API server or monolithic server

   Code Block
   systemctl stop abiquo-tomcat

2. Stop the UI on the API server or monolithic server or dedicated UI server

   Code Block
   systemctl stop httpd

3. Stop remote services server

   Code Block
   systemctl stop abiquo-tomcat

4. V2V Server
   You do not need to stop anything because the BPM remote service is run on-demand only
   

5. Stop monitoring server

   Code Block
   systemctl stop abiquo-delorean systemctl stop abiquo-emmett systemctl stop kairosdb systemctl stop cassandra

6. On the monitoring server, check if Cassandra is really dead

   Code Block
   ps auwx | grep cassandra

   Get the process number for Cassandra (the first number in the output of the previous command), and kill it. In this example, Cassandra is process 12345.

   Code Block
   kill -9 12345

All processes on platform servers should now be halted.

...

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.

...

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

On all Abiquo Servers, such as Abiquo API, Remote Services, Watchtower monitoring.

Prepare yum repositories for 6.0.0 or 6.1.0

1. To upgrade to a version with a patch number of zero, for example, version 6.0.0 or version 6.1.0

   1. Remove the previous version Abiquo release packages.

      Code Block
      yum remove 'abiquo-release-*'

   2. Find the abiquo-release-ee package for your version in the list of available versions

   3. Install the release package.
      For Abiquo 6.1.0, the command would be similar to the following:

      Code Block
      yum localinstall http://user:passwd@mirror.abiquo.com/el7/6.1/os/x86_64/abiquo-release-ee-6.1.0-20230112_211400.el7.noarch.rpm

      For Abiquo 6.1.1, the release package would be:

      Code Block
      http://use:passwd@mirror.abiquo.com/el7/6.1/updates/x86_64/abiquo-release-ee-6.1.1-20230511_170351.el7.noarch.rpm

   4. For major versions, disable the updates repo. See https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/sec-managing_yum_repositories

Prepare yum repositories for 6.0.x or 6.1.x

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.

...

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
   language bash
   $ 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
   language bash
   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
   language bash
   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

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

...

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

On remote services server:

# cd /usr/share/doc/abiquo-redis/redis/
# bash ./4.2.3/00-old-vsm-definitions.sh

 If you have custom billing queries, please update them now.

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.

Start Abiquo server and services

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

• On the Abiquo server, restart the HTTP daemon to refresh the user interface files, and bring up the Tomcat server.

  Code Block
  service httpd start service abiquo-tomcat start

• On the Remote services server, start the Tomcat server

  Code Block
  service abiquo-tomcat start

• On the Monitoring server: edit the file /opt/kairosdb/conf/kairosdb.properties to update the name of this variable and to remove the port from it:

  • Replace the line kairosdb.datastore.cassandra.host_list=192.168.888.999:9160.

  • With this line: kairosdb.datastore.cassandra.cql_host_list=192.168.888.999. Please note the new cql_ prefix for this property.

• On the Monitoring server: edit the file /etc/cassandra/conf/cassandra.yml OR /etc/cassandra/default.conf/cassandra.yaml (whichever exists) to remove a variable:

  • Remove the line starting with kairosdb.datastore.cassandra.datapoint_ttl and save and close the file.

• On the Monitoring server: edit the file /opt/kairosdb/conf/kairosdb.properties to add a new variable (ref: Internal JIRA SUP-333):

  • kairosdb.datastore.cassandra.datapoint_ttl = 15768000

• On the Monitoring server: start the Cassandra service

  Code Block
  sudo service cassandra start

• WAIT about 5 minutes until the service is up and running

• Start the KairosDB service

  Code Block
  sudo service kairosdb start

• Start the other services in this order

  Code Block
  sudo service abiquo-emmett start sudo service abiquo-delorean start

• On the V2V server: restart the Tomcat server:

  Code Block
  service abiquo-tomcat restart

Finally, in Abiquo, re-enable the physical machines!

After the upgrade, to prevent glitches in the UI, clear your browser cache