Upgrade Abiquo from 5.2 to 5.4.x

Minor version upgrade table

Warnings and notices

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 on the platform.

1. Check 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.

   # rabbitmqctl list_queues messages name

    

   # 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

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

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

    

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

    

3. Stop remote services server

    

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

5. Stop monitoring server

    

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

   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.

All processes on platform servers should now have 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 5.4

Check that you have the repository URL and credentials

1. To upgrade to a version with a patch number of zero, for example, version 5.4.0

   1. Remove the previous version Abiquo release packages.

   2. Locate the corresponding abiquo-release-ee package in the list of available versions

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

       

   4. Disable the updates repo. See 8.4.5. Adding, Enabling, and Disabling a Yum Repository | Red Hat Product Documentation

    

Prepare yum repositories for 5.4.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:

3. Optionally add your username and password to the Abiquo repos

   Don't forget to use a backslash to escape any shell special characters. For more details, see Learning the bash Shell, Second Edition

4. Clean yum and make cache

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 system property abiquo.nars.async.fileresults.path):

   
   
   

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

   
   
   

3. Update Abiquo packages:

   
   
   

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

   
   
   

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

      
      
      

   2. On the Remote Services with Appliance Manager and the V2V Server (i.e. servers that mount the NFS 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

      
      
      

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

   
   
   

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

   Do the following steps:

   1. Clear the database checksums

      
      
      

   2. Retry the above abiquo-db update command.

   
   
   

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

   
   
   

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.

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

Run the PIM planner

The PIM planner connects to the Abiquo kinton database and extracts the data for the PIM migrator tool.

• The PIM planner will process each deployed VM to:

  • Compute the provider ID

  • Define the rename of any backup jobs or groups

  • Define the rename of any firewalls and load balancers

The PIM planner doesn't make any changes to the platform but you must run it after you upgrade the database to Abiquo 5.3.

What is the output of the PIM planner?

• A log in standard output (you should redirect it to a file)

• A migration plan in ZIP format called migration-plan.data

PIM planner requirements

The PIM planner requires access to the MariaDB kinton schema via the JDBC URL. 

• It encrypts the database credentials for runtime use only; it does not save or export credentials

Before you run the PIM planner

1. Start the Abiquo upgrade to 5.3 as usual including

   1. Stop the Abiquo platform

   2. Create backups including VM snapshots, Database dump, and Redis dump

2. Upgrade the database

3. STOP the upgrade

Run the PIM planner

To run the PIM planner do these steps.

1. Run the Abiquo upgrade to 5.3 and stop after the database upgrade

2. On the Abiquo API Server, install the Abiquo PIM tools package

   By default, it should install in the /opt/abiquo/pim-tools folder

3. Run the PIM planner against your database.

   We strongly reccommend that you redirect the log in the standard output of the PIM planner to a file.

   For example:

    

4. Check the output file from the PIM planner
    If there are any warnings or errors, resolve them before you continue. 
   If you have any doubts, please contact Abiquo Support.

5. For ALL Remote Services servers

   1. Copy the migration-plan.data file to each Remote Services server

   Next, follow the instructions to run the PIM migrator on each Remote Services server

PIM planner options

Run the PIM migrator

The PIM migrator performs the provider ID migration in the compute, backup, and networking providers via the Remote Services servers.

• It updates the VMs, backups, firewalls, and load balancers in the providers and in Redis

• It also tests the migration in dry run mode

What does it output?

• An SQL file to run on the kinton database

• A log in standard output (you should redirect it to a file)

PIM migrator requirements

The PIM migrator requires the following.

• The migration plan from the PIM planner

• Access to:

  • the Redis instance of the Remote Service server.

  • the hypervisors in the datacenter

Before you run the PIM migrator

Do these steps.

1. Start the Abiquo upgrade to 5.3 as usual including

   1. Stop the Abiquo platform

   2. Create backups including snapshots, Database dump, and Redis dump

2. Upgrade the database

3. STOP the upgrade

4. Run the PIM planner and obtain the migration plan

Run the PIM migrator

Do these steps to run the PIM migrator.

Log in to ALL remote services servers and do these steps on EACH server. 

1. Install the PIM tools

   The default install folder is /opt/abiquo/pim-tools

2. Obtain the datacenter-id of the Remote Services server from the value of the abiquo.datacenter.id property in the abiquo.properties file.

   In this case, the value of the datacenter-id parameter will be "abq_dc1"

3. Run the PIM migrator in dry run mode, which is the default mode that doesn't make any changes.

   The "-noseed" parameter is required. The default value is false, which means the migrator will use the platform's default seed file. You can specify a seed file with the "-seed" parameter. 

   We recommend that you save the log in standard output to a file. And we recommend that you give the output files names that will identify the Remote Services server.

   For example 

    

4. Check the output file. If there are any errors or warnings, resolve them.
   If necessary, contact Abiquo Support.

5. Run the PIM migrator in update mode, by setting the "no dry run" option to true.

    

6. Copy the SQL file from the remote services server to the Abiquo database server.

   For example

    

After you run the migrator on ALL Remote Services servers, run the SQL upgrades on the database server as described in the next step. 

Update the Abiquo database server

1. Update the Abiquo database with all of the update.sql files. For example

    

Now continue with the Abiquo upgrade

PIM migrator options

PIM migrator notes

The migrator does not process the following providers.

• Hyper-V

• Networker

• Google Cloud Platform (see note below)

• Firewalls and load balancers that are not in NSX

For Google Cloud Platform, if you have VMs deployed before the upgrade, after you apply the PIM tools, do these steps:

1. Delete the VMs from the platform only 

   • in the API, delete them with the "logicaldelete" parameter set to true. See Delete a VM API doc 

2. Delete the virtual datacenters

3. Onboard the resources again

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:

 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
   If your API is not in the same domain as the UI, set the API endpoint pointing to your Abiquo API server:

   
   
   

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

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

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

2. On the Remote services server, start the Tomcat server

3. On the Monitoring server do these steps.

   1. Edit the file /opt/kairosdb/conf/kairosdb.properties to update the name of the following variable and to remove the port from it:

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

      2. With this line kairosdb.datastore.cassandra.cql_host_list=192.168.888.999. Please note the new cql_ prefix for host_list.

   2. Edit the file /etc/cassandra/conf/cassandra.yml OR /etc/cassandra/default.conf/cassandra.yaml (whichever exists) to remove a variable:

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

   3. Edit the file /opt/kairosdb/conf/kairosdb.properties to add a new variable (ref: Internal JIRA SUP-333):

      1. Add kairosdb.datastore.cassandra.datapoint_ttl = 15768000

4. On the Monitoring server, start the Cassandra service

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

6. Start the KairosDB service

7. Start the other services in this order

8. On the V2V server: restart the Tomcat server:

    

9. In Abiquo, re-enable the physical machines!

10. Clear your browser cache to prevent glitches in the UI