Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
diff docs/man/man8/fbhyve.rst @ 474:57f253106ed6
Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Tue, 27 Aug 2024 21:47:57 +0200 |
| parents | 6ecd16725818 |
| children | c3ad1105c746 |
line wrap: on
line diff
--- a/docs/man/man8/fbhyve.rst Mon Aug 26 17:22:26 2024 +0200 +++ b/docs/man/man8/fbhyve.rst Tue Aug 27 21:47:57 2024 +0200 @@ -6,35 +6,60 @@ Synopsis -------- -**service fbhyve** [ **start** | **stop** | **poll** | **status** ] [**name**]... +**service fbhyve** [ **start** | **stop** | **restart** | **poll** | **status** ] [**name**]... Description ----------- -An :file:`rc.d` script to start :manpage:`bhyve(8)` virtual machines +An :file:`rc.d` script to start :manpage:`bhyve(8)` virtual machines. + +Every VM is lives its own dedicated :manpage:`tmux(1)` session and has +its console windows therein. The sessions have names that are derived from +the name of the corresponding VM. Configuration Variables ~~~~~~~~~~~~~~~~~~~~~~~ `fbhyve_enable` + Act as default for all listed VMs. Default: NO `fbhyve_list` - The name of VMs to start to (aka. "profiles" or "sessions") + The list of names of VMs to start to (aka. "profiles" or "sessions"). + Default: empty + +`fbhyve_configdir` + Directory where by default the configuration files for all VMs live. + Default: :file:`/usr/local/etc/fbhyve` + +`fbhyve_tmux_session_prefix` + All tmux session names will have this prefix string. The effective session + name will have the VM's name appended. + +Each VM that is listed in `fbhyve_list` can be configured individually with: + +`fbhyve_<vm>_enable` + Enable or disable the virtual machine. + Default: ``$fbhyve_enable`` + +`fbhyve_<vm>_config` + The :manpage:`bhyve_config(5)` style configuration file with configuration + variables for the virtual machine. + Default: ``${fbhyve_configdir}/<vm>.conf`` Files ----- -- :file:`/usr/local/etc/fbhyve` +- :file:`/var/run/fbhyve` - Default-directory where all the configuration files with relative - filenames are looked up. + Directory where some runtime data and PID files are stored. See also -------- -:manpage:`bhyve(8)`, :manpage:`rc.conf(5)`, :manpage:`tmux(1)` +:manpage:`bhyve(8)`, :manpage:`bhyve_config(5)`, :manpage:`rc.conf(5)`, +:manpage:`tmux(1)`
