Compare commits

..

10 commits

5 changed files with 65 additions and 28 deletions

View file

@ -13,10 +13,12 @@ SRCD := src
SRC_QEMU_HOME := qemu
SRC_QEMU_BIN := $(SRC_QEMU_HOME)/bin
SRC_LAUNCHERSD := $(SRC_QEMU_HOME)/launchers
SRC_TMUX_CONF := $(SRC_QEMU_HOME)/tmux.conf
# Actual qemu Unix user home
QEMU_HOME := $(shell echo ~$(QEMU_USER))
QEMU_BIN := $(QEMU_HOME)/bin
LAUNCHERSD := $(QEMU_HOME)/launchers
TMUX_CONF := $(QEMU_HOME)/.tmux.conf
# Names of all qemush modules
SRC_MODULES_NAMES := $(notdir $(wildcard $(SRC_QEMU_BIN)/*))
@ -40,10 +42,10 @@ SRC_C_SOURCES_NAMES := $(notdir $(basename $(wildcard $(SRCD)/*$(SRC_FMT))))
C_BINARIES := $(addprefix $(QEMU_BIN)/,$(SRC_C_SOURCES_NAMES))
# Directories in ~qemu necessary for qemush to work
QEMUSH_DIRS_NAMES := bin launchers images
QEMUSH_DIRS_NAMES := bin launchers disks
QEMUSH_DIRS := $(addprefix $(QEMU_HOME)/,$(QEMUSH_DIRS_NAMES))
install: $(QEMUSH_DIRS) $(MODULES) $(C_BINARIES) $(QEMUSH) $(LAUNCHERS)
install: $(QEMUSH_DIRS) $(MODULES) $(C_BINARIES) $(QEMUSH) $(LAUNCHERS) $(TMUX_CONF)
$(QEMUSH_DIRS):
$(SUDO_QEMU) mkdir -p $@
@ -61,3 +63,6 @@ $(C_BINARIES): $(QEMU_BIN)%: $(SRCD)%$(SRC_FMT)
$(LAUNCHERS): $(LAUNCHERSD)%: $(SRC_LAUNCHERSD)%
$(SUDO_QEMU) install -m $(BINS_MODE) $^ $@
$(TMUX_CONF): $(SRC_TMUX_CONF)
$(SUDO_QEMU) install -m 640 $^ $@

View file

@ -33,29 +33,27 @@ the same virtual machines
- **Modularization**: `qemush` launching scripts are intended to be
stackable to reuse common `qemu` parameters in all virtual machines
needing them
- **Process supervision**: `qemush` uses `screen` to supervise processes
and keep track of them
- **Process supervision**: `qemush` uses `tmux` to supervise processes and
keep track of them
- **Copy-on-write**: images are formatted using `qcow2` to use less space
on disk
## Dependencies
All dependencies are common packages for a distribution, you'll be able to
grab them from your packages sources.
grab them from your favorite packages sources.
- `qemu` - this is literally a QEMU wrapper so there's a chance you'll
need it
- `bash` - the `qemush` interpreter
- `coreutils` - used for basic OS operations
- `sudo` - execute commands as `qemu`
- `screen` - for process supervision
- `tmux` - for process supervision
- `source-highlight` - for syntax highlighting when displaying launching
scripts
- `pathof` - see [Installation instructions](#installation-instructions)
- any text editor - used for builtin function to edit launching scripts
You can run `qemush depcheck` to check if all dependencies are met.
## Installation instructions
### QEMU user and group

View file

@ -1,5 +1,7 @@
#!/bin/bash
# version=0.2.0
# Function to re-exec the script as another user via sudo (only if needed)
exec_as() {
local user
user="$1"
@ -10,13 +12,19 @@ exec_as() {
fi
}
# Exec the script as qemu
exec_as qemu "$@"
# Directories used in the program
bin="${HOME}/launchers"
images="${HOME}/disks"
# Environment
PATH="${bin}:${HOME}/bin:${PATH}"
EDITOR="${EDITOR:-nvim}"
export QEMUSH_NAME
# Aliases
alias ls='ls --color=auto'
alias exec='exec '
if [ -t 1 ]; then
@ -25,15 +33,20 @@ else
alias pretty_cat=cat
fi
shopt -s expand_aliases
# Set a restrictive umask to make sure qemu user files are private
umask 027
# Function to print a colored error
perror() {
>&2 printf '\033[1;31mERROR:\033[0m \033[1m%s\033[0m\n' "$*"
}
# Function to show the usage
public_help() {
local name
name="$(basename "$0")"
exec cat << EOF
${name}: usage:
${name} active - (default behaviour) list active VMs
@ -53,32 +66,45 @@ ${name}: usage:
EOF
}
# Function to throw an invalid usage error (skill issue)
error_usage() {
perror "Invalid usage"
>&2 public_help
return 1
}
# Function to start a virtual machine ; fails if the virtual machine is
# already started thanks to tmux
public_start() {
QEMUSH_NAME="$1"
shift
exec screen -S "$vm_name" "$vm_name" "$@"
exec tmux new-session \
-s "$QEMUSH_NAME" \
"$QEMUSH_NAME" \
"$@"
}
# Attach to a running virtual machine output, the latest opened if no
# argument is provided
public_watch() {
exec screen -dr "$1"
[ -n "$1" ] && set -- -t "$1"
exec tmux attach "$@"
}
# List running virtual machines
public_active() {
exec screen -ls
exec tmux list-sessions
}
# List available virtual machines entrypoints
public_ls() {
echo "Available machines:"
exec ls "$bin"
}
# Create a copy-on-write disk for a virtual machine
public_diskadd() {
QEMUSH_NAME="$1"
shift
@ -86,6 +112,7 @@ public_diskadd() {
exec qemu-img create -f qcow2 "$(pathof disk)" "$1"
}
# Delete a disk
public_diskrm() {
QEMUSH_NAME="$1"
shift
@ -93,61 +120,61 @@ public_diskrm() {
exec rm -vi -- "$(pathof disk)"
}
# List available disks
public_diskls() {
echo "Available disks:"
exec ls "$images"
}
# Edit a virtual machine entrypoint with a text editor
public_edit() {
local file="${bin}/${1}"
"$EDITOR" "$file"
[ -f "$file" ] && exec chmod u+x "$file"
}
# Delete a virtual machine entrypoint
public_rm() {
exec rm -vi -- "${bin}/${1}"
}
# Invoke bash as qemu user in its home directory
public_shell() {
cd || return
exec bash -i
}
# Output the content of an entrypoint, with coloration if on a virtual
# terminal
public_cat() {
pretty_cat "${bin}/${1}"
}
# Copy a file in entrypoints folder
public_add() {
trap return EXIT
set -e
local name="${2:-$(basename "$1")}"
local name
name="${2:-$(basename "$1")}"
cp -v -i -- "$1" "${bin}/${2}"
chmod 740 "${bin}/${name}"
set +e
trap - EXIT
}
# Run shell commands as qemu
public_do() {
exec sh -c "$*"
}
bold_print() {
printf '\033['"${1}m${2}"'\033[0m: %s\n' "$3"
}
public_depcheck() {
for i in diskpath screen source-highlight ls rm cp chmod cat; do
if command -v "$i" > /dev/null; then
bold_print '1;32' OK "$i"
else
bold_print '1;31' KO "$i"
fi
done
}
# Retrieve user requested function
function="$1"
shift
# Defauts to `active` if no function is supplied; else checks for a public
# function named after the argument; else fails
if [ -z "$function" ]; then
public_active
elif declare -F | cut -d \ -f 3- | grep '^public_' | sed 's/^public_//' | grep -q "^${function}$"; then

View file

@ -6,7 +6,7 @@
# Choose the base dir to print according to argv[1]
case "$1" in
socket)
path=/run/qemush
path="${HOME}/sockets"
;;
disk)
path="${HOME}/disks"
@ -16,5 +16,7 @@ case "$1" in
;;
esac
# Print the base dir and the name of the VM
# Create the base dir if it doesn't exist and print the path of the
# ressource
mkdir -p -- "$path"
printf %s/%s\\n "$path" "$QEMUSH_NAME"

5
qemu/tmux.conf Normal file
View file

@ -0,0 +1,5 @@
# Keep tmux sessions visible after exit
set -g remain-on-exit on
# Override the nologin directive
set -g default-shell /bin/sh