User manual | OnApp 2.3 Admin Guide

v2.3.2
Admin Guide
A guide to all Control Panel functions, with tips for cloud admins.
Document version
Document release date
1.9
26th April 2012
document revisions
1
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Contents
1.
About this guide ............................................................................................................. 9
2.
OnApp overview ........................................................................................................... 10
3.
2.1
Main components & features ..................................................................................................... 10
2.2
API and integrations .................................................................................................................... 13
2.3
Hardware & software requirements ........................................................................................... 13
2.4
Architecture ................................................................................................................................ 15
Dashboard .................................................................................................................... 16
3.1
User profile ................................................................................................................................. 17
3.1.1
API Key ...................................................................................................................................................17
3.2 Cloud search tool .............................................................................................................................. 17
4.
Virtual machines........................................................................................................... 19
4.1
Manage VMs ............................................................................................................................... 19
4.1.1
Create VMs ............................................................................................................................................20
4.1.2
Build VMs manually ...............................................................................................................................22
4.1.3
View VMs ...............................................................................................................................................22
4.1.4
VM properties ........................................................................................................................................23
4.1.5
Adjust Resource Allocation ....................................................................................................................24
4.1.6
Migrate VMs ..........................................................................................................................................25
4.1.7
Autoscale VMs .......................................................................................................................................25
4.1.8
Segregate VMs .......................................................................................................................................26
4.1.9
Set VIP status for VMs ...........................................................................................................................27
4.1.10
Add a VM administrator’s note .........................................................................................................27
4.1.11
VM integrated console ......................................................................................................................27
4.1.12
VM transactions and logs ..................................................................................................................28
4.2
Manage VM networks ................................................................................................................. 28
4.2.1
Configure network interface ..................................................................................................................28
4.2.2
Set firewall rules ....................................................................................................................................29
4.2.3
Allocate IP Addresses .............................................................................................................................30
4.2.4
Display Network Speed for network interfaces on Virtual Machine page.............................................31
4.2.5
Edit virtual machine network speed ......................................................................................................31
4.3
Manage VM disk space ............................................................................................................... 32
2
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4.3.1
Add disks to a VM ..................................................................................................................................32
4.3.2
Resize VM disks ......................................................................................................................................33
4.3.3
Migrate disks..........................................................................................................................................33
4.3.4
Back up VM disks ...................................................................................................................................33
4.3.5
Schedule VM backups ............................................................................................................................34
4.3.6
Delete VM disks .....................................................................................................................................34
4.3.7
Manage backups ....................................................................................................................................35
4.4
5.
6.
VM statistics ................................................................................................................................ 35
4.4.1
VM CPU utilization .................................................................................................................................35
4.4.2
VM Billing statistics ................................................................................................................................36
4.4.3
Network Interface usage .......................................................................................................................36
4.4.4
Disk IOPS ................................................................................................................................................37
Load Balancers ............................................................................................................. 38
5.1
Add a load balancer cluster......................................................................................................... 38
5.2
Add an autoscaling cluster .......................................................................................................... 39
5.3
View load balancer details .......................................................................................................... 40
5.4
Edit/delete a load balancer ......................................................................................................... 41
CDN .............................................................................................................................. 43
6.1
CDN edge servers ........................................................................................................................ 44
6.1.1
Add CDN edge server .............................................................................................................................44
6.1.2
View edge server details ........................................................................................................................45
6.1.3
Edit CDN edge server .............................................................................................................................46
6.1.4
Delete CDN edge server .........................................................................................................................46
6.2
CDN resources ............................................................................................................................. 46
6.2.1
View CDN resources...............................................................................................................................47
6.2.2
Add new CDN resource ..........................................................................................................................47
6.2.3
Edit CDN resource ..................................................................................................................................49
6.2.4
View CDN resource details.....................................................................................................................49
6.2.5
Prefetch content ....................................................................................................................................50
6.2.6
Purge content ........................................................................................................................................50
6.2.7
Bandwidth statistics ...............................................................................................................................51
6.3
6.3.1
CDN edge groups ........................................................................................................................ 51
Create a new CDN edge group ...............................................................................................................51
3
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
7.
6.3.2
View CDN edge group details ................................................................................................................52
6.3.3
Assign/remove locations to/from the CDN Edge Group ........................................................................52
6.3.4
Edit/delete CDN edge group ..................................................................................................................52
DNS .............................................................................................................................. 53
7.1
7.1.1
7.2
8.
9.
DNS setup.................................................................................................................................... 53
Edit DNS domain ....................................................................................................................................54
DNS zone ..................................................................................................................................... 54
7.2.1
Add new DNS zone.................................................................................................................................54
7.2.2
Edit DNS zone.........................................................................................................................................56
7.2.3
Delete DNS zone ....................................................................................................................................57
7.2.4
User DNS zones ......................................................................................................................................57
7.2.5
Set End-User Access to DNS service.......................................................................................................57
7.2.6
View/edit/delete clients’ DNS zones .....................................................................................................58
Hypervisors .................................................................................................................. 59
8.1
View hypervisors ......................................................................................................................... 59
8.2
View hypervisor details ............................................................................................................... 59
8.3
Edit hypervisor details................................................................................................................. 60
8.4
Reboot hypervisors ..................................................................................................................... 60
8.5
Other hypervisor settings ........................................................................................................... 61
Templates .................................................................................................................... 62
9.1
View template details ................................................................................................................. 62
9.2
Edit template details ................................................................................................................... 63
9.3
Delete system templates ............................................................................................................ 63
9.4
Create custom templates ............................................................................................................ 63
9.5
User template permissions ......................................................................................................... 64
9.6
Edit and delete custom templates .............................................................................................. 64
9.7
Make templates public ............................................................................................................... 64
9.8
Allow users to make templates public ........................................................................................ 65
9.9
Template software licenses ........................................................................................................ 65
9.9.1
KMS licensing .........................................................................................................................................66
9.9.2
MAK licensing.........................................................................................................................................66
9.10
Template groups ......................................................................................................................... 67
4
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
10.
Logs .......................................................................................................................... 69
11.
Settings ..................................................................................................................... 70
11.1
Hypervisor settings ..................................................................................................................... 70
11.1.1
Add hypervisors .................................................................................................................................70
11.1.2
Edit hypervisors .................................................................................................................................71
11.1.3
Manage data stores for hypervisors ..................................................................................................71
11.1.4
Manage networks for hypervisors .....................................................................................................72
11.1.5
Delete hypervisors .............................................................................................................................72
11.1.6
User hypervisor permissions .............................................................................................................72
11.2
Hypervisor zone settings ............................................................................................................. 73
11.2.1
Create hypervisor zones ....................................................................................................................73
11.2.2
View, edit and delete hypervisor zones ............................................................................................73
11.2.3
View hypervisor zone details .............................................................................................................73
11.2.4
Add hypervisors to a hypervisor zone ...............................................................................................74
11.2.5
Remove hypervisors from a hypervisor zone ....................................................................................74
11.2.6
Manage data stores for hypervisor zones .........................................................................................74
11.2.7
Manage networks for hypervisor zones ............................................................................................75
11.2.8
User hypervisor zone permissions.....................................................................................................75
11.3
Data store settings ...................................................................................................................... 76
11.3.1
Add data stores .................................................................................................................................76
11.3.2
View data stores ................................................................................................................................76
11.3.3
Edit data stores..................................................................................................................................76
11.3.4
Delete data stores .............................................................................................................................77
11.3.5
User data store permissions ..............................................................................................................77
11.4
Data store zone settings ............................................................................................................. 77
11.4.1
Create a data store zone ...................................................................................................................77
11.4.2
View, edit and delete data store zones .............................................................................................78
11.4.3
View data store zone details .............................................................................................................78
11.4.4
Add data stores to a data store zone ................................................................................................78
11.4.5
Remove data stores from a data store zone .....................................................................................78
11.4.6
User data store zone permissions .....................................................................................................79
11.5
Backup servers ............................................................................................................................ 79
11.5.1
Create backup server.........................................................................................................................81
5
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.5.2
Edit backup server .............................................................................................................................81
11.5.3
Manage backups for backup server ..................................................................................................81
11.5.4
Delete backup server .........................................................................................................................82
11.5.5
User backup server permissions ........................................................................................................82
11.6
Backup server zones ................................................................................................................... 82
11.6.1
Create backup server zone ................................................................................................................82
11.6.2
View backup server zone details .......................................................................................................83
11.6.3
Edit backup server zone ....................................................................................................................83
11.6.4
Delete backup server zone ................................................................................................................83
11.6.5
Add a backup server to backup server zone......................................................................................83
11.6.6
Remove a backup server from a backup server zone ........................................................................84
11.6.7
User backup server zone permissions ...............................................................................................84
11.7
Disk settings ................................................................................................................................ 84
11.7.1
View and edit disks ............................................................................................................................84
11.7.2
User disk permissions ........................................................................................................................85
11.8
Resolver settings ......................................................................................................................... 85
11.8.1
View resolvers ...................................................................................................................................85
11.8.2
Edit resolvers .....................................................................................................................................86
11.8.3
Deleting resolvers ..............................................................................................................................86
11.8.4
User resolver permissions .................................................................................................................86
11.9
Network settings ......................................................................................................................... 86
11.9.1
View networks ...................................................................................................................................87
11.9.2
Add new networks.............................................................................................................................87
11.9.3
Add IP address(es) to a network .......................................................................................................87
11.9.4
Edit networks.....................................................................................................................................88
11.9.5
Delete networks ................................................................................................................................88
11.9.6
User network permissions .................................................................................................................89
11.10
Network zone settings ............................................................................................................ 89
11.10.1
Create network zones........................................................................................................................89
11.10.2
View, edit and delete network zones ................................................................................................89
11.10.3
View network zone details ................................................................................................................90
11.10.4
Add networks to a network zone ......................................................................................................90
11.10.5
Removing networks from a network zone ........................................................................................90
11.10.6
User network zone permissions ........................................................................................................90
6
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.11
Schedule settings .................................................................................................................... 91
11.11.1
View, edit and delete schedules ........................................................................................................91
11.11.2
User schedules permissions ..............................................................................................................91
11.12
Autobackup preset settings .................................................................................................... 92
11.13
License..................................................................................................................................... 92
11.14
Configuration settings ............................................................................................................. 93
11.14.1
Edit System configuration .................................................................................................................93
11.14.2
Edit Backup/Template configuration.................................................................................................94
11.14.3
Edit Interface configuration...............................................................................................................95
11.14.4
Edit Defaults configuration ................................................................................................................96
12.
Localization and customization .................................................................................. 98
12.1
Languages.................................................................................................................................... 98
12.1.1
Add custom languages ......................................................................................................................98
12.1.2
Enable a custom language for a specific user....................................................................................99
12.2
Currencies ................................................................................................................................... 99
12.2.1
Add currencies ...................................................................................................................................99
12.2.2
Edit/delete currencies .....................................................................................................................100
12.3
Look & feel ................................................................................................................................ 101
12.4
User customization and localization permissions ..................................................................... 102
12.5
Localization and Customization Search .................................................................................... 103
13.
Users....................................................................................................................... 105
13.1
User accounts............................................................................................................................ 105
13.1.1
View user account details................................................................................................................105
13.1.2
View, add & edit user payments .....................................................................................................106
13.1.3
View user account billing statistics ..................................................................................................107
13.1.4
Whitelist IPs .....................................................................................................................................107
13.1.5
Log in as a user ................................................................................................................................108
13.1.6
Add new users .................................................................................................................................108
13.1.7
User Additional Fields ......................................................................................................................109
13.1.8
Edit users .........................................................................................................................................109
13.1.9
Add SSH key .....................................................................................................................................109
13.1.10
Delete users .....................................................................................................................................110
13.1.11
Suspend and activate users .............................................................................................................110
7
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
13.2
User groups ............................................................................................................................... 110
13.2.1
Add a user group .............................................................................................................................110
13.2.2
Assign a new user to a group ..........................................................................................................110
13.2.3
Change a user's group .....................................................................................................................111
13.2.4
View/edit/delete user group ...........................................................................................................111
14.
Billing plans, resource limits and roles ..................................................................... 112
14.1
Billing plans ............................................................................................................................... 112
14.1.1
Create billing plans ..........................................................................................................................112
14.1.2
Set billing plan prices and resource limits .......................................................................................112
14.1.3
Assign users to billing plans .............................................................................................................116
14.1.4
Change a user’s billing plan .............................................................................................................116
14.1.5
Edit, copy and delete billing plans ...................................................................................................117
14.2
Roles and permissions............................................................................................................... 117
14.2.1
Add new roles ..................................................................................................................................117
14.2.2
Edit roles ..........................................................................................................................................117
14.2.3
Delete roles .....................................................................................................................................118
15.
Tools ....................................................................................................................... 119
15.1
Alerts ......................................................................................................................................... 119
15.2
Usage Statistics ......................................................................................................................... 119
15.3
Sysadmin Tools.......................................................................................................................... 120
16.
Advanced tasks ....................................................................................................... 121
16.1
Reset administrator password .................................................................................................. 121
16.2
Add IPs in Windows .................................................................................................................. 121
16.3
Create new Linux/Windows templates..................................................................................... 122
17.
Help ........................................................................................................................ 123
18.
Document revisions................................................................................................. 124
8
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1. About this guide
This guide provides a brief overview of OnApp’s cloud deployment and management software, and
explains in detail how to configure and manage your cloud using the OnApp Control Panel interface.
Key to interface and icons
This guide refers to various elements of the OnApp interface, including Menu items, Tabs, Icons and
Buttons. These are illustrated below. The specific functions available depend on the permissions
assigned to the user currently logged in. Users without full rights will not be able to access all
functionality, or may be denied access to functions they can see.
Menu
Tabs
Buttons
The following icons are referred to in this guide:
Edit
Schedules
Backups
Statistics
Delete
Suspend user
Make public
Add
Activate user
Log in as
9
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Icons
2. OnApp overview
OnApp software enables hosting providers to turn their existing infrastructure (or any commodity
hardware) into a single pool of resources (“a cloud”) which can then be sold on a utility basis.
2.1
Main components & features
OnApp handles cloud deployment, VM deployment, resource allocation, server and SAN management,
failover, user management and billing. Here’s a brief description of the main components and features
of an OnApp installation:
Servers
There are two required server types in an OnApp configuration – hypervisor servers and the Control
Panel server. OnApp also requires storage devices for templates, virtual machines and backups. These
may also be servers.
Hypervisor servers
The hypervisor server is a Xen- or KVM-powered hypervisor running on bare metal with CentOS Linux as
the management operating system. This ensures highly efficient use of available hardware, and
complete isolation of virtual server processes. The management OS controls virtual machines as well as
handling network/disk connectivity, monitoring, IP address anti-spoofing and more.
Hypervisor servers:
•
•
•
•
•
Provide system resources such as CPU, memory, and network
Control the virtual differentiation of entities such as virtual machines and application data being
delivered to cloud-hosted applications
Take care of secure virtualization and channeling of storage, data communications and machine
processing
Can be located at different geographical zones
Can have different CPU and RAM
Control Panel server
The Control Panel server (sometimes known as the Base server) hosts the OnApp interface and manages
all the processes happening to OnApp.
The Control Panel server:
•
•
•
•
Provides a web-based user interface
Assigns a virtual machine to a hypervisor server
Creates/starts/stops/deletes virtual machines
Resizes CPU and storage
10
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
•
•
•
•
Manages virtual machines through a console session
Creates backups of virtual machines
Allows virtual machines to be restored from a backup
Allows the creation of custom templates from virtual machine backups, for future deployment of
new virtual machines
Displays your CPU usage and network utilization
Storage devices
We recommend that you set up a separate server with SSH (preferred) or NFS (for high end NAS) to
store templates and backups. However, in a small installation you can use SSH storage on separate disks
in the Control Panel server.
You will also need a server to store your virtual machines. For storage you can use any block based
storage, such as local disks in hypervisors, an Ethernet SAN such as iSCSI or AoE, or hardware (fiber)
SAN. Storage Area Networks are core segments of the cloud system, and OnApp can control their
physical and virtual routing. This control enables seamless SAN failover management, including SAN
testing, emergency migration and data backup.
Networks
With OnApp you can create complex networks between virtual machines residing on a single host, or
across multiple installations of OnApp. You can configure each virtual machine with one or more virtual
NICs, each with its own IP and MAC address, to make them act like physical machines.
OnApp ensures that each customer has their own VLAN – their own virtual network, isolated and secure.
They can only see their traffic, even if they share the same physical server as another customer. OnApp
enables you to modify network configurations without changing actual cabling and switch setups.
Templates
An OnApp template is a pre-configured OS image that is used to build virtual machines. There are two
types of templates for virtual machine deployment in OnApp: downloadable templates provided by
OnApp, and custom templates you create from existing virtual machines. The OnApp template library
includes a wide range of VM templates for various flavors of Windows and Linux, both 32- and 64-bit.
 At present OnApp does not support VMs/templates with Active Directory Domain Controllers.
