Skip to content

[RFC] Create virtualbox guide #5194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ambersongliu
Copy link

VirtualBox Guide for Firecracker

Guide to switch from VMWare to VirtualBox.

#1033

Changes

Created guide to switch VM setup from VMware Fusion/Ubuntu to Vagrant and VirtualBox per Issue #1033.
...

Reason

Explore free alternative to current VM solution, VMWare. VirtualBox is GPL-licensed and thus free for commercial use. Vagrant and VirtualBox run identically on Intel-based macOS, Windows, and Linux, ensuring developers and CI systems use the same environment by streamlining the onboarding and maintenance process.
...

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

VirtualBox Guide for Firecracker

Guide to switch from VMWare to VirtualBox.

Signed-off-by: Amber Liu <[email protected]>
@ambersongliu ambersongliu force-pushed the switchtovirtualbox branch from cca8477 to d65c8e3 Compare May 7, 2025 00:43
added citation to Richard Case's vagrantfile

Signed-off-by: Amber Liu <[email protected]>
Copy link
Contributor

@Manciukic Manciukic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have left a few comments but I haven't tested it out yet. I'll try to give it a go on Ubuntu it by eow.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add .md extension to the file for Markdown rendering and add a link to it from the dev machine setup guide.

Also, we should have a disclaimer at the beginning of the guide that the guide is provided for the convenience of developers, that it may contain out of date information, but that we're very happy to receive contributions to improve it.


---

## 3. Why VirtualBox + Vagrant?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it'd be useful to have a link to instructions on how to install virtualbox and vagrant

SHELL
end

config.vm.provision "rust", type: "shell", run: "once" do |sh|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not required if we're using the devtool below

Comment on lines +118 to +119
[ -d firecracker ] || git clone https://github.com/firecracker-microvm/firecracker.git
cd firecracker
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks like too many firecracker folders. My understanding is that the sourcecode is synced at /home/vagrant/firecracker in line 68.

[ -d firecracker ] || git clone https://github.com/firecracker-microvm/firecracker.git
cd firecracker
source $HOME/.cargo/env
tools/devtool build
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is docker available and configured?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for VM dev machine(using free or open source software)
2 participants