@@ -533,15 +533,17 @@ <h2 id="configure-microvmhypervisor-use-microvmdeclaredrunner"><a class="header"
533533< code > microvm.hypervisor</ code > option can be wrong when you pick from
534534< code > microvm.runners</ code > directly. One example would be the defaults set by
535535< code > microvm.optimize</ code > .</ p >
536- < div style ="break-before: page; page-break-before: always; "> </ div > < h2 id ="microvmballoonmem "> < a class ="header " href ="#microvmballoonmem "> microvm.balloonMem</ a > </ h2 >
537- < p > Amount of balloon memory in megabytes</ p >
538- < p > The way virtio-balloon works is that this is the memory size
539- that the host can request to be freed by the VM. Initial
540- booting of the VM allocates mem+balloonMem megabytes of RAM.</ p >
536+ < div style ="break-before: page; page-break-before: always; "> </ div > < h2 id ="microvmballoon "> < a class ="header " href ="#microvmballoon "> microvm.balloon</ a > </ h2 >
537+ < p > Whether to enable ballooning.</ p >
538+ < p > By “inflating” or increasing the balloon the host can reduce the VMs
539+ memory amount and reclaim it for itself.
540+ When “deflating” or decreasing the balloon the host can give the memory
541+ back to the VM.</ p >
542+ < p > virtio-mem is recommended over ballooning if supported by the hypervisor.</ p >
541543< p > < em > Type:</ em >
542- signed integer </ p >
544+ boolean </ p >
543545< p > < em > Default:</ em >
544- < code > 0 </ code > </ p >
546+ < code > false </ code > </ p >
545547< p > < em > Declared by:</ em > </ p >
546548< ul >
547549< li > < a href ="https://github.com/astro/microvm.nix/tree/main/nixos-modules/microvm/options.nix "> microvm.nix/nixos-modules/microvm/options.nix</ a > </ li >
@@ -798,6 +800,28 @@ <h2 id="microvmguestenable"><a class="header" href="#microvmguestenable">microvm
798800< ul >
799801< li > < a href ="https://github.com/astro/microvm.nix/tree/main/nixos-modules/microvm/options.nix "> microvm.nix/nixos-modules/microvm/options.nix</ a > </ li >
800802</ ul >
803+ < h2 id ="microvmhotplugmem "> < a class ="header " href ="#microvmhotplugmem "> microvm.hotplugMem</ a > </ h2 >
804+ < p > Amount of hotplug memory in megabytes.</ p >
805+ < p > This describes the maximum amount of memory that can be dynamically added to the VM with virtio-mem.</ p >
806+ < p > < em > Type:</ em >
807+ unsigned integer, meaning >=0</ p >
808+ < p > < em > Default:</ em >
809+ < code > 0</ code > </ p >
810+ < p > < em > Declared by:</ em > </ p >
811+ < ul >
812+ < li > < a href ="https://github.com/astro/microvm.nix/tree/main/nixos-modules/microvm/options.nix "> microvm.nix/nixos-modules/microvm/options.nix</ a > </ li >
813+ </ ul >
814+ < h2 id ="microvmhotpluggedmem "> < a class ="header " href ="#microvmhotpluggedmem "> microvm.hotpluggedMem</ a > </ h2 >
815+ < p > Amount of hotplugged memory in megabytes.</ p >
816+ < p > This basically describes the amount of hotplug memory the VM starts with.</ p >
817+ < p > < em > Type:</ em >
818+ unsigned integer, meaning >=0</ p >
819+ < p > < em > Default:</ em >
820+ < code > 0</ code > </ p >
821+ < p > < em > Declared by:</ em > </ p >
822+ < ul >
823+ < li > < a href ="https://github.com/astro/microvm.nix/tree/main/nixos-modules/microvm/options.nix "> microvm.nix/nixos-modules/microvm/options.nix</ a > </ li >
824+ </ ul >
801825< h2 id ="microvmhugepagemem "> < a class ="header " href ="#microvmhugepagemem "> microvm.hugepageMem</ a > </ h2 >
802826< p > Whether to use hugepages as memory backend.
803827(Currently only respected if using cloud-hypervisor)</ p >
@@ -820,6 +844,16 @@ <h2 id="microvmhypervisor"><a class="header" href="#microvmhypervisor">microvm.h
820844< ul >
821845< li > < a href ="https://github.com/astro/microvm.nix/tree/main/nixos-modules/microvm/options.nix "> microvm.nix/nixos-modules/microvm/options.nix</ a > </ li >
822846</ ul >
847+ < h2 id ="microvminitialballoonmem "> < a class ="header " href ="#microvminitialballoonmem "> microvm.initialBalloonMem</ a > </ h2 >
848+ < p > Amount of initial balloon memory in megabytes.</ p >
849+ < p > < em > Type:</ em >
850+ unsigned integer, meaning >=0</ p >
851+ < p > < em > Default:</ em >
852+ < code > 0</ code > </ p >
853+ < p > < em > Declared by:</ em > </ p >
854+ < ul >
855+ < li > < a href ="https://github.com/astro/microvm.nix/tree/main/nixos-modules/microvm/options.nix "> microvm.nix/nixos-modules/microvm/options.nix</ a > </ li >
856+ </ ul >
823857< h2 id ="microvminitrdpath "> < a class ="header " href ="#microvminitrdpath "> microvm.initrdPath</ a > </ h2 >
824858< p > Path to the initrd file in the initrd package</ p >
825859< p > < em > Type:</ em >
@@ -911,7 +945,7 @@ <h2 id="microvmkernelparams"><a class="header" href="#microvmkernelparams">micro
911945< h2 id ="microvmmem "> < a class ="header " href ="#microvmmem "> microvm.mem</ a > </ h2 >
912946< p > Amount of RAM in megabytes</ p >
913947< p > < em > Type:</ em >
914- signed integer</ p >
948+ positive integer, meaning >0 </ p >
915949< p > < em > Default:</ em >
916950< code > 512</ code > </ p >
917951< p > < em > Declared by:</ em > </ p >
@@ -1157,7 +1191,7 @@ <h2 id="microvmuser"><a class="header" href="#microvmuser">microvm.user</a></h2>
11571191< h2 id ="microvmvcpu "> < a class ="header " href ="#microvmvcpu "> microvm.vcpu</ a > </ h2 >
11581192< p > Number of virtual CPU cores</ p >
11591193< p > < em > Type:</ em >
1160- signed integer</ p >
1194+ positive integer, meaning >0 </ p >
11611195< p > < em > Default:</ em >
11621196< code > 1</ code > </ p >
11631197< p > < em > Declared by:</ em > </ p >
0 commit comments