https://github.com/devbeno/miniguest

https://github.com/devbeno/miniguest

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/devbeno/miniguest
• Owner: devbeno
• License: gpl-3.0
• Created: 2022-06-20T14:35:22.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-06-20T14:35:56.000Z (over 2 years ago)
• Last Synced: 2024-05-10T23:09:54.187Z (8 months ago)
• Language: Nix
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING.GPL3

Awesome Lists containing this project

README

        
# Low-footprint NixOS images

Miniguest makes lightweight [NixOS] guest images for popular virtualisation

tools.  The guest systems live entirely on the host's Nix store.  The host

system does not need to be NixOS.

## How lightweight?

Lighter than if it were the host system.  There is no disk image, no 

bootloader, no ISO.  Just plain immutable files that are friendly to Nix's

deduplication mechanisms.

## Getting started

You can read the [Installation guide], then the [Usage guide].

## Support Vector

QEMU virtual machines and Linux containers are supported.

For VMs, [Libvirt] integration is present. For containers, Miniguest can

produce templates in [LXC] format.

## Related work

- [`nixos-container`](https://nixos.org/manual/nixos/stable#ch-containers):

  Miniguest takes inspiration from NixOS's containers, however, containers 

  wraps `systemd-nspawn`, whereas Miniguest delegates container management

  to any supported hypervisor.

  

- `nixos-rebuild build-vm`:

  Miniguest borrows the store-sharing mechanism from NixOS's built-in

  lightweight QEMU VMs when applicable, but it lets a framework take care of

  the VM configuration and lifecycle.

[NixOS]: https://nixos.org

[Libvirt]: https://libvirt.org

[LXC]: https://linuxcontainers.org/lxc/introduction/

[Installation guide]: ./INSTALL.md

[Usage guide]: ./USAGE.md