- Learn about Vagrant
- Learn about Vagrant commands
Vagrant is an open-source software product for building and maintaining portable virtual software development environments. Below, you will find some basic instructions on interacting with Vagrant through the command-line interface (CLI). You should be familiar with this since you will need to use it to control virtual machines during your internship.
Before installing Vagrant we must setup the cli repository, enable virtualization on our computer, and install VirtualBox.
NOTE: You should have at least 7 GB of free storage space this step.
There are three command-line programs you could use to interact with Vagrant CLI:
-
Git Bash: This is our recommended command line program. Git Bash is already installed along with planet installation script. After you open Git Bash, you will find its default directory at
C:\Users\YOUR_USERNAME. -
Command Prompt: There are two Command Prompt options on Windows: Command Prompt and Command Prompt(Admin). You could use either of them to access directories and interact with Vagrant CLI. The only difference is their default directory: Command Prompt(Admin) has
C:\Windows\system32as default directory and Command Prompt hasC:\Users\YOUR_USERNAMEas the default directory. -
Windows PowerShell: Windows PowerShell is a default shell interface installed on your machine, its default directory is
C:\Users\YOUR_USERNAME.
NOTE: PowerShell and Command Prompt users will have to substitute forward slashes “/” with backslashes “\” throughout these introductory steps as it pertains to file paths.
Example: If you see an instruction saying cd desktop/cli instead use cd desktop\cli.
Normally we use a terminal emulator to interact with Vagrant CLI
A lot of Vagrant commands require us to specify a target machine. We can also run those commands from a directory with the target machine’s Vagrant File. Otherwise, you may encounter an error like "A Vagrant environment or target machine is required." Please go to the directory that contains our Vagrant file:
Windows users should do the following:
- Go into git bash and type
cd ~/Desktop git clone https://github.com/treehouses/clicd ~/Desktop/cli
macOS or Linux users should do the following:
cd Desktopgit clone https://github.com/treehouses/cli
Since we are planning on using VirtualBox to control Virtual Machines with our Raspberry Pi, we must first enable virtualization
Please visit the following website to learn how to enable virtualization on your own machine: https://2nwiki.2n.cz/pages/viewpage.action?pageId=75202968
Next, we must install VirtualBox to get Vagrant to work properly
Windows users should do the following:
- Go to https://www.virtualbox.org/wiki/Downloads and select windows hosts to install VirtualBox
- Follow the steps until you can successfully open VirtualBox
macOS or Linux users should do the following:
- In your command line interface type the following:
brew cask install virtualboxorsudo apt-get install virtualbox
Last, we must install Vagrant so we can move onto the next steps
Windows users should do the following:
- Go to https://www.vagrantup.com/downloads.html and select windows hosts to install Vagrant
- Follow the steps until you have completed install for Vagrant
macOS or Linux users should do the following:
- In your command line interface type the following:
brew cask install vagrantorsudo apt-get install vagrant
Start up your vagrant environment by executing vagrant up, the most commonly used vagrant command.
vagrant global-status will tell us the state of all active Vagrant environments on the system for the currently logged in user. You will see something similar to this:
id name provider state directory
---------------------------------------------------------------------------
0e6abb1 cli virtualbox running /Users/pattanawadee/cli
The above shows information about all known Vagrant environments
on this machine. This data is cached and may not be completely
up-to-date (use "vagrant global-status --prune" to prune invalid
entries). To interact with any of the machines, you can go to that
directory and run Vagrant, or you can use the ID directly with
Vagrant commands from any directory. For example:
"vagrant destroy 1a2b3c4d"
The above output tells us:
- We have a Vagrant virtual machine called
clirunning in VirtualBox. - The directory of the virtual machine's Vagrantfile is located at
/Users/pattanawadee/Desktop/cli.
vagrant upwill turn the virtual machine back on if it's currently "poweroff".vagrant suspendwill suspend the "running" virtual machine, its state will become "saved".vagrant haltwill shut down the "running" virtual machine, its state will become "poweroff".vagrant destroywill delete the virtual machine entirely. To use the cli virtual machine again, we will have to rebuild a new machine from scratch usingvagrant up.
To conserve hardware resources of your computer, you could use vagrant halt to shutdown the virtual machine that's running. Use vagrant up to turn the virtual machine back on when you need to access your cli again.
We suggest you to look at Vagrant CLI's documentation to find out more about its commands and usage.
You could also use vagrant --help to see brief usage instruction of other commands that you might need.
Usage: vagrant [options] <command> [<args>]
-v, --version Print the version and exit.
-h, --help Print this help.
Common commands:
box manages boxes: installation, removal, etc.
connect connect to a remotely shared Vagrant environment
destroy stops and deletes all traces of the vagrant machine
global-status outputs status Vagrant environments for this user
halt stops the vagrant machine
help shows the help for a subcommand
init initializes a new Vagrant environment by creating a Vagrantfile
login log in to HashiCorp's Vagrant Cloud
package packages a running vagrant environment into a box
plugin manages plugins: install, uninstall, update, etc.
port displays information about guest port mappings
powershell connects to machine via powershell remoting
provision provisions the vagrant machine
push deploys code in this environment to a configured destination
rdp connects to machine via RDP
reload restarts vagrant machine, loads new Vagrantfile configuration
resume resume a suspended vagrant machine
share share your Vagrant environment with anyone in the world
snapshot manages snapshots: saving, restoring, etc.
ssh connects to machine via SSH
ssh-config outputs OpenSSH valid configuration to connect to the machine
status outputs status of the vagrant machine
suspend suspends the machine
up starts and provisions the vagrant environment
validate validates the Vagrantfile
version prints current and latest Vagrant version
For help on any individual command run `vagrant COMMAND -h`
Additional subcommands are available, but are either more advanced
or not commonly used. To see all subcommands, run the command
`vagrant list-commands`.
NOTE: At the end of this section, when you successfully installed vagrant and configured cli. Execute vagrant global-status command and post the code of your terminal to the Gitter chat.
Why install Vagrant? - Explanation of some basic concepts about why Vagrant is useful for developers, operators and designers. Vagrant download Wikipedia page on Vagrant Vagrant Cheatsheet Enabling Virtualization in Bios
Other helpful links and videos