Categorygithub.com/zinrai/kvm-vm-bare
repositorypackage
0.1.0
Repository: https://github.com/zinrai/kvm-vm-bare.git
Documentation: pkg.go.dev
Overview
Dependencies
8
Dependents
0

# README

kvm-vm-bare

kvm-vm-bare is a command-line tool that simplifies the process of creating empty virtual machines using KVM (Kernel-based Virtual Machine). This tool is designed for users who need to quickly set up base VMs without an operating system installed.

Features

  • Create empty VMs with customizable resources
  • Support for both BIOS and UEFI boot modes
  • Optional Secure Boot support for UEFI
  • Flexible network configuration

Prerequisites

Before using this tool, ensure you have the following installed on your system:

  • sudo
  • virsh
  • qemu-img
  • virt-install
  • ovmf ( for UEFI boot support )

Installation

Build the tool:

$ go build

Usage

The basic syntax for using the tool is:

$ ./kvm-vm-bare [OPTIONS] VM_NAME

Examples:

Create a VM with default settings ( BIOS boot ):

$ ./kvm-vm-bare myvm

Create a VM with custom resources:

$ ./kvm-vm-bare -size 30G -memory 2048 -vcpus 2 myvm

Create a VM with UEFI boot:

$ ./kvm-vm-bare -efi myvm

Create a VM with UEFI Secure Boot enabled:

$ ./kvm-vm-bare -efi -secureboot myvm

Create a VM with a specific bridge network:

$ ./kvm-vm-bare -network bridge=br0 myvm

Network Configuration

You can specify the network configuration using the -network option. The value should be in the format accepted by virt-install's --network option. For example:

  • bridge=BRIDGE: Connect to a bridge device
  • network=NAME: Connect to a virtual network

Boot Configuration

The tool supports different boot modes:

  • Default BIOS boot: No additional flags required
  • UEFI boot: Use the -efi flag
  • UEFI Secure Boot: Use both -efi and -secureboot flags

Note that Secure Boot requires UEFI boot to be enabled. The tool will prevent enabling Secure Boot without UEFI.

Notes

  • This tool requires sudo privileges to run as it needs to create disk images and define VMs.
  • The created VMs are empty and do not have an operating system installed. You'll need to manually install an OS after creation.
  • UEFI Secure Boot requires appropriate OVMF firmware support on your system.

License

This project is licensed under the MIT License - see the LICENSE for details.