Vagrant Workbench: Setting Up ·

Vagrant Workbench: Setting Up

09 Apr 2013

The guide setup assumes you're running a relatively modern version of OSX. But if you can get your non-OSX environment into shape, you should be able to follow along with the rest of the guide quite easily.

Install Homebrew

Homebrew is a package manager for OSX. Follow the instructions on the Homebrew Installation Page to install Homebrew.

Install Homebrew

$ ruby -e "$(curl -fsSL"

This guide will assume that you have Homebrew installed.

Install Git

Git is a distributed version control system that is used heavily by Chef. We need this too.

Install GIT

$ brew install git
$ git --version
git version 1.8.2

Install rbenv and ruby-build

OSX comes with its own outdated version of Ruby. Simply upgrading it can cause trouble. You need something to manage multiple versions of Ruby; enter rbenv and ruby-build.

Install rbenv

$ brew install rbenv
$ if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi
$ brew install ruby-build

EDIT: need to see if the command line entry is good enough or if we should be updating the bash profile.

Install Ruby

Ruby 1.9 is a requirement of Berkshelf. We will be using 2.0.0-p0 which is the latest patch level of 2.0.0.

Install Ruby

Set Ruby 2.0.0-p0 as your default Ruby version

Set Global Ruby Version

And install bundler for dependency resolution

Install Ruby Bundler

Install Berkshelf

Berkshelf is a dependency resolver and retriever for Chef Cookbooks.

Install Berkshelf

Note: This guide requires Berkshelf (1.0.0) or later.

Install Foodcritic

Foodcritic is a linting tool for Chef Cookbooks that helps you find problems and improve your code.

Install Foodcritic

Install VirtualBox

VirtualBox is a virtualization solution for creating virtual machines on your local computer. We will be using it to build our development environment.

Download Virtualbox from the Virtualbox Downloads Page and then install it. We will be using version 4.2.10 in this guide.

Install Vagrant

Vagrant provides easy to configure, reproducible, and portable work environment built on top of VirtualBox, VMWare, or AWS.

Vagrant can be installed by downloading the installer for your operating system and using standard procedures to install that package. We will be using version 1.1.5.

Install Berkshelf plugin

Install the Berkshelf plugin for Vagrant.

Install Berkshelf Plugin

$ vagrant plugin install berkshelf-vagrant

Creating the Cookbook

Create a new cookbook called "workbench" to bake our sample development environment. Berkshelf will do all the hard work, and set up a standard set of templates. Don't forget the --foodcritic attribute. This will create a skeleton for a new cookbook named ‘workbench' in the directory workbench in your current working directory.

Create A Cookbook

$ berks cookbook workbench --foodcritic
      create  workbench/files/default
      create  workbench/templates/default
      create  workbench/attributes
      create  workbench/definitions
      create  workbench/libraries
      create  workbench/providers
      create  workbench/recipes
      create  workbench/resources
      create  workbench/recipes/default.rb
      create  workbench/metadata.rb
      create  workbench/LICENSE
      create  workbench/
      create  workbench/Berksfile
      create  workbench/chefignore
      create  workbench/.gitignore
         run  git init from "./workbench"
      create  workbench/Thorfile
      create  workbench/Gemfile
      create  workbench/Vagrantfile
Using workbench (0.1.0) at path: '/Users/modius/Kitchen/workbench'

Passing the additional --foodcritic option generates additional boilerplate files for your cookbook that will enable lint testing with Foodcritic later.

Prepare your virtual environment

Switch into the directory of the newly created cookbook and install the Gem dependencies with bundler

Install Gem Dependencies

$ cd workbench
$ bundle install

Bundler will install all of the dependent RubyGems and guarantee that you have the right versions.

Starting your virtual machine

A Vagrantfile was generated for you by Berkshelf with a boilerplate configuration. The Vagrantfile defines the configuration of the virtual machine we'll be working with. By default this is configured to download and boot a CentOS 6.3 Vagrant Box and provision it with chef-solo.

First thing we're going to do is switch this to an Ubuntu virtual instead. Open the Vagrantfile inside your cookbook with your favorite editor and edit the values of the and config.vm.box_url attributes.

Edit Vagrantfile do |config|
  ... = "precise64"
  config.vm.box_url = ""

Start up your virtual machine

Vagrant Up

$ vagrant up
Bringing machine 'default' up with 'virtualbox' provider...
[default] Importing base box 'precise64'...
[default] Matching MAC address for NAT networking...
[default] Setting the name of the VM...
[default] Clearing any previously set forwarded ports...
[Berkshelf] Updating Vagrant's berkshelf: '/Users/modius/.berkshelf/vagrant/berkshelf-20130409-26494-18obao1'
[Berkshelf] Using workbench (0.1.0) at path: '/Users/modius/Kitchen/workbench'
[default] Fixed port collision for 22 => 2222. Now on port 2203.
[default] Creating shared folders metadata...
[default] Clearing any previously set network interfaces...
[default] Preparing network interfaces based on configuration...
[default] Forwarding ports...
[default] -- 22 => 2203 (adapter 1)
[default] Booting VM...
[default] Waiting for VM to boot. This can take a few minutes.
[default] VM booted and ready for use!
[default] Setting hostname...
[default] Configuring and enabling network interfaces...
[default] Mounting shared folders...
[default] -- /vagrant
[default] -- /tmp/vagrant-chef-1/chef-solo-1/cookbooks
[default] Running provisioner: VagrantPlugins::Chef::Provisioner::ChefSolo...
Generating chef JSON and uploading...
Running chef-solo...
stdin: is not a tty
[2013-04-09T11:45:33+00:00] INFO: *** Chef 10.14.2 ***
[2013-04-09T11:45:34+00:00] INFO: Setting the run_list to ["recipe[workbench::default]"] from JSON
[2013-04-09T11:45:34+00:00] INFO: Run List is [recipe[workbench::default]]
[2013-04-09T11:45:34+00:00] INFO: Run List expands to [workbench::default]
[2013-04-09T11:45:34+00:00] INFO: Starting Chef Run for workbench-berkshelf
[2013-04-09T11:45:34+00:00] INFO: Running start handlers
[2013-04-09T11:45:34+00:00] INFO: Start handlers complete.
[2013-04-09T11:45:34+00:00] INFO: Chef Run complete in 0.027968 seconds
[2013-04-09T11:45:34+00:00] INFO: Running report handlers
[2013-04-09T11:45:34+00:00] INFO: Report handlers complete

This may take a little while if this is your first time; Vagrant will need to download the Precise64 base box first. But once the box package is local, any request for a new box of the same name and url will reuse your local copy. If Ubuntu is not your thing, there's a convenient list of pre-prepped and popular Vagrant boxen online.

Check the full Vagrant Documentation for future reference.

If at anytime your virtual machine becomes unstable or if you'd like to start over you can destroy your virtual machine with one command

The Green Needle

$ vagrant destroy
Are you sure you want to destroy the 'default' VM? [y/N] y
[default] Forcing shutdown of VM...
[default] Destroying VM and associated drives...
[Berkshelf] Cleaning Vagrant's berkshelf

If you destroyed your VM just now becuase you couldn't help yourself, make sure to recreate it with vagrant up before moving on with the guide ;)

This is a companion discussion topic for the original entry at

Worth noting we’ve moved away from Chef as a provisioning environment for Vagrant in favour of Ansible. We published a set of provisioning roles that folks might find helpful, at least for Lucee development.