Page tree
Skip to end of metadata
Go to start of metadata
  1. Go to your Control Panel's Settings menu, and click the Configuration icon.

  2. Click the System tab to change the following application settings:

    If you change any settings here and save, the Control Panel server will restart OnApp services.


    License info

    • Key - the key for your OnApp installation.

    File Upload configuration

    • Max upload size - the maximum file size for ISOs that can be uploaded to boot a VS.


    • Force SAML login - enabling this feature will force SAML users to log into the cloud only with their third-party credentials and disable the possibility for them to log with OnApp login and password.


    By setting up the Use Yubico login option for your cloud, you give your customers the ability to log into OnApp by entering their credentials and using a Yubikey.

    • Use Yubico login - move the slider to the right to enable logging in using a Yubikey
    • Yubico client ID - enter your Yubico client ID
    • Yubico secret key - enter your Yubico secret key
      You can retrieve your Yubico client ID and secret key at


    • Host - RabbitMQ server IP address

    • Virtual Host - the name of the "virtual host" (or vhost) that specifies the namespace for entities (exchanges and queues) referred to by the protocol. Note that this is not virtual hosting in the HTTP sense.

    • Login - RabbitMQ login
    • Password - RabbitMQ password


    If you want to use a separate RabbitMQ instance for vCloud, specify the following vCloud RabbitMQ parameters in the /onapp/configuration/rabbit_mq/vcloud/credentials.yml file:

    • :host: - RabbitMQ server IP address
    • :port: - RabbitMQ port
    • :vhost: - the name of the "virtual host" (or vhost) that specifies the namespace for entities (exchanges and queues) referred to by the protocol. Note that this is not virtual hosting in the HTTP sense.
    • :user: - RabbitMQ login
    • :password: - RabbitMQ password


    Compute resources

    • Requests before marked as failed - determines how many times the Control Panel server will attempt to contact a Compute resource before failover is initiated. For the Integrated Storage, we recommend increasing this parameter to 30, so that the storage platform has enough time to mark the Compute resources accordingly, and allow the VSs to start up after a failed Compute resource. In integrated storage statuses of backend nodes are marked as inactive approximately in 3 minutes after a backend node has stopped reporting its status. Integrated storage is a distributed system and it takes some time to sync/converge metadata across nodes.

      The time before the CP initiates failover may differ depending on the number of compute resources and their load.



    VS Console Ports*

    These are the ports used to remotely connect to virtual servers using the integrated VNC console.

    • Set the port range using the First port and Last port fields. 

    Email - this is where you configure OnApp to send email alerts for failed transactions and changes of Compute resource status. If OnApp Storage is enabled, you may also switch on Storage hourly and/or daily email reports.

    • Send notifications? - move this slider to the right to enable email alerts (failed tasks, offline Compute resources, etc).
    • Enable hourly Storage reports - generate and send hourly Storage reports. Hourly Storage report is an email with details about storage disks changing degradation statuses (e.g. "Healthy" > "Degraded", "Missing members" > "Healthy", etc). If no such changes occurred during the last hour, the email is not sent.
    • Enable daily Storage reports - are the health check diagnostic pages sent as email for each Compute zone with storage. 
    • System host - enter a server IP or URL. Email alerts link to transaction logs for alert events, and those logs are opened from the server configured here.
    • FROM: – the email address from which help requests and email alerts are sent.
    • TO: - the email address to which the system will send alerts about failed transactions and change of Compute resource status.
    • Email delivery method - select a mail transfer agent: either sendmail or smtp. If you select smtp, please configure the options below:
      • SMTP address - address of the SMTP server
      • SMTP port - port of the SMTP server
      • SMTP domain - associated domain
      • SMTP username - user name to login into SMTP server
      • SMTP password - password to login into SMTP server
      • SMTP authentication - select an authentication mechanism from a drop-down menu
      • SMTP enable STARTTLS - enable or disable StartTLS extension


    • Application name – here you may change the application name, which is displayed at the welcome screen.
    • Config comment - this text is added by OnApp to system configuration files, such as resolv.conf. This prevents the system from creating VSs with more CPU than is available for a Compute resource. For example, on a Compute resource with 4 CPU cores, with CPU guarantee enabled, you will only be able to create 4 VSs with 100% CPU priority. The system will not allow you to create a 5th VS.
    • Enable huge pages - move this slider to the right to enable huge pages utilization. Huge pages are the memory pages of size 2MB. Use of huge pages allows you to reduce the number of page walks as compared to a standard method of translation from a virtual address to physical 4kB page.
    • Show IP address selection for new VS – move this slider to the right to enable IP address assignment during VS creation.
    • Number of simultaneous transactions - the number of transaction runners which the daemon will execute at the same time.
    • Zombie transaction time - set the duration in minutes after which the transaction running longer than the indicated time will be marked as zombie. 
    • System alert reminder period - the duration in minutes for the system to email alerts to admin if the failover resources are not enough. The default value is 60.
    • Enable wrong activated logical volume alerts - move the slider to the right to enable system alerts.
    • Wrong activated logical volume minutes - specify the alert emails frequency in minutes.
    • Timeout Before Shutting Down VSs (30-600 sec) - specify the VS shutdown period within the indicated range. This will allow refusing the shutdown if the VS is booting and retry every 30 seconds till it is registered.
    • Allow VS password encryption – move this slider to the right to enable root password encryption for virtual servers.
    • Allow VMware Compute resource password encryption – move this slider to the right to enable root password encryption for VMware Compute resources.
    • Use HTML 5 VNC console - move this slider to the right to enable the use of HTML 5 VNC console. VNP ports from the CP server are not required if the HTML 5 console is enabled.

      It is only possible to use HTML 5 console if the Control Panel server is based on CentOS6.

    • Max network interface port speed - maximum NIC port speed in MB
    • Allow users connect to AWS - move this slider to the right to enable AWS for the cloud

    Delay in seconds between executing background tasks
    Sets frequency in seconds for executing the following tasks:


    • Backup taker
    • Billing stats monitor 
    • Cluster monitor 
    • Compute resource monitor 
    • Schedule runner 
    • Transaction runner 
    • CDN Sync

    Background Processes

    • Amount of service instances -  the number of system processes that perform the OnApp engine tasks simultaneously. Each of the system processes performs the task using a separate CPU coreThe default value is 1. Currently, the maximum value is 5. If you input a value larger than five, the number of system process will still be five.
    • Transaction standby period - the time which a transaction spends in stand-by period before requeueing to pending queue.. The default value is 30. We recommend increasing this parameter for clouds with thousands of pending long lasting transactions (like backups) in order to decrease CPU/IO load.


    • Enable CloudBoot - move this slider to the right to enable/disable the PXE boot system on the cloud.

    • Static Config target -   the IP of NFS server that contains virtual server image templates.

    • CP server Cloudboot target - the IP of Control Panel server.

    OnApp Storage

    • Enable OnApp Storage - move this slider to the right to enable/disable the OnApp storage on the cloud.
    • Use Local Read Path - move this slider to the right to minimize the network throughput dependency for read heavy workloads. When the Use Local Read Path feature is enabled, reads go over the local software bridge to a local replica of the data rather than traverse a physical NIC + switch.
    • Use unicast - switch from multicast to unicast mode. Instead of CP server setting a multicast 'channel' and restarting all Compute resource control stacks that are added to the zone, the CP server now maintains the list of unicast hosts. This is the list of IDs of all hosts in the same zone separated with a comma. CP server updates the unicast hosts list for all Compute resources whenever any member is added or deleted from the set. This parameter is stored in the onappstore.conf file, and the CP server explicitly copies the /.rw/onappstore.conf to /onappstore/onappstore.conf on all Compute resources whenever a change is made.

      Please, be aware this is a beta option. We suggest switching to unicast mode only in case you are not able to use multicast. Also, if at least one Virtual Server is running - unicast cannot be turned on.


      When unicast mode is enabled, compute resources must be kept online to maintain full coherency of the database. In the event when a compute resource is offline but still enabled in the Control Panel, any subsequent reboots of other nodes will cause a delay in convergence of the Integrated Storage database across the nodes that have been rebooted. To avoid this scenario, either:
      • Ensure that all compute resources in the unicast group are active and booted (recommended)
      • Remove compute resources from the Control Panel if they are inactive for an extended period of time


    • VMware cluster name - the name of the VMware cluster.

    Statistics Management

    • Time of instant statistics storage (days) - the number of days the instant statistics from Compute resource will be stored. 
    • Enable hourly statistics archiving - move the slider to the right to switch on archiving for hourly statistics. If enabled, hourly statistics will be converted into monthly and stored as archive for all the period that exceeds the time specified in the Time of hourly statistics storage (months) parameter below. 
    • Time of hourly statistics storage (months) - this parameter configures how long you want the detailed hourly statistics to be stored in database before being converted into monthly statistics. For example, if you set that parameter to 10, the hourly statistics will be stored for the last 10 months. And everything older than 10 months will be sent to archive (that is converted into monthly statistics). If this parameter is set as 1, then you can view the detailed hourly statistics for the current month only. Set this parameter at least as 2 to keep the statistics for the previous month available. 

    • Enable logs cleaning - this parameter enables logs cleaning after the time period, specified in the Period to store logs (days) parameter below.

    • Period to store logs (days) - this parameter configures how many days you want logs to be kept in database before deletion.

    Custom Tools In Recovery Images

    • URL for custom tools - specify the full URL to the tools file packed with GNU Tar + Gzip, like These tools will be copied to a recovery VS after rebooting in recovery mode. The users will then be able to unpack and use these tools as they wish to.

    If the recovery image file is too large, the virtual servers may fail to start up in the recovery mode. We highly recommend you  to test the custom recovery image on the virtual server with minimum RAM size before using it.


    SNMP Trap Settings

    • Snmptrap addresses - a set of IPv4 management network IP(s) from the CP server separated by coma. These IP addresses will be used for communication between Control Panel and Compute resources.

    • Snmptrap port - port used for snmptrap. This must be greater than 1024.

      We recommend that you do not change the default value.
      In case you change the port value on your OnApp CP - the corresponding change of the port VM_STATUS_SNMP_PORT should be made for all Compute resources in /etc/onapp.conf file.  

    OnApp Dashboard API
    • Access Token - enter the Access token that is displayed in your OnApp Dashboard for your user account details. This token is used to synchronize locations between OnApp CP and OnApp Dashboard. Make sure to enable the Access Token if you are using CDN Locations. 


    CDN Settings
    • Maximum results per page for API-call to Aflexi - the maximum number of results per page delivered when OnApp data are synchronized with Aflexi. The default value is 500.

    Instance Types
    • Instance Types number - when the specified number is reached, instance types are shown in the linear view in the virtual server creation wizard for easier instance type selection. The default value is 3.

    Allow Control Panel to send crash reports

    • Allow to collect errors - move the slider to enable Control Panel to collect, aggregate, encrypt and send crash reports. If you enable this feature, the error list from your Control Panel will be sent to OnApp in a form of an encrypted API call. By default, this option is disabled.

    Zabbix Settings

    Starting with version 4.2, OnApp uses Zabbix for autoscaling. If you already have a Zabbix server, you can connect it to your cloud by adding the necessary information in the fields provided below:

    • Zabbix host - the IP address of your Zabbix server

    • Zabbix url - the path to the Zabbix web-interface

    • Zabbix user - your Zabbix user

    • Zabbix password - your Zabbix password

  3. Click the Save Configuration button to finish.
Unknown macro: {next_previous_links}
#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))