This guide explains how to upgrade OnApp Cloud v5.3 to the v5.4 for the cloud where all servers are static.Follow the procedure listed below in the correct order to upgrade your cloud. All packages (Control Panel and Compute resources) must belong to the same major version to ensure the best performance of your cloud.

OnApp 5.4 no longer supports custom roles created in vCloud Director. Please contact your account manager if it affects your upgrade.

On this page:

Search for other docs:



Important Notes

  1. You must be running the latest patch of OnApp 5.3 version to upgrade to 5.4 version. If you are using an earlier version, please upgrade to 5.3. first.
  2. Check the Activity Log in your OnApp CP dashboard if there are no transactions running in your cloud. If so, wait until all transactions are complete.
  3. Make sure no Control Panel files are open for editing under the root user account.

  4. If you plan to deploy Accelerator, refer to the RabbitMQ Configuration for Accelerator document for more details.
  5. Be aware that from now on, OnApp Licensing has a standalone client.Use only 443 port to connect from Control Panel to licensing server.
  6. We strongly recommend that you test all your custom scripts before upgrading your production environment.

  7. Be aware that OnApp does not support UEFI on static compute resources. You should disable UEFI on your compute resources before installing OnApp.

If you are using WHMCS modules for OnApp, it is not recommended to update your cloud to the latest release. To ensure that all WHMCS modules are working correctly you need to be running an LTS OnApp version.

Check Your Cloud Configuration


Starting with OnApp 5.4, networks are made up of sub-networks called IP nets which contain ranges of IP addresses. To make your system compatible with the new networking scheme, a rake task will run with the installer. The rake task will modify your networks to contain IP ranges and IP nets. If a network contains two or more consecutive IP addresses of the same range of addresses, they will be united into one IP range. Individual IPs will each constitute an IP range. For each of the IP ranges an IP net will be added to the network. If at least one conflict is found in the configuration, the cloud will not be updated. If your cloud configuration is correct, the CP installer will be run and your networks will be modified to include IP nets and IP ranges.

Prior to the update procedure, it is required to check your cloud configuration. The cloud should comply with the following requirements for a successful upgrade:

  • all VLANs indicated for the networks in the cloud should have a relevant value. The value for VLAN should not exceed 4095.
  • all networks which have one or several IP addresses assigned to user(s) should be within a network zone
  • all IP addresses added to the cloud should be represented with feasible values
  • all network masks should have relevant lengths
  • there should be no overlapping IP addresses in a single network

If one or several of the IP address you've added to the cloud do not correspond with their prefix, the system will offer to switch on the force option. When the force option is enabled, the system will automatically change the IP address to correspond with their prefix. For example, if you've had a IP address with 8 as its prefix, the system will change the address to

If any inconsistencies are detected in your system, the update procedure will stop and the networks will undergo no changes. In such a case, you need to address the issues that have been found and run the CP installer again. If it is not possible to fix the cloud configuration, please, contact our support team.

If the configuration of the cloud meets the requirements listed above, the update to OnApp 5.4 will go smoothly, and all networks will be modified to include IP nets and IP ranges.

When you run the Control Panel installer the system will check your configuration. You can view the log at log/ip_consistency_check.log. If any inconsistencies are found, the log might contain any of the following warning messages:

  • an incorrect VLAN for a network has been detected. The ID and label of the network will be provided.
  • a network that has an IP address assigned to a user and which is not in a network zone has been detected. The ID of the network, the ID of the assigned IP address and the ID of the user to whom the IP is assigned will be provided.
  • an IP address which is represented incorrectly has been detected. The ID of the IP address will be provided.
  • an IP address which does not correspond with its prefix has been detected. The ID of the network, the ID of the IP address and the existing and expected prefixes will be provided.
  • overlapping IP addresses have been detected in one network. The IP addresses and the network ID will be provided.


Upgrade Static Compute Resources

At first upgrade your static compute resources.

  1. Make sure your compute resource is visible and online in the Control Panel.
  2. Download and install the latest OnApp YUM repository file:

    # rpm -Uvh
  3. Install the pv utility package:

    # yum install pv
  4. (for CentSO 7.x only) Install psmisc package:

    # yum install psmisc
  5. Update storageAPI:

    # yum update onapp-storageAPI

When upgrading from OnApp 5.3 to 5.4 it is not required to upgrade static backup servers.

Upgrade Control Panel Server


