vagrant 関連のメモ

仮想マシン（Virtual Machine, VM）の作成・操作などを自動化するツール．下記のようなコマンドで VM を生成・操作できるようになる．

操作	コマンド	備考
起動	vagrant up	はじめての起動で まだ仮想環境に VM が登録されていない場合は登録も同時に行われる．
停止	vagrant halt
VM 状態確認	vagrant status
ssh で VM 操作	vagrant ssh
VM 破棄	vagrant destroy

何がいいの？

• コマンドラインで操作できる．
  従来は VM そのものの操作（VM 内の操作ではなく，マシンの電源を入れたり，マシンの再起動をかけたりするようなハードウェア操作）は，ホスト OS 側で VirtualBox などの仮想化ソフトウェアの GUI を目視・手動で行う前提だった．vagrant を導入することで，マシン再起動などの VM 自体の操作もコマンドラインでできるようになり，スクリプト等で自動化できるようになる．
• 仮想化ソフトウェアのちがいを吸収できる．
  VirtaulBox や VMware など，どの仮想化ソフトを使うかで具体的な操作が異なるが，vagrant を用いることで，例えば“VM 起動”であれば，いつでも“vagrant up”とすればよくなる．
• VM バリエーションの作り方を正規化できる．
  Web Server，DB Server など，いくつかの種類の VM を作成する場合，従来は特に決まったやり方はなく（ベスト プラクティスみたいなものはあったかも…でも，特にコレといって共通認識になっているやり方があったわけではないと思われる），個別にやり方を考えていた． vagrant では，ごくシンプルな空の VM ＋ 各種ミドルウェアをインストールするプロビジョニング フェーズにわけることで，VM バリエーションをつくる方法を提示している．

準備

※以降は ubuntu 14.04 を前提にしています．

仮想化ソフトウェア VirtualBox と vagrant をインストールする．

Box ファイルの作り方

流れは以下のとおり．

1. Box ファイルの元になる VM を作成する．ここは手動．
2. vagrant 用の適当なディレクトリをつくってカレント ディレクトリを移動しておく（Boxファイルや設定ファイル Vagrantfile はデフォルトでカレント ディレクトリから読まれるため）．
3. vagrant package --base コマンドで *.box ファイルを生成する．

Box ファイルの元になる VM の作成

Ubuntu 14.04 Desktop AMD64 を使って Box ファイルを作成する．［注　ネットで多種多様な Box ファイルが配布されていますので，必ずしも自力で作成する必要はありません．が，自分でつくってみたいのが人情だと思いますますので…　ちなみに，ネット上で配布されている Box ファイルを利用する場合，ダウンロードする必要すらなく，vagrant コマンドに Box ファイルがおいてる URL を指定して実行できますので，ほんとに手間なしです．］

• ユーザー アカウントの準備
  • “vagrant”というユーザーを作成する．パスワードも“vagrant”にしておく．
    $ sudo useradd -m vagrant
    $ sudo passswd vagrant
  • ユーザー vagrant はパスワードなしで sudo できるようにしておく．具体的には sudo visudo コマンドで /etc/sudoers に下記の1行を追加しておく．［※最下行に追加しておくことを おすすめします．sudoers では下に書かれた設定でオーバーライドされていくため，追加した行より下に NOPASSWD なしの %admin ALL=(ALL:ALL) ALL のような設定があって，ユーザー vagrant もパターンにマッチしてしまったりすると上書きされて NOPASSWD が有効にならずに悩むことがありますので…．］
    vagrant ALL=(ALL:ALL) NOPASSWD: ALL
  • root ユーザーのパスワードも“vagrant”にしておく．
• ssh の準備
  vagrant では VM に対する操作を公開鍵認証の ssh で行うため，あらかじめ VM 内に ssh server を立ちあげておき，ユーザー vagrant の $HOME/.ssh/ に公開鍵を仕込んでおく必要がある．
  • ssh server をインストールする．
    $ sudo apt-get install openssh-server
    ［ubuntu 14.04 desktop を利用する場合，特別な設定は必要ありません．他のディストリビューションでは /etc/ssh/sshd_config の調整が必要になるかも．おそらく requiretty と UseDNS を無効にしておくなど…．］
  • ~vagrant/.ssh/ に公開鍵を仕込む．
    $ su vagrant
    $ cd ~
    $ mkdir .ssh
    $ chmod 700 .ssh
    $ cd .ssh
    $ ssh-keygen ［※秘密鍵 id_rsa と公開鍵 id_rsa.pub ができる．秘密鍵 id_rsa をホストOS側にコピーしておく．］
    $ mv id_rsa.pub authorized_keys
    $ chmod 644 authorized_keys