Virtual Machines
OnApp gives you complete control of your virtual machines (VMs), and all files and processes running on
those machines. You can start, stop, reboot and delete virtual machines. You can move VMs between
hypervisors with no downtime. OnApp also lets you perform automatic and manual backups, and
restore VMs in case of failure.
11
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
When creating a virtual machine, you can choose a hypervisor server with data store attached if you
wish. If not, the system will search for hypervisors available that have sufficient RAM and storage for
that virtual machine, and choose the one with the lowest (but sufficient) amount of RAM available.
You can monitor the CPU usage of each virtual machine, and the network utilization of each network
interface. This helps you decide if and when to change the resources available to each VM. OnApp also
provides detailed logs of all tasks which are running, pending, have failed or have been completed.
Scalability
OnApp is a highly scalable cloud deployment and management tool that allows you to add and remove
hypervisors, data stores and resources at any time to meet your changing needs. You can add more
CPUs and memory to a specific virtual machine to increase its capacity, and increase the total available
RAM and CPU by adding new hypervisors.
High availability
OnApp provides high reliability and availability in a number of ways:
•
•
•
•
Hypervisor failover management system — If a hypervisor fails, OnApp’s self-healing architecture
automatically moves virtual machines to another box. Hypervisors regularly update the control
panel with their status. If they do not return valid data for a period of time, they are marked as
offline, and an appropriate new hypervisor is selected for a virtual machine to boot there. This
process is fully automatic but may take several minutes. When the crashed hypervisor comes
online, it will be again available, but virtual machines previously migrated from it will not be
migrated back.
Virtual machines — OnApp keeps virtual machines running even if the Control Panel server goes
offline. In such an event, you won’t be able to perform any actions to virtual machines until access
to the Control Panel server has been restored.
Backup mechanisms — There is storage security provided by the backup mechanisms on both
virtual and physical storage. Both automatic and manual backups provide the ability to capture the
current state of a virtual machine. You can always restore the virtual machine from a backup if
needed. There are also emergency mySQL backups as part of the disaster recovery system.
Database replication (planned feature) — OnApp will feature database replication which includes
the creation and maintenance of multiple copies of the same database. Database replication
improves availability: when your main database becomes unavailable, the slave copy will take over.
Security
OnApp provides multiple layers of security:
•
Hypervisor — OnApp is a multi-hypervisor cloud system that currently supports Xen and KVM
(support for VMware, Hyper-V and other hypervisors will be added in future releases). The first
layer of security is provided by the hypervisor itself. For example, Xen provides full isolation
between virtual machines and allows each virtual machine to access its own disk only. When a
12
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
•
•
2.2
virtual machine makes a request for data, it gets redirected to its correct disk. Xen dictates which
virtual machines and resources are allowed to run or be accessed at any given time.
Firewall — In addition to the hypervisor security mechanism, there is also an anti-spoof firewall
which resides on the server where you store virtual machines. The firewall enables the
management operating system of the hypervisor to examine packets entering and leaving the
virtual machine. It blocks packets that do not belong to the virtual machine and accepts those
meeting the rules. The firewall prevents IP spoofing and packet sniffing.
Control Panel — Virtual machines in OnApp are completely controlled by the administrator.
Administrators have full root (Linux) or Administrator (Windows) access to accounts and machines.
The Control Panel also lets you assign different levels of user access to virtual machines,
hypervisors, consoles and disks.
Network Security is provided by completely isolating virtual machines from each other using
VLANs. Each customer can be assigned their own VLAN, so using their private IP they can only
access addresses within that VLAN. Using a public IP, they can only access those boxes which are
manually specified, using the Integrated Console.
API and integrations
Our comprehensive RESTful xml and JSON API enables full integration of OnApp with third party
applications.
OnApp integrates with popular billing applications like HostBill, Ubersmith and WHMCS, and with PHP
applications via a wrapper (integration modules are available from the OnApp website:
http://www.onapp.com/support/downloads).
The API makes integration straightforward for other applications, too, including other control panels,
CRM and support and billing systems.
For more detail on the API, including a guide with code samples, see
http://www.onapp.com/support/documentation/
2.3
Hardware & software requirements
An OnApp installation requires at least two physical machines – one for the Control Panel server, and
the other for the Hypervisor server. You can have as many Hypervisor servers as you need. You will also
need storage for your virtual machines (a data store), and we recommend that you set up a separate
server for storing backups and templates.
These are the minimum requirements for a small cloud. For a larger deployment, OnApp’s technical
team will advise you on the best possible setup.
Hypervisor servers
•
x64 platform with AMD-V/VT-x hardware virtualization support enabled
13
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
•
•
•
Quad Core 2Ghz+ CPU
8GB+ RAM
3x Gig network interface cards (4 recommended)
30 GB of free disk space (SSD Recommended)
Control Panel server
•
•
•
•
Dual or Quad Core 2Ghz+ CPU
8GB RAM (16GB+ recommended)
100GB Raid 1
2x Gig network interface cards
Backup server
•
•
1GB RAM
2TB+ NAS (alternatively, a large hard disk can be used on the Control Panel server for backups)
Data stores
•
1TB Block Storage (iSCSI, AoE, Fiber — can even be on a shared SAN)
14
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
2.4
Architecture
OnApp software transforms your server and storage hardware into a virtual network system that
employs a Xen Hypervisor virtualization architecture to control virtual protocols and security. With this
infrastructure in place, OnApp users can host a multitude of secure cloud servers with more fluidity and
control. A schematic of the OnApp architecture is shown below.
15
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
3. Dashboard
The OnApp dashboard is displayed after logging into the system. It provides three main views of usage
and activity: Statistics, Cloud and Account. Click the icons by the silver dial to change the view.
Statistics
Cloud
Account
Statistics
• This is the default view, showing the total Disk Space (sum total of all data store capacities) and
RAM (sum total of all hypervisors RAM resources) in the cloud, along with the space remaining.
Total Disk space and RAM for a normal user are set by the billing plan limits.For administrators, the
bars show the disk space usage (sum total of all VM disks capacities + zombie disks capacities) and
RAM usage (sum total of RAM allocated to VMs + RAM allocated to zombie VMs) of the entire
cloud.
• For normal users, the disk and RAM bars are segmented: each segment represents a different
virtual machine. Mouse over a segment to see its details.
Cloud
Clicking this icon shows details of the entire cloud:
•
•
For normal users, it shows the total number of virtual machines, CPUs, CPU priority, RAM and disk
space they’re using.
For administrators, it shows the total number of virtual machines, hypervisors, data stores and IPs
used by the entire cloud.
16
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Account
Clicking this icon shows details of that user’s account:
•
For normal users, it shows their user name, the outstanding amount of payments owed, and
payments made.
For administrators, it shows their user name, license key, the number of cores the license covers,
and the license renewal date.
•
Transaction log
At the bottom of the screen in each case is a record of recent transactions. To view details of a
transaction, click its Ref number.
•
•
Normal users see recent transactions for their virtual machines.
Administrators see recent transactions for the entire cloud.
3.1
User profile
Click the My Profile button at the top of the Control Panel screen to view details of the user account
you’re currently logged in with. This includes details of user name, login, email, billing plans and prices,
and the roles currently assigned to this account. It also includes API Key information.
Administrators can view details of all account profiles through the Control Panel’s Users & Groups menu.
3.1.1 API Key
The API Key is used instead of the normal username/password login combination during API operations.
A key is generated for each user by the system when the user account is created. To change the key,
click the Change Key button. A new key will be generated, and you’ll be taken back to the main
Dashboard screen.
3.2 Cloud search tool
The search tool in the left-hand menu allows you to search your cloud for:
•
•
•
•
•
•
•
•
•
IP addresses
Usernames
Users’ full names (first or last name, in any order)
VM labels
VM identifiers
Disk identifiers
Log IDs
Backups
Template labels
17
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
•
•
Permission labels/identifiers
OnApp page URLs/titles
Any word from locale texts (yellow help box texts), if other search results are not successful
Type what you want to search for into the search box, and press Return.
The results are organized according to the menu item they refer to, e.g., Pages, Virtual Machines, Users,
Locales, etc. Click a search result to open the relevant details page.
18
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4. Virtual machines
Virtual machines are based on templates and are deployed on hypervisors. Hypervisors give them access
to CPU, disk and network resources. OnApp Cloud gives you high-end cloud management features
including:
•
•
•
•
•
•
•
•
4.1
Automatic VM deployment
Automatic IP allocation
Setting firewall rules
Manual build option
Customizable backups
Hot and cold migration
VM performance monitoring
Load balancing and autoscaling
Manage VMs
Administrators in OnApp have full control over the lifecycle of Virtual machines. Virtual Machines can be
in the following states:
o
o
o
o
o
o
o
o
o
Created - A machine is created when you successfully Add New Virtual Machine from the Virtual
Machines menu, having selected its template and set its properties, resources and network
requirements.
Build - A Virtual Machine must be built after it is created. Building is the process of actually
allocating the physical resources specified during its creation. This can be done manually, or
automatically if you check the Build virtual machine automatically box during the creation
process.
Powered on - A power on starts the virtual machine, its operating system and processes.
Powered off - If the operating system cannot be stopped, it will be forcefully terminated.
Shut down - A shut down will attempt to gracefully stop a virtual machine and its operating
system, which typically involves terminating all running applications.
Rebooted - Rebooted means a virtual machine has been shut down, and then powered on again.
Deleted - When a virtual machine is deleted, its backups are still stored on the server and can be
restored if required.
Re-built - To rebuild a virtual machine means to reinstall the template and reconfigure the
resources and network. All data will be lost.
Failed - A failed virtual machine is one that is down, for example because of hardware or
network problems. You will have to start the machine manually when those problems have been
solved.
19
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4.1.1 Create VMs
Virtual machines are created from templates. To create a virtual machine:
1. On your Control Panel’s dashboard, click the Create New Virtual Machine button (or go to the
Virtual Machines menu, and click the Add New Virtual Machine button).
2. Fill in the form that appears:
Properties
o Give your virtual machine a label and a hostname. The hostname should consist of
letters [A-Za-z], digits [0-9] and dash [ - ]. For more info on hostname validation,
refer to RFC standard documentation.
o Choose a hypervisor zone to build this VM on.
o Choose a specific hypervisor to build this VM on.
o Give your virtual machine a secure password. It can consist of 6-32 characters,
letters [A-Za-z], digits [0-9], dash [ - ] and lower dash [ _ ]. You can use both lowerand uppercase letters.
Template
If there are fewer than 10 templates available in the system, they will all be listed in the
Templates drop-down box. Select the template you need.
If there are more than 10 templates available, fill in the following fields:
o
o
o
Operating system - choose an OS from the drop-down box (Windows, Linux or
FreeBSD)
Distribution - choose a template Distribution
Template - choose a specific template from the list.
Windows Licensing Type
This option only appears if your billing plan allows it, and if the relevant licensing options have
been configured for the template group this template belongs to.
If this option is available, choose the license type you require:
o
o
For the KMS type, choose the licensing server
For your own license, type your license key
If you don't specify the licensing type, MAK licensing will be set by default.
Resources
o Set the resources needed for this VM: RAM, CPU cores, CPU priority.
 The amount of CPU resource a VM is given is the CPU priority (you can think of this as its
“share percentage”) multiplied by the number of cores allocated to that VM. This is a minimum
20
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
number – clients can burst over it, up to 100% multiplied by the number of cores. For example,
on a hypervisor with 3GHz CPU cores:
•
•
•
100% x 1 core = 3GHz (burstable to 3GHz)
10% x 2 cores = 600MHZ (burstable to 6GHz)
5 % x 4 cores = 600MHz (burstable to 12GHz)
By default, OnApp allows overselling of cloud resources. For example, OnApp will allow users to
create 5 VMs with 100% CPU priority/1 CPU core on a hypervisor with a 4-core CPU. In this
example, OnApp would reduce the guaranteed CPU for each VM.
 If you build a VM on a KVM hypervisor, the CPU priority settings will be disabled and CPU
priority value will be 100 by default.
Primary disk
o Choose a data store zone for this VM’s primary disk.
o Set the primary disk size.
Swap disk
o Choose a data store zone for this VM’s swap disk.
o Set the swap disk size.
 There is no swap disk for Windows-based VMs. In all other cases, swap disk size must be
greater than zero.
Network configuration
o Choose a network zone and set the port speed for this VM.
 You can’t select unlimited port speed if the Network Zone is not selected. In this case the port
speed will be 1 by default.
It's possible to create virtual machine with unlimited network speed without selecting a network
zone only if you have only one Network Zone assigned to your billing plan.
o
If the option is available, you can also assign an IP address for the VM from the
drop-down menu. Indicate HV and network to have the list of available IPs.
 This option is enabled via the “Specify a network address on new VM page” checkbox on the
Settings -> Configuration settings screen (under the System tab).
Automation settings
o Tick the Build Virtual Machine Automatically box if you want the system to
automatically build the VM. If you leave this box blank, you will have to build your
machine manually after it is created.
o Tick the Automatic backup box if you want this VM to be backed up automatically
(according to the backup settings configured in the Settings/Autobackup Presets
menu)
21
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
Tick the Enable autoscale box if you wish to set autoscaling rules for this VM.
3. Click the Create Virtual Machine button to start the creation process. You will be taken to the
virtual machine details screen.
 OnApp must be configured properly before VMs can be created. You must:
•
•
•
•
•
•
•
Have at least one data store configured and assigned to a data store zone (Settings -> Data
Stores -> Add New Data Store)
Have at least one network configured and assigned to a network zone (Settings -> Networks
-> Add New Network)
Have at least one hypervisor configured and online (Settings -> Hypervisors -> Add New
Hypervisor)
Have at least one hypervisor assigned to a hypervisor zone (Settings -> Hypervisor Zones ->
Choose a zone -> Press "+" sign next to an unassigned Hypervisor)
Have at least one data store attached to a hypervisor (Settings -> Hypervisors -> [choose a
hypervisor] -> Manage Data Stores)
Have at least one network attached to a hypervisor (Settings -> Hypervisors -> [choose a
hypervisor] -> Manage Networks)
Have assigned a billing plan to the user creating the VM (Users and Groups -> Edit [user])
4.1.2 Build VMs manually
If you haven’t checked the Build Virtual Machine Automatically option during the VM creation process,
you will have to do this manually after the VM has been created. Building a virtual machine is the
process of allocating physical resources to that VM.
To build a virtual machine manually:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
On the screen that appears, scroll down to the Actions section and click Build Virtual Machine.
On the screen that pops up, use the drop-down menu to choose a template with which to build
the VM.
5. Tick the Required Start Up box to have your VM started automatically after it is built.
6. Click the Build Virtual Machine button to finish.
4.1.3 View VMs
To view all virtual machines deployed in the cloud:
22
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1. Go to your Control Panel’s Virtual Machines menu to see an overview of all virtual machines in
the cloud: their name, IP addresses, power status (with on/off buttons), and allocated disk size
and RAM.
2. From here you also have quick access to the Statistics screen for each virtual machine, where
you can see its CPU usage, and the Backups screen for each machine. Click the relevant icon in
each case.
To see detailed information about a specific virtual machine:
1. Go to your Control Panel’s Virtual Machines menu.
2. On the screen that appears, use the top menu to manage your virtual machines. The schematic
menu navigation with the references to appropriate sections is represented below.
Overview
Properties
CPU Usage
Billing Statistics
Autoscaling
Console
show VM information and gives access to most of the
VM actions
Networking
Network Interfaces
Firewall
IP Addresses
manage VM network
Storage
Disks
Backups
give access to VM disks and backups
4.1.4 VM properties
To access main actions and information on VMs, go to Overview -> Properties tab.
VM information gives general overview of the VM details:
o
o
o
o
o
o
o
o
Hostname and login
Power status & On/Off buttons
Template this VM is built on
Resources for this VM
Hypervisor, network and IP
Owner
Prices per hour
Activity log
Actions menu enables you to perform main action on VMs (the exact list shown depends on the VM
status):
23
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
Startup Virtual Machine - Queues a start-up action for a VM that’s currently
powered off.
Startup on Recovery - Starts the VM in Recovery mode with a temporary login
(“root”) and password (“recovery”).
Reboot Virtual Machine - Powers off and then restarts the VM.
Reboot in Recovery - Powers off and then restarts the VM Recovery mode with a
temporary login (“root”) and password (“recovery”).
Edit Firewall Rules – Redirects you to Networking -> Firewall menu, where you can
set firewall rules.
Edit Administrator’s Note – Makes an optional note, which will be displayed in VM
Information.
Rebuild Network - Rebuilds network join, added to this VM (required after allocating
new IP addresses).
Set SSH keys –assigns SSH keys of the admin and a VM owner to the VM. If a VM
owner does not have any SSH keys, the system will assign only admin keys.
Suspend Virtual Machine - Stops a VM, changes its status to suspended and disables
all the other actions on VM, unless unsuspended.
Migrate Virtual Machine - Pops up the VM migration dialogue, enabling you to move
the VM to a different hypervisor.
Reset Root Password - Resets the root password for this VM (the password is
displayed in VM Information).
Rebuild Virtual Machine - Pops up the VM rebuild dialogue, where you can rebuild
the VM on the same (or another) template. All data will be lost!
Adjust Resource Allocation - Opens the Adjust Resource Allocations screen for
resizing this VM, where you can change number of CPUs, size of RAM, CPU priority
and change VM label. Note, that resizing the VM may lead to reboot (depends on
the template)!
Segregate Virtual Machine – Pops up a drop-down menu where you may choose a
VM to keep away from (your VM will never be booted on the same hypervisor as
specified VM).
Change Owner - Pops up a dialogue box with a drop-down of all users on the
system, enabling you to pass ownership of the VM to the user selected from the list.
Shut Down Virtual Machine – Pops up a dialog box, where you can either Shut Down
VM (terminates the VM gracefully), or Power Off VM (terminates the VM forcefully).
Delete Virtual Machine - Removes the VM from the system.
Go to Load Balancer – (displayed in case this VM is a node of a LB) – Redirects to the
Load Balancer screen.
4.1.5 Adjust Resource Allocation
You can adjust CPU and RAM resources for all VMs. Depending on the OS it is built on, some VMs can
have their CPU and RAM resized without needing to be powered off (“resize without reboot”).
24
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
 Windows 2008 and Windows 7 VMs can be resized without rebooting: Windows 2003 requires a
reboot. With Linux it depends on kernel. E.g. CentOS with kernel 2.6.18 can be resized; Ubuntu cannot.
Whether a template allows resize without reboot is shown on the main Templates menu screen.
To adjust VM CPU & RAM resources:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the machine you want to resize, to show its details screen.
Click the Adjust Resource Allocation link in the Actions section of the details screen.
Change CPU core/priority and RAM values , and click the Save Virtual Machine button:
o If the VM template allows resize without reboot, the resize should be completed
automatically: you will be returned to the VM details screen and see a message indicating
the resize was successful.
o If the template does not allow this, you will be asked to confirm that the VM will need
rebooting so that the resize can take place.
4.1.6 Migrate VMs
OnApp allows hot and cold migration of virtual machines between hosts that share common data stores
(or data store zones). Hot migration means moving virtual machines that are running, while cold
migration means moving virtual machines that are shut down.
 Hot migration is not available for virtual machines based on Windows 2003. They must be cold
migrated (that is, once they have been shut down).
To hot migrate a virtual machine:
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you want to migrate.
In the Actions section, click the Migrate Virtual Machine link.
In the window that appears, choose the target hypervisor from the drop-down menu.
Click the Start to Migrate button.
After migration, the Power status of your virtual machine remains as it was before the move. If you
migrate a virtual machine that’s running, the whole process is almost unnoticeable.
OnApp administrators can control user access over virtual machine migration. Using OnApp permissions,
you can allow/forbid users to perform migration of all virtual machines, or their own machines only. This
is handled in the Control Panel’s Users and Groups menu.
4.1.7 Autoscale VMs
VM autoscaling allows you to automatically increase the RAM, CPU and disk size of a virtual machine.
VM resources are scaled based on rules you specify. For example, you can set up a rule that will add
25
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1000MB of memory to a VM if RAM usage has been above 90% for the last 10 minutes - but add no
more than 5000MB in total in 24 hours. Once the RAM, CPU and disk size are increased, the values are
not scaled down.
 For Linux-based VMs only.
If the VM is based on Xen and the template allows resizing without reboot - see the Adjust Resource
Allocation section – then virtual machine RAM and CPU will be increased without rebooting the VM.Disk
space autoscaling requires a VM reboot.
If you autoscale a VM’s memory to a value greater than current VM RAM x 16 (which is a max_mem
parameter in a configuration file and database), the VM will be rebooted anyway, regardless of the
template it is built on.
To configure autoscaling:
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the appropriate VM.
On the page that follows, click the Autoscaling tab.
Add autoscaling rules, explained below:
• If RAM usage exceeds X% for a specific time period, add Y MB – but no more than Z MB
in a 24 hour period.
• If CPU usage exceeds X % for a specific time period, add Y% - but no more than Z% in a
24 hour period.
• If disk usage exceeds X % for a specific time period, add Y GB - but no more than Z GB in
a 24 hour period.
Click Apply.
To delete an autoscaling rule:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the appropriate VM.
On the page that follows, click the Autoscaling tab.
Click Delete. This will delete all autoscaling rules.
4.1.8 Segregate VMs
If required, you can instruct OnApp to make sure a VM is never booted on the same hypervisor as
another specific VM. This may be important if, for example, you have two name servers or a load
balanced web server, and you need to keep VMs on separate physical machines.
To isolate one VM from another:
1. Go to your Control Panel’s Virtual Machines menu.
2. Click the label of the virtual machine you want to segregate.
26
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
3. On the screen that appears, scroll down to the Actions section and click Segregate Virtual
Machine.
4. On the screen that pops up, use the drop-down menu to choose a VM you want to keep away
from.
5. Click the Segregate VM button to finish.
4.1.9 Set VIP status for VMs
If a hypervisor fails or reboots, the system migrates virtual machines to another server, one VM at a
time. The order VMs are migrated in is random. However, you can give a virtual machine “VIP” status,
and this will give that VM priority in the migration queue.
To set or remove VIP status for a VM:
1. Go to your Control Panel’s Virtual Machines menu.
2. Use the VIP button next to a VM to switch VIP status on and off.
4.1.10 Add a VM administrator’s note
You can add notes to your virtual machines with brief comments or reminders. For example, you can
add a note indicating the first template from which this VM was built, or the date of VM creation.
To add (or edit) an administrator’s note:
1. Go to your Control Panel’s Virtual Machines menu.
2. Click the label of the virtual machine you’re interested in.
3. On the screen that appears, scroll down to the Actions section and click Edit Administrator’s
note.
On the screen that pops up, enter your note and click Save Note.
4.1.11 VM integrated console
OnApp includes an integrated VNC console that gives users direct access to their virtual machines
through the OnApp Control Panel, if their user role permits. Administrators can access all virtual
machine consoles for support and troubleshooting purposes.
The console connects the user’s browser to the VNC port made available via the hypervisor for the guest
console. Both the administrator and the end user web UIs offer a console connection, regardless of the
OS.
27
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4.1.12 VM transactions and logs
The system records a detailed log of all the transactions happening to your virtual machines. The list of
transactions logged by the system includes:
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
Provision virtual machine
Startup virtual machine
Stop virtual machine
Resize virtual machine without reboot
Configure Operating System
Build disk
Resize disk
Format disk
Destroy disk
Take backup
Convert backup
Restore backup
Destroy backups
Destroy virtual machine
Destroy template
Download template
Update firewall
To view transactions for a virtual machine:
1. Go to your Control Panel’s Virtual Machines menu.
2. Click the label of the virtual machine you’re interested in.
3. The details screen for that virtual machine shows recent transactions in the VM Activity Log
section.
To cancel pending tasks, click Cancel All Pending Tasks for this virtual machine.
4.2
Manage VM networks
The Networking tab in the Virtual Machines menu enables you to manage network interfaces, allocate IP
addresses and set firewall rules for VMs.
4.2.1 Configure network interface
The Networking -> Network Interfaces menu shows the virtual network interfaces allocated to this VM.
Network interfaces join the physical network to the VM.
When you create a VM a network interface is added automatically. This network interface will be
assigned to the existing physical network using a spare IP (IPv4) and will be set primary by default.
28
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
OnApp supports IPv4 and IPv6. Since not every application supports IPv6, at least one IPv4 address must
be allocated to a VM’s primary network interface.
To see the list of all network interfaces allocated to the VM:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Networking -> Network Interfaces tab.
On the page that follows you will see the following fields:
•
•
•
•
Interface – optional label of the network interface.
Network join – name of the network and a hypervisor or hypervisor zone this network is
joined to.
Port speed – the speed set to the interface.
Primary interface – indication whether the interface is primary or not.
Here you can also view Interface Usage, Edit and Delete network interface (using icon controls) and Add
a new network interface using the button at the bottom of the screen.
To add a network interface:
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Networking -> Network Interfaces tab.
Click the Add New Network Interface button.
On the screen that appears – input values for the following parameters:
• Label – a human-friendly name for the new interface.
• Physical Network – choose a network join from the drop-down menu, which lists
network joins assigned to the hypervisor/hypervisor zone on which the VM runs).
• Port speed – set port speed in Mbps, or make it unlimited.
6. Click the Add Network Interface button
To edit network interface label, port speed or set it as primary (if none is marked as primary), click Edit
icon next to the appropriate network interface. This does not require a reboot.
To delete a network interface, click the Delete icon next to the interface you want to delete.
 To run the VM, at least one network interface with an assigned IP address (or addresses) is required!
To allocate another physical network, add a new network interface.
4.2.2 Set firewall rules
With OnApp you can set firewall rules for the network interfaces of virtual machines. There are two
types of firewall rule:
29
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
•
ACCEPT – defines the packets that will be accepted by the firewall
DROP – define the packets that will be rejected by the firewall
To configure a rule:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the VM for which you want to configure a firewall rule.
Click the Networking -> Firewall tab.
On the page that appears set the following:
a. Choose the network interface.
b. Specify if the rule defines requests that should be accepted or dropped.
c. Set the IP address for which this rule is active.
• Leave the empty field to apply this rule to all IPs
• Enter hyphen-separated IPs to apply the rule to an IP range
(e.g. 192.168.1.1-192.168.1.10)
• Enter the IPs with slash to apply the rule to CIDR (e.g. 192.168.1.1/24)
d. Set the port for which this rule will is effective.
• Leave the empty field to apply the rule to all ports
• Enter colon-separated ports to apply the rule to a port range (e.g. 1024:1028)
• Enter comma-separated ports to apply the rule to the list of ports
(e.g. 80,443,21)
e. Choose the protocol (TCP or UDP).
5. Save the rule. The rule will be saved in the UI, but the transaction won’t be started until you click
the Apply Firewall Rules button.
6. To start the transaction which runs firewall rules for a VM, click Apply firewall rules button.
 Example: the Int1 ACCEPT 122.158.111.21 22 TCP firewall rule means that the Int1 network interface
