[PATCH RFC 5/5] doc: Add documentation for new cputune elements: period and quota

[Wen Congyang <wency@xxxxxxxxxxxxxx>]

---
 docs/formatdomain.html.in |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 267839b..05ebed7 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -294,6 +294,8 @@
     <vcpupin vcpu="2" cpuset="2,3"/>
     <vcpupin vcpu="3" cpuset="0,4"/>
     <shares>2048</shares>
+    <period>1000000</period>
+    <quota>-1</quota>
   </cputune>
   ...</pre>
 
@@ -382,6 +384,23 @@
         2048 will get twice as much CPU time as a VM configured with value 1024.
         <span class="since">Since 0.9.0</span>
       </dd>
+      <dt><code>period</code></dt>
+      <dd>
+        The optional <code>period</code> element specifies the enforcement
+        interval(unit: microseconds). Within <code>period</code>, the domain
+        will not be allowed to consume more than <code>quota</code> worth of
+        runtime. The value should be in range [1000, 1000000].
+        <span class="since">Since 0.9.3</span>
+      </dd>
+      <dt><code>quota</code></dt>
+      <dd>
+        The optional <code>quota</code> element specifies the maximum allowed
+        bandwidth(unit: microseconds). A domain with <code>quota</code> as any
+        negative value indicates that the domain has infinite bandwidth, which
+        means that it is not bandwidth controlled. The value should be in range
+        [1000, 18446744073709551] or less than 0.
+        <span class="since">Since 0.9.3</span>
+      </dd>
     </dl>
 
     <h3><a name="elementsCPU">CPU model and topology</a></h3>
-- 
1.7.1

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list