• VirtualBox Manager で Port Forwarding の設定を行う．
  この段階ではホストOS側から ssh コマンドを実行すると当然ながら自身の 22 番ポートにつなぎにいってしまうので，VirtualBoxで，2222 番ポートを VM 側の 22 番ポートに転送するように設定する（図1a，1b）．

図1a Port Forwarding 設定1	図1b Port Forwarding 設定2

ここまでの手順が正しければ，ホスト OS 側から下記の ssh コマンドで VM 側のユーザー vagrant にパスワードなしで（※ここ重要）ログインができるようになっているはず．

$ ssh vagrant@127.0.0.1 -p 2222

上記の設定の他に，ディストリビューションによっては，デフォルトでファイアウォールが設定されていて ssh が とおらなかったり，SELinux が有効になっているのがジャマをしていたりもする．Ubuntu Desktop はデスクトップ用のディストリビューションなので，利便性を優先した設計になっていて，簡単に Box ファイルをつくることができる．

パッケージング（Box ファイルの作成）

ホストOS側にもどり，下記のコマンドで Box ファイルを作成する（“ubuntu_1404”は ここまでの手順で VirtualBox 内に作成した VM の名称）．［注意　このコマンドは かなり時間がかかります．この原稿執筆時点で，VAIO Pro 13（Intel Core i7-4500U 1.8GHz）で約6分かかっています．元 VM（ubuntu_1404.vdi）のサイズは 5.0 GB，作成される Box ファイルは 1.7 GB です．］

$ mkdir ~/vagrant
$ cd ~/vagrant
$ vagrant package --base ubuntu_1404

カレントディレクトリに package.box というファイルができているはず．以上で Box ファイルの作成は完了． 以下は作成した Box ファイルから vagrant up するまでの手順…

設定ファイル Vagrantfile の作成

Box ファイルができたら（or どこかから Box ファイルを入手したら）vagrant の設定ファイル Vagrantfile を作成する．

vagrant は この Vagrantfile という1個のファイルに すべての設定を記述するようになっているので，このファイルだけをメンテナンスすればよい．また，コピーして別の環境にもっていったり削除して作りなおしたりも特別なコマンドは必要なく，通常の OS のコマンド（cp や rm など）を使えばよい．実にお気楽な透明さ．

$ vagrant init ubuntu

これでカレント ディレクトリに Vagrantfile ができる．

初期段階では ほぼすべての記述がコメントアウトされている状態になっているので，必要に応じてコメントを外して編集すればよい．とりあえず，下記の部分だけ修正しておけばよい．［ubuntu 14.04 では ssh-keygen で作成される秘密鍵ファイルの名前がデフォルト id_rsa になるので config.ssh.private_key_path の編集は必須．また，config.vm.provider は VM を起動したときに GUI 画面をだすかどうかをコントロールする部分で必須というわけではないが，テスト用にわかりやすいためコメントを外して有効にしている．サンプル Vagrantfile］

config.ssh.private_key_path = "~/.ssh/id_rsa"
config.vm.provider :virtualbox do |vb|
    # Don't boot with headless mode
    vb.gui = true
    # Use VBoxManage to customize the VM. For example to change memory:
    vb.customize ["modifyvm", :id, "--memory", "1024"]
end

vagrant からの VM の起動

ここまでの手順を正しく実施できていれば，下記のコマンドを実行するだけで，vagrant が Box ファイル（package.box）をタネに新しい VM を VirtualBox に登録して起動するところまで自動でやってくれる．

$ vagrant up

サンドボックス機能（sahara plug-in）

sahara プラグインをインストールすると vagrant コマンドから VM スナップショットをとって roll back などを行えるようになる．

$ vagrant plugin install sahara
$ vagrant plugin list
sahara (0.0.17)

Appendix

備考： Faild to mount folders in Linux guest ...

ubuntu など，Debian 系の Linux ディストリビューションをゲストOSにすると，VirtualBox のバグ[7][8]を踏んでしまう．このバグは，正確には VirtualBox Guest Additions 4.3.10 のもので，4.3.12 (VBoxGuestAdditions_4.3.12.iso)[9]など，少し新しいものを利用すれば解消する．

図　Issue #3341 を踏んだときの現象（クリックで拡大）

ダウンロードしてきた新しい VBoxGuestAdditions_*.iso を $HOME/.VirtualBox/ にコピーして，Oracle VM VirtualBox Manager の Settings → Storage でマウントしてあげれば，ゲストOS側で autorun が走って新しい Guest Additions が自動でインストールされる（ビルドに必要なツール kernel-headers, build-essentials は古い版の Guest Additions をビルドした際に既にはいっているので改めてインストールする必要はないはず）．

Links