docs.onapp.com file · web viewdocs.onapp.com
If you can't read please download the document
TRANSCRIPT
4.3 Administrator Guide
OnApp 4.3 Administration Guide
Author: Version: Date:
Admin
2
13-May-2016 16:49
Table of Contents
1Key to interface and icons272OnApp 4.328Index29What's New in OnApp Cloud 4.345Changes to terminology and the user interface45New features for OnApp and vCloud integration45Document Conventions46OnApp Cloud Overview48Main Components & Features48Servers48Storage devices51Networks51Templates51Scalability52High availability52Security52API and Integrations53Hardware & Software Requirements53Architecture55Network Configurations56Cloud Only (Xen & KVM)56Cloud & Storage58Cloud Only (VMware)60Dashboard61Statistics61Cloud62Account62Activity log62Additional Navigation62API Key63Login Screen63User Profile65Overview65Payments69Billing Plan69White List69Backups70Customer Networks71iFrame71Cloud Search Tool72Appliances73Virtual Servers76View Virtual Servers78View Virtual Server Details79Create Virtual Server82Virtual Server Creation Workflow91Edit Virtual Server93Rebuild/Build Virtual Server Manually94Migrate Virtual Server95Autoscale Virtual Server96Set VIP Status for Virtual Server97Segregate Virtual Server98Delete Virtual Server99Virtual Server Power Options99Virtual Server Administrative Options101Virtual Server Networks102Virtual Server Disks108Virtual Server Backups112Virtual Server Backup Schedules123Virtual Server Statistics128Virtual Server Integrated Console132Virtual Server Transactions and Logs132Virtual Server Recipes134Virtual Server Recipe Custom Variables135ISO Virtual Servers136View ISO Virtual Servers137View ISO Virtual Server Details138View ISO Virtual Server Transactions and Logs139Create ISO Virtual Server140Manage ISO Virtual Servers146ISO Virtual Server Networks151ISO Virtual Server Disks156ISO Virtual Server Statistics160Smart Servers164View Smart Servers166View Smart Server Details167Create Smart Server168Smart Server Creation Workflow172Rebuild/Build Smart Server Manually174Edit Smart Server174Delete Smart Server175Autoscale Smart Server175Migrate Smart Server177Smart Server Power Options178Smart Server Administrative Options179Smart Server Networks180Smart Server Disks183Smart Server Backups186Smart Server Backup Schedules192Smart Server Statistics197Smart Server Integrated Console199Smart Server Transactions and Logs200Smart Server Recipes201Smart Server Recipe Custom Variables202Smart Server Billing202Baremetal Servers203View the List of Baremetal Servers204View Baremetal Server Details204Create Baremetal Server204Baremetal Server Creation Workflow207Edit Baremetal Server209Delete Baremetal Server209Manage Baremetal Server Recipes210Manage Baremetal Server Recipe Custom Variables211Baremetal Server Billing211Baremetal Server Recovery Mode212Application Servers213View Application Servers214View Application Server Details215Create Application Server217Edit Application Server222Rebuild/Build Application Server Manually222Migrate Application Server222Autoscale Application Server223Set VIP Status for Application Server225Segregate Application Server225Delete Application Server225Application Server Power Options226Application Server Administrative Options227Application Server Networks227Application Server Disks233Application Server Backups237Application Server Backup Schedules244Application Server Statistics248Application Server Transactions and Logs252Application Server Billing253Load Balancers255View Load Balancer Details255Create Load Balancer Cluster257Create Autoscaling Cluster259Edit Load Balancer261Delete Load Balancer261View Load Balancer Billing Statistics262View Load Balancer Autoscaling Monitors262Compute Resources264Compute resource features265Compute resource management265Compute Resource Matrix267CloudBoot Compute Resources272VMware Compute Resources273VCloud Compute Resources273View Compute Resources273View Compute Resource Details274Edit Compute Resource Details275Reboot Compute Resource2768.8Assets278Applications280The List of Available Applications280Forums280Blogs2819.1.3CMS282E-commerce284Social networking285Educational286Video286Admanager286Galleries287Projectman287Files288Wikis288Frameworks288Mail289Customer support2909.1.16ERP290DBtools291Music291Polls291Guestbook292Calendars292Games2929.1.23RSS293Microblog293Others293View Applications294Create Application295Delete Application299Application Backups300View Application Backups300Create Application Backup300Restore Application Backup301Delete Application Backup301Manage FTP Users302View FTP users302Create FTP user303Delete FTP user303Manage Domains304View Domains304Create Domain305Delete Domain305System Application Settings306List of system applications306PHP version switching30710DNS308DNS Setup308Edit DNS Domain309DNS Zones309Create DNS Zone309Edit DNS Zone315Delete DNS Zone315User DNS Zones315Set End-User Access to DNS Service316View User DNS Zones316Edit User DNS Zones316Delete User DNS Zones317Blueprints318SolidFire Integration319SolidFire Management319SolidFire Quality of Service320Integrated Storage322Known Limitations and Restrictions322Templates324What templates are325Windows templates325Types of templates325Where templates are stored326Template store328My template group328Configuration Options329Installation and update330Billing330Manage Templates331View Template Details331Edit Template Details332Delete System Templates332Install/Update Templates332Create Custom Templates335Edit Custom Templates336Delete Custom Templates336Make Templates Public336Allow Users to Make Templates Public337Manage Template Recipes337Manage Template Recipe Custom Variables338Template Software Licenses339KMS Licensing340MAK Licensing340Template Store341My Template Groups343ISOs346View ISOs346Boot from ISO347Share the location where the ISOs are stored.347Enable ISO Permissions348Upload ISO(s) into the cloud.349Make ISO(s) public.349Boot virtual or smart server from ISO.350Upload ISOs350Upload ISO(s) into the Cloud350Make ISO(s) Public351Edit ISOs352Delete ISOs352Recipes353Recipe use353Recipe variables354View List of All Recipes355View Recipe Details356View the List of Assigned Servers356Create Recipe357Create recipe357Create steps358Assign Recipe to Multiple Servers360Edit Recipe360Edit Recipe Step361Delete Recipe362Recipe Permissions362Recipe Groups365Recipe Use Examples366Recipe 1366Recipe 2368Recipe 3369Recipe 436916.14Control Panel Recipes Settings.37017CDN373CDN Setup Wizard375CDN Edge Servers376Create CDN Edge Server378View CDN Edge Server Details379Edit CDN Edge Server381Set VIP Status for Edge Server381Delete CDN Edge Server382CDN Edge Server Network Interface Usage382CDN Storage Servers382View CDN Storage Server Details382Create CDN Storage Server384Edit CDN Storage Server385Set VIP Status for Storage Server385Delete CDN Storage Server386CDN Resources386View CDN Resources388View CDN Resource Details388Create HTTP CDN Resource394Create Video On Demand CDN Resource401Create Live Streaming CDN Resource404Edit CDN Resource406Bandwidth Statistics407Stream Statistics408Raw Logs409View CDN Advanced Reporting410Prefetch Content412Purge Content412Billing Statistics413HTTP Caching Rules.414Token Authentication431CDN Edge Groups436View CDN Edge Group Details437Create CDN Edge Group437Edit CDN Edge Group438Delete CDN Edge Group438Assign/Remove CDN Edge Group Locations438CDN Upload Instructions43817.6.143917.6.2HTTP Push CDN Resource43917.6.3439VOD Pull CDN Resource439VOD Push CDN Resource44017.6.644117.6.7Live Streaming CDN Resource441CDN SSL Certificates445View Custom SNI SSL Certificates446Add Custom SNI SSL Certificates446Edit Custom SNI SSL Certificate447Delete SNI SSL Certificate448CDN Accelerator448View Accelerators449Create Accelerator452Manage Accelerators455Accelerator Disks460Accelerator Networks462
17.8.6
Accelerator IP Addresses
466
17.8.7
Accelerator Statistics
468
18
AWS
470
18.1
Enable/disable AWS
470
18.2
View EC2 Instances
471
18.3
Launch New EC2
472
19
Users And Groups
476
19.1
User Accounts
476
19.1.1
View Users
476
19.1.2
View User Account Details
477
19.1.3
User Payments
480
19.1.4
User Billing Statistics
480
19.1.5
User Whitelist IPs
482
19.1.6
Customer Networks
482
19.1.7
Log in as User
483
19.1.8
Create User
483
19.1.9
User Additional Fields
484
19.1.10
Edit User
485
19.1.11
Add SSH Key
486
19.1.12
Delete User
486
19.1.13
Suspend and Activate Users
487
19.1.14
View User Backups
488
19.1.15
Unlock User
489
19.2
User Groups
489
19.2.1
View User Group
489
19.2.2
Create User Group
489
19.2.3
Edit User Group
490
19.2.4
Assign New User to Group
490
19.2.5
Change User Group for User
491
19.2.6
Delete User Group
491
19.3
Drop Session
491
19.3.1
Drop Own Sessions
491
19.4
Users with Config Problems
492
20 Roles And Sets493
20.1 Create New Role49320.2 Edit Role49320.3 Delete Role49420.4 Clone Role49420.5 Restrictions Sets495
20.5.1 Configure Reseller Role496
20.5.2 Create Restrictions Sets497
20.5.3 List of Restrictions Resources498
20.5.4 Edit Restrictions Sets506
20.5.5 Delete Restrictions Sets507
21 Billing Plans508
21.1 Master Bucket Billing50821.2 Master Template Billing50921.3 Create Billing Plan51021.4 Set Billing Plan Prices And Resource Limits511
21.4.1 Add limits for Instance packages522
21.4.2 Modify/delete Limits for Instance packages522
21.5 Billing Plan Configuration Workflow52321.6 Billing Calculation524
21.6.1 Hourly and monthly resource limit types525
21.6.2 Calculation for the missing period526
21.6.3 IP addresses527
21.6.4 Port Speed528
21.6.5 Guaranteed minIOPS529
21.6.6 Disk size531
21.6.7CPU532
21.6.8 CPU shares533
21.6.9 CPU Priority533
21.6.10 CPU Units534
21.6.11 Instance packages535
21.6.12 DRaaS536
21.7 Assign Users to Billing Plan53721.8 Edit User Billing Plan53721.9 Copy Billing Plan53721.10 Delete Billing Plan53821.11 Create and Manage Payments538
21.11.1 View payments539
21.11.2 Create payment539
21.11.3 Edit payment540
21.11.4 Delete payment540
22 Instance Packages542
22.1 View Instance Packages54222.2 Set up Instance Packages for Cloud543
22.2.1 Enable the instance packages permission543
22.2.2 Add instance packages to your cloud544
22.2.3 Add the instance package(s) to the users' billing plan545
22.2.4 Interface configuration547
22.2.5 Build Virtual Server Using Instance packages548
22.3 Billing for Instance Packages550
22.3.1 Add instance packages to your cloud550
22.3.2 Add instance packages to the billing plan551
22.4 Edit Instance Package55322.5 Delete Instance Package554
23 Compute Resource Settings556
23.1 Compute Resource Settings.556
23.1.1 View Compute Resource Settings556
23.1.2 Create Compute Resource557
23.1.3 Create CloudBoot Compute Resource558
23.1.4 Manage CloudBoot Compute Resource Devices564
23.1.5 Edit Xen/KVM Compute Resource565
23.1.6 Edit CloudBoot Compute Resource566
23.1.7 Edit Baremetal CloudBoot Compute Resource569
23.1.8 Edit Smart CloudBoot Compute Resource570
23.1.9 Delete Compute Resource572
23.1.10 Manage Compute Resource Data Stores572
23.1.11 Manage Compute Resource Networks573
23.1.12 Maintenance Mode for Xen/KVM Compute Resources573
23.1.13 Compute Resource Extended CPU Flags576
23.2 Compute Zones Settings579
23.2.1 Create Compute Zone579
23.2.2 View Compute Zones582
23.2.3 View Compute Zone Details582
23.2.4 Add Compute Resource to Compute Zone583
23.2.5 Remove Compute Resource from Compute Zone583
23.2.6 Delete Compute Zone584
23.2.7 Edit Compute Zone584
23.2.8 Manage Compute Zone Data Stores586
23.2.9 Manage Compute Zone Networks587
23.2.10 Manage Compute Zone Recipes587
23.2.11 Manage Extended CPU Flags for Compute Zone589
24 Storage Settings592
24.1 Data Store Zones Settings592
24.1.1 View Data Store Zones592
24.1.2 View Data Store Zone Details592
24.1.3 Create Data Store Zone592
24.1.4 Create Solidfire Data Store Zone593
24.1.5 Edit Data Store Zone594
24.1.6 Attach Data Stores to Data Store Zone594
24.1.7 Remove Data Stores From Data Store Zone594
24.1.8 Delete Data Store Zone595
24.2 Data Stores Settings595
24.2.1 View Data Stores596
24.2.2 Create LVM Data Store596
24.2.3 Create SolidFire Data Store597
24.2.4 Edit Data Store599
24.2.5 Delete Data Store599
24.3 Disks Settings600
24.3.1 View Disks600
24.3.2 Enable Disk Auto-backups600
24.3.3 Backup Disks601
24.3.4 Migrate Disks.601
24.3.5 View Disk IOPS601
24.3.6 Schedule Disks for Backups602
24.3.7 Delete Disks602
25 Location Groups604
25.1 Add Location Groups60425.2 View Location Groups60525.3 Edit Location Groups60525.4 Assign Zones to Location Groups60625.5 Unassign Zones from Location Groups606
26 Backup Settings608
26.1 Auto-backup Presets Settings60826.2 Backup Servers Settings609
26.2.1 Basic Backup Scheme609
26.2.2 Advanced Backup Scheme610
26.2.3 CloudBoot Backup Scheme611
26.2.4 Create Backup Server611
26.2.5 Create CloudBoot Backup Server612
26.2.6 Create Virtual Backup Server615
26.2.7 Edit Backup Server619
26.2.8 Backup Server Balancing619
26.2.9 Manage Backups For Backup Server620
26.2.10 Delete Backup Server620
26.3 Backup Server Zones Settings621
26.3.1 View Backup Server Zone Details621
26.3.2 Create Backup Server Zone621
26.3.3 Edit Backup Server Zone622
26.3.4 Add Backup Server to Backup Server Zone622
26.3.5 Remove Backup Server From Backup Server Zone622
26.3.6 Delete Backup Server Zone622
26.4 Schedules Settings623
26.4.1 View Schedules623
26.4.2 Edit Schedules624
26.4.3 Delete Schedules624
27 Network Settings626
27.1 Networks Settings626
27.1.1 View networks626
27.1.2 Create Network626
27.1.3 Edit Network627
27.1.4 Add IP Address to Network627
27.1.5 Assign IP Address to User628
27.1.6 Unassign IP Address from User629
27.1.7 Delete IP Address from Network629
27.1.8 Delete Network630
27.1.9 View Network Details630
27.2 Network Zones Settings631
27.2.1 Create Network Zone631
27.2.2 View Network Zone631
27.2.3 View Network Zone Details631
27.2.4 Edit Network Zone632
27.2.5 Add Networks to Network Zone632
27.2.6 Remove Networks From Network Zone633
27.2.7 Delete Network Zone633
27.3 Firewalls633
27.3.1 View/Edit/Delete Firewalls633
27.3.2 Create firewall634
27.4 Resolvers Settings634
27.4.1 View Resolvers635
27.4.2 Create Resolver635
27.4.3 Edit Resolver635
27.4.4 Delete Resolver635
27.5 Customer VLANs63627.6 IP Address Pools636
28 OnApp Configuration637
28.1 Authentication637
28.1.1 OAuth637
28.1.2 SAML Authentication641
28.2 License64728.3 Configuration Settings648
28.3.1 Edit System Configuration648
28.3.2 Edit Backups/Templates Configuration656
28.3.3 Edit Interface Configuration659
28.3.4 Edit Defaults Configuration659
28.4Control Panel Recipes Settings661
29 Permissions List664
29.1 List of all OnApp Permissions664
29.1.1 Accelerators668
29.1.2 Activity logs669
29.1.3 Application Servers669
29.1.4 Autoscaling Configuration670
29.1.5 Autoscaling monitors671
29.1.6 Auto-backup presets671
29.1.7 Availability671
29.1.8 Backup server zones671
29.1.9 Backup servers672
29.1.10 Backups672
29.1.11 Base resources673
29.1.12 Billing plans673
29.1.13 Blueprints674
29.1.14 Blueprint templates674
29.1.15 Blueprint template groups674
29.1.16 Blueprint template group relations675
29.1.17 Catalogs675
29.1.18 CDN locations676
29.1.19 CDN resources676
29.1.20 CDN SSL Certificates676
29.1.21 CDN usage statistics677
29.1.22 CloudBoot677
29.1.23
Company Billing Plans
677
29.1.24
Compute resources
677
29.1.25
Compute Resource Devices
678
29.1.26
Compute zones
678
29.1.27
Control panel
679
29.1.28
Currencies
679
29.1.29
Customer networks
679
29.1.30
Customer VLANs
680
29.1.31
Dashboard
680
29.1.32
Data stores
680
29.1.33
Data store joins
681
29.1.34
Data store zones
681
29.1.35
Disks
681
29.1.36
DNS zone
682
29.1.37
DRaaS
682
29.1.38
Edge Gateways
683
29.1.39
Edge groups
683
29.1.40
Edge servers
683
29.1.41
Federation
684
29.1.42
Federation failed action
685
29.1.43
Firewall rules
685
29.1.44
Global search
686
29.1.45
Groups
686
29.1.46
Help
686
29.1.47
Http Caching Rules
686
29.1.48
iFrame
686
29.1.49
Instance packages
687
29.1.50
Internationalization
687
29.1.51
IO Statistics
687
29.1.52
IP Address Pools
687
29.1.53
IP addresses
688
29.1.54
ISOs
688
29.1.55
Last access log
689
29.1.56
Load balancers
689
29.1.57
Load balancing cluster s
689
29.1.58
Location Groups
690
29.1.59
Log items
690
29.1.60
Media
691
29.1.61
Monthly user billing statistics
691
29.1.62
Monthly user group billing statistics
691
29.1.63
Nameservers
692
29.1.64
Networks
692
29.1.65
Network zones
692
29.1.66
OnApp Storage
693
29.1.67
OAuth Providers
693
29.1.68
Orchestration Models
693
29.1.69
Org Networks
693
29.1.70
Payments
694
29.1.71
Permissions
694
29.1.72
Provider Resource Pools
694
29.1.73
Recipes
695
29.1.74
Recipe Groups
695
29.1.75
Recipe Group Relations
695
29.1.76
Relation group templates
696
29.1.77
Resource limits
696
29.1.78
Resource Pool
697
29.1.79
Resource Pool Statistics
697
29.1.80
Restrictions Resources
697
29.1.81
Restrictions Sets
697
29.1.82
Roles
698
29.1.83
SAML Identity Providers
698
29.1.84
Schedule logs
698
29.1.85
Schedules
699
29.1.86
Sessions
699
29.1.87
Settings
699
29.1.88
Smart Servers
700
29.1.89
SSH keys
700
29.1.90
Storage Servers
701
29.1.91
Sysadmin tools
701
29.1.92
Templates
702
29.1.93
Template groups
703
29.1.94
Themes
703
29.1.95
Transactions
704
29.1.96
Users
704
29.1.97
User additional fields
705
29.1.98
User groups
706
29.1.99
VApps
706
29.1.100
VApp Networks
707
29.1.101
VApp Templates
707
29.1.102
vCloud Nat Rules
707
29.1.103
Virtual Servers
708
29.1.104
Virtual Server Snapshots
710
29.1.105
Virtual Machine Statistics
710
29.1.106
Virtual Server's IP Addresses
710
29.1.107
White IPs
711
29.1.108
Zabbix Server
711
29.2 List of Default Permissions for Admin Role71229.3 List of Default Permissions for User Role718
30 Tools725
30.1 Logs72530.2 Failover Processes72630.3 Statistics726
30.3.1 Cloud Usage727
30.3.2 CDN Usage727
30.3.3 Top IOPS disks728
30.4 Alerts72830.5 Sysadmin729
30.5.1 Sysadmin Tools730
30.5.2 Services732
30.5.3 Application errors732
30.5.4 Activity Log732
30.5.5 Zabbix Setup733
30.5.6 Control Panel Maintenance735
31 Localization and Customization737
31.1 Languages737
31.1.1 Add Custom Languages737
31.1.2 Enable Custom Language for Specific User738
31.2 Currencies738
31.2.1 Create currency738
31.2.2 Delete Currency740
31.2.3 Edit Currency740
31.3 Localization and Customization Search74131.4 Look & Feel74131.5 iFrame Configuration743
32 Miscellaneous745
32.1 Reset Control Panel Administrator Password74532.2 Add IPs in Windows Environment74532.3 Create New Linux/Windows Templates74632.4 Transaction Server74632.5 Failover Configuration747
32.5.1 How failover works747
32.5.2 Failover settings748
32.5.3 Failover algorithm749
32.5.4 Failover Logs751
32.6 Calculate Billing Statistics for the Missing Period75232.7 Advanced Configuration Settings752
32.7.1 SNMP Statistics758
32.7.2 VMware Statistics758
32.7.3 SolidFire Statistics759
32.8 Track Daemon Process Activity75932.9 Virtual Server Provisioning760
33 High Availability Control Panel761
33.1 Advanced Deployment762
33.1.1 Physical Infrastructure Configuration763
33.1.2 Configuration on CP Side764
33.2 Regular Deployment766
33.2.1 Preparation767
33.2.2 Configuration on GUI Side781
33.2.3 Activate Clusters786
33.2.4 Configure Backup servers and Compute Resources790
33.4
Basic Deployment
813
33.4.1
Physical Infrastructure Configuration
814
33.4.2
Configuration on CP Side
817
33.5
Manage Hosts
821
33.5.1
View Hosts
821
33.5.2
Add a Host
822
33.5.3
Edit a Host
822
33.5.4
Delete a Host
823
33.6
Manage Communication
823
33.6.1
View Communication Ring
823
33.6.2
Add Communication Ring
824
33.6.3
Edit Communication Ring
824
33.6.4
Delete Communication Ring
825
33.7
Manage Clusters
825
33.7.1
View Clusters
825
33.7.2
Add Cluster
827
33.7.3
Add Node to Cluster
827
33.7.4
Deactivate/Activate Cluster
828
33.8
Disable High Availability
828
34
Disaster Recovery as a
Service
(DRaaS)
834
34.1
Prerequisites
834
34.2
Enable DRaaS for Virtual Server
835
34.3
Disable DRaaS
836
34.4
DRaaS billing
836
35 SSL Certificates838
35.1 Prerequisites83835.2 View SSL certificates83835.3 Add SSL certificate838
36 Help840
This guide provides an 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.
(OnApp 4.3 Administration Guide)
(Version 2) (99)
1 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.
This guide is aimed at Administrators and Users with limited permissions will not be able to access all functionality, or may be denied access to functions they can see.
The following icons are referred to in this guide:
2 OnApp 4.3
Updated
Updated The List of Available Applications section Updated List of all OnApp Permissions section Updated Segregate Virtual Server section Updated Billing Calculation section
Updated Set Billing Plan Prices And Resource Limits section
Updated Advanced Configuration Settings section: updated default values for the following parameters - backup_taker_delay, schedule_runner_delay and transaction_runner_delay.
3 Index
3.1 A B C D E FG H IJ K L M N OP R S T U V W X Y Z
3.2 A
administrator password
add IPs in Windows environment advanced configuration settings alerts
background processes zombie data stores zombie disks
zombie domains zombie transactions appliances application server administrative options autoscale
backups
backup schedules billing
create delete disks edit migrate
power options rebuild/build
segregate set vip status statistics
transactions and logs view
view details applications backups create delete
manage domains manage FTP users system application view
API and integrations API key
architecture assets authentication OAuth
SAML Authentication Id Provider
auto-backup presets AWS
3.3 B
background task daemon backup servers
cloud boot backup server create
delete edit
manage backups virtual backup server incremental backups normal backups backup servers zones add backup server create
delete edit
remove backup server view
billing plans assign users copy
create delete edit
master bucket master template prices
resource limits blueprints create
delete edit templates
template groups view
blueprint servers
view
view details create Blueprint edit
delete
blueprint template groups blueprint templates
view
view details create
edit delete
3.4 C
CDN
edge groups edge servers resources setup wizard storage servers upload
HTTP Caching Rules prepend
override purge prefetch
Token Authentication CDN Accelerator view
create
manage disks networks
IP addresses statistics
CDN SSL Certificates add
delete edit view
CDN sync runner CDN raw logs loudBoot IPs view
create edit delete
cloud locations step cloud search tool Compute Resources baremetal CloudBoot
create delete edit
location group reboot settings
smart view VCloud
VMware Compute zone view
view details create
edit delete
add Compute resource to Compute zone remove Compute resource from Compute zone manage Compute zone data stores
manage Compute zone networks manage Compute zone recipes control panel
CPU cores CPU flags CPU shares CPU sockets CPU threads CPU topology CPU units
customer networks customer VLAN configuration backups/templates defaults
interface system customization
3.5 D
dashboard activity log data stores delete
edit LVM
VMware Solidfire view
data store zones attach data stores create
delete details edit
remove data stores view
disable failover disks
edit delete view backup migrate
view IOPS
schedule for backups DNS
setup
zones
document conventions DRaaS
3.6 E
error collector
3.7 F
failover algorithm failover processes firewalls
delete edit view
3.8 G
3.9 H
hardware & software requirements
3.10 I
iFrame
instance packages delete
edit
set up instance packages view
integrated storage IP address pools
view create edit delete ISO
add delete edit view
make ISO public ISO Virtual Servers create
manage networks disks statistics
3.11 J
3.12 K
3.13 L
languages
add custom languages
enable custom language for user license
load balancers
load balancer clusters autoscaling clusters location groups
localization
localization and customization search logs
look & feel
3.14 M
maintenance mode
3.15 N
network
add IP address assign IP address create
delete
delete IP address edit
unassign IP address view
network zones add networks create
delete details edit
remove networks view
3.16 O
OnApp Dashboard
3.17 P
payment
power cycle command publishing rules
3.18 Q
3.19 R
recipes view create delete edit
edit step manage settings recovery image resolvers
create delete edit view roles create edit delete clone
reseller role lastAccess log restrictions sets
create edit delete rsync
running processes
3.20 S
schedules view
edit delete search servers
application server backup server baremetal servers blueprint server cdn edge sever
cloudboot backup server iso virtual server
smart servers migrate migrate disks
convert backup to template storage servers transaction server
virtual server
virtual backup server vmware virtual server SNMP stats runner
snmptrap SolidFire
SSL certificate statistics
CDN usage Cloud usage sysadmin
3.21 T
templates view
edit delete custom
make public
my template groups template manager template store template recipes
template software licenses transactions/logs
3.22 U
unicast mode users accounts activate
additional fields billing statistics create
delete
drop session edit
groups
log in as user payments ssh key suspend view backups whitelist ips
with config problems user profile
unicast
3.23 V
virtual servers autoscale
convert backup to template build manually
create delete VS edit VS
integrated console manage custom variables manage networks manage power options manage recipes
migrate migrate disks
provisioning type
rebuild manually view
view details segregate set vip status statistics
VS transactions and logs VMware
configuration
create VMware server template VMware virtual servers
create
create template build manually edit
delete
integrated console
manage administrative options manage custom variables manage disk space
manage networks manage power options manage recipes migrate
statistics transactions and logs view
vCenter installation Vyatta installation
3.24 W
3.25 X
3.26 Y
yubikey
3.27 Z
Zabbix
zombie data stores zombie disks zombie domains zombie transactions
zombie virtual servers
4 What's New in OnApp Cloud 4.3
The OnApp Cloud 4.3 release contains the following changes and new features:
4.1 Changes to terminology and the user interface
The following terminology changes have been made in the 4.3 version of the OnApp Cloud: instance types have been renamed as instance packages.
4.2 New features for OnApp and vCloud integration
For the list of new functionality and improvements refer to OnApp and vCloud Director Configuration Guide
5 Document Conventions
The following document conventions are used in this guide.
Bold
Label or button names in the Control Panel, often clickable. For example:
On the VS's screen, click the Tools button, then select Delete Virtual Server.
Italics
Parameters and field labels in the UI. For example:
Password - set password for remote Vyatta management.
co de blo ck
Source code. For example:
alter if not: eth0 = public interface
eth1 = CP Communication interface
eth2 = VLAN communication interface
In some cases, code examples can be preformatted. For example: Run the following commands:
echo "cp /etc/vmware/firewall/vnc.xml" >> /etc echo "localcli network firewall refresh" >> /etc/rc.local
echo "esxcli network firewall refresh" >> /etc/rc.local
A menu selection
For example:
Go to Settings -> Networks -> Add New Network
We use the following formatting elements to draw your attention to certain pieces of information:
Info
An info message emphasizes or explains the information within the chapter.
(Clicking the OFF button performs graceful shutdown and then powers off the VS after the timeout set in the Configuration settings.)
Note
A Note message contains information essential for the task completion.
(The maximum length of a Mount Point is 256 characters.)
Warning
A warning message informs you of something you should not do or be cautious.
(You won't be able to restore a VS after deleting it.)
6 OnApp Cloud Overview
OnApp Cloud software enables service providers to turn their existing infrastructure (or any commodity hardware) into a single pool of resources - "a cloud" - which can then be sold to end users on a utility basis. It's a complete cloud deployment and management platform that's designed to make it easy for service providers to sell a wide range of cloud services.
OnApp Cloud can also be used by enterprise IT departments and MSPs to deliver cloud services to end users. For more information, see http://onapp.com/platform/.
This guide explains how to configure and use OnApp Cloud through the OnApp Control Panel management user interface. Depending on your OnApp Cloud license type (free or full), and how your cloud is configured, you can use the Control Panel to set up your own distributed SAN, DNS services and CDN services too, using OnApp's companion products, OnApp Storage and OnApp CDN. All of these functions are covered in this guide.
6.1 Main Components & Features
OnApp Cloud handles cloud deployment, VS deployment, VS management & resource allocation, Compute resource and SAN management, failover, user management, billing, self- provisioning, CDN and DNS, and other associated functions. Here's a brief description of the main components and features of the OnApp installation:
6.1.1 Servers
There are two required server types in an OnApp configuration Compute resource servers and the Control Panel server. OnApp also requires storage devices for templates, virtual servers and backups.
Control Panel server
The Control Panel server (sometimes known as the Base server) hosts the OnApp user interface and manages all the processes controlled by OnApp.
The Control Panel server:
Provides a web-based user interface
Assigns a virtual server to a Compute resource Creates/starts/stops/deletes virtual servers Resizes CPU and storage
Manages virtual servers through a console session Creates backups of virtual servers
Allows virtual servers to be restored from a backup
Allows the creation of custom templates from virtual server backups, for future deployment of new virtual servers
Displays your CPU usage and network utilization
Compute resources
Compute resources are Xen, KVM, or VMware ESXi/vSphere 5.0 -powered servers 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 servers as well as handling network/disk connectivity, monitoring, IP address anti-spoofing and more.
Compute resources:
Provide system resources such as CPU, memory, and network
Control the virtual differentiation of entities such as virtual servers and application data being delivered to cloud-hosted applications
Take care of secure virtualization and channeling of storage, data communications and server processing
Can be located at different geographical zones Can have different CPU and RAM
OnApp Cloud supports three Compute resource virtualization platforms: Xen - OnApp supports Xen 3 and Xen 4
KVM
VMware
VMware Compute resources operate in a slightly different way. With Xen/KVM OnApp controls Compute resources directly. With VMware, OnApp controls the VMware vCenter. This allows vCenter to control the VSs with the full range of VMware functionality including DRS and vMotion to ensure that the operation is optimal.
CloudBoot Compute resources
CloudBoot functionality is a method of Compute resource installation without the presence of a local disk or other local storage, utilizing the PXE and DHCP servers. To start using CloudBoot, you must have Integraded Storage configured and the CloudBoot enabled in the system configuration first. See CloudBoot Compute Resources section for details. CloudBoot Compute resources are used for smart and baremetal server provisioning.
Virtual Servers
OnApp gives you complete control of your virtual servers (VSs), and all files and processes running on those servers. You can start, stop, reboot and delete virtual servers. You can move VSs between Compute resources with no downtime. OnApp also lets you perform automatic and manual backups, and restore VSs in case of failure.
When creating a virtual server, you can choose a Compute resource server with data store attached if you wish. If not, the system will search for Compute resources available that have sufficient RAM and storage for that virtual server, and choose the one with the lowest (but sufficient) amount of RAM available.
You can monitor the CPU usage of each virtual server, and the network utilization of each network interface. This helps you decide if and when to change the resources available to each VS. OnApp also provides detailed logs of all tasks which are running, pending, have failed or have been completed.
Smart Servers
Smart servers are dedicated entities based on CloudBoot Compute resources with passthrough enabled. Smart servers are created and managed exactly the same as virtual servers, except only one smart server can be deployed per Compute resource. Smart servers can be organized into zones to create different tiers of service - for example, by setting up different zones for smart appliances, with limits and prices specified per zone. Smart appliance zones can also be used to create private clouds for specific users.
Baremetal Servers
Baremetal servers are physical servers that reside directly on the hardware without the virtualization layer. Namely, baremetal server is a Compute resource that runs on the OS installed. B aremetal Compute resources can not have more than one baremetal server located on it.
6.1.2 Storage devices
For VS template and backup storage we recommend that you set up a separate server with SSH (preferred) or NFS (for high end NAS). However, in a CloudBoot environment or for a small scale installation you can use the Control Panel server to host the templates and backups. You will also need a storage platform for virtual server disk storage. OnApp provides an integrated storage platform that enables you to expose local storage drives across Compute resources as a distributed block SAN with full redundancy and failover properties. Additionally, you can use any block based storage platform, such as local disks in Compute resources, 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.
6.1.3 Networks
With OnApp you can create complex networks between virtual servers residing on a single host, or across multiple installations of OnApp. You can configure each virtual server with one or more virtual NICs, each with its own IP and MAC address, to make them act like physical servers.
OnApp ensures that each customer has their own dedicated 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.
6.1.4 Templates
An OnApp template is a pre-configured OS image that is used to build virtual servers. There are two types of templates for virtual server deployment in OnApp: downloadable templates provided by OnApp, and custom templates you create from existing virtual servers. The OnApp template library includes a wide range of VS templates for various distributions of Windows and Linux, both 32- and 64-bit.
(At present OnApp does not support VSs/templates with Active Directory Domain Controllers.)
6.1.5 Scalability
OnApp is a highly scalable cloud deployment and management tool that allows you to add and remove Compute resources, data stores and resources at any time to meet your changing needs. You can add more CPUs and memory to a specific virtual server to increase its capacity, and increase the total available RAM and CPU by adding new Compute resources.
6.1.6 High availability
OnApp provides high reliability and availability in a number of ways:
Compute resource failover management system If a Compute resource fails, OnApp's self-healing architecture automatically moves virtual servers to another box. Compute resources 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 Compute resource is selected for a virtual server to boot there. This process is fully automatic but may take several minutes. When the crashed Compute resource comes online, it will be again available, but virtual servers previously migrated from it will not be migrated back.
Virtual servers OnApp keeps virtual servers running even if the Control Panel server goes offline. In such an event, you won't be able to perform any actions to virtual servers 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 server. You can always restore the virtual server 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.
High Availability Control Panel OnApp High Availability feature brings new opportunity to deploy more than one Control Panel within one cloud. This allows to improve cloud load balancing, minimize server downtime in case of CP issues and enhance scalability of the whole infrastructure.
6.1.7 Security
OnApp provides multiple layers of security:
Compute resource OnApp is a multi-Compute resource cloud system that currently supports Xen, KVM and VMware (Hyper-V and other Compute resources will be added in future releases). The first layer of security is provided by the Compute resource itself. For example, Xen provides full isolation between virtual servers and allows each virtual server to access its own disk only. When a virtual server makes a request for data, it gets redirected to its correct disk. Xen dictates which virtual servers and resources are allowed to run or be accessed at any given time.
Firewall In addition to the Compute resource security mechanism, there is also an anti-spoof firewall which resides on the server where you store virtual servers. The firewall enables the management operating system of the Compute resource to examine packets entering and leaving the virtual server. It blocks packets that do not belong to the virtual server and accepts those meeting the rules. The firewall prevents IP spoofing and packet sniffing.
Control Panel Virtual servers in OnApp are completely controlled by the administrator. Administrators have full root (Linux) or Administrator (Windows) access to accounts and servers. The Control Panel also lets you assign different levels of user access to virtual servers, Compute resources, consoles and disks.
Network Security is provided by completely isolating virtual servers 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.
6.2 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: Downloads).
The API makes integration straightforward for other applications too, including other control panels, CRM, support and billing systems.
For a detailed API guide with code samples, see OnApp 4.1 API Guide.
6.3 Hardware & Software Requirements
An OnApp installation requires at least two physical machines one for the Control Panel server, and the other for the Compute resource server. You can have as many Compute resource servers as you need. You will also need storage for your virtual servers (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.
(Compute resource serversx64 platform with AMD-V/VT-x hardware virtualization support enabled Quad Core 2Ghz+ CPU8GB+ RAM3x Gig network interface cards (4 recommended) 30 GB of free disk space (SSD Recommended)Control Panel serverDual or Quad Core 2Ghz+ CPU 8GB RAM (16GB+ recommended) 100GB Raid 12x Gig network interface cards)Server Requirements
(Backup server1GB RAM2TB+ NAS (alternatively, a large hard disk can be used on the Control Panel server for backups))Additional Server Recommendations
Storage Requirements
Integrated Storage Platform
Local Storage Only
Enterprise SAN
Any number of
Minimum 1
Centralised Block Storage
integrated storage drives
dedicated
SAN (iSCSI, ATA over
can be grouped together
partition in
Ethernet or Fibre Channel)
across any Compute
each
accessible to every Compute
resource
Compute
resource
resource
Integrated Storage Platform
Local Storage Only
Enterprise SAN
SSD drives recommended for best performance
separate disk from the primary OS drive
at least 1 dedicated 1GBit/s NIC assigned per Compute resource for the SAN
at least 1 dedicated NIC
recommended
multiple NICs bonded or
assigned per Compute
10GBit/s ethernet
resource for the SAN
recommended
multiple NICs bonded or
10GBit/s ethernet
recommended
6.4 Architecture
OnApp software transforms your server and storage hardware into a virtual network system that employs a Xen Compute resource 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.
(Hypervisors have been renamed as compute resources. Compute resources is a collective name for hypervisors, vCloud hypervisors and other hypervisor types.)
6.5 Network Configurations
There are several supported network configurations:
6.5.1 Cloud Only (Xen & KVM)
Basic Backup SchemeAdvanced Backup Scheme
Cloud only Network Diagram (BBS)
Cloud only Network Diagram (ABS)
6.5.2 Cloud & Storage
This allows you to use OnApp Integrated Storage. Data Protection is restricted to Basic Backup Scheme
Cloud and Storage Network Diagram (BBS)
6.5.3 Cloud Only (VMware)
Cloud only Network Diagram (VMware)
7 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.
7.1 Statistics
This is the default view, showing the Memory (sum total of all Compute resources' RAM resources), total Storage (sum total of all data store capacities) and IOPS in the cloud, along with the space remaining. Storage space and RAM for a normal user are set by the billing plan limits. For administrators, the bars show:
CPU usage, with the following details:
total cores - total physical cores on all Compute resources which are configured in OnApp
used cores - total virtual cores assigned to running VSs (may be higher than active cores if overselling)
Storage usage (sum total of all VS disks capacities + orphan disks capacities)
Memory usage (sum total of RAM allocated to VSs + RAM allocated to orphaned VSs) of the entire cloud.
IOPS /h usage - the input/output requests for the last hour for the entire cloud.
Baremetal servers - the amount of baremetal servers created in the cloud.
Smart servers - the amount of smart servers created in the cloud.
(Active cores (displayed at your OnApp Dashboard) means total physical cores on all Compute resources which have at least one VS running.) (For Integrated Storage the Storage usage is displayed in the following way:Used - sum of all created vdisks in all Data Stores in the cloudTotal - Used + summed up Maximum disk size values of each Data Store in the cloud)
7.2 Cloud
Clicking this icon shows details of the entire cloud:
For normal users, it shows the total number of virtual servers, RAM, data stores, backups and disk space they're using.
For administrators, it shows the total number of virtual servers, Compute resources, data stores and backups in the entire cloud.
7.3 Account
Clicking this icon shows details of your account: user's name, CDN status, license type, validity and key, number of cores on license, the date of the last sync with the licensing server.
7.4 Activity 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 servers. Administrators see recent transactions for the entire cloud.
7.5 Additional Navigation
Build in the upper right corner, click the Build button to create new virtual server, application server, load balancer, edge server, storage server or new blueprint.
Click the Arrow button to hide the Control Panel's menu.
Use the Search tool for global search across the cloud.
To hide the infobox on a particular page, click the Close button in the upper-right corner of the infobox. For more infobox settings, refer to User Profile section.
7.6 API Key
The API Key is used instead of the normal username/password credentials 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 Regenerate Key button. A new key will be generated, and you'll be taken back to the main Dashboard screen.
7.7 Login Screen
To access your Control Panel, you must first provide a username and password. Optionally, you can set up two factor authentication for your cloud using a Yubikey. Authentication means identifying a user and verifying that this user is allowed to access the OnApp Control Panel.
Check the Remember me box to have the CP remember your login details for one month. You will have to enter your login credentials again after you log out or clear your browser cookies.
If you have forgotten your password, press the Forgot your password? link and specify the email to which your reset password instructions will be sent.
To set up two factor authentication for your cloud you need to perform the following steps:
1. Enable the Use Yubico login option at Dashboard > Settings > Configuration > System tab. For more information on OnApp configuration, refer to the OnApp Configuration chapter.
2. Enable the Use Yubikey option for your user and set your Yubikey at Dashboard > Users and Groups > User name. For more information on user profiles, refer to the User Profile section.
Then you will be prompted to provide your OnApp login and password, and afterwards you will be forwarded to a page where you need to enter your Yubikey:
1. Insert the Yubikey into your computer's USB port. If the Yubikey is connected correctly, its status light will turn green.
2. Click in the Enter your Yubikey field.
3. Press your finger to the gold Yubikey button. A long line of characters will appear in the field. You will be automatically forwarded to your Dashboard page.
7.8 User Profile
Click your account name at the top of the Control Panel screen to view tabs with the details of the user account you're currently logged in with. It also includes infobox options and API Key information. Administrators can view details of all account profiles through the Control Panel's Users & Groups menu. For details, refer to the Users And Groups chapter.
This chapter contains information on the following tabs that comprise the user profile: Overview
Payments Billing Plan White List Backups
Customer Networks iFrame
7.8.1 Overview
This tab contains information on the user's login, user roles, billing plan, prices and other.
ProfileUser Details
These are the settings which are specified at user creation process.
User's avatar (this feature is available if the Use gravatar option is enabled - Create User
).
User's name and surname. User's email.
Last Access Log - click to see information on the IP addresses that logged in to your account, and the time and date of access.
Drop Other Sessions - click if you want all other IPs that are logged in to your account to be logged out. The only IP address that will still be logged in to the account will be the one you are currently using.
Login - user's screen name.
User Roles - the roles assigned for the user. The roles are set at user creation process.
User Group - the group to which this user is assigned. The user groups are set at user creation process.
Time Zone - time zone set for this user.
Locale - locales set for this user.
System Theme - the color scheme: light or dark.
Display infoboxes whether infoboxes are displayed or not for this user.
Restore infoboxes - click this button to display infoboxes for the user (this option may be disabled depending on the user's permissions).
Send Password Reminder - click this button to send the password reminder to the user. The user will receive an email with a link for change password action.
Amazon Web Services
Shows the the status of the Amazon Web Services: disconnected or connected. For more information, see Enable/disable AWS.
Here you can also connect Amazon Web Services:
1. Click the(Connect) icon.
2. On the following page provide your AWS credentials: AWS access key ID and AWS secret access key.
3. Click Submit to connect AWS to your account.
Additional Info
User Additional Fields allow administrators to create custom fields and use them with the API or a third party system. These fields will vary for different users, depending on the information the administrator wants them to fill in.
For more information, see User Additional Fields.
Oauth Authentication
OAuth - open standard for authorization - enables users to log into OnApp using their Google and Facebook accounts. For users to access this feature, it should be enabled by the Cloud Administrator.
Facebook - click Connect to set up this option. If it is configured correctly, you will be able to log in to your account by entering your Facebook login details.
Google - click Connect to set up this option. If it is configured correctly, you will be able to log in to your account by entering your Google login details.
For more information, see OAuth.
vCloud Credentials
Login - the user's vCloud login
Password - click the Change Password link to edit the user's vCloud credentials For more information, see Manage vCloud Credentials.
API Info
API key - click the Regenerate Key button to generate a new API key.
For more information, see API Key.
Yubico info
Use Yubikey - move the slider to the right to enable logging in using a Yubikey for this user.
Enter the Yubikey in the form that appears:
1. Insert the Yubikey into your computer's USB port. If the Yubikey is connected correctly, its status light will turn green.
2. Click in the Enter your Yubikey field.
3. Press your finger to the gold Yubikey button. A long line of characters will appear in the field.
Billing Details
Price per hour - shows the price for VSs, Load Balancers, and other resources per hour.
Billing plan - the billing plan this user is assigned to. Click the plan label to see its details.
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.
Monthly fee - a set monthly price for a billing plan.
Total cost - the sum of used resources cost and virtual servers cost.
Payments - the total amount of payments made.
Virtual Server Hourly Statistic - clicking this link will generate billing statistics for all virtual servers owned by this user. For more information, see Virtual Server Billing Statistics.
User Statistic - clicking this link will generate user's resource usage statistics. For more information, see User Billing Statistics.
Monthly Bills - clicking this link will generate the bills list that shows the total due per each month of the year. To view billing statistics, select a year from the drop-down list and click Apply. The list that appears displays a particular month of the selected year and the cost of used resources for that month. At the bottom of the list there is the total amount of money which was to be paid for the selected period.
Prices
The list of all used resources and their price per hour for two states: server powered ON and server powered OFF.
Servers
Shows the list of all virtual servers, load balancers, edge servers, smart servers, application servers in the cloud with their prices for server on and off.
Backups
Backups Count - the price per hour for the quantity of the user's backups. Templates Count - the price per hour for the quantity of the user's templates. ISOs Count - the price per hour for the quantity of the user's ISOs.
Templates, ISOs & Backups Disk Size - the price per hour for the disk space user's /ISOs
/backups/templates occupy.
Autoscaling Monitor Fee - the price per hour for autoscaling monitors.
Backup Server Groups - the price per hour for the resources consumed by backup server groups.
Edit Profile
To edit the details of the user profile, click the edit button in the upper right corner. You will then be redirected to a page where you can change the details of your profile. Besides the details described above, you can also change the password and auto suspending settings.
7.8.2 Payments
This tab contains the list of your paid invoices. Once you have paid an invoice, you can add it to the system:
1. Clicking Create Payment or +.
2. On the following page indicate the invoice number and the amount of money paid.
3. Click Save and the invoice will be added to the list of payments.
7.8.3 Billing Plan
This tab contains the details of the billing plan assigned to the user. The following sections are displayed:
User VS limit
Limits for Template Store Limits for Recipe Groups
Limits & Pricing for Compute resource Zones Limits & Pricing for Data Store Zones
Limits & Pricing for Network Zones Limits for Edge groups
Limits & Pricing for Backup server Zones Limits for guaranteed minIOPS
Limits for Instance Packages
For more information, see Set Billing Plan Prices and Resource Limits.
7.8.4 White List
This tab includes the list of IPs from which this user can log in to the Control Panel. For each of the IPs, the following details are displayed:
IP - the IP you want to add to the white list.
Description - the description of that IP.
Actions - you can edit or delete the chosen IP address.
To add a white list IP:
1. Click Create White List IP or +.
2. On the following page fill in the IP and description of the new IP.
3. Click Save IP and the new IP address will be added to the White List.
You can also delete all IPs from the White List by clicking Clear White List IPs. For more information, see User Whitelist IPs.
7.8.5 Backups
This tab contains the list of the user's backups. For each backup the following details are displayed:
Date - the date when the backup was made.
Target - target for which the backup was taken - either a disk (for normal backups) or a virtual server (for incremental backups).
Status - the status of the backup, whether it was built or not.
Backup Size - the size of the backup in MB.
Initiated - how the backup was launched - either manually or automatically on a periodic basis - annual, monthly, weekly or daily.
Backup Server - the backup server where the backup is stored.
Note - an arbitrary note to the backup.
VS - the virtual server for which the backup was taken.
Customer - the customer this backup refers to.
Actions - you can perform the following actions: convert the backup to template
restore the system from the chosen backup
view Virtual Server backups for this particular VS delete the backup
add or edit the backup's note.
7.8.6 Customer Networks
(This is a VMware vCenter feature only.)
This tab contains the list of user's customer networks. Customer networks are used for isolation of customers virtual servers from other customers' VSs via VLAN.
For each customer network, the following details are displayed:
Name - the name of the customer network.
Network address - the network address of this customer network.
Default outside IP address - the default outside IP address of this customer network.
VLAN - a group of virtual servers functioning as if theyre connected to a single network (even if they are not, in fact).
Actions - you can delete the customer network.
You can add new customer networks to the profile:
1. Click New Customer Network or +.
2. On the following page provide the following details of the new customer network:
Label - the label of the new customer network.
Compute resource - select the VMware Compute resource to associate the customer network with.
IP Address Pool - a range of NAT IP addresses.
Network Zone - specify the network zone to which the customer network will be assigned.
Prefix Size (CIDR) - the prefix size should be in the range 24-30 and is used to set the subnet size.
Is nated - select this check box to use NAT for translating the traffic from Vyatta's single eternal IP to local customer network IPs. Leave this box unchecked if you are using your own firewall with external IP address.
3. Click Create Customer Network and the new network will be added to the customer networks list.
If you decide not to add a new network and want to return to the previous page - click Back. For more information, see Customer vCenter Networks.
7.8.7 iFrame
This tab is iFrame show page. The title of this tab is set by the user when configuring this option. If required you can integrate an iFrame into OnApp which will display a web page within the user OnApp Control Panel. By default, the possibility to configure an iFrame is disabled. To enable, use the Enable iFrame Window permission.
For more information, see iFrame Configuration.
7.9 Cloud Search Tool
The search tool in the upper right corner allows you to search your cloud for: IP addresses
Usernames
Users full names (first or last name, in any order) VS labels
VS identifiers Disk identifiers Log IDs Backups Template labels
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 confirm.
The results are organized according to the menu item they refer to, e.g., Pages, Virtual Servers, Users, Locales, etc. Click a search result to open the relevant details page.
8 Appliances
Appliances is a collective name for all virtual and physical devices that can be provisioned in the cloud. The term appliance seizes the following cloud components:
Virtual Servers
VMware vCenter Virtual Servers (of vCenter Implementation guide) Smart Servers
Baremetal Servers Load Balancers Compute Resources Assets
OnApp Cloud gives you high-end cloud management features for the following appliances including:
Server Options
Virtual Servers
Smart Servers
Application Servers
Baremetal Servers
Edit
Rebuild manually
Migrate
Delete
Segregate
Set VIP status
Autoscale
Power Options
Reboot
Reboot in recovery
Server Options
Virtual Servers
Smart Servers
Application Servers
Baremetal Servers
Boot from ISO
Suspend
Shut down
Startup
Startup on Recovery
Administrative Options
Reset Root Password
Change owner
Set SSH keys
Edit Administrator's note
Integrated console
Transactions and logs
Networks
Configure network interface
Rebuild network
Set firewall rules
Virtual server IP addresses
Display network speed for network interfaces
Server Options
Virtual Servers
Smart Servers
Application Servers
Baremetal Servers
Edit network speed
Disks
Create disks
Edit disks
Migrate disks
Delete disks
Backups
View
Convert to template
Restore backup
Delete backup
Edit backup note
Backup Schedules
View schedules
Create schedule
Edit schedule
Delete schedule
Statistics
Server Options
Virtual Servers
Smart Servers
Application Servers
Baremetal Servers
CPU utilization
Billing statistics
Network interface statistics
Disk IOPS statistics
Recipes
Recipes
Custom variables
8.1 Virtual Servers
Virtual servers are based on templates and are deployed on Compute resources. Compute resources give them access to CPU, disk and network resources. OnApp Cloud gives you high- end cloud management features including:
(Virtual Server OptionsPower OptionsAdministrative OptionsNetworksDisksBackupsBackup SchedulesStatisticsEditRebootReset Root PasswordConfigure network interfaceCreate disksViewView schedulesCPUutilizatioRebuild manuallyReboot in recoveryChange ownerRebuild networkEdit disksConvert to templateCreate scheduleBilling statisticsMigrateSuspendSet SSH keysSet firewall rulesMigrate disksRestore backupEdit scheduleNetwork interface statistics)n
Virtual Server Options
Power Options
Administrative Options
Networks
Disks
Backups
Backup Schedules
Statistics
Delete
Shut down
Edit Administrator's note
Virtual server IP addresses
Delete disks
Delete backup
Delete schedule
Disk IOPS
statistics
Segregate
Startup
Integrated console
Display network speed for network interfaces
Edit backup note
Set VIP status
Startup on Recovery
Transactions and logs
Edit network speed
Autoscale
Boot from ISO
Enable Disaster Recovery
OnApp supports two kinds of storage for virtual servers: traditional centralized SANs, and the new distributed block storage functionality introduced with OnApp Storage, in which local disks in Compute resources provide the physical storage space allocated to virtual servers. In each case, the OnApp platform creates virtual data stores from the physical resources, and uses these to provide virtual servers with virtual disks.
Administrators in OnApp have full control over the lifecycle of virtual servers. Virtual servers can be in the following states:
Created - A server is created when you successfully Create Virtual Server from the Virtual servers menu, having selected its template and set its properties, resources and network requirements.
Build - A virtual server 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 Server Automatically box during the creation process.
Powered on - A power on starts the virtual server, 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 server and its operating system, which typically involves terminating all running applications.
Rebooted - Rebooted means a virtual server has been shut down, and then powered on again.
Deleted - When a virtual server is deleted, its backups are still stored on the server and can be restored if required.
Re-built - To rebuild a virtual server means to reinstall the template and reconfigure the resources and network. All data will be lost.
Failed - A failed virtual server is one that is down, for example because of hardware or network problems. You will have to start the server manually when those problems have been solved.
8.1.1 View Virtual Servers
To view all virtual servers deployed in the cloud:
1. Go to your Control Panel's Virtual Servers menu to see an overview of all virtual servers in the cloud.
2. The page that loads will show the list of VSs together with their: operating system
label. Click the label to see the VS details.
VIP status (enabled or disabled). Click the icon to enable/disable VIP status of a particular VS.
IP addresses allocated disk size RAM
backups - the number of backups and the space these backups take. compute resource - the label of compute resource with which VS is associated user - the owner of this VS. Click the user name to see the owner details. power status. Click the on/off buttons to change the status.
3. Click the Actions button next to the VS for the quick access to the list of VS actions (the list of actions displayed depends on the VS status):
1.Reboot a VS
Recovery reboot Power off a VS CPU usage Backups Shutdown
Start up Recovery start up Unlock
To search for a particular virtual server, click the Search icon at the top of the VS list. When the search box appears, type the text you want to search for and click the Search button:
8.1.2 View Virtual Server Details
To view details of a specific virtual server:
1. Go to your Control Panel's Virtual Servers menu.
2. Click the label of the virtual server you're interested in.
3. The screen that appears loads the VS properties, notes, activity log and tools for managing your VS.
VS Properties
VS properties page gives general overview of the VS details: Template this VS is built on
Power status & On/Off/Reboot buttons.
(Clicking the OFF button performs graceful shutdown and then powers off the virtual server after the timeout set in Configuration settings.)
Segregated VS. This field appears if the VS is segregated from another virtual server. Click the label of the virtual server to view the details of the VS from which the current server is segregated.
Hostname
Compute resource. Click the Compute resource name to see its details
Location group. Click the location to view the details of the location group with which the VS is associated.
Login credentials
Owner. Click the owner name to see its details.
VIP status (on/off). Click the icon to change the status. Price per hour
(Please pay attention that when you edit a VS, the price is changed, and the new price is not applied immediately. It takes about 5 minutes to take effect.)
Memory CPU(s)
CPU priority or CPU units Disk Size
Disk backups Network Speed
IP Addresses. Only the first five IP addresses are displayed on the virtual server properties page. To view the list of all virtual server IP addresses, mouse over IP addresses area or go to the Networking > IP addresses tab.
Autoscale - move the slider to enable/disable the autoscaling rules set for this VS.
(Until the autoscaling rules are configured the autoscaling itself will not start working.If the Autoscale slider is greyed out that means that you have reached the autoscaling limit in billing plan (or the max is set as 0).)
Auto-backups - move the slider to enable/disable automatic backups for this VS. If the incremental backups are enabled in your cloud, you can set auto-backups per VS rather than per disk.
(If the automation options werent enabled during this virtual server creation, youll be redirected to the form where you can configure them.)
Accelerate - move the Accelerate slider to the right to enable acceleration for this VS or move this slider to the left to disable acceleration for this VS. For more information, refer to CDN Accelerator section. If VS is accelerated, you can also view the actual Acceleration Status - active or inactive.
Notes
The Notes section lists brief comments or reminders for a VS. You can add either Admin's or User's notes. The Admin's note will be available to cloud administrators. Click the Actions button in the Notes section of the page to add admin's or user's note.
VS Management
Click the Tools button to expand the Tools menu with the VS management options . Use the top menu to manage your virtual servers' statistics/networking/storage options.
8.1.3 Create Virtual Server
Virtual servers are created from templates. To create a virtual server:
1. Go to your Control Panel's Virtual Servers menu and click the "+" button, or click the Create Virtual Server button at the bottom of the screen. This will start a VS creation wizard.
2. Fill in the wizard step by step. Each of these steps is described in the corresponding sections below.
3. Click the Create Virtual Server button to start the creation process. You will be taken to the virtual server details screen.
(On this page:Step 1 of 6. Cloud LocationsStep 2 of 6. TemplatesStep 3 of 6. Virtual Server Properties Step 4 of 6. ResourcesStep 5 of 6. RecipesStep 6 of 6. Confirmation) (OnApp must be configured properly before VSs can be created. You must have: At least one data store configured and assigned to a data store zoneAt least one network configured and assigned to a network zone At least one Compute resource configured and onlineAt least one Compute resource assigned to a Compute zone At least one data store attached to a Compute resourceAt least one network attached to a Compute resource Assigned a billing plan to the user creating the VS)
(See also:Virtual Servers - the information on managing virtual serversSet Billing Plan Prices And Resource Limits - billing plan configuration Create Billing Plan - the info on how to set Lincensing Type in billing plans Template Software Licenses - how to enable MAK or KMSSet up Instance Packages for Cloud - the walk-through for using packages of resourcesRecipes - recipes creation and managementVirtual Servers (API) - the list of available API requests)
Step 1 of 6. Cloud Locations
The Cloud Locations step applies to those users who have Compute zones assigned to location groups in their billing plan. This step will be present in the wizard if both of the following requirements are met:
all compute resources available to the user are assigned to location groups compute resources are assigned to different locations
If the user's billing plan has several Compute zones, some of which are assigned to location groups, whereas others are not - the cloud locations screen will not be available in the wizard. Also if all compute zones are assigned to the same location this step will be skipped. In this case the wizard will start with the Templates step.
Indicate your virtual server's cloud location:
Country - choose the country, where the cloud is located, from the drop-down menu. City - specify the city, where the cloud is located, from the drop-down menu.
Click Next to proceed to the following step of the wizard to specify the virtual server templates.
Step 2 of 6. Templates
At this step, specify the template from which your virtual server will be built. Greyed out templates mean that there are not enough resources to build a VS from this template. To choose a template:
1. Click the required Operating system label (Windows, Linux or FreeBSD) to expand the list of template groups
2. Distribution - choose a template Distribution
3. Template - select the template
4. Click Next
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:
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. Consider the following when creating a VS on Windows templates:
It is possible to deploy Windows virtual servers without running sysprep. To do so, you need to disable the Run Sysprep option for the Compute zone the virtual server will be built on. See Create Compute Zone section for details.
If there are several virtual servers simply deployed from the same template in the cloud, they will have identical SIDS. This will result in the system conflict.
It is not possible to select KMS or own licensing type when creating a Windows virtual server from custom template. As a workaround, you can create a virtual server from the template used for custom template creation.
Proceed to the following step of the wizard and specify the virtual server properties.
(Template extraction is performed during server provisioning or taking a backup when using a particular template. To prevent template from being used in other transactions during extraction, template is locked during the extraction and unlocked on accomplishment. If other transaction tries to use the locked template, it will fail after 5 minutes of standby. Transaction which locked template and failed, means that extracted template is broken.)
(Storing scheme:template /onapp/templates/your_template.tgzextracted template /onapp/backups/templates/your_template locked template /onapp/backups/templates/your_template.lock)
Step 3 of 6. Virtual Server Properties
At this step you need to indicate your virtual server's properties, such as label, Compute resource, password and other. You can create a virtual server having specified only the required parameters and configure it later.
Specify the following virtual server properties:
Label - the label of the virtual server. The required parameter.
Hostname - the hostname of the virtual server. The required parameter. The hostname should consist of letters [A-Z a-z], digits [0-9] and dash [ - ]. For more info on hostname validation, refer to RFC standard documentation.
(Particular characters are not allowed for Windows-based virtual servers: percent sign [%]double quotation marks [] brackets []vertical bar [|] caret [^] ampersand [&] parentheses [(,)])
Time zone - set the time zone for the virtual server. This parameter is applicable only to Windows XEN and KVM virtual servers.
(Currently, the time zone is set at the Compute resource side only. Therefore, users need to set the target time zone inside a Windows VS manually. Setting correct time zone at the Compute resource side helps to keep correct time inside a VS after starting it if time synchronization is not completed for some reason.)
Password - a secure password for the VS. It can consist of 6-99 characters, letters [A-Za- z], digits [0-9], dash [ - ] and lower dash [ _ ], and the following special characters: ~ ! @
# $ * _ - + = ` \\ { } [ ] : ; ' , . ? /. You can use both lower- and uppercase letters.
Password confirmation - repeat the password to confirm it.
Encrypt password - move the Encrypt Password slider to the right, to encrypt your password, then enter an encryption key in the field that appears.
Click Next to proceed to the following step of the wizard to specify the virtual server resources.
Step 4 of 6. Resources
At this step, you can choose to create the virtual server either by selecting a predefined instance package or by setting your virtual server's resources, such as disk size, network configuration and other manually.
A VS created using instance packages is called an instance package VS.
A VS created by setting resources manually is called a custom virtual server.
(Depending on the permissions, this step will display either Instance Packages orCreate your own tabs, or both of them.You are forwarded to the next step from the tab you are currently on. If you select an instance package and then click on the Create Your Own tab and proceed to the next step, the system will set the resources from the Create Your Own tab even if you did not configure any resources there.)
Resources Instance packages
(Note that instance package VSs can only be created on compute resources within compute zones where all compute resources are assigned the same amount of CPU units. If there are compute resources with different amount of CPU units set in a zone, it will not be possible to create instance package VSs in such zones. The reason is that CPU priority for instance package VSs in this configuration cannot be set to 100%, which is the default value for such virtual servers.If there are no available IP addresses during VS creation, all instance packages will be grayed out in the wizard.)
From this tab, you can choose one of the predefined Instance Packages for your virtual server.
If you select a compute zone that does not have enough resources during virtual server creation, you will see all instance packages available to you, but those that have resources incompatible with the chosen compute zone will be grayed out. Grayed out instance packages cannot be selected.
For each of the instance packages the following details are displayed: Memory - the RAM size (GB) available in the instance package CPUs - the number of CPU cores available in this instance package Disk Size - the disk size available in this instance package Bandwidth - the bandwidth available in this instance package
Price per Hour:
Mode ON - hourly instance package price for the VS powered on
Mode OFF - hourly instance package price for the VS powered off Price per Month:
Mode ON - monthly instance package price for the VS powered on
Mode OFF - monthly instance package price for the VS powered on
Click the instance package to select it. After that, the instance package you have chosen will be highlighted in green.
(Virtual servers created using instance packages do not support autoscaling.)
Create Your Own
Using this tab you can define the resources for your virtual server manually:
Compute Resources
Compute Zone - the Compute zone to build the VS on
Compute Resource - the specific Compute resource to build the VS on. Compute resource may be selected automatically according to the set provisioning type.
(When the Show Compute resources on Virtual Machine creation permission is disabled (so that user cannot select the Compute resource, but can choose the virtualization type), the Compute resource that meets the virtualization type and the resources set will be automatically selected. The data store will be set according to the compute zone selected.)
Resources
RAM - set the amount of virtual server's RAM. The maximum RAM depends on your billing plan's settings. The maximum RAM that can be assigned to a VS is 168 GB regardless of the Max RAM value set in the billing plan. The maximum RAM that can be assigned to a VS built on a XEN 32bit (x86) template is 16 GB.
CPU Cores - set the amount of virtual server's CPU cores. For KVM Compute resources, this parameter sets CPU sockets by default, unless CPU topology is enabled.
CPU Priority (or CPU Units) - set virtual server's CPU priority. If the CPU units are switched on in the billing plan for this user, then CPU priority is replaced with CPU units. Refer to Billing Calculation section for details on CPU units and CPU priority.
(Do not use CPU Units for KVM Compute resources running on CentOS5.)
The following options are available for VSs based on KVM Compute resources only, providing the Enable CPU topology permission is switched on for the user.
Use CPU Topology - move the slider to the right, to set the following parameters:
CPU Sockets - set the amount of sockets.
CPU Threads - set the amount of threads per core.
(CPU topology (CPU sockets and CPU threads) is the Labs feature preview. Pay attention that setting CPU sockets and CPU threads are at your own risk only!You may face the following problems when setting CPU topology:Currently you cannot set CPU sockets and threads parameters for existing VSs.After setting, the new parameters won't be shown at the VS details screen. Some Linux VSs fail to boot up.When sockets and threads are set incorrectly, you may face huge load on Compute resource's under CentOS 5.x.)
Primary Disk
Data Store Zone - choose a data store zone for VS's primary disk.
Primary disk size - set the primary disk size.
Swap Disk
Data Store Zone - choose a data store zone for VS's swap disk.
Swap disk size - set the swap disk size. There is no swap disk for Windows-based VSs. In all other cases, swap disk size must be greater than zero.
Network Configuration
Network Zone - choose a network zone from the drop-down box.
Show only my IP address - tick this checkbox to view only own IP addresses in the IP addresses dropbox.
Show IP address selection for new VS - if the option is available, you can also assign an IP address for the VS from the drop-down menu. Indicate Compute resource and network to have the list of available IPs.
Port Speed - set the port speed for this VS
(Show IP address selection for new VS option is enabled via the "Specify a network address on new VS page" checkbox on the Settings > Configuration settings screen (under the System tab).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 server with unlimited network speed without selecting a network zone only if you have only one Network Zone assigned to your billing plan.)
Click Next to proceed to the following step of the wizard where yo