Go to file
Mitchell Hashimoto 8c7ab333a0 Squash the f-docker-hostmachine branch.
Initial work

commands/up: make sure all names to with_target_vms are strings

providers/docker: create a docker host VM if needed

providers/docker: executor abstraction for driver to eventually support remote

providers/docker: vagrant executor

providers/docker: support creating the machine

providers/docker: status works if host VM is gone

providers/docker: use start fence to get real docker output

core: Call preserves stack ordering

core: support Message post option

providers/docker: Guard some features with HasSSH checks

providers/docker: much better messaging around create/destroy

providers/docker: output the container ID on create

providers/docker: copy the hostmachine Vagrantfile to the data dir

providers/docker: should make host machine before any up action

providers/docker: HandleBox before the host machine

providers/virtualbox: functional_vboxsf to disable vboxsf

providers/virtualbox: synced folder usable method should take 2 args

providers/docker: default machine name to :default
2014-04-21 13:54:33 -07:00
bin commands/box/list: doesn't trigger Vagrantfile loading 2014-04-18 20:46:44 -07:00
contrib Update contrib/README & bash shebang line 2014-03-10 11:18:20 -04:00
keys Remove reference to PPK in keys readme 2013-07-18 10:52:38 -04:00
lib Squash the f-docker-hostmachine branch. 2014-04-21 13:54:33 -07:00
plugins Squash the f-docker-hostmachine branch. 2014-04-21 13:54:33 -07:00
scripts scripts: calculate shasum 2013-12-09 00:17:14 -08:00
tasks update rake tasks for acceptance testing 2013-12-05 14:24:10 -08:00
templates Squash the f-docker-hostmachine branch. 2014-04-21 13:54:33 -07:00
test Squash the f-docker-hostmachine branch. 2014-04-21 13:54:33 -07:00
website website/docs: update docs for winrm shell provisioning 2014-04-21 13:53:58 -07:00
.gitignore website/docs: document Vagrantfile updates 2014-02-05 21:20:26 -08:00
.travis.yml Install Bundler 1.5.2 for tests 2014-01-16 09:36:26 -08:00
.vimrc .vimrc with vagrant tabstop settings 2013-10-22 08:24:58 +02:00
.yardopts YARD and some documentation 2010-09-22 09:43:30 -06:00
CHANGELOG.md Update CHANGELOG 2014-04-21 13:54:22 -07:00
CONTRIBUTING.md Add notes about debugging logs to contributing guidelines 2013-06-09 20:42:31 -03:00
Gemfile Update dep of ChildProcess to 0.4.0 2014-01-17 20:34:58 -08:00
LICENSE 🎆 New year! 🎆 2014-01-02 00:48:22 -02:00
README.md A simple typo 2014-04-03 12:37:24 -07:00
Rakefile stdout.sync = true for rake tasks. 2011-11-13 19:41:38 -08:00
vagrant-spec.config.example.rb core: Within a Bundler env, don't manage Bundler 2014-01-17 09:39:20 -08:00
vagrant.gemspec communicators/winrm: initial import from vagrant-windows 2014-04-21 13:50:58 -07:00
version.txt v1.5.4 2014-04-21 11:50:01 -07:00

README.md

Vagrant

Vagrant is a tool for building and distributing development environments.

Vagrant provides the framework and configuration format to create and manage complete portable development environments. These development environments can live on your computer or in the cloud, and are portable between Windows, Mac OS X, and Linux.

Quick Start

First, make sure your development machine has VirtualBox installed. After this, download and install the appropriate Vagrant package for your OS. If you're not on Mac OS X or Windows, you'll need to add /opt/vagrant/bin to your PATH. After this, you're ready to go!

To build your first virtual environment:

vagrant init hashicorp/precise32
vagrant up

Note: The above vagrant up command will also trigger Vagrant to download the precise32 box via the specified URL. Vagrant only does this if it detects that the box doesn't already exist on your system.

Getting Started Guide

To learn how to build a fully functional development environment, follow the getting started guide.

Installing the Gem from Git

If you want the bleeding edge version of Vagrant, we try to keep master pretty stable and you're welcome to give it a shot. The following is an example showing how to do this:

rake install

Ruby 2.0 is needed.

Contributing to Vagrant

Dependencies and Unit Tests

To hack on vagrant, you'll need bundler which can be installed with a simple gem install bundler. Afterwards, do the following:

bundle install
rake

This will run the unit test suite, which should come back all green! Then you're good to go!

If you want to run Vagrant without having to install the gem, you may use bundle exec, like so:

bundle exec vagrant help

NOTE: By default running Vagrant in via bundle will disable plugins. This is necessary because Vagrant creates its own private Bundler context (it does not respect your Gemfile), because it uses Bundler to manage plugin dependencies.

Acceptance Tests

Vagrant also comes with an acceptance test suite that does black-box tests of various Vagrant components. Note that these tests are extremely slow because actual VMs are spun up and down. The full test suite can take hours. Instead, try to run focused component tests.

To run the acceptance test suite, first copy vagrant-spec.config.example.rb to vagrant-spec.config.rb and modify it to valid values. The places you should fill in are clearly marked.

Next, see the components that can be tested:

$ rake acceptance:components
cli
provider/virtualbox/basic
...

Then, run one of those components:

$ rake acceptance:run COMPONENTS="cli"
...