Refresh docs for current VM workflows
Keep the user-facing docs aligned with the current Go control plane instead of the older one-VM-at-a-time and ambiguous rootfs rebuild flows. Document concurrent multi-VM lifecycle and set commands, clarify that rebuilt images now include mise plus opencode, and spell out when make rootfs needs an explicit base image. Also update the repo guidelines so future changes keep those behaviors documented.
This commit is contained in:
parent
4e0132982d
commit
8ba920eda6
2 changed files with 23 additions and 1 deletions
22
README.md
22
README.md
|
|
@ -111,6 +111,14 @@ Update stopped VM settings:
|
|||
banger vm set calm-otter --memory 2048 --vcpu 4 --disk-size 32G
|
||||
```
|
||||
|
||||
Lifecycle and `set` actions also accept multiple VM refs and run them
|
||||
concurrently:
|
||||
```bash
|
||||
banger vm stop calm-otter buildbox api-1
|
||||
banger vm kill --signal KILL aa12bb34 cc56dd78
|
||||
banger vm set --nat web-1 web-2 web-3
|
||||
```
|
||||
|
||||
Launch the TUI:
|
||||
```bash
|
||||
banger tui
|
||||
|
|
@ -146,7 +154,7 @@ Useful config keys:
|
|||
- `firecracker_bin`
|
||||
- `ssh_key_path`
|
||||
- `namegen_path`
|
||||
- `customize_script`
|
||||
- `customize_script` (manual helper compatibility; `banger image build` is Go-native)
|
||||
- `default_rootfs`
|
||||
- `default_base_rootfs`
|
||||
- `default_kernel`
|
||||
|
|
@ -174,6 +182,10 @@ Build a managed image:
|
|||
banger image build --name docker-dev --docker
|
||||
```
|
||||
|
||||
Rebuilt images install a pinned `mise` at `/usr/local/bin/mise`, activate it
|
||||
for bash login and interactive shells, and install `opencode` through `mise`
|
||||
by default.
|
||||
|
||||
Show or delete images:
|
||||
```bash
|
||||
banger image show docker-dev
|
||||
|
|
@ -215,6 +227,12 @@ To rebuild the source-checkout default image in `./runtime/rootfs-docker.ext4`:
|
|||
make rootfs
|
||||
```
|
||||
|
||||
If your runtime bundle does not include `./runtime/rootfs.ext4`, pass an
|
||||
explicit base image instead:
|
||||
```bash
|
||||
./make-rootfs.sh --base-rootfs /path/to/base-rootfs.ext4
|
||||
```
|
||||
|
||||
If the package manifest changed and you want a fresh source-checkout image:
|
||||
```bash
|
||||
rm -f ./runtime/rootfs-docker.ext4 ./runtime/rootfs-docker.ext4.packages.sha256
|
||||
|
|
@ -223,6 +241,8 @@ make rootfs
|
|||
|
||||
`make rootfs` expects a bootstrapped runtime bundle. If `./runtime/rootfs.ext4`
|
||||
is not available, pass an explicit `--base-rootfs` to `./make-rootfs.sh`.
|
||||
Existing VMs keep using their current image and disks; rebuilds only affect VMs
|
||||
created from the rebuilt image afterward.
|
||||
|
||||
## Maintaining The Runtime Bundle
|
||||
The checked-in [`runtime-bundle.toml`](/home/thales/projects/personal/banger/runtime-bundle.toml)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue