This VM includes a sandboxed installation ("chroot") of Raspbian, an ARM variant of the Debian Linux distribution optimized for Raspberry Pi. Use of the sandbox is mediated by a cross-compiling tool called ScratchBox2. ScratchBox2 craftily translates the ARM executables bundled with Raspbian such that they run on your Intel box.
Why is this so nice? Suppose you have C++ app that you want to build for the Raspberry Pi, but it requires a bunch of third-party libraries. Do you really want to hunt down these libraries, their dependencies, their dependencies dependencies, their dependencies dependencies dependencies and so on, until you're able to build your own app? It should be clear that that way lies madness. Perhaps you'll just copy the headers and libraries from your Raspberry to your Intel box, and point your compiler at those. That might work, but it'll be fragile and annoying.
How about we let the Raspbian folks do all the hard work? With ScratchBox2, you can simply apt-get to your heart's content. Just type:
sb2 -eR apt-get install ...
apt-get in the default ScratchBox2 container (in our case, we only have the one. It's called "raspberry".) The
-e flag is for chroot (emulated) mode;
-R runs the command as the equivalent of root in the sandboxed environment. For a slightly more thorough explanation of ScratchBox2, see these presentation slides: http://www.daimi.au.dk/~cvm/sb2.pdf.
- Install both VirtualBox and Vagrant.
- In a terminal, execute
git clone git://github.com/nickhutchinson/raspberry-devbox.git && cd raspberry-devbox
vagrant upto launch and provision your Virtual Machine.
Vagrant will now download the basebox, bootstrap the environment and run the provisioner for the first time. Since the basebox and numerous packages must be downloaded, the first run may take some time depending on your network connection. No supervision should be required; running the install overnight should be just fine. Future runs will be much faster, and won't require network connectivity.
If like to see words dribble down your screen, you can monitor the bootstrap progress by running
vagrant ssh to ssh into your VM, and then
tail -F ~/raspberry-dev/rootfs/debootstrap/debootstrap.log)
After installation has completed, you should find:
- the Raspbian chroot.
The basic virtualization layer is VirtualBox. Any current version should do, however the guest additions are pinned to current version at the time the basebox was built (4.2.0). A mismatch between the guest additions and the VirtualBox version may result in strange behaviour, mostly affecting shared folders and networking. To update the guest, additions follow the instructions in the VirtualBox manual.
Vagrant is the scripting toolkit used to control all interaction with the devbox. A full guide on Vagrant can be found on the Vagrant site. As a short primer, the following commands should be sufficient:
vagrant up <boxname>start the given box. If the box has not been initialized and created, this will download the basebox as required, bootstrap it and run the provisioner. Running
vagrant upwhen the box is already running is a NOOP and has no effect.
vagrant halt <boxname>stop the given box. Has no effect if the box is not running. May require an invocation using the
vagrant halt --force <boxname>) if the box crashed, locked up or cannot be accessed via
vagrant reload <boxname>stop and start the given box. Runs the provisioner.
vagrant provision <boxname>Runs the provisioner.
vagrant destroy <boxname>destroys the given box. This is useful if for some reason the box has been damaged or to free disk space. Running
vagrant upafter running
vagrant destroybootstraps a new box.
vagrant ssh <boxname>open an ssh connection to the given box.
Provisioning of the Virtual Machine is handled by Puppet. Take a look at the
If you encounter a problem, please file a ticket. If you can help improve this Virtual Machine recipe please let me know; I'm very new to Vagrant, Puppet, ScratchBox2 and Raspberry Pi, and barely know what I'm doing!
- all of this is still quite rough
- improve on the readme