docs.onapp.com · web viewthis guide explains how to configure and use onapp cloud through the...
Post on 21-May-2019
227 Views
Preview:
TRANSCRIPT
OnApp 5.3 Administration Guide v2
(Author:AdminVersion:2Date:2016.12.07) (OnApp 5.3 Administration GuideOnApp 5.3 Administration Guide) 0
Table of ContenTs
1Key to interface and icons30
2OnApp 5.331
3Index33
3.1A B C D E F G H I J K L M N O P R S T U V W X Y Z33
3.2A33
3.3B34
3.4C36
3.5D39
3.6E40
3.7F40
3.8G40
3.9H40
3.10I40
3.11J41
3.12K41
3.13L41
3.14M42
3.15N42
3.16O42
3.17P43
3.18Q43
3.19R43
3.20S44
3.21T45
3.22U46
3.23V46
3.24W48
3.25X48
3.26Y48
3.27Z49
4What's New in OnApp Cloud 5.350
4.1Zone Types50
4.2Service Add-ons50
4.3CDN reporting50
4.4Integrated Storage Auto Healing51
4.5Transaction change tracking51
4.6Service Catalog51
4.7rDNS zone and PTR records creation51
4.8vCloud Director improvements51
4.9CloudBoot KVM CentOS 7 support52
5Document Conventions53
6OnApp Cloud Overview55
6.1Main Components & Features55
6.1.1Servers55
6.1.2Storage devices57
6.1.3Networks57
6.1.4Templates58
6.1.5Scalability58
6.1.6High availability58
6.1.7Security59
6.2API and Integrations59
6.3Hardware & Software Requirements60
6.4vCloud Director Integration Implementation Details61
6.4.1Implementation62
6.5vCloud Director Supported Functionality65
6.6Architecture70
6.7Network Configurations71
6.7.1Cloud Only (Xen & KVM)71
6.7.2Cloud & Storage73
6.7.3Cloud Only (VMware)75
6.8Zone Types76
7Dashboard78
7.1Statistics78
7.1.1vCloud Statistics79
7.2Your summary80
7.3Activity log80
7.4Additional Navigation80
7.5API Key81
7.6Login Screen81
7.7User Profile82
7.7.1Overview83
7.7.2Payments87
7.7.3Billing Plan87
7.7.4White List88
7.7.5Backups88
7.7.6iFrame89
7.8Cloud Search Tool89
8Service Catalog90
9Appliances92
9.1Virtual Servers94
9.1.1View Virtual Servers96
9.1.2View Virtual Server Details98
9.1.3Create Virtual Server100
9.1.4Virtual Server Creation Workflow110
9.1.5Edit Virtual Server112
9.1.6Rebuild/Build Virtual Server Manually113
9.1.7Migrate Virtual Server114
9.1.8Autoscale Virtual Server114
9.1.9Set VIP Status for Virtual Server116
9.1.10Purge Content116
9.1.11Segregate Virtual Server117
9.1.12Delete Virtual Server117
9.1.13Virtual Server Power Options118
9.1.14Virtual Server Administrative Options119
9.1.15Virtual Server Networks121
9.1.16Virtual Server Disks130
9.1.17Virtual Server Backups135
9.1.18Virtual Server Backup Schedules145
9.1.19Virtual Server Statistics149
9.1.20Virtual Server Integrated Console153
9.1.21Virtual Server Transactions and Logs153
9.1.22Virtual Server Recipes155
9.1.23Virtual Server Recipe Custom Variables156
9.1.24Virtual Server Service Add-ons156
9.2vCloud Director Virtual Servers158
9.2.1Manage vCloud Director VSs159
9.2.2Manage vCloud Director VS Disks164
9.2.3View vCloud Director VS Statistics168
9.2.4vCloud Director VS Network Interfaces170
9.2.5vCloud Director VS Snapshots174
9.2.6vCloud Director VS Guest Customization177
9.2.7vCloud Director VS Recipes179
9.2.8vCloud Director VS Recipe Custom Variables182
9.2.9vCloud Director VS Service Add-ons184
9.3ISO Virtual Servers187
9.3.1View ISO Virtual Servers187
9.3.2View ISO Virtual Server Details189
9.3.3View ISO Virtual Server Transactions and Logs189
9.3.4Create ISO Virtual Server191
9.3.5Manage ISO Virtual Servers196
9.3.6ISO Virtual Server Networks201
9.3.7ISO Virtual Server Disks206
9.3.8ISO Virtual Server Statistics209
9.4OVA Virtual Servers213
9.4.1View OVA Virtual Servers214
9.4.2View OVA Virtual Server Details215
9.4.3View OVA Virtual Server Transactions and Logs216
9.4.4Create OVA Virtual Server217
9.4.5Manage OVA Virtual Servers223
9.4.6OVA Virtual Server Networks227
9.4.7OVA Virtual Server Disks233
9.4.8OVA Virtual Server Statistics236
9.5Smart Servers239
9.5.1View Smart Servers241
9.5.2View Smart Server Details241
9.5.3Create Smart Server242
9.5.4Smart Server Creation Workflow246
9.5.5Rebuild/Build Smart Server Manually248
9.5.6Edit Smart Server248
9.5.7Delete Smart Server249
9.5.8Autoscale Smart Server249
9.5.9Purge Content.251
9.5.10Migrate Smart Server252
9.5.11Smart Server Power Options252
9.5.12Smart Server Administrative Options253
9.5.13Smart Server Networks254
9.5.14Smart Server Disks257
9.5.15Smart Server Backups259
9.5.16Smart Server Backup Schedules264
9.5.17Smart Server Statistics269
9.5.18Smart Server Integrated Console271
9.5.19Smart Server Transactions and Logs272
9.5.20Smart Server Recipes272
9.5.21Smart Server Recipe Custom Variables273
9.5.22Smart Server Billing274
9.6Baremetal Servers274
9.6.1View the List of Baremetal Servers275
9.6.2View Baremetal Server Details275
9.6.3Create Baremetal Server276
9.6.4Baremetal Server Creation Workflow278
9.6.5Edit Baremetal Server280
9.6.6Delete Baremetal Server280
9.6.7Manage Baremetal Server Recipes281
9.6.8Manage Baremetal Server Recipe Custom Variables281
9.6.9Baremetal Server Billing282
9.6.10Baremetal Server Recovery Mode283
9.7Application Servers283
9.7.1View Application Servers285
9.7.2View Application Server Details286
9.7.3Create Application Server287
9.7.4Edit Application Server292
9.7.5Rebuild/Build Application Server Manually292
9.7.6Migrate Application Server292
9.7.7Autoscale Application Server293
9.7.8Set VIP Status for Application Server294
9.7.9Segregate Application Server294
9.7.10Delete Application Server295
9.7.11Application Server Power Options295
9.7.12Application Server Administrative Options296
9.7.13Application Server Networks297
9.7.14Application Server Disks302
9.7.15Application Server Backups306
9.7.16Application Server Backup Schedules311
9.7.17Application Server Statistics316
9.7.18Application Server Transactions and Logs318
9.7.19Application Server Billing320
9.8Container Servers321
9.8.1View Container Servers322
9.8.2View Container Server Details323
9.8.3Create Container Server325
9.8.4Edit Container Server330
9.8.5Container Server Cloud Config330
9.8.6Container Server Billing332
9.8.7Rebuild/Build Container Server Manually333
9.8.8Migrate Container Server334
9.8.9Set VIP Status for Container Server334
9.8.10Segregate Container Server335
9.8.11Delete Container Server335
9.8.12Container Server Power Options336
9.8.13Container Server Administrative Options337
9.8.14Container Server Networks338
9.8.15Container Server Disks344
9.8.16Container Server Statistics348
9.8.17Container Server Integrated Console351
9.8.18Container Server Transactions and Logs352
9.8.19Container Server Recipes353
9.8.20Container Server Recipe Custom Variables354
9.9Load Balancers355
9.9.1View Load Balancers355
9.9.2Create Load Balancer Cluster358
9.9.3Create Autoscaling Cluster360
9.9.4Edit Load Balancer362
9.9.5Delete Load Balancer363
9.9.6View Load Balancer Billing Statistics363
9.9.7View Load Balancer Autoscaling Monitors363
9.10Compute Resources365
9.10.1Compute resource features366
9.10.2Compute resource management367
9.10.3Compute Resource Matrix367
9.10.4CloudBoot Compute Resources372
9.10.5VMware Compute Resources372
9.10.6vCD Compute Resources373
9.10.7View Compute Resources374
9.10.8View Compute Resource Details.375
9.10.9Edit Compute Resource Details375
9.10.10Reboot Compute Resource376
9.11Assets378
10Applications380
10.1The List of Available Applications380
10.1.1Forums380
10.1.2Blogs381
10.1.3CMS382
10.1.4E-commerce384
10.1.5Social networking385
10.1.6Educational385
10.1.7Video386
10.1.8Admanager386
10.1.9Galleries386
10.1.10Projectman387
10.1.11Files388
10.1.12Wikis388
10.1.13Frameworks388
10.1.14Mail389
10.1.15Customer support389
10.1.16ERP390
10.1.17DBtools390
10.1.18Music391
10.1.19Polls391
10.1.20Guestbook391
10.1.21Calendars392
10.1.22Games392
10.1.23RSS392
10.1.24Microblog392
10.1.25Others392
10.2View Applications394
10.3Create Application395
10.4Delete Application399
10.5Application Backups400
10.5.1View Application Backups400
10.5.2Create Application Backup400
10.5.3Restore Application Backup401
10.5.4Delete Application Backup401
10.6Manage FTP Users402
10.6.1View FTP users402
10.6.2Create FTP user403
10.6.3Delete FTP user404
10.7Manage Domains404
10.7.1View Domains405
10.7.2Create Domain405
10.7.3Delete Domain406
10.8Manage Databases406
10.8.1View Databases and Database Users407
10.8.2Create Database408
10.8.3Create and Manage Database Users409
10.8.4Assign User and Set Privileges for Database410
10.8.5Edit Users, Assigned to Database411
10.8.6Remove Database411
10.9System Application Settings412
10.9.1List of system applications413
10.9.2PHP version switching413
10.10Manage Email Accounts414
10.10.1View email accounts414
10.10.2Deploy Email Server415
10.10.3Create email account415
10.10.4Remove email account416
10.11Manage Services416
10.11.1View services416
10.11.2Start/Stop/Restart services417
11vCloud Director418
11.1Create and Manage Catalogs419
11.1.1View Catalogs419
11.1.2Create Catalog420
11.1.3Delete Catalog421
11.1.4View Media Library421
11.1.5Add file to Media Library422
11.2Create and Manage Orchestration Models423
11.2.1View orchestration models423
11.2.2Create orchestration model426
11.2.3Deploy orchestration model428
11.2.4Delete orchestration model430
11.3Create and Manage vApps430
11.3.1View vApps431
11.3.2Create vApps433
11.3.3Recompose vApp436
11.3.4Add vApp to Catalog439
11.3.5Edit vApp440
11.3.6Start/Stop vApps440
11.3.7Delete vApps440
11.4Create and Manage vApp Templates441
11.4.1View vApp Template442
11.4.2Create vApp Template442
11.4.3Delete vApp Template443
11.5Edge Gateways443
11.5.1View Edge Gateways444
11.5.2Create Edge Gateways445
11.5.3Edit Edge Gateways445
11.5.4Delete Edge Gateways446
11.6Manage NAT Rules447
11.6.1View NAT Rules447
11.6.2Create NAT Rules448
11.6.3Edit NAT Rule449
11.6.4Delete NAT Rules450
11.7Manage Organization Networks450
11.7.1View Organization Networks451
11.7.2Create Organization Network452
11.7.3Edit Organization Network453
11.7.4Delete Organization Network454
11.8Manage VPN Service454
11.8.1View VPN Tunnels455
11.8.2Create VPN Tunnel456
11.8.3Delete VPN Tunnel457
11.9Resource Pools457
11.9.1View Resource Pool458
11.9.2Create Resource Pool460
11.9.3Edit Resource Pool462
11.9.4Delete vCloud Director Resource Pool464
11.9.5Resource Pool Data Stores464
11.9.6Resource Pool Billing Statistics465
11.10vCloud Director Firewall Rules467
11.10.1Create Firewall Rules468
11.10.2Edit Firewall Rules469
11.10.3Delete Firewall Rules470
12DNS471
12.1DNS Setup471
12.1.1Edit DNS Domain472
12.2DNS Zones472
12.2.1Create DNS Zone472
12.2.2Edit DNS Zone477
12.2.3Delete DNS Zone478
12.2.4User DNS Zones478
12.2.5Set End-User Access to DNS Service478
12.2.6View User DNS Zones479
12.2.7Edit User DNS Zones479
12.2.8Delete User DNS Zones479
13Blueprints480
14SolidFire Integration481
14.1SolidFire Management481
14.2SolidFire Quality of Service482
15Integrated Storage484
15.1Known Limitations and Restrictions484
16Service Add-ons486
16.1Create service add-on487
16.2Add events to service add-on488
16.3Service add-on store488
16.4Pricing and Access control489
16.5Permissions489
16.6Assign service add-on to VS490
16.7Manage Service Add-ons490
16.7.1View service add-ons491
16.7.2Create service add-on492
16.7.3On add and On remove events management493
16.7.4Edit service add-on494
16.7.5View service add-on applied to VSs495
16.7.6Delete service add-on495
16.8Manage Service Add-on Store496
16.8.1Service add-on group management496
17Templates498
17.1What templates are499
17.2Windows templates499
17.3Types of templates500
17.4Where templates are stored501
17.5Template store502
17.6My template group502
17.7Configuration Options503
17.8Installation and update504
17.9Billing504
17.10Manage Templates505
17.10.1View Template Details505
17.10.2Edit Template Details506
17.10.3Delete System Templates506
17.10.4Install/Update Templates507
17.10.5Create Custom Templates509
17.10.6Edit Custom Templates509
17.10.7Delete Custom Templates510
17.10.8Make Templates Public510
17.10.9Allow Users to Make Templates Public510
17.10.10Manage Template Recipes510
17.10.11Manage Template Recipe Custom Variables511
17.11Template Software Licenses512
17.11.1KMS Licensing513
17.11.2MAK Licensing513
17.12Template Store514
17.12.1Template group management514
17.12.2Add ISO to template store516
17.12.3Add OVA to template store516
17.13My Template Groups516
18ISOs520
18.1View ISOs520
18.2Boot from ISO521
18.2.1Share the location where the ISOs are stored.521
18.2.2Enable ISO Permissions522
18.2.3Upload ISO(s) into the cloud.523
18.2.4Make ISO(s) public.523
18.2.5Boot virtual or smart server from ISO.524
18.3Upload ISOs524
18.3.1Upload ISO(s) into the Cloud524
18.3.2Make ISO(s) Public525
18.4Edit ISOs525
18.5Delete ISOs526
19OVAs527
19.1Limitations and prerequisites527
19.2Converting OVF to OVA528
19.3View OVAs528
19.4Upload OVAs529
19.5Edit OVAs531
19.6Using OVA on Cloudboot Backup Server531
19.7Delete OVAs532
20Recipes534
20.1vCloud Director VS Recipes534
20.2Recipe use534
20.3Recipe variables535
20.4View List of All Recipes536
20.5View Recipe Details537
20.6View the List of Assigned Servers538
20.7Create Recipe538
20.7.1Create recipe538
20.7.2Create steps539
20.8Assign Recipe to Multiple Servers541
20.9Edit Recipe541
20.10Edit Recipe Step542
20.11Delete Recipe543
20.12Recipe Permissions544
20.13Recipe Groups546
20.14Recipe Use Examples547
20.14.1Recipe 1547
20.14.2Recipe 2549
20.14.3Recipe 3550
20.14.4Recipe 4550
20.15Control Panel Recipes Settings.551
21CDN554
21.1CDN Setup Wizard556
21.2CDN Edge Servers557
21.2.1Create CDN Edge Server558
21.2.2View CDN Edge Server Details560
21.2.3Edit CDN Edge Server562
21.2.4Set VIP Status for Edge Server562
21.2.5Delete CDN Edge Server562
21.2.6CDN Edge Server Network Interface Usage563
21.3CDN Storage Servers563
21.3.1View CDN Storage Server Details563
21.3.2Create CDN Storage Server564
21.3.3Edit CDN Storage Server566
21.3.4Set VIP Status for Storage Server566
21.3.5Delete CDN Storage Server566
21.4CDN Resources567
21.4.1View CDN Resources568
21.4.2View CDN Resource Details568
21.4.3Create HTTP CDN Resource575
21.4.4Create Video On Demand CDN Resource581
21.4.5Create Live Streaming CDN Resource584
21.4.6Edit CDN Resource587
21.4.7Stream Statistics587
21.4.8Raw Logs588
21.4.9View CDN Advanced Reporting589
21.4.10Prefetch Content589
21.4.11Purge Content590
21.4.12Billing Statistics590
21.4.13HTTP Caching Rules.591
21.4.14Token Authentication606
21.5CDN Edge Groups611
21.5.1View CDN Edge Group Details612
21.5.2Create CDN Edge Group612
21.5.3Edit CDN Edge Group613
21.5.4Delete CDN Edge Group613
21.5.5Assign/Remove CDN Edge Group Locations613
21.6CDN Upload Instructions613
21.6.2HTTP Push CDN Resource614
21.6.4VOD Pull CDN Resource614
21.6.5VOD Push CDN Resource615
21.6.7Live Streaming CDN Resource616
21.7CDN SSL Certificates620
21.7.1View Custom SNI SSL Certificates621
21.7.2Add Custom SNI SSL Certificates622
21.7.3Edit Custom SNI SSL Certificate622
21.7.4Delete SNI SSL Certificate623
21.8CDN Accelerator623
21.8.1View Accelerators624
21.8.2Create Accelerator627
21.8.3Manage Accelerators630
21.8.4Accelerator Disks635
21.8.5Accelerator Networks637
21.8.6Accelerator IP Addresses641
21.8.7Accelerator Statistics643
21.9CDN Reporting644
21.9.1CDN Overview Report645
21.9.2Cache Statistics Report646
21.9.3Top Files Report647
21.9.4Top Referrers Report647
21.9.5Status Codes Report648
21.9.6Bandwidth Statistics Report649
22AWS651
22.1Enable/disable AWS651
22.2Manage EC2 Instances652
22.2.1View the list of EC2 Instances653
22.2.2View EC2 Instances details654
22.2.3Edit EC2 Instance655
22.2.4Delete EC2 Instance655
22.3Launch New EC2655
23Users659
23.1User Accounts659
23.1.1vCloud Director Users659
23.1.2View Users660
23.1.3View User Account Details660
23.1.4User Payments665
23.1.5User Billing Statistics665
23.1.6User Whitelist IPs667
23.1.7Log in as User667
23.1.8Create User667
23.1.9User Additional Fields669
23.1.10Edit User670
23.1.11Add SSH Key672
23.1.12Delete User672
23.1.13Suspend and Activate Users673
23.1.14View User Backups673
23.1.15Unlock User674
23.2Drop Session674
23.2.1Drop Own Sessions674
23.3Users with Config Problems675
24Groups676
24.1vCloud Director Organizations676
24.2View User Group676
24.3Create User Group677
24.3.1Create User Group677
24.3.2Create Organization678
24.4Edit User Group679
24.4.1Edit User Group680
24.4.2Edit Organization680
24.5Assign New User to Group681
24.6Change User Group for User681
24.7Delete User Group681
25Roles682
25.1Create New Role682
25.2Edit Role683
25.3Delete Role683
25.4Clone Role683
26Restrictions Sets685
26.1Configure Reseller Role686
26.1.1Create a reseller role686
26.1.2Create a restrictions set687
26.1.3Create billing plan687
26.1.4Create other roles required by the reseller687
26.1.5Create a user group687
26.1.6Create reseller account687
26.2Create Restrictions Sets688
26.3List of Restrictions Resources688
26.4Edit Restrictions Sets695
26.5Delete Restrictions Sets695
27Billing Plans696
27.1Master Bucket Billing696
27.2Master Template Billing697
27.3Create User Billing Plan698
27.4Set User Billing Plan Prices And Resource Limits698
27.4.1Add limits for Instance packages709
27.4.2Modify/delete Limits for Instance packages710
27.5User Billing Plan Configuration Workflow710
27.6Company Billing Plans711
27.6.1Create company billing plan712
27.6.2Set company billing plan prices and resource limits713
27.6.3Assign company billing plan to user group (organization)720
27.6.4Edit company billing plan720
27.6.5Delete company billing plan721
27.6.6Billing statistics722
27.7Billing Calculation723
27.7.1Hourly and monthly resource limit types723
27.7.2Calculation for the missing period724
27.7.3IP addresses725
27.7.4Port Speed727
27.7.5Guaranteed minIOPS728
27.7.6Disk size729
27.7.7CPU731
27.7.8CPU shares732
27.7.9CPU Priority732
27.7.10CPU Units733
27.7.11Instance packages734
27.7.12DRaaS735
27.8Assign Users to Billing Plan735
27.9Edit User Billing Plan736
27.10Copy User Billing Plan736
27.11Delete User Billing Plan736
27.12Create and Manage Payments737
27.12.1View user payments737
27.12.2View company payments738
27.12.3Create payment739
27.12.4Edit payment739
27.12.5Delete payment740
28Instance Packages741
28.1View Instance Packages741
28.2Set up Instance Packages for Cloud742
28.2.1Enable the instance packages permission742
28.2.2Add instance packages to your cloud743
28.2.3Add the instance package(s) to the users' billing plan744
28.2.4Interface configuration745
28.2.5Build Virtual Server Using Instance packages746
28.3Billing for Instance Packages747
28.3.1Add instance packages to your cloud747
28.3.2Add instance packages to the billing plan748
28.4Edit Instance Package750
28.5Delete Instance Package751
29Compute Resource Settings752
29.1Compute Resource Settings.752
29.1.1View Compute Resource Details752
29.1.2Create Compute Resource755
29.1.3Create CloudBoot Compute Resource756
29.1.4Manage CloudBoot Compute Resource Devices762
29.1.5Edit Xen/KVM Compute Resource764
29.1.6Edit CloudBoot Compute Resource765
29.1.7Edit Baremetal CloudBoot Compute Resource767
29.1.8Edit Smart CloudBoot Compute Resource768
29.1.9Delete Compute Resource769
29.1.10Manage Compute Resource Data Stores770
29.1.11Manage Compute Resource Networks770
29.1.12Maintenance Mode for Xen/KVM Compute Resources771
29.1.13Compute Resource Extended CPU Flags773
29.2Compute Zones Settings776
29.2.1View Compute Zones776
29.2.2View Compute Zone Details777
29.2.3Create Compute Zone778
29.2.4Add Compute Resource to Compute Zone783
29.2.5Remove Compute Resource from Compute Zone783
29.2.6Delete Compute Zone784
29.2.7Edit Compute Zone784
29.2.8Manage Compute Zone Data Stores787
29.2.9Manage Compute Zone Networks787
29.2.10Manage Compute Zone Recipes788
29.2.11Manage Compute Zone Backup Servers789
29.2.12Manage Extended CPU Flags for Compute Zone791
30Storage Settings795
30.1Data Store Zones Settings795
30.1.1View Data Store Zones795
30.1.2View Data Store Zone Details796
30.1.3Create Data Store Zone796
30.1.4Create Solidfire Data Store Zone797
30.1.5Edit Data Store Zone797
30.1.6Attach Data Stores to Data Store Zone798
30.1.7Remove Data Stores From Data Store Zone798
30.1.8Delete Data Store Zone798
30.2Data Stores Settings799
30.2.1View Data Stores800
30.2.2Create LVM Data Store800
30.2.3Create SolidFire Data Store801
30.2.4Edit Data Store803
30.2.5Delete Data Store804
30.3Disks Settings804
30.3.1View Disks805
30.3.2Enable Disk Auto-backups806
30.3.3Backup Disks806
30.3.4Migrate Disks.806
30.3.5View Disk IOPS807
30.3.6Schedule Disks for Backups807
30.3.7Delete Disks807
30.4vCloud Director Storage Policies808
30.4.1View Storage Policies809
30.4.2Manage Data Store Zone809
31Location Groups811
31.1Add Location Groups811
31.2View Location Groups812
31.3Edit Location Groups812
31.4Assign Zones to Location Groups813
31.5Unassign Zones from Location Groups813
32Backup Settings815
32.1Auto-backup Presets Settings815
32.2Backup Servers Settings816
32.2.1Basic Backup Scheme816
32.2.2Advanced Backup Scheme816
32.2.3CloudBoot Backup Scheme818
32.2.4Create Backup Server818
32.2.5Create CloudBoot Backup Server819
32.2.6Edit Backup Server822
32.2.7Backup Server Balancing823
32.2.8Manage Backups For Backup Server824
32.2.9Delete Backup Server824
32.3Backup Server Zones Settings825
32.3.1View Backup Server Zone Details825
32.3.2Create Backup Server Zone825
32.3.3Edit Backup Server Zone826
32.3.4Add Backup Server to Backup Server Zone826
32.3.5Remove Backup Server From Backup Server Zone826
32.3.6Delete Backup Server Zone826
32.4Schedules Settings827
32.4.1View Schedules827
32.4.2Edit Schedules828
32.4.3Delete Schedules828
33Network Settings829
33.1Networks Settings829
33.1.1View networks829
33.1.2Create Network829
33.1.3Edit Network830
33.1.4Add IP Address to Network831
33.1.5Assign IP Address to User831
33.1.6Unassign IP Address from User832
33.1.7Delete IP Address from Network832
33.1.8Delete Network832
33.1.9View Network Details833
33.2Network Zones Settings833
33.2.1Create Network Zone834
33.2.2View Network Zone834
33.2.3View Network Zone Details835
33.2.4Edit Network Zone835
33.2.5Add Networks to Network Zone835
33.2.6Remove Networks From Network Zone836
33.2.7Delete Network Zone836
33.3Firewalls836
33.3.1View/Edit/Delete Firewalls837
33.3.2Create firewall837
33.4Resolvers Settings837
33.4.1View Resolvers838
33.4.2Create Resolver838
33.4.3Edit Resolver838
33.4.4Delete Resolver838
33.5vCloud Director vApp Networks839
33.5.1View vApp Networks839
33.5.2Create vApp Network840
33.5.3Delete vApp Network841
33.6vCloud Director External Networks841
33.6.1View External Networks Imported as Network Zones841
33.6.2View External Networks Imported as Networks842
34OnApp Configuration843
34.1Authentication843
34.1.1OAuth843
34.1.2SAML Authentication846
34.2License853
34.3Configuration Settings854
34.3.1Edit System Configuration854
34.3.2Edit Backups/Templates Configuration861
34.3.3Edit Interface Configuration864
34.3.4Edit Defaults Configuration865
34.4Control Panel Recipes Settings866
35Notifications Setup869
35.1Notifications after update to OnApp 5.2870
35.2Enable notifications for your cloud871
35.3Configure gateways871
35.4Add notification templates873
35.5Add custom events873
35.6Create recipients lists874
35.6.1External Recipients874
35.6.2Recipients Lists875
35.7Set up subscriptions875
35.8Check if the notifications were delivered877
35.9View internal notifications in CP878
35.10Manage Notifications878
35.10.1Manage Gateways880
35.10.2Manage Notification Templates881
35.10.3Manage External Recipients882
35.10.4Manage Recipients Lists883
35.10.5Delete Subscriptions884
35.10.6Delete events, deliveries or notifications for a particular period884
35.10.7Disable Notifications884
36Permissions List885
36.1List of all OnApp Permissions885
36.1.1Accelerators889
36.1.2Activity logs890
36.1.3Application Servers890
36.1.4Autoscaling Configuration891
36.1.5Autoscaling monitors891
36.1.6Auto-backup presets892
36.1.7Availability892
36.1.8Backup server zones892
36.1.9Backup servers893
36.1.10Backups893
36.1.11Base resources894
36.1.12Billing plans894
36.1.13Blueprints894
36.1.14Blueprint templates895
36.1.15Blueprint template groups895
36.1.16Blueprint template group relations895
36.1.17Catalogs896
36.1.18CDN locations896
36.1.20CDN reports897
36.1.21CDN resources897
36.1.22CDN SSL Certificates897
36.1.23CDN usage statistics898
36.1.24CloudBoot898
36.1.25Company Billing Plans898
36.1.26Compute resources898
36.1.27Compute Resource Devices899
36.1.28Compute zones899
36.1.29Container Servers900
36.1.30Control panel901
36.1.31Currencies901
36.1.32Dashboard902
36.1.33Data stores902
36.1.34Data store joins902
36.1.35Data store zones903
36.1.36Disks903
36.1.37DNS Zone's Records903
36.1.38DNS Zones904
36.1.39DRaaS904
36.1.40Edge Gateways904
36.1.41Edge groups905
36.1.42Edge servers905
36.1.43Federation906
36.1.44Federation failed action906
36.1.45Firewall rules907
36.1.46Global search907
36.1.47Groups907
36.1.48Help907
36.1.49Http Caching Rules908
36.1.50iFrame908
36.1.51Instance packages908
36.1.52Internationalization908
36.1.53IO Statistics909
36.1.54IP addresses909
36.1.55ISOs909
36.1.56Last access log910
36.1.57Load balancers910
36.1.58Load balancing cluster s910
36.1.59Location Groups911
36.1.60Log items911
36.1.61Media912
36.1.62Messaging: Deliveries912
36.1.63Messaging: Events912
36.1.64Messaging: External Recipients912
36.1.65Messaging: Gateways913
36.1.66Messaging: Notifications913
36.1.67Messaging: Notification Templates913
36.1.68Messaging: Recipients Lists913
36.1.69Messaging: Subscriptions914
36.1.70Monthly user billing statistics914
36.1.71Monthly user group billing statistics914
36.1.72Nameservers915
36.1.73Networks915
36.1.74Network zones915
36.1.75OnApp Storage916
36.1.76OAuth Providers916
36.1.77Orchestration Models916
36.1.78Org Networks916
36.1.79OVAs917
36.1.80Payments917
36.1.81Permissions918
36.1.82Provider Resource Pools918
36.1.83Recipes918
36.1.84Recipe Groups919
36.1.85Recipe Group Relations919
36.1.86Relation group templates919
36.1.87Resource Diff920
36.1.88Resource limits920
36.1.89Resource Pool921
36.1.90Resource Pool Statistics921
36.1.91Restrictions Resources921
36.1.92Restrictions Sets921
36.1.93Roles922
36.1.94SAML Identity Providers922
36.1.95Schedule logs922
36.1.96Schedules923
36.1.97Service Add-ons923
36.1.99Service Add-on Groups924
36.1.100Service Catalog924
36.1.101Sessions924
36.1.102Settings925
36.1.103Smart Servers925
36.1.104SSH keys925
36.1.105Storage Servers925
36.1.106Sysadmin tools926
36.1.107Templates926
36.1.108Template groups928
36.1.109Themes928
36.1.110Transactions928
36.1.111Tunnels929
36.1.113Users929
36.1.114User additional fields931
36.1.115User groups931
36.1.116VApps931
36.1.117VApp Networks932
36.1.118VApp Templates932
36.1.119vCloud Nat Rules932
36.1.120vCloud Permissions933
36.1.121Virtual Servers933
36.1.122Virtual Server Snapshots935
36.1.123Virtual Machine Statistics935
36.1.124Virtual Server's IP Addresses936
36.1.125White IPs936
36.1.126Zabbix Server936
36.2List of Default Permissions for Admin Role937
36.2.1DNS Zone's Records939
36.2.2Messaging: Deliveries940
36.2.3Messaging: Events940
36.2.4Messaging: External Recipients941
36.2.5Messaging: Gateways941
36.2.6Messaging: Notifications941
36.2.7Messaging: Notification Templates941
36.2.8Messaging: Recipients Lists941
36.2.9Messaging: Subscriptions941
36.3List of Default Permissions for User Role944
36.3.1CDN reports944
36.3.2DNS Zone's Records946
37Tools951
37.1Logs951
37.1.1View and Manage Logs951
37.1.2Change Tracking952
37.2Sysadmin953
37.2.1Sysadmin Tools954
37.2.2Services956
37.2.3Application errors956
37.2.4Activity Log956
37.2.5Zabbix Setup957
37.2.6Control Panel Maintenance959
37.3Alerts960
37.4Failover Processes961
38Statistics962
38.1Usage Trends962
38.1.1View Usage Trends963
38.1.2Usage Trends Statistics Measurement964
38.2Cloud Usage965
38.3CDN Usage966
38.4Top IOPS disks967
39Localization and Customization968
39.1Languages968
39.1.1Add Custom Languages968
39.1.2Enable Custom Language for Specific User969
39.2Currencies969
39.2.1Create currency969
39.2.2Edit Currency970
39.2.3Delete Currency971
39.3Localization and Customization Search972
39.4Look & Feel972
39.4.1Look & Feel menu972
39.4.3Custom CSS rules974
39.5iFrame Configuration975
40Miscellaneous977
40.1Reset Control Panel Administrator Password977
40.2Add IPs in Windows Environment977
40.3Create New Linux/Windows Templates978
40.4Transaction Server978
40.5Failover Configuration979
40.5.1How failover works979
40.5.2Failover settings980
40.5.3Failover algorithm981
40.5.4Failover Logs982
40.6Calculate Billing Statistics for the Missing Period983
40.7Advanced Configuration Settings983
40.7.1Daemon workflow988
40.7.2SNMP Statistics988
40.7.3VMware Statistics988
40.7.4SolidFire Statistics989
40.8Track Daemon Process Activity989
40.9Virtual Server Provisioning990
40.10Add Google Map API Key991
41High Availability Control Panel992
41.1Manage Hosts993
41.1.1View Hosts993
41.1.2Add a Host994
41.1.3Edit a Host994
41.1.4Delete a Host994
41.2Manage Communication995
41.2.1View Communication Ring995
41.2.2Add Communication Ring996
41.2.3Edit Communication Ring996
41.2.4Delete Communication Ring997
41.3Manage Clusters997
41.3.1View Clusters997
41.3.2Add Cluster998
41.3.3Add Node to Cluster999
41.3.4Deactivate/Activate Cluster1000
41.4Disable High Availability1000
42Disaster Recovery as a Service (DRaaS)1001
42.1Prerequisites1001
42.2Enable DRaaS for Virtual Server1002
42.3Disable DRaaS1003
42.4DRaaS billing1003
43SSL Certificates1005
43.1Prerequisites1005
43.2View SSL certificates1005
43.3Add SSL certificate1006
44Help1007
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.
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:
OnApp 5.3
Added
Added CDN Overview Report, Cache Statistics Report , Status Codes Report and Bandwidth Statistics Report sections
Added Zone Types section
Added Service Add-ons chapter
Added Virtual Server Service Add-ons section
Added vCloud Director VS Service Add-ons section
Added Virtual Server as a Gateway section
Added Service Catalog section
Updated
Updated List of all OnApp Permissions section: added See Overview Report, Any action related to service catalog and Allow use virtual server as gateway permissions, added service add-on and resource diff related permissions
Updated List of Default Permissions for Admin Role section: added Resource Diff, Service Catalog, Service Add-ons and Service Add-on Groups permissions
Updated List of Default Permissions for User Role section: added Any action related to service catalog permission
Updated Edit Data Store section: added info about Auto Healing parameter for integrated data stores
Updated Data Stores Settings, Data Store Zones Settings, Compute Zones Settings, Compute Resource Settings, Backup Server Zones Settings and Network Zone Settings sections: added information on zone types
Updated Set User Billing Plan Prices And Resource Limits section: added info about limits for service add-on groups
Updated Virtual Servers and View Virtual Server Details sections: added info about assigning of service add-ons to VS
Updated vCloud Director Virtual Servers and Manage vCloud Director VSs sections: added info about assigning of service add-ons to VS
Updated Recipes section: added prerequsites for vCloud Director VS recipes
Updated Upload OVAs section: added info about the Unlock button
Updated View User Group section: added ability to view Service Addons Stats for vCloud Director VSs
Updated View CDN Advanced Reporting section: removed CDN advanced reporting statistics
Updated Create and Manage vApps section: added information on the new recompose vApp process
Updated Logs section: added information about change tracking in logs
Updated Create DNS Zone and Edit DNS Zone sections: added possibility to create rDNS zone and PTR records
Updated Create CloudBoot Compute Resource section: added CloudBoot KVM CentOS 7 entry for CloudBoot compute resource wizard
Updated Create and Manage Catalogs and vCloud Director Supported Functionality sections: added possibility to upload files to media library
Updated Dashboard section: added information about vCloud Director charts and Integrated Storage usage calculation
Updated View Container Server Details section: added information about login credentials
Index
A B C D E F G H I J K L M N O P R S T U V W X Y Z
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
databases
email accounts
services
system application
view
API and integrations
API key
architecture
assets
authentication
OAuth
SAML Authentication
Id Provider
auto-backup presets
AWS
B
background task daemon
backup servers
cloud boot backup server
create
delete
edit
manage backups
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
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 reporting
top files report
top referrers report
overview report
cache statistics report
status codes report
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 Director
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
manage Compute zone backup servers
container server
control panel
CPU cores
CPU flags
CPU shares
CPU sockets
CPU threads
CPU topology
CPU units
configuration
backups/templates
defaults
interface
system
customization
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
E
error collector
F
failover algorithm
failover processes
firewalls
delete
edit
view
G
H
hardware & software requirements
I
iFrame
instance packages
delete
edit
set up instance packages
view
integrated storage
ISO
add
delete
edit
view
make ISO public
ISO Virtual Servers
create
manage
networks
disks
statistics
J
K
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
M
maintenance mode
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
notifications
O
OnApp Dashboard
OVAs
view OVA
upload OVA
edit OVA
delete OVA
OVA virtual servers
P
payment
power cycle command
publishing rules
Q
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
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
vmware virtual server
service add-ons
service add-on store
virtual server service add-ons
vCloud Director service add-ons
SNMP stats runner
snmptrap
SolidFire
SSL certificate
statistics
CDN usage
Cloud usage
usage trends
sysadmin
T
templates
view
edit
delete
custom
make public
my template groups
template manager
template store
template recipes
template software licenses
transactions/logs
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
V
vCloud Director
catalog
orchestration model
vApp
vApp template
edge gateway
NAT rules
organization network
VPN service
resource pool
firewall rules
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
VS as a gateway
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
W
X
Y
yubikey
Z
Zabbix
zombie data stores
zombie disks
zombie domains
zombie transactions
zombie virtual servers
zone types
What's New in OnApp Cloud 5.3
The OnApp Cloud 5.3 release contains the following changes and new features:
Zone Types
OnApp 5.3 reinforces the role of the types for compute, data store, network and backup server zones. Now all of the compute, data store, network and backup server zones have one of the following types: Virtual, Baremetal, Smart or VPC. All individual resources (compute resources, data stores, backup servers and networks) inherit the type of the zone with which they are associated. All vCloud Director related resources have the VPC type.
Service Add-ons
Implemented Service Add-ons functionality, which allows you to offer to your customers additional services on top of your current IaaS Virtual Server offering. Service Add-on functionality provides the ability to add services to a virtual server.
CDN reporting
CDN reportingfunctionality allows you to study and review the in-depth analysis on your own CDN resources by viewing different reports. Added CDN Overview Report, Cache Statistics Report , Status Codes Report and Bandwidth Statistics Report.Virtual Server as a Gateway
Now you can set up your virtual server configuration so that it can function as a gateway for the network interface.
Integrated Storage Auto Healing
OnApp introduces auto healing - an auto-scheduling option to repair degraded vdisks. This functionality can be used only in case there are no serious issues with Integrated Storage.
Transaction change tracking
If the size of certain resources is changed, the logs will contain the information about both the current and the previous size of the resource.
Service Catalog
The service catalog page gives you quick access to the the creation wizard of most common OnApp entities.
rDNS zone and PTR records creation
Now you can create rDNS zone. Reverse DNS resolution (rDNS) is the determination of a domain name associated with an IP address via querying DNS.
vCloud Director improvements
The following improvements of vCloud Director functionality are implemented:
improved vApp recompose process
added possibility to upload files to media library
Also improved OnApp and vCenter integration networking functionality; removed Vyatta, customer networks, customer VLANs and IP address pools.
CloudBoot KVM CentOS 7 support
Added CloudBoot KVM CentOS 7 entry for CloudBoot compute resource wizard.
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.
code block
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/rc.local
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.
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.
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:
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 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
Can be of Virtual, Baremetal, Smart and VPC types. The VPC type indicates the vCloud Director compute resources
Can be associated with the data stores, networks and backup servers of the same type
OnApp Cloud supports the following Compute resource virtualization platforms:
Xen - OnApp supports Xen 3 and Xen 4
KVM
VMware
vCloud Director
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. Baremetal Compute resources can not have more than one baremetal server located on it.
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.
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. Networks in OnApp can be of Virtual, Baremetal, Smart and VPC types and can be associated with compute resources and compute zones of the same type. The VPC type indicates the vCloud Director networks.
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.
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.
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.
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. At this stage OnApp introduces high availability for the following components:
UI
Background services
Cloudboot
Load Balancer
Redis
Message Queue
Database
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.
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 5.2 API Guide.
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.
Server Requirements
Compute resource servers
x64 platform with AMD-V/VT-x hardware virtualization support enabled
Quad Core 2Ghz+ CPU
8GB+ RAM
3x Gig network interface cards (4 recommended)
30 GB of free disk space (SSD Recommended)
Control Panel server
Dual or Quad Core 2Ghz+ CPU
8GB RAM (16GB+ recommended)
100GB Raid 1
2x Gig network interface cards
Additional Server Recommendations
Backup server
1GB RAM
2TB+ NAS (alternatively, a large hard disk can be used on the Control Panel server for backups)
Storage Requirements
Integrated Storage Platform
Local Storage Only
Enterprise SAN
Any number of integrated storage drives can be grouped together across any Compute resource
SSD drives recommended for best performance
at least 1 dedicated NIC assigned per Compute resource for the SAN
multiple NICs bonded or 10GBit/s ethernet recommended
Minimum 1 dedicated partition in each Compute resource
separate disk from the primary OS drive recommended
Centralised Block Storage SAN (iSCSI, ATA over Ethernet or Fibre Channel) accessible to every Compute resource
at least 1 dedicated 1GBit/s NIC assigned per Compute resource for the SAN
multiple NICs bonded or 10GBit/s ethernet recommended
vCloud Director Integration Implementation Details
OnApp has developed a new integration between the OnApp Infrastructure-as-a-Service platform and VMware vCloud Director. Starting with OnApp 4.2 you can import multiple vCDs into OnApp.
The new integration enables existing vCloud Director installations to use the OnApp CP as their front-end UI. With the new integration, OnApp:
Provide new UI options for vCloud Director users (VS monitoring)
Expand vCloud Director capabilities with integrated billing plans
OnApp CP and the vCloud Director are synchronized on a daily basis to update the data.
Control Panel with vCloud Director integration should have at least 3 onappd instances (vcloud L1, vcloud L2 and another one).
Below you can find the compatibility matrix for vCloud Director and OnApp versions:
Versions
vCD 5.6
vCD 8.0
vCD 8.1.0
OnApp v5.3
OnApp v5.2
OnApp v5.1
OnApp v5.0
OnApp v4.3
OnApp v4.2
OnApp v4.1
OnApp v4.0
OnApp v3.5
Starting from OnApp 5.1 version, vCD 5.6 version is not officially supported by OnApp.
Implementation
OnApp and vCloud Director connection is supported with RabbitMQ. To integrate OnApp with the vCloud Director, you must specify RabbitMQ credentials both on the OnApp CP and the vCloud Director (in beta version, RabbitMQ will be delivered with the OnApp RPMs. RabbitMQ will be synchronizing OnApp and the vCloud Director: it will get the list of actions happen in the vCD and report it to the CP).
After that, add the vCloud Director instance as an OnApp compute resource (vcloud type) and specify the vCloud Director URL and vCloud Director system admin credentials. After that, all the existing vCloud Director resources will be shown in OnApp.
At the moment, importing a vCloud Director into OnApp includes the following components:
vCloud Director instance (as an OnApp compute resource)
vApps
VSs
Catalogues
Organizations (added as OnApp user groups)
Networks (organization vDC networks, external networks and vApp networks)
Storage policies
Users and their roles (except system administrators)
The import of other vCloud Director components into OnApp is scheduled for the following releases.
vCloud Director instanceVSs
Virtual servers, built on a guest operating system, can be used to install and run software compatible with that operation system.
VSs between Vcloud Director and Vcenter are mapped using moref ID.
vApps
VApp consists of one or more virtual servers that communicate over a network and use resources and services in a deployed environment.
vApp templates
A vApp template is a virtual server image that is loaded with an operating system, applications, and data. VApp templates are added to catalogs.
Catalogs
A catalog is a container for vApp templates and media files. You can view the list of catalogs at OnApp Control Panel > Catalogs menu of your OnApp Cloud.
Edge Gateways
Edge Gateway is a virtual router for organization vDC (virtualDataCenter) networks. You can view the list of edge gateways (together with firewall rules, NAT rules and VPN service) at OnApp Control Panel > Edge Gateways menu of your OnApp Cloud.
vCloud Director Resource Pools
Resource pool is an allocation model which determines how and when the provider virtual data center compute and memory resources are committed to the organization virtual data center. There are three types of resource pools:
Allocation Pool
Pay-As-You-Go
Reservation Pool
Orchestration Models
Orchestration models enable you to provide your customers with a ready environment which they can use to deploy virtual servers.
Organizations
vCD Organizations are displayed in OnApp as user groups.
Company Billing Plans
Company billing plan is a set of limits and prices for the resources used by vCloud Director organizations imported as user groups into OnApp.
Networks
External, organization and vApp network types, as well as network pools, are imported into OnApp as networks and network zones of the VPC type. Below are the details on how different vCD networks are imported:
Network Pools
Each network pool is imported into OnApp as two network zones:
Isolated network zone - this zone contains isolated organization and vApp networks imported from vCloud Director.
Routed network zone - this zone contains routed organization and vApp networks imported from vCloud Director.
External Networks
External networks are imported both as a network zone and as a network within that zone. Importing external networks as network zones enables administrators to configure billing for external network usage.
Organization Networks
Organization networks are imported into OnApp as Org networks and are associated with a network zone. Depending on the type of the organization network, it will be associated with a certain zone.
Routed organization networks are associated with their network pool imported as a routed network zone.
Isolated organization networks are associated with their network pool imported as an isolated network zone.
Direct organization networks are associated with their external network imported as a network zone.
vApp Networks
vApp networks are imported into OnApp as networks and are associated with a network zone. Depending on the type of the vApp network, it will be associated with a certain zone.
Routed vApp networks are associated with their network pool imported as a routed network zone.
Isolated vApp networks are associated with their network pool imported as an isolated network zone.
Direct vApp networks are associated with their parent organization network and are assigned to the network zone to which their parent networks are assigned. So depending on the parent network, they can be imported to Isolated, Routed, or External network zone.
Storage policies
Provider storage policies are imported to OnApp as data store zones of the VPC type. Storage policies appear in the OnApp UI as data stores. You can select them during vApp creation. To view storage policies and the list of disks and VSs associated with them, go to the Settings > Data Stores menu.
Users
Users are imported with their existing roles. OnApp imports the username and creates that user in OnApp. From that point forward, changes to the user should be made inside OnApp. OnApp will generate a random password for each imported user. The user will be emailed with the instructions to change this password to be able to log into OnApp. After the log in, user will be asked to confirm the vCloud Director password.
vCloud Director Supported Functionality
Here is the list of the current vCloud Director functions you can perform by means of OnApp Control Panel:
Functionality
Supported Actions
Version
vApps
view
4.0 and up
compose
4.1 and up
create
4.0 and up
start
4.0 and up
stop
4.0 and up
delete
4.0 and up
edit
4.0 and up
recompose
4.0 and up
add vApp to catalog
4.1 and up
add to catalog
4.0 and up
Virtual Servers
view
4.0 and up
shutdown
4.0 and up
reboot
4.0 and up
edit (label, RAM,CPU)
4.0 and up
set SSH keys
4.2 and up
view VS console
4.0 and up
start
4.0 and up
delete
4.1 and up
insert/eject Media (ISO)
4.2 and up
install VMWare Tools
4.3 and up
VS console
MKS
4.0 and up
Vmrc
4.0 and up
VS Snapshots
view
4.0 and up
create
4.0 and up
restore
4.1 and up
build
4.1 and up
delete
4.1 and up
VS monitoring
view CPU statistics
4.0 and up
view networking statistics
4.0 and up
view disk statistics
4.0 and up
VS Network Interface
view
4.0 and up
add
4.0 and up
edit
4.1 and up
delete
4.0 and up
VS Guest Customization
view
4.1 and up
edit
4.1 and up
VS Recipes
view
4.2 and up
assign
4.2 and up
remove
4.2 and up
VS Recipe Custom Variables
view
4.2 and up
create
4.2 and up
edit
4.2 and up
delete
4.2 and up
vApp Templates
view
4.2 and up
create
4.2 and up
delete
4.2 and up
Orchestration Models
view
4.2 and up
create
4.2 and up
deploy
4.2 and up
delete
4.2 and up
Catalogs
view
4.0 and up
create
4.2 and up
delete
4.2 and up
Media library
view
4.2 and up
upload file
5.3
Storage policies
view / select during vApp creation
4.0 and up
Organizations
view
4.0 and up
create
4.2 and up
edit
4.2 and up
delete
4.2 and up
Disks
view
4.0 and up
add
4.0 and up
edit
4.0 and up
delete
4.0 and up
Users
view
4.0 and up
create
4.2 and up
edit
4.2 and up
delete
4.2 and up
vApp Networks
view
4.0 and up
add
4.1 and up
Org Networks
view
4.2 and up
create
4.3 and up
edit
4.2 and up
delete
4.2 and up
Firewall Rules
view
4.0 and up
add
4.0 and up
edit
4.1 and up
delete
4.0 and up
Edge Gateways
view
4.0 and up
add
4.1 and up
edit
4.1 and up
delete
4.1 and up
NAT rules
view
4.1 and up
create
4.1 and up
edit
5.2 and up
delete
4.1 and up
VPN tunnels
view
4.1 and up
create
4.1 and up
delete
4.1 and up
Resource Pools
view
4.2 and up
create
4.3 and up
edit
4.3 and up
delete
4.2 and up
Resource Pool Data Stores
view
4.3 and up
create
4.3 and up
edit
4.3 and up
delete
4.3 and up
Resource pool billing statistics
view
4.2 and up
Company billing plans
view
4.2 and up
create
4.2 and up
edit
4.2 and up
delete
4.2 and up
Payments
view
4.2 and up
create
4.2 and up
edit
4.2 and up
delete
4.2 and up
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.
Network Configurations
There are several supported network configurations:
Cloud Only (Xen & KVM)
Basic Backup SchemeAdvanced Backup Scheme
Cloud only Network Diagram (BBS)
Cloud only Network Diagram (ABS)
Cloud & Storage
This allows you to use OnApp Integrated Storage. Data Protection is restricted to Basic Backup Scheme
Cloud and Storage Network Diagram (BBS)
Cloud Only (VMware)Cloud only Network Diagram (VMware)
Zone Types
OnApp 5.3 reinforces the role of the types for compute, data store, network and backup server zones. The following norms apply to existing and new zones and resources:
All individual resources (compute resources, data stores, backup servers and networks) should be assigned to zones. Unassigned resources cannot be used for virtual server creation.
All compute, data store, network and backup server zones have their type which cannot be changed. The zone's type also defines the type of the resources assigned to it. All vCloud Director related resources have the VPC type.
Resources can be moved from one zone to another, but the zones should be of the same type. For example, you can move a data store from a data store zone of the Virtual type to another zone of the Virtual type. However, such a data store cannot be moved to a zone of the VPC type.
Networks, data stores and backup servers can only be assigned to compute zones and compute resources of the same type. For example, a network from the Virtual type network zone can be assigned only to a compute zone of the Virtual type.
See also:
Data Stores Settings
Data Store Zones Settings
Compute Zones Settings
Compute Resource Settings
Backup Server Zones Settings
Network Zones Settings
Below you can find tables that demonstrate the available zone types depending on the resource type:
Compute resources and zones:
Compute Resource Type
Compute Zone Type
Xen
Virtual/Baremetal
KVM
Virtual/Smart
VMware
Virtual
vCloud Director
VPC
Data stores and data store zones:
Data Store Type
Data Store Zone Type
LVM
Virtual/Smart
Integrated Storage
Virtual/Smart
SolidFire
Virtual/Smart
vCloud Director
VPC
VMware
Virtual
Networks and network zones:
Network Type
Network Zone Type
vCloud Director
VPC
Other
Virtual/Smart/Baremetal
Backup servers and backup server zones: backups server zones can have either the Virtual or the Smart type. Any backup server can be added to a zone of either type. Once the backup server is added to a zone of a certain type it can be assigned to a backup server zone, compute resource or compute zone of that type only.
Dashboard
The OnApp dashboard is displayed after logging into the system. You can view resource usage statistics, activity log and summary of the entire cloud.
Statistics
You can choose the time period (24 hours, 7 or 30 days), for which the statistics will be shown. Resource statistics are represented in the form of bars and charts, which show the following:
Resource
Used
Total
Chart
CPU
Total virtual cores assigned to running VSs (may be higher than active cores if overselling)
Total physical cores on all compute resources which are configured in OnApp
Points on the graph show daily peaks of used CPU (in cores)
Memory
Total amount of memory used currently.
Sum total of RAM allocated to VSs + RAM allocated to orphaned VSs
Points on the graph show daily peaks of used memory (in MB)
Storage
Total amount of storage currently used.
Sum total of all VS disks unused capacities + orphan disks capacities
Points on the graph show daily peaks of used storage (in GB)
IOPS /h usage
The amount of input/output requests for the entire cloud (blue part of the bar- data read, dark blue - data written) for the last hour
Points on the graph show the total sum of all hourly statistics for a given day
Baremetal servers
The amount of running baremetal servers in the cloud
The amount of baremetal servers created in the cloud
Points on the graph show daily peaks of amount of created baremetal servers
Smart servers
The amount of running smart servers in the cloud
The amount of smart servers created in the cloud
Points on the graph show daily peaks of amount of created smart servers
vCloud CPU*
Points on the graph show daily peaks of used provider vDC CPU (in GHz)
vCloud Storage*
Points on the graph show daily peaks of used vCloud storage (in GB)
*vCloud Director charts are not shown on the dashboard if vCloud Director has never been connected to the Control Panel.
Go to your Control Panel's Settings > Configuration > Interface tab > Dashboard Statistics to choose which statistics will be shown on the dashboard.
Ensure that Dashboard permissions are enabled before viewing dashboard statistics. For more information about permissions refer to the Permissions section of this guide.
If there are no baremetal servers or smart servers in the cloud, the statistics on them are not shown.
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 - sum of all disk capacities on Data Stores in the cloud
vCloud Statistics
To view additional vCloud Director cloud statistics, click the vCloud icon by the silver dial. Be aware, that you should be logged in as vCloud administrator to view the statistics. You can view the following statistics:
Memory - the amount of used/total memory (in GB)
CPU - the amount of used/total CPU (in GHz)
vDisks - the amount of vDisks and disk size (in GB), used by these vDisks
IOPS - the amount of input and output requests
Your summary
This section 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.
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.
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.
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.
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 > 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.
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 menu. For details, refer to the Users chapter.
This chapter contains information on the following tabs that comprise the user profile:
Overview
Payments
Billing Plan
White List
Backups
iFrame
Overview
This tab contains information on the user's login, user roles, billing plan, prices and other.
Profile
User 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 w
top related