This chapter provides an overview on what templates in OnApp are, the management tips, the information on creating your own templates and providing them as a paid resource for your customers.


On this page:

What templates are

A template is a fully preconfigured operating system environment – a tar + gzip archive that contains the root directory of an operating system. A basic template includes the data needed for a minimum OS installation, but templates may also include applications and additional OS components.

OnApp templates are used to deploy virtual servers in your cloud. The OnApp template library includes over 100 VS templates based on various 32-bit and 64-bit flavours of Windows and Linux operating systems. OnApp customers can also access a large number of JumpBox virtual Compute resources and deploy them as templates in OnApp. 

Windows templates

To create a virtual server from a template which is based on paid software, such as MS Windows, you must have a valid license. The system verifies if you have a license before allowing the VS to be created, so before creating a VS you must first upload the license keys you've bought to OnApp, or connect to a licensing server.

OnApp supports three license types:

  • MAK licensing: the default licensing type applied to all Windows-based VSs.
  • KMS licensing: this is applicable to Windows 2008 and Windows 7 VSs only.
  • User licenses: allow end users to input a license key when creating a VS.

Windows Server 2003/XP OSs have come to their end-of-life on July 14th, 2015 and are no longer supported. Thus OnApp version 4.0 introduces new Windows templates version 4.x with Cygwin as SSH server (instead of CopSSH as in versions 3.x).

  • New 4.0 templates cannot be used in OnApp version 3.x or below.
  • Windows templates version 3.x can be used in OnApp version 4.0 without restrictions.

For more information refer to Template Software Licenses page.

Windows 10/Windows Server 2016 Virtual Servers

If you want to build Windows 10/Windows Server 2016 VSs, the following limitations apply to KVM compute resources:

  • Windows 10/Windows Server 2016 VSs can be built on the CentOS 6/CentOS 7 compute resources with the following CPU models:
    • at least Ivy-Bridge-based Intel Xeon E series v2

    • Opteron G2, G3, G4, G5, and G6

  • CPU flag 'fsgsbase' is required. For more information on CPU flags refer to Manage Extended CPU Flags for Compute Zone.

The above limitations do not apply to XEN compute resources.

Types of templates

There are two different kinds of template:

  • System templates. These are provided by OnApp and downloaded from an online library. They comprise an operating system with the latest set of packages installed. Windows 2008 templates require 20GB of free disk space. Windows 2003 templates require 10GB. Most Linux templates require 2–10GB. Some Windows Templates with additional software may require minimum disk size of 30 GB - e.g. win12_x64_std-sqlweb-ver3.2-kvm_virtio. Minimum disk size for new 4.0 Windows templates is 30 GB (40 GB for templates with MS SQL).


  • Custom/user templates. These are templates you create by backing up an existing virtual server, and converting that backup to a template. This allows you to pre-configure virtual servers (for example with specific OS settings, or pre-installed applications) and use the same configuration again and again.


For more details on how to create a custom templates from a backup, refer to Convert Virtual Server Backup to Template and Create Custom Templates sections.

You can use the following templates for smart servers and baremetal server creation:

OSBaremetal ServersSmart Servers

2008 R2 Standard Edition

2008 R2 Data Center Edition

Windows 2008 x64 STD R2 XEN 3.1

CentOS 5 64 bit

CentOS 6 64 bit

Redhat 6 64 bit

Debian 6 64 bit

Ubuntu 12 64 bit

Debian 6.0 x64



Where templates are stored

Depending on the configuration of your cloud, new templates are stored at different locations:

Configuration of your cloud

Storage locations for templates

No backup servers and ssh_file_transfer option is disabled

In this configuration, the templates will be uploaded to all Compute resources. If this template already exists somewhere, the action is skipped. In such case NFS or any other sharing service should be enabled between Compute resource's.

No backup servers and ssh_file_transfer option  is enabled

The template is uploaded to this ssh_file_transfer server only.


There are backup servers and ssh_file_transfer option is disabled

The templates are uploaded to all backup servers. The action is skipped if such a template already exists. In this configuration ensure that some sharing service is between backup servers. Provisioning is performed at backup servers only. If there is more than one backup server in the cloud, the user is prompted to choose to which BS a template will be stored.

There are backup servers and ssh_file_transfer is enabled

The templates are uploaded to this ssh_file_fransfer server only. 

High Availability is configured for the Cloud

In this configuration, make sure to store templates at Database&Transactions server or any other server with shared NFS service, so that both Control Panels could access thetemplates directory.


The following scheme demonstrates the possible template storage locations depending on your system's configuration :

Template store

Template store enables you to organize individual templates into groups that can be used as a paid resource for billing plans. This allows you to easily create groups of templates which can be added to the billing plan. Only those groups which are added to a billing plan will be available to a user. You can arrange the templates into groups depending on their type, price, or whatever other attribute.

For detailed instructions, refer to Template Store section.



My template group

My Template Groups allow you to create own license groups for your own personal/custom templates. The groups cannot be shared amongst the users. Also, for Windows based templates, My Template Groups provide the possibility to use your own licensing type regardless of your billing plan. 

For detailed instructions, refer to My Template Groups section.



Configuration Options 

You can set template configurations for you cloud in the settings menu at Dashboard > Settings > Configuration > Backups/Templates tab. This menu lets you set the following template-related parameters:

  • The URL of the required template server
  • Whether you want to delete the downloaded templates after they were distributed
  • The system path to templates and recovery templates

During Control panel install/upgrade process, the following values are set by default:

Templates and backups can be stored on a remote server or a mounted disk. If you wish to store templates and backups remotely, you should also configure the following settings:

  • Template/backup server IP, user login and SSH options
  • Whether to use SSH file transfer for your template/backup server or not



For more information, refer to Edit Backups/Templates Configuration.



Installation and update

The OnApp template library includes over 100 VS templates based on various 32-bit and 64-bit flavours of Windows and Linux operating systems. You can also access a large number of JumpBox virtual compute resources and deploy them as templates in OnApp. The templates library is constantly updated. You can manage new templates with the OnApp template manager that connects to template server and allows you to:

  • update the system templates which are already installed to your cloud 
  • download and install new templates available on a template server.

The Template server URL has to be set at Control panel > Settings > Configuration > Backups/templates tab as a prerequisite for installing/upgrading templates.

For detailed instructions, refer to Install/Update Templates page.




You can set up templates as a paid resource in several ways.

To set the pricing for the individual templates, go to the Template store menu and indicate the price for required templates per template per hour. To set the pricing for the template storage space and the amount of templates allowed per account, use the billing plans.

If the templates are stored on compute resources or SSH file transfer server, you can apply the Templates, ISOs & Backups Storage and Template User VS Limits:

  • free disk space for templates
  • the total amount of disk space for templates
  • the price per GB of disk space per hour
  • the number of templates users can create for free
  • the maximum number of templates
  • the price per template per hour

If the templates are stored on backup servers, apply the Limits&Pricing for backup server zone limits :

  • free disk space for templates
  • total amount of backup server space that the templates can get
  • the price per GB of disk space per hour
  • the amount of templates users get for free
  • the total amount of templates
  • the price per template per hour