YogafireというAWSツールでヨガの奥義を極める
※注 タイトルに深い意味はありません
https://github.com/toritori0318/p5-Yogafire
だいぶ前からgithubには置いてたんですが
年始だしドキュメントっぽいのを書いてみることにしました。
超長い！でも便利かも！
前置き
仕事上AWS（EC2）を使うことが多いのですが、
自分で使っていて「こんなんあったら便利かなー」というのを寄せ集めたCLIです。
基本的な考え方としては「EC2をタグNameベースで」いろいろと操作できるようなツールですね。*1 *2
貧乏性な自分はスポットインスタンスを定常的に使うので
yoga sshは割と必須だったりしています。
※Windows
たぶん動きません！
インストール
cpanm https://github.com/toritori0318/p5-Yogafire/tarball/master # cpanm無い時 curl -LOk http://xrl.us/cpanm # 環境によっては sudo 付ける # ncurses-devel / readline-devel パッケージが必要 perl cpanm https://github.com/toritori0318/p5-Yogafire/tarball/master
依存が多くていらいらするかもしれませんがしばらく待ちましょう。
インストールが成功するともれなく「yoga」コマンドが使えるようになります。
コマンド一覧
設定系
| config | Yogafireコンフィグを設定 |
| use | プロファイル設定 |
EC2操作系
| ls | EC2インスタンスのリストを表示／操作 |
| ssh | EC2インスタンスへssh接続 |
| start | EC2インスタンスを起動 |
| stop | EC2インスタンスを停止 |
| reboot | EC2インスタンス再起動 |
| terminate | EC2インスタンスを削除 |
| create-image | EC2インスタンスからAMIイメージを作成 |
| expand-volume | EC2ボリュームを拡張 |
| info | EC2インスタンスの詳細情報を表示 |
| cmd | リモートサーバでコマンド実行 |
| get | リモートサーバからrsyncでファイルを取得 |
| put | リモートサーバへrsyncでファイルを送信 |
AMI操作系
| ls-ami | AMIリストを表示／操作 |
初期設定
利用するにはyogaコマンド用のコンフィグファイルを設定する必要があります。
yoga config --init
対話形式での設定を開始します。
AWS関連の環境変数を設定していればある程度自動で設定してくれます。
ただしpemファイルの在り処は入力する必要があるでしょう。
デフォルトでは「$HOME/.yoga」にコンフィグファイルが作られます。
コンフィグファイルの場所は環境変数「YOGAFIRE_CONFIG」で指定することも可能です。
このファイルを直接編集することも可能です(YAML形式)。
※コンフィグファイルのexample
yoga use
yogafireでは複数のAWSアカウントを管理することができます。
プロファイルを複数用意し、useコマンドでプロファイル名を指定することによって
簡単に切り替えることができます。
通常は「global」プロファイルに紐付けられています。
# プロファイル一覧 yoga use # "account1"プロファイルに切り替える yoga use 'account1'
Yoga Core：利用頻度ランキング
自分がよく使う順に説明していきます。
yoga ssh
インスタンスに対してSSHします。runningのインスタンスのみが自動でピックアップされます。
# 起動中の全サーバを一覧表示し、番号を選択してsshログイン yoga ssh # Nameタグが「www01」のサーバにsshログイン yoga ssh www01 (以下でも同じ意味) yoga ssh --tagsname www01 # Nameタグが「www*」のサーバを一覧表示し、番号を選択してsshログイン yoga ssh 'www*' # --filterオプションでAPIのフィルターも自由にかけることも可能 # ※sshコマンドに限らず、他のコマンドでも同様 # http://docs.amazonwebservices.com/AWSEC2/2011-05-15/APIReference/index.html?ApiReference-query-DescribeInstances.html yoga ssh --filter='instance-state-name=running,availability-zone=ap-northeast-1,group-name=base'
yoga ls
インスタンスのリストを表示できます。全てのステータスが対象となります
（オプションで絞り込むことは可能）
# "www"でタグNameが始まるインスタンスのみ表示 yoga ls 'www*' (以下でも同じ意味) yoga ls --tagsname 'www*'
また、-iオプションを追加すると、表示したインスタンスに対して更にコマンド（ssh / start /stop /...）を
実行することができます。
# さらに追加コマンドを選択 yoga ls -i
yoga ls-ami
lsのAMI版。
これをよく使うのは、AMI削除するときにスナップショットも一緒に消せるようにしているからですね。*3
# "www"でAMINameが始まるインスタンスのみ表示 yoga ls-ami 'www*' (以下でも同じ意味) yoga ls-ami --name 'www*'
lsと同じように、-iオプションを追加するとインタラクティブモードになります。
# さらに追加コマンドを選択 yoga ls-ami -i
yoga get
rsyncでリモートサーバのファイルを取得します。
# Nameタグが「www02」サーバの「/tmp/hoge.log」をローカルの「./」に転送 yoga get www02 /tmp/hoge.log ./ # Nameタグが「www」で始まるサーバ全部に「/tmp/hoge.log」をローカルの「./」に転送 yoga get 'www*' /tmp/hoge.log ./ # ホスト名でも可能 yoga get hogehoge.example.com /tmp/hoge.log ./ # dry-runモード yoga get www02 /tmp/hoge.log ./ --dry-run # rsyncオプションを追加(node_modulesディレクトリを除外してsync) yoga get www02 ./nodapp ./ -o '--exclude=node_modules'
yoga put
getの反対でリモートサーバのファイルを取得します。
dry-runやrsyncオプションもgetと同じように指定できます。
# ローカルの「README」ファイルを、Nameタグが「www03」サーバの「/home/tori243」に転送 yoga put www03 README /home/tori243
yoga cmd
指定したコマンドをリモートサーバで実行します。
並列実行はTodo...
# Nameタグが「www04」のサーバでlsを実行 yoga cmd www04 'ls' # Nameタグが「www」で始まるサーバでuptimeを実行 yoga cmd 'www*' 'uptime' # Nameタグが「db」で始まるサーバでsudo+password実行 yoga cmd 'db*' -s -p '/etc/init.d/redis start'
Yoga Plugin：利用頻度ランキング
プラグインで自分がよく使う順に説明していきます。
yoga instance-type
EC2インスタンスタイプの一覧を表示します。
idとタイプの紐付けや、スペックの確認に便利。
yoga region
リージョンのIDも忘れがちなので一覧で見れると便利ですね！
yoga render
割とお気に入りの機能です。EC2インスタンス情報をテンプレートで記述できます。
具体例をいくつか上げてみます。
# ステータスがrunningのサーバ全てを対象にdnsNameを生成
yoga render --template='"[% dnsName %]",\n' --state=running
(結果)
"ec2-xxx-xxx-xxx-xxx.ap-northeast-1.compute.amazonaws.com",
"ec2-yyy-yyy-yyy-yyy.ap-northeast-1.compute.amazonaws.com",
...
# タグNameが'www'で始まるサーバのグローバルIPを生成
yoga render --template='[% ipAddress %]\n' --tagsname='www*'
(結果)
xxx.xxx.xxx.xxx
yyy.yyy.yyy.yyy
# タグNameが'db'で始まるサーバ情報でPerlのコードっぽいのを生成
yoga render --template='{ instance => { instance_id => "[% instanceId %]", private_ip => "[% privateIpAddress %]", launch_time => "[% launchTime %]" } },\n' --tagsname='www*'
(結果)
{ instance => { instance_id => "i-bbbbbbb", private_ip => "x.x.x.x", launch_time => "2012-03-30T09:00:34.000Z" } },
{ instance => { instance_id => "i-ccccccc", private_ip => "y.y.y.y", launch_time => "2012-03-30T09:01:49.000Z" } }
yoga aws-status
awsステータス情報の通知を時系列に表示します。日付/リージョン/サービス名指定も可能。
yoga hosts
EC2インスタンスのipアドレスをhostsに自動更新します。
以下のようなフォーマットでファイルの末尾に追記されます。
更新時も「Yogafire Begin <-> Yogafire End」の間だけが自動で置換されます。
フォーマット
#======== Yogafire Begen ========# <public_ip or private_ip> <tag_Name> ... #======== Yogafire End ========#
実行例
# 更新後のhostsファイルをプレビュー yoga hosts --preview # プライベートIPでhostsファイルを置換します（バックアップ有り） yoga hosts --replace --private-ip --backup
更新後ファイルの例
127.0.0.1 localhost pn-agent pn-broadcast ::1 localhost fe80::1%lo0 localhost ... #======== Yogafire Begen ========# 59.1.1.1 wwwhoge 59.1.1.2 wwwfuga 59.1.1.3 dbpiyo #======== Yogafire End ========#
yoga sshconfig
EC2インスタンスのipアドレスをsshconfigに自動更新します。
以下のようなフォーマットでファイルの末尾に追記されます。
フォーマット
#======== Yogafire Begen ========#
Host <tag_Name>
HostName <dnsName>
IdentityFile <.yogaコンフィグの鍵ファイルパス>
User <.yogaコンフィグのユーザ名>
Port <.yogaコンフィグのポート番号>
...
#======== Yogafire End ========#実行例
# 更新後のsshconfigファイルをプレビュー yoga sshconfig --preview # sshconfigファイルを置換します（バックアップ有り） yoga sshconfig --replace --backup
更新後ファイルの例
#======== Yogafire Begen ========#
Host wwwhoge
HostName hogehoge.com
IdentityFile /path/to/id.pem
User ec2-user
Port 22
Host wwwfuga
HostName fugafuga.com
IdentityFile /path/to/id.pem
User ec2-user
Port 22
Host dbpiyo
HostName piyopiyo.com
IdentityFile /path/to/id.pem
User ec2-user
Port 22
#======== Yogafire End ========#
他にも
割愛しますが、リージョンを横断して情報表示できる all-region-info や、
ステータスを監視して ステータスが変更されたらgrowl表示したりできる
ec2watcherやamiwatcherという機能もあったりします。
Tips的な話
ヘルプ
# 全部のコマンド一覧 yoga # コマンド毎のヘルプを見る yoga <command> --help
オートコンプリート
sshやls -iなど、番号／インスタンス名／インスタンスIDを入力するところでは
TABキーでオートコンプリートが効きます。
また、zsh補完を設定しておくと、コマンドラインでもいろいろと補完が効くようになります。
yogaコマンド補完
さらに絞り込んで補完とか。
インスタンス名補完
また、ssh / ls / start / stop /terminate / get /put などのコマンドでは
yoga
カラムのカスタマイズ
ssh / ls / ls-ami などで表示される一覧のカラムは
コンフィグファイルでカスタマイズすることが可能です。
app1: access_key_id: aaaaaaaaaaaaaaaa identity_file: '/path/to/nyoro.pem' ############################################### # amiリストのカラム # VM::EC2::Imageのメソッドと一致するものを指定 # http://search.cpan.org/~lds/VM-EC2/lib/VM/EC2/Image.pm#METHODS # タグの場合は「tags_<タグ名>」で指定可能 image_column: - tags_Name - name - imageId - colorfulImageState ############################################### # インスタンスリストのカラム # VM::EC2::Instanceのメソッドと一致するものを指定 # http://search.cpan.org/~lds/VM-EC2/lib/VM/EC2/Instance.pm#METHODS # タグの場合は「tags_<タグ名>」で指定可能 instance_column: - tags_Name - tags_Role - instanceId - ipAddress - privateIpAddress - dnsName - launchTime - colorfulInstanceState region: ap-northeast-1 secret_access_key: bbbbbbbbbbbbbb ssh_port: 22 ssh_user: ec2-user
alias
指定しておくとさらに便利ですね。
# wwwサーバへssh alias yssh-www='yoga ssh "www*"' # dbサーバへコマンド実行 alias ycmd-db='yoga cmd "db*"' # /etc/hostsを置換 alias yhost-replace='sudo YOGAFIRE_CONFIG=/home/toritori0318/.yoga /path/to/yoga hosts --replace'
他のコマンドと連携してみるとか
yoga render コマンドの結果を用いてpsshに食わせたりとか夢ひろがりんぐですね。
Nameタグについての注意点
Nameタグの値が 'www 01 desuyo' のように、間にスペースがあると
動作に影響する可能性があります。スペース禁止！
Todo（たぶんやる）
- 表示系のソート指定
- sync や cmdのパラレル実行
- 入力履歴っぽいのをテンプレートで保存して使えるようにするような仕組み*4
まとめ
自分の用途に特化しているため、まとまりがなかったりAPIが微妙だったりするかもしれないですが
ssh / render / hosts などは割と便利だと思うので
興味がある方は触ってみてください。
また、コマンド自体はMouse::App::Cmdで定義しているだけなのでコマンド追加もコマンドファイル一つ作るだけでいけます。*5
コマンドを自分用に作るのもいいでしょう。
番外編：yogaコマンド依存度
ちなみに自分のコマンドランキングはこんな感じ。
566 cd 515 perl 486 git 407 yoga 404 vi 308 curl 178 make 150 ll 135 node 101 npm 101 ack
どんだけyogaコマンドうってるの…
