You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ro...@apache.org on 2021/01/14 00:33:37 UTC
[cloudstack-documentation] branch 4.15 updated: VMware new
additions for deploy-as-is (#179)
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch 4.15
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/4.15 by this push:
new 594c67a VMware new additions for deploy-as-is (#179)
594c67a is described below
commit 594c67a230961b25c380e115b7d86afcad442f05
Author: Nicolas Vazquez <ni...@gmail.com>
AuthorDate: Wed Jan 13 21:33:26 2021 -0300
VMware new additions for deploy-as-is (#179)
* VMware new additions for deploy-as-is
* Add new section for virtual ppliances
* Update source/adminguide/templates.rst
Co-authored-by: Abhishek Kumar <ab...@gmail.com>
* Update source/adminguide/virtual_machines/virtual_appliances.rst
Co-authored-by: Abhishek Kumar <ab...@gmail.com>
* Complete docs
Co-authored-by: Abhishek Kumar <ab...@gmail.com>
---
source/_static/images/vapps-deployment-opts.png | Bin 0 -> 35001 bytes
source/_static/images/vapps-eulas.png | Bin 0 -> 103639 bytes
source/_static/images/vapps-networks.png | Bin 0 -> 68255 bytes
source/_static/images/vapps-properties.png | Bin 0 -> 60989 bytes
source/adminguide/templates.rst | 31 +++++++++-
source/adminguide/virtual_machines.rst | 15 ++++-
.../virtual_machines/virtual_appliances.rst | 65 +++++++++++++++++++++
7 files changed, 105 insertions(+), 6 deletions(-)
diff --git a/source/_static/images/vapps-deployment-opts.png b/source/_static/images/vapps-deployment-opts.png
new file mode 100644
index 0000000..8d67664
Binary files /dev/null and b/source/_static/images/vapps-deployment-opts.png differ
diff --git a/source/_static/images/vapps-eulas.png b/source/_static/images/vapps-eulas.png
new file mode 100644
index 0000000..f00a8e8
Binary files /dev/null and b/source/_static/images/vapps-eulas.png differ
diff --git a/source/_static/images/vapps-networks.png b/source/_static/images/vapps-networks.png
new file mode 100644
index 0000000..688c28d
Binary files /dev/null and b/source/_static/images/vapps-networks.png differ
diff --git a/source/_static/images/vapps-properties.png b/source/_static/images/vapps-properties.png
new file mode 100644
index 0000000..0784b68
Binary files /dev/null and b/source/_static/images/vapps-properties.png differ
diff --git a/source/adminguide/templates.rst b/source/adminguide/templates.rst
index 1936bfe..615f520 100644
--- a/source/adminguide/templates.rst
+++ b/source/adminguide/templates.rst
@@ -159,7 +159,7 @@ as the prototype for other VMs.
- **Name and Display Text**. These will be shown in the UI, so
choose something descriptive.
- - **OS Type**. This helps CloudStack and the hypervisor perform
+ - **OS Type**. (Except for VMware). This helps CloudStack and the hypervisor perform
certain operations and make assumptions that improve the
performance of the guest. Select one of the following.
@@ -177,6 +177,12 @@ as the prototype for other VMs.
5.4 to support a CentOS 6.2 image will in general not work.
In those cases you should choose Other.
+ .. note::
+ Since version 4.15, VMware templates do not allow users or administrators
+ selecting an OS Type when registering a template. The OS Type is
+ obtained from the template after it is registered.
+
+
- **Public**. Choose Yes to make this template accessible to all
users of this CloudStack installation. The template will appear in
the Community Templates list. See `“Private and
@@ -192,6 +198,12 @@ The new template will be visible in the Templates section when the
template creation process has been completed. The template is then
available when creating a new VM.
+.. note::
+ Since version 4.15, CloudStack obtains information from the VMware templates
+ automatically at registration time. If a template contains different deployment
+ options (or configurations) as in the case of virtual appliances, then CloudStack
+ display the information required by the template, allowing users or administrators
+ to configure their instances.
Creating a Template from a Snapshot
-----------------------------------
@@ -237,7 +249,7 @@ To upload a template:
available, or All Zones to make it available throughout
CloudStack.
- - **OS Type**: This helps CloudStack and the hypervisor perform
+ - **OS Type**: (Except for VMware). This helps CloudStack and the hypervisor perform
certain operations and make assumptions that improve the
performance of the guest. Select one of the following:
@@ -251,6 +263,11 @@ To upload a template:
support a CentOS 6.2 image will in general not work. In
those cases you should choose Other.
+ .. note::
+ Since version 4.15, VMware templates do not allow users or administrators
+ selecting an OS Type when registering a template. The OS Type is
+ obtained from the template after it is registered.
+
- **Hypervisor**: The supported hypervisors are listed. Select the
desired one.
@@ -278,7 +295,10 @@ To upload a template:
Note that uploading multi-disk templates is also supported.
.. note::
- 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.
+ VMware only: If the selected template contains OVF properties, different deployment options or configurations,
+ multiple NICs or end-user license agreements, then the wizard will display these properties.
+
+ See `“Support for Virtual Appliances” <virtual_machines.html#support-for-virtual-appliances>`_.
@@ -294,6 +314,11 @@ The steps are similar as when Uploading a template/ISO from a remote HTTP server
For this feature to work, your SSVMs must be supporting HTTPS (for more info please visit `“Using a SSL Certificate for the Console Proxy”
<systemvm.html#using-a-ssl-certificate-for-the-console-proxy>`_).
+.. note::
+ Since version 4.15, VMware templates do not allow users or administrators
+ selecting an OS Type when uploading a template. The OS Type is
+ obtained from the template after it is uploaded.
+
Example GUI dialog of uploading Template/ISO from local (browser) is given below:
|template-upload-from-local.PNG|
diff --git a/source/adminguide/virtual_machines.rst b/source/adminguide/virtual_machines.rst
index fd1bd1a..5880d16 100644
--- a/source/adminguide/virtual_machines.rst
+++ b/source/adminguide/virtual_machines.rst
@@ -141,9 +141,10 @@ To create a VM from a template:
service offering.
.. note::
- VMware only: If the selected template OVF contains static properties, the wizard will display these properties. Static
- properties do not have the concept of required and optional fields . Therefore CloudStack is not able
- to enforce the population of 'important fields'.
+ VMware only: If the selected template contains OVF properties, different deployment options or configurations,
+ multiple NICs or end-user license agreements, then the wizard will display these properties.
+
+ See `“Support for Virtual Appliances” <virtual_machines.html#support-for-virtual-appliances>`_.
#. Click Submit and your VM will be created and started.
@@ -752,6 +753,9 @@ Each user VM has a set of "details" associated with it (as visible via listVirtu
The Settings tab is always present/visible, but settings can be changed only when the VM is in a Stopped state.
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).
+.. note::
+ 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.
+
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).
Read-only details/settings that are hidden by default:
@@ -913,6 +917,11 @@ snapshot:
VM snapshots are deleted automatically when a VM is destroyed. You don't
have to manually delete the snapshots in this case.
+Support for Virtual Appliances
+==============================
+
+.. include:: virtual_machines/virtual_appliances.rst
+
Unmanaging Virtual Machines
===========================
diff --git a/source/adminguide/virtual_machines/virtual_appliances.rst b/source/adminguide/virtual_machines/virtual_appliances.rst
new file mode 100644
index 0000000..e14d759
--- /dev/null
+++ b/source/adminguide/virtual_machines/virtual_appliances.rst
@@ -0,0 +1,65 @@
+About Virtual Appliances
+------------------------
+
+CloudStack allows users to deploy virtual appliances on VMware such as its been made directly though vCenter.
+Vendors of virtual appliances for VMware often produce ‘templates’ of their appliances in an OVA format.
+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.
+
+Virtual Appliances are supported only on VMware.
+
+.. note::
+ Since version 4.15, all the new templates registered are treated as virtual appliance templates.
+
+ To keep the existing functionality, all the templates registered before version 4.15 are not affected by this changes.
+
+Deployment options (configurations)
+-----------------------------------
+
+VMware templates can provide different deployment options in their OVF descriptor file. CloudStack obtains
+the different deployment options when the template is registered and it displays them to the users
+in the virtual machine deployment wizard, under the 'Compute Offering' section.
+
+After the user selects a deployment option, CloudStack lists the compute offerings which match or exceed the
+deployment options hardware requirements for CPU and memory.
+
+.. note::
+ All the custom unconstrained compute offerings are displayed, but only those constrained custom offerings
+ in which the maximum or minimum requirements for CPU and memory are supported by the selected deployment option.
+
+.. |vapps-deployment-opts.png| image:: /_static/images/vapps-deployment-opts.png
+.. |vapps-eulas.png| image:: /_static/images/vapps-eulas.png
+.. |vapps-networks.png| image:: /_static/images/vapps-networks.png
+.. |vapps-properties.png| image:: /_static/images/vapps-properties.png
+
+The 'Compute Offering' section will be similar to this:
+ |vapps-deployment-opts.png|
+
+
+Network interfaces
+------------------
+
+In case the template requires the virtual appliance to connect different network interfaces, these are displayed in the 'Networks' section, similar to this:
+
+|vapps-networks.png|
+
+
+Properties
+----------
+
+If the template contains properties that require the user input, those are being displayed on the 'Properties' section, similar to this:
+
+|vapps-properties.png|
+
+
+End-user license agreements
+---------------------------
+
+If the template contains one or more end-user license agreements, the user must accept them prior to deploy their virtual appliance.
+If the license agreements are not accepted, then it is not possible to deploy a virtual appliance.
+
+|vapps-eulas.png|
+
+Advanced deployment settings
+----------------------------
+
+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.
\ No newline at end of file