Upgrade Abiquo

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

To upgrade from earlier versions, see Upgrade Abiquo from 4.7 to 5.2.x

Please contact Abiquo Support for further information.

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

The upgrade will overwrite lang_en_US.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

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

1. Prevent cloud users from performing VM operations

In the UI in the Infrastructure view, select each physical machine and click Disable
Using the API, set the state of each physical machine to DISABLED

2. Check for operations in progress on the platform

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

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

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.

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.

3. Back up the main platform elements

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

Before you begin, stop platform services, and check you have enough space on your destination systems.

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

4. Stop platform services

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

if there are operations in progress, DO NOT STOP the platform services because this can cause serious issues with your platform.
See Check for operations in progress on the platform and wait for all operations to complete

To stop platform services:

Stop the API on the API server or monolithic server
```
systemctl stop abiquo-tomcat
```
Stop the UI on the API server or monolithic server or dedicated UI server
```
systemctl stop httpd
```
Stop remote services server
```
systemctl stop abiquo-tomcat
```
V2V Server
You do not need to stop anything because the BPM remote service is run on-demand only

Stop monitoring server

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

On the monitoring server, check if Cassandra is really dead
```
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.
```
kill -9 12345
```

All processes on platform servers should now have halted.

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

6. Prepare yum repositories for 5.3

Unable to render {include} The included page could not be found.

7. Upgrade packages on ALL servers

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

Update Abiquo packages:

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

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
```
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)
```
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
```
EC2_HOME=/opt/aws
```

8. 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
```
Retry the above abiquo-db update command.

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
```
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

9. Upgrade additional elements

Start with your original version and perform the steps to the final version.

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

Click here to show/hide the steps to upgrade from 5.2.0 or higher to 5.3.0

Unable to render {include} The included page could not be found.

10. 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.
Reporting changes: To upgrade the Abiquo Reports Server for the upgrade to Abiquo 5.2.x, contact Abiquo Support for the file and procedure.

11. 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.
```
service httpd start
service abiquo-tomcat start
```
On the Remote services server, start the Tomcat server
```
service abiquo-tomcat start
```
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
On the Monitoring server, start the Cassandra service
```
sudo service cassandra start
```
WAIT about 5 minutes until the service is up and running
Start the KairosDB service
```
sudo service kairosdb start
```

Start the other services in this order

sudo service abiquo-emmett start
sudo service abiquo-delorean start

On the V2V server: restart the Tomcat server:
```
service abiquo-tomcat restart
```
In Abiquo, re-enable the physical machines!
Clear your browser cache to prevent glitches in the UI