rust-vmm-container

rustvmm/dev is a container with all dependencies used for running rust-vmm integration and performance tests. The container is available on Docker Hub and has support for x86_64 and aarch64 platforms.

For the latest available tag, please check the rustvmm/dev builds available on Docker Hub.

Know Issues

For now rust is installed only for the root user.

Using the Container

The container is currently used for running the integration tests for the majority of rust-vmm crates.

Example of running cargo build on the kvm-ioctls crate:

> git clone git@github.com:rust-vmm/kvm-ioctls.git
> cd kvm-ioctls/
> docker run --volume $(pwd):/kvm-ioctls \
         rustvmm/dev:$VERSION \
         /bin/bash -c "cd /kvm-ioctls && cargo build --release"
 Downloading crates ...
  Downloaded libc v0.2.48
  Downloaded kvm-bindings v0.1.1
   Compiling libc v0.2.48
   Compiling kvm-bindings v0.1.1
   Compiling kvm-ioctls v0.0.1 (/kvm-ioctls)
    Finished release [optimized] target(s) in 5.63s

Testing Changes locally with the Container Image

When we modify the container to install new dependencies, we may need to test the new dependencies locally, before publishing the PR. To do this, first build the rust-vmm container locally by running the commands

> cd rust-vmm-container
> ./docker.sh build

since this command will build a new docker image with tag latest version + 1 and will alias it with "latest" tag, when testing the container check the output of the ./docker.sh build command and you will see the tag that will be published with your PR to be sure that the changes introduced by your PR to the CI works correctly before pusing it upstream. Example of this output is Build completed for rustvmm/dev:v38_x86_64

Example of how to test the container on your localhost with tag v38_x86_64:

> docker run --device=/dev/kvm -it --rm \
--volume $(pwd):/path/to/workdir --workdir /path/to/workdir \
--privileged rustvmm/dev:v38_x86_64

The --workdir /workdir option ensures that when the container starts, the working directory inside the container is set to /workdir Since you've mounted the host's current directory ($(pwd)) to /workdir in the container, any files in the current working directory on the host will be accessible in the /workdir directory inside the container.

Publishing a New Version

A new container version is published for each PR merged to main that adds changes to the Dockerfile or the related scripts. Publishing the container happens automatically through the .github/worflows and no manual intervention is required.

You can check the progress of a commit being published to Docker Hub by looking at the GitHub commit history, and clicking on the status check of the relevant commit.

Manual Publish

If for any reason the GitHub workflow is not working and a new container version was not automatically pushed when merging the Dockerfile changes to the main branch, you can follow the steps below for a manual publish.

The rust-vmm organization on Docker Hub is free and thus has only 3 members that are allowed to publish containers:

• Andreea Florescu
• Laura Loghin
• and the rust-vmm bot account

On an aarch64 platform:

> cd rust-vmm-dev-container
> ./docker.sh build
> ./docker.sh publish

You will need to redo all steps on an x86_64 platform so the containers are kept in sync (same package versions on both x86_64 and aarch64).

Now that the tags v4_x86_64 and v4_aarch64 are pushed to Docker Hub, we can go ahead and also create a new version tag that points to these two builds using docker manifest.

./docker.sh manifest

If it is the first time you are creating a docker manifest, most likely it will fail with: docker manifest is only supported when experimental cli features are enabled. Checkout this article to understand why and how to fix it.