NIFTY Cloud 向け knife プラグイン

概要

knife から NIFTY Cloud のインスタンスを扱うためのプラグインです。 knife-ec2 と同じように、インスタンスを作成した上で Chef のノードとして登録 (= ブートストラップ) したり、 インスタンスを削除したりできます。

インストール

"chef" gem と "ニフティクラウドSDK for Ruby" gem に依存しているので、 まだインストールしていない場合にはインストールしましょう。

# "chef" gem のインストール
gem install chef

    # "ニフティクラウドSDK for Ruby" のインストール
wget http://cloud.nifty.com/api/sdk/NIFTY_Cloud_SDK_for_ruby.zip
cd NIFTY_Cloud_SDK_for_ruby
rake install

あとは gem install knife-nc を実行するだけです。

gem install knife-nc

設定

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.rb をバージョン管理システムにコミットしている場合 (つまり誰でも閲覧可能になっている場合) には、 環境変数から読み込ませることも可能です。

knife[:nc_access_key_id] = "#{ENV['NIFTY_CLOUD_ACCESS_KEY_ID']}"
knife[:nc_secret_access_key] = "#{ENV['NIFTY_CLOUD_SECRET_ACCESS_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.rb に設定可能です。

サブコマンド一覧

knife nc server create

NIFTY Cloud 上にインスタンスを作成し SSH 経由で Chef のブートストラップを行います。「ブートストラップ」というのは Chef をインストールして Chef クライアントとして Chef サーバと通信できるようにすることです。デフォルトでは centos5-gems テンプレートでブートストラップを行います。-d オプションか --template-file オプションで振る舞いを上書きすることができます。インスタンス作成時、あとから knife コマンド経由で削除可能とするために、diableApiTermination を false に設定することに注意してください。

knife nc server delete

設定済みの NIFTY Cloud アカウント内のインスタンスを指定して停止・削除します。注意：デフォルトではそのインスタンスに関するノード・クライアント情報を Chef サーバ上から削除しません。削除するためには --purge フラグをつけてください。

knife nc server list

現在設定されている NIFTY Cloud アカウントが持つすべてのサーバの一覧を出力します。注意：アカウントに紐づいたすべてのインスタンスを表示するので、Chef サーバに管理されていないインスタンスが表示されることもあります。

knife nc image list

knife-ec2 にはないオリジナルのコマンドです。現在のアカウントで利用可能なイメージの一覧を表示します。 knife nc server create コマンドの -I オプションに渡す Image ID を確認するために利用してください。

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 本体にこちらの修正を適用すれば動きます

ライセンス

Opscode Chef のプロダクトに準じて Apache Lisence, Version 2.0 を適用します。