share facebook facebook twitter menu hatena pocket slack

2017.08.01 TUE

俺の EC2 〜 郷編 〜

川原 洋平

WRITTEN BY 川原 洋平

もはや Golang は

インフラエンジニアを自称するものにとって心得ておかなければならないプログラム言語では?という強い危機感と、これからどうやって Golang を勉強していけばいいんだろうと不安になっていたら、お仕事等で Bash + AWS CLI でその場限りのツールをポツポツ作ったりしているので、それを Golang で作ってみることにした。

ということで、describe instances して、テーブル形式、カンマ区切り形式、Markdown 形式、dnsmasq の hosts リスト形式で出力するコマンドラインツールを Golang で作ってみた。

作ったもの

gist.github.com

使い方

準備

#
# go のバージョンを確認
#
$ go version
go version go1.8.3 darwin/amd64

#
# 必要なパッケージを取得
#
$ go get  github.com/aws/aws-sdk-go
$ go get  github.com/olekukonko/tablewriter

ビルド

$ wget --no-check-certificate https://gist.githubusercontent.com/inokappa/12b0f484bdae8876f6917ff5b43dcfae/raw/ff44c6c6c658d8cf82d6d1a71a5f22d5942f95d2/oreno-ec2.go
$ go build oreno-ec2.go

特にビルドしなくても go run でも動く。但し、結果が出力されるまで時間を要する。

help

$ ./oreno-ec2 -help
Usage of ./oreno-ec2:
  -comma
        カンマ区切りの hosts リストを生成する
  -command string
        指定したコマンドを実行する
  -dnsmasq
        dnsmasq 用の hosts リストを生成する
  -markdown
        Markdown のテーブルフォーマットで出力する
  -path string
        ファイルのパスを指定する (default "hosts_list")
  -profile string
        AWS Shared Credential の Profile 名を指定する
  -read
        -path オプションで指定したファイルを読み取る
  -region string
        AWS Region 名を指定する (default "ap-northeast-1")

ヘルプが日本語ですいません。

EC2 一覧を出力

AWS CLI の --output table オプションとほぼ同じ。

$ ./oreno-ec2
+------------------+---------------------+--------------+-----------------+---------------+----------------+---------+
|     TAG:NAME     |     INSTANCEID      | INSTANCETYPE |       AZ        |   PRIVATEIP   |    PUBLICIP    | STATUS  |
+------------------+---------------------+--------------+-----------------+---------------+----------------+---------+
| dev-aaa1         | i-xxxxxxxxxxxxxxxxx | t2.micro     | ap-northeast-1a | 172.31.x.187  | Not assignment | stopped |
| dev-bbb1         | i-xxxxxxxxx         | t2.micro     | ap-northeast-1a | 172.31.x.39   | Not assignment | stopped |
| hogehoge         | i-yyyyyyyyyyyyyyyyy | t2.micro     | ap-northeast-1a | 172.31.x.89   | Not assignment | stopped |
| dev-ccc1         | i-zzzzzzzzz         | t2.medium    | ap-northeast-1a | 172.31.x.139  | Not assignment | stopped |
| dev-ddd1         | i-pppppppppp        | t2.micro     | ap-northeast-1a | 172.31.x.117  | xx.xxx.xxx.xx  | running |
| dev-eee1         | i-qqqqqqqqqqqqqq    | t2.micro     | ap-northeast-1a | 172.31.x.28   | Not assignment | stopped |
+------------------+---------------------+--------------+-----------------+---------------+----------------+---------+

出力出来る項目数だけで比較すると AWS CLI を利用した方がいいかな…

dnsmasq の hosts リストを出力

dnsmasq の --address= で指定する /Domain/IPAddress 形式のリストを -path で指定したファイルに出力する。

$ ./oreno-ec2 -dnsmasq -path dnsmasq.txt
$ ./oreno-ec2 -read -path dnsmasq.txt
address=/dev-aaa1/172.31.x.187
address=/dev-bbb1/172.31.x.39
address=/hogehoge/172.31.x.89
address=/dev-ccc1/172.31.x.139
address=/dev-ddd1/172.31.x.117
address=/dev-eee1/172.31.x.28

-read オプションはコマンドの cat と全く同じ機能。単に Golang でファイルを読み込む方法を勉強したかった為に実装した。

func read_hosts_list_file(file_path string) {
    contents, _ := ioutil.ReadFile(file_path)
    fmt.Println(string(contents))
}

ioutil.ReadFile にファイルのパスを指定するだけで読み込めるらしい。なるほど。ioutil 便利。

カンマ区切りでファイルに出力

