vagrant-iijgp 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-iijgp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Takahiro HIMURA
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.ja.md

@@ -0,0 +1,106 @@
+# Vagrant IIJ GIO Provider
+
+これは [Vagrant](http://www.vagrantup.com) 1.3+ に IIJ GIO ホスティングパッケージサービスの
+仮想サーバを操作する機能を追加する provider です。
+
+## Features
+
+-   IIJ GIO ホスティングパッケージサービスの仮想マシンを起動することができます
+-   仮想サーバに SSH ログインができます
+-   Chef による仮想サーバの provisioning ができます
+-   `rsync` を用いた synced folder をサポートしています
+-   IIJ CentOS イメージに対して、いくつかの調整を行ないます
+    -   root ユーザに対する sudo の `Default requiretty` 設定を無効化します
+
+## Usage
+
+通常の Vagrant 1.1+ 以降のプラグインの導入方法と同様にインストールできます。
+インストール後は、`iijgp` provider を指定して `vagrant up` してください。
+以下に例を示します
+
+~~~~ {.shell}
+$ vagrant plugin install vagrant-iijgp
+...
+$ vagrant up --provider=iijgp
+...
+~~~~
+
+上記を実行する前に、iijgp 用の Vagrant box を入手しておく必要があります。
+
+## Quick Start
+
+プラグインを(前述の通り)インストールした後、
+手っ取り早く始めるには、ダミーの IIJGP box を使い、
+詳しいパラメータは `config.vm.provider` ブロックに都度指定する方法があります。
+まず、はじめにダミーの box を任意の名前で追加します:
+
+~~~~ {.shell}
+$ vagrant box add dummy https://...
+....
+~~~~
+
+次に、Vagrantfile を以下のように作成し、必要な情報を埋めてください。
+
+~~~~ {.ruby}
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  config.vm.provider :iijgp do |iijgp, override|
+    iijgp.access_key = "YOUR ACCESS KEY"
+    iijgp.secret_key = "YOUR SECRET KEY"
+    iijgp.gp_service_code = "gpXXXXXXXX"
+    iijgp.ssh_public_key = "YOUR PUBLIC SSH KEY"
+
+    override.ssh.username = "root"
+    override.ssh.private_key_path = "#{ENV['HOME']}/.ssh/id_rsa"
+  end
+
+  config.vm.define "vm1" do |c|
+    c.vm.provider :iijgp do |iijgp|
+      iijgp.gc_service_code = "gcXXXXXXXX"
+    end
+  end
+end
+~~~~
+
+そして `vagrant up --provider=iijgp vm1` を実行してください。
+
+これは、既に GP "gpXXXXXXXX" 内に作成済みの "gcXXXXXXXX" を起動します。
+また、SSH 用の情報が正しく Vagrantfile に設定されていれば、
+SSH と provisioning が行なわれます。
+
+もし、あなたが iijgp provider をデフォルトで利用したい場合、
+以下のようにシェルを設定することで、`vagrant up` だけで iijgp provider が利用できます。
+~~~~ {.shell}
+export VAGRANT_DEFAULT_PROVIDER=iijgp
+~~~~
+
+## Box Format
+
+全ての Vagrant provider は、それ用にカスタムの box を導入する必要があります。
+box の例は example_box/ ディレクトリにあります。
+
+## Configuration
+
+IIJ GIP provider 固有の設定は以下の通りとなります:
+
+-   必須パラメータ
+    -   `access_key` - IIJ API にアクセスするためのアクセスキー
+    -   `secret_key` - IIJ API にアクセスするためのシークレット
+    -   `gp_service_code` - 仮想サーバを実行する gp サービスコード
+    -   `ssh_public_key` - 仮想サーバにアクセスするための SSH 公開鍵の内容。
+        この設定は、仮想サーバを最初に起動する際のみ利用されます。
+        もし、SSH キーの設定を変更したい場合、仮想サーバの初期化をするか、
+        手動で ImportRootSshPublicKey API を実行する必要があります。
+-   任意
+    -   `label` - 仮想サーバのラベル。もし設定が無い場合には vagrant の vm name が利用されます
+    -   `virtual_machine_type` - 仮想サーバの品目。この設定は新規に仮想サーバを契約する場合のみ必要です
+    -   `os` - OS の種類。Chef provisioner を利用する場合、CentOS6 のイメージを指定する必要があります
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.md

@@ -0,0 +1,109 @@
+# Vagrant IIJ GIO Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.3+ plugin that adds a IIJGP provider to Vagrant,
+allowing Vagrant to control and provision VMs in IIJ GIO Hosting package service.
+
+## Features
+
+-   Boot Virtual Machines in IIJ GIO Hosting package service
+-   SSH into the VMs.
+-   Provision the VMs with the Chef provisioner.
+-   Supports synced folder via `rsync`.
+-   Do some tweaks for IIJ CentOS VM
+    -   disabling `Default requiretty` sudo settings for the root user.
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods.
+After installing, `vagrant up` and specify the `iijgp` provider.
+An example shown below.
+
+~~~~ {.shell}
+$ vagrant plugin install vagrant-iijgp
+...
+$ vagrant up --provider=iijgp
+...
+~~~~
+
+Of course prior to doing this, you'll need to obtain a iijgp-compatible box file for Vagrant.
+
+## Quick Start
+
+After installing the plugin (instructions above),
+the quickest way to get started is to actually use a dummy IIJGP box
+and specify all the details manually within a `config.vm.provider` block.
+So first, add the dummy box using any name you want:
+
+~~~~ {.shell}
+$ vagrant box add dummy https://github.com/iij/vagrant-iijgp/raw/master/dummy.box
+....
+~~~~
+
+And then make a Vagrantfile that looks like the following,
+filling in your informathion where necessary.
+
+~~~~ {.ruby}
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  config.vm.provider :iijgp do |iijgp, override|
+    iijgp.access_key = "YOUR ACCESS KEY"
+    iijgp.secret_key = "YOUR SECRET KEY"
+    iijgp.gp_service_code = "gpXXXXXXXX"
+    iijgp.ssh_public_key = "YOUR PUBLIC SSH KEY"
+
+    override.ssh.username = "root"
+    override.ssh.private_key_path = "#{ENV['HOME']}/.ssh/id_rsa"
+  end
+
+  config.vm.define "vm1" do |c|
+    c.vm.provider :iijgp do |iijgp|
+      iijgp.gc_service_code = "gcXXXXXXXX"
+    end
+  end
+end
+~~~~
+
+And then run `vagrant up --provider=iijgp vm1`.
+
+This will start the VM which is already created and specified with
+the service code "gcXXXXXXXX" in GP "gpXXXXXXXX".
+And if your SSH information was filled in properly,
+SSH and provisioning will work as well.
+
+If you always use iijgp provider as default, please set it in your shell setting:
+~~~~ {.shell}
+export VAGRANT_DEFAULT_PROVIDER=iijgp
+~~~~
+then you can simply run `vagrant up` with iijgp provider.
+
+## Box Format
+
+Every provider in Vagrant must introduce a custom box format.
+This provider introduce `iijgp` boxes.
+You can view an example box in the example_box/ directory.
+
+## Configuration
+
+There are some provider specific configuration option to control IIJ GIO VMs:
+
+-   mandatory parameters
+    -   `access_key` - The access key for manipulating IIJ API.
+    -   `secret_key` - The secret key for manipulating IIJ API.
+    -   `gp_service_code` - The gp service code to launch the VMs.
+    -   `ssh_public_key` - The SSH public key content to accessing IIJ VMs.
+        This is used only for the first start up of the VM.
+        If you intend to change the SSH key, you should initialize virtual machine.
+        (Or, call ImportRootSshPublicKey API manually...)
+-   optional parameters
+    -   `label` - The label for the VM. If it is missing, the vagrant VM name will be used.
+    -   `virtual_machine_type` - The type of virtual machine. This setting is only required if you want to add a new VM contract.
+    -   `os` - The operating system. If you intend to use Chef provisioner, you need to use a kind of CentOS6 images.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example_box/README.md

@@ -0,0 +1,10 @@
+# Vagrant IIJGP Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `iijgp` provider.
+
+To turn this into a box file:
+
+~~~~
+$ fakeroot tar cvzf dummy.box ./metadata.json ./Vagrantfile
+~~~~

data/example_box/Vagrantfile

@@ -0,0 +1,9 @@
+# -*- mode: ruby; coding: utf-8 -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.provider :iijgp do |iijgp|
+    iijgp.virtual_machine_type = "V10"
+    iijgp.os = "CentOS6_64_U"
+  end
+end

data/example_box/metadata.json

@@ -0,0 +1 @@
+{ "provider": "iijgp" }

data/lib/vagrant-iijgp/action/boot.rb

@@ -0,0 +1,28 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class Boot
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_iijgp::action::boot")
+        end
+
+        def call(env)
+          @env = env
+
+          env[:ui].info I18n.t("vagrant.actions.vm.boot.booting")
+          gp = env[:machine].provider_config.gp_service_code
+          gc = env[:machine].id
+
+          vm = env[:iijapi].gp(gp).gc(gc)
+          vm.start
+
+          env[:ui].info I18n.t("vagrant_iijgp.wait_for_start")
+          vm.wait_for_start { env[:ui].info "-- current_status: #{vm.status}" }
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/check_running.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class CheckRunning
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if env[:machine].state.id != :running
+            raise Vagrant::Errors::VMNotRunningError
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/create_vm.rb

@@ -0,0 +1,59 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class CreateVM
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_iijgp::action::create_vm")
+        end
+
+        def call(env)
+          @env = env
+
+          config = env[:machine].provider_config
+          gp = config.gp_service_code
+
+          if env[:machine].id.nil?
+            opts = {
+              "VirtualMachineType" => config.virtual_machine_type,
+              "OS" => config.os,
+              "ContractNum" => "1"
+            }
+            env[:ui].info "-- AddVirtualMachines option: #{opts}"
+
+            res = env[:iijapi].gp(gp).add_virtual_machines(opts)
+            env[:ui].info "-- AddVirtualMachines response: #{res}"
+            env[:machine].id = res['GcServiceCodeList'].first
+          end
+
+          gc = env[:machine].id
+          vm = env[:iijapi].gp(gp).gc(gc)
+
+          retry_left = config.api_max_retry_count
+          begin
+            vm.wait_while(proc { vm.contract_status! == "InPreparation" }) do
+              env[:ui].info "-- contract status: #{vm.contract_status}"
+            end
+          rescue IIJ::Sakagura::Core::Error::APIError => e
+            env[:ui].warn "Failed to fetch the status of contract: #{e.inspect}"
+            retry_left -= 1
+            if retry_left > 0
+              sleep config.api_retry_wait
+              retry
+            else
+              raise
+            end
+          end
+
+          env[:ui].info I18n.t("vagrant_iijgp.import_root_ssh_public_key")
+          vm.import_ssh_public_key(config.ssh_public_key)
+
+          env[:ui].info I18n.t("vagrant_iijgp.wait_for_configured")
+          vm.wait_while(proc { vm.status! == "Configuring" }) { env[:ui].info "-- current_status: #{vm.status}" }
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/destroy.rb

@@ -0,0 +1,27 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class Destroy
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_iijgp::action::destroy")
+        end
+
+        def call(env)
+          env[:ui].info I18n.t("vagrant_iijgp.initialize_vm")
+
+          gp = env[:machine].provider_config.gp_service_code
+          gc = env[:machine].id
+
+          vm = env[:iijapi].gp(gp).gc(gc)
+          vm.initialize_vm
+
+          env[:ui].info I18n.t("vagrant_iijgp.wait_for_stop")
+          vm.wait_while(proc { vm.status! == "Initializing" }) { env[:ui].info "-- current_status: #{vm.status}" }
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/is_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/is_stopped.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class IsStopped
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :stopped
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/message_already_running.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class MessageAlreadyRunning
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info I18n.t("vagrant_iijgp.vm_already_running", :name => env[:machine].name)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/message_invalid_status.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class MessageInvalidStatus
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info I18n.t("vagrant_iijgp.invalid_status", :name => env[:machine].name, :state => env[:machine_state])
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/message_not_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class MessageNotCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info I18n.t("vagrant_iijgp.vm_not_created", :name => env[:machine].name)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/message_will_not_destroy.rb

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class MessageWillNotDestroy
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info I18n.t("vagrant.commands.destroy.will_not_destroy",
+                              :name => env[:machine].name)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/prepare_iijapi.rb

@@ -0,0 +1,38 @@
+require 'iij/sakagura'
+
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class PrepareIIJAPI
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_iijgp::action::prepare_iijapi")
+        end
+
+        def call(env)
+          config = env[:machine].provider_config
+
+          # use the existing gc contract.
+          if config.gc_service_code
+            if env[:machine].id.nil?
+              # first time `vagrant up`
+              env[:machine].id = config.gc_service_code
+            elsif config.gc_service_code != env[:machine].id
+              raise Errors::MismatchServiceCode, :provider_config => config.gc_service_code, :machine_id => env[:machine].id
+            end
+          end
+
+          opts = {
+            :access_key => config.access_key,
+            :secret_key => config.secret_key
+          }
+          opts[:endpoint] = config.endpoint if config.endpoint
+
+          env[:iijapi] = IIJ::Sakagura::GP::Client.new(opts)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/read_ssh_info.rb

@@ -0,0 +1,27 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class ReadSSHInfo
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_iijgp::action::read_ssh_info")
+        end
+
+        def call(env)
+          env[:machine_ssh_info] = read_ssh_info(env[:iijapi], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_ssh_info(cli, machine)
+          vm = cli.gp(machine.provider_config.gp_service_code).gc(machine.id)
+
+          {
+            :host => vm.info['GlobalAddress']['IPv4Address'],
+            :port => 22
+          }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/read_state.rb

@@ -0,0 +1,41 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class ReadState
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_iijgp::action::read_state")
+        end
+
+        def to_snake_sym(str)
+          str.gsub(/[A-Z]/) {|s| "_#{s.downcase}" }.sub(/^_/, '').to_sym
+        end
+
+        def call(env)
+          env[:machine_state] = read_state(env)
+          @app.call(env)
+        end
+
+        def read_state(env)
+          machine = env[:machine]
+          return :not_created if machine.id.nil?
+
+          vm = env[:iijapi].gp(machine.provider_config.gp_service_code).gc(machine.id)
+          if contract_status = vm.contract_status
+            if contract_status == "InService"
+              return to_snake_sym(vm.status)
+            elsif contract_status == "InPreparation"
+              return :in_preparation
+            else
+              machine.id = nil
+              return :not_created
+            end
+          else
+            machine.id = nil
+            return :not_created
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-iijgp/action/set_label.rb

@@ -0,0 +1,25 @@
+module VagrantPlugins
+  module ProviderIijGp
+    module Action
+      class SetLabel
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_iijgp::action::set_label")
+        end
+
+        def call(env)
+          gp = env[:machine].provider_config.gp_service_code
+          gc = env[:machine].id
+
+          vm = env[:iijapi].gp(gp).gc(gc)
+          label = env[:machine].provider_config.label || env[:machine].name.to_s || Time.now.strftime('%F %T')
+
+          @logger.info("Setting the label of the VM [#{gp}/#{gc}]: #{label}")
+          vm.label = label
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end