diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index f40afc4ac93292ac94e7118f56f7ace31e9ef26c..50c11c3949f3b756f8c1e41e44f877c27543d756 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -282,85 +282,17 @@ -

Basic resources

+

CPU Allocation

+<domain>
   ...
-  <memory>524288</memory>
-  <currentMemory>524288</currentMemory>
-  <memoryBacking>
-    <hugepages/>
-  </memoryBacking>
-  <blkiotune>
-    <weight>800</weight>
-  </blkiotune>
-  <memtune>
-    <hard_limit>1048576</hard_limit>
-    <soft_limit>131072</soft_limit>
-    <swap_hard_limit>2097152</swap_hard_limit>
-    <min_guarantee>65536</min_guarantee>
-  </memtune>
   <vcpu cpuset="1-4,^3,6" current="1">2</vcpu>
-  <cputune>
-    <vcpupin vcpu="0" cpuset="1-4,^2"/>
-    <vcpupin vcpu="1" cpuset="0,1"/>
-    <vcpupin vcpu="2" cpuset="2,3"/>
-    <vcpupin vcpu="3" cpuset="0,4"/>
-    <shares>2048</shares>
-    <period>1000000</period>
-    <quota>-1</quota>
-  </cputune>
-  <numatune>
-    <memory mode="strict" nodeset="1-4,^3"/>
-  </numatune>
-  ...
+ ... +</domain> +
-
memory
-
The maximum allocation of memory for the guest at boot time. - The units for this value are kilobytes (i.e. blocks of 1024 bytes)
-
currentMemory
-
The actual allocation of memory for the guest. This value can - be less than the maximum allocation, to allow for ballooning - up the guests memory on the fly. If this is omitted, it defaults - to the same value as the memory element
-
memoryBacking
-
The optional memoryBacking element, may have an - hugepages element set within it. This tells the - hypervisor that the guest should have its memory allocated using - hugepages instead of the normal native page size.
-
blkiotune
-
The optional blkiotune element provides the ability - to tune Blkio cgroup tunable parameters for the domain. If this is - omitted, it defaults to the OS provided defaults.
-
weight
-
The optional weight element is the I/O weight of the - guest. The value should be in range [100, 1000].
-
memtune
-
The optional memtune element provides details - regarding the memory tunable parameters for the domain. If this is - omitted, it defaults to the OS provided defaults. For QEMU/KVM, the - parameters are applied to the QEMU process as a whole. Thus, when - counting them, one needs to add up guest RAM, guest video RAM, and - some memory overhead of QEMU itself. The last piece is hard to - determine so one needs guess and try.
-
hard_limit
-
The optional hard_limit element is the maximum memory - the guest can use. The units for this value are kilobytes (i.e. blocks - of 1024 bytes)
-
soft_limit
-
The optional soft_limit element is the memory limit to - enforce during memory contention. The units for this value are - kilobytes (i.e. blocks of 1024 bytes)
-
swap_hard_limit
-
The optional swap_hard_limit element is the maximum - memory plus swap the guest can use. The units for this value are - kilobytes (i.e. blocks of 1024 bytes). This has to be more than - hard_limit value provided
-
min_guarantee
-
The optional min_guarantee element is the guaranteed - minimum memory allocation for the guest. The units for this value are - kilobytes (i.e. blocks of 1024 bytes)
vcpu
The content of this element defines the maximum number of virtual CPUs allocated for the guest OS, which must be between 1 and @@ -375,6 +307,28 @@ be used to specify whether fewer than the maximum number of virtual CPUs should be enabled.
+
+ + +

CPU Tuning

+ +
+<domain>
+  ...
+  <cputune>
+    <vcpupin vcpu="0" cpuset="1-4,^2"/>
+    <vcpupin vcpu="1" cpuset="0,1"/>
+    <vcpupin vcpu="2" cpuset="2,3"/>
+    <vcpupin vcpu="3" cpuset="0,4"/>
+    <shares>2048</shares>
+    <period>1000000</period>
+    <quota>-1</quota>
+  </cputune>
+  ...
+</domain>
+
+ +
cputune
The optional cputune element provides details @@ -422,6 +376,110 @@ speed. (NB: Only qemu driver support) Since 0.9.4
+
+ + +

Memory Allocation

+ +
+<domain>
+  ...
+  <memory>524288</memory>
+  <currentMemory>524288</currentMemory>
+  ...
+</domain>
+
+ +
+
memory
+
The maximum allocation of memory for the guest at boot time. + The units for this value are kilobytes (i.e. blocks of 1024 bytes)
+
currentMemory
+
The actual allocation of memory for the guest. This value can + be less than the maximum allocation, to allow for ballooning + up the guests memory on the fly. If this is omitted, it defaults + to the same value as the memory element
+
+ + +

Memory Backing

+ +
+<domain>
+  ...
+  <memoryBacking>
+    <hugepages/>
+  </memoryBacking>
+  ...
+</domain>
+
+ +
+
memoryBacking
+
The optional memoryBacking element, may have an + hugepages element set within it. This tells the + hypervisor that the guest should have its memory allocated using + hugepages instead of the normal native page size.
+
+ + +

Memory Tuning

+ +
+<domain>
+  ...
+  <memtune>
+    <hard_limit>1048576</hard_limit>
+    <soft_limit>131072</soft_limit>
+    <swap_hard_limit>2097152</swap_hard_limit>
+    <min_guarantee>65536</min_guarantee>
+  </memtune>
+  ...
+</domain>
+
+ +
+
memtune
+
The optional memtune element provides details + regarding the memory tunable parameters for the domain. If this is + omitted, it defaults to the OS provided defaults. For QEMU/KVM, the + parameters are applied to the QEMU process as a whole. Thus, when + counting them, one needs to add up guest RAM, guest video RAM, and + some memory overhead of QEMU itself. The last piece is hard to + determine so one needs guess and try.
+
hard_limit
+
The optional hard_limit element is the maximum memory + the guest can use. The units for this value are kilobytes (i.e. blocks + of 1024 bytes)
+
soft_limit
+
The optional soft_limit element is the memory limit to + enforce during memory contention. The units for this value are + kilobytes (i.e. blocks of 1024 bytes)
+
swap_hard_limit
+
The optional swap_hard_limit element is the maximum + memory plus swap the guest can use. The units for this value are + kilobytes (i.e. blocks of 1024 bytes). This has to be more than + hard_limit value provided
+
min_guarantee
+
The optional min_guarantee element is the guaranteed + minimum memory allocation for the guest. The units for this value are + kilobytes (i.e. blocks of 1024 bytes)
+
+ + +

NUMA Node Tuning

+ +
+<domain>
+  ...
+  <numatune>
+    <memory mode="strict" nodeset="1-4,^3"/>
+  </numatune>
+  ...
+</domain>
+
+ +
numatune
The optional numatune element provides details of @@ -440,6 +498,29 @@
+ +

Block I/O Tuning

+
+<domain>
+  ...
+  <blkiotune>
+    <weight>800</weight>
+  </blkiotune>
+  ...
+</domain>
+
+ +
+
blkiotune
+
The optional blkiotune element provides the ability + to tune Blkio cgroup tunable parameters for the domain. If this is + omitted, it defaults to the OS provided defaults.
+
weight
+
The optional weight element is the I/O weight of the + guest. The value should be in range [100, 1000].
+
+ +

CPU model and topology