vagrant-sakura 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 945fc69723e0d563c7daeb0ae6a40271166dbcf6
-  data.tar.gz: c7ce8eaf073dc58e7408507907bc1c695a8005ae
+SHA256:
+  metadata.gz: 8710a8b87c7c07ffeb170510c46699d89a2b24da2dbf92928c1e655cfa333d88
+  data.tar.gz: 5969024cdd2bc5db362b811ee69b1a3b1dd4df5d6b277909eea45122d6bebfe2
 SHA512:
-  metadata.gz: f75e242e6e681c00957bef08bfbc9d0843d07fd0dc99e8492f8c2adce5bd287a414634078afcd1e5555810ec682167933954929ee06585ea4df0b5b09e75032d
-  data.tar.gz: 870c6fb96b0cc5ae989ebbe6ae73c18c4fa50fb87de7d159341235edbcbe852274339f62f8d8ac0a359194d819f0d7bc82c6abe53742c00250bea7dac16e82a0
+  metadata.gz: cb1570c46e1d5135fe342b227e41bd91303af5d993cc43c2f490136cf2ae3806d1d47ee17206c3505eb1817df68b55c2bd46754f541cfcdbf36d4e6dee59c54a
+  data.tar.gz: ca48864c5e4de22d8838cd97d813c5ec1463cdf0805641fa2cb3649d6036888ccade416220d04985ec15a640c83bb0fafc74a9e1069ce9d1e68bb6ec2bcdc4d5

data/.gitignore

@@ -17,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/

data/.travis.yml

