Kubernetes でのデバッグ
PyCharm は、Kubernetes の以下のデバッグフローをサポートしています。一時的なコンテナーによるオンザフライの pod トラブルシューティングや Telepresence を使ったリモートデバッグで、IDE を離れずにさまざまな問題を診断できます。
一時的なコンテナー
PyCharm は、実行中の pod を再起動せずに 一時的なコンテナー をアタッチすることをサポートしています。 これにより、稼働中の Kubernetes 環境をインスペクションし、診断コマンドを実行し、実行中の pod 内で直接問題を調査することができます。
エフェメラルコンテナーは、既存の pod にデバッグ用に一時的に追加され、アプリケーションコンテナーと並行して実行されます。 この目的のために、PyCharm は内部で kubectl debug コマンドを実行します。 カスタムデバッグコンテナーをアタッチするか、 ping、 netstat、 wget、 top などの一般的なツールをすぐに使用できる軽量の BusyBox イメージを使用することもできます。
pods 実行中のデバッグの詳細については、 Kubernetes のドキュメント(英語)を参照してください。
稼働中の pod に BusyBox を接続する
サービスツールウィンドウを開く： に移動するか、 Alt+8 を押してください。
実行中の pods をリストするノードを展開し、デバッグする pod を右クリックして、コンテキストメニューから を選択します。
または、必要な pod を選択し、ツールバーの
をクリックして、ドロップダウンから Attach Busybox を選択します。
実行中の pod にカスタムコンテナーを接続する
サービスツールウィンドウを開く： に移動するか、 Alt+8 を押してください。
実行中の pods をリストするノードを展開し、デバッグする pod を右クリックして、コンテキストメニューから を選択します。
または、必要な pod を選択し、ツールバーの
をクリックして、ドロップダウンから カスタムを添付 を選択します。Attach Custom Debug Container ダイアログで、次のフィールドを使用して、一時コンテナーを起動および接続するための
kubectl debugコマンドをカスタマイズします。Pod: ドロップダウンからデバッグする pod を選択します。
ターゲット: 選択した pod 内のターゲットコンテナーを指定します。
イメージ: デバッグ用に使用するイメージ名を入力し、候補リストから選択してください。
実行可能: 起動後に一時コンテナー内で実行するシェルへの絶対パスを指定します（たとえば、BusyBox なら
/bin/sh、Ubuntu なら/bin/bash）。オプション: デバッグコンテナーに追加の設定パラメーターを提供します。 例については、 Kubernetes のドキュメント(英語)を参照してください。
Attach to Pod をクリックしてください。
PyCharm が新しい一時コンテナーを起動し、pod に正常にアタッチすると、 コンソール タブが開き、そこでコマンドを実行したり pod を確認したりできます。
BusyBox をアタッチすると 、PyCharm は自動的に sh を使用します。 カスタムイメージの場合、IDE は 実行可能 フィールドで指定されたシェルを使用します。
コンテナーが接続されている pod を削除すると、コンテナーは削除されます。
最近のコマンド
一時的なデバッグコンテナー メニューで一時的なコンテナーをアタッチすると、PyCharm は対応する kubectl debug コマンドを自動保存します。 後で 最近 セクションからアクセスして再実行できます。
最近のコマンドを使用して一時コンテナーを起動する
サービスツールウィンドウを開く： に移動するか、 Alt+8 を押してください。
実行中の pods をリストするノードを展開し、デバッグ対象の pod を右クリックします。 コンテキストメニューから 一時的なデバッグコンテナー を選択し、必要な最近のコマンドを選択します。
または、必要な pod を選択し、ツールバーの
をクリックして、ドロップダウンから最近のコマンドを選択します。
最近のコマンドを管理する
最近のコマンドにアクセスします。
設定 ダイアログ（Ctrl+Alt+S ）で、 を選択します。
サービス ツールウィンドウ（Alt+8 ）を開きます。 実行中の pod を右クリックし、コンテキストメニューから を選択します。
一時的なデバッグコンテナー セクションに移動します。
事前に設定して新しい一時コンテナーをすばやく起動できる新しいコマンドを追加するには、
をクリックします。 デバッグパラメーターを追加する ダイアログでは、イメージ、実行可能ファイル、 kubectl debugコマンドのオプションを指定できます。最近使用したコマンドからコマンドを削除するには、テーブルでコマンドを選択し、
をクリックします。既存のコマンドを編集するには、テーブルでコマンドを選択し、
をクリックします。 デバッグパラメーターを追加する ダイアログで、 kubectl debugコマンドのイメージ、実行ファイル、オプションを変更します。
Telepresence
Telepresence (英語) は、Kubernetes クラスター内のサービスにアクセスし、サービスがローカルのコンピューターで実行されているかのようにデバッグしたり、変更を加えたり、テストしたりできるツールです。
Kubernetes プラグインは Telepresence との統合を提供し、次のことを可能にします。
Telepresence に接続して、DNS 名でクラスター内のサービスにアクセスします。
サービスをインターセプトするは、クラスターからローカル環境にトラフィックをルーティングします。
Telepresence に接続する
サービスツールウィンドウを開きます。 を選択するか、 Alt+8 を押してください。
Kubernetes クラスターを右クリックし、 Telepresence を接続 を選択します。 あるいは、ツールバーの「
」をクリックします。 プロンプトが表示されたら、Telepresence デーモンを起動するために必要な管理者アカウントのパスワードを入力します。 Windows では、 telepresence.exe の実行を許可します。Telepresence と Traffic Manager をインストールした後、もう一度 Telepresence を接続 をクリックします。
クラスターがワークステーション上で実行されているかのように、DNS 名を使用して Kubernetes クラスター内のサービスにアクセスできるようになりました。 例: hello-node:9001 へのリクエストを受け入れるアプリケーションがある場合、その名前でアクセスできます。
クラスターからのトラフィックを傍受する
インターセプトを使用すると、Kubernetes クラスター内のサービスに送られるトラフィックを受け取り、それをローカルサービスへルーティングできます。
ツールバーで、
(Create New Interception) をクリックし、次に Create new interception をクリックします。開いたウィンドウの サービス リストで、インターセプトするワークロードを選択します。 これは、デプロイ、ReplicaSet、StatefulSet のいずれかになります。
ポート フィールドで、サービスのローカルインスタンスが実行されているポートを指定します。
サービスが正常にインターセプトされると、ローカルでアクセスでき、IDE 機能を使ってクラスター内で実行中のアプリケーションの試行、デバッグ、プロファイリングができます。
Telepresence の終了
Telepresence は一度に 1 つのクラスターと対話するため、別のクラスターに接続する前にテレプレゼンスを停止する必要がある場合があります。 テレプレゼンスを終了すると、アクティブな傍受がすべて停止されます。
サービスツールウィンドウを開きます。 を選択するか、 Alt+8 を押してください。
Kubernetes クラスターを右クリックし、 Telepresence の終了 を選択します。 あるいは、ツールバーの「
」をクリックします。
インターセプションを使用してアプリケーションを実行する
PyCharm で、ワンクリックでローカルアプリケーションを実行し、同時に Kubernetes クラスター内のサービス宛てトラフィックをこのローカルアプリケーションへリダイレクトできます。
これは、Kubernetes クラスターへのトンネル（Telepresence インターセプト）を構成し、実行構成の 起動前タスクとして追加することで実現します。 この実行構成を実行するたびに、PyCharm は Telepresence インターセプトを作成し、リモートアプリケーションをローカルで動作させているかのようにデバッグできるようにします。
実行構成にインターセプションを追加する
以下を確認してください：
サービスの元のインスタンスが Kubernetes クラスターにデプロイされて実行され、そのローカルインスタンスのソースコードがエディターで開かれます。
あなたの PyCharm インスタンスは Kubernetes クラスターに接続されています。
メインクラス宣言の近くのガターで
をクリックし、 リモートデバッグ用のトンネルを追加 を選択します。 このアクションは、PyCharm でクラスターが少なくとも 1 つ接続されている場合に利用できます。
あるいは、アプリケーションの実行 / デバッグ構成がすでに存在する場合は、実行ウィジェットで
をクリックし、 リモートデバッグ用のトンネルを追加 を選択します。開いた 実行構成に Kubernetes トンネルを追加する ウィンドウで、クラスターと名前空間を選択し、 Connect to Cluster をクリックします。 プロンプトが表示されたら、Telepresence デーモンを起動するために必要な管理者アカウントのパスワードを入力します。
クラスターに正常に接続できた場合は、インターセプトパラメーターを構成してください：
サービス リストで、インターセプトするワークロードを選択します
ポート フィールドで、サービスのローカルインスタンスが実行されているポートを指定します。
必要に応じて、
telepresence interceptコマンドに追加のオプションを指定します。
Telepresence コマンドの出力を確認する場合は、 出力 セクションを展開します。 Telepresence への接続中にエラーが発生した場合、このセクションは自動的に展開されます。
設定の保存 をクリックしてください。 インターセプトパラメーターを確認するため、PyCharm はインターセプトを作成してすぐに解除します。
インターセプトパラメーターは、新しい実行構成の起動前タスクとして Add Tunnel for Debug として保存されます。 他の実行構成と区別するために、この実行構成名には (Telepresence) 接尾辞が含まれます (例: MyApp（Telepresence）)。
これで、 アプリケーションを実行し、そのリモートバージョンをインターセプトする準備が整いました。
インターセプションを使用してアプリケーションを実行する
実行ウィジェットで、 (Telepresence) 接尾辞を持つ実行構成を選択します。
- をクリックして実行するか、
をクリックしてデバッガーセッションを開始します。
これにより、ローカルアプリケーションが実行され、同時に上記で指定したパラメーターを使用して telepresence intercept コマンドが実行されます。
Telepresence は、クラスター内のサービスに送信されるすべてのトラフィックをインターセプトし、ローカルアプリケーションにルーティングするようになりました。 インターセプトされたサービスをローカルでコーディングおよびデバッグできます。
サービス ツールウィンドウには、 Telepresence インターセプション ノードに作成されたインターセプトが表示されます。 Kubernetes クラスターのルートノードには、生成されたテレプレゼンスコマンドと関連ログも表示されます。
このアプリケーションを停止すると（
をクリック）、PyCharm もインターセプト（telepresence leave ）を停止します。