Skip to content
Vagrant is a tool for building and distributing development environments.
Ruby HTML PowerShell Shell CSS JavaScript
Branch: master
Clone or download

Latest commit

Latest commit 8951975 May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci Update helper May 4, 2020
.circleci Add CI scripts and configuration Jan 16, 2020
.github Add path filtering to pull requests Mar 10, 2020
bin Use :ui_class opt to set ui class Mar 30, 2020
contrib completion.sh: add more up options Nov 28, 2019
keys Use SSL and HTTPS links where appropriate Jan 25, 2016
lib Remove unused require for MapCommandOptions class May 20, 2020
plugins Remove whitespace May 20, 2020
scripts Update RELEASE Jun 14, 2016
tasks Use color Jul 9, 2015
templates Update to use example domain May 20, 2020
test Use example domain in downloader tests May 21, 2020
website Use example domain for documentation May 21, 2020
.gitignore Add a custom path location to ignore Feb 28, 2018
.hashibot.hcl Do not comment when locking really old issues Apr 3, 2020
.runner.sh Add simple build script Mar 7, 2018
.vimrc .vimrc with vagrant tabstop settings Oct 22, 2013
.yardopts YARD and some documentation Sep 22, 2010
CHANGELOG.md Update CHANGELOG May 26, 2020
Gemfile Update URLs for the repo Mar 7, 2018
LICENSE Update year on LICENSE Mar 25, 2019
README.md Documentation and template updates for discuss Feb 3, 2020
RELEASE.md Update the steps in the release document Jun 25, 2019
Rakefile Change symbols inside hashes to 1.9 JSON-like syntax May 22, 2014
Vagrantfile Box switched to hashicorp/bionic64 and supported providers adjusted Sep 22, 2019
vagrant-spec.config.example.rb core: Within a Bundler env, don't manage Bundler Jan 17, 2014
vagrant.gemspec Merge pull request #11339 from dcermak/bump_dependencies Apr 17, 2020
version.txt Update files for new development May 7, 2020

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

Package dependencies: Vagrant requires bsdtar to be available on your system PATH to run successfully.

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/bionic64
vagrant up

Note: The above vagrant up command will also trigger Vagrant to download the bionic64 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!

If you are developing Vagrant on a machine that already has a Vagrant package installation present, both will attempt to use the same folder for their configuration (location of this folder depends on system). This can cause errors when Vagrant attempts to load plugins. In this case, override the VAGRANT_HOME environment variable for your development version of Vagrant before running any commands, to be some new folder within the project or elsewhere on your machine. For example, in Bash:

export VAGRANT_HOME=~/.vagrant-dev

You can now run Vagrant commands against the development version:

bundle exec vagrant

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"
...
You can’t perform that action at this time.