From 31bea730921f4ed633d4d8c76fd7a6fa235172ea Mon Sep 17 00:00:00 2001 From: Pavel 'LEdoian' Turinsky Date: Thu, 20 Jul 2023 20:17:48 +0200 Subject: [PATCH] Update readme, so this is shippable. --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d511772..849e3b4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,28 @@ This is a simple tool to generate testing networks of virtual machines. It was -written primarilly for my bachelor's thesis. +written primarilly for my bachelor's thesis, which lives at . # Usage: 1. Edit `gen_machines.py` to define the desired network -2. Optionally edit the templates of config files -3. Run it -4. Create pre-installed Alpine Linux 3.15.4 disk image in `dummydisk.img` (you can use `gen_dummy.sh` for that) +2. Optionally edit the templates of config files in the `templates/` folder +3. Run `gen_machines.py` +4. Create pre-installed Alpine Linux 3.15.4 disk image in `dummydisk.img` + - you can use `gen_dummy.sh` for that + - To automatically install alpine, `alpine_install` can be used as the install script. See comment in that file for explanation + - After installation, `alpine_postinst` sets up the SSH key and add basic packages. 5. Run `gen_disks.sh` as root – this creates customized disk images for all the machines 6. Append `output/bridge.conf` to your `/etc/qemu/bridge.conf` in order to be able to connect your VMs to bridges as regular user 7. Run `output/gen_bridges.sh` to create the bridge interfaces on your machine. + +Now, the machines may be started. Either use `qemu.sh` script in the respective +directory under `output/`, or run `./manage_all.sh start`. To attach, use SPICE +on the `spice.sock`, or SSH there using the key in this repo, if you already +have connectivity. + +Loging in as root should not ask for password. + +Have a lot of fun!`\cite{suse}` + +--- + +The idea behind current addressing system is sketched in `IDEA`.