will accept all requests and packets addressed from 122.158.111.21 using the TCP protocol on port 22.
The Int2 DROP 122.158.111.21 22 UDP firewall rule means that the Int2 network interface will reject all
requests and packets from 122.158.111.21 using the UDP protocol on port 22.
PLEASE NOTE: if you reboot a Xen-based VM from the console, the firewall rules for this VM will be lost,
and you will need to update the firewall rules again.
4.2.3 Allocate IP Addresses
In the Networking -> IP Addresses tab you can find the list of assigned IP addresses, allocate new IP
addresses and rebuild a network.
To allocate a new IP Address to the VM:
30
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Networking -> IP Addresses tab.
Click the Allocate New IP Assignment button.
Select a network interface from the drop-down menu (only the network interfaces you added to
the VM will be available)
6. Select an IP address from the IP Pool associated with the network interface.
You may select an IP address that’s already assigned to a VM, but only one VM should be online
at a time.
7. Click the Add IP Address Assignment button.
8. Click the Rebuild Network button to rebuild the network.
 You must rebuild the network after making changes to IP address allocations.
To remove an IP address from a VM:
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Networking -> IP Addresses tab.
Click the delete icon next to the IP address you want to delete.
In the pop up window that appears:
o Choose Delete with Reboot option if you want to reboot a VM and rebuild the network
immediately after deleting the IP address
o Choose Delete without Reboot option if you don’t want to reboot a VM. In this case to
apply the changes, you will have to the reboot the VM additionally.
4.2.4 Display Network Speed for network interfaces on Virtual Machine page
The main Virtual Machines screen displays the network speed of each VM’s primary network interface.
To see the speed of all interfaces assigned to a VM:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machine’s menu.
Click the label of the virtual machine you are interested in.
Click the Networking > Network Interfaces tab.
On the screen that appears, the Port Speed column shows the network speed of the network
interface.
4.2.5 Edit virtual machine network speed
To edit a virtual machine’s network speed:
1. Go to your Control Panel’s Virtual Machines menu.
2. Select the virtual machine you want to change.
31
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
3. Go to the Network -> Network interfaces tab, and edit the network speed accordingly.
4. Click the Save Network Interface button to save changes.
4.3
Manage VM disk space
Virtual machine storage is provided by disks. A disk is a partition of a data store that is allocated to a
specific virtual machine. Disks can be assigned as standard or swap disks (there are no swap disks for
Windows based templates). They can also be set as primary (that is, the disk from which an OS will
boot).
Managing disks for the entire cloud is handled through the Control Panel’s Settings menu. Disks for
individual virtual machines are managed through the Control Panel’s Virtual Machines menu, where you
can:
•
•
•
•
•
•
•
•
see the list of disks allocated to this VM
add new disks
resize a disk
migrate a disk
back up a disk or see already made backups for the disk
set backup schedules
check disk usage statistics (IOPS)
delete a disk
4.3.1 Add disks to a VM
Adding a disk to a virtual machine will require that VM to be rebooted. If a VM is running when you try
to add a new disk to it, you’ll be asked to confirm the reboot. To add a disk to a virtual machine:
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Click a VM’s label to open its details screen.
Click the Storage -> Disks tab.
Click the Add New Disk button.
Fill in the details:
o Choose the Data Store to create a disk on from the drop-down menu.
o Set the desired disk size.
o Specify if this disk is swap space, and requires formatting.
o Specify whether the disk should be added to Linux FSTAB, and its mount point.
 The maximum length of a Mount Point is 256 characters. Spaces are not allowed. No
more than one slash is allowed.
6. Click the Add Disk button to finish.
32
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
 When you add a new disk to a virtual machine it will automatically become available to that
machine.
4.3.2 Resize VM disks
You can easily resize disks when needed. The resize will fail if your current usage is greater than the new
size you request. Note, that any changes on disk size will lead to reboot of your VM.
To change disk size:
1.
2.
3.
4.
5.
6.
Go to your Control Panel’s Virtual Machines menu.
Make sure your virtual machine is powered off, then click its label to open its details screen.
Click the Storage -> Disks tab.
Click the Edit icon next to the disk you want to change.
Enter a new disk size in GB in the field provided.
Click the Save Disk button.
4.3.3 Migrate disks
You can migrate disks of your virtual machines to other data stores, which are allocated to the same
hypervisor or hypervisor zone. Unlike VM migration – disk migration requires reboot of the VM (despite
the template it is based on).
To migrate a disk:
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Make sure your virtual machine is powered off, then click its label to open its details screen.
Click the Storage -> Disks tab.
Click the Migrate icon next to the disk you want to move to another data store.
On the screen that appears select a target data store from a drop-down box.
 You can only migrate disks to data stores in data store zones assigned to your billing plan.
6. Click Start Migrate.
 You cannot migrate a disk to a data store with less capacity than the disk size!
4.3.4 Back up VM disks
To back up a virtual machine:
1. Go to your Control Panel’s Virtual Machines menu.
2. Click the label of the machine you want to back up.
3. Click the Storage -> Disks tab. You’ll see a list of the disks allocated to that virtual machine.
33
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4. Click the Backups icon next to a disk. You’ll see a list of all the backups taken and pending for
that disk, along with the tools to restore backups, delete them, and convert them to templates.
o To make a backup, click the Take Backup button at the end of the list.
o To restore a backup, click the Restore link next to the backup you want to revert to.
o To convert a backup into the custom template, click Convert to template link next to the
backup (see Create custom templates).
4.3.5 Schedule VM backups
In addition to the system autobackup presets, you can schedule backups of VMs (VM disks) as required.
For example, you can set up a schedule to back up your disks once a week.
To add a backup schedule:
1.
2.
3.
4.
5.
6.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you want to schedule a backup for.
Click the Disks tab.
On the screen that appears, click the Schedules icon next to the disk you want to back up.
On the screen that follows, click the Add New Schedule button.
Next, enter duration and choose a period from the drop-down menu: daily, weekly, monthly or
yearly. The duration determines how frequently the backup will take place according to the
period set. For example, duration of 2 and a period of days will take a backup every 2 days.
7. Click the Save button to finish.
Editing and deleting backup schedules is handled through the Control Panel’s Settings menu, in the
Schedules section.
 The combination of Scheduled VM backups and Autobackup Presets provide a great deal of flexibility
in the way backups are handled for the cloud, and for individual VMs. Autobackup Presets can be applied
to all new VMs added to the cloud. Scheduled VM backups enable specific backups to be scheduled for
individual VMs, outside of the autobackup pattern.
4.3.6 Delete VM disks
To delete a disk:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Make sure your virtual machine is powered off, then click its label to open its details screen.
Click the Storage -> Disks tab.
Click Delete icon next to the disk you want to delete.
34
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4.3.7 Manage backups
Backups tab lists all backups performed for the VM (off all disks) and enables you to restore or convert
them into custom templates.
To restore backups or convert them to custom templates:
1.
2.
3.
4.
4.4
Go to your Control Panel’s Virtual Machines menu.
Click the label of the machine you require.
Click the Storage -> Backups tab.
You’ll see a list of all the backups taken and pending for that virtual machine, along with the
tools to restore backups, delete them, and convert them to templates.
o To restore a backup, click the Restore link next to the backup you want to revert to.
o To convert a backup into the custom template, click Convert to template link next to the
backup (see Create custom templates).
VM statistics
For your convenience, the system tracks VM performance and generates statistics on:
•
•
•
•
VM CPU utilization
VM Billing statistics
Interface Usage
Disk IOPS
4.4.1 VM CPU utilization
OnApp tracks CPU usage for virtual machines and generates charts that help analyze VM performance.
The charts show the total CPU usage for all the cores of this particular VM for a specified time period.
The vertical axis has a scale of 0.0-X.0, where 0.0 is 0% and X.0% is 100% of CPU utilization - X depends
on the total number of cores used by the VM. The horizontal axis defines a time period.
To see CPU usage statistics:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Overview -> CPU Usage tab.
On the screen that appears, the top chart shows CPU usage for the last 24 hours. The bottom
chart shows usage for the last three months (if there is enough data). If there less data available,
the chart will show utilization for the time available.
5. Tick the Show in my Timezone box to show bandwidth statistics according to your profile’s
timezone settings.
35
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
6. To zoom into a time period, click and drag in a chart. Click the Show all button to zoom out
again.
 To see what percentage of hypervisor CPU resource a VM takes, go to your Control Panel’s Virtual
Machines menu and click the label of the VM you’re interested in. On the screen that appears, the CPU
priority will show the amount of CPU resource given to this VM.
4.4.2 VM Billing statistics
OnApp has a record of all the charges applied to your VMs for the last three month period. If a virtual
machine was created less than three months ago, statistics are recorded for the VM’s existence to date.
You can view all statistics available, or those for a shorter period by setting a Start and End time.
To view billing statistics for a virtual machine:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Overview -> Billing Statistics tab.
Set Start and End time. By default the statistics are generated for the last three months or the
actual VM existence period.
5. Tick the Show in my Timezone box to show bandwidth statistics according to your profile’s
timezone settings.
6. On the page that appears:
o Date – particular date and time for the generated statistics
o Users – the virtual machine owner. Click the owner name to see the User Profile (user
details)
o Virtual Machines – the virtual machine name with the total due for VM resources (CPU
priority, CPUs, memory and template resources) for the point of time specified in the Date
column.
o Network Interfaces – the total due for the network interfaces used by this VM for the point
of time specified in the Date column. Click the network interface name to see its details.
o Disks – the list of disks assigned to this VM with the total due for the disk space resources
(disk size, data read/written, reads/writes completed) for the point of time specified in the
Date column. Click the disk name to see its details.
o Costs – the total due for the Virtual Machines, Network Interfaces and Disks resources for
the point of time specified in the Date column.
Scroll down to see Total Amount (the total due for the whole billing statistics period).
4.4.3 Network Interface usage
OnApp tracks network usage for virtual machines and generates charts that help analyze network
performance. To see network utilization statistics for a virtual machine:
36
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1.
2.
3.
4.
5.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Networking -> Network Interfaces tab.
Click the Statistics (chart) icon next to the network you’re interested in.
On the screen that appears, the top chart shows bandwidth usage for the last 24 hours. The
bottom chart shows usage for the last three months.
6. To zoom into a time period, click and drag in a chart. Click the Show all button to zoom out
again.
4.4.4 Disk IOPS
The system tracks IOPS (Input/Output Operations per Second) for virtual machines and generates charts
that help analyze VM disk performance. To see IOPS for a virtual machine:
1.
2.
3.
4.
Go to your Control Panel’s Virtual Machines menu.
Click the label of the virtual machine you’re interested in.
Click the Storage -> Disks tab.
Click the Statistics (chart) icon next to the disk you’re interested in. There are four charts on the
screen that appears:
o IOPS for the last hour
o IOPS for the last 24 hours
o Data written/read for the last 24 hours
o Data written/read for the last hour
5. To zoom into a time period, click and drag in a chart. Click the Show all button to zoom out
again.
 The OnApp API allows you to limit the Hourly IOPS and Hourly data by setting the limit=N parameter,
where the N variable is the number of hours for which the charts will display the info.
37
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
5. Load Balancers
Load balancing aids application availability and scalability. There are two load balancing options in
OnApp:
•
Load balancer clusters
With this option, you specify which VMs (nodes) will participate in a load balancer cluster.
Incoming traffic is distributed evenly between all the VMs added to a cluster – you still present a
single host name to end users, but they actually access the cluster of VMs rather than a single
end point. This helps application availability: if one VM fails, traffic is automatically routed to
another in the cluster. You can add and remove cluster VMs as required.
•
Autoscaling clusters
VM Autoscaling increases or decreases your VM capacity by automatically adding or removing
nodes to a cluster. The cluster is scaled in (decreased) or out (increased) based on rules you
specify in the Control panel. This aids application performance and scalability.
 For instance, you can create a rule that will add 3 more nodes to a cluster if CPU usage has
been more than 90% for the last 5 minutes; or rules that remove a node if there has been more
than 256 MB RAM free for the last 20 minutes.
5.1
Add a load balancer cluster
In this scheme, load balancers manage incoming requests one by one, rotating them between the
servers added to a cluster (a round-robin method).
OnApp load balancers are based on Layer 4 load balancing which means that requests are distributed at
the transport layer, such as TCP/UDP transport protocols. To add an LB cluster:
1. Go to your Control Panel’s Load Balancers menu.
2. Click the Add a Balancer button.
3. On the page that follows, fill in the form that appears:
Cluster Configuration
o Port - specify the port for this load balancer to run on (e.g. 9090, 8080, 9008 etc.)
Load Balancer Instance
o Label – give a name to your load balancer instance.
o Hostname – specify a host name that will identify your load balancer.
o Hypervisor zone – choose a hypervisor zone.
o Hypervisor – select a hypervisor that will be enabled for the cluster.
o Network zone – choose a network zone for this load balancer.
o Port Speed – use the slider to set a port speed or tick the Unlimited box if required.
38
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Load Balancer Type
o Choose the Cluster option.
Cluster Nodes
This is where you add and configure the nodes in this load balancing cluster. A node is a
combination of a VM and an IP address.
 Please note that the only VMs you can add to a cluster are those which are based on the
selected hypervisor/hypervisor zone, have an IP in the defined network zone and are located in
the same IP range.
Virtual Machines
o Select a virtual machine from the drop-down box.
4. Click Save.
5.2
Add an autoscaling cluster
To add an autoscaling cluster to your cloud:
1. Go to your Control Panel’s Load Balancers menu.
2. Click the Add a Balancer button.
3. On the page that follows, fill in the form that appears:
Cluster Configuration
o Port - specify the port for this load balancer to run on (e.g. 9090, 8080)
Load Balancer Instance
o Label – give a name for your load balancer instance.
o Hostname – specify a host name which will identify your load balancer.
o Hypervisor zone – choose a hypervisor zone.
o Hypervisor – select a hypervisor that will be enabled for the cluster.
o Network zone – choose a network zone for this load balancer.
o Port Speed – use the slider to set a port speed or tick the Unlimited box if required.
Load Balancer Type
o Choose the Autoscaling option.
Cluster Node Template
These settings configure the nodes that will be added to your cluster.
o
o
o
Image template – choose a template from the drop-down box: nodes will be built on
this template
Min node amount – the minimum number of nodes in this cluster.
Max node amount – the maximum number of nodes in this cluster.
39
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
 Example: if you set Min node amount = 2 and Max node amount = 5, then the system will
scale out the cluster up to 5 nodes, and scale in to 2 nodes if required.
 Please note that the only templates you can add to a cluster are those based on the
selected hypervisor/hypervisor zone.
Cluster Node Parameters
These are the settings for each node of a cluster. Each node added to a cluster will have the
following parameters:
o
o
o
o
Memory – set the amount of memory allocated per node in MB.
CPUs – the number CPUs which will form each node.
CPU Priority – the node’s CPU priority. For more info on CPU priority, refer to the Create
VMs section.
Rate Limit – set the port speed for a node.
Autoscale Out Parameters
Set the rules defining when the system should add more nodes to your autoscaling cluster. The
system will add nodes until the limit set in the Max node amount field is reached.
Autoscale In Parameters
Set the rules defining when the system should remove the nodes from your autoscaling cluster.
The system will remove nodes until the limit set in the Min node amount field is reached.
4. Click Save.
5.3
View load balancer details
Load balancers are also virtual machines, so you can perform the same basic actions on them as for
other VMs. To view load balancer details:
1. Go to your Control Panel’s Load Balancers menu.
2. On the screen that appears, click the label of the Load balancer required.
3. You’ll see the information on the load balancers with the range of tools available for the
balancer:
LB information
o Hostname and login
o Power status & On/Off buttons
o Template this LB is built on
o Resources allocated to this LB
o Hypervisor and IPs
o Owner
40
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
o
Prices per hour
Administrator’s note
Activity log
Tabs with additional tools
o Billing Stats – Shows costs due for this LB for a specified time period.
o Monitis monitors – Shows the cluster load.
Actions (the exact list shown depends on Balancer status):
o
o
o
o
o
o
o
o
o
Startup Balancer - Queues a start-up action for a Balancer that’s currently powered
off.
Reboot Balancer - Powers off and then restarts the Balancer.
Shut Down Balancer - Terminates the Balancer forcefully.
Delete Balancer - Removes the Balancer from the system.
Suspend Balancer - Stops a Balancer, and changes its status to suspended.
Migrate Balancer - Pops up the Balancer migration dialogue, enabling you to move
the Balancer to a different hypervisor.
Rebuild Balancer - Pops up the Balancer rebuild dialogue, where you can rebuild the
Balancer on the same (or another) template. All data will be lost!
Edit Administrator’s Note – Add a brief comment or reminder for a Balancer.
Monitis Monitors - Shows the cluster load.
Cluster Nodes
This is the list of the nodes which form the load balancer. Here you can:
o Power on/off the node.
o Delete a node from a cluster.
5.4
Edit/delete a load balancer
To edit a load balancer:
1. Go to your Control Panel’s Load Balancers menu.
2. Click the Edit icon next to a required load balancer.
3. When the page loads, edit necessary parameters and click Save.
 When you increase the RAM of the nodes of a load balancer (autoscaling type) to a value greater than
the current node RAMx16 (which is a max_mem parameter in a configuration file and database), the
load balancer will be cold resized.
To delete a load balancer:
41
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1. Go to your Control Panel’s Load Balancers menu.
2. Click the Delete icon next to a required load balancer.
3. When the confirmation window pops up, click OK.
42
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
6. CDN
OnApp CDN is a software product that works with OnApp Cloud v2.3 and later. If you enable CDN for
your end users, they can get access to a network of global edge servers (yours, and/or those provided by
other cloud hosts) and use that network to deliver web content more quickly and reliably to visitors all
over the world. Your CDN is managed alongside your cloud using your OnApp Control Panel. See
http://www.onapp.com/cdn for more information.
Setting up OnApp CDN includes:
•
•
•
•
•
Enabling CDN for your cloud in the OnApp customer dashboard (contact OnApp Support if you
don’t have dashboard access)
Setting up edge servers in your OnApp Control Panel
Adding CDN edge groups and assigning them to billing plans
Creating CDN resources
Assign the billing plan to a user, and set their permissions
Edge servers cache web content and deliver it to website visitors. They are virtual appliances that are
deployed on hypervisors and managed just like VMs. You can use edge servers to sell CDN bandwidth to
your end users, and/or submit the edge server to the OnApp CDN marketplace and sell your bandwidth
to other hosts. You can create as many edge servers as you need and place them on different
hypervisors in different geographical locations, and easily broaden your CDN by combining your own
edge servers with other locations on the CDN marketplace. You can even build a CDN solely with
marketplace resources.
Edge groups are groups of edge servers – your own, and those you subscribe to from the CDN
marketplace. They are usually grouped by location, so they represent a pool of servers for a given
geographical area.
Edge groups are assigned to billing plans to set the prices for the bandwidth that your end users
consume. You can assign several groups to one billing plan at a time, and establish different
geographical zones with different pricing. The bandwidth pricing of the billing plan is the price for CDN
bandwidth sold to your end users.
A CDN resource is a specific server with content an end user wants to distribute via the CDN. CDN
resources are assigned to edge groups, which determines the list of servers taking part in
distributing/caching of their data.
 When you create a user account, you need to grant them all necessary permissions for managing CDN
resources and assign the user to the appropriate billing plan.
43
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
6.1
CDN edge servers
Web content is cached in the network of edge servers on the CDN, distributed across different
geographic locations. Content is delivered to end users from the server which is closest to the user, or
has the best availability. If you have CDN enabled for your cloud, you can use the control panel to set up
your own edge servers, and manage them in the same way you manage virtual machines.
6.1.1 Add CDN edge server
To add a CDN edge server:
1. Go to your Control Panel’s CDN Edge Servers menu.
2. On the screen that appears, click the Add New Edge Server button.
3. Fill in the form that appears:
o
Edge server properties
Give your edge server a label and a hostname. The label can consist of:
 Lower- & upper-case letters [A-Za-z]
 Digits [0-9]
 Dash [ - ]
 Underscore [ _ ]
 Space character [ ]
 At sign [@]
 Brackets [ (){} ]
 Slashes [/\]
 Caret [^]
 Dollar sign [$]
 Asterisk [*]
 Comma [,]
 Dot [.]
o Choose a hypervisor zone to build this server on.
o Choose a specific hypervisor to build this server on.
CDN properties
o Tick the Add to Marketplace box to submit this server to the OnApp CDN marketplace.
 Any servers you submit will be assessed before they are accepted into the marketplace.
Criteria include geographic location, bandwidth and server specs.
Edge server type
o Choose the OS and distribution on which the edge server is built. Currently, only Debian is
supported.
Resources
o Set the resources needed for this edge server: RAM, CPU cores and CPU priority.
44
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Primary disk
o Choose a data store zone for this edge server’s primary disk.
o Set the primary disk size.
Network configuration
o Choose a network zone and set the port speed for this edge server.
Automation settings
o Tick the Build Edge Server Automatically box if you want the system to automatically
build the edge server. If you leave this box blank, you will have to build your server
manually after it is created.
4. Click Create Edge Server.
6.1.2 View edge server details
Edge servers are virtual appliances that are much like other virtual machines in your cloud. You can
perform the same basic actions on them as for VMs.
To view all edge servers in the cloud:
1. Go to your Control Panel’s CDN Edge Servers menu to see an overview of all edge servers in your
cloud: their name, IP addresses, power status (with on/off buttons), and allocated disk size and
RAM.
2. From here you also have quick access to the Statistics screen for each edge server, where you
can see its CPU usage and Backups screen. Click the relevant icon in each case.
To view a particular edge server’s details:
1. Go to your Control Panel’s CDN Edge Servers menu.
2. Click the label of the Edge Server required.
3. On the screen that appears, use the top navigation tabs to manage your edge server.
 Edge servers are managed with the same tools you use to manage VMs in your cloud. The table
