VS Codeで実践! Kubernetes上のアプリのデバッグ実行手法

Kubernetes上で複数のマイクロサービスが協調動作する環境が一般的になってきました。その環境上でしか動作しないアプリケーションを、開発時のようにステップ実行してデバッグすること（以下、デバッグ実行）を諦めている方も多いと思います。VS Codeでは、Kubernetes上でアプリケーションをデバッグ実行する拡張機能が複数公開されています。本セッションでは、以下の3つのデバッグ実行の手法について、方法とその制約を解説、実演します。

- 拡張機能『Cloud Code』を使う
- kubectl port-forward を使う
- 拡張機能『Bridge To Kubernetes』を使う

ただし、本セッションでも本番環境のコンテナを直接デバッグ実行する方法については触れません。開発、ステージング環境など、ある程度構成を変更可能な環境を対象とします。

Transcript

1. VS Codeで実践！ Kubernetes上のアプリのデバッグ実行 Atsushi Morimoto @74th
2. Atsushi Morimoto @74th • Mobility Technologies所属 • AIよりのサーバサイドエンジニア タクシーアプリ GO や タクシー乗務員支援サービスを開発 • 著書 • VS Code Conference Japan 2021 → 11/20開催！ 技術書典3~11参加
3. とあるタクシー向けAIサービスの構成 （乗務員さんに、お客さんを拾いやすい道順を提供するサービス）
4. これをデバッグ実行したい とあるタクシー向けAIサービスの構成 （乗務員さんに、お客さんを拾いやすい道順を提供するサービス）
5. Kubernetes運用アプリのデバッグのペインポイント • Dockerコンテナ環境でしか再現しない ◦ MacOS/Windows上のローカルでは再現しない • クラウド上のリソースに依存している • Kubernetes上の他のサービスに依存している ◦ 他のコンテナにアクセスできる環境でしか再現しない
6. Agenda 1. ローカルでデバッグ実行 2. Dockerコンテナでデバッグ実行 3. Kubernetesコンテナでデバッグ実行 4. 中間コンテナをデバッグ実行
7. 最初に断っておくこと • 本番環境のコンテナを対象にしません • 開発、ステージング環境など、 構成を変更可能な環境を対象とします • コンテナ内にデバッガなど必要なツールは持込可能とします
8. Agenda 1. ローカルでデバッグ実行 2. Dockerコンテナでデバッグ実行 3. Kubernetesコンテナでデバッグ実行 4. 中間コンテナをデバッグ実行
9. ローカルでの開発
10. ローカルでデバッグ実行
11. デバッガを経由して実行する $ python -m myapp.app $ python -m debugpy \ --listen 0.0.0.0:5678 \ --wait-for-client \ -m myapp.app $ ./cmd/app/main $ dlv exec --listen=0.0.0.0:2345 \ --headless --api-version 2 \ ./cmd/app/main
12. 他に拡張機能やデバッガがやっていること • ビルド時に 最適化オプションをオフにする $ go build -gcflags="all=-N -l" \ cmd/app/main.go
13. Agenda 1. ローカルでデバッグ実行 2. Dockerコンテナでデバッグ実行 3. Kubernetesコンテナでデバッグ実行 4. 中間コンテナをデバッグ実行
14. コンテナでの実行
15. コンテナ内のプロセスにアタッチ
16. Dockerコンテナに追加しておくこと • デバッガもコンテナの中に追加する ◦ イメージにデバッガを持ち込みたくない場合、 デバッガのプログラムを、ボリュームでマウントさせる • 環境変数などによって、 デバッガ経由でプログラムを起動できるようにしておく • 最適化オフのプログラムもビルドしておく
17. 環境変数でデバッガを有効にする 　 import os if os.environ.get("ENABLE_DEBUGGER", "false") == "true": import debugpy debugpy.listen(("0.0.0.0", 5678)) import app app.start() #!/bin/sh if [ "${ENABLE_DEBUGGER}" == "true" ];then # 最適化オフのプログラム dlv exec --headless -l localhost:12345 ./app_debug else ./app fi
18. コンテナ実行後の、デバッグの設定 { "name": "Attach (Remote Debug)", "type": "python", "request": "attach", "pathMappings": [ { "localRoot": "${workspaceRoot}", "remoteRoot": "/app/" } ], "port": 5678, "host": "127.0.0.1" } コンテナ内のパスと ローカルのパスの対応 ~/project/main.py /app/main.py デバッグ実行設定 .vscode/launch.json
19. 拡張機能Docker コンテナビルドや、デバッガ経由の実行をやってくれる 「デバッグ開始ボタン」で、 コンテナビルド→コンテナ内デバッグ実行を行う設定ができる デバッグ実行はNode.js、Python、.NET Coreしか対応しない
20. Agenda 1. ローカルでデバッグ実行 2. Dockerコンテナでデバッグ実行 3. Kubernetesコンテナでデバッグ実行 4. 中間コンテナをデバッグ実行
21. Kubernetes上のコンテナ（Pod）へのデバッグ
22. Kubernetes上のDeploymentへのデバッグ
23. Kubernetes上のDeploymentへのデバッグ • Podの数を1（replicas: 1）にすること • デバッガ経由の実行にコマンドを書き換えること • kubectl port-forwardを使って、 デバッガに接続可能にすること
24. 拡張機能Cloud Code • デバッガの持ち込み、デバッガ経由での実行、 Podの数の変更、ポート転送、デバッガへのアタッチを 全部やってくれる • ただし、Node.js、Python、Go、Java、.NET Coreのみ • 一部、古いデバッガ（Pythonのptvsd）を使っているので注意
25. Agenda 1. ローカルでデバッグ実行 2. Dockerコンテナでデバッグ実行 3. Kubernetesコンテナでデバッグ実行 4. 中間コンテナをデバッグ実行
26. 中間コンテナへのデバッグ
27. デモ 拡張機能 Kubernetes
28. 拡張機能 Bridge to Kubernetes Kubernetes環境をローカルプロセスとしてデバッグ可能にする
29. 通信をローカルプロセスに迂回させてデバッグ実行
30. まとめ • 一般的なデバッグ実行 • Dockerコンテナへのデバッグ実行 ◦ デバッガ経由で実行に置き換える ◦ デバッガにTCPポートでアクセスする ◦ コンテナ内のファイルシステムとの対応を記述する • Kubernetes上のコンテナへのデバッグ実行 ◦ replicas: 1 を使う ◦ デバッガに kubectl port-forward でアクセスする ◦ Bridge to Kubernetesを使い、 ローカルプロセスに通信を迂回させる 設定などの具体例はこちらに https://74th.booth.pm/items/3338895