Vagrant Sakura Provider

この gem は Vagrant に さくらのクラウド上のサーバを操作する 機能を追加する provider です。

機能 / 制限

• さくらのクラウド上にサーバを作成できます。
• サーバに SSH ログインできます。
• サーバを停止/再開(オフ/オン)できます。
• Chef をはじめとする provisioner が動きます。

なお Chef を利用する場合は vagrant-omnibus プラグインを使ってサーバ上に Chef をインストールしてください。

インストール

通常の Vagrant 1.1+ 以降のプラグインの導入方法でインストールできます。 インストール後は sakura プロバイダを指定して vagrant up してください。 以下に例を示します:

$ vagrant plugin install vagrant-sakura
...
$ vagrant up --provider=sakura
...

なお実行前にさくらのクラウド用の Vagrant box を取得しておく必要があります。

かんたんな使い方

プラグインを(先述の通りに)インストールしたら、てっとり早く始めるためには ダミーのさくらのクラウド用 box を使い、詳細は config.vm.provider で 指定します。 まずはじめに、ダミーの box を好きな名前で追加してください:

$ vagrant box add dummy https://github.com/tsahara/vagrant-sakura/raw/master/dummy.box
...

次に、以下のような Vagrantfile を作成し、必要な情報を埋めてください。

Vagrant.configure("2") do |config|
  config.vm.box = "dummy"
  config.ssh.username = "ubuntu"
  config.ssh.private_key_path = File.expand_path "~/.ssh/id_rsa"

  config.vm.provider :sakura do |sakura|
    sakura.access_token = 'YOUR ACCESS TOKEN'
    sakura.access_token_secret = 'YOUR ACCESS TOKEN SECRET'
    sakura.sshkey_id = 'YOUR PUBLIC KEY ID'
  end
end

そして vagrant up --provider=sakrua を実行してください。

サーバのディスクソースを sakura.disk_source_archive で指定しなかった 場合のデフォルトは 112500182464 で Ubuntu 12.04.2LTS-server 64bit です。 このディスクソースのログインアカウントは root ではないため、 config.ssh.username で指定してやる必要があります。

なお、さくらのクラウド API を利用するための API キー(ACCESS TOKEN)と シークレットトークン(ACCESS TOKEN SECRET)は環境変数 SAKURA_ACCESS_TOKEN と SAKURA_ACCESS_TOKEN_SECRETで指定することも できます。

コマンド

sakura-list-id コマンドを使って、Vagrantfile で指定するリソース ID を調べることができます。

$ vagrant sakuara-list-id
...

設定

さくらのクラウド provider では以下の設定ができます:

• access_token - さくらのクラウド API にアクセスするための API キー
• access_token_secret - API キーのシークレットトークン
• disk_plan - サーバで利用するディスクのプラン ID
• disk_source_archive - サーバで利用するディスクのベースとするアーカイブ
• server_name - サーバ名
• server_plan - 作成するサーバのプラン ID
• sshkey_id - サーバへのログインに利用する SSH 公開鍵のリソース ID
• zone_id - ゾーン ID (石狩第1=is1a, 石狩第2=is1b)

ネットワーク

vagrant-sakura は config.vm.network を利用したネットワークの構築を まだサポートしていません。

開発

vagrant-sakura プラグインをいじる場合は、リポジトリを clone してから Bundler を使って依存関係を解決してください。

$ bundle

依存パッケージが入ったら、。。。 開発を始められます。 Vagrantfile を clone したディレクトリに置いて (.gitignore に書いてあるので git には無視されます)、 以下の行を Vagrantfile に足してやれば、プラグインをインストールしなくても 開発中の Vagrant 環境をテストすることができます。

Vagrant.require_plugin "vagrant-sakura"

Vagrant を実行する時は bundler を使ってください:

$ bundle exec vagrant up --provider=sakura