below links to the relevant sections of this guide’s Virtual Machines chapter. The only notable
exception (at present) is that autoscaling is not currently available for edge servers.
Overview
Properties
CPU Usage
Billing Statistics
Console
Networking Network
Interfaces
Firewall
The Overview tab shows CDN edge server
information and gives access to the most
frequently-used management tools.
The Networking tab lets you manage your edge
server’s network configuration.
45
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
IP Addresses
Storage
Disks
Backups
The Storage tab lets you manage your edge
server’s disks and backups.
6.1.3 Edit CDN edge server
Editing a CDN edge server means adjusting the resources allocated to it, changing its label and basic
properties.
To edit a CDN edge server:
1. Go to your Control Panel’s CDN edge server menu.
2. Click the label of an edge server.
3. On the next screen, click the Adjust Resource Allocation link in the Actions section:
• Change the edge server label.
• Edit CPU core/priority and RAM values.
 Note that the server will be rebooted if you edit resources allocated.
• Edit CDN properties as required.
4. Click Save Edge server.
6.1.4 Delete CDN edge server
To delete a CDN edge server:
1.
2.
3.
4.
6.2
Go to your Control Panel’s CDN edge server menu.
Click the label of an edge server.
When the page loads, click Delete Edge Server in the Actions section.
You will be asked for confirmation before the edge server is deleted.
CDN resources
A CDN resource is a host (e.g. a specific web server), the content
of which you are going to distribute over the network of edge
servers. Only servers added to the edge groups assigned to the
resource will distribute/cache the host’s content.
 To activate the CDN Resources menu, at least one CDN Edge
46
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Group with at least one edge server or marketplace location must be available.
6.2.1 View CDN resources
Go to your Control Panel’s CDN Resources menu.
You will see the list of CDN resources with the following information:
CDN Hostname – hostname of the CDN resource.
Origin Sites – path of the content that will be served from the CDN.
Type - type of resource (currently HTTP Pull).
Cost – cost of the resource.




You can edit/delete a resource using the relevant icons next to each resource in the list, and add a
resource with the New CDN Resource button.
6.2.2 Add new CDN resource
To add a CDN resource:
1. Go to your Control Panel’s CDN Resources menu.
2. Click New CDN Resource button.
3. On the screen that appears, fill in the following fields:
CDN Resource Properties
o CDN hostname – the hostname from where you will serve static content.
E.g. if your site (origin) is onapp.com, and you want to serve static content from the CDN and
make it available at static.onapp.com, then static.onapp.com would be the CDN hostname.
o
o
Origin – the path from which content is requested, to be put on the CDN.
Resource type – HTTP Pull is currently the only type supported.
Advanced Settings
Tick this checkbox to configure the following advanced settings:
IP Access
Configure a rule to enable/disable access to the CDN resource’s content for a range of IP
addresses.
o
o
Access Policy – select Disabled to switch off a rule; otherwise choose between Allow by
default/Block by default.
IP Addresses – input IP address(es)
Country Access
Configure a rule to enable/disable access to the CDN resource’s content for specified countries.
47
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
Access Policy – select Disabled to switch off a rule; otherwise choose between Allow by
default/Block by default.
Countries – select a country for the rule. To select more than one country, hold Ctrl during
selection.
Hotlink Policy
o Hotlink Policy – select Disabled to switch off a hotlink policy; otherwise choose between
Allow by default/Block by default.
URL Signing
Protect your files from unauthorized access with a key. A signed URL looks like
`http://example.com/filename?hash=DMF1ucDxtqgxwYQ==`.
o
o
Enable URL Signing – tick this checkbox to enable it.
URL Signing Key – input the key which will be used for URL signing. The secret key is similar
to a password and can contain a minimum of 6 to a maximum of 32 characters. Symbols and
spaces are allowed.
You can also specify the expiration time, that is the time when this URL becomes invalid. The
time is passed in the URL itself in a Unix timestamp format and takes part in hash generation.
Here is the example PHP script used to generate the hash key:
# unixdate generation sample:
$expires_y = '2010';
$expires_m = '12';
$expires_d = '11';
$expires = mktime(0 , 0 , 0 , $expires_m , $expires_d , $expires_y);
# this therefore expires at 2010 Dec 11th, at 00:00:00
$arr_str_from
= array("+" , "/");
$arr_str_to
= array("-" , "_");
$keystr = "$url$secret_key";
# or $keystr = "$expires$url$secret_key"; # if using expiry. note that $expires
is unixdate
$hashkey = str_replace($arr_str_from , $arr_str_to , base64_encode(md5($keystr
, TRUE)));
Cache expiry
o Cache expiry – set the cache expiry time in minutes.
Password
o Enable Password – tick this checkbox to restrict access to the resource (cdn hostname).
o Unauthorized HTML – input the text which will be displayed for unauthorized login.
o Username – input username.
o Password – input password for the user.
 To remove a user, clear both fields.
48
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Edge Groups
Tick the box next to the group(s) which will share the resource added. Available groups depend
on the assigned billing plan limits.
4. Click the Create CDN Resource button.
6.2.3 Edit CDN resource
To edit a CDN Resource:
1. Go to your Control Panel’s CDN Resource menu.
2. Click the Edit icon next to a resource.
3. On the screen that appears you can edit all CDN resource parameters (see the Add new CDN
Resource section for details).
4. Click the Apply changes button to finish.
6.2.4
View CDN resource details
View basic and advanced details of a CDN Resource.
To view instructions and basic settings:
1. Go to your Control Panel’s CDN Resource menu.
2. Click the required CDN Hostname.
3. On the page that appears, click Instructions and basic settings tab. The screen provides you with
the following information:
CDN Resource details
o CDN hostname
o Resource type
o CDN reference – the ID of the resource in database
o CDN status – shows the resource status
Resource Path and Origins
o This cannot be configured at the moment. It is reserved for future use.
DNS settings
o Add a CNAME for the CDN Hostname which can then be used to view the contents. Use this for
the origin settings.
Edge Groups
o Shows to which Edge groups the resource is assigned.
49
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
To view advanced details:
1.
2.
3.
4.
Go to your Control Panel’s CDN Resource menu.
Click a CDN Hostname.
On the screen that appears, click the Advanced Details tab.
This screen provides you with the following information:
o Publisher name – name of the user who created the CDN Resource record
o IP Access Policy
o Country Access Policy
o URL Signing Enabled
o Hotlink Policy
o Password On
o Cache Expiry
o No Cache regex
6.2.5 Prefetch content
This tool allows HTTP Pull content to be pre-populated to the CDN. Recommended only for files which
are especially large.
To prefetch the content:
1.
2.
3.
4.
Go to CDN Resource menu.
Click the required resource link.
On the page that appears, click the Prefetch tab.
In the input field indicate paths on the CDN Resource (cdn hostname). You may indicate only
one path per line.
5. Click the Prefetch button to finish.
6.2.6 Purge content
This tool allows instant removal of HTTP Pull cache content in the CDN, if newly updated content has not
been properly replicated.
To purge content:
1.
2.
3.
4.
Go to CDN Resource menu.
Click the required resource link.
On the page that appears, click the Purge tab.
In the input field indicate paths on the CDN Resource (cdn hostname). You may indicate only
one path per line.
5. Click the Purge button to finish.
50
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
6.2.7 Bandwidth statistics
To see the bandwidth statistics/graphs for a CDN resource:
1.
2.
3.
4.
5.
Go to your Control Panel’s CDN Resources menu.
Click the Bandwidth statistics tab.
Select type of filter – either GB or Mbits/s.
Specify the period in the From and To fields.
Tick the Show in my Timezone box to show bandwidth statistics according to your profile’s
timezone settings.
6. Select a resource for which the statistics will be generated (select several resources by holding
Ctrl).
7. Click the Apply button.
The statistics are displayed in two graphs: Cached and Non Cached.
To zoom into a time period, click and drag in a chart. Click the Show all button to zoom out again.
6.3
CDN edge groups
CDN edge groups are groups of edge servers – your own, and those you subscribe to from the CDN
marketplace. They are usually grouped by location, so they represent a pool of servers for a given
geographical area. Once you have created an edge group containing edge servers in specific locations,
you can then assign the group (or groups) to a specific CDN resource.
The CDN edge groups menu enables you to see available edge server locations and form them into CDN
Edge groups.
 You need to associate CDN Edge groups with billing plans to make them available for users.
6.3.1 Create a new CDN edge group
To create a new CDN Edge Group:
1. Go to your control panel’s Users and Groups menu.
2. Select the CDN Edge Groups tab.
3. On the screen that appears you will see existing groups with the number of assigned locations
and associated billing plans.
4. Click the New Edge Group button.
5. On the screen that appears, give your new group a label and click the Create Edge Group button.
6. You will be redirected to the screen where you can assign locations to the group.
51
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
6.3.2 View CDN edge group details
To see details of a CDN Edge Group:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Select the CDN Edge Groups tab.
Click the label of the edge group you want to see.
On the screen that appears you will see the list of assigned locations and available locations with
the following information:
o City – the city the edge server is in.
o Country – the country the edge server is in.
o Operator – name of the edge server owner.
o Source – either Marketplace (locations added from the CDN marketplace) or your
Own Edge servers (servers added by you).
o Price – price per GB transferred.
6.3.3 Assign/remove locations to/from the CDN Edge Group
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Select the CDN Edge Groups tab.
Click the label of the CDN Edge Group you want to configure.
On the screen that appears you may assign or remove locations, using the Add and Delete icons.
6.3.4 Edit/delete CDN edge group
To edit the name of a CDN Edge Group, or delete a group:
1. Go to your Control Panel’s Users and Groups menu.
2. Select the CDN Edge Groups tab.
3. On the screen that appears you will see existing groups:
• Click the Edit icon to change the group label.
• Click the Delete icon to delete the group.
52
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
7. DNS
The full version of OnApp Cloud (with CDN enabled) now gives you access to our free Anycast DNS
service. Instead of managing your own DNS servers you can use our fully redundant global DNS, hosted
at multiple datacenters around the world, and manage it through your OnApp Control Panel.
You can use our DNS service with domains registered anywhere on a third party domain registrar. The
Control Panel lets you set up hostnames, manage DNS records, aliases, Mail Exchange, TXT and SRV
records.
Using DNS has two main steps: setting up DNS hostnames, and managing DNS zones.
7.1
DNS setup
DNS setup allows you to create a DNS hostname. After you create a DNS hostname, you get access to
creating and managing DNS zones. To set up a new DNS, make sure that:
•
•
CDN is enabled
You have dns_zone or dns_zone.setup permission to access this page.
You can create only one DNS domain. Once created, a DNS domain can’t be deleted, only updated.
If an administrator uses the same license for two different Control Panels, they can use the same DNS
domain for CP1 and CP2. To do this, administrator should set the same DNS domain settings for both
Control Panels.
To add a DNS domain:
1. Go to your Control Panel’s Settings.
2. On the screen that appears, type your fully qualified domain name.
Mind that you won’t be able to use a domain name that is already registered with OnApp DNS.
The domains of the following kind are forbidden:
o google
o microsoft
o domain.com
o onapp.com
o facebook.com
o gmail.com
o googlemail.com
o yahoo
3. Click the Save button.
After the DNS domain is added, the DNS menu will be enabled to users (see DNS section)
53
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Make sure your domain name registrar has designated your domain to the following name servers:
•
•
•
•
ns1.yourdomain.com
ns2.yourdomain.com
ns3.yourdomain.com
ns4.yourdomain.com
Where yourdomain.com is your fully qualified domain name, which you have specified at DNS setup.
7.1.1 Edit DNS domain
To edit your DNS domain:
1. Go to your Control Panel’s Settings menu, and click the DNS Setup icon.
2. Type a new fully qualified domain name to replace your existing domain
3. Click the Save button to save changes.
If DNS domain is updated, all NS records for all DNS zones under this user will be updated.
7.2
DNS zone
OnApp DNS Zone feature allows you to manage your and your clients’ domain DNS. Each time DNS zone,
record or setup settings are refreshed, the DNS configuration is immediately updated on the DNS vendor
server.
7.2.1 Add new DNS zone
To add a new DNS zone:
1.
2.
3.
4.
Log in to your Control Panel account.
Go to DNS menu.
Click the Add New DNS zone button.
Fill in your domain name. At the domain registrar, point your domain to the following name
servers:
o ns1.yourdomain.com
o ns2.yourdomain.com
o ns3.yourdomain.com
o ns4.yourdomain.com
Where yourdomain.com is your fully qualified domain name, which you have specified at DNS
setup.
54
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
5. Tick the Auto Populate box to automatically import your existing DNS settings, or skip this step
to start from scratch. Note that this option may not import all existing settings, so you should
check your new record for any missing entries.
6. Click the Submit button.
7. On the page that appears, click the add icons next to the DNS records you want to add. You can
add and manage the following DNS records:
a. SOA (Start of Authority) – change the start of authority time to live value (TTL).
To change a SOA TTL, click the TTL cell next to the SOA record and type a new value.
b. NS (Name Server) – change the TTL of the existing name servers or add new name
servers.
To change a name server’s TTL, click the TTL cell next to the name server record and
type a new value.
c. A (Host) –-point your domain name to a static IP address.
To create a new A record, enter the following parameters into the cells:
Host – enter a host name or use the “@” sign to represent your current host.
Point to – enter the IP address to which the user would be sent for this host
name.
TTL – set the time to live value for this record.
A record example:
ftp 192.168.0.1 86400
Where: ftp is the host; 643763287490 - IP , 86400 is TTL value.
So your ftp.yourdomain.com will resolve to 2a00:1450:400b:c00::68 IP address
and the TTL value = 86400 seconds.
d. AAAA (Host)
To create a new AAAA record, fill in the following cells:
Host – enter a host name or use the “@” sign to represent your current host.
Point to – enter the IP address to which the user would be sent for this host
name.
TTL – set the TTL value for this record.
AAAA record example:
ftp 2a00:1450:400b:c00::68 86400
Where: ftp is the host, 2a00:1450:400b:c00 – IPv6 address, 86400 is the TTL
value.
So your ftp.yourdomain.com will resolve to 2a00:1450:400b:c00 IPv6 address.
e. CNAME (Alias) – alias domain records to your domain.
To add a CNAME record, fill in the following cells:
Host –.enter the host name or use the “@” sign to represent your current host.
Point to –enter an alias you want to assign to your domain.
TTL – set the TTL value.
CNAME record example:
www example.com 86400
Where: www is an alias, example.com is a valid domain name, 86400 is TTL
value.
To add the aliases, make sure an A record is added or this domain.
f. MX (Mail Exchange) - identify the mail server for your domain name.
To add a MX record, fill in the following cells:
55
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Priority – set the MX priority to specify the routing order (lower value means
higher priority).
Host: enter the hostname to which the emails should go
Goes to – enter the valid domain name.
TTL – set the TTL value.
MX record example:
10 mail example.com 86400
Where: 10 is priority, mail is the host, example.com is a domain, 86400 is TTL.
g. TXT – add additional information about the DNS zone.
Host – enter the valid host name
Value – any free text you want within a TXT record.
TTL – TTL value.
TXT record example:
@ v=spf1 a mx ptr ip4:192.168.1.1 ~all 86400
Where: @ is the host name, v=spf1 a mx ptr ip4:192.168.1.1 ~all is value, 86400
is TTL.
h. SRV (Service) –specify services that you have on your domain.
To add a SRV record, enter the following cells parameters:
Host – type the host for which this record is valid.
Priority – set the host priority. Lower value means more preferred.
Weight – the approximate weight for relative records with the same priority.
Port – the port on which the service can be found.
Points to – enter the domain name.
TTL – set the time to live value.
SRV record example:
xmpp._tcp 0 1 5222 jabber.example.com 86400
Where: xmpp._tcp is a host,0 is priority, 1 is weight, 5222 is port,
jabber.example.com is a points to value, 86400 is TTL.
7.2.2 Edit DNS zone
When you edit a DNS Zone, you manage the records assigned to this zone. The changes are instantly
updated on DNS.
To edit a DNS zone:
1. Go to your Control Panel’s DNS menu. On the screen that appears, the list of DNS zones will be
displayed.
2. Click the Edit icon next to the domain zone you want to change.
3. On the screen that appears, edit the DNS records as required:
o SOA (Start of Authority) – change the start of authority TTL.
o NS (Name Server) – change the TTL of the existing name servers or add a new name
server.
o A (Host) – change the A host record properties:
 In the Host text box, type the name for a host.
 In the Point to text box, type the IP address for the new host.
56
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
o
o
 Set the TTL value.
AAAA (Host) – change the AAAA record properties as described for the A record.
CNAME (Alias) – canonical name properties.
MX (Mail Exchange) - - change the mail server properties for your domain name.
SRV (Service) - specify services that you have on your domain.
7.2.3 Delete DNS zone
To delete a domain zone:
1. Go to your Control Panel’s DNS menu.
2. Click the Delete icon next to the domain zone you want to delete.
3. Click OK to confirm.
7.2.4 User DNS zones
User DNS zones tab allows you to manage your clients’ DNS zones. Use the icons on the right to
edit/delete user DNS zones. The changes will be instantly updated on our DNS.
7.2.5 Set End-User Access to DNS service
To set end-users’ access to DNS service:
1.
2.
3.
4.
5.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab.
Click the edit icon next to the required User.
On the screen that follows, choose the DNS Zone group in the Groups field.
The following list of DNS permissions will appear:
o
o
o
o
o
o
o
o
o
o
o
o
Any action on DNS zone
Create a new DNS zone
Destroy any DNS zone
Destroy own DNS zone
See all DNS zones
See own DNS zones
Any action on DNS record
Create a new DNS record
Destroy any DNS record
See all DNS records
Update any DNS record
DNS Setup
57
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
6. Tick the required boxes.
7. Click the Save button.
7.2.6 View/edit/delete clients’ DNS zones
To view, edit and delete existing clients’ DNS zones:
1. Go to your Control Panel’s DNS menu.
2. Click the User DNS Roles tab. On the screen that appears, you’ll see a list of all clients’ DNS
zones.
3. To edit a clients’ DNS zone, click the Edit icon next to it, edit its details on the screen that
appears and click the Save button.
4. To delete a clients’ DNS zone, click the Delete icon next to the DNS zone you want to delete.
You’ll be asked to confirm deletion.
58
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
8. Hypervisors
Hypervisors provide hardware resources for virtual machines. Each virtual machine in the cloud is
hosted by a specific physical hypervisor server, from which it receives CPU time, RAM and storage
capacity from the Data Stores attached to that hypervisor.
Hypervisors can also be organized into Hypervisor zones, which make it easy to offer tiered service levels
and create private clouds for specific users.
8.1
View hypervisors
The Control Panel provides a quick way to see Hypervisors and Hypervisor zones in the cloud, along with
a summary of their resources:
1. Click your Control Panel’s main Hypervisors menu to see a list of all hypervisors in your cloud,
and a quick overview of their:
o Name (label)
o Type (Xen, KVM etc)
o IP address
o Zone
o CPU cores
o CPU resources used/available
o Total VMs hosted
o Whether failover is enabled or not
o Total RAM/free RAM
o CPU speed
You can also see the hypervisors assigned to a specific hypervisor zone, by clicking the
hypervisor zone name underneath the main Hypervisors menu.
8.2
View hypervisor details
You can drill into a specific hypervisor to see details of all virtual machines controlled by that hypervisor,
and their resources. To do so:
1. Go to your Control Panel’s Hypervisors menu (or click a hypervisor zone name underneath it).
On the screen that appears you’ll see a list of hypervisors.
2. Click a hypervisor’s name (label) to see its hypervisor details screen:
o You’ll see a list of all virtual machines hosted on that hypervisor, along with their IP address,
power status, disk and RAM resources.
o You have quick access to VM power on/off buttons, and can click the relevant icons to see
VMs’ backup schedule and CPU usage screens. You can also drill into a specific VM by
clicking its label.
59
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
8.3
Finally, the Actions section of the hypervisor details screen offers buttons to Edit and
Reboot that hypervisor.
Edit hypervisor details
You can edit hypervisor details (its type, IP address and so on) via the hypervisor details screen, or
through the Control Panel’s Settings/Hypervisors menu (see the relevant section under Settings in this
guide for details: the editing functionality is the same whichever method you choose.)
To edit hypervisor details:
1. Go to your Control Panel’s Hypervisors menu (or click a hypervisor zone name underneath it).
On the screen that appears you’ll see a list of hypervisors.
2. Click a hypervisor’s name (label).
3. Scroll down to the Actions section.
4. Click the Edit Hypervisor link.
5. On the screen that follows, change details as required:
o The hypervisor’s name (label)
o Its type (Xen, KVM etc)
o Whether it’s enabled or not (hypervisors that are not enabled cannot be used to host VMs)
o Its IP address
o Memory overhead
o Tick the box to disable failover. Hypervisor failover means VM migration to another
hypervisor if the hypervisor on which it is running goes offline.
6. Click the Save Hypervisor button to save your changes.
You can also edit your hypervisors in the Control Panel’s Settings menu. Refer to the Settings section of
this guide for more details.
8.4
Reboot hypervisors
To reboot a hypervisor:
1. Go to your Control Panel’s Hypervisors menu (or click a hypervisor zone name underneath the
main hypervisor menu link).
2. Click the label (name) of the hypervisor you want to reboot.
3. On the hypervisor details screen that follows, scroll down to the Actions section and click the
Reboot Hypervisor button.
4. A new screen will open asking for confirmation (via two checkboxes) before reboot:
o Stop all virtual machines that cannot be migrated to another hypervisor? Check this box if
you want VMs that cannot be migrated to be powered off. When a hypervisor is scheduled
for a reboot, OnApp will first attempt to hot migrate all VMs it hosts. If hot migration is not
possible for a VM, OnApp will attempt to cold migrate that VM. With this box checked, if
60
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
cold migration fails, the VM will be stopped so the reboot may proceed.
If you don’t check this box, OnApp will attempt to hot and then cold migrate all VMs hosted
by the hypervisor being rebooted – but will stop the migration process if any VM cannot be
migrated.
o Are you sure you want to reboot this hypervisor? A simple confirmation to confirm that
you want the hypervisor to reboot.
5. When you’re certain you want to proceed with the reboot, click the Reboot button.
8.5
Other hypervisor settings
Access to detailed hypervisor and hypervisor zone settings is handled in the Control Panel’s Settings
menu. These are explained in the Settings section of this guide.
61
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
9. Templates
OnApp templates are used to deploy virtual machines in your cloud. A template is a fully pre-configured
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.
There are two different kinds of template:
o
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.
o
Custom/user templates
These are templates you create by backing up an existing virtual machine, and converting that
backup to a template. This allows you to pre-configure virtual machines (for example with
specific OS settings, or pre-installed applications) and use the same configuration again and
again.
The OnApp template library includes over 100 VM 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 appliances and deploy them as templates in OnApp. For the latest
list see: http://onapp.com/how-it-works/vm-templates
 At present OnApp does not support VMs/templates with Active Directory Domain Controllers.
Also note that only customers with a ful (paid) license have access to the complete template
library, and special deals with JumpBox.
9.1
View template details
The Control Panel’s Templates List menu lists all of the templates available on your system, their version
number, the Operating System they install, whether swap disk is allowed, and whether you can adjust
their CPU cores/priority & RAM without rebooting a virtual machine based on that template (“resize
without reboot”).
The templates are organized into three tabs:
o
o
o
System templates - the OS images provided by OnApp.
Custom/User templates - the templates converted by users from VM backups. The tab will show
the templates of the user who is currently logged in.
Inactive templates - the templates that are currently unavailable to build VMs on.
62
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
To see which virtual machines are based on a specific template:
1. Click the main Templates menu in the control panel to bring up the list of templates.
2. Click the template’s label (name) in the list.
9.2
Edit template details
You can edit a range of template details through the Control Panel, including minimum disk size
required, version number, filename and label. To do so:
1. Go to your Control Panel’s Templates List menu. You’ll see a list of templates on your system.
2. Click the Edit icon next to the template you want to change. On the screen that follows, enter
template details as required:
• Label – change the template name
• Filename – edit the template filename
• Version – the template version
• Min disk size – the minimum VM disk size required to build a VM on this template (in
Gb)
• Min memory size – the minimum VM RAM required to build a VM on this template (in
Mb)
3. Click the Save button to finish.
9.3
Delete system templates
To delete a template, go to the Control Panel’s Templates List menu and click the delete icon next to the
template you wish to delete. When templates are deleted the virtual machines built from them will
continue to run.
9.4
Create custom templates
You can create custom templates by making a backup of an existing virtual machine and saving it as a
template for future use. To create a custom template:
1.
2.
3.
4.
5.
Create a new virtual machine and configure it as you would like for your template.
Click the Backups icon for this virtual machine.
In the list of backups, click Convert to Template next to the backup you want to convert.
Click Ok to proceed.
On the next screen, enter the following:
• A label for your template.
• The minimum memory size: make sure the minimum memory size takes into account
the settings for the template on which the VM was built, plus any modifications you may
have made to the template before making the backup.
63
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
The minimum disk size: ensure the value is based on the template settings and any
possible modifications you may have made, e.g. installing additional software.
• Click the Convert Backup button.
6. The backup will be scheduled for creation. When conversion is complete, it will be then listed on
the Templates List > User Templates tab, from where you can edit it.
 If you update a custom template (by converting a more recent backup of a VM, for example) it will not
update existing VMs built on the previous version. Only new VMs, or those that are rebuilt, will use the
new template.
9.5
User template permissions
Administrators can set permissions that control whether other users can convert their backups into
templates, use those templates and delete them. This is handled in the Control Panel’s Users and
Groups menu. To do so:
1.
2.
3.
4.
9.6
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab.
Click the Edit icon next to the user type you want to manage.
Check or uncheck the box next to Create and Manage Templates.
Edit and delete custom templates
You can edit your custom templates at any time. To do so:
1. Go to your Control Panel’s Templates List > User Templates tab menu. Your custom templates
will be listed there.
2. Click the Edit icon next to the template you wish to edit, make your changes on the screen that
follows, and click Save Template.
3. Click the Delete icon next to a template if you want to delete it.
9.7
Make templates public
The template list is organized into three tabs. The User templates tab lists all the custom templates
created form the backups. By default those templates are available only to those users who created
them. To make User templates available to all users:
1.
2.
3.
4.
Go to your Control Panel’s Templates List menu.
Click User templates tab.
Click the Make public icon next to the template you want to make public.
Confirm the window that pops up.
When you make a custom template public, it is moved to a System templates tab.
64
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
9.8
Allow users to make templates public
All custom templates are private by default, which means they are only available to the users who
created them. As administrator, you can give users the right to create templates that are available to all
users – i.e. to create public templates. This is handled through the Control Panel’s Users and Groups
menu:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab.
Click the Edit icon next to the role you want to edit.
On the screen that follows, check the box next to the Make own template public permission.
9.9
Template software licenses
To create a virtual machine 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 VM to be created,
so before creating a VM 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 VMs.
KMS licensing: this is applicable to Windows 2008 and Windows 7 VMs only.
User licenses: allow end users to input a license key when creating a VM.
The template licenses in OnApp are managed in two places:
1. Template groups – where you specify which license types can be applied to templates assigned
to this group.
2. Billing plans – where you specify which license types a user on this plan can apply to their
Windows-based VMs.
 The billing plan settings override the template group settings. So if, for example, KMS
licensing is allowed by template group settings, but not enabled in billing plan configuration, the
user will not be able to create VMs using KMS licensing.
The user specifies the license type for a particular virtual machine during the VM creation process. The
list of available license types depends on the template which is chosen for the VM, and the billing plan
the user is signed up to.
To enable users to choose the license type:
1. Create a template group
2. Specify which licenses can be used within this group
3. Assign the templates to this group
65
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4.
5.
6.
7.
Create a billing plan
Specify which license types can be used within this plan
Assign template groups to a billing plan (optional)
Assign a user to this billing plan.
 Notes:
•
•
If you do not assign a template to a template group, the default MAK licensing is applied to that
template.
If you do not assign any template group to a billing plan, the user can build VMs on any template
available in the cloud. The choice of licenses will depend on the settings specified for the
template group to which this template belongs.
9.9.1 KMS licensing
To allow your users to create VMs (on Windows 2008 and Windows 7 templates) using KMS licensing:
1. Log in to your Control Panel as an Admin.
2. Enable KMS licensing for a particular template group, and attach the templates for which you
plan to enable KMS licensing to this group (see Template Groups in the next section).
 Only Windows 2008 and Windows 7 templates can have KMS licensing enabled!
3. Enable KMS licensing for a billing plan, and assign this template group to a billing plan (see the
Billing Plans section)
4. Sign up a user to this billing plan (see the Assign users to billing plans section).
9.9.2 MAK licensing
To add a MAK license to OnApp:
1. Go to your Control Panel’s Software Licenses menu.
2. Click the Add new License button.
3. Set the necessary parameters in the form that appears. Where:
o Label – Windows OS distribution (2003, 2008, 7)
o R2 – tick this parameter if your license is for the second edition of Windows OS distribution
o x64 or x86 - specify the architecture
o Specify the Edition – STD (Standard), ENT (Enterprise), WEB (web), PRO (Professional), DC
(Data center)
o License – enter the license code, e.g. TZXTC-R4GGG-9TT3V-DYDY4-T628B
o Total - the total number of machines allowed by the license (the amount of licenses you
bought from Microsoft)
4. Click Save
66
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
To view MAK license details:
1. Go to your Control Panel’s Software Licenses menu. This screen lists all the licenses you’ve
added to your OnApp installation with their details:
o Label – the license name specifying the OS distribution, architecture and edition, e.g.
Windows 2008 R2 x64 STD/ENT
o License - the license code
o Total - the number of VMs allowed by the license
o Count - the number of licenses used
To edit/delete an existing MAK license:
1. Go to your Control Panel’s Software Licenses menu. This screen lists all the licenses you’ve
added to your OnApp installation.
2. Click the edit/delete icons next to the license you’re interested in.
9.10 Template groups
Template groups enable you to organize individual templates into groups that can be used as a paid
resource for billing plans.
To add a template group:
1.
2.
3.
4.
5.
Go to your Control Panel’s Template Store menu.
On the page that follows, click the Add new template group button.
Give a name to your group.
Specify the Windows Licensing type: MAK, KMS, or User license.
For KMS licensing, set the following parameters:
• Server label – the name of the KMS server
• KMS server host – the hostname of the licensing server
• KMS server port – the port used to connect to the licensing server
6. Click Save.
7. On the page that appears, you’ll be prompted to assign a template to a group.
To assign a template to a template group:
1.
2.
3.
4.
Go to your Control Panel’s Template Store menu.
Click the name of the template group to which you wish to assign a template.
Choose the template from the drop-down box at the Add a template section.
Click Add a template to a group button to confirm.
67
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
To remove a template from a template group:
1.
2.
3.
4.
Go to your Control Panel’s Template Store menu.
Click the name of the template group from which you wish to remove a template.
On the page that follows, click the Delete icon next to a necessary template.
Confirm.
To change the template price:
1. Go to your Control Panel’s Template Store menu.
2. Click the name of the template group.
3. Click the price field next to the template which price you want to change and enter the value.
To view/edit/delete a template group:
1. Go to your Control Panel’s Template Store menu.
2. On the page that follows, you’ll see the list of all template groups created within your cloud:
o Click the template group label, to see the list of templates assigned to this group.
o Click the Edit icon next to a group to edit its name.
o Click Delete icon to delete a group.
68
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
10. Logs
OnApp logs all cloud management actions that take place on cloud resources, including virtual
machines, disks, data stores, hypervisors, templates, networks.
To access and manage logs:
1. Click the Control Panel’s Logs menu to view the log of all transactions in the cloud.
o To view details of a specific transaction, click its Ref number.
o You can also search for a transaction using the search box at the end of the list.
o Click Clean Logs to completely clear the log.
o Click Cancel All Pending Tasks to cancel all tasks scheduled for completion.
o Click Clean All Pending Backups to remove all pending backups from the log.
o You can relegate “pending” transactions to zombie status by clicking the pending status of a
transaction, and then clicking the “Failed” option in the pop-up window.
This option becomes available if the transaction has been pending for the period of time
specified in the Settings -> Configuration -> Zombie transaction time parameter.
69
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11. Settings
The Control Panel’s Settings menu is where you get detailed control over low-level cloud settings for
hypervisors, data stores, disks, networks, resolvers, schedules, backups and the configuration of OnApp
itself.
11.1 Hypervisor settings
Hypervisors are a critical part of the cloud. You should only change hypervisor settings if you’re
absolutely sure you know what you’re doing.
11.1.1 Add hypervisors
You can add more physical hypervisors at any time. To add a hypervisor:
1.
2.
3.
4.
5.
6.
Go to your Control Panel Settings menu.
Click the Hypervisors icon.
Click the Add New Hypervisor button underneath the list of Hypervisors on the screen.
Add the IP and label on the screen that appears.
Specify a memory overhead (MB) (see  note below).
Choose a hypervisor type and whether the hypervisor is enabled or not (hypervisors that are not
enabled cannot be used to host VMs).
7. Tick the box to disable failover on this hypervisor (failover is automatic VM migration to another
hypervisor if this one goes down)
8. Click the Add Hypervisor button. The hypervisor will be added to the system. You can view it
under the Hypervisor menu.
 A memory overhead is the amount of memory that a hypervisor itself is using besides the memory
allocated to virtual machines. Its size depends on the number of virtual CPUs, VMs guest memory, and
includes memory allocated to Xen Dom0.
Example calculation:
XEN memory overhead consists of the following parts:
o
o
o
o
Dom0 memory (400 Mb).. This is a standard value.
64 Mb for Xen itself.
1 Mb for each virtual CPU.
8 Kb for each 1 Mb of virtual machine RAM.
If we have 1 VM with 2 Gb Ram and 4 virtual CPUs, then:
o
Dom0 memory = 400Mb +64Mb (this is a standard minimum value, though you can allocate
more)
70
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
1Mb x 4 vCPUs = 4
2048 x 8/1024 = 16
XEN memory overhead = 464 + 4 + 16 = 484 Mb
The calculation is the same for KVM hypervisors.
11.1.2 Edit hypervisors
To edit a hypervisor:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu.
Click the Hypervisors icon.
Click the Edit icon next to the Hypervisor you want to edit.
On the screen that follows, change details as required:
o The hypervisor’s name (label).
o Its IP address.
o Its type (Xen, KVM etc).
o Whether it’s enabled or not (hypervisors that are not enabled cannot be used to host VMs).
o Memory overhead
o Tick the box to disable failover on this hypervisor (failover is automatic VM migration to
another hypervisor if this one goes down)
5. Click the Save Hypervisor button to save your changes.
11.1.3 Manage data stores for hypervisors
Data stores can easily be attached and removed from hypervisors. This association between a hypervisor
and a data store is called a data store join.
To add/remove data store joins:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu and click the Hypervisors icon.
Click the label of the hypervisor you want to manage data stores for.
On the screen that appears, click the Manage Data Stores link in the Actions section.
On the screen that follows, you’ll see a list of all data stores currently associated with this
hypervisor.
o To remove a data store join, click the Delete icon next to it. You’ll be asked for confirmation
before the store is removed.
o To add a new data store join, choose a data store from the drop-down menu and click the
Add Data Store button.
71
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.1.4 Manage networks for hypervisors
Networks can easily be attached and removed from hypervisors. This association between a hypervisor
and a network is called a network join.
To add/remove network joins:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu and click the Hypervisors icon.
Click the label of the hypervisor you want to manage networks for.
On the screen that appears, click the Manage Networks link in the Actions section.
On the screen that follows, you’ll see a list of all networks currently associated with this
hypervisor.
o To remove a network join, click the Delete icon next to it. You’ll be asked for confirmation
before the network is removed.
o To add a new network join, choose a network from the drop-down menu, enter its interface
name (eth0, eth1) and click the Add Network button.
11.1.5 Delete hypervisors
Hypervisors can be removed from your cloud if required. A hypervisor cannot be removed until all of the
virtual machines assigned to it are migrated to another hypervisor.
To remove a hypervisor:
1. Go to your Control Panel Settings menu.
2. Click the Hypervisors icon.
3. Click the Delete icon next to the hypervisor you want to delete.
11.1.6 User hypervisor permissions
OnApp administrators can control users’ ability to manage hypervisors. This is handled through the
Control Panel’s Users and Groups menu. You can set the following hypervisor permissions for user roles:
o
o
o
o
o
o
o
Any action on hypervisors
Create a new hypervisor
Remove any hypervisor
See all hypervisors
Update any hypervisor
Reboot any hypervisor
Hide hypervisors on VM creation
To set these permissions:
1. Go to your Control Panel’s Users and Groups menu.
2. Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
72
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
3. Click the Edit icon next to the relevant role.
4. Change the role’s permissions, then click the Save button.
11.2 Hypervisor zone settings
Hypervisor zones can be used to create different tiers of service - for example, by setting up different
zones for high-performance hypervisor servers, with different prices for virtual machines deployed on
that zone.
Hypervisor zones can have data stores and networks attached to them. The combination of hypervisor,
data store and network groups can be used to create private clouds for customers.
11.2.1 Create hypervisor zones
To create a new hypervisor zone:
1. Go to your Control Panel’s Settings menu and click the Hypervisor Zones icon.
2. Click the Add New Hypervisor Zone button.
3. On the screen that follows, give your hypervisor zone a name (label) and then click the Save
button.
11.2.2 View, edit and delete hypervisor zones
To view hypervisor zones:
1. Go to your Control Panel’s Settings menu, and click the Hypervisor Zones icon.
2. The screen that appears will show all zones currently set up in the cloud. These zones will also
show under the main Hypervisors menu in the Control Panel.
3. Click a zone’s label (name) to see details of the zone and to access the functions for
adding/removing hypervisors to/from the zone.
o Click the Edit icon next to a zone to change its name and disable failover of all the
hypervisors added to this zone.
o Click the Delete icon next to a zone to remove it from the cloud. You’ll be asked for
confirmation before the zone is removed.
11.2.3 View hypervisor zone details
To view details of a hypervisor zone:
1. Go to your Control Panel’s Settings menu and click the Hypervisor Zones icon.
73
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
2. Click the label of the zone you’re interested in. The screen that follows shows details of that
zone:
o Its name
o Actions to Edit Hypervisor Zone (change its name), Manage Data Stores and Manage
Networks
o A list of hypervisors assigned to the zone
o A list of hypervisors in the cloud that are not assigned to the zone
11.2.4 Add hypervisors to a hypervisor zone
To add a hypervisor to a zone:
1. Go to your Control Panel’s Settings menu and click the Hypervisor Zones icon.
2. Click the label of the zone you want to add a hypervisor to. The screen that appears will show
you all hypervisors in the cloud, organized into two lists – those assigned to the zone already,
and those that are unassigned.
3. In the unassigned list, find the hypervisor you want to add to the zone, and click the Add icon
next to it.
11.2.5 Remove hypervisors from a hypervisor zone
 You can only remove a hypervisor from a hypervisor zone if it currently hosts no virtual machines.
