openbsd-vmmanager 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,104 @@
1
+ Metadata-Version: 2.4
2
+ Name: openbsd-vmmanager
3
+ Version: 0.1.0
4
+ Summary: A Textual TUI for managing OpenBSD vmd virtual machines
5
+ Author-email: Kasra Madadipouya <kasra@madadipouya.com>
6
+ License-Expression: GPL-3.0-or-later
7
+ Project-URL: Homepage, https://github.com/OpenBSDGuy/vmmanager
8
+ Project-URL: Repository, https://github.com/OpenBSDGuy/vmmanager
9
+ Project-URL: Issues, https://github.com/OpenBSDGuy/vmmanager/issues
10
+ Keywords: openbsd,vmd,vmctl,vm,tui,textual,cli
11
+ Classifier: Environment :: Console
12
+ Classifier: Operating System :: POSIX :: BSD :: OpenBSD
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Topic :: System :: Emulators
15
+ Requires-Python: >=3.11
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: textual>=8.2
19
+ Dynamic: license-file
20
+
21
+ # vmmanager
22
+
23
+ A terminal UI for OpenBSD's vmm/vmd virtual machines. Think VirtualBox, but in a terminal and built on `vmctl` and `vm.conf`: create, start, run, connect, stop, update, delete and migrate VMs, with networking set up for you.
24
+
25
+ ![vmmanager main screen](https://raw.githubusercontent.com/OpenBSDGuy/vmmanager/main/docs/screenshot.png)
26
+
27
+ ## Requirements
28
+
29
+ - OpenBSD (tested on 8.0, amd64) with virtualization enabled in the BIOS
30
+ - Python 3.11+
31
+ - `vmd` running (`rcctl enable vmd && rcctl start vmd`) and the VM BIOS firmware (`fw_update`); vmmanager offers to do both on first run
32
+ - `doas` for creating, changing, deleting and migrating VMs (`permit persist :wheel` in `/etc/doas.conf` saves you a password prompt per step)
33
+
34
+ ## Installation
35
+
36
+ ### Quick install (recommended)
37
+
38
+ ```
39
+ $ pkg_add py3-pipx
40
+ $ pipx install openbsd-vmmanager
41
+ ```
42
+
43
+ Or with pip:
44
+
45
+ ```
46
+ $ pip install openbsd-vmmanager
47
+ ```
48
+
49
+ Then run:
50
+
51
+ ```
52
+ $ vmmanager
53
+ ```
54
+
55
+ ### From source
56
+
57
+ ```
58
+ $ git clone https://github.com/OpenBSDGuy/vmmanager
59
+ $ cd vmmanager
60
+ $ python3 -m venv venv && . venv/bin/activate
61
+ $ pip install -e .
62
+ $ vmmanager
63
+ ```
64
+
65
+ ## First run
66
+
67
+ vmmanager checks the host before showing your VMs and offers a fix for anything missing: `vmd` not running, missing VM firmware, or a VM whose configuration is broken (for example because its folder was deleted by hand). It also offers to install the man pages system-wide.
68
+
69
+ The first time you create a VM with Internet on, vmmanager sets up NAT for VMs once: it writes `/etc/vmmanager/pf.conf` (loaded as a pf anchor from a marked block it adds to `/etc/pf.conf`), turns on IP forwarding, and starts `unwind` if no DNS resolver is running. Every change that needs root is explained first and asks before it runs through `doas`.
70
+
71
+ ## Usage
72
+
73
+ | Key | Action |
74
+ |-----|------------------------------------------------------------------------|
75
+ | n | Create a VM: name, memory, CPUs, disk size, install ISO, Internet on/off |
76
+ | s | Start the VM in the background |
77
+ | r | Run: start the VM and attach its serial console |
78
+ | o | Connect to the console of a running VM |
79
+ | x | Stop the VM (graceful first, then offers a force stop) |
80
+ | e | Update memory, CPUs, ISO and Internet of a stopped VM |
81
+ | d | Delete a stopped VM; asks separately before removing its disk |
82
+ | m | Migrate a VM you wrote by hand in `/etc/vm.conf` into vmmanager |
83
+ | ? | Show the manual page |
84
+ | q | Quit |
85
+ | ~. | Leave a VM console and return to vmmanager |
86
+
87
+ In the ISO browser, `.` shows or hides dot files and folders.
88
+
89
+ ## Notes
90
+
91
+ - Each VM gets its own folder, `~/vmmanager/<name>/`, holding its disk and a small `vmmanager.toml`. Its `vm.conf` block lives in `/etc/vmmanager/<user>/<name>.conf`, which `/etc/vm.conf` includes through one added line.
92
+ - vmmanager never rewrites your hand-written `/etc/vm.conf`. VMs defined there are listed but locked until you migrate them; migration moves the disks, comments out the old block and can be undone by hand (see `vmmanager(8)`, MIGRATING).
93
+ - Every VM vmmanager creates is owned by you (`owner` in `vm.conf`), so vmd itself stops other users from starting, stopping or opening the console of your VMs. They can still see them.
94
+ - Starting, stopping and the console need no root. Writing configuration does, and every write is checked with `vmd -n` and rolled back if it fails.
95
+ - Networking is either on (NAT through the host) or off (no network interface at all, an air-gapped VM).
96
+ - Deleting a VM keeps its folder unless you agree to remove it.
97
+
98
+ ## Manual
99
+
100
+ `vmmanager(8)` covers keys, files, privileges, networking, migration, security and how to uninstall, and `vmmanager.toml(5)` the per-VM file. Read them with `man vmmanager` once installed system-wide (`vmmanager --install-man`), or without installing with `vmmanager --man`.
101
+
102
+ ## License
103
+
104
+ GPL-3.0
@@ -0,0 +1,27 @@
1
+ openbsd_vmmanager-0.1.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
2
+ vmmanager/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
3
+ vmmanager/cli.py,sha256=seEgsk4qouDyuI0OJ60z-kqnbk0w9sWQEyRhlWUVDt8,1328
4
+ vmmanager/confblock.py,sha256=Vr8gNwfCYIBfjjs-vy8psNTrTiNWcvAb1jEwFsjSRF0,8008
5
+ vmmanager/errors.py,sha256=09Bnl9ohzX2XIWzbo7HUWB3GUw9CjztI0NjeDAkLt7Q,177
6
+ vmmanager/health.py,sha256=RN7jujo0wb1TFVU60bx1CfEYNf9lnrZGHCarc6KAebk,3185
7
+ vmmanager/inventory.py,sha256=IYQxI8fyk5eayaWYq35zi8wzkzu5Le7hxnbHDgYRej0,3181
8
+ vmmanager/layout.py,sha256=PFD2eb_r4oW3-h5ReHjrAnNP_2OlczMa-IcAF4C_oeQ,1993
9
+ vmmanager/manpages.py,sha256=C_AexSpEdKyj-yplojvTBAU6y5d3WgaoiodO2rbRCqg,1476
10
+ vmmanager/migrate.py,sha256=4U2bCEHn9eQ2K3FZsxtHw19gHPjeFGkZ_KreakWotdI,7250
11
+ vmmanager/network.py,sha256=7iNJcY7q9SVavZRLj1GBhYay57PyLdnA1d2ONnYBtic,3365
12
+ vmmanager/ops.py,sha256=FM55komN9mya8aGcQvfibyWj6aQbCU69JJWeKva3Zhs,7228
13
+ vmmanager/rootwrite.py,sha256=a_ymeP7T-jB8qzDONFDbgemXgWdFiofguOs1yeKdNKY,2804
14
+ vmmanager/system.py,sha256=rrDHVZ7WYXSWWt_e8Ye0xgSV0XDse7ZPmLLQL4268SQ,3048
15
+ vmmanager/tomlio.py,sha256=CH48GhxycTbfifXyjeb0cCSlpD0fXhGlGzfn2F3cMng,916
16
+ vmmanager/vmctl.py,sha256=Z3i55nAXKfvOZQhahwRcZjLkZjG8mQVXWrG6Lm6LQkU,1885
17
+ vmmanager/man/vmmanager.8,sha256=fwWtiT708qorXpky38gcnjf-SnqSelIj3aAavZvUWkU,12847
18
+ vmmanager/man/vmmanager.toml.5,sha256=Haz8a0uAAbpIt6xV21VjZy1E4p9zNbRsia7zp94DT34,1380
19
+ vmmanager/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
20
+ vmmanager/ui/app.py,sha256=5I7GOr3XwAfMl2yVO3N2IBWa8paaXviYUA4uj162ugU,16429
21
+ vmmanager/ui/dialogs.py,sha256=wPMxDpB2menqNicdYxaPY0WFplEYmMtYzMjx4Avwjqc,5779
22
+ vmmanager/ui/forms.py,sha256=CH1QO8_W678omKhn6wncr4dkO0iTUAxEW7zEfEw4C0E,5743
23
+ openbsd_vmmanager-0.1.0.dist-info/METADATA,sha256=6D9mzozOUTUCtCKPukQyw0KufI3eQRfxTZ5r0SpFtm4,4933
24
+ openbsd_vmmanager-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
25
+ openbsd_vmmanager-0.1.0.dist-info/entry_points.txt,sha256=YGt-vBhgU3aty0lh6I6Z4IT1JTayJD1OzqOfu4HsvPo,49
26
+ openbsd_vmmanager-0.1.0.dist-info/top_level.txt,sha256=GUqoQSpKVkKPkWa2VQmMXnyly2pSLVAJuQvWUY3WV1o,10
27
+ openbsd_vmmanager-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (84.2.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ vmmanager = vmmanager.cli:main