diff --git a/About.md b/About.md index bc9c43f..279fbf5 100644 --- a/About.md +++ b/About.md @@ -1,14 +1,27 @@ **NLVMI** stands for **Native Lightweight Vm Management Interface** +As the name suggests, the goal of this project is to build a lightweight interface for handling KVM in a home or small business environment. -It is composed of a few parts:
-The bash script
-The suid wrapper
-The php interface
-The js helper
-Other parts which are used:
-Bootstrap
-NoVNC
-QEMU
-and a few linux tools
+It uses standard linux tools as much as possible and its code is explicitely written to be easy to understand and extend. +Yes, the code could probably be written nicer in one way or another, but as it seems, more complexity isn't really needed. :-) + +Patches are very welcome! + +As of now, nlvmi is capable of the following things:
+-Defining, starting/stopping vms as unprivileged users (every vm could run as different unix user)
+-Creating (up to 3) tap interfaces and adding them to defined network bridges
+-Handling vms on remote servers via ssh
+-Novnc access to VMs
+ +A few things are planned to get added:
+-handling of qcow images (maybe even minimal lvm management one day)
+-live migration between hosts
+-initd script / systemd unit to start/stop vms on host reboots (autostart can already be achieved via a cron @reboot entry)
+-some server overview with current usage
+-a mac-address generator
+ +These things are not in scope:
+-measuring usage of vms to bill customers or such
+-beeing feature complete. Qemu can do just too much! But there is a custom field for uncommon configurations
+-automatic failover between hosts. That would need a daemon running and we should not reinvent the wheel. Look at DRDB and pacemaker. Patches are welcome to handle the basics of them!