Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools

comparison docs/man/man8/fbhyve.rst @ 474:57f253106ed6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
473:c3125616d0ec 474:57f253106ed6
4 ====== 4 ======
5 5
6 Synopsis 6 Synopsis
7 -------- 7 --------
8 8
9 **service fbhyve** [ **start** | **stop** | **poll** | **status** ] [**name**]... 9 **service fbhyve** [ **start** | **stop** | **restart** | **poll** | **status** ] [**name**]...
10 10
11 11
12 Description 12 Description
13 ----------- 13 -----------
14 14
15 An :file:`rc.d` script to start :manpage:`bhyve(8)` virtual machines 15 An :file:`rc.d` script to start :manpage:`bhyve(8)` virtual machines.
16
17 Every VM is lives its own dedicated :manpage:`tmux(1)` session and has
18 its console windows therein. The sessions have names that are derived from
19 the name of the corresponding VM.
16 20
17 21
18 Configuration Variables 22 Configuration Variables
19 ~~~~~~~~~~~~~~~~~~~~~~~ 23 ~~~~~~~~~~~~~~~~~~~~~~~
20 24
21 `fbhyve_enable` 25 `fbhyve_enable`
26 Act as default for all listed VMs.
22 Default: NO 27 Default: NO
23 28
24 `fbhyve_list` 29 `fbhyve_list`
25 The name of VMs to start to (aka. "profiles" or "sessions") 30 The list of names of VMs to start to (aka. "profiles" or "sessions").
31 Default: empty
32
33 `fbhyve_configdir`
34 Directory where by default the configuration files for all VMs live.
35 Default: :file:`/usr/local/etc/fbhyve`
36
37 `fbhyve_tmux_session_prefix`
38 All tmux session names will have this prefix string. The effective session
39 name will have the VM's name appended.
40
41 Each VM that is listed in `fbhyve_list` can be configured individually with:
42
43 `fbhyve_<vm>_enable`
44 Enable or disable the virtual machine.
45 Default: ``$fbhyve_enable``
46
47 `fbhyve_<vm>_config`
48 The :manpage:`bhyve_config(5)` style configuration file with configuration
49 variables for the virtual machine.
50 Default: ``${fbhyve_configdir}/<vm>.conf``
26 51
27 52
28 Files 53 Files
29 ----- 54 -----
30 55
31 - :file:`/usr/local/etc/fbhyve` 56 - :file:`/var/run/fbhyve`
32 57
33 Default-directory where all the configuration files with relative 58 Directory where some runtime data and PID files are stored.
34 filenames are looked up.
35 59
36 60
37 See also 61 See also
38 -------- 62 --------
39 63
40 :manpage:`bhyve(8)`, :manpage:`rc.conf(5)`, :manpage:`tmux(1)` 64 :manpage:`bhyve(8)`, :manpage:`bhyve_config(5)`, :manpage:`rc.conf(5)`,
65 :manpage:`tmux(1)`