Skip to content

Commit 4d020c4

Browse files
committed
Document preloaded disposables
For: QubesOS/qubes-issues#1512
1 parent 02a9b4f commit 4d020c4

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

doc/manpages/qvm-features.rst

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ boot-mode.name.\*
105105

106106
The user-visible pretty name for a boot mode. The ID of the boot mode with the
107107
given pretty name is specified by the last dot-separated word in the feature
108-
key, while the pretty name is specified by the feature value.
108+
key, while the pretty name is specified by the feature value.
109109

110110
gui
111111
^^^
@@ -184,8 +184,8 @@ internal
184184

185185
Internal qubes (with this feature set to :py:obj:`True`) are not included in the
186186
menu, not available in GUI tools (e.g in Global Settings as a default net qube)
187-
and generally hidden from normal usage. It is not recommended to set this
188-
feature manually.
187+
and generally hidden from normal usage (including not showing as a Qrexec target
188+
for `Ask` rules. It is not recommended to set this feature manually.
189189

190190
Default: not internal VM
191191

@@ -422,6 +422,46 @@ calls. Feature value could contain the rationale for the start ban.
422422
Note: `prohibit-start` for a TemplateVM does not forbid start of AppVMs based
423423
on it.
424424

425+
preload-dispvm-max
426+
^^^^^^^^^^^^^^^^^^
427+
428+
Number of disposables to preload, accepts only integers. Only evaluated when set
429+
on a disposable template.
430+
431+
When set, it will adjust the number of running preloaded disposables to match
432+
the maximum configured, if there is not enough preloaded disposables, new ones
433+
will be started, if there are more than enough, the excess will be removed.
434+
435+
There are some cases where a new disposable won't be preloaded, such as when a
436+
preloaded disposable is killed before being used or when the amount of available
437+
memory on the system is less than enough to preload a new disposable, it will
438+
skip creation. It is possible to resume from this state by setting this feature
439+
again to the same value and it will try to preload the difference.
440+
441+
Default: `0`
442+
443+
preload-dispvm
444+
^^^^^^^^^^^^^^
445+
446+
Space separated list of preloaded disposables of a disposable template. This
447+
feature is set automatically after `preload-dispvm-max`, thus not intended to be
448+
modified manually. Preloaded disposables are disposables that start and run in
449+
the background waiting for use, when requesting a fresh disposable, there is no
450+
waiting time for the qube to start.
451+
452+
Preloaded disposables have its GUI applications entries hidden and are paused to
453+
avoid user mistakes, as it is not intended to use them directly. To use them,
454+
target the disposable template to start a service in a disposable, instead of
455+
creating a new disposable, calls will be redirected to the preloaded disposable.
456+
As soon as the preloaded disposable is requested to be used, it is removed from
457+
the `preload-dispvm` list, GUI applications entries become visible, followed by
458+
a new disposable being preloaded.
459+
460+
.. warning::
461+
462+
Applications configured to autostart by the disposable template or the
463+
template itself will be shown before the preloaded disposable can be paused.
464+
425465
custom-persist.*
426466
^^^^^^^^^^^^^^^^
427467

0 commit comments

Comments
 (0)