Update To openQRM 5.1 On Debian Wheezy

Version 1.0
Last edited 01. October 2013
Author Matt Rechenburg

This HowTo is about how to update an existing openQRM environment version 4.9 or 5.0 to the latest openQRM 5.1 on Debian 7 aka Wheezy.



- an existing openQRM Installation < version 5.1 (e.g. 4.9 or 5.0)


Backup your existing openQRM environment

Here a screenshot of a existing, fully configured openQRM 5.0 Setup:

Here a screenshot of the version details of this openQRM 5.0 Setup

openQRM consist of "files" and a "database". Having a backup of both parts allow to "roll-back" the update at any point.

All files in openQRM are located within the openQRM base-directory (normally /usr/share/openqrm). To create a simply backup please run the following commands as 'root' on your openQRM Server:

cp -aR /usr/share/openqrm /usr/share/openqrm-5.0.before-update

To backup the openQRM database content (assuming mysql as the database backend) please run:

mysqldump openqrm -p > /usr/share/openqrm-5.0.before-update/openqrm-db.sql

This command will ask for the openQRM database password.

Please notice!

At any time in this howto you can roll-back to your existing openQRM environment by running as 'root'

mv /usr/share/openqrm /usr/share/openqrm-update-rolled-back && mv /usr/share/openqrm-5.0.before-update /usr/share/openqrm && /etc/init.d/openqrm restart

Furthermore openQRM provides a 'state-backup' which captures the full-state (all configuration files and the databases content). A 'state-backup' of openQRM also allows to "roll-back" the update at any point. To run a state backup please run:

/usr/share/openqrm/bin/openqrm state backup -n 5.0.before-update

To list all state backups please run:

/usr/share/openqrm/bin/openqrm state list

To apply/restore a state backups please run e.g.:

/usr/share/openqrm/bin/openqrm state restore -n [backup-name]

Here the commands to apply for a standard backup before an update:


Update openQRM to version 5.1

Get the openQRM 5.1 version

This howto to update an existing openQRM environment to openQRM 5.1 works for the openQRM Community Edition in the same way as for the openQRM Enterprise Edition.

The update procedure for openQRM 5.1 is straight forward.

Get the openQRM 5.1 Community Edition at http://sourceforge.net/projects/openqrm/ or get the openQRM Enterprise Edition from http://www.openqrm-enterprise.com/

As 'root' change to the ../src directory and run:

make && make update

The 'make' phase is downloading the new components for the openQRM 5.1 version and preparing the source for an installation or update. The 'make update' phase actually is doing the following actions to update the existing openQRM setup:

As the first step the update procedure creates a current state-backup as described above.

As second setp it creates a 'mirror' directory /usr/share/openqrm_pre_update. This is to compare the contents of all configuration files in a later step.

As the third step it actually runs the install action which then overwrites the current /usr/share/openqrm content.

As the fourth step the update procedure checks all configuration files and applies the current configured values to the new installation.

As the fivth step it applies eventually database schema updates.

As last step it updates the kernel initrd-files (used by network-deployment) and restarts openQRM

Please notice!

After the update it is required to restart the 'openqrm-client' on all integrated systems!

Only for the openQRM Enterprise Edition (skip if you are using the openQRM Community Edition)

The openQRM Enterprise Edition forwards to the License-Upload.

Please select the Enterprise Public, Server and eventual Clients License keys and click on submit.

Please notice!

With openQRM 5.1 the following plugins got merged:

citrix + citrix-storage to citrix

kvm + kvm-storage to kvm

xen + xen-storage to xen

The following plugins got re-named:

lxc-storage to lxc

openvz-storage to lxc

For those plugins the VM configuration directory changed from /var/lib/[plugin-name]-storage to /var/lib/[plugin-name]. e.g. for the KVM-Storage plugin it is required to move the previous VM configuration directory /var/lib/kvm-storage to /var/lib/kvm. For KVM-Storage please run the following command as 'root' to do the directory migration.

mv /var/lib/kvm-storage /var/lib/kvm

The update procedure will not do this automatically since it is recommended to have this directory mounted from a NAS!

Please notice!

If you are using any of the above plugins the safest way to do the update to 5.1 is to stop and remove all appliances and VM resources (just keeping the VM Images), then do the update. The 5.1 version provides an easy way to get the Images back into openQRM. Then simply create new VM resources and add new servers with the existing VM Images.

Here a screenshot of the openQRM UI after the successful update to openQRM 5.1

Here a screenshot of the version details of the openQRM Setup after updating it to version 5.1

Congratulations!! You have successfully updated openQRM to version 5.1!


openQRM Community - http://www.openqrm.com/

openQRM Project at sourceforge - http://sourceforge.net/projects/openqrm/

openQRM Enterprise - http://www.openqrm-enterprise.com/

openQRM at Twitter - https://twitter.com/openQRM

openQRM at Facebook - https://www.facebook.com/openQRM

This Howto is sponsored by openQRM Enterprise

Share this page:

0 Comment(s)