Upgrading from OpenNebula 5.2.x

This section describes the installation procedure for systems that are already running a 5.2.x OpenNebula. The upgrade to OpenNebula 5.10 can be done directly following this section, you don’t need to perform intermediate version upgrades. The upgrade will preserve all current users, hosts, resources and configurations; for both Sqlite and MySQL backends.

Read the Compatibility Guide and Release Notes to know what is new in OpenNebula 5.10.


If you are using the vCenter drivers, there is a manual intervention required in order to upgrade to the latest version of OpenNebula.

Upgrading a Federation

If you have two or more 5.2.x OpenNebulas working as a Federation, you need to upgrade all of them. The upgrade for this version has to occur simultaneously on all zones including the master.

The steps to follow are:

  1. Stop the MySQL replication in all the slaves and master zone. The MySQL replication is no longer needed.
  2. Upgrade the master zone to the latest version
  3. Upgrade the slaves zones to the latest version
  4. Replicate the state of the shared tables from the master zone into each slave zone.

During steps 1 and 2 the slave OpenNebula’s can be running, and users can keep accessing them if each zone has a local Sunstone instance. However all the shared database tables (users, groups, ACL...) will not be updated in the slaves zones till step 3 is completed.

To perform the first step, you must stop and reset each slave (and master), remove any configuration attribute for replication in my.cnf file and finally restart mysqld. Please refer to mysql documentation for more details on how to perform this step.

Then follow this section for the master zone. After the master has been updated to 5.10, upgrade each slave zone following this same section.

Upgrading from a High Availability deployment

You need to restore the HA deployment according to the new implementation. Upgrade the active OpenNebula instance as described in this section and then regenerate the HA instances as described in the in the HA guide.


Before proceeding, make sure you don’t have any VMs in a transient state (prolog, migr, epil, save). Wait until these VMs get to a final state (runn, suspended, stopped, done). Check the Managing Virtual Machines guide for more information on the VM life-cycle.



Read this section carefully if you are using vCenter!

If you are using vCenter you will need to follow some extra steps while still running OpenNebula 5.2.

Follow the vCenter upgrade 5.2 to 5.4 Pre-migration phase.

Stop OpenNebula

Stop OpenNebula and any other related services you may have running: OneFlow, EC2, and Sunstone. Use preferably the system tools, like systemctl or service as root in order to stop the services.


Backup the configuration files located in /etc/one. You don’t need to do a manual backup of your database, the onedb command will perform one automatically.

cp -r /etc/one /etc/one.$(date +'%Y-%m-%d')

Installation of New Version

Follow the Platform Notes and the Installation guide, taking into account that you will already have configured the passwordless ssh access for oneadmin.

Make sure to run the install_gems tool, as the new OpenNebula version may have different gem requirements.


If executing install_gems you get a message asking to overwrite files for aws executables you can safely answer “yes”.

It is highly recommended not to keep your current oned.conf, and update the oned.conf file shipped with OpenNebula 5.10 to your setup. If for any reason you plan to preserve your current oned.conf file, read the Compatibility Guide and the complete oned.conf reference for 5.4 and 5.10 versions.

Configuration Files Upgrade

If you haven’t modified any configuration files, the package managers will replace the configuration files with their newer versions and no manual intervention is required.

If you have customized any configuration files under /etc/one we recommend you to follow these steps regardless of the platform/linux distribution.

  1. Backup /etc/one (already performed)
  2. Install the new packages (already performed)
  3. Compare the old and new configuration files: diff -ur /etc/one.YYYY-MM-DD /etc/one. Or you can use graphical diff-tools like meld to compare both directories, which are very useful in this step.
  4. Edit the new files and port all the customizations from the previous version.
  5. You should never overwrite the configuration files with older versions.

EC2 Configuration File

The credentials and capacity from ec2 zones have been moved from its configuration file to the template of the host. You don’t need to update the file /etc/one/ec2_driver.conf with the data from the old file. To make this data available to the migrator copy the old configuration file to /etc/one/ec2_driver.conf.old:

cp /etc/one.$(date +'%Y-%m-%d')/ec2_driver.conf /etc/one/ec2_driver.conf.old

After migration you can delete the old file:

rm /etc/one/ec2_driver.conf.old

Database Upgrade

vCenter Migration Tool


Read this section carefully if you are using vCenter!

