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

annotate docs/man/man8/fbhyve.rst @ 807:ed94334bc6f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fports: Update manual pages to show the now current syntax
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 05 Nov 2024 11:18:52 +0100
parents 3f187ec5c4d9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fbhyve
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ======
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
476
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
9 **service fbhyve** [ **start** | **stop** | **restart** | **kill** | **poll** | **status** ] [**name**]...
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 Description
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 -----------
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
474
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
15 An :file:`rc.d` script to start :manpage:`bhyve(8)` virtual machines.
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
16
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
17 Every VM is lives its own dedicated :manpage:`tmux(1)` session and has
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
18 its console windows therein. The sessions have names that are derived from
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
19 the name of the corresponding VM.
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21
476
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
22 Extra Commands
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
23 ~~~~~~~~~~~~~~
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
24
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
25 The extra command ``kill`` is like switching the power off immediately.
477
3f187ec5c4d9 Extra support for "forcestart" in fbhyve
Franz Glasner <fzglas.hg@dom66.de>
parents: 476
diff changeset
26 It can also be used to cleanup if some spurious artifacts have been left
3f187ec5c4d9 Extra support for "forcestart" in fbhyve
Franz Glasner <fzglas.hg@dom66.de>
parents: 476
diff changeset
27 around that hinder normal starts.
476
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
28
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
29 The ``stop`` command initiates a clean shutdown by properly terminating
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
30 :manpage:`bhyve(8)` with `SIGTERM`.
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
31
c3ad1105c746 Implement a "kill" extra-commant for fbhyve to do an immediate poweroff of a VM
Franz Glasner <fzglas.hg@dom66.de>
parents: 474
diff changeset
32
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 Configuration Variables
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 ~~~~~~~~~~~~~~~~~~~~~~~
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 `fbhyve_enable`
474
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
37 Act as default for all listed VMs.
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38 Default: NO
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 `fbhyve_list`
474
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
41 The list of names of VMs to start to (aka. "profiles" or "sessions").
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
42 Default: empty
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
43
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
44 `fbhyve_configdir`
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
45 Directory where by default the configuration files for all VMs live.
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
46 Default: :file:`/usr/local/etc/fbhyve`
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
47
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
48 `fbhyve_tmux_session_prefix`
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
49 All tmux session names will have this prefix string. The effective session
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
50 name will have the VM's name appended.
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
51
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
52 Each VM that is listed in `fbhyve_list` can be configured individually with:
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
53
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
54 `fbhyve_<vm>_enable`
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
55 Enable or disable the virtual machine.
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
56 Default: ``$fbhyve_enable``
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
57
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
58 `fbhyve_<vm>_config`
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
59 The :manpage:`bhyve_config(5)` style configuration file with configuration
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
60 variables for the virtual machine.
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
61 Default: ``${fbhyve_configdir}/<vm>.conf``
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64 Files
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65 -----
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66
474
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
67 - :file:`/var/run/fbhyve`
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68
474
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
69 Directory where some runtime data and PID files are stored.
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
72 See also
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
73 --------
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
74
474
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
75 :manpage:`bhyve(8)`, :manpage:`bhyve_config(5)`, :manpage:`rc.conf(5)`,
57f253106ed6 Implement fbhyve, a management system that runs bhyve virtual machines within tmux sessions
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
76 :manpage:`tmux(1)`