To remove a hypervisor from a zone:
1. Go to your Control Panel’s Settings menu and click the Hypervisor Zones icon.
2. Click the label of the zone you want to remove a hypervisor from. The screen that appears will
show you all hypervisors in the cloud, organized into two lists – those assigned to the zone
already, and those that are unassigned.
3. In the assigned list, find the hypervisor you want to remove, and click the Delete icon next to it.
11.2.6 Manage data stores for hypervisor zones
Data stores can easily be attached and removed from hypervisor zones. This association between a
hypervisor zone and a data store is called a data store join.
1.
2.
3.
4.
Go to your Control Panel’s Settings menu and click the Hypervisor Zones icon.
Click the label of the hypervisor zone you want to manage data stores for.
On the screen that appears, click the Manage Data Stores link in the Actions section.
On the screen that follows you’ll see a list of all data stores currently associated with this
hypervisor zone.
o To remove a data store from the zone, click the Delete icon next to it. You’ll be asked for
confirmation before the store is removed.
74
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
To add a new data store, choose one from the drop-down menu and click the Add Data
Store button.
11.2.7 Manage networks for hypervisor zones
Networks can easily be attached and removed from hypervisor zones. This association between a
hypervisor zone and a network is called a netwok join.
1.
2.
3.
4.
Go to your Control Panel’s Settings menu and click the Hypervisor Zones icon.
Click the label of the hypervisor zone you want to manage data stores for.
On the screen that appears, click the Manage Networks link in the Actions section.
On the screen that follows you’ll see a list of all networks currently associated with this
hypervisor zone.
o To remove a network, click the Delete icon next to it. You’ll be asked for confirmation
before the network is removed.
o To add a new network, choose one from the drop-down menu, enter its interface name
(eth0, eth1) and click the Add Network button.
11.2.8 User hypervisor zone permissions
OnApp administrators can control users’ ability to manage hypervisor zones. This is handled through the
Control Panel’s Users and Groups menu. You can set the following hypervisor zone permissions for user
roles:
o
o
o
o
o
o
o
Any action on hypervisor zones
See the list of all hypervisor zone
See details of any hypervisor zone
Create a new hypervisor zone
Delete any hypervisor zone
Update any hypervisor zone
Hide Hypervisors on VM creation
To set these permissions:
1. Go to your Control Panel’s Users and Groups menu.
2. Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
3. Click the Edit icon next to the relevant role. Change the role’s permissions, then click the Save
button.
75
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.3 Data store settings
Data stores provide disk space for your virtual machines and operating systems. Data stores are
attached to hypervisors. Use caution when changing data store settings!
11.3.1 Add data stores
To add a data store:
1.
2.
3.
4.
Go to your Control Panel Settings menu.
Click the Data Stores icon.
Click the Add New Data Store link at the bottom of the screen.
On the screen that appears enter a label and IP address for your data store, and set the capacity.
o If required, you can also disable the data store. When disabled, OnApp will not allow new
disks to be created automatically on that data store. This is useful to prevent an established
data store from becoming too full. It also lets you prevent the automatic creation of root
disks on ‘special’ data stores (high speed, etc).
o If required, you can also bind the data store with a local hypervisor. This is helpful if you
wish that the data store and a hypervisor were located on the same physical server thus
decreasing the time needed for a hypervisor-data store connection.
o If required, you can also assign the data store to a data store zone. The drop-down menu
lists all data store zones set up in the cloud (to add or edit data store zones, see the section
on Data store zones in the Settings section of this guide)
5. When you’ve finished configuring the store, click the Add Data Store button.
To use the data store, you have to assign it either to a hypervisor or a hypervisor zone.
11.3.2 View data stores
To view all data stores on your cloud:
1. Go to your Control Panel Settings menu.
2. Click the Data Store tab. The screen that appears lists all data stores currently available.
11.3.3 Edit data stores
To edit a data store:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu.
Click the Data Store icon. You’ll see a list of the data stores on your system.
Click the Edit icon next to the store you want to change.
As required, change the data store’s label, IP address, disk capacity and data store zone, and
whether the store is enabled or disabled.
5. Click the Save Data Store button to finish.
76
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.3.4 Delete data stores
To delete a data store:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu.
Click the Data Store icon.
You’ll see a list of the data stores on your system.
Click the delete icon next to the data store you want to delete. You’ll be asked for confirmation
before the store is deleted.
11.3.5 User data store permissions
OnApp administrators can control user access to data store management. To do so:
1. Go to your Control Panel’s Users and Groups menu.
2. Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
3. Click the Edit icon next to the relevant role. Change the role’s permissions as required to allow
or forbid users to:
o Perform any action on data stores
o See all data stores
o Create a new data store
o Update any data store
o Delete any data store
4. Click the Save button to finish.
11.4 Data store zone settings
Data store zones can be used to create different tiers of service – for example, by setting up different
zones for ordinary and high-performance SANs in the cloud. Zones can also be used to create private
clouds for specific users.
11.4.1 Create a data store zone
To create a new data store zone:
1. Go to your Control Panel’s Settings menu and click the Data store zones icon.
2. Click the Add New Data store zone button.
3. On the screen that follows, give your data store zone a name (label) and then click the Save
button.
77
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.4.2 View, edit and delete data store zones
To view/edit/delete data store zones:
1. Go to your Control Panel’s Settings menu, and click the Data store zones icon.
2. The screen that appears will show all data store zones currently set up in the cloud.
o Click a zone’s label (name) to see details of the zone and to access the functions for
adding/removing data stores to/from the zone.
o Click the Edit icon next to a zone to change the zone’s name.
o Click the Delete icon next to a zone to remove it from the cloud. You’ll be asked for
confirmation before the zone is removed.
11.4.3 View data store zone details
To view details of a data store zone:
1. Go to your Control Panel’s Settings menu and click the Data store zones icon.
2. Click the label of the zone you’re interested in. The screen that follows shows details of that
zone:
o Its name
o A list of data stores assigned to the zone
o A list of data stores in the cloud that are not assigned to the zone
11.4.4 Add data stores to a data store zone
To add a data store to a zone:
1. Go to your Control Panel’s Settings menu and click the Data Store Zones icon.
2. Click the label of the zone you want to add a data store to. The screen that appears will show
you all data stores in the cloud, organized into two lists – those assigned to the zone already,
and those that are unassigned.
3. In the unassigned list, find the data store you want to add to the zone, and click the Add icon
next to it.
11.4.5 Remove data stores from a data store zone
To remove a data store from a zone:
1. Go to your Control Panel’s Settings menu and click the Data Store Zones icon.
2. Click the label of the zone you want to remove a data store from. The screen that appears will
show you all data stores in the cloud, organized into two lists – those assigned to the zone
already, and those that are unassigned.
3. In the assigned list, find the data store you want to remove, and click the Delete icon next to it.
78
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.4.6 User data store zone permissions
OnApp administrators can control user access to data store zones management. To do so:
1. Go to your Control Panel’s Users and Groups menu.
2. Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
3. Click the Edit icon next to the relevant role. Change the role’s permissions as required to allow
or forbid users to:
o Create a new data store zone
o See details of any data store zone
o Delete any data store zone
o See all data store zones
o Perform any action on data store zones
o Update any data store zone
4. Click the Save button to finish.
11.5 Backup servers
Backup servers are servers responsible for storing backups and templates of virtual machines running in
the cloud, in order to prevent data loss in the event of failure.
There are now two ways to handle backup and template storage in your cloud.
1. Running disk-related actions on hypervisors
This was the default backup method prior to OnApp Cloud 2.3.2. In this scenario, template/backup
storage works as follows:
•
•
•
•
Backups and templates are stored on a single backup/template server.
Backup transactions are performed on hypervisors.
After the backup is taken on a hypervisor, it is put on the backup/template server. This
server can be accessed via SSH or NFS.
o In order to make this server accessible via SSH, you should configure SSH file
transfer server options.
o In order to make this server accessible via NFS, you should mount the appropriate
directory from this server to each hypervisor.
Backups created are stored at the path defined in Settings -> Configuration ->
Backups/templates
79
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
2. Running disk-related actions on one or more dedicated backup servers
This option does not use hypervisors to take backups. Instead, you deploy one or more dedicated
backup servers, which handle transactions and store all backups & templates.
•
•
If you have added one or more backup servers, all backups will be stored on these servers.
If there is more than one backup server, backups are performed on the server with the most
available disk space.
• Using this method, templates are also stored on the dedicated backup server(s). When
converting a backup to a template, the new template will be stored on the same server as the
backup.
Dedicated backup servers handle the following activities:
1. Backup and template related actions
o Take a backup
o Restore a backup
o Convert backup to template
o Destroy backup
o Destroy template
2. Disk related actions
o Configure OS on virtual machine
o Provision virtual machine
o Create disk
o Format disk
o Resize disk
o Migrate disk
o Destroy disk
3. VM related actions
o Set SSH keys
o Network Configuration
o Rebuild network
o Attach/detach Network Interface
If there are no dedicated backup servers in the cloud, all these actions will be performed by hypervisors,
and backups/templates stored according to the settings defined in Settings -> Configuration ->
Backups/templates.
 The new functionality (using dedicated backup servers) is available for non-local data stores only.
80
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
If your cloud uses a combination of local storage and SANs, you will only be able to use the new backup
method for virtual machines that have been allocated SAN-based storage.
If the new backup scheme is used, your SAN should be connected to the provisioning network.
Hypervisors need only be attached to the provisioning network if you’re using the previous backup
method.
If only local storage is used, you shouldn’t define any dedicated backup servers – instead, configure your
SSH or NFS settings in the Settings -> Configuration -> Backups/templates menu.
11.5.1 Create backup server
To create a backup server:
1. Go to your Control Panel’s Settings menu and click the Backup Servers icon.
2. Click the Add New Backup Server button.
3. Fill in the form that appears:
o Give your backup server a label.
o Enter the backup server IP address (IPv4).
o Set the backup server capacity (in GB).
4. Tick the Enabled box to enable the backup server.
5. Click the Add Backup Server button.
11.5.2 Edit backup server
To edit a backup server:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu and click the Backup Servers icon.
Click the backup server’s label.
On the screen that appears, you’ll see the list of all backup servers currently set up in the cloud.
Click the Edit icon next to the backup server to change the backup server’s properties:
o Label
o IP address
o Capacity (in GB)
o Enabled box – if you leave the enabled box empty, the backup server will be disabled.
5. Click the Edit a Backup Server button to save changes.
11.5.3 Manage backups for backup server
Click a backup zone’s label to perform the following actions with a backup server:
o
o
See the list of all backups currently present on the backup server.
Remove a particular backup.
81
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
Proceed to the backup page.
11.5.4 Delete backup server
To delete a backup server:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu and click the Backup Servers icon.
Click the backup server’s label.
On the screen that appears, you’ll see the list of all backup servers currently set up in the cloud.
Click the delete icon next to the backup server to remove it from the cloud. You’ll be asked to
confirm deletion.
 All the backups stored on that backup server will be deleted!
11.5.5 User backup server permissions
OnApp administrators can control users’ ability to manage backup servers through the Control Panel’s
Users and Groups menu. You can set the following backup server permissions for user roles:
•
•
•
•
•
Any action on Backup servers
Add a new Backup server
Delete any Backup server
See all Backup servers
Update any Backup server
To set the backup server permissions:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
Click the Edit icon next to the relevant role.
Change the role’s permissions and click the Save button.
11.6 Backup server zones
The Backup server zones feature can be used to create different tiers of service – for example, by
organizing backup servers in the cloud into different backup server zones. You can also specify limits and
prices individually for each Backup Server Zone assigned to the Billing Plan.
11.6.1 Create backup server zone
To create a new backup server zone:
1. Go to your Control Panel’s Settings menu and click the Backup Server Zones icon.
2. On the screen that appears, click the Add New Backup Zone button at the bottom of the list.
82
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
3. Give your network zone a name and click the Save button.
11.6.2 View backup server zone details
To view details of a backup server zone:
1. Go to your Control Panel’s Settings menu and click the Backup Server Zones icon.
2. On the screen that appears, you’ll see all backup server zones currently set up in the cloud.
3. Click the label of the zone you’re interested in. The screen that appears shows details of that
zone:
o Zone’s label.
o List of assigned backup servers.
o List of unassigned backup servers.
11.6.3 Edit backup server zone
To edit a backup server zone:
1. Go to your Control Panel’s Settings menu.
2. Click the Backup Server Zones icon.
3. Click the Edit icon next to the backup server zone to change the zone’s name.
4. Click Save.
11.6.4 Delete backup server zone
To delete a backup server zone:
1. Go to your Control Panel’s Settings menu
2. Click the Backup Server Zones icon.
3. Click the delete icon next to the zone to remove it from the cloud. You’ll be asked to confirm
deletion.
11.6.5 Add a backup server to backup server zone
To attach a backup server to the backup server zone:
1. Go to your Control Panel’s Settings menu and click the Backup Server Zones icon.
2. Click the label of the zone you want to attach a backup server to. On the screen that appears
you will see the list of all backup servers in the cloud organized into two groups – those already
assigned to this backup server zone and those that are unassigned.
3. Choose an unassigned backup server and click the add icon next to it.
83
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.6.6 Remove a backup server from a backup server zone
To remove a backup server to the backup server zone:
1. Go to your Control Panel’s Settings menu and click the Backup Server Zones icon.
2. Click the label of the zone you want to attach a backup server to. On the screen that appears
you will see the list of all backup servers in the cloud organized into two groups – those already
assigned to this backup server zone and those that are unassigned.
3. In the assigned list, find the backup server you want to remove, and click the Delete icon next to
it.
11.6.7 User backup server zone permissions
OnApp administrators can control users’ ability to manage backup server zones through the Control
Panel’s Users and Groups menu. The following backup server permissions for user roles can be set:
•
•
•
•
•
•
Any action on backup server zones
Create a new backup server zone
Delete any backup server zone
See list of all backup server zones
See details of any backup server zone
Update any backup server zone
To set the backup server permissions:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
Click the Edit icon next to the relevant role.
Change the role’s permissions and click the Save button.
11.7 Disk settings
The disk settings screen lets you view, edit, migrate and delete every disk in the cloud, and provides
quick access to their backup and schedule functions.
11.7.1 View and edit disks
The Disk Settings screen lists all the disks in the cloud and indicates disk ID, the disk size, the data store
they’re configured on, the virtual machine they’re assigned to, their type, status and backup status.
o
o
Use the Yes/No buttons to change their autobackup status.
Click the Edit icon next to a disk to change its size.
84
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
o
o
o
Click the Migrate icon next to a disk to migrate it to another data store.
Click the Statistics icon next to a disk to see its IOPS.
Click the Backups icon next to a disk to view its backups, and to take a new one.
Click the Schedules icon next to a disk to view its scheduled backups and to add a new schedule.
Click the Delete icon next to a disk to delete it. You’ll be asked for confirmation before the disk is
removed. All backups for this disk will be removed too.
11.7.2 User disk permissions
OnApp administrators control user access to disk management. This is handled through the Control
Panel’s Users and Groups menu. You can set the following disk management permissions for user roles:
o
o
o
o
o
o
o
o
o
o
o
Allow/forbid users to perform any action on disks
See all disks
See own disks
Autobackup any disk
Autobackup own disk
Create a new disk
Update any disk
Update own disk
Unlock any disk
Delete any disk
Delete own disk
To set these permissions:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
Click the Edit icon next to the relevant role.
Change the role’s permissions for disks as required, then click the Save button.
11.8 Resolver settings
OnApp Resolvers work like DNS servers – they translate a hostname to an IP address.
 You should specify at least 2 resolvers for each network in OnApp. When a new VM is provisioned,
these resolvers are injected into the resolver configuration automatically.
11.8.1 View resolvers
To view the resolvers on your system:
85
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1. Go to your Control Panel’s Settings menu.
2. Click the Resolvers icon. The screen that appears lists all resolvers set up for your cloud.
11.8.2 Edit resolvers
To edit an existing resolver:
1. Go to your Control Panel’s Settings menu.
2. Click the Resolvers icon.
3. Click the Edit icon next to the resolver you want to change.
11.8.3 Deleting resolvers
To delete an existing resolver:
1. Go to your Control Panel’s Settings menu.
2. Click the Resolvers icon.
3. Click the Delete icon next to the resolver you want to change. You will be asked for confirmation
before the resolver is removed.
11.8.4 User resolver permissions
OnApp administrators control how users can manage resolvers. This is handled through the Control
Panel’s Users and Groups menu. You can set the following resolver permissions for user roles:
o
o
o
o
o
Create a new resolver
Perform any action on resolvers
Remove any nameserver
Update any nameserver settings
See all nameservers
To set these permissions:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
Click the Edit icon next to the relevant role.
Change the role’s permissions for resolvers as required, then click the Save button.
11.9 Network settings
OnApp enables you to modify network configurations quickly and easily. Use caution when changing
network settings.
86
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
11.9.1 View networks
To view the networks currently available in your cloud:
1. Go to your Control Panel’s Settings menu.
2. Click the Networks icon.
3. The screen that appears shows every network available in your cloud.
o Click a network’s label to show details of IPs assigned to that network, and to add new IP
addresses.
o Click the Edit icon to change the network’s label, VLAN and network zone settings.
11.9.2 Add new networks
To add a new network:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu.
Click the Networks icon: the screen that appears shows every network available in your cloud.
Click the Add New Network button at the end of the list.
On the screen that follows, give the new network a name (label), a VLAN number, and assign it
to a network zone if required.
5. Click the Add Network button to finish.
 The network label is simply your choice of a human-readable name – “public”, “external”, “1Gb”,
“10Gb” etc. The VLAN field only needs to be given a value if you are tagging the IP addresses you will add
to this network with a VLAN ID (IEEE 802.1Q). If you plan to tag IP addresses in this way, you need to
make sure the link to the public interface on the hypervisors is a trunked network port. If you are not
VLAN tagging addresses, this field can be left blank and the public port on the hypervisor can be an
access port
 Once you have added a network to OnApp you will need to add an IP address range to the new
network.
To use the network, you have to assign it either to a hypervisor or a hypervisor zone.
11.9.3 Add IP address(es) to a network
Once a network has been added you need to add IP addresses to that network. The system supports
dual-stack protocol implementation (both IPv4 and IPv6).
To add IPv4 or IPv6 addresses:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu.
Click the Networks icon: the screen that appears shows every network available in your cloud.
Click the name (label) of the network you want to add addresses to.
On the screen that follows you’ll see a list of all IP addresses currently assigned to this network.
87
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
5. Click the Add New IP Address button at the bottom of the screen, and complete the form that
appears:
o IP Address – You can create either single IP address or a range of IP addresses.
o Single IP address example: '192.168.1.5' (IPv4); '2001:db8:0:0:8:800:200C:417A'
(IPv6).
o Range example: '192.168.0.2-254' or '192.168.0.2-192.168.0.254' (IPv4);
'2001:db8:8:800:200C:417A-427A' (IPv6).
o Netmask – Netmask example: '255.255.255.0' (IPv4) or '24' (IPv6).
o Gateway – Enter a single IP to specify a gateway. If you leave this blank the address will be
added without a gateway.
o Don’t use as primary during VM build – If you tick this box, the IP addresses you add will
never be assigned as primary IPs. Primary IPs are only allocated to VMs when the VM is
built, so with this box ticked, the address range will never be assigned to a newly built VM.
6. Click the Add New IP Address button to finish.
 The number of IP addresses you can add at one time is defined on the Settings -> Configuration
screen, under the Interface tab. To add more IP addresses than the maximum number configured,
just repeat the procedure again.
11.9.4 Edit networks
To change the name, VLAN or network zone of an existing network:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu.
Click the Networks icon.
Click the Edit icon next to the network you want to change.
Change its details on the screen that follows, then click the Save Network button.
 The network label is simply your choice of a human-readable name – “public”, “external”, “1Gb”,
“10Gb” etc.
The VLAN field only needs to be given a value if you are tagging the IP addresses you will add to this
network with a VLAN ID (IEEE 802.1Q). If you plan to tag IP addresses in this way, you need to make sure
the link to the public interface on the hypervisors is a trunked network port. If you are not VLAN tagging
addresses, this field can be left blank and the public port on the hypervisor can be an access port.
11.9.5 Delete networks
To delete an existing network, so it is no longer available as a cloud resource:
1. Go to your Control Panel’s Settings menu.
2. Click the Networks icon.
88
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
3. Click the Delete icon next to the network you want to remove. You will be asked for
confirmation before the network is deleted.
11.9.6 User network permissions
OnApp administrators control how users can manage network resources. This is handled through the
Control Panel’s Users and Groups menu.
You can set the following network management permissions for user roles:
o
o
o
o
o
Perform any action on networks
See all networks
Create a new network
Update any network settings
Remove any network
To do so:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
Click the Edit icon next to the relevant role.
Change the role’s permissions for networks as required, then click the Save button.
11.10
Network zone settings
Network zones can be used to create different tiers of service – for example, by setting up different
zones for different network resources in the cloud. Zones can also be used to create private clouds for
specific users.
11.10.1
Create network zones
To create a new network zone:
1. Go to your Control Panel’s Settings menu and click the Network zones icon.
2. Click the Add New Network zone button.
3. On the screen that follows, give your network zone a name (label) and then click the Save
button.
11.10.2
View, edit and delete network zones
To view network zones:
1. Go to your Control Panel’s Settings menu, and click the Network zones icon.
2. The screen that appears will show all network zones currently set up in the cloud.
89
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
3. Click a zone’s label (name) to see details of the zone and to access the functions for
adding/removing networks to/from the zone.
o Click the Edit icon next to a zone to change the zone’s name.
o Click the Delete icon next to a zone to remove it from the cloud. You’ll be asked for
confirmation before the zone is removed.
11.10.3
View network zone details
To view details of a network zone:
1. Go to your Control Panel’s Settings menu and click the Network zones icon.
2. Click the label of the zone you’re interested in. The screen that follows shows details of that
zone:
o Its name
o A list of networks assigned to the zone
o A list of networks in the cloud that are not assigned to the zone
11.10.4
Add networks to a network zone
To add a network to a zone:
1. Go to your Control Panel’s Settings menu and click the Network Zones icon.
2. Click the label of the zone you want to add a network to. The screen that appears will show you
all networks in the cloud, organized into two lists – those assigned to the zone already, and
those that are unassigned.
3. In the unassigned list, find the network you want to add to the zone, and click the Add icon next
to it.
11.10.5
Removing networks from a network zone
To remove a network from a zone:
1. Go to your Control Panel’s Settings menu and click the Network zones icon.
2. Click the label of the zone you want to remove a network from. The screen that appears will
show you all networks in the cloud, organized into two lists – those assigned to the zone
already, and those that are unassigned.
3. In the assigned list, find the network you want to remove, and click the Delete icon next to it.
11.10.6
User network zone permissions
OnApp administrators control a user’s ability to manage network zones. This is handled through the
Control Panel’s Users and Groups menu.
90
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
You can set the following network zone management permissions for user roles:
o
o
o
o
o
o
Allow/forbid users to perform any action on network zones
See all network zones
Create a new network zone
See details of any network zone
Remove any network zone
Update any network settings
To set these permissions:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
Click the Edit icon next to the relevant role.
Change the role’s permissions for network zone as required, then click the Save button.
11.11
Schedule settings
The schedules settings screen lets you view, edit and delete all backups scheduled for virtual machines
in the cloud. When a schedule is no longer needed, we recommend deleting it so that the task will no
longer run.
11.11.1
View, edit and delete schedules
To view, edit and delete schedules:
1.
2.
o
o
Go to your Control Panel’s Settings menu.
Click the Schedules icon to see a list of all schedules on the system.
Click the Delete icon next to a schedule to remove it.
Click the Edit icon next to a schedule to change its frequency.
11.11.2
User schedules permissions
OnApp administrators control users ability to manage schedules. This is handled through the Control
Panel’s Users and Groups menu. You can set the following schedule management permissions for user
roles:
o
o
o
o
o
Create a new schedule
See all schedules
Perform any action on schedules
See own schedules
Remove any schedule
91
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
o
Update any schedule
Remove own schedules
Update own schedules
To set these permissions:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
Click the Edit icon next to the relevant role.
Change the role’s permissions for schedules as required, then click the Save button.
11.12
Autobackup preset settings
Autobackup presets are a simple way to set up an automatic backup schedule when Virtual Machines
are created. Once configured, they can be applied to a VM automatically when the Automatic Backups
Required box is checked during VM creation.
A number of preset backup time periods are available (daily, weekly, monthly and annual backups)
which are configured further by specifying how often each backup is taken. So, for example, you can set
up automatic backups every 2 days, or every 1 month, or even every 12 months (the same as every 1
year). Each type of backup can be enabled or disabled.
To view and edit autobackup presets:
1. Go to your Control Panel’s Settings menu
2. Click the Autobackup Presets icon. You’ll see a list of the presets available on the following
screen, and whether they are enabled or not.
3. To change a preset, click its Edit icon, change the period and frequency, and decide whether
that preset is enabled or not.
4. Click the Save button to finish.
 The combination of Autobackup Presets and Scheduled VM backups provides a great deal of flexibility
