Skip to content

Commit

Permalink
Migrate vagrant docs
Browse files Browse the repository at this point in the history
  • Loading branch information
skrysmanski committed Feb 4, 2024
1 parent e397918 commit e2c7515
Show file tree
Hide file tree
Showing 3 changed files with 208 additions and 0 deletions.
141 changes: 141 additions & 0 deletions content/articles/vagrant/basics.md
@@ -0,0 +1,141 @@
---
title: Vagrant Basics
date: 2021-06-13
topics:
- vagrant
---

Vagrant is a tool to quickly create and destroy virtual machines for development and testing purposes.

Homepage: <https://www.vagrantup.com/>

Download: <https://www.vagrantup.com/downloads>

Docs: <https://www.vagrantup.com/docs>

Official Quick Start: <https://learn.hashicorp.com/tutorials/vagrant/getting-started-index?in=vagrant/getting-started>

## Vagrant on Windows

For using Vagrant on Windows, see [](vagrant-on-windows.md).

## Default Lice Cycle

This command only creates the `Vagrantfile` file. If you already have one, you don't need/should not call this:

```shell
$ vagrant init hashicorp/bionic64
```

To start a VM, simply use:

```shell
$ vagrant up
```

To get into the VM, use:

```shell
$ vagrant ssh
```

To destroy/delete the VM, use:

```shell
$ vagrant destroy
```

To just stop the VM (without destroying it), use:

```shell
$ vagrant halt
```

## Simple Vagrant File

```ruby
# -*- mode: ruby -*-
# vi: set ft=ruby :
VAGRANTFILE_API_VERSION = "2"

Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
config.vm.box = "hashicorp/bionic64"
end
```

## Full Vagrant File

This is a Vagrant file as it's generated by `vagrant init`:

```ruby
# -*- mode: ruby -*-
# vi: set ft=ruby :

# All Vagrant configuration is done below. The "2" in Vagrant.configure
# configures the configuration version (we support older styles for
# backwards compatibility). Please don't change it unless you know what
# you're doing.
Vagrant.configure("2") do |config|
# The most common configuration options are documented and commented below.
# For a complete reference, please see the online documentation at
# https://docs.vagrantup.com.

# Every Vagrant development environment requires a box. You can search for
# boxes at https://vagrantcloud.com/search.
config.vm.box = "hashicorp/bionic64"

# Disable automatic box update checking. If you disable this, then
# boxes will only be checked for updates when the user runs
# `vagrant box outdated`. This is not recommended.
# config.vm.box_check_update = false

# Create a forwarded port mapping which allows access to a specific port
# within the machine from a port on the host machine. In the example below,
# accessing "localhost:8080" will access port 80 on the guest machine.
# NOTE: This will enable public access to the opened port
# config.vm.network "forwarded_port", guest: 80, host: 8080

# Create a forwarded port mapping which allows access to a specific port
# within the machine from a port on the host machine and only allow access
# via 127.0.0.1 to disable public access
# config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1"

# Create a private network, which allows host-only access to the machine
# using a specific IP.
# config.vm.network "private_network", ip: "192.168.33.10"

# Create a public network, which generally matched to bridged network.
# Bridged networks make the machine appear as another physical device on
# your network.
# config.vm.network "public_network"

# Share an additional folder to the guest VM. The first argument is
# the path on the host to the actual folder. The second argument is
# the path on the guest to mount the folder. And the optional third
# argument is a set of non-required options.
# config.vm.synced_folder "../data", "/vagrant_data"

# Provider-specific configuration so you can fine-tune various
# backing providers for Vagrant. These expose provider-specific options.
# Example for VirtualBox:
#
# config.vm.provider "virtualbox" do |vb|
# # Display the VirtualBox GUI when booting the machine
# vb.gui = true
#
# # Customize the amount of memory on the VM:
# vb.memory = "1024"
# end
#
# View the documentation for the provider you are using for more
# information on available options.

# Enable provisioning with a shell script. Additional provisioners such as
# Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
# documentation for more information about their specific syntax and use.
# config.vm.provision "shell", inline: <<-SHELL
# apt-get update
# apt-get install -y apache2
# SHELL
end
```
62 changes: 62 additions & 0 deletions content/articles/vagrant/vagrant-on-windows.md
@@ -0,0 +1,62 @@
---
title: Vagrant on Windows
date: 2021-06-13
topics:
- vagrant
- windows
---

Using Vagrant on Windows is a little bit more complicated. The reason: **Hyper-V**

The main problem with Hyper-V is that other hypervisors (like VirtualBox) no longer work when Hyper-V is enabled.

It's also problematic that it's not really obvious whether Hyper-V is enabled or not. The following pieces of developer software enable/require Hyper-V (as of 2021):

* Docker
* WSL (Windows Subsystem for Linux)

If you want to use any of these, you need to use Vagrant with Hyper-V.

## Installing required software

To be able to use Vagrant with Hyper-V, Vagrant requires the **Hyper-V PowerShell Cmdlets** to be installed. To do so, open an **admin PowerShell console** and execute this command:

```powershell
Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V-Management-PowerShell -All
```

## Using Vagrant with Hyper-V

The most important thing to know:

> To use Vagrant with Hyper-V, you need to run your `vagrant` commands from an **admin console**.
If you're in doubt whether Vagrant uses Hyper-V, you can simply add `--provider=hyperv` to each command:

```shell
$ vagrant up --provider=hyperv
```

## Vagrant Version

Latest usable version: **2.2.6**

Note: Newer 2.2.x versions (including 2.2.16) contain a bug that makes Vagrant unusable on Windows: <https://github.com/hashicorp/vagrant/issues/12121>

## Temporarily disable and re-enable Hyper-V

If you want to temporarily disable Hyper-V (without uninstalling it), open an **admin prompt** and enter:

```shell
$ bcdedit /set hypervisorlaunchtype off
```

Then restart you machine.

To re-enable Hyper-V afterwards, enter:

```shell
$ bcdedit /set hypervisorlaunchtype auto
```

Again, restart your machine.
5 changes: 5 additions & 0 deletions content/topics/vagrant/_index.md
@@ -0,0 +1,5 @@
---
title: 'Vagrant'
---

[Vagrant](https://www.vagrantup.com/) is a tool to quickly create (and destroy) virtual machines for development and testing purposes.

0 comments on commit e2c7515

Please sign in to comment.