Go to file
Brian Cain dd782294f4
Update year on LICENSE
2019-03-25 10:21:32 -07:00
.circleci add circleci website build 2018-11-16 15:12:06 -05:00
.github Add a few more updates to the CONTRIBUTING document 2018-12-19 10:12:41 -08:00
bin Remove VALID_FEATURES constant 2018-12-07 13:52:02 -08:00
contrib Add `cloud` command to bash completion 2018-10-12 09:49:49 -07:00
keys Use SSL and HTTPS links where appropriate 2016-01-25 13:14:54 -05:00
lib Fix typo in UI Prefix for trigger UI 2019-03-21 10:11:38 -07:00
plugins Merge pull request #10745 from chrisroberts/f-net-sftp-comms 2019-03-20 15:57:21 -07:00
scripts Update RELEASE 2016-06-14 20:33:19 +02:00
tasks Use color 2015-07-09 17:24:29 -06:00
templates Fixes #10663: Ignore boxes in collection with malformed version numbers 2019-02-14 15:30:11 -08:00
test Merge pull request #10713 from renatoaguiar/fix-void-nfs 2019-03-20 15:48:46 -07:00
website Fix formatting issues on WSL docs 2019-03-19 09:03:24 -04:00
.gitignore Add a custom path location to ignore 2018-02-28 10:08:01 -08:00
.runner.sh Add simple build script 2018-03-07 08:52:53 -08:00
.travis.yml Update Ruby version to 2.6.1 for Travis CI 2019-02-04 13:43:03 -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 2019-03-22 16:31:20 -07:00
Gemfile Update URLs for the repo 2018-03-07 17:10:30 -05:00
LICENSE Update year on LICENSE 2019-03-25 10:21:32 -07:00
README.md Update CONTRIBUTING.md (and related stuff) 2018-05-16 11:50:37 +02:00
RELEASE.md Minor fix on string #041 2018-12-13 19:20:02 -03:00
Rakefile Change symbols inside hashes to 1.9 JSON-like syntax 2014-05-22 12:35:12 -04:00
Vagrantfile Updated Vagrantfile to install more recent versions of software. 2016-07-26 20:00:02 -04: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 Merge pull request #10513 from briancain/catch-invalid-version-errors-vagrant_cloud 2019-01-09 11:16:58 -08:00
version.txt Update version for dev 2.2.5.dev 2019-02-27 07:38:22 -08:00

README.md

Vagrant

Vagrant is a tool for building and distributing development environments.

Development environments managed by Vagrant can run on local virtualized platforms such as VirtualBox or VMware, in the cloud via AWS or OpenStack, or in containers such as with Docker or raw LXC.

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

For the quick-start, we'll bring up a development machine on VirtualBox because it is free and works on all major platforms. Vagrant can, however, work with almost any system such as OpenStack, VMware, Docker, etc.

First, make sure your development machine has VirtualBox installed. After this, download and install the appropriate Vagrant package for your OS.

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 from Source

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. Please review the installation page here.

Contributing to Vagrant

Once your Vagrant bundle is installed from Git repository, you can run the test suite with:

bundle exec rake

This will run the unit test suite, which should come back all green!

Please take time to read the HashiCorp Community Guidelines and the Vagrant Contributing Guide.

Then you're good to go!

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"
...