Skip to content

Commit 594c67a

Browse files
nvazquezshwstppr
andauthored
VMware new additions for deploy-as-is (apache#179)
* VMware new additions for deploy-as-is * Add new section for virtual ppliances * Update source/adminguide/templates.rst Co-authored-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * Update source/adminguide/virtual_machines/virtual_appliances.rst Co-authored-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * Complete docs Co-authored-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
1 parent 03bdd1e commit 594c67a

File tree

7 files changed

+105
-6
lines changed

7 files changed

+105
-6
lines changed
34.2 KB
Loading
101 KB
Loading
66.7 KB
Loading
59.6 KB
Loading

source/adminguide/templates.rst

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ as the prototype for other VMs.
159159
- **Name and Display Text**. These will be shown in the UI, so
160160
choose something descriptive.
161161

162-
- **OS Type**. This helps CloudStack and the hypervisor perform
162+
- **OS Type**. (Except for VMware). This helps CloudStack and the hypervisor perform
163163
certain operations and make assumptions that improve the
164164
performance of the guest. Select one of the following.
165165

@@ -177,6 +177,12 @@ as the prototype for other VMs.
177177
5.4 to support a CentOS 6.2 image will in general not work.
178178
In those cases you should choose Other.
179179

180+
.. note::
181+
Since version 4.15, VMware templates do not allow users or administrators
182+
selecting an OS Type when registering a template. The OS Type is
183+
obtained from the template after it is registered.
184+
185+
180186
- **Public**. Choose Yes to make this template accessible to all
181187
users of this CloudStack installation. The template will appear in
182188
the Community Templates list. See `“Private and
@@ -192,6 +198,12 @@ The new template will be visible in the Templates section when the
192198
template creation process has been completed. The template is then
193199
available when creating a new VM.
194200

201+
.. note::
202+
Since version 4.15, CloudStack obtains information from the VMware templates
203+
automatically at registration time. If a template contains different deployment
204+
options (or configurations) as in the case of virtual appliances, then CloudStack
205+
display the information required by the template, allowing users or administrators
206+
to configure their instances.
195207

196208
Creating a Template from a Snapshot
197209
-----------------------------------
@@ -237,7 +249,7 @@ To upload a template:
237249
available, or All Zones to make it available throughout
238250
CloudStack.
239251

240-
- **OS Type**: This helps CloudStack and the hypervisor perform
252+
- **OS Type**: (Except for VMware). This helps CloudStack and the hypervisor perform
241253
certain operations and make assumptions that improve the
242254
performance of the guest. Select one of the following:
243255

@@ -251,6 +263,11 @@ To upload a template:
251263
support a CentOS 6.2 image will in general not work. In
252264
those cases you should choose Other.
253265

266+
.. note::
267+
Since version 4.15, VMware templates do not allow users or administrators
268+
selecting an OS Type when registering a template. The OS Type is
269+
obtained from the template after it is registered.
270+
254271
- **Hypervisor**: The supported hypervisors are listed. Select the
255272
desired one.
256273

@@ -278,7 +295,10 @@ To upload a template:
278295
Note that uploading multi-disk templates is also supported.
279296

280297
.. note::
281-
Templates corresponding to appliances with 'static properties' in the OVF (such as virtual appliances) are also supported. CloudStack stores any template properties in the OVF in the database after successful template installation. Once the template is ready, these properties are viewed by selecting the template and clicking on the 'OVF Properties' tab.
298+
VMware only: If the selected template contains OVF properties, different deployment options or configurations,
299+
multiple NICs or end-user license agreements, then the wizard will display these properties.
300+
301+
See `“Support for Virtual Appliances” <virtual_machines.html#support-for-virtual-appliances>`_.
282302

283303

284304

@@ -294,6 +314,11 @@ The steps are similar as when Uploading a template/ISO from a remote HTTP server
294314
For this feature to work, your SSVMs must be supporting HTTPS (for more info please visit `“Using a SSL Certificate for the Console Proxy”
295315
<systemvm.html#using-a-ssl-certificate-for-the-console-proxy>`_).
296316

317+
.. note::
318+
Since version 4.15, VMware templates do not allow users or administrators
319+
selecting an OS Type when uploading a template. The OS Type is
320+
obtained from the template after it is uploaded.
321+
297322
Example GUI dialog of uploading Template/ISO from local (browser) is given below:
298323

299324
|template-upload-from-local.PNG|

source/adminguide/virtual_machines.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,10 @@ To create a VM from a template:
141141
service offering.
142142

143143
.. note::
144-
VMware only: If the selected template OVF contains static properties, the wizard will display these properties. Static
145-
properties do not have the concept of required and optional fields . Therefore CloudStack is not able
146-
to enforce the population of 'important fields'.
144+
VMware only: If the selected template contains OVF properties, different deployment options or configurations,
145+
multiple NICs or end-user license agreements, then the wizard will display these properties.
146+
147+
See `“Support for Virtual Appliances” <virtual_machines.html#support-for-virtual-appliances>`_.
147148

148149
#. Click Submit and your VM will be created and started.
149150

@@ -752,6 +753,9 @@ Each user VM has a set of "details" associated with it (as visible via listVirtu
752753
The Settings tab is always present/visible, but settings can be changed only when the VM is in a Stopped state.
753754
Some VM details/settings can be hidden via "user.vm.blacklisted.details" global setting (you can find below the list of those hidden by default).
754755

756+
.. note::
757+
Since version 4.15, VMware VM settings for the ROOT disk controller, NIC adapter type and data disk controller are populated automatically with the values inherited from the template.
758+
755759
When adding a new setting or modifying the existing ones, setting names are shown/offered in a drop-down list, as well as their possible values (with the exception of boolean or numerical values).
756760

757761
Read-only details/settings that are hidden by default:
@@ -913,6 +917,11 @@ snapshot:
913917
VM snapshots are deleted automatically when a VM is destroyed. You don't
914918
have to manually delete the snapshots in this case.
915919

920+
Support for Virtual Appliances
921+
==============================
922+
923+
.. include:: virtual_machines/virtual_appliances.rst
924+
916925
Unmanaging Virtual Machines
917926
===========================
918927

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
About Virtual Appliances
2+
------------------------
3+
4+
CloudStack allows users to deploy virtual appliances on VMware such as its been made directly though vCenter.
5+
Vendors of virtual appliances for VMware often produce ‘templates’ of their appliances in an OVA format.
6+
An OVA file contain disc images, as well as the configuration data of the virtual appliance and also at times a EULA which must be acknowledged.
7+
8+
Virtual Appliances are supported only on VMware.
9+
10+
.. note::
11+
Since version 4.15, all the new templates registered are treated as virtual appliance templates.
12+
13+
To keep the existing functionality, all the templates registered before version 4.15 are not affected by this changes.
14+
15+
Deployment options (configurations)
16+
-----------------------------------
17+
18+
VMware templates can provide different deployment options in their OVF descriptor file. CloudStack obtains
19+
the different deployment options when the template is registered and it displays them to the users
20+
in the virtual machine deployment wizard, under the 'Compute Offering' section.
21+
22+
After the user selects a deployment option, CloudStack lists the compute offerings which match or exceed the
23+
deployment options hardware requirements for CPU and memory.
24+
25+
.. note::
26+
All the custom unconstrained compute offerings are displayed, but only those constrained custom offerings
27+
in which the maximum or minimum requirements for CPU and memory are supported by the selected deployment option.
28+
29+
.. |vapps-deployment-opts.png| image:: /_static/images/vapps-deployment-opts.png
30+
.. |vapps-eulas.png| image:: /_static/images/vapps-eulas.png
31+
.. |vapps-networks.png| image:: /_static/images/vapps-networks.png
32+
.. |vapps-properties.png| image:: /_static/images/vapps-properties.png
33+
34+
The 'Compute Offering' section will be similar to this:
35+
|vapps-deployment-opts.png|
36+
37+
38+
Network interfaces
39+
------------------
40+
41+
In case the template requires the virtual appliance to connect different network interfaces, these are displayed in the 'Networks' section, similar to this:
42+
43+
|vapps-networks.png|
44+
45+
46+
Properties
47+
----------
48+
49+
If the template contains properties that require the user input, those are being displayed on the 'Properties' section, similar to this:
50+
51+
|vapps-properties.png|
52+
53+
54+
End-user license agreements
55+
---------------------------
56+
57+
If the template contains one or more end-user license agreements, the user must accept them prior to deploy their virtual appliance.
58+
If the license agreements are not accepted, then it is not possible to deploy a virtual appliance.
59+
60+
|vapps-eulas.png|
61+
62+
Advanced deployment settings
63+
----------------------------
64+
65+
It is not possible to choose the boot type (BIOS, UEFI) and boot mode for virtual appliances. The boot mode and type used by the virtual appliances is defined in the template.

0 commit comments

Comments
 (0)