v2.3.3 Admin Guide A guide to all Control Panel functions, with tips for cloud admins. Document version 2.5 Document release date 3rd January 2013 document revisions 1 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 Contents 1. About this guide ............................................................................................................. 9 2. OnApp overview ........................................................................................................... 10 2.1 Main components & features ..................................................................................................... 10 2.2 API and integrations .................................................................................................................... 13 2.3 Hardware & software requirements ........................................................................................... 13 2.4 Architecture ................................................................................................................................ 15 3. 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 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 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 ................................................................................................................................... 34 4.3.5 Schedule VM backups ............................................................................................................................ 34 4.3.6 Delete VM disks ..................................................................................................................................... 34 4.3.7 Manage backups .................................................................................................................................... 35 4.4 VM statistics ................................................................................................................................ 35 4.4.1 VM CPU utilization ................................................................................................................................. 35 4.4.2 VM Billing statistics ................................................................................................................................ 36 4.4.3 Network Interface usage ....................................................................................................................... 37 4.4.4 Disk IOPS ................................................................................................................................................ 37 5. 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 6. 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 CDN edge groups ........................................................................................................................ 51 6.3.1 Create a new CDN edge group ............................................................................................................... 51 3 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 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 7. DNS .............................................................................................................................. 53 7.1 DNS setup .................................................................................................................................... 53 7.1.1 Edit DNS domain .................................................................................................................................... 54 7.2 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 8. 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 9. 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 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 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 .................................................................................................. 72 11.1.4 Manage networks for hypervisors ..................................................................................................... 72 11.1.5 Delete hypervisors ............................................................................................................................. 72 11.1.6 User hypervisor permissions ............................................................................................................. 73 11.2 Hypervisor zone settings ............................................................................................................. 73 11.2.1 Create hypervisor zones .................................................................................................................... 73 11.2.2 View, edit and delete hypervisor zones ............................................................................................ 74 11.2.3 View hypervisor zone details ............................................................................................................. 74 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 ......................................................................................... 75 11.2.7 Manage networks for hypervisor zones ............................................................................................ 75 11.2.8 User hypervisor zone permissions ..................................................................................................... 75 11.3 Data store settings ...................................................................................................................... 77 11.3.1 Add data stores ................................................................................................................................. 77 11.3.2 View data stores ................................................................................................................................ 77 11.3.3 Edit data stores .................................................................................................................................. 77 11.3.4 Delete data stores ............................................................................................................................. 78 11.3.5 User data store permissions .............................................................................................................. 78 11.4 Data store zone settings ............................................................................................................. 78 11.4.1 Create a data store zone ................................................................................................................... 78 11.4.2 View, edit and delete data store zones ............................................................................................. 79 11.4.3 View data store zone details ............................................................................................................. 79 11.4.4 Add data stores to a data store zone ................................................................................................ 79 11.4.5 Remove data stores from a data store zone ..................................................................................... 79 11.4.6 User data store zone permissions ..................................................................................................... 80 11.5 Backup servers ............................................................................................................................ 80 11.5.1 Create backup server ......................................................................................................................... 82 5 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 11.5.2 Edit backup server ............................................................................................................................. 82 11.5.3 Manage backups for backup server .................................................................................................. 83 11.5.4 Delete backup server ......................................................................................................................... 83 11.5.5 User backup server permissions ........................................................................................................ 83 11.6 Backup server zones ................................................................................................................... 84 11.6.1 Create backup server zone ................................................................................................................ 84 11.6.2 View backup server zone details ....................................................................................................... 84 11.6.3 Edit backup server zone .................................................................................................................... 84 11.6.4 Delete backup server zone ................................................................................................................ 85 11.6.5 Add a backup server to backup server zone ...................................................................................... 85 11.6.6 Remove a backup server from a backup server zone ........................................................................ 85 11.6.7 User backup server zone permissions ............................................................................................... 85 11.7 Disk settings ................................................................................................................................ 86 11.7.1 View and edit disks ............................................................................................................................ 86 11.7.2 User disk permissions ........................................................................................................................ 86 11.8 Resolver settings ......................................................................................................................... 87 11.8.1 View resolvers ................................................................................................................................... 87 11.8.2 Edit resolvers ..................................................................................................................................... 87 11.8.3 Deleting resolvers .............................................................................................................................. 87 11.8.4 User resolver permissions ................................................................................................................. 88 11.9 Network settings ......................................................................................................................... 88 11.9.1 View networks ................................................................................................................................... 88 11.9.2 Add new networks............................................................................................................................. 88 11.9.3 Add IP address(es) to a network ....................................................................................................... 89 11.9.4 Edit networks..................................................................................................................................... 90 11.9.5 Delete networks ................................................................................................................................ 90 11.9.6 User network permissions ................................................................................................................. 90 11.10 Network zone settings ............................................................................................................ 91 11.10.1 Create network zones........................................................................................................................ 91 11.10.2 View, edit and delete network zones ................................................................................................ 91 11.10.3 View network zone details ................................................................................................................ 91 11.10.4 Add networks to a network zone ...................................................................................................... 92 11.10.5 Removing networks from a network zone ........................................................................................ 92 11.10.6 User network zone permissions ........................................................................................................ 92 6 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 11.11 Schedule settings .................................................................................................................... 93 11.11.1 View, edit and delete schedules ........................................................................................................ 93 11.11.2 User schedules permissions .............................................................................................................. 93 11.12 Autobackup preset settings .................................................................................................... 93 11.13 License ..................................................................................................................................... 94 11.14 Configuration settings ............................................................................................................. 94 11.14.1 Edit System configuration ................................................................................................................. 94 11.14.2 Edit Backup/Template configuration................................................................................................. 96 11.14.3 Edit Interface configuration............................................................................................................... 97 11.14.4 Edit Defaults configuration ................................................................................................................ 98 12. Localization and customization .................................................................................. 99 12.1 Languages.................................................................................................................................... 99 12.1.1 Add custom languages ...................................................................................................................... 99 12.1.2 Enable a custom language for a specific user .................................................................................. 100 12.2 Currencies ................................................................................................................................. 100 12.2.1 Add currencies ................................................................................................................................. 100 12.2.2 Edit/delete currencies ..................................................................................................................... 102 12.3 Look & feel ................................................................................................................................ 102 12.4 User customization and localization permissions ..................................................................... 104 12.5 Localization and Customization Search .................................................................................... 105 13. Users ....................................................................................................................... 106 13.1 User accounts ............................................................................................................................ 106 13.1.1 View user account details ................................................................................................................ 106 13.1.2 View, add & edit user payments ..................................................................................................... 107 13.1.3 View user account billing statistics .................................................................................................. 108 13.1.4 Whitelist IPs ..................................................................................................................................... 108 13.1.5 Log in as a user ................................................................................................................................ 109 13.1.6 Add new users ................................................................................................................................. 109 13.1.7 User Additional Fields ...................................................................................................................... 110 13.1.8 Edit users ......................................................................................................................................... 110 13.1.9 Add SSH key ..................................................................................................................................... 110 13.1.10 Delete users ..................................................................................................................................... 111 13.1.11 Suspend and activate users ............................................................................................................. 111 7 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 13.2 User groups ............................................................................................................................... 111 13.2.1 Add a user group ............................................................................................................................. 111 13.2.2 Assign a new user to a group .......................................................................................................... 111 13.2.3 Change a user's group ..................................................................................................................... 112 13.2.4 View/edit/delete user group ........................................................................................................... 112 14. Billing plans, resource limits and roles ..................................................................... 113 14.1 Billing plans ............................................................................................................................... 113 14.1.1 Create billing plans .......................................................................................................................... 113 14.1.2 Set billing plan prices and resource limits ....................................................................................... 113 14.1.3 Assign users to billing plans ............................................................................................................. 117 14.1.4 Change a user’s billing plan ............................................................................................................. 117 14.1.5 Edit, copy and delete billing plans ................................................................................................... 118 14.2 Roles and permissions............................................................................................................... 118 14.2.1 Add new roles .................................................................................................................................. 118 14.2.2 Edit roles .......................................................................................................................................... 118 14.2.3 Delete roles ..................................................................................................................................... 119 15. Tools ....................................................................................................................... 120 15.1 Alerts ......................................................................................................................................... 120 15.2 Usage Statistics ......................................................................................................................... 120 15.3 Sysadmin Tools .......................................................................................................................... 121 16. Advanced tasks ....................................................................................................... 122 16.1 Reset administrator password .................................................................................................. 122 16.2 Add IPs in Windows .................................................................................................................. 122 16.3 Create new Linux/Windows templates ..................................................................................... 123 17. Help ........................................................................................................................ 124 18. Document revisions ................................................................................................. 125 8 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 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 Icons 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 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013 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 10 OnApp Cloud v2.3.3 | Admin Guide | v2.5 |3rd January 2013