Vagrantを使って気軽にスクラップ&ビルドできる環境を自動構築する

開発の度に本番に近い開発環境や検証環境をローカルで作ったりしているのですが、毎回VirtualBoxのGUIをポチポチ操作して仮想環境を構築するのが面倒大変です。

今回はVagrantという仮想環境を構築するソフトウェアを使って仮想環境の構築を自動化してみたいと思います。

Vagrantとは

VagrantとはHashiCorp社が開発提供している仮想環境の構築を自動化するソフトウェア。仮想環境の構築はVagrantfileと呼ばれる設定ファイルを元に作成が行われます。条件が一定であれば、いつでも同じ環境を構築することができます。

今回はVagrantを使って仮想環境の構築自動化を行いたいと思います。

事前準備

Virutalboxのインストール

Vagrantを使用するためにはVirtualBoxをインストールする必要があります。

https://www.virtualbox.org/wiki/Downloads

自分の使用するマシンの環境に応じてインストールを行ってください。

Vagrantのインストール

次にVagrantをインストールを行います。

http://www.vagrantup.com/

これもVirutalboxと同様に自分の使用するマシンの環境に応じてインストールを行ってください。

Vagrantがちゃんとインストールされているかは、ターミナルから-vで確認してみましょう。

$ vagrant -v
Vagrant 2.2.7

Windowsの場合はPathが通っていないと思うので、C:\HashiCorp\Vagrant\bin直下にあるvagrant.exeをコマンドプロンプトやPowerShellで実行しましょう。

PS C:\HashiCorp\Vagrant\bin> .\vagrant.exe
Vagrant 2.2.7

バージョンが確認できれば準備OKです。

構築したいOSのBox名を取得する

VagrantではBoxと呼ばれるOSのイメージファイルを取得する必要がある。

自分でBoxファイルを作成することもできるが、今回はVagrant CloudというHashiCorpが提供している公開されているBoxを検索することができるサイトから構築したいOSを取得してきます。

https://app.vagrantup.com/

検索ボックスにubuntu,18.04と入力すると、いくつかのBox名が表示されますので、好きなBoxを選びましょう。これらのBoxは公式が公開しているものもありますが、有志の方々がアップロードしているものもありますので、変なBoxは公開されてないと思いたいですが、なるべくDownload数が多いものを選ぶなどをするといいと思います。今回はgeneric/ubuntu1804を使用したいと思います。

Vagrantfileを作成する

上記で取得したBox名はVagrantfileを生成するときに使用します。

任意のディレクトリを作成して、ディレクトリの中でVagrantfileを生成するコマンドを実行します。

$ mkdir vagrant_ubuntu
$ cd vagrant_ubuntu
$ vagrant init generic/ubuntu1804
----
A `Vagrantfile` has been placed in this directory. You are now
ready to `vagrant up` your first virtual environment! Please read
the comments in the Vagrantfile as well as documentation on
`vagrantup.com` for more information on using Vagrant.

vagrant initコマンド実行時に先ほど取得したBox名を引数に指定します。

すると実行したディレクトリ内に指定したBoxを使用するためのVagrantfileのひな型が生成されます。

$ ls
Vagrantfile

実際にVagrantfileを確認すると下記の通りの記述になっています。

# -*- 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 = "generic/ubuntu1804"
  
  # 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
  # Ansible, Chef, Docker, Puppet and Salt 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

上記のVagrantfileを編集して構成を作るのですが、今回はデフォルトのまま立ち上げを行ってみたいと思います。

Vagrantを実行して仮想環境を構築する

生成したVagrantfileが配置されているディレクトリ内でvagrant upコマンドを実行してみましょう。

$ vagrant up

vagrant upコマンドを実行するとVagrant Cloudから指定したBoxファイルをダウンロードしてきます。すでに過去に取得しているBoxファイルであれば、ダウンロードプロセスはスキップされて、仮想環境が構築されます。

これで仮想環境の構築が完了しました。

あれ？これだけ？はい、これだけです。細かくはVagrantfileでカスタマイズする櫃王がありますが、立ち上げは1コマンドでできます。しかも仮想環境を削除してもvagrant upコマンドで何度でも同じ環境を自動的に構築することができます。

構築した環境にログインしてみる

それではVagrantで構築した仮想環境にログインしてみたいと思います。VagrantfileでIPを設定するように定義している場合はSSHでのログインも可能ですが、Vagrantで構築した仮想環境へのログインはvagrant sshコマンドでログインすることができます。

$ vagrant ssh
---
vagrant@ubuntu1804:~$
vagrant@ubuntu1804:~$ pwd
/home/vagrant

ちょっとした検証環境とかを用意するときにサクッと用意できて非常に便利です。vagrant sshでログインした環境は通常のSSHでログインしたときのようにexitコマンドまたはctrl + d キーなどでログアウトすることができます。

VagrantfileでIPを定義してSSHを行う方法は設定が必要なので、別途記事にしたいと思います。

おまけ：構築した仮想環境をコマンドで削除する

今回Vagrantで構築した仮想環境はVirutalboxのGUIから削除することもできますが、せっかくなのでCUIでワンコマンドで削除してみましょう。

Vagrantで構築した仮想環境はVagrantfileが配置されているディレクトリから下記コマンドで破棄することができます。

$ vagrant halt

仮想環境を停止するときにはvagrant stopで停止できます。停止された仮想環境はvagrant startで起動することができます。vagrant haltでは仮想環境の停止と仮想環境の削除を行うので、ついついvagrant haltの方を使いがちなのですが、うっかり構築検証して残しておきたい仮想環境を削除しないように気をつけましょう（過去何度もやらかしてます・・・）