Cloud Code は、Kubernetes Pod へのデバッガのアタッチをサポートします。デバッグ可能なコンテナとタイプ cloudcode.kubernetes のアタッチ構成だけが必要です。
コンテナの設定
デバッグするコンテナがデバッグできる状態であることを確認する必要があります。そのようにコンテナを設定するための言語別の手順を次に示します。
Node.js
--inspect=<debugPort>で Node.js アプリケーションを起動します。debugPortはアタッチ構成から取得します。例:CMD ["node", "--inspect=9229", "index.js"]
Python
Go
Java
- JVM がマシンにインストールされていることを確認します。
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<debugPort>,quiet=yを使用して Java アプリケーションを起動します。debugPortはアタッチ構成から取得します。たとえば、Java アプリケーションをデバッグモードで起動し、ポート
debugPortで接続をリッスンします。ENTRYPOINT ["java","-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<debugPort>,quiet=y", "-jar", "my-app-1.0.jar"]
.NET Core
Microsoft の.NET Core コマンドライン デバッガの
vsdbgが Kubernetes コンテナにインストールされていることを確認します。例:
RUN apt-get update
&& apt-get install -y --no-install-recommends unzip
&& apt-get install -y procps
&& rm -rf /var/lib/apt/lists/*
&& curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v latest -l /vsdbg
アタッチ構成の設定
デバッグ可能なコンテナにアタッチするには、cloudcode.kubernetes タイプのアタッチ構成が必要です。
.vscode/launch.json ファイルがないプロジェクト
プロジェクトの .vscode フォルダに launch.json ファイルがない場合は、[デバッグ] パネルを使用して追加できます。
[デバッグ] パネルに移動し（アクティビティ バーの [デバッグ] ビューアイコン
を使用）、プルダウン メニューから [Add Configuration] を選択します。
環境として
Cloud Code: Kubernetesを選択します。
Attach to Kubernetes Podオプションを選択
対応するプログラミング言語を選択します。
これにより、プロジェクトの
launch.jsonファイルが作成されて開き、接続構成も作成されます。プロジェクトの構成属性に合わせて、このファイル内の構成属性を更新できます。構成属性の詳細については、こちらの表をご覧ください。
.vscode/launch.json ファイルがあるプロジェクト
既存の .vscode/launch.json に新しいアタッチ構成を追加するには:
- launch.json ファイルを開きます。
Add Configurationボタンを押して、Intellisence スニペットを起動します。- 目的の言語の
Cloud Code: Attach to Kubernetes Podスニペットのうちいずれかを選択します。 これにより、アタッチ構成が追加されます。これで、この構成の属性をプロジェクトの属性に合わせて更新できます。構成属性の詳細については、こちらの表をご覧ください。
構成属性
| 属性 | 説明 |
|---|---|
| debugPort | コンテナで使用されるデバッグポート。 |
| podSelector | デバッグ Pod の選択に使用される Key-Value ペアです（詳細については、セレクタのガイドをご覧ください）。典型的な podSelector の場合、次のようになります。
|
| localRoot | デバッグするプログラムが存在するローカル ディレクトリのパス。 デフォルトは ${workspaceFolder} です。 |
| remoteRoot | デバッグするプログラムが存在するリモート ディレクトリの絶対パス（Kubernetes コンテナ上のパス）。 |
Kubernetes Pod へのデバッガのアタッチ
構成とコンテナを設定したら、次の手順を行います。
- デバッグビュー を開きます。
F5を押して、構成を選択して起動します。localhost:${debugPort}は、デバッグ中にコンテナのdebugPortにポート転送されます。
- これで、デバッグ セッションが正常に設定されました。
- ブレークポイントの設定やコードのステップ実行など、ローカルコードのデバッグ時に普段行うすべてのタスクを実行できるようになります。
変数とスタック情報を調べるには、デバッグ サイドバーを使用します。デバッグ セッションをインタラクティブに操作するには、下部ペインのデバッガにあるデバッグ コンソールを使用します。
デバッグ セッションを終了するには、デバッグ ツールバーの停止アイコンをクリックします。
Kubernetes Pod へのアタッチと Kubernetes アプリケーションのデバッグ
| Kubernetes Pod への接続 | Kubernetes アプリケーションのデバッグ |
|---|---|
| 単一の Kubernetes Pod をデバッグします。 | アプリケーション内のすべてのデバッグ可能なコンテナをデバッグします。 |
| デバッグする前に、アプリケーションが Kubernetes Pod で実行されていることを確認する必要があります。 | Kubernetes クラスタでアプリケーションを実行し、デバッガをアタッチします。 |
| タイプ「cloudcode.kubernetes」の構成（.vscode/launch.json）を使用し、「attach」をリクエストします。 | タイプ「cloudcode.kubernetes」の構成（.vscode/launch.json）を使用し、「launch」をリクエストします。 起動構成とアタッチ構成。 |
サンプル構成:
{
"name": "Attach to Kubernetes Pod (NodeJS)",
"type": "cloudcode.kubernetes",
"request": "attach",
"language": "Node",
"debugPort": 9229,
"podSelector": {
"app": "hello-world"
},
"localRoot": "${workspaceFolder}",
"remoteRoot": "/app"
}
|
サンプル構成:
{
"name": "Run/Debug on Kubernetes",
"type": "cloudcode.kubernetes",
"request": "launch",
"skaffoldConfig": "${workspaceFolder}/skaffold.yaml",
"watch": true,
"cleanUp": true,
"portForward": true
}
|
| この構成はアプリケーションの実行には使用できません | この構成は、アプリケーションの実行とデバッグの両方に使用できます。 |
| この構成は言語固有のものです | この構成は言語に依存しません |
| 専用のコマンドを使用しません | 「Debug on Kubernetes」コマンド |