Skip to content

Commit

Permalink
deploy: 3692c11
Browse files Browse the repository at this point in the history
  • Loading branch information
astro committed Jun 27, 2024
1 parent 4272ab7 commit 736e29d
Show file tree
Hide file tree
Showing 5 changed files with 176 additions and 154 deletions.
43 changes: 27 additions & 16 deletions host-options.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ <h2 id="microvmautostart"><a class="header" href="#microvmautostart">microvm.aut
<code>[ ]</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmhostenable"><a class="header" href="#microvmhostenable">microvm.host.enable</a></h2>
<p>Whether to enable the microvm.nix host module.</p>
Expand All @@ -192,7 +192,7 @@ <h2 id="microvmhostenable"><a class="header" href="#microvmhostenable">microvm.h
<code>true</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmhosttapscript"><a class="header" href="#microvmhosttapscript">microvm.host.tapScript</a></h2>
<p>Commands to run after creating a tap interface</p>
Expand All @@ -210,7 +210,7 @@ <h2 id="microvmhosttapscript"><a class="header" href="#microvmhosttapscript">mic
</code></pre>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmhostusenotifysockets"><a class="header" href="#microvmhostusenotifysockets">microvm.host.useNotifySockets</a></h2>
<p>Enable if all your MicroVMs run with a Hypervisor that sends readiness notification over a VSOCK.</p>
Expand All @@ -222,7 +222,7 @@ <h2 id="microvmhostusenotifysockets"><a class="header" href="#microvmhostusenoti
<code>false</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmstatedir"><a class="header" href="#microvmstatedir">microvm.stateDir</a></h2>
<p>Directory that contains the MicroVMs</p>
Expand All @@ -232,7 +232,7 @@ <h2 id="microvmstatedir"><a class="header" href="#microvmstatedir">microvm.state
<code>&quot;/var/lib/microvms&quot;</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvirtiofsdextraargs"><a class="header" href="#microvmvirtiofsdextraargs">microvm.virtiofsd.extraArgs</a></h2>
<p>Extra command-line switch to pass to virtiofsd.</p>
Expand All @@ -242,7 +242,7 @@ <h2 id="microvmvirtiofsdextraargs"><a class="header" href="#microvmvirtiofsdextr
<code>[ ]</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvirtiofsdinodefilehandles"><a class="header" href="#microvmvirtiofsdinodefilehandles">microvm.virtiofsd.inodeFileHandles</a></h2>
<p>When to use file handles to reference inodes instead of O_PATH file descriptors
Expand All @@ -256,7 +256,18 @@ <h2 id="microvmvirtiofsdinodefilehandles"><a class="header" href="#microvmvirtio
<code>null</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvirtiofsdthreadpoolsize"><a class="header" href="#microvmvirtiofsdthreadpoolsize">microvm.virtiofsd.threadPoolSize</a></h2>
<p>The amounts of threads virtiofsd should spawn. This option also takes the special
string <code>\</code>nproc`` which spawns as many threads as the host has cores.</p>
<p><em>Type:</em>
string or (unsigned integer, meaning &gt;=0)</p>
<p><em>Default:</em>
<code>&quot;`nproc`&quot;</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvms"><a class="header" href="#microvmvms">microvm.vms</a></h2>
<p>The MicroVMs that shall be built declaratively with the host NixOS.</p>
Expand All @@ -266,7 +277,7 @@ <h2 id="microvmvms"><a class="header" href="#microvmvms">microvm.vms</a></h2>
<code>{ }</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnameautostart"><a class="header" href="#microvmvmsnameautostart">microvm.vms.&lt;name&gt;.autostart</a></h2>
<p>Add this MicroVM to config.microvm.autostart?</p>
Expand All @@ -276,7 +287,7 @@ <h2 id="microvmvmsnameautostart"><a class="header" href="#microvmvmsnameautostar
<code>true</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnameconfig"><a class="header" href="#microvmvmsnameconfig">microvm.vms.&lt;name&gt;.config</a></h2>
<p>A specification of the desired configuration of this MicroVM,
Expand All @@ -287,7 +298,7 @@ <h2 id="microvmvmsnameconfig"><a class="header" href="#microvmvmsnameconfig">mic
<code>null</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnameflake"><a class="header" href="#microvmvmsnameflake">microvm.vms.&lt;name&gt;.flake</a></h2>
<p>Source flake for declarative build</p>
Expand All @@ -297,7 +308,7 @@ <h2 id="microvmvmsnameflake"><a class="header" href="#microvmvmsnameflake">micro
<code>null</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnamenixpkgs"><a class="header" href="#microvmvmsnamenixpkgs">microvm.vms.&lt;name&gt;.nixpkgs</a></h2>
<p>This option is only respected when <code>config</code> is specified.
Expand All @@ -308,7 +319,7 @@ <h2 id="microvmvmsnamenixpkgs"><a class="header" href="#microvmvmsnamenixpkgs">m
<code>pkgs.path</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnamepkgs"><a class="header" href="#microvmvmsnamepkgs">microvm.vms.&lt;name&gt;.pkgs</a></h2>
<p>This option is only respected when <code>config</code> is specified.
Expand All @@ -320,7 +331,7 @@ <h2 id="microvmvmsnamepkgs"><a class="header" href="#microvmvmsnamepkgs">microvm
<code>pkgs</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnamerestartifchanged"><a class="header" href="#microvmvmsnamerestartifchanged">microvm.vms.&lt;name&gt;.restartIfChanged</a></h2>
<p>Restart this MicroVM’s services if the systemd units are changed,
Expand All @@ -332,7 +343,7 @@ <h2 id="microvmvmsnamerestartifchanged"><a class="header" href="#microvmvmsnamer
<code>false</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnamespecialargs"><a class="header" href="#microvmvmsnamespecialargs">microvm.vms.&lt;name&gt;.specialArgs</a></h2>
<p>This option is only respected when <code>config</code> is specified.
Expand All @@ -345,7 +356,7 @@ <h2 id="microvmvmsnamespecialargs"><a class="header" href="#microvmvmsnamespecia
<code>{ }</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>
<h2 id="microvmvmsnameupdateflake"><a class="header" href="#microvmvmsnameupdateflake">microvm.vms.&lt;name&gt;.updateFlake</a></h2>
<p>Source flake to store for later imperative update</p>
Expand All @@ -355,7 +366,7 @@ <h2 id="microvmvmsnameupdateflake"><a class="header" href="#microvmvmsnameupdate
<code>null</code></p>
<p><em>Declared by:</em></p>
<ul>
<li><a href="file:///nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix">/nix/store/n6n856yah6frs22scpc98g36lv16vn6p-source/nixos-modules/host/options.nix</a></li>
<li><a href="file:///nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix">/nix/store/8vdjpb2vj615mz7d4z4zhry8f1yanfj9-source/nixos-modules/host/options.nix</a></li>
</ul>

</main>
Expand Down
Loading

0 comments on commit 736e29d

Please sign in to comment.