$ ./oreno-ec2 -comma -path comma.txt
$ ./oreno-ec2 -read -path comma.txt
dev-aaa1,i-xxxxxxxxxxxxxxxxx,t2.micro,ap-northeast-1a,172.31.x.187,Not assignment,stopped
dev-bbb1,i-xxxxxxxxx,t2.micro,ap-northeast-1a,172.31.x.39,Not assignment,stopped
hogehoge,i-yyyyyyyyyyyyyyyyy,t2.micro,ap-northeast-1a,172.31.x.89,Not assignment,stopped
dev-ccc1,i-zzzzzzzzz,t2.medium,ap-northeast-1a,172.31.x.139,Not assignment,stopped
dev-ddd1,i-pppppppppp,t2.micro,ap-northeast-1a,172.31.x.117,52.198.32.108,running
dev-eee1,i-qqqqqqqqqqqqqq,t2.micro,ap-northeast-1a,172.31.x.28,Not assignment,stopped

カンマ区切り。一応、Excel でファイルを開くと CSV として解釈してくれるので有難い。

Markdown フォーマットのテーブル形式で出力

$ ./oreno-ec2 -markdown
|     TAG:NAME     |     INSTANCEID      | INSTANCETYPE |       AZ        |   PRIVATEIP   |    PUBLICIP    | STATUS  |
|------------------|---------------------|--------------|-----------------|---------------|----------------|---------|
| dev-aaa1         | i-xxxxxxxxxxxxxxxxx | t2.micro     | ap-northeast-1a | 172.31.x.187  | Not assignment | stopped |
| dev-bbb1         | i-xxxxxxxxx         | t2.micro     | ap-northeast-1a | 172.31.x.39   | Not assignment | stopped |
| hogehoge         | i-yyyyyyyyyyyyyyyyy | t2.micro     | ap-northeast-1a | 172.31.x.89   | Not assignment | stopped |
| dev-ccc1         | i-zzzzzzzzz         | t2.medium    | ap-northeast-1a | 172.31.x.139  | Not assignment | stopped |
| dev-ddd1         | i-pppppppppp        | t2.micro     | ap-northeast-1a | 172.31.x.117  | 52.198.32.108  | running |
| dev-eee1         | i-qqqqqqqqqqqqqq    | t2.micro     | ap-northeast-1a | 172.31.x.28   | Not assignment | stopped |

お仕事で Wiki 等にインスタンス一覧を資料として書くことが多々あるので便利だろうなあと思って追加した。実際に貼り付けてみると以下の通り。

TAG:NAME INSTANCEID INSTANCETYPE AZ PRIVATEIP PUBLICIP STATUS
dev-aaa1 i-xxxxxxxxxxxxxxxxx t2.micro ap-northeast-1a 172.31.x.187 Not assignment stopped
dev-bbb1 i-xxxxxxxxx t2.micro ap-northeast-1a 172.31.x.39 Not assignment stopped
hogehoge i-yyyyyyyyyyyyyyyyy t2.micro ap-northeast-1a 172.31.x.89 Not assignment stopped
dev-ccc1 i-zzzzzzzzz t2.medium ap-northeast-1a 172.31.x.139 Not assignment stopped
dev-ddd1 i-pppppppppp t2.micro ap-northeast-1a 172.31.x.117 52.198.32.108 running
dev-eee1 i-qqqqqqqqqqqqqq t2.micro ap-northeast-1a 172.31.x.28 Not assignment stopped

Backlog 記法も出力出来ると嬉しいけどもう少し研究が必要。

ということで

郷言語

難しいけど、ワンバイナリに出来るのはとても魅力的でデプロイの手順削減にだいぶん貢献出来ると思う。色々と覚えなければいけないこともあったりするけど、シェルスクリプトを作るような感覚で作ることが出来そうな気がする(気がするだけ)。

aws-sdk-go のドキュメント

このドキュメントの読み方がイマイチ解っていないのが致命的。

工夫したところ

func aws_ec2_client(profile string, region string) *ec2.EC2 {
    var config aws.Config
    if profile != "" {
        creds := credentials.NewSharedCredentials("", profile)
        config = aws.Config{Region: aws.String(region), Credentials: creds}
    } else {
        config = aws.Config{Region: aws.String(region)}
    }
    sess := session.New(&config)
    ec2_client := ec2.New(sess)
    return ec2_client
}

手元のパソコンから oreno-ec2 を叩く場合には Shared Credential の Profile 名を指定することが多いけど、EC2 上で叩く場合には大概の場合、IAM Role が付いているので Profile 名が指定されない場合を想定している。(より良い書き方があるかもしれないけど)

テスト

プログラムを書いたらテストまでしっかりと書きたいと思い続けて 100 年くらいたったけど、なかなかテストを書くという行為まで至れない。

元記事はこちら

俺の EC2 〜 郷編 〜

cloudpack

cloudpackは、Amazon EC2やAmazon S3をはじめとするAWSの各種プロダクトを利用する際の、導入・設計から運用保守を含んだフルマネージドのサービスを提供し、バックアップや24時間365日の監視/障害対応、技術的な問い合わせに対するサポートなどを行っております。
AWS上のインフラ構築およびAWSを活用したシステム開発など、案件のご相談はcloudpack.jpよりご連絡ください。