Versions Compared

Key

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

...

(warning) 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

...

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:

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

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

...

titleClick here to show/hide the steps to upgrade from 5.2.0 or higher to 5.3.x

...

titleClick here to show/hide the steps to upgrade from 5.3.0 or higher to 5.4.x

...

titleClick here to show/hide the steps to upgrade from 5.4.0 or higher to 5.4.x

...

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:

Code Block
{
    "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.3.x, contact Abiquo Support.

Start Abiquo server and services

...

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

    Code Block
    yum install abiquo-pim-tools

    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:

    Code Block
    java -jar /opt/abiquo/pim-tools/pimplanner.jar --jdbc-url="jdbc:mysql://my.database.server:3306/kinton?autoReconnect=true&user=root&password=root" | tee output_pimplanner.log

  4. Check the output file from the PIM planner
    (warning) 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

Option

Alias

Required

Description

jdbcurl

--jdbc-url

yes

Kinton JDBC URL including user and password

-output

--output-file

no

The output file. The default is 'migration-plan.data'

...


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.

Warning

Before you run the PIM migrator on your production servers:

  1. you must run it in your lab environment

  2. you must run it in dry run mode with the migration plan from the PIM planner that you ran on a dump of your production database

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

  1. Install the PIM tools

    Code Block
    yum install abiquo-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.

    Code Block
    abiquo.datacenter.id=abq_dc1

    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 

    Code Block
    java -jar /opt/abiquo/pim-tools/pimmigrator.jar -dc=abq_dc1 -redishost=localhost -plan=migration-plan.data -noseed -output=update_DC1.sql | tee pimmigrator_dry_run_DC1.log

  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.

    Code Block
    java -jar /opt/abiquo/pim-tools/pimmigrator.jar -nodry -dc=abq_dc1 -redishost=localhost -plan=migration-plan.data -noseed -output=update_DC1.sql | tee pimmigrator_DC1.log

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

    For example

    Code Block
    scp update_DC1.sql root@my.database.server:~/

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

    Code Block
    mysql kinton < update_DC1.sql
    mysql kinton < update_DC2.sql
    ...

Now continue with the Abiquo upgrade

PIM migrator options

Option

Alias

Required

Description

-dc

--datacenter-id

yes

ID of the current datacenter to migrate

-nodry

--no-dry-run

no

Set to 'true' in order to perform the changes (default: false)

-noseed

--no-seed

yes

If true, don't use a seed file and ignore the seed property value (default: false)

-output

--output-file

no

SQL output file (by default 'update.sql')

-plan

--migration-plan-file

yes

Migration plan data file

-redishost

--redis-host

yes

Redis server host for this datacenter

-redisport

--redis-port

no

Redis server port for this datacenter (by default 6379)

-seed

--seed-file

no

Seed file (by default '/etc/abiquo/.store')

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:

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


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

Expand
titleClick here to show/hide the steps to upgrade from 5.2.0 or higher to 5.3.x

Run Redis database script

(tick) These scripts can always be found on the Abiquo Server.

On each Remote Services server (including Monolithic sever) or Datanode server run the Redis scripts.

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


Expand
titleClick here to show/hide the steps to upgrade from 5.3.0 or higher to 5.4.x

Run Redis database script

(tick) These scripts can always be found on the Abiquo Server.

On each Remote Services server (including Monolithic sever) or Datanode server run the Redis scripts.

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


Expand
titleClick here to show/hide the steps to upgrade from 5.4.0 or higher to 5.4.x

Run Redis database script

(tick) These scripts can always be found on the Abiquo Server.

On each Remote Services server (including Monolithic sever) or Datanode server run the Redis scripts.

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


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

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.

    Code Block
    service httpd start
    service abiquo-tomcat start
  2. On the Remote services server, start the Tomcat server

    Code Block
    service abiquo-tomcat start
  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

    Code Block
    sudo service cassandra start
  5. WAIT about 5 minutes until the service is up and running

  6. Start the KairosDB service

    Code Block
    sudo service kairosdb start
  7. Start the other services in this order

    Code Block
    sudo service abiquo-emmett start
    sudo service abiquo-delorean start
  8. On the V2V server: restart the Tomcat server:

    Code Block
    service abiquo-tomcat restart

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

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