in the way backups are handled for the cloud, and for individual VMs. Autobackup Presets can be applied
to all new VMs added to the cloud. Scheduled VM backups enable specific backups to be scheduled for
individual VMs, outside of the autobackup pattern.
11.13
License
The license screen lets you view and edit your OnApp license key details. To edit OnApp license details:
1.
2.
3.
4.
Go to your Control Panel’s Settings menu.
Click the license icon.
On the screen that appears, click the Change License key button.
Change the license key and click the save button to save changes.
92
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
5. To accelerate the license validation after changing the license, click the Restart License Client
button.
11.14
Configuration settings
The configuration settings screen lets you change various aspects of your OnApp installation. To edit
these OnApp configuration settings:
1. Go to your Control Panel’s Settings menu.
2. Click the Configuration icon. Click the tabs to edit the relevant config settings (System,
Backups/Templates, Interface) – these are explained in the subsections that follow.
11.14.1
Edit System configuration
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:
Hypervisor
o Number of requests before marked as failed - determines how many times the Control
Panel server will attempt to contact a hypervisor before failover is initiated.
 If you change settings here and save, the Control Panel server will restart OnApp services.
Application updates
o Update server URL - the location OnApp software updates are downloaded from.
License info
o [key] - the key for your OnApp installation. Virtual machine console ports
VM Console Ports
These are the ports used to remotely connect to virtual machines using the integrated VNC
console.
o
Set the port range using the first and last port fields.
 If you change settings here and save, the Control Panel server will restart OnApp services.
Email
This is where you configure OnApp to send email alerts for failed transactions and changes of
hypervisor status.
o
o
o
Send notification - tick this to enable email alerts.
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.
93
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
To - the email address to which the system will send alerts about failed transactions and
change of hypervisor status.
Miscellaneous
o Config comment - this text is added by OnApp to system configuration files, such as
resolv.conf
o Application name – here you may change the application name
o CPU guarantee – tick this box to make sure there is enough CPU on the system to create a
new VM.
 This prevents the system from creating VMs with more CPU than is available for a hypervisor.
