xref: /aosp_15_r20/external/crosvm/tools/examples/example_simple (revision bb4ee6a4ae7042d18b07a98463b9c8b875e44b39)

#!/bin/bash
# Copyright 2022 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Example VM with a simple ubuntu guest OS but no UI, audio or networking.

set -e

SRC=$(realpath "$(dirname "${BASH_SOURCE[0]}")")
mkdir -p "$SRC/images/simple" && cd "$_"

if ! [ -f rootfs ]; then
    # ANCHOR: build
    # Build a simple ubuntu image and create a user with no password.
    virt-builder ubuntu-20.04 \
        --run-command "useradd -m -g sudo -p '' $USER ; chage -d 0 $USER" \
        -o ./rootfs
    # Packages can be pre-installed to the image using
    # --install PACKAGE_NAME
    # Ex: virt-builder ubuntu-20.04 ... --install openssh-server,ncat
    # In this example, the ubuntu image will come pre-installed with OpenSSH-server and with Ncat.
    # ANCHOR_END: build

    # ANCHOR: kernel
    virt-builder --get-kernel ./rootfs -o .
    # ANCHOR_END: kernel
fi

if [ "$(groups | grep kvm -c)" -eq 0 ]; then
    echo "Adding user $USER to the kvm group to grant access to /dev/kvm"
    # ANCHOR: kvm
    sudo adduser "$USER" kvm
    # ANCHOR_END: kvm
    echo "Please logout and log back in to reflect the kvm group."
    exit 1
fi

# ANCHOR: run
# Create `/var/empty` where crosvm can do chroot for jailing each virtio device.
# Devices can't be jailed if /var/empty doesn't exist.
# You can change this directory(/var/empty) by setting the environment variable: DEFAULT_PIVOT_ROOT
sudo mkdir -p /var/empty
# Run crosvm.
# The rootfs is an image of a partitioned hard drive, so we need to tell
# the kernel which partition to use (vda5 in case of ubuntu-20.04).
cargo run --no-default-features -- run \
    --rwdisk ./rootfs \
    --initrd ./initrd.img-* \
    -p "root=/dev/vda5" \
    ./vmlinuz-*
# ANCHOR_END: run