Kubernetes でのデバッグ

JetBrains Rider は、一時的なコンテナーを使用したオンザフライの pod トラブルシューティングと、Telepresence を使用したリモートデバッグという Kubernetes デバッグフローをサポートしているため、IDE を移動せずにさまざまな問題を診断できます。

一時的なコンテナー

JetBrains Rider は、実行中の pods を再起動することなく、一時的なコンテナー(英語)をアタッチすることをサポートしています。これにより、稼働中の Kubernetes 環境をインスペクションし、診断コマンドを実行し、実行中の pod 内で直接問題を調査することができます。

一時的なコンテナーは、既存の pod にデバッグ用に一時的に追加され、アプリケーションコンテナーと並行して実行されます。この目的のため、JetBrains Rider は内部で kubectl debug コマンドを実行します。カスタムデバッグコンテナーをアタッチするか、ping、netstat、wget、top などの一般的なツールをすぐに使用できる軽量の BusyBox イメージを使用することもできます。

pods 実行中のデバッグの詳細については、Kubernetes のドキュメント(英語)を参照してください。

稼働中の pod に BusyBox を接続する

サービスツールウィンドウを開きます。表示 | ツールウィンドウ | サービスを選択するか、Alt+8 を押します。
実行中の pods をリストするノードを展開し、デバッグする pod を右クリックして、コンテキストメニューから一時的なデバッグコンテナー | Busybox を添付するを選択します。
または、必要な pod を選択し、ツールバーのをクリックして、ドロップダウンから Busybox を添付するを選択します。

実行中の pod にカスタムコンテナーを接続する

サービスツールウィンドウを開きます。表示 | ツールウィンドウ | サービスを選択するか、Alt+8 を押します。
実行中の pods をリストするノードを展開し、デバッグする pod を右クリックして、コンテキストメニューから一時的なデバッグコンテナー | カスタムを添付を選択します。
または、必要な pod を選択し、ツールバーのをクリックして、ドロップダウンからカスタムを添付を選択します。
カスタムデバッグコンテナーをアタッチするダイアログで、次のフィールドを使用して、一時コンテナーを起動および接続するための kubectl debug コマンドをカスタマイズします。
- Pod: ドロップダウンからデバッグする pod を選択します。
- ターゲット : 選択した pod 内のターゲットコンテナーを指定します。
- イメージ : デバッグに使用するイメージの名前を入力し、候補リストから選択します。
- 実行可能ファイル: 起動後に一時コンテナー内で実行するシェルの絶対パスを指定します (たとえば、BusyBox の場合は /bin/sh、Ubuntu の場合は /bin/bash)。
- オプション : デバッグコンテナーに追加の設定パラメーターを提供します。例については、Kubernetes のドキュメント(英語)を参照してください。
アイコンの上にマウスカーソルを置くと、結果の kubectl debug コマンドがプレビューされます。
Pod に取り付けるをクリックします。

JetBrains Rider が新しい一時コンテナーを起動し、それを pod に正常に接続すると、コンソールタブが開き、そこでコマンドを実行して pod をインスペクションできるようになります。

BusyBox をアタッチすると、JetBrains Rider は自動的に sh を使用します。カスタムイメージの場合、IDE は「実行可能ファイル」フィールドで指定されたシェルを使用します。

コンテナーが接続されている pod を削除すると、コンテナーは削除されます。

最近のコマンドを使用して一時コンテナーを起動する

サービスツールウィンドウを開きます。表示 | ツールウィンドウ | サービスを選択するか、Alt+8 を押します。
実行中の pods をリストするノードを展開し、デバッグ対象の pod を右クリックします。コンテキストメニューから一時的なデバッグコンテナーを選択し、必要な最近のコマンドを選択します。
または、必要な pod を選択し、ツールバーのをクリックして、ドロップダウンから最近のコマンドを選択します。

最近のコマンドを管理する

最近のコマンドにアクセスします。
- 設定 / 環境設定ダイアログ（Ctrl+Alt+S）で、ビルド、実行、デプロイ | Kubernetes を選択します。
- サービスツールウィンドウ（Alt+8）を開きます。実行中の pod を右クリックし、コンテキストメニューから一時的なデバッグコンテナー | 最近編集を選択します。
一時的なデバッグコンテナーセクションに移動します。
- 事前に設定して新しい一時コンテナーをすばやく起動できる新しいコマンドを追加するには、をクリックします。デバッグパラメーターを追加するダイアログでは、イメージ、実行可能ファイル、kubectl debug コマンドのオプションを指定できます。
- 最近使用したコマンドからコマンドを削除するには、テーブルでコマンドを選択し、をクリックします。
- 既存のコマンドを編集するには、テーブルでコマンドを選択し、をクリックします。デバッグパラメーターを追加するダイアログで、kubectl debug コマンドのイメージ、実行ファイル、オプションを変更します。

Telepresence

Telepresence (英語) は、Kubernetes クラスター内のサービスにアクセスし、サービスがローカルのコンピューターで実行されているかのようにデバッグしたり、変更を加えたり、テストしたりできるツールです。

Kubernetes プラグインは Telepresence との統合を提供し、次のことを可能にします。

Telepresence に接続するは、DNS 名によってクラスター内のサービスにアクセスします。
サービスをインターセプトするは、クラスターからローカル環境にトラフィックをルーティングします。

Telepresence に接続する

サービスツールウィンドウを開きます。表示 | ツールウィンドウ | サービスを選択するか、Alt+8 を押します。
Kubernetes クラスターを右クリックし、Telepresence を接続を選択します。または、ツールバーのをクリックします。プロンプトが表示されたら、Telepresence デーモンを起動するために必要な管理者アカウントのパスワードを入力します。Windows では、telepresence.exe の実行を許可します。
macOS および Linux では、コンピューターに Telepresence がインストールされていない場合、通知が表示され、インストールのオプションが提供されます。Telepresence は /usr/local/bin にインストールされます。同様に、クラスターに交通管理者(英語)がインストールされていない場合、JetBrains Rider によってインストールするように求められます。
Windows の場合は、Telepresence インストールドキュメント(英語)に従ってください。
Telepresence と Traffic Manager をインストールした後、もう一度 Telepresence を接続をクリックします。

クラスターがワークステーション上で実行されているかのように、DNS 名を使用して Kubernetes クラスター内のサービスにアクセスできるようになりました。例: hello-node:9001 へのリクエストを受け入れるアプリケーションがある場合、その名前でアクセスできます。

クラスターからのトラフィックを傍受する

インターセプトを使用すると、Kubernetes クラスター内のサービスに送信されるトラフィックを取得し、ローカルサービスにルーティングできます。

ツールバーで、 ( 新規インターセプトの作成 ) をクリックし、次に新規インターセプトの作成をクリックします。
開いたウィンドウのサービスリストで、インターセプトするワークロードを選択します。これは、デプロイ、ReplicaSet、StatefulSet のいずれかになります。
ポートフィールドで、サービスのローカルインスタンスが実行されているポートを指定します。