@@ -0,0 +1,30 @@
+sudo: false
+language: ruby
+cache: bundler
+
+addons:
+  apt:
+    packages:
+    - bsdtar
+rvm:
+- 2.3.7
+- 2.4.4
+- 2.5.0
+- 2.5.1
+
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+script: bundle exec rake test
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: dPtjpKnaDadiUGiO/ZZG+CK0GRChirb6qbr5UawJff3X1POtU/Q7AXOfwYkMEZv55NT098jvtqPDcAA7ilqQu6Pb1YO51FnHqXk5UPqksCMcAucQX6ByL3V1X8Vliw2rbvKw8BTg9IoNotu6bDIFMDdU0Gz0iU35U9efkxIX+Rc=
+  on:
+    tags: true
+
+notifications:
+  slack:
+    secure: d9jmDMPRbEHfKTmY+FqYNovtDTag+NNBVE2W3YYkGLp4QCGiaHSlV6rCDDmX02fUOtLgA1FrsJJpS17/3sBG6JX3aWh4wIWW8XCzrzUmItWa25J/Fj3KutbJN0pYXeEVDR8Cw0OoAZpzlgBOBbe5mcCpPhHhe3gTUaRBxqCiQII=

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 0.1.0 (2018/09/10)
+
+- Use usacloud config (#28)
+- Use TravisCI (#29)
+- Add startup script config (#31)
+- Add packer filter config (#32)
+- Add os_type config (#33)
+- Add sakura-reinstall command (#36)
+- Add enable_pw_auth config (#37)
+
 ## 0.0.9 (2018/07/13)
 
 ### General

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 group :development do
   gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git", :tag => 'v2.1.2'
   gem "test-unit", "~> 3.2.3"
+  # gem "test-unit-rr", "~> 1.0.5"
+  gem "rake", "~> 12.0.0"
 end
 
 group :plugins do

data/README.md

@@ -1,7 +1,8 @@
 # Vagrant Sakura Provider
 
 [![Gem Version](https://badge.fury.io/rb/vagrant-sakura.png)](http://badge.fury.io/rb/vagrant-sakura)
-
+[![Build Status](https://travis-ci.org/sacloud/vagrant-sakura.svg?branch=master)](https://travis-ci.org/sacloud/vagrant-sakura)
+[![Slack](https://slack.usacloud.jp/badge.svg)](https://slack.usacloud.jp/)  
 
 この gem は [Vagrant](http://www.vagrantup.com) に
 [さくらのクラウド](http://cloud.sakura.ad.jp)上のサーバを操作する
@@ -57,8 +58,8 @@ Vagrant.configure("2") do |config|
   config.ssh.username = "ubuntu"
 
   config.vm.provider :sakura do |sakura|
-    sakura.access_token = 'YOUR ACCESS TOKEN'
-    sakura.access_token_secret = 'YOUR ACCESS TOKEN SECRET'
+    sakura.access_token = '<YOUR ACCESS TOKEN>'
+    sakura.access_token_secret = '<YOUR ACCESS TOKEN SECRET>'
     sakura.use_insecure_key = true
   end
 end
@@ -66,24 +67,64 @@ end
 
 そして ``vagrant up --provider=sakura`` を実行してください。
 
-サーバのディスクソースを ``sakura.disk_source_archive`` で指定しなかった
-場合のデフォルトは ``113000423772`` で
-Ubuntu Server 16.04.4 LTS 64bit(石狩第2ゾーン)
-です。
+サーバのディスクソース(OS)は ``sakura.disk_source_archive`` または``sakura.os_type``で指定します。  
+デフォルトでは``sakura.os_type="ubuntu"``となっています。
+
+> 注: ディスクソースに指定するOSに応じて`config.ssh.username`を適切に指定する必要があります。  
+詳細は`os_type`の説明を参照してください。
+
+## APIキーの指定
+
+さくらのクラウド API を利用するための APIキー(トークン/シークレット/ゾーン)は 以下の3通りの方法で指定できます。
 
-> ※注: アーカイブのIDはゾーンごとに異なります
+ 1. Vagrantfileに直接記載
+ 2. さくらのクラウド CLI [Usacloud](https://github.com/sacloud/usacloud)の設定ファイル
+ 3. 環境変数
 
-このディスクソースのログインアカウントは ``root`` ではないため、
-``config.ssh.username`` で指定してやる必要があります。
+> 複数指定されている場合はより上に記載されているものが優先されます。
 
-なお、さくらのクラウド API を利用するための API キー(ACCESS TOKEN)と
-シークレットトークン(ACCESS TOKEN SECRET)は環境変数
-``SAKURA_ACCESS_TOKEN`` と ``SAKURA_ACCESS_TOKEN_SECRET``で指定することも
-できます。
+### 1. Vagrantfileに直接記載
+
+以下のようにVagrantfileに直接記載する方法です。
+
+```Ruby
+  config.vm.provider :sakura do |sakura|
+    sakura.access_token = '<YOUR ACCESS TOKEN>'
+    sakura.access_token_secret = '<YOUR ACCESS TOKEN SECRET>'
+    sakura.zone_id = '< is1a / is1b / tk1a >'
+    
+    # ...
+  end
+```
+
+### 2. さくらのクラウド CLI Usacloudの設定ファイル
+
+[Usacloud](https://github.com/sacloud/usacloud)の設定ファイルを利用する方法です。  
+UsacloudにてAPIキーの設定(`usacloud config`コマンドの実行など)を行なっておけばvagrant-sakura が自動的にUsacloudの設定ファイルを読み込みます。
+この機能を利用すればVagrantfileにAPIキー関連の設定を記載する必要はありません。
+
+デフォルトでは`~/.usacloud/<current_profile>/config.json`ファイルが利用されます。  
+任意のUsacloud設定ファイルを利用したい場合、Vagrantfileに`config_path`を指定することで利用する設定ファイルを指定できます。
+
+```Ruby
+  config.vm.provider :sakura do |sakura|
+    sakura.config_path = 'your/config/file.json'
+    # ...
+  end
+```
+
+### 3. 環境変数
+
+環境変数でAPIキーを指定可能です。  
+Usacloudや[Packer for さくらのクラウド](https://github.com/sacloud/packer-builder-sakuracloud)、[Terraform for さくらのクラウド](https://github.com/sacloud/terraform-provider-sakuracloud)と共通の環境変数を利用できます。  
+
+- API アクセストークン: `SAKURACLOUD_ACCESS_TOKEN` または `SAKURA_ACCESS_TOKEN`
+- API シークレット: `SAKURACLOUD_ACCESS_TOKEN_SECRET` または `SAKURA_ACCESS_TOKEN_SECRET`
+- ゾーン: `SAKURACLOUD_ZONE`
 
 ## SSH 鍵の指定方法
 
-vagrant-sakura では、サーバにログインするための SSH 公開鍵を 3通りの方法で
+vagrant-sakura では、サーバにログインするための SSH 公開鍵を 以下の3通りの方法で
 設定できます。
 
  1. コントロールパネルで設定済みの SSH 公開鍵をリソース ID で指定する。
@@ -111,6 +152,18 @@ vagrant-sakura では、サーバにログインするための SSH 公開鍵を
 
 
 ## コマンド
+
+#### OSの再インストール
+
+`sakura-reinstall` コマンドを使って、ディスクに対しOSの再インストールを行うことができます。
+
+```
+$ vagrant sakura-reinstall
+...
+```
+
+#### 各種IDの一覧表示
+
 `sakura-list-id` コマンドを使って、`Vagrantfile` で指定するリソース ID
 を調べることができます。
 ```
@@ -125,13 +178,30 @@ $ vagrant sakura-list-id
 - ``access_token`` - さくらのクラウド API にアクセスするための API キー
 - ``access_token_secret`` - API キーのシークレットトークン
 - ``disk_plan`` - サーバで利用するディスクのプラン ID
-- ``disk_source_archive`` - サーバで利用するディスクのベースとするアーカイブ
+- ``os_type`` - サーバで利用するディスクのベースとするアーカイブの種別 (※ `disk_source_archive`とは同時に指定できません)  
+指定可能な値は以下の通りです。  
+
+|指定可能な値|SSHユーザー名|Vagrantfileの例|備考|
+|---|---|:---:|---|
+|`ubuntu`(デフォルト)|`ubuntu`| [example](examples/ubuntu.md) | - |
+|`centos`|`root`| [example](examples/centos.md) | - |
+|`centos6`|`root`| [example](examples/centos6.md) | - |
+|`debian`|`root`| [example](examples/debian.md) | - |
+|`coreos`|`core`| [example](examples/coreos.md) | - |
+|`freebsd`|`root`| [example](examples/freebsd.md) | - |
+|`rancheros`|`rancher`| [example](examples/rancheros.md) | メモリ2GB以上のプランが必要 |
+
+- ``disk_source_archive`` - サーバで利用するディスクのベースとするアーカイブのID (※`os_type`とは同時に指定できません)
 - ``server_name`` - サーバ名
 - ``server_plan`` - 作成するサーバのプラン ID
+- ``packet_filter`` - 作成するサーバに適用するパケットフィルタ ID
+- ``startup_scripts`` - 作成するサーバに適用するスタートアップスクリプト ID(リスト)
+- ``enable_pw_auth`` - パスワード認証の有効化(デフォルト: `false`)
 - ``tags`` - 作成するサーバ/ディスクのタグ(リスト)
 - ``description`` - 作成するサーバ/ディスクの説明
 - ``sshkey_id`` - サーバへのログインに利用する SSH 公開鍵のリソース ID
 - ``zone_id`` - ゾーン ID (石狩第1=`is1a`, 石狩第2=`is1b`、東京第1=`tk1a`、デフォルトは`is1b`)
+- ``config_path`` - APIキーが記載されたUsacloud設定ファイルのパス
 
 ## ネットワーク
 ``vagrant-sakura`` は ``config.vm.network`` を利用したネットワークの構築を

data/Rakefile

@@ -1,3 +1,8 @@
 require 'rubygems'
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+Rake::TestTask.new do |test|
+  test.warning = false
+end

data/examples/centos.md

@@ -0,0 +1,15 @@
+# Vagrantfileの例(CentOS7を利用する場合)
+
+```bash
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.username = "root"
+
+  config.vm.provider :sakura do |sakura, override|
+    sakura.os_type = "centos"
+    
+    sakura.public_key_path        = File.expand_path("~/.ssh/id_rsa.pub")
+    override.ssh.private_key_path = File.expand_path("~/.ssh/id_rsa")
+  end
+end
+```

data/examples/centos6.md

@@ -0,0 +1,15 @@
+# Vagrantfileの例(CentOS6を利用する場合)
+
+```bash
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.username = "root"
+
+  config.vm.provider :sakura do |sakura, override|
+    sakura.os_type = "centos6"
+    
+    sakura.public_key_path        = File.expand_path("~/.ssh/id_rsa.pub")
+    override.ssh.private_key_path = File.expand_path("~/.ssh/id_rsa")
+  end
+end
+```

data/examples/coreos.md

@@ -0,0 +1,15 @@
+# Vagrantfileの例(CoreOS/ContainerLinuxを利用する場合)
+
+```bash
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.username = "core"
+
+  config.vm.provider :sakura do |sakura, override|
+    sakura.os_type = "coreos"
+    
+    sakura.public_key_path        = File.expand_path("~/.ssh/id_rsa.pub")
+    override.ssh.private_key_path = File.expand_path("~/.ssh/id_rsa")
+  end
+end
+```

data/examples/debian.md

@@ -0,0 +1,15 @@
+# Vagrantfileの例(Debianを利用する場合)
+
+```bash
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.username = "root"
+
+  config.vm.provider :sakura do |sakura, override|
+    sakura.os_type = "debian"
+    
+    sakura.public_key_path        = File.expand_path("~/.ssh/id_rsa.pub")
+    override.ssh.private_key_path = File.expand_path("~/.ssh/id_rsa")
+  end
+end
+```

data/examples/freebsd.md

@@ -0,0 +1,17 @@
+# Vagrantfileの例(FreeBSDを利用する場合)
+
+```bash
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.username = "root"
+  config.ssh.shell = "sh"
+  config.vm.synced_folder ".", "/vagrant", id: "vagrant-root", disabled: true
+
+  config.vm.provider :sakura do |sakura, override|
+    sakura.os_type = "freebsd"
+    
+    sakura.public_key_path        = File.expand_path("~/.ssh/id_rsa.pub")
+    override.ssh.private_key_path = File.expand_path("~/.ssh/id_rsa")
+  end
+end
+```

data/examples/rancheros.md

@@ -0,0 +1,17 @@
+# Vagrantfileの例(RancherOSを利用する場合)
+
+```bash
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.username = "rancher"
+  config.vm.synced_folder ".", "/vagrant", id: "vagrant-root", disabled: true
+
+  config.vm.provider :sakura do |sakura, override|
+    sakura.os_type = "rancheros"
+    sakura.server_plan = 4002 # 2core/4GBメモリ プラン
+    
+    sakura.public_key_path        = File.expand_path("~/.ssh/id_rsa.pub")
+    override.ssh.private_key_path = File.expand_path("~/.ssh/id_rsa")
+  end
+end
+```

data/examples/ubuntu.md

@@ -0,0 +1,15 @@
+# Vagrantfileの例(Ubuntuを利用する場合)
+
+```bash
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.username = "ubuntu"
+
+  config.vm.provider :sakura do |sakura, override|
+    sakura.os_type = "ubuntu"
+    
+    sakura.public_key_path        = File.expand_path("~/.ssh/id_rsa.pub")
+    override.ssh.private_key_path = File.expand_path("~/.ssh/id_rsa")
+  end
+end
+```

data/lib/vagrant-sakura/action/complete_archive_id.rb

@@ -0,0 +1,38 @@
+require 'log4r'
+require 'vagrant-sakura/driver/api'
+require "vagrant-sakura/os_type"
+
+module VagrantPlugins
+  module Sakura
+    module Action
+      class CompleteArchiveId
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_sakura::action::complete_archive_id")
+        end
+
+        def call(env)
+          config = env[:machine].provider_config
+          if config.disk_source_mode == :os_type
+            api = env[:sakura_api]
+
+            filter = VagrantPlugins::Sakura::OSType::OS_TYPE_QUERIES[config.os_type]
+            raise 'invalid os_type' if filter.nil?
+
+            data = {
+                "Filter" => filter
+            }
+            response = api.get("/archive", data)
+            raise "os_type `#{config.os_type}` is not found" if response.nil? || response["Archives"].nil? || response["Archives"].empty?
+
+            config.disk_source_archive = response["Archives"][0]["ID"]
+          else
+            config.os_type = ""
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-sakura/action/reinstall.rb

@@ -0,0 +1,114 @@
+require 'vagrant/util/retryable'
+
+require 'vagrant-sakura/driver/api'
+#require 'vagrant-sakura/util/timer'
+require 'log4r'
+
+module VagrantPlugins
+  module Sakura
+    module Action
+      class Reinstall
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_sakura::action::run_instance")
+        end
+
+        def call(env)
+          disk_source_archive = env[:machine].provider_config.disk_source_archive
+          os_type = env[:machine].provider_config.os_type
+          sshkey_id = env[:machine].provider_config.sshkey_id
+          public_key_path = env[:machine].provider_config.public_key_path
+          use_insecure_key = env[:machine].provider_config.use_insecure_key
+          enable_pw_auth = env[:machine].provider_config.enable_pw_auth
+          startup_scripts = env[:machine].provider_config.startup_scripts
+
+          api = env[:sakura_api]
+          serverid = env[:machine].id
+          diskid = env[:machine].provider_config.disk_id
+
+          unless env[:machine].provider_config.disk_id
+            begin
+              response = api.get("/server/#{serverid}")
+            rescue Driver::NotFoundError
+              raise 'server not found'
+            end
+            diskid = response["Server"]["Disks"][0]["ID"]
+          end
+
+          env[:ui].info(I18n.t("vagrant_sakura.reinstalling_disk"))
+          env[:ui].info(" -- Target Disk ID: #{diskid}") if os_type
+          env[:ui].info(" -- Disk Source OS Type: #{os_type}") if os_type
+          env[:ui].info(" -- Disk Source Archive: #{disk_source_archive}")
+          env[:ui].info(" -- Startup Scripts: #{startup_scripts.map {|item| item["ID"]}}") unless startup_scripts.empty?
+
+         data = {
+             "Disk" => {
+                 "SourceArchive" => {
+                     "ID" => disk_source_archive
+                 },
+             }
+         }
+         response = api.put("/disk/#{diskid}/install", data)
+
+         while true
+           response = api.get("/disk/#{diskid}")
+           case response["Disk"]["Availability"]
+           when "available"
+             break
+           when "migrating"
+             migrated = response["Disk"]["MigratedMB"]
+             size = response["Disk"]["SizeMB"]
+             env[:ui].info("Disk #{diskid} is migrating (#{migrated}/#{size})")
+           else
+             status = presponse["Disk"]["Availability"]
+             env[:ui].info("Disk #{diskid} is #{status}")
+           end
+           sleep 3
+         end
+
+          data = {
+              "UserSubnet" => {},
+              "Notes" => startup_scripts,
+              "DisablePWAuth" => !enable_pw_auth
+          }
+          if sshkey_id
+            data["SSHKey"] = { "ID" => sshkey_id }
+          elsif public_key_path
+            data["SSHKey"] = { "PublicKey" => File.read(public_key_path) }
+          elsif use_insecure_key
+            pubkey = Vagrant.source_root.join("keys", "vagrant.pub").read.chomp
+            data["SSHKey"] = { "PublicKey" => pubkey }
+          else
+            raise 'failsafe'
+          end
+
+          response = api.put("/disk/#{diskid}/config", data)
+          # Config
+
+          response = api.put("/server/#{serverid}/power")
+          # Power On
+
+          if !env[:interrupted]
+            # Wait for SSH to be ready.
+            env[:ui].info(I18n.t("vagrant_sakura.waiting_for_ssh"))
+            while true
+              break if env[:interrupted]
+              break if env[:machine].communicate.ready?
+              sleep 2
+            end
+
+            #@logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")
+
+            # Ready and booted!
+            env[:ui].info(I18n.t("vagrant_sakura.ready"))
+          end
+
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end