From 4883c265475f80c6b5fd0e9c3ee66e7de341bdd4 Mon Sep 17 00:00:00 2001 From: Jeff Carr Date: Thu, 7 Nov 2024 07:32:41 -0600 Subject: so it shows up on pkg.go.dev Signed-off-by: Jeff Carr --- README | 34 ---------------------------------- README.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 34 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index ed285cf..0000000 --- a/README +++ /dev/null @@ -1,34 +0,0 @@ -virtigo: a control panel for your virtual machine cluster - -This is an attempt to make something that should: - -* Maintain the master list of virtual machines that should be running at all times -* Work with a cluster of dom0 hypervisiors via libvirt and/or qemu -* Understand the cluster and autostart droplets that have failed -* Initiate and Handle all droplet events: start, stop, clone, migrate, etc -* Verify consistancy on the hypervisors -* Initiate and handle live migrations between hypervisors -* Talk to the hypervisors using only the virtigo daemon via protobuf -* Work in GUI mode (GTK/QT/etc) but ALSO the console (ncurses) -* GPL'd with the intent for use with homelab and personal hobbyists - -Notes & Goals: - -* Be super easy to use. -* Automatically map access to serial and graphical consoles -* Only temporarily generate libvirt XML files for virsh create -* This is intended for managing Virtual Machines, not for containers -* This often uses the DO nomenclature 'droplets' instead of 'virtual machines' or 'domU' -* Every droplet is considered hostile -* When possible, use protobuf -* Let security be handled externally at the socket layer with other tools -* Put network, cpu, etc stats in external tools -* Automatic live migration to decommission nodes -* Implement iptable rules via the virtigo daemon - -Inspired by: - -* kvm -* virt-manager -* golang -* the simplicity of the DO droplet control panel diff --git a/README.md b/README.md new file mode 100644 index 0000000..54684dc --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# virtigo: a control panel for your virtual machine cluster + +There is no greater thrill for a linux sys admin than running your own cloud. + +# This is an attempt to make something that should: + +* Maintain the master list of virtual machines that should be running at all times +* Work with a cluster of dom0 hypervisiors via libvirt and/or qemu +* Understand the cluster and autostart droplets that have failed +* Initiate and Handle all droplet events: start, stop, clone, migrate, etc +* Verify consistancy on the hypervisors +* Initiate and handle live migrations between hypervisors +* Talk to the hypervisors using only the virtigo daemon via protobuf +* Work in GUI mode (GTK/QT/etc) but ALSO the console (ncurses) +* GPL'd with the intent for use with homelab and personal hobbyists + +# Notes & Goals: + +* Be super easy to use. +* Automatically map access to serial and graphical consoles +* Only temporarily generate libvirt XML files for virsh create +* This is intended for managing Virtual Machines, not for containers +* This often uses the DO nomenclature 'droplets' instead of 'virtual machines' or 'domU' +* Every droplet is considered hostile +* When possible, use protobuf +* Let security be handled externally at the socket layer with other tools +* Put network, cpu, etc stats in external tools +* Automatic live migration to decommission nodes +* Implement iptable rules via the virtigo daemon + +# Inspired by: + +* kvm +* virt-manager +* golang +* the simplicity of the DO droplet control panel -- cgit v1.2.3