Page History
...
CloudStack users wish to have the ability functionality to add “extra configuration” metadata to a user VM during deployment in a manner that is similar across the 3 major supported hypervisors. This data could be anything ranging from instructions to install hypervisor specific required tools and drivers in each VM that is deployed from a template which does not have these tools installed. To simplify the implementation, the user will pass this additional configuration as URL encoded string that will be decoded and parsed for each hypervisor type. These additional metadata must be included in the VM instance definition.
Any additional configuration setting/command needs to be first included into the list of allowed settings by the Root Admin through a configurable global configuration. No command/setting is allowed by default.
- KVM
The primary configuration file for KVM host guest instances is a domain XML. The additional configuration for KVM should be provided in XML format in a URL encoded string which will be parsed and append to the KVM instance XML configuration file builder.
A configurable global config 'allow.additional.vm.configuration.list.kvm' is available for Root admin to specify a list options that are allowed with this feature. with KVM No option is allowed by default.
Example: the following metadata can be passed to enable hugepages on KVM hosts specify guest VM NUMA topology using the <numa> element in the domain XML, with 'memoryBacking' included in the list of allowed setting/configuration
<memoryBacking>
<hugepages/>
</memoryBacking>
...
Another Example: the following examples allows user to add EHCI controller to VM, also with the 'controller' element/tag included in the list of allowed settings/configuration
<controller type='usb' index='1' model='ehci'></controller>
...
%3Ccontroller%20type%3D%27usb%27%20index%3D%271%27%20model%3D%27ehci%27%3E%3C%2Fcontroller%3E
A configurable global config 'additional.vm.configuration.black.list.kvm' is available for Root admin to specify a list options that are disallowed with this feature.
- Default values are; 'name, uuid, memory, currentMemory'
The keys in the blacklisted commands are used to validate the tags from the user passed XML as extraconfig data. Any tag/element that is found with the name in the blacklist of commands will result to an Exception.
e.g. <name>my vm </name> or <memory unit="KiB">262144</memory> or <currentMemory unit="KiB">262144</currentMemory> will throw an exception by default because this type of XML tags have been blacklisted.
- XenServer
Similar for this hypervisor, the primary configuration file of the guest VM is built by CloudStack, therefor, the additional metadata will also be parsed and append to the builder.
- XenServer
Support for XenServer has only been added for the XAPI's 'vm-param-set' configuration using its arguments/keys as strings. Below is a full list of all supported operations with this feature;
Simple key=value pair configurations, e.g PV-args=hvc0, is-a-template=true. Any of this these settings will override an existing setting with the new value from the use, behaviour can be prevented by blacklisting the key in the global config with the list of disallowed keysuser.
A configurable global config 'allow.additional.vm.configuration.list.xenserver' is available for Root admin to specify a list of 'vm-param-set' options that are allowed with this feature. No configuration is allowed by default.
is-a-template,
memory-static-max,
memory-dynamic-max,
memory-dynamic-min,
memory-static-min,
VCPUs-max,
VCPUs-at-startup,
HVM-boot-policy,
order,
shutdown-delay, Long
start-delay, Long
ha-restart-priority,
PV-bootloader-args,
PV-bootloader,
PV-legacy-args,
PV-args,
PV-ramdisk,
PV-kernel,
HVM-shadow-multiplier,
...
Example: Following commands are used to convert a VM from HVM to PV;, also admin needs to include HVM-boot-policy, PV-bootloader and PV-args for the configuration below to be allowed.
HVM-boot-policy=
PV-bootloader=pygrub
PV-args=hvc0
...
And verify that they have been correctly set.
...
set
...
.
...
Default values are; ' is-a-template, memory-static-max, memory-dynamic-max, memory-dynamic-min, memory-static-min'
The algorithm for XenServer does the following checks;
- Is the command option passed a valid key/value pair 'key1=value1\nkey2=value2' and so on. Throws an Exception if user input is not valid key/value pair.
- The next algorithm checks if passed command contains any keys from the blacklisted ckeys allowed list of keys keys and throws a CloudRountimeException if truefalse. This check is case insensitive. (e.x. is-a-template=true will throw an Exception since 'is-a-template' is blacklisted by default).
- VMware
Similar for this hypervisor, the primary configuration file of the guest VM is built by CloudStack, therefor, the additional metadata will also be parsed and append to the VMX file builder.
A configurable global config 'allow.additional.vm.configuration.list.vmware' is available for Root admin to specify a list options that are allowed with this feature.
Example: the following is an example to set Hyper-V to run on ESXi, with 'hypervisor.cpuid.v0' included on the list of allowed settings/configuration keys.
hypervisor.cpuid.v0=FALSE
...
- find / -name *.vmx
- cat <vmx file path> | grep \w ‘extra config’
...
The configuration passed is parsed as key/value pair and every key is validated against against the blacklisted allowed list of commands set by Root admin. An Exception is thrown if an invalid key is found.
...
- 3 new settings with a list of options that are not allowed to passed as additional data. The admin user will populate this setting with a list of tags/commands that will be used for validating against user supplied additional configuration. All this settings are dynamic and should not requires a restart of the CloudStack management server in order for changes to take effect. Please note that this are only available as global settings for the Root admin only.
- 'allow.additional.vm.configuration.black.list.kvm'
- 'allow.additional.vm.configuration.black.list.xenserver'
- 'allow.additional.vm.configuration.black.list.vmware'
UserVmManageImpl class is refactored to include the new Boolean configuration setting to allow/disallow passing of additional data during VM deployment/updating, and stores the data in the 'user_vm_details' table.
...
- The extraconfig is retrieved from the VirtualMachineTO as a list of key/value pairs that are supported by the 'vm-param-set' commands to be executed by the hyervisor host using the 'xe' CLI (XAPI) against the target VM.The commands are executed sequentially to set the parameters command option and are set using the predefined setters from the 'xenapi' plugin against the target VM.
VMware: VmwareResource is also refactored to include additional configuration into the VMX configuration file builder before starting the VM.
- All the key/value configuration settings stored under the 'user_vm_details' table are appended to the VM's vmx file by the VMware API and ignoring duplicates.
UI integration
N/A
...
Overview
Content Tools
Apps