準備の全体像
Steampipe の公式の対応 OS は Linux と macOS で、Windows には WSL2 経由での利用が案内されている。そこでこのシリーズでは、次の分担で環境を作る。
| 場所 | 置くもの | 理由 |
|---|---|---|
| Windows | AWS CLI v2・プロファイル(C:\Users\<名前>\.aws)・SSO のログイン・Excel やブラウザ | ふだんの AWS CLI の設定を1か所で管理したい |
| WSL2(Ubuntu) | Steampipe・AWS プラグイン・Powerpipe | Steampipe が Linux 用のため |
| 両方から参照 | .aws フォルダー | WSL から Windows 側の設定とSSOのトークンを読む |
AWS CLI のインストールと、IAM Identity Center(SSO)のプロファイル dev の作り方は ポートフォワード PART 02 で説明しているので、まだの場合は先に済ませておく。PowerShell で次のコマンドが通れば、Windows 側の準備はできている。
aws sso login --profile dev
aws sts get-caller-identity --profile devWSL2とUbuntuを用意する
WSL をまだ使っていなければ、管理者として開いた PowerShell で Ubuntu 24.04 を入れる。途中で再起動を求められたら従い、最初の起動時に Linux 側のユーザー名とパスワードを決める。
wsl --install -d Ubuntu-24.04すでに WSL を使っている場合は、ディストリビューションが WSL2 で動いているかを確かめる。VERSION が 1 なら wsl --set-version <名前> 2 で切り替える。
PS> wsl -l -v
NAME STATE VERSION
* Ubuntu-24.04 Running 2⚠️ Ubuntu 20.04 では動かない
Steampipe v2.0.0 から、動作に glibc 2.34 以上が必要になった。Ubuntu 20.04(glibc 2.31)は対象外なので、古い WSL 環境を流用する場合は ldd --version で確かめ、22.04 以降を使う。
SteampipeとAWSプラグインを入れる
ここからは WSL のターミナル(スタートメニューの「Ubuntu 24.04」や Windows Terminal のタブ)で作業する。インストールは公式のスクリプトで行う。/usr/local/bin に書き込むので sudo のパスワードを聞かれる。
sudo /bin/sh -c "$(curl -fsSL https://steampipe.io/install/steampipe.sh)"
steampipe --versionSteampipe v2.4.7続けて AWS プラグインを入れる。初回は、プラグインのほかに内蔵の PostgreSQL と FDW もダウンロードされるので、少し時間がかかる。
steampipe plugin install aws
steampipe plugin listデータベース・プラグイン・設定ファイルは、すべて WSL のホームディレクトリの ~/.steampipe に置かれる。主な中身は次のとおり。
| パス | 中身 |
|---|---|
~/.steampipe/config/ | 接続などの設定ファイル(*.spc)。aws.spc はプラグインのインストール時に作られる |
~/.steampipe/plugins/ | プラグインの本体 |
~/.steampipe/db/ | 内蔵 PostgreSQL |
~/.steampipe/logs/ | ログ(PART 06 で使う) |
💡 インストール先を Windows のドライブに移さない
環境変数 STEAMPIPE_INSTALL_DIR でインストール先は変えられるが、/mnt/c の下には置かないほうがよい。WSL から Windows のドライブへのアクセスは Linux のファイルシステムより遅く、PostgreSQL が前提とするファイルの権限も再現されないためだ。Windows から見たいのは結果の CSV くらいなので、それだけを /mnt/c に出せば足りる(PART 04)。
社内のプロキシを通す必要がある環境では、インストールの前に export HTTPS_PROXY=http://proxy.example.co.jp:8080 のように設定しておく。プラグインが AWS の API を呼ぶときも同じ環境変数が使われる。
落とし穴:WSLとWindowsで.awsが別になる
ここが Windows で使うときに一番つまずきやすい点だ。WSL の ~(/home/<Linuxのユーザー名>)と Windows の C:\Users\<名前> は別の場所なので、Windows で設定したプロファイルは、そのままでは WSL から見えない。この状態でクエリを実行すると、Steampipe は認証情報を見つけられずにエラーになる。
いくつか方法があるが、おすすめは WSL の ~/.aws を、Windows の .aws へのシンボリックリンクにする方法だ。
# Windows のユーザー名を確認する
ls /mnt/c/Users/
# WSL 側に既に ~/.aws があれば退避する
[ -e ~/.aws ] && mv ~/.aws ~/.aws.bak
# Windows の .aws を指すリンクを作る(taro は自分のユーザー名に)
ln -s /mnt/c/Users/taro/.aws ~/.aws
ls -l ~/.awslrwxrwxrwx 1 taro taro 22 Oct 23 10:00 /home/taro/.aws -> /mnt/c/Users/taro/.awsこの方法の利点は、config だけでなく SSO のトークンのキャッシュ(.aws/sso/cache)も共有されることだ。PowerShell で aws sso login をすれば、WSL の Steampipe もそのトークンで API を呼べる。ログインのたびに WSL 側で操作する必要がない。
| 方法 | SSO のトークン | 向いている場合 |
|---|---|---|
| シンボリックリンク(おすすめ) | Windows と共有される | Windows の AWS CLI の設定をそのまま使いたい |
環境変数 AWS_CONFIG_FILE で Windows の config を指す | 共有されない(キャッシュの場所は ~/.aws/sso/cache 固定) | config だけ共有し、ログインは WSL で行う |
| WSL にも AWS CLI を入れて別に設定する | 別々 | WSL を Windows と独立した環境として使いたい |
⚠️ Windows のパスが書かれたプロファイルは WSL では動かない
config に credential_process = C:\tools\get-cred.exe のような Windows のプログラムを指定したプロファイルがあると、WSL からはそのプログラムを実行できない。SSO のプロファイルやアクセスキーのプロファイルは問題なく共有できるので、Steampipe ではそちらを使う。
接続の設定ファイル(aws.spc)を書く
プラグインを入れると、~/.steampipe/config/aws.spc に aws という名前の接続が1つ作られる。中身は説明付きの設定例だが、すべてコメントアウトされているので、このままだと AWS CLI と同じ探し方(環境変数 → default プロファイル …)で認証情報とリージョンが決まる。
意図しない認証情報を使わないよう、プロファイルとリージョンを明示しておく。ファイルを開いて、先頭の接続を次のように書き換える。
nano ~/.steampipe/config/aws.spcconnection "aws" {
plugin = "aws"
profile = "dev"
regions = ["ap-northeast-1"]
}書式は HCL(Terraform と同じ記法)で、主に使う項目は次のとおり。
| 項目 | 意味 | 省略したとき |
|---|---|---|
profile | 使うプロファイル名(~/.aws/config のもの) | AWS CLI と同じ探し方で決まる |
regions | 問い合わせるリージョン。"*" や "ap-*" のようなワイルドカードも使える | default_region の1リージョンだけ |
default_region | IAM や Cost Explorer などグローバルな API を呼ぶリージョン | 環境変数 → プロファイルの region → regions から推測 → us-east-1 |
ignore_error_codes | 無視するエラーコードの一覧 | 「見つからない」系のエラーだけ無視(PART 06) |
max_error_retry_attempts | 失敗した API 呼び出しの最大試行回数 | 9 |
💡 boto3 とは環境変数の扱いが逆
boto3 の PART 02 では「環境変数のアクセスキーがプロファイルより先に使われる」落とし穴を紹介した。Steampipe の AWS プラグインは逆で、接続に profile・アクセスキー・regions のどれかを書くと、環境変数の認証情報は使われない。シェルに古い AWS_ACCESS_KEY_ID が残っていても、接続の設定が優先される。
設定ファイルは保存すれば読み直されるので、Steampipe を再インストールする必要はない。反映されていないように見えるときは、後述のサービスを起動していれば steampipe service restart を実行する。
接続を確認する
まず PowerShell で SSO にログインしておき(aws sso login --profile dev)、WSL で次のクエリを実行する。aws_sts_caller_identity は、AWS CLI の aws sts get-caller-identity と同じ情報を返すテーブルだ。
steampipe query "select account_id, arn from aws_sts_caller_identity"+--------------+---------------------------------------------------------------------------------------+
| account_id | arn |
+--------------+---------------------------------------------------------------------------------------+
| 123456789012 | arn:aws:sts::123456789012:assumed-role/AWSReservedSSO_ReadOnly_0123456789abcdef/taro |
+--------------+---------------------------------------------------------------------------------------+アカウント ID とロールが意図どおりなら、接続はできている。対話モードでは、. で始まるメタコマンドで接続やテーブルを確認できる。
| メタコマンド | 表示されるもの |
|---|---|
.connections | 接続の一覧と、使っているプラグイン |
.inspect aws | 接続 aws のテーブルの一覧 |
.inspect aws_ec2_instance | テーブルの列と説明(PART 03 で詳しく使う) |
.help / .exit | ヘルプ / 終了(Ctrl+D でも終了) |
うまくいかないときは、エラーの内容で原因を絞り込む。
| 症状 | よくある原因と対処 |
|---|---|
| プロファイルが見つからない | ~/.aws のリンク先が違う、またはプロファイル名の誤り。cat ~/.aws/config で WSL から見えているか確かめる |
| SSO のトークンが無い・期限切れ | PowerShell で aws sso login --profile dev をやり直す |
| アカウントが想定と違う | aws.spc の profile が未設定で、default プロファイルが使われている |
| 名前解決やタイムアウトのエラー | プロキシの設定。WSL のシェルで HTTPS_PROXY を設定する |
SSOのトークンが切れたとき
IAM Identity Center のトークンには有効期限がある(期間は組織の設定による)。期限が切れると、Steampipe のクエリは認証エラーになる。Steampipe には自分でログインし直す機能がないため、Steampipe の外でログインし直す。
- PowerShell で
aws sso login --profile devを実行し、ブラウザで承認する - WSL で同じクエリを再実行する(トークンは
.awsのリンク経由で共有されている) - それでも古い認証情報のエラーが続く場合は、
steampipe service restartでプラグインを起動し直す
同じ理由で、MFA の入力が必要な AssumeRole のプロファイルは、そのままでは使えない。Steampipe が MFA のコードを聞いてこないためだ。この場合は、あらかじめ一時的な認証情報を作っておくプロファイル(credential_process)を用意する。詳しくは PART 06 で触れる。
サービスとして起動しWindowsのツールから使う
steampipe query を実行すると、内蔵の PostgreSQL はその間だけ起動し、終了すると止まる。これとは別に、PostgreSQL を常駐させる「サービス」モードがある。Powerpipe(PART 07)を使うときや、Windows の DB ツールから問い合わせたいときに使う。
# 自分のPCからだけ接続を受け付けて起動する
steampipe service start --database-listen local
# 状態と接続情報(パスワード付き)を表示する
steampipe service status --show-password
# 止める
steampipe service stop起動すると、接続先が postgres://steampipe:<パスワード>@localhost:9193/steampipe の形で表示される。WSL2 は、WSL 内の localhost で待ち受けているポートを Windows の localhost からも使えるようにしているので、Windows の DBeaver や A5:SQL Mk-2 などから次の内容で接続できる。
| 項目 | 値 |
|---|---|
| 種類 | PostgreSQL |
| ホスト / ポート | localhost / 9193 |
| データベース / ユーザー | steampipe / steampipe |
| パスワード | steampipe service status --show-password で表示されたもの |
⚠️ --database-listen local を付けて起動する
何も指定しないと、サービスはすべてのネットワークからの接続を受け付ける設定(network)で起動する。手元で使うだけなら local を指定し、同じネットワークの他の PC から AWS の情報を引かれないようにしておく。
準備のチェックリスト
- WSL2 の Ubuntu 22.04 以降(このシリーズは 24.04)で作業している
steampipe --versionとsteampipe plugin listで AWS プラグインが見える- WSL の
~/.awsが Windows の.awsを指している(ls -l ~/.aws) aws.spcにprofileとregionsを明示したaws_sts_caller_identityで意図したアカウントとロールが返る- サービスを起動するときは
--database-listen localを付ける
✅ 次の記事では…
PART 03 では、テーブルの列の調べ方と、速く・漏れなく取るためのクエリの書き方(列の選び方・API 側で効く絞り込み・JSONB・キャッシュ)を解説する。