Skip to content

Latest commit

 

History

History
145 lines (121 loc) · 5.88 KB

README.md

File metadata and controls

145 lines (121 loc) · 5.88 KB
Raw

minivmm

This is a minimal and lightweight virtual machine manager.

Features

  • Tiny installation. The installer will create only below;
    • 1 binary
    • 1 data directory
    • 1 network namespace
    • 1 user/group/sudoers
    • 1 systemd service
  • Embedded simple web UI.

Required packages

yum

# yum install qemu-system-x86 qemu-img seabios iproute genisoimage

pacman

# pacman -S qemu seabios iproute2 cdrkit

Getting started

Installation

# export VMM_ORIGIN=http://<hostname>:14151
# export VMM_NO_TLS=true
# export VMM_NO_AUTH=true
# curl -Lo - https://github.com/rsp9u/minivmm/releases/latest/download/install.sh | sh -

Download a cloud image and put into image direcotry

# curl -Lo /opt/minivmm/images/ubuntu-bionic.img https://cloud-images.ubuntu.com/bionic/current/bionic-server-cloudimg-amd64.img

Create your VM with Web UI

  1. Open http://<hostname>:14151 in your browser.
  2. Create a new VM.
  3. Connect via ssh to the created VM.

Uninstallation

# curl -Lo - https://github.com/rsp9u/minivmm/releases/latest/download/uninstall.sh | sh -
# rm -rf /opt/minivmm (if you'd like to remove all data)

Other installation methods

Standalone

# export VMM_ORIGIN=https://<hostname>:14151
# export VMM_OIDC_URL=https://<OIDCProvidor>:<OIDCProvidorPort>
# export VMM_SERVER_CERT=/path/to/server.crt
# export VMM_SERVER_KEY=/path/to/server.key
# curl -Lo - https://github.com/rsp9u/minivmm/releases/latest/download/install.sh | sh -

Multi-node

Install with UI

# export VMM_ORIGIN=https://<hostname>:14151
# export VMM_OIDC_URL=https://<OIDCProvidor>:<OIDCProvidorPort>
# export VMM_SERVER_CERT=/path/to/server.crt
# export VMM_SERVER_KEY=/path/to/server.key
# curl -Lo - https://github.com/rsp9u/minivmm/releases/latest/download/install.sh | sh -

Install without UI

# export VMMINST_NO_UI=true
# export VMM_OIDC_URL=https://<OIDCProvidor>:<OIDCProvidorPort>
# export VMM_SERVER_CERT=/path/to/server.crt
# export VMM_SERVER_KEY=/path/to/server.key
# export VMM_CORS_ALLOWED_ORIGINS=https://<hostname-UI-installed-in>:14151
# curl -Lo - https://github.com/rsp9u/minivmm/releases/latest/download/install.sh | sh -

Firewall settings

Allow to access to udp:5353 of the earch machines to pass the mDNS packets.

  • e.g. iptables -A INPUT -p udp --dport 5353 -j ACCEPT

Standalone with Docker

if target device with mixed architecture (ARM big.LITTLE), maybe need to add --cpuset-cpus 0-1 to arguments.

$ sudo docker run \
  --name minivmm --rm -itd --privileged --net host \
  -e VMM_ORIGIN=http://localhost:14151 \
  -e VMM_AGENTS=hypervisor1=http://localhost:14151 \
  -e VMM_SUBNET_CIDR=192.168.200.0/24 \
  -e VMM_NO_TLS=true \
  -e VMM_NO_AUTH=true \
  --mount type=bind,source=/run/netns,target=/run/netns,bind-propagation=rshared \
  -v /sys:/sys \
  -v $PWD/data:/opt/minivmm \
    minivmm -ui

Update

# export VMMINST_UPDATE=true
# curl -Lo - https://github.com/rsp9u/minivmm/releases/latest/download/install.sh | sh -

Environments

If you'd like to change environment variables, edit $VMM_DIR/minivmm.environment and restart minivmm service, like below;

# vi /opt/minivmm/minivmm.environment
# systemctl restart minivmm.service
Name Default Description
VMM_DIR '/opt/minivmm' base directory path to store data files
VMM_LISTEN_PORT '14151' listen port
VMM_ORIGIN origin url of minivmm server
VMM_OIDC_URL oidc auth url
VMM_AGENTS agents' API endpoint (comma separated), it works only if VMM_NO_AGENTS_DISCOVER="true"
VMM_CORS_ALLOWED_ORIGINS allowed origin urls (comma separated)
VMM_SUBNET_CIDR '192.168.200.0/24' subnet CIDR for the network containing VMs
VMM_NAME_SERVERS '1.1.1.1,1.0.0.1' domain name servers' address sent via DHCP server (comma separated)
VMM_SERVER_CERT path to the server certificate file
VMM_SERVER_KEY path to the server private key file
VMM_NO_TLS 'false' disable tls if set "true"
VMM_NO_AUTH 'false' skip API authentication if set "true"
VMM_NO_KVM 'false' disable kvm if set "true"
VMM_NO_AGENTS_DISCOVER 'false' disable mDNS-ServiceDiscovery and use VMM_AGENTS
VMM_VNC_KEYBOARD_LAYOUT 'en-us' keyboard layout language for VNC

Installer environments

Name Default Description
VMMINST_VERSION latest minivmm version to be installed
VMMINST_NO_UI false to install without UI
VMMINST_UPDATE false to update minivmm