[libvirt] [PATCH 0/2] Some additions/fixes in formatdomain docs
Katerina Koukiou (2): docs: formatdomain: add info about global_period and global_quota for cputune docs: formatdomain: clarify period cputune subelement docs/formatdomain.html.in | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) -- 2.17.1
Patch series https://www.redhat.com/archives/libvir-list/2016-January/msg00482.html introduced the parameters but didn't update the docs. Signed-off-by: Katerina Koukiou <kkoukiou@redhat.com> --- docs/formatdomain.html.in | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index a3afe137bf..7fa448acdc 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -747,6 +747,8 @@ <shares>2048</shares> <period>1000000</period> <quota>-1</quota> + <global_period>1000000</global_period> + <global_quota>-1</global_quota> <emulator_period>1000000</emulator_period> <emulator_quota>-1</emulator_quota> <iothread_period>1000000</iothread_period> @@ -837,6 +839,25 @@ <span class="since">Only QEMU driver support since 0.9.4, LXC since 0.9.10</span> </dd> + <dt><code>global_period</code></dt> + <dd> + The optional <code>global_period</code> element specifies the + enforcement period for a quota (unit: microseconds) for whole domain, + when using posix scheduler. The value should be in range + [1000, 1000000]. A global_period with value 0 means no value. + <span class="since">Only QEMU driver support since 1.3.3</span> + </dd> + <dt><code>global_quota</code></dt> + <dd> + The optional <code>global_quota</code> element specifies the maximum + allowed bandwidth (unit: microseconds) to be used within a period for + whole domain. A domain with <code>global_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. A global_quota with value 0 + means no value. + <span class="since">Only QEMU driver support since 1.3.3</span> + </dd> <dt><code>emulator_period</code></dt> <dd> -- 2.17.1
On Tue, Jul 17, 2018 at 05:47:31PM +0200, Katerina Koukiou wrote:
Patch series https://www.redhat.com/archives/libvir-list/2016-January/msg00482.html
The commit hashes would be better IMO, i.e. commits 4d92d5 and 55ecda.
introduced the parameters but didn't update the docs.
Signed-off-by: Katerina Koukiou <kkoukiou@redhat.com> --- docs/formatdomain.html.in | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index a3afe137bf..7fa448acdc 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -747,6 +747,8 @@ <shares>2048</shares> <period>1000000</period> <quota>-1</quota> + <global_period>1000000</global_period> + <global_quota>-1</global_quota> <emulator_period>1000000</emulator_period> <emulator_quota>-1</emulator_quota> <iothread_period>1000000</iothread_period> @@ -837,6 +839,25 @@ <span class="since">Only QEMU driver support since 0.9.4, LXC since 0.9.10</span> </dd> + <dt><code>global_period</code></dt> + <dd> + The optional <code>global_period</code> element specifies the + enforcement period for a quota (unit: microseconds) for whole domain, + when using posix scheduler. The value should be in range
s/ whole/the whole/ How about "... element specifies the enforcement CFS scheduler interval for the whole domain in contrast with <period> which enforces the interval per vcpu."
+ [1000, 1000000]. A global_period with value 0 means no value.
s/\(global_period\)/<code>\1</code>/
+ <span class="since">Only QEMU driver support since 1.3.3</span>
^This bit can stay as is.
+ </dd> + <dt><code>global_quota</code></dt> + <dd> + The optional <code>global_quota</code> element specifies the maximum + allowed bandwidth (unit: microseconds) to be used within a period for
s/to be used// s/ whole/the whole/
+ whole domain. A domain with <code>global_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. A global_quota with value 0 + means no value.
s/\(global_quota\)/<code>\1</code>/
+ <span class="since">Only QEMU driver support since 1.3.3</span> + </dd>
<dt><code>emulator_period</code></dt> <dd> --
Reviewed-by: Erik Skultety <eskultet@redhat.com>
Although the name of the element is not self-explanatory, it's affecting only the vcpu threads. Signed-off-by: Katerina Koukiou <kkoukiou@redhat.com> --- docs/formatdomain.html.in | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 7fa448acdc..61930e4907 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -831,11 +831,11 @@ <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. A quota with value 0 means no - value. You can use this feature to ensure that all vcpus run at the same - speed. + negative value indicates that the domain has infinite bandwidth for + VCPU threads, which means that it is not bandwidth controlled. The value + should be in range [1000, 18446744073709551] or less than 0. A quota + with value 0 means no value. You can use this feature to ensure that all + vcpus run at the same speed. <span class="since">Only QEMU driver support since 0.9.4, LXC since 0.9.10</span> </dd> -- 2.17.1
On Tue, Jul 17, 2018 at 5:47 PM, Katerina Koukiou <kkoukiou@redhat.com> wrote:
Although the name of the element is not self-explanatory, it's affecting only the vcpu threads.
Signed-off-by: Katerina Koukiou <kkoukiou@redhat.com> --- docs/formatdomain.html.in | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 7fa448acdc..61930e4907 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -831,11 +831,11 @@ <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. A quota with value 0 means no - value. You can use this feature to ensure that all vcpus run at the same - speed. + negative value indicates that the domain has infinite bandwidth for + VCPU threads, which means that it is not bandwidth controlled. The value
Just a nitpick here. I'd go for vCPU instead of VCPU. I know both terms are used, it's just that vCPU seems to be used more often than VCPU: [ffidenci@pessoa libvirt]$ grep --color "vCPU" docs/formatdomain.html.in | wc -l 10 [ffidenci@pessoa libvirt]$ grep --color "VCPU" docs/formatdomain.html.in | wc -l 5 I'd follow up with an additional patch just to standardize the name for the most used one.
+ should be in range [1000, 18446744073709551] or less than 0. A quota + with value 0 means no value. You can use this feature to ensure that all + vcpus run at the same speed. <span class="since">Only QEMU driver support since 0.9.4, LXC since 0.9.10</span> </dd> -- 2.17.1
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
Best Regards, -- Fabiano Fidêncio
On Tue, Jul 17, 2018 at 06:01:50PM +0200, Fabiano Fidêncio wrote:
On Tue, Jul 17, 2018 at 5:47 PM, Katerina Koukiou <kkoukiou@redhat.com> wrote:
Although the name of the element is not self-explanatory, it's affecting only the vcpu threads.
Signed-off-by: Katerina Koukiou <kkoukiou@redhat.com> --- docs/formatdomain.html.in | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 7fa448acdc..61930e4907 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -831,11 +831,11 @@ <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. A quota with value 0 means no - value. You can use this feature to ensure that all vcpus run at the same - speed. + negative value indicates that the domain has infinite bandwidth for + VCPU threads, which means that it is not bandwidth controlled. The value
Just a nitpick here. I'd go for vCPU instead of VCPU.
I know both terms are used, it's just that vCPU seems to be used more often than VCPU: [ffidenci@pessoa libvirt]$ grep --color "vCPU" docs/formatdomain.html.in | wc -l 10 [ffidenci@pessoa libvirt]$ grep --color "VCPU" docs/formatdomain.html.in | wc -l 5
I'd follow up with an additional patch just to standardize the name for the most used one.
even "vcpu" would be fine, but I agree with Fabiano. If you adjust that, you have my Reviewed-by: Erik Skultety <eskultet@redhat.com>
On Tue, Jul 17, 2018 at 05:47:32PM +0200, Katerina Koukiou wrote:
Although the name of the element is not self-explanatory, it's affecting only the vcpu threads.
Signed-off-by: Katerina Koukiou <kkoukiou@redhat.com> --- docs/formatdomain.html.in | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 7fa448acdc..61930e4907 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -831,11 +831,11 @@ <dd> The optional <code>quota</code> element specifies the maximum allowed bandwidth(unit: microseconds). A domain with <code>quota</code> as any
There is a missing space before the parenthesis here, and it's copied multiple times for all the similar attributes. It's a good indicator that we should only write the repetititive text once, and collect the differences in a neat table, e.g.: +---------------+----------------+---------+-------------------------+ + quota element | period element | affects | since | +---------------+----------------+---------+-------------------------+ + quota | period | vCPUs | 0.9.4, LXC since 0.9.10 | + global_guota | global_period | all | ... | +---------------+----------------+---------+-------------------------+ (But, of course, even this change is better than nothing) Jano
- 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. A quota with value 0 means no - value. You can use this feature to ensure that all vcpus run at the same - speed.
On Wed, Jul 18, 2018 at 10:05:30AM +0200, Ján Tomko wrote:
On Tue, Jul 17, 2018 at 05:47:32PM +0200, Katerina Koukiou wrote:
Although the name of the element is not self-explanatory, it's affecting only the vcpu threads.
Signed-off-by: Katerina Koukiou <kkoukiou@redhat.com> --- docs/formatdomain.html.in | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 7fa448acdc..61930e4907 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -831,11 +831,11 @@ <dd> The optional <code>quota</code> element specifies the maximum allowed bandwidth(unit: microseconds). A domain with <code>quota</code> as any
There is a missing space before the parenthesis here, and it's copied multiple times for all the similar attributes. It's a good indicator that we should only write the repetititive text once, and collect the differences in a neat table, e.g.:
+---------------+----------------+---------+-------------------------+ + quota element | period element | affects | since | +---------------+----------------+---------+-------------------------+ + quota | period | vCPUs | 0.9.4, LXC since 0.9.10 | + global_guota | global_period | all | ... | +---------------+----------------+---------+-------------------------+
(But, of course, even this change is better than nothing)
Yes, this approach looks indeed cleaner. I 'll merge this patch with Fabianos/Erics comment and I 'll keep moving to table format as a followup.
Jano
- 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. A quota with value 0 means no - value. You can use this feature to ensure that all vcpus run at the same - speed.
participants (4)
-
Erik Skultety -
Fabiano Fidêncio -
Ján Tomko -
Katerina Koukiou