You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Brian Cain 5cc06bde64
Merge pull request #11341 from hjung4/spell
5 months ago
.ci Add CI scripts and configuration 6 months ago
.circleci Add CI scripts and configuration 6 months ago
.github Fix environment variable value 5 months ago
bin Remove VALID_FEATURES constant 1 year ago
contrib completion.sh: add more up options 7 months ago
keys Use SSL and HTTPS links where appropriate 4 years ago
lib Check name config option with respond_to? 6 months ago
plugins update 5 months ago
scripts Update RELEASE 4 years ago
tasks Use color 5 years ago
templates Fixes #11128: Error if machine folder inaccessible (#11239) 6 months ago
test Set provisioner names to symbol 6 months ago
website update 5 months ago
.gitignore Add a custom path location to ignore 2 years ago
.hashibot.hcl Lock closed issues after 30 days (#11332) 5 months ago
.runner.sh Add simple build script 2 years ago
.vimrc .vimrc with vagrant tabstop settings 6 years ago
.yardopts YARD and some documentation 9 years ago
CHANGELOG.md Update version and changelog for new development 5 months ago
Gemfile Update URLs for the repo 2 years ago
LICENSE Update year on LICENSE 1 year ago
README.md Update docs with newly supported hashicorp/bionic64 box 11 months ago
RELEASE.md Update the steps in the release document 1 year ago
Rakefile Change symbols inside hashes to 1.9 JSON-like syntax 6 years ago
Vagrantfile Box switched to hashicorp/bionic64 and supported providers adjusted 9 months ago
vagrant-spec.config.example.rb core: Within a Bundler env, don't manage Bundler 6 years ago
vagrant.gemspec Merge pull request #11181 from stefansundin/rubyzip-v1.3.0 8 months ago
version.txt Update version and changelog for new development 5 months ago

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