For example, on a hypervisor with 4 CPU cores, with CPU guarantee enabled, you will only be
able to create 4 VMs with 100% CPU priority. The system will not allow you to create a 5th VM.
o
o
o
Number of simultaneous transactions - the number of transaction runners which
the daemon will execute at the same time.
Specify a network address on New VM page – tick this checkbox to enable IP
address assignment during VM creation.
Zombie transaction time - set the duration in minutes for the system to consider a
task as “pending” before it can be relegated to zombie status.
Delay in seconds between executing background tasks
Sets frequency in seconds for executing the following tasks:
o Backup Taker
o Billing Stats Monitor
o Cluster Monitor
o Hypervisor Monitor
o Schedule Runner
o Transaction Runner
3. Click the Save Configuration button to finish.
11.14.2
Edit Backup/Template configuration
1. Go to your Control Panel’s Settings menu, and click the Configuration icon.
2. Click the Backups/Templates tab to manage the following settings:
Paths
Sets paths for various OnApp files (shown here with default path examples)
o
o
o
Templates - /data/templates
Recovery templates - /onapp/tools/recovery
Backups - /data/backups
94
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
Backup/template server
Backups and templates can be stored on a remote server or a mounted disk. To store backups &
templates remotely, configure the following settings:
o
o
o
o
Use ssh file transfer - tick this to allow secure file access, transfer and management to a remote
server.
Server IP - The address of the remote server.
User name - The login used for remote server authentication. A password is not required, as it is
required that you store a host key.
Options - The ssh protocol options that set the rules and behavior of how to log into the remote
server. By default, the options are set to omit adding new host keys to the host file, and skip
password authentication. They also specify the path where the host key is stored. For a detailed
list of configuration options, refer to ssh protocol man pages (under the -o option description.
See http://unixhelp.ed.ac.uk/CGI/man-cgi?ssh+1).
Backup processes
o
o
o
Total number allowed - the maximum number of hypervisor and data store backup
processes allowed at once.
Total per data store - if this number exceeds the overall total, the overall total limit will be
enforced.
Total per hypervisor - if this number exceeds the overall total, the overall total limit will be
enforced.
 For example: if Total number allowed is 10, and Total per data store and Total per
hypervisor are set to 5, then up to 10 backups can be taken at once is 10 – 5 per data store,
and 5 per hypervisor.
3. Click the Save Configuration button to finish.
11.14.3
Edit Interface configuration
1. Go to your Control Panel’s Settings menu, and click the Configuration icon.
2. Click the Interface tab to change the following application settings:
Locales
o
Allowed locales – select locales which will be available for the users.
IP range limit – set the number of IPs that can be added as a range at the same time.
AJAX update rates (ms)
VM status - how often VM status is refreshed on the Virtual Machines screen.
95
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
Dashboard/logs/other - how often the dashboard, logs and other items are refreshed.
Number per page for
o
set how many entries the Control Panel will display for the following:
o Virtual Machines
o Hypervisors
o Logs (how many log entries the Logs page will display)
o Transactions (how many entries the API request will output)
o Templates
o Network
o IP Addresses
o Billing Plans
o Permissions
o Disks
o Schedules
3. Click the Save Configuration button to finish.
11.14.4
Edit Defaults configuration
1. Go to your Control Panel’s Settings menu, and click the Configuration icon.
2. Click the Defaults tab to change the following application settings:
New Virtual Machines
o Default VM OS - the default OS for VM creation on the Add a new virtual machine screen.
o Default VM Template - choose a particular OS template as the default for VM creation. A
new virtual machine will be created using this template, unless otherwise set in the wizard.
Firewall
o Default firewall policy – default settings for a VM’s Networking -> Firewall tab (accept/drop)
o Enable KVM anti spoofing (beta) – tick the box to run the anti-spoofing mechanism for IP
addresses of the network interfaces attached to KVM-based virtual machines. To apply the
anti-spoofing, it is necessary to restart the Control Panel and OnApp Daemon.
 Currently, the anti-spoofing works only for one IP address per network interface. This
limitation will be removed in a future release.
SSH Options
o SSH port – specify the port used to connect to hypervisors and backup servers.
SSH Keys
96
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
View SSH-keys – click to add/edit/delete the administrator SSH keys. The keys will
be automatically assigned to all VMs which will be created in the cloud later. To
assign the keys to existing VMs, go to VM Overview -> Properties menu.
3. Click the Save Configuration button to finish.
97
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
12. Localization and customization
You can easily adapt the Control Panel to your requirements by translating to different custom
languages, adding new currencies and currency formats, and changing images, colors, names and titles.
You can also assign differently localized/customized Control Panel views to different users. This chapter
explains all of this functionality.
12.1 Languages
OnApp uses a standard Rails I18n internationalization system. You can add any language to your Control
Panel and translate all the interface labels, error messages and other texts into a single custom language
or several languages.
12.1.1 Add custom languages
You can add custom languages in two ways:
•
•
Translate the .yml language files of your installation.
Translate the phrases using Control Panel UI.
To translate the .yml language files:
1. Go to the /onapp/interface/config/locales directory of your OnApp installation.
2. Translate the files that are located in this directory:
• en-currency.yml – currency details
• en-flash.yml – error messages and warnings
• en-helpers.yml - some interface labels of several templates
• en-models.yml – the attributes of the models (for VM model it is CPU, RAM, shares etc.)
• en-permission.yml – user role permissions
• en.mailer.yml – email alerts
• en.yml – all other interface labels
3. Save the translated files as your_language_code.yml at /onapp/interface/config/locales. For
example for German they will be de.yml, de.mailer.yml or de-flash.yml
Alternatively, you can translate the language files through your Control Panel UI:
1.
2.
3.
4.
Go to your Control Panel’s Settings -> i18n Customization menu.
Click Add new locale button and select the required language from the list.
Click the appropriate custom language name.
On the screen that appears:
• Subset name – the names correspond to the .yml files located at
/onapp/interface/config/locales directory
• English Items – the number of phrases in the original language files
98
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
Custom Language Items – the number of translated phrases in the custom language
files
• Missing Items – the number of phrases which haven’t been translated yet to a custom
language
• Out of Date Items – the number of phrases which have changed in English since the
translation was made.
5. Click a subset name. On the screen that follows:
• Provide a translation in the Custom Language Phrase field next to an appropriate English
value. Click Update.
• To copy the English value to a target custom language, click the arrow in the Copy
column next to a required value.
• Red rows indicate phrases that exist in English but are missing in your custom language.
• Yellow rows indicate phrases that exist in English and your custom language, but where
the English phrase has been changed since the last translation.
• Green rows indicate phrases that exist in both English and your custom language, where
the English version is still the same as when it was translated.
You can scroll through the list of phrases with the Previous/Next buttons at the bottom of the screen.
12.1.2 Enable a custom language for a specific user
Now that you have added one or more custom languages, you can specify which language a particular
user will see in their view of the Control Panel. For this:
1.
2.
3.
4.
5.
Go to your Control Panel’s Users and Groups menu.
Click a user’s name.
On the page that appears, click the Edit Profile tab.
Choose your custom language from the Locales drop-down list.
Click Save.
12.2 Currencies
By default the system includes three currencies: USD, EUR and GBP. You can add more currencies at any
time.
12.2.1 Add currencies
To add a currency:
1. Go to your Control Panel's Settings menu.
2. Click the Currencies icon.
3. On the page that follows, click the Add New Currency button.
99
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
4. Fill in the form that appears:
o name - give the label to your currency
o unit - insert a currency symbol
o code - –fill in a three-character currency code that is generally used to represent the
currency you wish to add
o separator - – specify a character used to format decimal numbers, e.g 100.99.
o delimiter - – set a grouping character used to separate thousands, e.g: 100,000,000.
o precision – specify the number of digits after the delimiter. The precision parameter is used
to display the costs total for a certain period, e.g. Outstanding amount, Total Cost,
Payments.
o precision per unit – the number of digits after the delimiter. The precision per unit
parameter is used to display the prices for the resources , e.g. for CPU, Disk size, RAM, IP,
Data stores, Edge servers, Disks, Backups, Templates, etc.
o format - set how the currency will be displayed in the control panel. Use the following
parameters:
o %n - for the digits
o %u - for the currency symbol
5. Click Save.
 For example, the currency form for US Dollars might look as follows…
o
o
o
o
o
o
o
o
Name:
US Dollar
Unit:
$
Code:
USD
Separator:
.
Delimiter:
,
Precision:
5
Precision per unit :
8
Format:
%n %u
…and the prices will be displayed in the following way: $7,000.00000
12.2.2 Edit/delete currencies
To edit and delete existing currencies:
1. Go to your Control Panel’s Settings menu.
2. Click the Currencies icon.
o To edit a currency, click the Edit icon next to it, edit its details on the screen that appears,
then click the Save button.
o To delete a currency, click the Delete icon next to the currency you want to remove. You will
be asked for confirmation before the currency is deleted.
100
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
 You cannot delete a currency that is associated with a billing plan.
12.3 Look & feel
You can skin various aspects of the Control Panel’s look & feel, including the logo displayed, background
colors and other graphics. To do so:
1. Go to your Control Panel’s Settings menu and click the Look & Feel icon.
2. Click the Add a new theme button.
3. Use the fields provided to skin the UI, as explained below.
 Changes, including disabling and deleting UI elements, will not be applied unless the Enable Skin
checkbox is ticked, and you click the Save Skin button at the bottom of the screen.
Theme properties
o
o
o
Label - give a name to your theme.
Active – use this checkbox to specify whether the theme is displayed or not. If this box is not
checked, the default colors and graphics are used, irrespective of other settings.
User Group - check the groups of users for whom you wish to apply the theme.
General
o
Application title - enter the desired title which will be displayed at the top left corner of the
browser window.
o
Logo - click the Browse button to choose a custom logo.
o Check the Disable box to prevent a logo from displaying.
o Check the Delete box to remove a custom logo.
o
Favicon - click the Browse button to choose a custom logo.
o Check the Disable box to prevent the favicon from displaying.
o Check the Delete box to remove a favicon.
o
Images Folder - this is name of the folder which you create to store alternative images (e.g.
icons, buttons, breadcrumbs, etc).
o The folder should be created at the /public/images/custom location.
o Make sure the structure of the folder you created is the same as the structure of the
images folder: the names and number of the folders should stay the same, except the
custom folder.
o
Powered by - check the Hide box to remove the Powered by OnApp message at the top of the
navigation pane.
o Enter an URL you wish to link to instead of http://www.onapp.com/.
101
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
Specify the text which will be added after Powered by instead of OnApp.
o
Background color - this is the color displayed in the main body of the page (e.g. behind the fields
you’re currently editing).
o To change the color, click the field to pop up a palette chooser, or enter a CSS color
code.
o To revert to the default color, leave this field blank.
o The color will not be displayed unless any full screen Background Image you’re using is
disabled.
o
Top background image - click the Browse button to choose a custom image.
o Check the Disable box to prevent the top background image displaying.
o Check the Delete box to remove a custom image.
o
Footer background image - click the Browse button to choose a custom image.
o Check the Disable box to prevent the footer image displaying.
o Check the Delete box to remove a custom image.
Wrapper
o
Background color - this is the color displayed around the rest of the UI.
o To change the color, click the field to pop up a palette chooser, or simply enter a CSS
color code To revert to the default color, leave this field blank.
o The color will not be displayed unless any full screen Background Image you’re using is
disabled.
o
Background image - click the Browse button to choose a custom image.
o Check the Disable box to prevent the top background image displaying.
o Check the Delete box to remove a custom image.
o
Enable Skin - this controls whether the skin is displayed or not. If this box is not checked, the
default colors and graphics are used, irrespective of other settings.
o
Header&Footer HTML - enter the html codes to display instead of default header and footer.
12.4 User customization and localization permissions
System administrators can control each user’s ability to customize and localize the application. This is
handled through the Control Panel’s Users and Groups menu.
To set these permissions:
1. Go to your Control Panel’s Users and Groups menu.
102
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
2. Click the Roles tab. You’ll see a list of all roles on your system on the following screen.
3. Click the Edit icon next to the relevant role.
4. Change the role’s permissions as required, then click the Save button.
You can set the following permissions for user roles:
Internationalization
o
Enable internationalization locales (i18n.manage)
Currencies
•
•
•
•
•
•
Any action with Currencies (currencies)
The user can take any action on currencies
Create new Currency (currencies.create)
Delete any Currency (currencies.delete)
See list of all Currencies (currencies.read)
Update all Currencies (currencies.update)
Look & feel
•
•
•
•
•
•
Any action on Themes (themes)
User can make any action on themes
Create Theme (themes.create)
Destroy Theme (themes.delete)
Read Theme (themes.read)
Update Theme (themes.update)
12.5 Localization and Customization Search
The search box in the Localization and Customization menu allows you to search by the following
parameters:
• Item ID
• English Value
• Translation
To search:
1.
2.
3.
4.
Log in to your Control Panel.
Go to the Settings menu.
Click the I18n Customization icon.
Click the required language Name (e.g. “English”).
103
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
5. On the following page, click the appropriate Subset Name (e.g. “core”).
6. Type the search phrase into the search box and press Return.
7. If required, make changes and click Update.
104
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
13. Users
OnApp provides very fine control over cloud users and what they’re allowed to do. You can set up as
many different types of user as you need, and customize their access to cloud resources and Control
Panel functions as required.
For example, standard, VIP and reseller users can have different capabilities and resource limits. You
might provide basic cloud management functionality to L1 support staff (e.g. reboot virtual machines
but not destroy them) while your L3 admins have full rights. Your development teams will probably need
to deploy test VMs in the cloud just as a customer would, only without being charged for them.
Meanwhile, your billing staff need a “billing only” view with no access to customer resources.
This fine control is enabled by a combination of user accounts, roles and permissions and billing plans.
13.1 User accounts
There are two types of accounts in OnApp: administrators and users. An administrator account is
created automatically when OnApp is installed. Administrators have full access to the system, including
managing virtual machines and hypervisors, performing actions on templates and backups, and
configuring data stores and networks. There can be several Administrators in OnApp.
User accounts are created by administrators, and only have access to those actions which are specified
by an administrator.
13.1.1 View user account details
For a quick view of user account details, go to your Control Panel’s Users and Groups menu. You’ll see a
list of all user accounts in your cloud, along with a brief summary of their account:
o
o
o
o
o
o
o
Login/email
User role and group - to edit a group, click its label. When a drop-down box appears, choose a
desired group and press Enter.
Virtual machines – shows the list of all VMs owned by this user.
Payments - click to see the list of paid invoices.
Billing plans - click to see billing plan details.
Monthly bills - click to see the total amount of charges applied to this user for each month
during the year specified in the drop-down box.
Usage statistics - click to see the billing details for a user. Refer to the View user account billing
statistics chapter for details.
You can scroll through the list of users with the Previous/Next buttons at the bottom of the screen, as
well as searching for a specific user.
105
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
To view detailed information about users account, click a user’s name. The user details screen that
appears shows the following information:
User details
o
API key - click Change key to generate a new key.
Billing details
o
o
o
o
o
Billing plan - click the plan label to see its details.
Monthly price - a set monthly price for a billing plan.
Outstanding amount - the total amount of money owned by this user since it has been created,
for all resources, minus the amount of Payments. The sum is displayed for the period since a
user has been created until the last 24hrs.
o Click the Details link to see the hourly billing statistics for all VM resources (CPU, CPU
priority, Disk Size, Memory, IP Address, Virtual Machine, Template&Backup Storage,
Disk size and IP Address) and Network interface usage (Data read/written, Input/Output
requests, Port speed, Data received and Data sent), as well as total amount due for this
user.
o Click the Monthly bills list to show the total due per each month of the year specified in
the drop-down list.
Payments - the total amount of payments made.
Hourly price - shows the price for VMs, Load Balancers, and other resources per hour.
User role
User group
User payments - the list of payments with their details.
13.1.2 View, add & edit user payments
To view, add and edit payments for a user:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Payments link next to a user in the list to view all payments on the system for that user.
Click the Edit icon to change details of a specific payment.
Click the Add New Payment button at the end of the list to add a new payment.
106
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
13.1.3 View user account billing statistics
The system has a record of all the billing statistics on a user account for the last three months. If the
account was created less than three months ago, statistics are generated for the actual period. You can
also define a shorter period by setting Start and End time.
To view billing statistics for an account:
1. Go to your Control Panel’s Users and Groups menu.
2. You’ll see a list of all user accounts in your cloud. Click the User Statistics link next to a user in
question.
3. Set Start and End time. By default the statistics are generated for the last three months or the
actual account existence period. On the page that appears:
o Daily Stats – particular date and time for the generated statistics
o Used Resources Cost – the total due for the resources used for all virtual machines
o Virtual Machines cost – the total due for all the VMs minus Backups/Templates Cost (if any)
o Total cost – the sum of Used resources cost and Virtual Machines cost
o Resources cost – the money owed per virtual machine for the following resources:
o CPU
o CPU Priority
o Disk Size
o Memory
o IP Address
o Virtual Machine
o Template&Backup Storage
o Disk size
o IP Address
o Usage cost – the money owed per virtual machine for the following resource usage:
o Data read/written
o Input/Output requests
o Port speed
o Data received
o Data sent
o Total – the total due per virtual machine for Resources and Usage cost.
13.1.4 Whitelist IPs
An OnApp White List is a list of IPs from which a particular user has an access to control panel. By
entering an IP to the white list, you thus restrict an access for this user from any other IPs that are not in
the list.
To whitelist an IP:
1. Go to your Control Panel's Users and Groups menu.
107
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
2.
3.
4.
5.
Click the name of the required user. You will see the User Profile page.
Click the White List tab.
On the page that appears, click Add new IP button.
Fill in the form that appears:
o IP - an IP you wish to enter to the white list.
o Description - any description (this may be a reason why you entered an IP to the list, etc.)
6. Click Add new IP.
7. Repeat steps 4-6 if you need to add more IPs to the white list.
To edit/delete a whitelisted IP, go to your Control Panel's Users and Groups -> User Profile page, click
the White List tab and use the corresponding icons next to the questioned IPs.
13.1.5 Log in as a user
Administrators can log in as a user to see their view of the cloud. To do so:
1. Go to your Control Panel’s Users and Groups menu. You’ll see a list of all user accounts in your
cloud.
2. Click the Login as user icon next to the user you’d like to log in as.
3. Your screen will refresh and you should now be logged in as that user.
 To return to your original view of the cloud, click the Back to Admin Area link at the top of the screen.
13.1.6 Add new users
To add a new user:
1. Go to your Control Panel’s Users and Groups menu. You’ll see a list of all user accounts in your
cloud.
2. Click the Add New User button at the bottom of the list.
3. Provide details on the screen that appears:
o Login name. It can consist of 4-40 characters, letters [A-Za-z], digits [0-9], dash [ - ], lower
dash [ _ ], [@]. You can use both lower- and uppercase letters.
o First/Last names. It can consist of any 1-20 characters.
o Password. It can consist of any 6-40 characters.
o Email address
o Time zone
o Locale (see Locales)
o User role
o Billing plan
o User group
4. Specify Auto-suspending options if any. You can configure the system to suspend a user at a
definite time or in several hours after creation.
108
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
5. Click the Save button to finish.
13.1.7 User Additional Fields
User Additional Fields allow administrators to create custom fields and use them with the API or a third
party system. The custom fields are stored and edited in the user profile.
To add a new Additional Field:
1.
2.
3.
4.
5.
Log in to the Control Panel as an Admin.
Go to the Users and Groups menu.
On the screen that appears, click the User Additional Fields button at the bottom of the list.
Click the Add New User Additional Field at the bottom of the list.
Fill in the form that appears. You can choose the string/integer data type, and set the Default
Value that will be displayed if a user hasn't specified data for this field, or if they have entered
information that doesn't match the data type.
6. Click the Add New Field button to finish.
To edit and delete an Additional Field:
1. Click the Edit icon next to an Additional Field to change its details.
2. Click the Delete icon next to an Additional Field to delete a particular field.
13.1.8 Edit users
To edit a user account:
1. Go to your Control Panel’s Users and Groups menu. You’ll see a list of all user accounts in your
cloud.
2. Click the Edit icon next to the user you want to edit.
3. Change their details as required on the screen that appears.
4. Click the Save button to finish.
13.1.9 Add SSH key
To add a SSH key to a user profile:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Edit icon next to the required user.
Click the SSH-key button.
On the pop-up screen you may add a new key, and edit/delete a key.
The SSH key will be automatically assigned to all VMs the user creates.
109
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
To assign keys to existing VMs, go to the VM Overview -> Properties menu.
13.1.10
Delete users
To delete a user account:
1. Go to your Control Panel’s Users and Groups menu. You’ll see a list of all user accounts in your
cloud.
2. Click the Delete icon next to the user you want to remove. You’ll be asked for confirmation
before the user is deleted.
13.1.11
Suspend and activate users
Suspending a user account makes it inactive, but still present on the system. A suspended user will not
be able to log into the Control Panel. To suspend an account:
1. Go to your Control Panel’s Users and Groups menu. You’ll see a list of all user accounts in your
cloud.
o Click the Suspend icon next to the user you want to suspend. You’ll be asked for confirmation
before the user is suspended.
o To activate a suspended user, click the Activate user button next to their entry in the Users and
Groups menu.
 You can also set a user to auto-suspend at a certain time/date on the user’s Edit Profile screen (Users
& Groups > [user name] > Edit Profile tab).
13.2 User groups
You can assign users into different user groups, so you can give different groups of users different cloud
experiences. At present you can assign a UI theme to specific user groups (Settings -> Look&Feel menu).
13.2.1 Add a user group
To add a user group:
1.
2.
3.
4.
Go to your Control Panel's Users and Groups menu.
Click the User Groups tab.
On the page that follows, click Add a new group button.
When the page loads, enter a user group name (Label) and click Save.
13.2.2 Assign a new user to a group
This happens on the Add New User screen, as part of the user creation process:
110
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
1.
2.
3.
4.
Go to your Control Panel's Users and Groups menu.
Click the Add new user button.
Select the User group for the user from the user group drop-down menu.
Complete the other user detail fields, and click the Save button.
13.2.3 Change a user's group
You can change the group a user is assigned to on the Edit User screen:
1.
2.
3.
4.
Go to your Control Panel's Users and Groups menu.
Click the Edit icon next to the user in question.
Select a user group for the user from the user group drop-down menu.
Click the Save button.
13.2.4 View/edit/delete user group
To view, edit and delete a user group :
1. Go to your Control Panel's Users and Groups menu.
2. Click the User Groups tab.
o Click a group label to see all the users with their details assigned to the questioned group.
o Click the Edit icon next to a user group to change its details.
o Click the Delete icon next to a user group to delete a specific group.
111
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
14. Billing plans, resource limits and roles
14.1 Billing plans
Before users can create virtual machines in your cloud, it is important to set prices for the resources
they use. This is a three-step process: creating a billing plan, setting prices and resources limits for that
plan, and then assigning users to that plan.
14.1.1 Create billing plans
To create a billing plan:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Billing plans tab.
On the screen that appears, click the Add New Billing plan button.
Complete the form on the screen that follows:
o Label - give your billing plan a name.
o Type of currency - set a currency to charge in.
o Monthly price – set a monthly price for the billing plan. This price will be applied regardless
of the actual prices for used resources.
5. Specify Windows licensing support settings:
o Tick the MAK licensing box to enable MAK licensing for a user signed up for this plan
o Tick the KMS licensing box to allow using KMS service
o Choose User licences to allow inserting custom licenses
6. Click Save to finish.
14.1.2 Set billing plan prices and resource limits
You can set pricing and limits for cloud resources for each billing plan. This is a six-step process.
1. Add a resource to a billing plan:
o Go to your Control Panel’s Users and Groups menu.
o Click the Billing Plans tab.
o The screen that appears shows all billing plans currently available. Click the Resources
(chart) icon next to the plan in question.
o The screen that appears shows all resources currently assigned to this billing plan.
o Click the Add New Resource button.
o A pop-up window will appear: choose the resource you want to add from the drop-down
menu, and click the Save button.
112
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
2. Set limits and prices for each resource assigned to the plan:
o On the billing plan resources screen (Users and Groups > Billing Plans tab > Resources icon)
you can enter prices and limits for each resource in the table shown.
o Click the cells next to the required resource, type a value and press Enter.
o If you leave the limit fields blank, no limit will be applied to that resource. The resource
types are explained below.
 Note that billing plan resource limits are per user, not per VM. So, a user assigned to a plan with a
maximum available disk size of 500Gb cannot exceed that limit across all of their VMs.
o
o
o
o
o
o
o
o
o
o
CPU (Free, Max, On, Off) - the number of CPU cores that users get for free, and the
maximum number of CPU cores they can request under this plan. You can set prices per CPU
core, per hour, for VMs powered on and off.
CPU Priority*(Free, Max, On, Off) - the CPU priority % that users get for free, and the
maximum CPU priority they can request under this plan. You can set prices per CPU priority
%, per hour, for VMs powered on and off.
Disk size (Free, Max, On, Off) - the disk space users get for free, and the maximum disk
space they can request under this plan. You can set prices for disk space for VMs powered
on and off. Disk size is measured in GB and priced per hour.
Memory (Free, Max, On, Off) - the amount of RAM users get for free, and the maximum
RAM they can request under this plan. You can set RAM prices for VMs powered on and off.
RAM is measured in MB and priced per hour.
IP address (Free, Max, On, Off) - the number of IP addresses users get for free, and the
maximum number of IP addresses they can request under this plan. You can set IP address
prices for VMs powered on and off. IP addresses are priced per hour.
Virtual machines (Free, Max) - the number of virtual machines users can create for free,
and the maximum number of VMs they can create.
Template & backup storage (Disk size for free, Disk size, Price) - the amount of free disk
space users get for backup and template storage, and the total amount of disk space they
can use for backups and templates. Disk space is measured in GB, and priced per hour.
Backup (Max) - the number of backups users can create, subject to their maximum
template/backup storage space limit. Backups are not priced individually: instead, you can
set prices for template and backup storage.
Templates (Max) - the number of templates a user can create, subject to their maximum
template/backup storage space limit. Templates are not priced individually: instead, you can
set prices for template and backup storage.
Monitis (Free, Max, Price) – the number of VMs using Autoscaling a user can create for free
as well as total amount of such VMs. You can also set the price for the VMs using
Autoscaling (per VM).
3. Add a template group to the plan.
113
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
o
o
Go to the billing plan resources screen (Users and Groups > Billing Plans tab > Resources
icon).
Click the Add New Template Group button.
In the pop-up window that appears, choose a template group from the drop-down menu,
and click Save.
 When you add a template group to a billing plan, you limit the number of preconfigured
system templates available to a user signed up for this billing plan – they can only choose from
templates available in that template group.
4. Add a hypervisor zone* to the plan.
o Go to the billing plan resources screen (Users and Groups > Billing Plans tab > Resources
icon).
o Click the Add New Hypervisor Zone button.
o In the pop-up window that appears, choose a hypervisor zone from the drop-down menu,
and click Save.
5. Add data store zone resources*, and set limits/prices per zone
o Go to the billing plan resources screen (Users and Groups > Billing Plans tab > Resources
icon).
o Click the Add New Data Store Zone button.
o In the pop-up window that appears, choose a data store zone from the drop-down menu,
set the limit type and click Save.
o You then need to set limits and prices for the data store zone:
o Disk size (Free, Max, On, Off) - set a maximum amount of disk space users get for
free, and total amount of disk space users can allocate to this data store. You can
set prices for disk space for VMs powered on and off. Disk space is measured in GB
and priced per hour.
o Data read (Free, Price over free units) - set the amount of data users get for free for
read operations and the price for each unit over that free limit. Data read is
measured in GB, and priced per GB.
o Data written (Free, Price over free units) - set the amount of data users get for free
for write operations and the price for each unit over that free limit. Data written is
measured in GB, and priced by GB.
o Input requests (Free, Price over free units) - set the amount of simultaneous input
requests users get for free, and the price for each request over that free limit.
o Output requests (Free, Price over free units) - set the amount of simultaneous
output requests users get for free, and the price for each request over that free
limit.
114
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
6. Add network zone resources*, and set limits/prices per zone
o Go to the billing plan resources screen (Users and Groups > Billing Plans tab > Resources
icon).
o Click the Add New Network Zone button.
o In the pop-up window that appears, choose a network zone from the drop-down menu, set
the limit type and click Save.
o You then need to set limits and prices for the network zone:
o IP addresses (Free, Max, On, Off) - set the amount of IP addresses users get for
free, and the total amount they may request. You can set prices for VMs powered
on and off.
o Port speed (Free, Max, On, Off) - set the port speed users get for free, and the
maximum port speed they can request. You can set prices for VMs powered on and
off. Port speed is measured in Mb and priced per hour.
o Data received (Free, Price over free units) - set the amount of data users can
receive for free, and the prices for each unit of data over that limit. Data is
measured in GB, and priced per GB.
o Data sent (Free, Price over free units) - set the amount of data users can send for
free, and the prices for each unit of data over that limit. Data is measured in GB, and
priced per GB.
 * By adding hypervisor, data store and network zone resources to a billing plan, you can add
to the overall limits enforced by the billing plan, by limiting what amount of resource is available
in different zones of your cloud.
For example: a user is assigned to a billing plan with a total limit of 10 IP addresses. The plan is
associated with 2 network zones: NZ1, a high performance zone, which has a limit of 2 IPs; and
NZ2, which has a limit of 8 IPs.
In this case, the user would be able to use a maximum of 10 IPs for all of their VMs - of which, up
to 2 may be located in NZ1, and up to 8 located in NZ2.
7. Add Edge groups resources limits/prices per group
o Go to the billing plan resources screen (Users and Groups > Billing Plans tab > Resources
icon).
o Click the Add New Edge Group button.
o In the pop-up window that appears, choose an Edge group from the drop-down menu, and
click Save.
o You then need to set the price for the edge group.
8. Add backup server zones limits/prices per zone
115
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
o
Go to the billing plan resources screen (Users and Groups > Billing Plans tab > Resources
icon).
o
Click the Add New Backup Server Zone button at the bottom of the screen.
o
In the dropdown menu that appears, choose a backup server zone and click Save.
o
You then need to set limits and prices for the backup server zone:
o
Backups – set the amount of backups users get for free, and the total amount they may use.
You can set prices for backups.
o
Backup Disk Size – set a maximum amount of backup server space users get for free, and
total amount of backup server space users can request. You can set prices for backup server
space. Backup server space is measured in GB.
o
Templates – set the amount of templates users can send for free, and the prices for each
template over that limit.
o
Template Disk Size – - set the amount of template disk size users can receive for free, and
the prices for each GB over that limit. Template disk size is measured in GB, and priced per
GB.
o
If you specify backup server zone in the billing plan, users will be able to use only the backup
servers specified in the backup server zones assigned their billing plan.
If the billing plan does not contain any assigned backup servers zone, users will be able to use any
available Backup Server.
14.1.3 Assign users to billing plans
Assigning a new user to a billing plan takes place on the Add New User screen, as part of the user
creation process:
1.
2.
3.
4.
Go to your Control Panel's Users and Groups menu.
Click the Add New User button.
Select a billing plan for the user from the billing plan drop-down menu.
Complete the other user detail fields, and click the Save button.
14.1.4 Change a user’s billing plan
Changing a user's billing plan takes place on the Edit User screen:
1.
2.
3.
4.
Go to your Control Panel's Users and Groups menu.
Click the Edit icon next to the user in question.
Select a billing plan for the user from the billing plan drop-down menu.
Click the Save button.
116
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
14.1.5 Edit, copy and delete billing plans
To edit, copy or delete a billing plan:
1. Go to your Control Panel’s Users and Groups menu. The screen that appears will show all the
billing plans currently set up on the cloud:
o Click a billing plan name to view its details.
o Click the Add icon next to a required billing plan to copy it.
o Click the Edit icon next to a required billing plan to change the plan details.
o Click the Delete icon next to a billing plan to remove it from the system. You’ll be asked for
confirmation before the plan is removed.
14.2 Roles and permissions
OnApp allows you to assign roles to users. Each role has a set of permissions associated with it. By
assigning users to different roles you can control what those users are allowed to do.
Roles are assigned to users during the user creation process. OnApp provides the following preconfigured user roles: Administrator and User.
14.2.1 Add new roles
To add a new role:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab.
Click the Add New Role button at the bottom of the screen.
On the screen that follows, give the role a description (label) and use the checkboxes to set its
permissions.
5. Click the Save button to finish.
 On the Add New Role screen there are also buttons to give Full Access to the role (this automatically
checks all relevant boxes to allow that role to perform any action) and to Deselect All permissions, if you
want to start from scratch.
14.2.2 Edit roles
To edit a role:
1.
2.
3.
4.
Go to your Control Panel’s Users and Groups menu.
Click the Roles tab. You’ll see a list of all roles on your system.
Click the Edit icon next to the role you want to change.
On the screen that appears, change the role’s description and permissions, then click the Save
button.
117
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
14.2.3 Delete roles
To delete a role:
1. Go to your Control Panel’s Users and Groups menu.
2. Click the Roles tab. You’ll see a list of all roles on your system.
3. Click the Delete icon next to the role you want to delete. You’ll be asked for confirmation before
the role is removed.
118
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
15. Tools
OnApp provides a number of tools to help you monitor and manage your OnApp system: Alerts, Usage
Statistics and Sysadmin Tools. To access them, click the relevant links under the main Tools menu item in
the Control Panel.
15.1 Alerts
Alerts are created when zombies appear on the system. These are listed in the Control Panel’s Alerts
screen. There are different kinds of zombies:
o
o
o
o
Zombie virtual machines - VMs which are detected by the OnApp controller as currently
running on a hypervisor, but which are not in OnApp’s database.
Zombie disks - disks which are detected by the OnApp controller as existing on a SAN, but which
are not in OnApp’s database.
Zombie data stores - data stores which are detected by the OnApp controller as existing in the
cloud, but which are not in OnApp’s database.
Zombie transactions - transactions which exist in OnApp’s database, but aren’t running in the
cloud.
The Alerts menu also lists the Background processes running on your system. Max Amount values show
the maximum number of background processes which can run simultaneously. Running shows the
number of processes running at the moment.
 In most cases you can remove the zombie elements from the system by clicking the Delete icon next to
a zombie. For further help, contact support.
15.2 Usage Statistics
The Usage Statistics screen lists every virtual machine in the cloud, along with their:
o
o
o
o
o
o
o
o
Owner - the owner’s user name.
CPU used - shows how long (in seconds) the VM has been using the CPU for the last 72 hours or
during the specified period
Disk reads completed - the number of read operations performed by the disk.
Disk writes completed - the number of write operations performed by the disk.
Disk data read - the amount of data read from a disk.
Disk data written - the amount of data written to a disk.
Bandwidth sent - the number of Bytes sent by this VM.
Bandwidth received - the number of Bytes received by this VM.
By default, statistics are generated for the last 72 hours. To specify another period, set the Start and
End time.
119
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
You can sort by all categories except virtual machine name: click a column label to sort in ascending
order (you’ll see an arrow appear to show how the data is being sorted). Click it again to sort in
descending order.
You can also drill into a specific VM, or its owner, by clicking the relevant links in the list.
15.3 Sysadmin Tools
The Sysadmin Tools screen provides tools for a number of system administration tasks.
Background Task Daemon
Daemon is responsible for executing all background tasks such as:
•
•
•
•
•
•
transactions
backup takers
billing stats updater
cluster monitor
hypervisor monitor
schedule runner
To operate the daemon, use the following commands:
o
o
o
o
Start daemon - starts up all the tasks.
Stop daemon - completes any backups in progress, but prevents any more backups from
starting; stops all tasks in progress.
Restart daemon – restarts the tasks, and completes all running tasks if their PIDs still exist.
Check Status – shows PID of the task and its status.
Transactions/logs
o
o
o
Clean all pending backups - removes all transactions relating to pending backups from the log.
Cancel all pending tasks - removes all pending actions from the log.
Clean logs - completely clears the log.
120
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
16. Advanced tasks
This chapter describes more sophisticated operations, which help manage different OnApp
functionalities. It is highly recommended that only advanced users perform these tasks.
16.1 Reset administrator password
To generate a new password for an administrator user:
1. Log in to your OnApp Cloud Control Panel using SSH:
ssh [email protected]
2. Go to the directory where your Control Panel is installed:
cd /onapp/interface
3. To generate a random password, run the following rake task :
onapp:password[admin_login]
4. To set a predefined password, run:
onapp:password[admin_login,new_password]
 Make sure there are no spaces in brackets.
If the operation was successful you will see a Password successfully changed to 'new_password'
message. If the operation could not be completed, you will see an error report.
16.2 Add IPs in Windows
After you allocate an IP address assignment in your Control Panel, it is necessary to add IPs directly in
your Windows environment.
To add an additional IP address in Windows 2003/2008 Server and Windows 7:
1.
2.
3.
4.
5.
6.
Locate the My Network Places icon on your desktop, right click and select Properties.
To open the network properties dialogue, right-click on External or Ext. Select Properties.
Select Internet Protocol (TCP/IP) and click Properties.
Click Advanced.
Click Add, enter the IP address and corresponding Subnet mask.
Click Add.
If you wish to add more IP addresses, repeat steps 5 and 6 until you have added the IP addresses we
assigned to you.
121
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
16.3 Create new Linux/Windows templates
We’re preparing separate documents to explain how to create Windows and Linux templates from
scratch, rather than from existing VM templates. Contact support or your integration specialist for more
information.
122
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
17. Help
The help menu lets you submit support requests to the OnApp team. All OnApp customers with a full
(paid) license are entitled to 24/7 support.
o
o
Click the Help link in the Control Panel, and complete the form on the screen that follows.
Alternatively you can call +1 (888) 876-8666, or email [email protected] with your problem.
123
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
18. Document revisions
v1.9, 26th April 2012
•
Updated the Create custom templates section with the requirements for Min memory size and
Min disk size values
v1.8, 13th April 2012
Added:
•
•
•
•
•
•
•
Backup servers chapter
Backup server zones chapter
DNS chapter
License section
Universal search form section
Localization and Customization Search section
User Additional Fields section
Updated:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Manage VM networks section with the info on how to remove an IP address
Set billing plan prices and resource limits section with the info on backup server zone resource
limits
Template software licenses contains new Windows licensing type parameters
Template groups section adds info on Windows licensing type
Load Balancers chapter with the info on new parameters
Add CDN edge server section adds info on edge server label validation
Bandwidth statistics section adds info on the latest parameters
Changed CPU Share to CPU Priority
Create custom templates section
Create VMs section adds info on new licensing type for Windows VMs
Autoscale VMs section
Set firewall rules section
Manage VM networks section adds info on Display Network Speed for network interfaces on
Virtual Machine page
Migrate disks section with the info on new parameters
VM CPU utilization and VM Billing statistics sections add info on Show in my Timezone option
Label description in Add CDN edge server section
Add disks to a VM section with mount point validation description
124
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
•
•
•
Edit Defaults Configuration section with the info on IP address anti-spoofing and SSH ports
option
Add IP address(es) to a network section with a note to reflect maximum number of IPs that can
be added at once (1,000)
Removed Template sets section
Add currencies section with the details on Precision per unit parameter.
v1.6, 8th December 2011
•
Updated:
o
o
o
o
o
o
o
o
o
o
Updated instructions on how to turn back to Admin area at a Log in as a user section
Create VMs section contains hostname validation requirements
View user account billing statistics section adds info on Used resources cost field
View and edit disks section with the info on new controls
Templates chapter
Alerts section clarifies the listed background processes
Edit hypervisor and Add hypervisors sections with the info on new options
Edit system configuration section with the explanation of Zombie transaction time
parameter
Logs chapter
Autoscale VMs section
v1.5, 28th November 2011
•
•
Updated Allocate IP addresses description to reflect current functionality more accurately. It is not
currently possible to allocate an IP to a VM if that IP has already been allocated, so this text has
been removed (the ability to “share” IPs in this way will be fixed in a future update).
Removed detail about creating new templates. This is now handled in separate documents –
contact us for more information.
v1.4, 17th November 2011
•
Added screenshot to the CDN Resources section to clarify location of CDN Resources menu.
v1.3, 21st October 2011
•
Removed redundant price and autoscale settings from Add CDN edge server section.
v1.2, 6th October 2011
125
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012
•
Updated hardware requirements information – CP RAM and HV NICs.
v1.1, 6th October 2011
•
Added CDN introduction with basic workflow description.
v1.0, 3rd October 2011
•
•
Added
o
o
o
o
o
o
o
o
o
Set VIP status subsection.
Configure network interface subsection.
Allocate IP addresses subsection.
Add SSH key section.
Template sets section.
Advanced tasks chapter.
CDN edge servers chapter.
CDN resources chapter.
CDN edge groups chapter.
Updated
o Virtual Machines chapter is reorganized. Now it consists of 4 main sections: Manage VMs,
Manage VM network, Manage VM disk space and VM Statistics.
o VM Properties (prev. View VM details) contains new items in the Actions list.
o Create VMs and Add new users sections contain login/password validation requirements.
o Add new networks section contains information how to join a network to a hypervisor or a
hypervisor zone.
o Add IP address(es) contains information on adding IPv6 addresses.
o Edit defaults configuration section contains information on SSH keys.
o Edit system configuration section.
o Edit Backup/Template configuration section.
o Sysadmin Tools section.
o Dashboard section with the info on Disk size and memory calculation for the cloud and a
particular user.
o Add custom languages section updated with the info on adding new locales.
o Set billing plan prices and resource limits section updated with info on adding Edge group
limits.
Other detail is unchanged from the last version (v1.1) of the Admin Guide for OnApp 2.2.
126
th
OnApp Cloud v2.3.2 | Admin Guide | v1.9 |26
April 2012

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project