PaulAngus commented on a change in pull request #6: Enable DPDK support on KVM documentation URL: https://github.com/apache/cloudstack-documentation/pull/6#discussion_r218064835
########## File path: source/plugins/ovs-plugin.rst ########## @@ -267,6 +267,93 @@ Using the OVS plugin with VPC OVS plugin does not work with VPC at that time +DPDK Support +------------------------------ + +Since version 4.12 it is possible to enable DPDK support on CloudStack along with the OVS plugin. + +Agent configuration +~~~~~~~~~~~~~~~~~~~ + +- Edit /etc/cloudstack/agent/agent.properties to append DPDK support on ovs-vstcl commands for port creations + + :: + + openvswitch.dpdk.enable=true + +Use DPDK on VM deployments +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Users are able to pass extra configurations as part of the 'deployVirtualMachine' API method. +These extra configurations are included on the resulting XML domain of the virtual machine. + +Additional VM configuration +""""""""""""""""""""""""""" +The 'deployVirtualMachine' API method accepts a URL UTF-8 string encoded parameter 'extraconfig'. + +Parameter is decoded following these rules: + +- There could be multiple XML sections, separated by a new line +- Each section can be named, setting a title ending on ':' at the first line +- Double quotes instead of single quotes should be used +- Configurations are persisted as VM details, with the key: 'extraconfig-TITLE' or 'extraconfig-N' where N is a number. + +- Example: + + - In order to pass the below extra configuration to the VM, named 'config-1' + + :: + + config-1: + <tag> + <inner-tag>VALUE</inner-tag> + </tag> + + - The 'extraconfig' parameter should receive the UTF-8 URL encoded string: + + :: + + config-1%3A%0A%3Ctag%3E%0A%20%20%20%3Cinner-tag%3EVALUE%3C%2Finner-tag%3E%0A%3C%2Ftag%3E + +DPDK required configuration +""""""""""""""""""""""""""" + +- Set the global configuration to 'true' (as global setting or account setting) + + :: + + enable.additional.vm.configuration + +- Generate the UTF-8 URL encoded additional configuration to enable huge pages and NUMA, examples below: + + :: + + dpdk-hugepages: + <memoryBacking> + <hugepages> + </hugepages> + </memoryBacking> + + dpdk-numa: + <cpu mode="host-passthrough"> + <numa> + <cell id="0" cpus="0" memory="9437184" unit="KiB" memAccess="shared"/> + </numa> + </cpu> + +- Pass the 'extraconfig' parameter to 'deployVirtualMachine' or 'updateVirtualMachine' API methods Review comment: can you explicitly explain that you mean deployVirtualMachine name='<NAME>' extraconfig='dpdk-hugepages%3A%0A%3CmemoryBackingBLAH' (if thats correct). if there are more than one parts are they extraconfig[0]= and extraconfig[1]= ?? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
