Skip to content

Instantly share code, notes, and snippets.

@brianknight10
Last active June 30, 2021 08:54
Show Gist options
  • Save brianknight10/c8989b00a25d16f318b48eafcfaca199 to your computer and use it in GitHub Desktop.
Save brianknight10/c8989b00a25d16f318b48eafcfaca199 to your computer and use it in GitHub Desktop.
Vagrant setup for Docker development

#Base Docker Development VM

Provisions an Ubuntu server with Docker Compose.

  • Creates an Ubuntu VM running Docker
  • Allows for configuration using a docker-compose.yml file

##How do i use it?

Step 1. Install vagrant

[https://www.vagrantup.com/]

If using a mac homebrew casks is probably the easiest way:

$> brew doctor && brew update
$> brew cask install vagrant

If you are using windows:

... just use the website- https://www.vagrantup.com

Step 2. Install the docker-compose plugin:

vagrant plugin install vagrant-docker-compose

Step 3. Go to the directory where the Vagrant file is.

vagrant up

Congrats, you now have a working dev environment you can play with.

If you want to destroy the vm (delete):

vagrant destroy

If you want to pause the vm:

vagrant halt

vagrant ssh will take you into the machine where you can work with docker once inside:

docker ps
docker exec -it <containerid> bash

##Creating a Docker compose file

Step 1. Create a docker-compose.yml file defining your containers in the same directory as your Vagrantfile.

A good example is found here.

Step 2. Reference the docker-compose file in the Vagrantfile.

config.vm.provision :docker_compose, yml: "/vagrant/docker-compose.yml", run:"always"

Step 3. Whenever you change the file, you need to run: vagrant reload to redefine the box.

# -*- 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://atlas.hashicorp.com/search.
config.vm.box = "ubuntu/trusty64"
config.vm.provider "virtualbox" do |vb|
vb.name = 'python-aws-dev'
vb.memory = 2048
vb.cpus = 1
vb.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
vb.customize ["modifyvm", :id, "--natdnsproxy1", "on"]
end
config.vm.provision :docker
# config.vm.provision :docker_compose, yml: "/vagrant/docker-compose.yml", run:"always"
# 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.
# config.vm.network "forwarded_port", guest: 8088, host: 8088
# 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.
# Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
# such as FTP and Heroku are also available. See the documentation at
# https://docs.vagrantup.com/v2/push/atlas.html for more information.
# config.push.define "atlas" do |push|
# push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
# end
# 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
# sudo apt-get update
# sudo apt-get install -y apache2
# SHELL
end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment