knife-nc 0.0.0 → 0.0.1

data/README.md

@@ -14,7 +14,7 @@ knife-ec2 と同じように、インスタンスを作成した上で Chef の
 	# "chef" gem のインストール
 	gem install chef
 
-        # "ニフティクラウドSDK for Ruby" のインストール
+	# "ニフティクラウドSDK for Ruby" のインストール
 	wget http://cloud.nifty.com/api/sdk/NIFTY_Cloud_SDK_for_ruby.zip
 	cd NIFTY_Cloud_SDK_for_ruby
 	rake install
@@ -25,33 +25,40 @@ knife-ec2 と同じように、インスタンスを作成した上で Chef の
 
 # 設定
 
-NIFTY CLoud REST API と通信するため、knife コマンドにアクセスキー／シークレットキーを教えてやる必要があります。
+NIFTY Cloud REST API と通信するため、knife コマンドにアクセスキー／シークレットキーを教えてやる必要があります。
 knife.rb に設定するのが一番簡単でしょう。
 
-	knife[:nc_access_key_id]  = "Your NIFTY Cloud Access Key ID"
-	knife[:nc_secret_access_key] = "Your NIFTY Cloud Secret Access Key"
+	knife[:nc_access_key] = "Your NIFTY Cloud Access Key"
+	knife[:nc_secret_key] = "Your NIFTY Cloud Access Key"
 
 knife.rb をバージョン管理システムにコミットしている場合 (つまり誰でも閲覧可能になっている場合) には、
 環境変数から読み込ませることも可能です。
 
-	knife[:nc_access_key_id] = "#{ENV['NIFTY_CLOUD_ACCESS_KEY_ID']}"
-	knife[:nc_secret_access_key] = "#{ENV['NIFTY_CLOUD_SECRET_ACCESS_KEY']}"
+	knife[:nc_access_key] = "#{ENV['NIFTY_CLOUD_ACCESS_KEY']}"
+	knife[:nc_secret_key] = "#{ENV['NIFTY_CLOUD_SECRET_KEY']}"
 
 アクセスキー／シークレットキーは knife サブコマンドの -A (--nc-access-key) と -K (--nc-secret-key) オプションで指定することもできます。
 
 	# provision a new mini instance
-	knife ec2 server create -r 'role[webserver]' -I 1 -T mini -A 'Your NIFTY Cloud Access Key ID' -K "Your AWS Secret Access Key"
+	knife nc server create -r 'role[webserver]' -I 1 -T mini -A 'Your NIFTY Cloud Access Key' -K "Your NIFTY Cloud Secret Key"
 
 さらに下記のオプションが knife.rb に設定可能です。
 
- * 
- * 
+ * nc_instance_type
+ * nc_image_id
+ * nc_ssh_key_id
+ * nc_bootstrap_version
+ * nc_distro
+ * nc_template_file
+ * nc_user_data
 
 ## サブコマンド一覧
 
 ### knife nc server create
 
-NIFTY Cloud 上にインスタンスを作成し SSH 経由で Chef のブートストラップを行います。「ブートストラップ」というのは Chef をインストールして Chef クライアントとして Chef サーバと通信できるようにすることです。デフォルトでは centos5-gems テンプレートでブートストラップを行います。-d オプションか --template-file オプションで振る舞いを上書きすることができます。インスタンス作成時、あとから knife コマンド経由で削除可能とするために、diableApiTermination を false に設定することに注意してください。
+NIFTY Cloud 上にインスタンスを作成し SSH 経由で Chef のブートストラップを行います。「ブートストラップ」というのは Chef をインストールして Chef クライアントとして Chef サーバと通信できるようにすることです。利用するブートストラップ・スクリプトは指定したイメージ ID によって自動的に検出されますが、-d オプションや --template-file オプションで上書きすることもできます。インスタンス作成時、あとから knife コマンド経由で削除可能とするために、diableApiTermination を false に設定することに注意してください。
+
+また、v0.0.1 からは独自オプションとして -R または --ssh-passphrase オプションで SSH パスフレーズが指定できるようになりました。
 
 ### knife nc server delete
 
@@ -66,17 +73,33 @@ NIFTY Cloud 上にインスタンスを作成し SSH 経由で Chef のブート
 knife-ec2 にはないオリジナルのコマンドです。現在のアカウントで利用可能なイメージの一覧を表示します。
 knife nc server create コマンドの -I オプションに渡す Image ID を確認するために利用してください。
 
+## NIFTY Cloud イメージ向けブートストラップ
+
+knife-nc gem には NIFTY Cloud で提供されているイメージに最適化された 2 つのブートストラップ・スクリプト (nc-centos5-gems, nc-centos6-gems) が同梱されています。
+knife nc server create を利用する際にはイメージ ID に応じて自動で利用すべきスクリプトの判別が行われます。
+knife bootstrap からこのスクリプトを利用するには下記のように -d オプションで識別子を指定してください。
+
+    knife bootstrap XXX.XXX.XXX.XXX -d nc-centos5-gems
+
+なお、サポート対象のイメージ ID と各イメージ ID に対応するスクリプトの識別子は下記の通りです。
+
+イメージ ID | OS・ディストリビューション | ブートストラップ・スクリプト | 同梱されている gem
+------------|----------------------------|------------------------------|-------------------
+1           | CentOS 5.3 32bit Plain     | nc-centos5-gems              | knife-nc
+2           | CentOS 5.3 64bit Plain     | nc-centos5-gems              | knife-nc
+6           | CentOS 5.3 32bit Server    | nc-centos5-gems              | knife-nc
+7           | CentOS 5.3 64bit Server    | nc-centos5-gems              | knife-nc
+13          | CentOS 5.6 64bit Plain     | nc-centos5-gems              | knife-nc
+14          | CentOS 5.6 64bit Server    | nc-centos5-gems              | knife-nc
+17          | Ubuntu 10.04 64bit Plain   | ubuntu10.04-gems             | chef
+21          | CentOS 6.2 64bit Plain     | nc-centos6-gems              | knife-nc
+
 ## TODO
 
  * nc server create の -U オプション (起動スクリプト指定) の動作確認ができていない
  * nc server create の --template-file オプション (ブートストラップ用テンプレート指定) の動作確認ができていない
- * nc server create の -P オプションが SSH Key のパスフレーズに適用されない
-   * そもそも Chef::Knife::Bootstrap が SSH キーのパスフレーズに対応していないので保留としています
- * nc server create の -I オプション (イメージ ID 指定) で一部ブートストラップできないイメージがある
-   * CentOS 5 + 64bit の組み合わせで Ruby の OpenSSL ライブラリで "Cipher is not a module" エラーが出て止まってしまうようです
- * nc server create で利用しているデフォルトの centos5-gems テンプレートを一部修正する必要があります
-   * EPEL rpm の URL が変更されたため現状動いていないっぽいです、Chef 本体に[こちらの修正](https://github.com/vgirnet/chef/commit/62bdc5a7415025555502583cad5f6a6543e7a954)を適用すれば動きます
 
 ## ライセンス
 
-Opscode Chef のプロダクトに準じて Apache Lisence, Version 2.0 を適用します。
+[knife-ec2](https://github.com/opscode/knife-ec2) をベースに NIFTY Cloud 向けに修正を加えたものです。
+オリジナルに準じて Apache Lisence, Version 2.0 を適用します。

data/lib/chef/knife/bootstrap/nc-centos5-gems.erb

@@ -0,0 +1,65 @@
+bash -c '
+<%= "export http_proxy=\"#{knife_config[:bootstrap_proxy]}\"" if knife_config[:bootstrap_proxy] -%>
+
+if [ ! -f /usr/bin/chef-client ]; then
+  yum erase -y ruby-1.8.5-24.el5
+  yum erase -y ruby-libs-1.8.5-24.el5
+  yum erase -y ruby-devel-1.8.5-24.el5
+
+  wget <%= "--proxy=on " if knife_config[:bootstrap_proxy] %>http://dl.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm
+  rpm -Uvh epel-release-5-4.noarch.rpm
+  wget <%= "--proxy=on " if knife_config[:bootstrap_proxy] %>http://rpm.aegisco.com/aegisco/rhel/aegisco-rhel.rpm
+  rpm -Uvh aegisco-rhel.rpm
+
+  yum install -y gcc gcc-c++ automake autoconf make
+  yum --disablerepo=base install -y ruby ruby-devel
+
+  cd /tmp
+  wget <%= "--proxy=on " if knife_config[:bootstrap_proxy] %>http://production.cf.rubygems.org/rubygems/rubygems-1.6.2.tgz
+  tar zxf rubygems-1.6.2.tgz
+  cd rubygems-1.6.2
+  ruby setup.rb --no-format-executable
+fi
+
+gem update --system
+gem update
+gem install ohai --no-rdoc --no-ri --verbose
+gem install chef --no-rdoc --no-ri --verbose <%= bootstrap_version_string %>
+
+mkdir -p /etc/chef
+
+(
+cat <<'EOP'
+<%= validation_key %>
+EOP
+) > /tmp/validation.pem
+awk NF /tmp/validation.pem > /etc/chef/validation.pem
+rm /tmp/validation.pem
+
+<% if @chef_config[:encrypted_data_bag_secret] -%>
+(
+cat <<'EOP'
+<%= encrypted_data_bag_secret %>
+EOP
+) > /tmp/encrypted_data_bag_secret
+awk NF /tmp/encrypted_data_bag_secret > /etc/chef/encrypted_data_bag_secret
+rm /tmp/encrypted_data_bag_secret
+<% end -%>
+
+(
+cat <<'EOP'
+<%= config_content %>
+EOP
+) > /etc/chef/client.rb
+
+(
+cat <<'EOP'
+<% if Chef::Version.new(Chef::VERSION) >= Chef::Version.new('0.10.10') %>
+<%= first_boot.to_json %>
+<% else %>
+<%= { "run_list" => @run_list }.to_json %>
+<% end %>
+EOP
+) > /etc/chef/first-boot.json
+
+<%= start_chef %>'

data/lib/chef/knife/bootstrap/nc-centos6-gems.erb

@@ -0,0 +1,55 @@
+bash -c '
+<%= "export http_proxy=\"#{knife_config[:bootstrap_proxy]}\"" if knife_config[:bootstrap_proxy] -%>
+
+if [ ! -f /usr/bin/chef-client ]; then
+  yum install -y ruby ruby-devel gcc gcc-c++ automake autoconf make
+
+  cd /tmp
+  wget <%= "--proxy=on " if knife_config[:bootstrap_proxy] %>http://production.cf.rubygems.org/rubygems/rubygems-1.6.2.tgz
+  tar zxf rubygems-1.6.2.tgz
+  cd rubygems-1.6.2
+  ruby setup.rb --no-format-executable
+fi
+
+gem update --system
+gem update
+gem install ohai --no-rdoc --no-ri --verbose
+gem install chef --no-rdoc --no-ri --verbose <%= bootstrap_version_string %>
+
+mkdir -p /etc/chef
+
+(
+cat <<'EOP'
+<%= validation_key %>
+EOP
+) > /tmp/validation.pem
+awk NF /tmp/validation.pem > /etc/chef/validation.pem
+rm /tmp/validation.pem
+
+<% if @chef_config[:encrypted_data_bag_secret] -%>
+(
+cat <<'EOP'
+<%= encrypted_data_bag_secret %>
+EOP
+) > /tmp/encrypted_data_bag_secret
+awk NF /tmp/encrypted_data_bag_secret > /etc/chef/encrypted_data_bag_secret
+rm /tmp/encrypted_data_bag_secret
+<% end -%>
+
+(
+cat <<'EOP'
+<%= config_content %>
+EOP
+) > /etc/chef/client.rb
+
+(
+cat <<'EOP'
+<% if Chef::Version.new(Chef::VERSION) >= Chef::Version.new('0.10.10') %>
+<%= first_boot.to_json %>
+<% else %>
+<%= { "run_list" => @run_list }.to_json %>
+<% end %>
+EOP
+) > /etc/chef/first-boot.json
+
+<%= start_chef %>'

data/lib/chef/knife/nc_base.rb

@@ -15,8 +15,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
+$:.unshift(File.dirname(__FILE__) + '../../') unless $:.include?(File.dirname(__FILE__) + '../../')
 require 'chef/knife'
+require 'knife-nc/chef_extensions'
+require 'knife-nc/nifty_cloud_sdk_extensions'
 
 class Chef
   class Knife
@@ -53,7 +55,7 @@ class Chef
           connection = NIFTY::Cloud::Base.new(
             :access_key => Chef::Config[:knife][:nc_access_key],
             :secret_key => Chef::Config[:knife][:nc_secret_key]
-	  )
+        )
         end
       end
 

data/lib/chef/knife/nc_image_list.rb

@@ -38,7 +38,7 @@ class Chef
           ui.color('State', :bold)
         ]
         connection.describe_images.imagesSet.item.each do |image|
-	  image_list << image.imageId
+          image_list << image.imageId
           image_list << image.name
           image_list << "#{image.imageOwnerId} (#{image.imageOwnerAlias})"
           image_list << "#{image.imageState} (#{image.isPublic ? 'public' : 'private'})"

data/lib/chef/knife/nc_server_create.rb

@@ -76,6 +76,12 @@ class Chef
         :long => "--ssh-password PASSWORD",
         :description => "The ssh password"
 
+      option :ssh_passphrase,
+        :short => "-R PASSPHRASE",
+        :long => "--ssh-passphrase PASSPHRASE",
+        :description => "The ssh passphrase",
+        :proc => Proc.new { |key| Chef::Config[:knife][:ssh_passphrase] = key }
+
       option :ssh_locally,
         :short => "-L",
         :long => "--ssh-locally",
@@ -99,8 +105,7 @@ class Chef
         :short => "-d DISTRO",
         :long => "--distro DISTRO",
         :description => "Bootstrap a distro using a template",
-        :proc => Proc.new { |d| Chef::Config[:knife][:nc_distro] = d },
-        :default => "centos5-gems"
+        :proc => Proc.new { |d| Chef::Config[:knife][:nc_distro] = d }
 
       option :nc_template_file,
         :long => "--template-file TEMPLATE",
@@ -170,22 +175,6 @@ class Chef
         puts "\n"
         confirm("Do you really want to create this server")
 
-        # monkey patch NIFTY::Cloud::Base (ignore password option and enable user data)
-        connection.instance_eval do
-          def run_instances(options)
-            options[:password] = 'ignoreme'
-            @user_data = options[:user_data]
-            super(options)
-          end
-          def response_generator(params)
-            params.delete('Password') if params['Password'] == 'ignoreme'
-            if @user_data
-              params['UserData'] = extract_user_data(:user_data => @user_data, :base64_encoded => true)
-              params['UserData.Encoding'] = 'base64'
-            end
-            super(params)
-          end
-        end
         server = connection.run_instances(create_server_def).instancesSet.item.first
 
         msg_pair("Instance ID", server.instanceId)
@@ -235,11 +224,25 @@ class Chef
         bootstrap.config[:run_list] = config[:run_list]
         bootstrap.config[:ssh_user] = config[:ssh_user]
         bootstrap.config[:ssh_password] = config[:ssh_password]
+        bootstrap.config[:ssh_passphrase] = config[:ssh_passphrase]
         bootstrap.config[:identity_file] = config[:identity_file]
         bootstrap.config[:chef_node_name] = config[:chef_node_name] || server.instanceId
         bootstrap.config[:prerelease] = config[:prerelease]
         bootstrap.config[:bootstrap_version] = locate_config_value(:nc_bootstrap_version)
-        bootstrap.config[:distro] = locate_config_value(:nc_distro)
+
+        image_id = locate_config_value(:nc_image_id)
+	if locate_config_value(:nc_distro)
+          bootstrap.config[:distro] = locate_config_value(:nc_distro)
+        elsif %w(1 2 6 7 13 14).include?(image_id)
+          bootstrap.config[:distro] = 'nc-centos5-gems'
+        elsif image_id == '17'
+          bootstrap.config[:distro] = 'ubuntu10.04-gems'
+        elsif image_id == '21'
+          bootstrap.config[:distro] = 'nc-centos6-gems'
+	else
+          bootstrap.config[:distro] = 'nc-centos5-gems'
+        end
+
         bootstrap.config[:use_sudo] = true unless config[:ssh_user] == 'root'
         bootstrap.config[:template_file] = locate_config_value(:nc_template_file)
         bootstrap.config[:environment] = config[:environment]
@@ -257,7 +260,7 @@ class Chef
 
         if @name_args.empty?
           errors << "You have not provided a valid instance ID."
-	end
+        end
 
         if config[:security_group].nil?
           errors << "You have not provided a valid Security Group."
@@ -286,7 +289,7 @@ class Chef
 
         if Chef::Config[:knife][:nc_user_data]
           begin
-            server_def.merge!(:user_data => File.read(Chef::Config[:knife][:nc_user_data]))
+            server_def.merge!(:user_data => File.read(locate_config_value(:nc_user_data)))
           rescue
             ui.warn("Cannot read #{Chef::Config[:knife][:nc_user_data]}: #{$!.inspect}. Ignoring option.")
           end

data/lib/chef/knife/nc_server_delete.rb

@@ -79,7 +79,7 @@ class Chef
             confirm("Do you really want to delete this server")
 
             print "\n#{ui.color("Waiting for server to shutdown", :magenta)}"
-	    connection.stop_instances(:instance_id => instance_id, :force => true)
+            connection.stop_instances(:instance_id => instance_id, :force => true)
             while server.instanceState.name != 'stopped'
               print "."
               server = connection.describe_instances(:instance_id => instance_id).reservationSet.item.first.instancesSet.item.first

data/lib/chef/knife/nc_server_list.rb

@@ -43,8 +43,8 @@ class Chef
         ]
         connection.describe_instances.reservationSet.item.each do |instance|
           server = instance.instancesSet.item.first
-	  group = instance.groupSet
-	  server_list << server.instanceId
+          group = instance.groupSet
+          server_list << server.instanceId
           server_list << server.ipAddress.to_s
           server_list << server.privateIpAddress.to_s
           server_list << server.instanceType

data/lib/knife-nc/chef_extensions.rb

@@ -0,0 +1,54 @@
+#
+# Author:: tily (<tidnlyam@gmail.com>)
+# Copyright:: Copyright (c) 2011 tily
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'chef/knife'
+require 'chef/knife/ssh'
+require 'chef/knife/bootstrap'
+
+class Chef::Knife
+  class Ssh
+    alias original_session_from_list session_from_list
+
+    option :ssh_passphrase,
+      :long => "--ssh-passphrase PASSPHRASE",
+      :description => "Your SSH Passphrase",
+      :proc => Proc.new { |key| Chef::Config[:knife][:ssh_passphrase] = key }
+
+    def session_from_list(list)
+      session = original_session_from_list(list)
+      session.servers.each do |server|
+        server.options[:passphrase] = config[:ssh_passphrase]
+      end
+      session
+    end
+  end
+
+  class Bootstrap
+    alias original_knife_ssh knife_ssh
+
+    option :ssh_passphrase,
+      :long => "--ssh-passphrase PASSPHRASE",
+      :description => "Your SSH Passphrase",
+      :proc => Proc.new { |key| Chef::Config[:knife][:ssh_passphrase] = key }
+
+    def knife_ssh
+      ssh = original_knife_ssh
+      ssh.config[:ssh_passphrase] = config[:ssh_passphrase]
+      ssh
+    end
+  end
+end

data/lib/knife-nc/nifty_cloud_sdk_extensions.rb

@@ -0,0 +1,37 @@
+#
+# Author:: tily (<tidnlyam@gmail.com>)
+# Copyright:: Copyright (c) 2011 tily
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'NIFTY'
+
+class NIFTY::Cloud::Base
+  alias original_run_instances run_instances
+  alias original_response_generator response_generator
+  def run_instances(options)
+    options[:password] = 'ignoreme' unless options[:password]
+    @user_data = options[:user_data]
+    original_run_instances(options)
+  end
+
+  def response_generator(params)
+    params.delete('Password') if params['Password'] == 'ignoreme'
+    if @user_data
+      params['UserData'] = extract_user_data(:user_data => @user_data, :base64_encoded => true)
+      params['UserData.Encoding'] = 'base64'
+    end
+    original_response_generator(params)
+  end
+end

data/lib/knife-nc/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module Nc
-    VERSION = "0.0.0"
+    VERSION = "0.0.1"
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-nc
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-20 00:00:00.000000000Z
+date: 2012-06-03 00:00:00.000000000Z
 dependencies: []
 description: NIFTY Cloud Support for Chef's Knife Command
 email:
@@ -24,16 +24,20 @@ files:
 - .rspec
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - knife-nc.gemspec
+- lib/chef/knife/bootstrap/nc-centos5-gems.erb
+- lib/chef/knife/bootstrap/nc-centos6-gems.erb
 - lib/chef/knife/nc_base.rb
 - lib/chef/knife/nc_image_list.rb
 - lib/chef/knife/nc_server_create.rb
 - lib/chef/knife/nc_server_delete.rb
 - lib/chef/knife/nc_server_list.rb
+- lib/knife-nc/chef_extensions.rb
+- lib/knife-nc/nifty_cloud_sdk_extensions.rb
 - lib/knife-nc/version.rb
 - spec/spec_helper.rb
-- README.md
 homepage: https://github.com/tily/ruby-knife-nc
 licenses: []
 post_install_message: