How to upgrade to OnApp v5.5

Zack Grindall

Zack Grindall
Cloud Architect

OnApp 5.5 is the new stable release of the OnApp cloud management platform, and with it comes a host of new features including Transaction Approvals, Service Insertions and beta support for vCenter. You can read more about the new version at

If possible we recommend that all customers upgrade to this release – so here’s a quick how-to guide. This upgrade guide covers the Control Panel upgrade process, and some additional steps if you are using OnApp for vCloud Director; plus links to complete your upgrade for CloudBoot and static hypervisor servers.



Important notes, before we begin…

This upgrade guide applies to environments running OnApp 5.0 LTS or OnApp 5.4 only. If you are using a previous version of OnApp, you’ll need to upgrade to 5.4 first, this can be achieved by performing a ‘tiered upgrade’: I have added information on how to do this at the bottom of this article.

You can check what version of OnApp you are running by affixing /version to the end of the Control Panel URL. If you access your OnApp CP using, then type

If you’re using OnApp for vCD, please ensure you are running vCD version 8.0 or higher before using this upgrade guide.


OnApp v5.5 control panel upgrade instructions

Upgrading OnApp should take around 30-60 minutes. We also offer free and paid upgrade services: if you would rather let us handle the upgrade for you, just log your request at the OnApp support portal.

1. Download and install the latest OnApp repository:

If you are running OnApp 5.0:

# rpm -Uvh

If you are running OnApp 5.4:

# rpm -Uvh

2. Upgrade the OnApp installer package:

# yum update onapp-cp-install

3. Update the CentOS base components:

# /onapp/onapp-cp-install/ -y

4. Run the OnApp upgrade script:

# /onapp/onapp-cp-install/

5. That’s it – the upgrade is underway.

Depending on the size of your existing environment, the upgrade script will take somewhere between 5 and 30 minutes to complete. You might see configuration key warnings during the upgrade, but they can be safely ignored. These warnings relate to depreciated configuration values no longer in use by OnApp.

If you are using OnApp for vCD, you can now skip to the vCD section below. For OnApp clouds, the next step is to upgrade your hypervisor servers (compute nodes). The method depends on whether you are using OnApp with CloudBoot servers, static servers or a mix of both.

Please review the following links to continue the upgrade process:


If you are using OnApp for vCD:

Once the Control Panel upgrade has successfully completed, it is strongly recommended to run the following scripts to ensure that OnApp and vCloud Director are in sync:

# cd /onapp/interface ; RAILS_ENV=production rake vcloud:resync_clean
# cd /onapp/interface ; RAILS_ENV=production rake vcloud:resync

The first script should take less than a minute or two to run, while the second script can take up to 25 minutes, depending on the size of your environment.

You can can check the status of these scripts while they are running, by having a separate console open and monitoring the following file as follows:

# tail -f /onapp/interface/log/production_vcloud.log

If you notice any errors in this log file during the upgrade, please get in touch with OnApp support and they will be able to assist!


Tiered upgrade instructions

Upgrading from OnApp v5.0 or v5.4, to OnApp v5.5, can be done in a single upgrade. For other v5.x releases you’ll need to upgrade sequentially  – e.g. from 5.1 to 5.2 to 5.3 to 5.4, and then to v5.5  (with the release of v5.5 we also announced a change to our release cycle which will make upgrades easier – you can read more about that here.)

As I mentioned earlier in this post, our support team is happy to handle your upgrades for you – just log your request at the OnApp support portal.

If you want to perform your own tiered upgrade, you can follow the steps above for each version – but with the following changes:

  • For the control panel upgrade – the initial repository definition

For example; if you are upgrading to OnApp 5.5 from OnApp 5.3, you’ll need to follow the upgrade steps twice, but defining the repository slightly differently before you begin each upgrade.

For the first upgrade you would use the following repository:

rpm -Uvh

For the second upgrade you would use:

rpm -Uvh


  • For hypervisor upgrades – the instructions for each version, which you’ll find here:

v5.1 – v5.2
v5.2 – v5.3
v5.3 – v5.4


If you need any clarification on this please contact!