Kubernetes Explorer の使用

Kubernetes Explorer ペインを使用すると、IDE から直接、クラスタ、ノード、ワークロードなどに関する情報にアクセスできます。また、Kubernetes Explorer で現在のコンテキストの設定、ログのストリーミングと表示インタラクティブ ターミナルのオープン、リソースの説明の検索ができます。

Kubernetes Explorer にアクセスする

右側のサイドパネルからアクセスできる Kubernetes Explorer を使用すると、Kubernetes リソースをより簡単に管理できます。または、[Tools] > [Cloud Code] >[Kubernetes] > [View Cluster Explorer] からもアクセスできます。

右側のタスクバーのタブを使用して開いた Kubernetes Explorer パネル

Cloud Code は「$HOME/.kube」ディレクトリの下にあるデフォルトの kubeconfig ファイルを使用しますが、Kubernetes リソースの取得には別の kubeconfig ファイルを使用できます。kubeconfig を管理する方法については、追加の kubeconfig ファイルの操作をご覧ください。

基本操作

Kubernetes Explorer では kubectl が使用されています。クラスタにアクセスするように kubectl コンテキストを構成すると、アクティブまたは非アクティブのコンテキストに関係なく、Kubernetes Explorer を使用してクラスタのすべての Namespace、リソース、ノードを参照できます。

エクスプローラのアイコンからアクセス可能な Kubernetes Explorer の一般的なアクションは次のとおりです。

  • サンプルから新しい Kubernetes アプリケーションを作成する サンプル アイコンから新しい Kubernetes アプリにアクセスする
  • エクスプローラの更新 エクスプローラ アイコンを更新する
  • ウェブブラウザで Cloud Code Kubernetes ドキュメントを開く ドキュメント アイコンを開く

リソース名をコピーする

Kubernetes リソース名(コンテナ名とクラスタ名を含む)をクリップボードにコピーできます。右クリック メニューを使用してリソース名をコピーする

リソースを更新する

Kubernetes Explorer により変更が監視され、更新を反映するために自動的に更新されます。Kubernetes リソースを強制的に更新して最新の情報を取得するには、リソースを右クリックして [更新] を選択します。右クリックでアクセスできる更新メニューを使用して Pod を更新する

Kubernetes Explorer の更新ボタンを使用して、エクスプローラ全体を強制的に更新することができます。

Kubernetes Explorer の [更新] ボタン

リソースの説明

クラスタ以外のリソースの詳細を表示するには、[Describe] を選択します。これにより、Kubernetes Explorer Console パネルにリソース情報が表示されます。

説明オプションは、Kubernetes Explorer パネル内で適切なリソースを右クリックして [説明] を選択することで使用できます。

任意のリソースをクリックして、リソースの詳細を表示することもできます。メタデータが添付されている場合、そのメタデータは Kubernetes Explorer の [Resource Details] パネルに表示されます。

Kubernetes Explorer の後半にある Resource Details パネルでリソース メタデータを表示する

リモート YAML を表示する

Kubernetes Explorer から、クラスタ内のリソースの YAML を表示できます。Kubernetes Explorer で Pod などのリソースに移動し、リソース名を右クリックして [View Remote YAML] を選択します。

指定したリソースに対応する YAML ファイルが、新しいエディタタブで開きます。

Kubernetes Explorer で Pod のラベルを右クリックし、[View Remote YAML] を選択して、Pod の YAML を表示する

ログのストリーミング

Pod、コンテナ、Deployment、サービス、レプリカセットでは、これらのリソースから Kubernetes Explorer Console にログをストリーミングして表示し、進捗状況をモニタリングできます。

右クリック メニューを使用してポッドのログをストリーミングし、Kubernetes Explorer Console にログを出力する

ターミナルの起動

Pod とコンテナでは、インタラクティブ ターミナルを開きます。

Pod の右クリック メニューから Kubernetes Explorer Console のインタラクティブ ターミナルにアクセスする

リソース固有の操作

Kubernetes Explorer には、クラスタ、Namespace、ノード、ワークロード(Deployment、レプリカセット、Pod、コンテナなど)、サービスと Ingress、構成(Secret、構成マップなど)、ストレージ(ボリュームなど)が表示されます。Kubernetes Explorer を使用すると、これらのリソースの一部に対して独自のアクションを実行できます。