To upgrade your Control Panel server:


  1. Download and install the latest OnApp YUM repository file:

    # rpm -Uvh
  2. Upgrade OnApp Control Panel installer package:

    # yum update onapp-cp-install

  3. Update your server OS components (if required):

    # /onapp/onapp-cp-install/ -y
  4. (Optional) If you need some custom Control Panel configuration, set the values before the installer script runs.

    Template server URL


    # IPs (separated with coma) list for the SNMP to trap. This is the list of Control Panel IP addresses on which the traps sent from the compute resources are processed.


    # OnApp Control Panel custom version


    # OnApp MySQL/MariaDB connection data (database.yml)


    # MySQL/MariaDB server configuration data (in case of local server)


    # Use MariaDB instead of MySQL as OnApp database server (Deprecated parameter. If you set any values for this parameter, they will not take effect)


    # Configure the database server relative amount of available RAM


    # The number of C data structures that can be allocated before triggering the garbage collector. Only change this value if you understand what it does.


    # sysctl.conf net.core.somaxconn value


    # The root of OnApp database dump directory (on the Control Panel box)


    # Remote server's (to store database dumps) IP, user, path, openssh connection options ans number of dumps to keep

    DB_DUMP_SERVER_SSH_OPT="-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PasswordAuthentication=no"
    DB_DUMP_CRON='40 * * * *'

    # Enable monit - tool for managing and monitoring Unix systems


    # If enabled (the 1 value is set) - install (if local box) and configures RabbitMQ Server (messaging system) for the vCloud support. (Deprecated parameter. If you set any values for this parameter, they will not take effect)


    # Rotate transactions' log files created more than TRANS_LOGS_ROTATE_TIME day(s) ago


    # Maximum allowed for uploading file size in bytes, from 0 (meaning unlimited) to 2147483647 (2GB). Default is 1GB




    # Timeout before ping Redis Server to check if it is started. Default is 5 sec.



    # OnApp Control Panel SSL certificates (please do not change if you aren't familar with SSL certificates)
    # * The data below to generate self-signed PEM-encoded X.509 certificate

    SSL_CERT_COMMON_NAME=`hostname --fqdn 2>/dev/null`


    #   SSLCertificateFile, SSLCertificateKeyFile Apache directives' values
    #   ssl_certificate, ssl_certificate_key Nginx directives' values



    # * PEM-encoded CA Certificate (if custom one exists)
    #   SSLCACertificateFile, SSLCertificateChainFile Apache directives' values
    #   ssl_client_certificate Nginx directives' values



    #   SSLCipherSuite, SSLProtocol Apache directives' values
    #   ssl_ciphers, ssl_protocols Nginx directives' values



    # vi /onapp/onapp-cp.conf
  5. Run Control Panel installer:

    # /onapp/onapp-cp-install/




    /onapp/onapp-cp-install/ [-c CONFIG_FILE] [--mariadb | --community | --percona | --percona-cluster] [-m MYSQL_HOST] [--mysql-port=MYSQL_PORT] [--mysql-sock[=MYSQL_SOCK] [-p MYSQL_PASSWD] [-d MYSQL_DB] [-u MYSQL_USER] [-U ADMIN_LOGIN] [-P ADMIN_PASSWD] [-F ADMIN_FIRSTNAME] [-L ADMIN_LASTNAME] [-E ADMIN_EMAIL] [-v ONAPP_VERSION] [-i SNMP_TRAP_IPS] [--redis-host=REDIS_HOST] [--redis-bind[=REDIS_BIND] [--redis-passwd[=REDIS_PASSWD] [--redis-port=REDIS_PORT] [--redis-sock[=REDIS_SOCK] [--rbthost RBT_HOST] [--vcdlogin VCD_LOGIN] [--vcdpasswd VCD_PASSWD] [--vcdvhost VCD_VHOST] [--rbtlogin RBT_LOGIN] [--rbtpasswd RBT_PASSWD] [-a] [-y] [-D] [-t] [--noservices] [--ha-install] [--rake=RAKE_TASKS] [-h]


     Database server options:Default database SQL server is MySQL Server. Please use one of the following option to install LOCALLY.
    --mariadbMariaDB Server
     --communityMySQL Community Server
    --perconaPercona Server
    --percona-clusterPercona Cluster
    MYSQL_*Options are useful if MySQL is already installed and configured.
    -m MYSQL_HOSTMySQL host. Default is 'localhost'
    --mysql-port=MYSQL_PORTTCP port where MySQL Server serves connections. Default values is 3306 for the local installation
     --mysql-sock[=MYSQL_SOCK]Unix socket on which MySQL Server serves connections. Default values is /var/lib/mysql/mysql.sock. Used if local server only. The socket is unset if the option's argument isn't specified.
    -p MYSQL_PASSWDMySQL password. Random is generated if is not set or specified.
    -d MYSQL_DBOnApp MySQL database name. Default is 'onapp'
    -u MYSQL_USERMySQL user
    REDIS_*Options are useful if Redis Server is already installed and configured.

    IP address/FQDN where Redis Server runs. It is used by Control Panel to connect to Redis Server. The Redis Server will be installed and configured on the current box if localhost/ or box's public IP address (listed in SNMP_TRAP_IPS) is specified. Default value is If local Redis, it will serve as well on the unix socket 'PORT' (if --redis-sock without argument isn't specified).
    --redis-bind[=REDIS_BIND]The IP address for Redis Server to serve connections (to listen). The option isn't mandatory.
    --redis-port=REDIS_PORTRedis Server listen port.
    Defaults are:
    0 - if local server
    6379 - if remote server
    --redis-passwd[=REDIS_PASSWD]Redis Server password to authentificate.
    Random password is generated if the option's argument isn't specified.
    By default no password is used for local Redis.
    --redis-sock=REDIS_PATH :Path to the Redis Server's socket. Used if local server only. Default is /var/run/redis/redis.sock. The socket is unset if the option's argument isn't specified.
    ADMIN_*Options are used to configure OnApp Control Panel administrator data.
    Please note, that these options are for NEW INSTALL only and not for upgrade


    CP administrator password
    -F ADMIN_FIRSTNAMECP administrator first name
    -L ADMIN_LASTNAMECP administrator last name
    -E ADMIN_EMAILCP administrator e-mail
      --rbthost   RBT_HOST  IP address/FQDN where RabbitMQ Server runs. The RabbitMQ will be installed and configured on the current box if localhost/ or box's public IP address (enlisted in SNMP_TRAP_IPS) Default values are
    VCD_*Options are usefull if vCloud/RabbitMQ are already installed and configured.
    --vcdlogin  VCD_LOGINRabbitMQ/vCloud user. Default value is 'rbtvcd'.
    --vcdpasswd VCD_PASSWDRabbitMQ/vCloud user password. The random password is generated if isn't specified.
    --vcdvhost  VCD_VHOSTRabbitMQ/vCloud vhost. Default value is '/'
    RBT_*  Options are used to configure RabbitMQ manager account. If local RabbitMQ server.
    --rbtlogin  RBT_LOGIN RabbitMQ manager login. The default value is 'rbtmgr'.
    --rbtpasswd RBT_PASSWDRabbitMQ manager password. The random password is generated if isn't specified.
    --ha-installProceed with Control Panel and High Availability components installation.
    --rake RAKE_TASKSList of OnApp Control Panel rake tasks (separated with space) to run at the very end of install or upgrade.
    -v ONAPP_VERSIONInstall custom OnApp CP version
    -i SNMP_TRAP_IPSIP addresses separated with coma for snmp to trap
    -c CONFIG_FILECustom installer configuration file. Otherwise, preinstalled one is used.
    -yupdate OS packages (except of OnApp provided) on the box with 'yum update'.
    -aDo not be interactive. Process with automatic installation. Please note, this will continue OnApp Control Panel install/upgrade even if there is transaction currently running.
    -tAdd to the database and download Base Templates. For new installs only. If this option is not used, then only the following mandatory System Templates will be added by default during fresh install: OnApp CDN Appliance; Load Balancer Virtual Appliance; Application Server Appliance.

    Do not start OnApp services: monit, onapp and httpd
    Please note, crond and all OnApp's cron tasks remain running. They could be disabled by stopping crond service manually for your own risk.

    -DDo not make database dump, and make sure it is disabled in the cron and not running at the moment.
    -hprint this info

    You may wish to reboot your Control Panel server to take advantage of a new kernel if it is installed. It is not required immediately as a part of the upgrade process though.

If you face the problem with viewing the maps on VS/Smart/Application server creation wizard (Locations step), refer to the Add Google Map API Key document.



Getting support for your upgrade

You can use the information in this document to perform your own upgrade to the 5.4 version of the OnApp Cloud. However, if you have a full OnApp Cloud license, you are entitled to free upgrade support from the OnApp Support team.

If you would prefer to have the Support team perform the upgrade for you, just raise a ticket in the normal way. Please be aware, however, that there may be a queue! For help with your upgrade, visit the OnApp community forum:

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels