Add Debian - with the option of running a startup script and...

debian/Makefile

@@ -0,0 +1,18 @@
+VENDOR=Debian
+NAME=Debian
+IMAGE_FORMAT=qcow2
+IMAGE_GLOB=*.qcow2
+
+# match versions like:
+# debian-bookworm-genericcloud.qcow2
+VERSION=$(shell echo $(IMAGE) | sed -e 's/debian-\([a-z]\+\)-genericcloud.*/\1/')
+
+
+-include ../makefile-sanity.include
+-include ../makefile.include
+
+download:
+	/bin/bash download.sh
+
+build: download
+	$(MAKE) docker-image

debian/README.md

@@ -0,0 +1,21 @@
+# Debian VM
+
+To download a compatible image of the Debian VM execute the [download.sh](download.sh) script that will download a cloud-init image of Debian from <https://cloud.debian.org/images/cloud>. The version is set in the script and can be changed manually.
+
+Once the qcow2 image is downloaded, build the container with the following command:
+
+```bash
+make
+```
+
+The resulting container will be tagged as `vrnetlab/vr-debian:<version>`, e.g. `vrnetlab/vr-debian:bookworm`.
+
+## Host requirements
+
+* 1 vCPU, 512 MB RAM
+
+## Configuration
+
+Initial config is carried out via cloud-init.
+
+* `9.9.9.9` configured as the DNS resolver. Change it with `resolvectl` if required.

debian/docker/Dockerfile

@@ -0,0 +1,33 @@
+FROM debian:bookworm-slim
+
+ARG DEBIAN_FRONTEND=noninteractive
+ARG DISK_SIZE=4G
+
+RUN apt-get update -qy \
+   && apt-get install -y \
+   bridge-utils \
+   iproute2 \
+   socat \
+   qemu-kvm \
+   tcpdump \
+   ssh \
+   inetutils-ping \
+   dnsutils \
+   iptables \
+   nftables \
+   telnet \
+   cloud-utils \
+   sshpass \
+   && rm -rf /var/lib/apt/lists/*
+
+ARG IMAGE
+COPY $IMAGE* /
+COPY *.py /
+COPY backup.sh /
+COPY copy_etc_and_run_startupscript.sh /
+
+RUN qemu-img resize /${IMAGE} ${DISK_SIZE}
+
+EXPOSE 22 5000 10000-10099
+HEALTHCHECK CMD ["/healthcheck.py"]
+ENTRYPOINT ["/launch.py"]

debian/docker/backup.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+DEFAULT_USER="admin"
+DEFAULT_PASSWORD="admin"
+BACKUP_FILE="backup.tar.gz"
+BACKUP_PATH=/config/$BACKUP_FILE
+REMOTE_BACKUP_PATH=/tmp/$BACKUP_FILE
+
+handle_args() {
+    # Parse options
+    while getopts 'u:p:' OPTION; do
+        case "$OPTION" in
+            u)
+            user="$OPTARG"
+            ;;
+            p)
+            password="$OPTARG"
+            ;;
+            ?)
+            usage
+            exit 1
+            ;;
+        esac
+    done
+    shift "$(($OPTIND -1))"
+
+    # Assign defaults if options weren't provided
+    if [ -z "$user" ] ; then
+        user=$DEFAULT_USER
+    fi
+    if [ -z "$password" ] ; then
+        password=$DEFAULT_PASSWORD
+    fi
+
+    SSH_CMD="sshpass -p $password ssh -o LogLevel=ERROR -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -p22"
+    SCP_CMD="sshpass -p $password scp -o LogLevel=ERROR -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -P22"
+    HOST="$user@localhost"
+
+    # Parse commands
+    case $1 in
+
+    backup)
+        backup
+        ;;
+
+    restore)
+        restore
+        ;;
+
+    *)
+        usage
+        ;;
+    esac
+}
+
+usage() {
+	echo "Usage: $(basename $0) [-u USERNAME] [-p PASSWORD] COMMAND"
+    echo "Options:"
+    echo "  -u USERNAME    VM SSH username (default: clab)"
+    echo "  -p PASSWORD    VM SSH password (default: clab@123)"
+    echo
+    echo "Commands:"
+    echo "  backup         Backup VM /etc directory to $BACKUP_PATH"
+    echo "  restore        Restore VM /etc directory from $BACKUP_PATH"
+	exit 0;
+}
+
+backup() {
+    echo "Backing up..."
+    $SSH_CMD $HOST "sudo tar zcf $REMOTE_BACKUP_PATH /etc > & /dev/null"
+    $SCP_CMD $HOST:$REMOTE_BACKUP_PATH $BACKUP_PATH
+}
+
+restore() {
+    if [ -f "$BACKUP_PATH" ]; then
+        echo "Restoring from backup..."
+        # Put backup file to VM, untar, and reboot.
+        $SCP_CMD $BACKUP_PATH $HOST:$REMOTE_BACKUP_PATH && $SSH_CMD $HOST "sudo tar xzf $REMOTE_BACKUP_PATH -C /" && $SSH_CMD $HOST "sudo shutdown -r now || true"
+    else 
+        echo "$BACKUP_PATH not found. Nothing to restore."
+    fi
+}
+
+handle_args "$@"

debian/docker/copy_etc_and_run_startupscript.sh

@@ -0,0 +1,89 @@
+#!/bin/bash
+
+DEFAULT_USER="admin"
+DEFAULT_PASSWORD="admin"
+DOCKER_ETC_PATH=/config/etc
+REMOTE_TMP_PATH=/tmp/etc
+# location of startup script in the docker container
+STARTUPSCRIPT=/config/startup.sh
+
+handle_args() {
+    # Parse options
+    while getopts 'u:p:' OPTION; do
+        case "$OPTION" in
+            u)
+            user="$OPTARG"
+            ;;
+            p)
+            password="$OPTARG"
+            ;;
+            ?)
+            usage
+            exit 1
+            ;;
+        esac
+    done
+    shift "$(($OPTIND -1))"
+
+    # Assign defaults if options weren't provided
+    if [ -z "$user" ] ; then
+        user=$DEFAULT_USER
+    fi
+    if [ -z "$password" ] ; then
+        password=$DEFAULT_PASSWORD
+    fi
+
+    SSH_CMD="sshpass -p $password ssh -o LogLevel=ERROR -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -p22"
+    SCP_CMD="sshpass -p $password scp -o LogLevel=ERROR -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -P22"
+    HOST="$user@localhost"
+
+    # Parse commands
+    case $1 in
+
+    startupconfig)
+        startupconfig 
+        ;;
+
+    copyetc)
+        copyetc 
+        ;;
+
+    *)
+        usage
+        ;;
+    esac
+}
+
+usage() {
+	echo "Usage: $(basename $0) [-u USERNAME] [-p PASSWORD] COMMAND"
+    echo "Options:"
+    echo "  -u USERNAME    VM SSH username (default: admin)"
+    echo "  -p PASSWORD    VM SSH password (default: admin)"
+    echo
+    echo "Commands:"
+    echo "  startupconfig         copy $STARTUPSCRIPT to vm and run it"
+    echo "  copyetc               copy $DOCKER_ETC_PATH to /etc on the vm"
+	exit 0;
+}
+
+startupconfig() {
+    if [ -f "$STARTUPSCRIPT" ]; then
+        echo "copy_etc_and_run_startupscript.sh startupconfig(): Copying $STARTUPSCRIPT to vm..."
+	# Put startupfile file to VM under ~/ (/home/clab for the debian image).
+        $SCP_CMD $STARTUPSCRIPT $HOST:startup.sh && $SSH_CMD $HOST "sudo chmod +x startup.sh && sudo ./startup.sh || true"
+    else 
+	    echo "copy_etc_and_run_startupscript.sh startupconfig(): $STARTUPSCRIPT not found. No startupscript to upload."
+    fi
+}
+
+copyetc() {
+    if [ -d "$DOCKER_ETC_PATH" ]; then
+	echo "copy_etc_and_run_startupscript.sh copyetc(): Copying $DOCKER_ETC_PATH to vm..."
+        # Copy /config/etc to /etc in the VM.
+        $SCP_CMD -r $DOCKER_ETC_PATH $HOST:$REMOTE_TMP_PATH && $SSH_CMD $HOST "sudo cp -r $REMOTE_TMP_PATH/* /etc" && $SSH_CMD $HOST "sudo shutdown -r now || true"
+    else 
+	    echo "copy_etc_and_run_startupscript.sh copyetc(): $DOCKER_ETC_PATH not found. Nothing to upload."
+    fi
+}
+
+handle_args "$@"