If you are using vCenter you will need to run the vCenter migration tool before running the onedb upgrade command from the next section.

Follow the vCenter upgrade 5.2 to 5.4 Migration phase.

Perform the Database Upgrade

The database schema and contents are incompatible between versions. The OpenNebula daemon checks the existing DB version, and will fail to start if the version found is not the one expected, with the message ‘Database version mismatch’.

You can upgrade the existing DB with the ‘onedb’ command. You can specify any Sqlite or MySQL database. Check the onedb reference for more information.


Make sure at this point that OpenNebula is not running. If you installed from packages, the service may have been started automatically.


For environments in a Federation: Before upgrading the master, make sure that all the slaves have the MySQL replication paused.

After you install the latest OpenNebula, and fix any possible conflicts in oned.conf, you can issue the ‘onedb upgrade -v’ command. The connection parameters have to be supplied with the command line options, see the onedb manpage for more information. Some examples:

onedb upgrade -v --sqlite /var/lib/one/one.db
onedb upgrade -v -S localhost -u oneadmin -p oneadmin -d opennebula

If everything goes well, you should get an output similar to this one:

$ onedb upgrade -v -u oneadmin -d opennebula
MySQL Password:
Version read:
Shared tables 4.11.80 : OpenNebula 4.12.1 daemon bootstrap
Local tables  4.11.80 : OpenNebula 4.12.1 daemon bootstrap

MySQL dump stored in /var/lib/one/mysql_localhost_opennebula.sql
Use 'onedb restore' or restore the DB using the mysql command:
mysql -u user -h server -P port db_name < backup_file

>>> Running migrators for shared tables

>>> Running migrators for local tables
  > Done in 41.93s

Database migrated from 4.11.80 to 4.13.80 (OpenNebula 4.13.80) by onedb command.

Total time: 41.93s


Make sure you keep the backup file. If you face any issues, the onedb command can restore this backup, but it won’t downgrade databases to previous versions.

Check DB Consistency

After the upgrade is completed, you should run the command onedb fsck.

First, move the 5.2.x backup file created by the upgrade command to a safe place.

mv /var/lib/one/mysql_localhost_opennebula.sql /path/for/one-backups/

Then execute the following command:

$ onedb fsck -S localhost -u oneadmin -p oneadmin -d opennebula
MySQL dump stored in /var/lib/one/mysql_localhost_opennebula.sql
Use 'onedb restore' or restore the DB using the mysql command:
mysql -u user -h server -P port db_name < backup_file

Total errors found: 0

Recreate the Federation salves

This section applies only to environments working in a Federation.

For the master zone: Snapshot the shared tables using the onedb tool. Please refer to the federation guide for more details.

For a slave zone: Each slave should be already configured, i.e. oned.conf should include the ZONE_ID for the slave, auth files present and OpenNebula updated to last version. You only need to restore the shared tables saved in the previous step and start the slave zone.

Reload Start Scripts

Follow this section if you are using a systemd base distribution, like CentOS 7+, Ubuntu 16.04+, etc.

In order for the system to re-read the configuration files you should issue the following command after the installation of the new packages:

systemctl daemon-reload

Update the Drivers

You should be able now to start OpenNebula as usual, running service opennebula start as root. At this point, as oneadmin user, execute onehost sync to update the new drivers in the hosts.


Doing onehost sync is important. If the monitorization drivers are not updated, the hosts will behave erratically.


OpenNebula will continue the monitoring and management of your previous Hosts and VMs.

As a measure of caution, look for any error messages in oned.log, and check that all drivers are loaded successfully. After that, keep an eye on oned.log while you issue the onevm, onevnet, oneimage, oneuser, onehost list commands. Try also using the show subcommand for some resources.

Restoring the Previous Version

If for any reason you need to restore your previous OpenNebula, follow these steps:

  • With OpenNebula 5.10 still installed, restore the DB backup using ‘onedb restore -f’
  • Uninstall OpenNebula 5.10, and install again your previous version.
  • Copy back the backup of /etc/one you did to restore your configuration.

Known Issues

If the MySQL database password contains special characters, such as @ or #, the onedb command will fail to connect to it.

The workaround is to temporarily change the oneadmin’s password to an ASCII string. The set password statement can be used for this:

$ mysql -u oneadmin -p

mysql> SET PASSWORD = PASSWORD('newpass');