diff mbox series

[v2,3/4] tools/xenstore: add documentation for new set/get-quota commands

Message ID 20220527072427.20327-4-jgross@suse.com (mailing list archive)
State Superseded
Headers show
Series tools/xenstore: add some new features to the documentation | expand

Commit Message

Jürgen Groß May 27, 2022, 7:24 a.m. UTC
Add documentation for two new Xenstore wire commands SET_QUOTA and
GET_QUOTA used to set or query the global Xenstore quota or those of
a given domain.

Signed-off-by: Juergen Gross <jgross@suse.com>
---
Note that it might be a good idea to add support to the Xenstore
migration protocol to transfer quota data (global and/or per domain).
V2:
- remove feature bit (Julien Grall)
- add possibility to access global quota and to query supported quotas
---
 docs/misc/xenstore.txt | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Julien Grall June 23, 2022, 6:34 p.m. UTC | #1
Hi Juergen,

On 27/05/2022 08:24, Juergen Gross wrote:
> Add documentation for two new Xenstore wire commands SET_QUOTA and
> GET_QUOTA used to set or query the global Xenstore quota or those of
> a given domain.
> 
> Signed-off-by: Juergen Gross <jgross@suse.com>
> ---
> Note that it might be a good idea to add support to the Xenstore
> migration protocol to transfer quota data (global and/or per domain).

I think this is needed because a user may have configured a domain with 
quotas above the default. After Live-Update, we would have a short 
window where the domain may not function properly.

I think it would be good to documentation the migration part in this 
patch. But if you want do it separately then:

Reviewed-by: Julien Grall <jgrall@amazon.com>

Cheers,
Jürgen Groß June 24, 2022, 5:24 a.m. UTC | #2
On 23.06.22 20:34, Julien Grall wrote:
> Hi Juergen,
> 
> On 27/05/2022 08:24, Juergen Gross wrote:
>> Add documentation for two new Xenstore wire commands SET_QUOTA and
>> GET_QUOTA used to set or query the global Xenstore quota or those of
>> a given domain.
>>
>> Signed-off-by: Juergen Gross <jgross@suse.com>
>> ---
>> Note that it might be a good idea to add support to the Xenstore
>> migration protocol to transfer quota data (global and/or per domain).
> 
> I think this is needed because a user may have configured a domain with quotas 
> above the default. After Live-Update, we would have a short window where the 
> domain may not function properly.
> 
> I think it would be good to documentation the migration part in this patch. But 
> if you want do it separately then:
> 
> Reviewed-by: Julien Grall <jgrall@amazon.com>

Thanks.

I think I will add another patch documenting all of the needed migration
stream additions.


Juergen
diff mbox series

Patch

diff --git a/docs/misc/xenstore.txt b/docs/misc/xenstore.txt
index 00f6969202..49b05e3c9a 100644
--- a/docs/misc/xenstore.txt
+++ b/docs/misc/xenstore.txt
@@ -345,6 +345,23 @@  SET_FEATURE		<domid>|<value>|
 	xenstored prevents the use of GET_FEATURE and SET_FEATURE other
 	than by dom0.
 
+GET_QUOTA		[[<domid>|]<quota>|]	<value>|
+SET_QUOTA		[<domid>|]<quota>|<value>|
+	Returns or sets a quota value for the domain being specified by
+	<domid>. Omitting <domid> will return or set the global quota
+	values, which are the default values for new domains. <quota> is
+	 one of "nodes", "watches", "transactions", "node-size",
+	"permissions", or any other implementation defined value. For
+	GET_QUOTA it is possible to omit the <quota> parameter together
+	with the <domid> parameter, which will return a single string of
+	all supported <quota> values separated by blanks. <value> is a
+	decimal number specifying the quota value, with "0" having the
+	special meaning of quota checks being disabled. The initial quota
+	settings for a domain are the global ones of Xenstore.
+
+	xenstored prevents the use of GET_QUOTA and SET_QUOTA other
+	than by dom0.
+
 ---------- Miscellaneous ----------
 
 CONTROL			<command>|[<parameters>|]