クラスタ

  • Google Kubernetes Engine クラスタを追加します。既存の Standard GKE クラスタか Autopilot GKE クラスタを追加するか、または Kubernetes Explorer の [Add GKE Cluster] クラスタ プラス アイコンの追加 をクリックして、新しいクラスタを作成します。

    これにより、[Add GKE Cluster] ダイアログが表示され、使用するプロジェクトとクラスタを選択できます。新しいクラスタを作成して、このダイアログに戻ることもできます。

    完了したら、[OK] をクリックして、Kubernetes Explorer で選択したクラスタとその基盤となるリソースにアクセスします。

    プロジェクトとクラスタ名のフィールドを含む Kubernetes Explorer ダイアログを使用した GKE クラスタの追加

  • 現在のコンテキストに設定: 指定されたクラスタをアクティブとして設定し、構成済みの kubectl コンテキストがデフォルトでこのクラスタにアクセスするようにします。

    Kubernetes Explorer でクラスタを現在のコンテキストとして設定

    この操作が成功すると、エクスプローラが自動的に更新され、該当するクラスタの横に Kubernetes の記号が表示されます。

    また、クラスタに複数のコンテキストが構成されている場合は、使用可能なコンテキストの 1 つを選択して、現在のコンテキストとして設定できます。

    Kubernetes Explorer で複数のコンテキストのリストからアクティブなクラスタを選択して設定する

Namespace

  • 現在のコンテキストに設定: 指定された Namespace をアクティブとして設定し、構成済みの kubectl コンテキストがデフォルトでこの Namespace にアクセスするようにします。

    右クリック メニューで Namespace を現在のコンテキストに設定する

    この操作が成功すると、エクスプローラが自動的に更新され、現在のコンテキストの一部であることを示すため、Namespace の横にアスタリスクが表示されます。

    Kubernetes コンテキストは、クラスタ内の名前空間にすばやくアクセスするためのショートカットです。コンテキストは通常、minikube クラスタまたは GKE クラスタを起動すると自動的に作成されます。特定の名前空間の [Set as current context] オプションが表示されず、そのコンテキストを作成する場合は、ターミナルで kubectl config set-context コマンドを使用して、好みのクラスタ、ユーザー、名前空間でコンテキストを設定します。

ポッド

  • ログのストリーミング: Pod から Kubernetes Explorer Console にログをストリームします。
  • ターミナルの取得: Kubernetes Explorer Console で Pod のターミナルを取得します。

    また、実行中の Pod では、ラベルの横に色付きのステータス マークが表示されます。

    • : Pod は失敗状態です。
    • 黄色: Pod が起動中または終了中です。
    • : Pod は正常で、実行中です

    Pod のラベルの横にある緑色のチェックマークで確認できる通り、Pod のステータスは正常です

コンテナ

デプロイ

  • ログのストリーミング: Deployment から Kubernetes Explorer Console にログをストリームします。

    ライブ Deployment では、ラベルの横に色付きのステータス マーク、現在のレプリカ数、合計レプリカの数が表示されます。

    • 黄色: Deployment に最小限の可用性がないか、イメージに問題があります。
    • : Deployment は正常で、最小限の可用性が確保されていました。

    Deployment ラベルの横に緑色のチェックマークが表示されている場合、Deployment のステータスは正常です

ノード

クラスタのノードの Namespace の横に色付きのステータス マークが表示されます。

  • 黄色: ノードにリソースの問題(メモリやディスクの可用性など)があります。
  • : ノードは正常です。

カスタム リソース定義(CRD)

Kubernetes Explorer には、クラスタにインストールされ、使用可能なすべてのカスタム リソース定義(CRD)が表示されます。

エクスプローラのカスタム リソース定義のリスト

サポートの利用

IntelliJ IDE でフィードバックを送信するか、問題を報告するには、[Tools] > [Cloud Code] > [Help / About] > [Submit feedback or report an issue] を選択します。ここから、GitHub で問題を報告したり、Stack Overflow で質問したりできます。

また、Google Cloud Slack コミュニティの 1 つである、#cloud-code チャンネルにも参加できます。