Kubernetes

リソースファイルを作成する

IntelliJ IDEA を使用すると、Kubernetes で最も一般的なリソースの一部の構成ファイルをすばやく作成できます。

1. Project ツールウィンドウ（Alt+1 ）で、フォルダーを右クリックし、 新機能 を選択するか、 Alt+Insert を押してから、 Kubernetes リソース を選択します。

2. Name フィールドにリソース名を入力し、リストからファイルテンプレートを選択します。

   

   これにより、選択した ファイルテンプレートに基づいた内容で新しいファイルが作成されます。詳しくは ファイルテンプレートを参照してください。

また、YAML ファイルでは、事前定義された ライブテンプレートを使用できます。例:

• kconfigmap: Kubernetes ConfigMap

• kcronjob: Kubernetes CronJob

• kdeployment: Kubernetes デプロイ

• kingress: Kubernetes Ingress

• kpod: Kubernetes Pod

• kresource: Kubernetes リソースをゼロから構築

• kservice: Kubernetes サービス

フローティングツールバーの外観を設定する

エディターでフローティングツールバーをいつ表示するかを設定できます。

1. Ctrl+Alt+S を押して設定を開き、 ビルド、実行、デプロイ | Kubernetes を選択します。

2. エディターにフローティングツールバーを表示する オプションを使用して、フローティングツールバーがいつ表示されるかを選択します。

   • 常に実行

   • マウス移動時

   • 表示しない

   または、フローティングツールバーを右クリックして必要なオプションを選択することもできます。

Kubernetes スキーマの検証を無効にする

PhpStorm は、Kubernetes API スキーマに対して Kubernetes ファイルを検証します。 これには、必要なキーまたは可能なタイプのリソースのチェックが含まれます。

ファイルに apiVersion と kind が含まれているが、それが Kubernetes ファイルではない場合、そのような検証を無効にすることができます。 インスペクションを抑制し、その範囲と重大度を 設定 | エディター | インスペクション | Kubernetes で変更できます。 または、検証を無効にする特別なディレクティブでファイルをマークすることもできます。

• ファイルの先頭に # nonk8s を追加します。

• または、不明なリソースに関する警告がすでにある場合は、 問題 ツールウィンドウでそれを右クリックし、 クイックフィックスの表示 | このファイルを非 Kubernetes にマーク を選択します。

コンテキストの追加

Kubernetes クラスターと対話するには、 サービス ツールウィンドウでクラスターを追加します。

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. サービス ツールウィンドウで Kubernetes ノードを右クリックし、 コンテキストの追加 を選択します。 または、 をクリックして Kubernetes | コンテキストの追加 を選択します。

   次に、追加する Kubernetes クラスターのソースを選択します。

   • デフォルトディレクトリから: デフォルトの場所 (通常は $HOME/.kube/config) からクラスターを取得します。

   • カスタム kubeconfigs から: コンピューターから任意の kubeconfig ファイルを選択します。

   • kubeconfig の内容を貼り付け: 開いたテキストエリアに kubeconfig のコンテンツを貼り付けます。

   

3. 開いた コンテキストの追加 ウィンドウで、追加するクラスターを選択し、 コンテキストの追加 をクリックします。

   

追加された Kubernetes クラスターは、 サービス ツールウィンドウで利用できるようになります。 クラスターを右クリックして 新規タブで開く を選択すると、それぞれを別のタブで開くことができます。

クラスターリソースをリアルタイムで監視するには、 クラスターに接続します。

クラスターに接続する

クラスターに接続して IDE で操作できます: ログを追跡し、リソースをプレビューし、構成ファイルを表示し、変更時にライブアップデートを取得できます。 クラスターに接続しなくても、エディターで リソースを変更できます。

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. サービス ツールウィンドウにクラスターがない場合は、 クラスターを追加します。

3. クラスターを右クリックし、 クラスターの接続 を選択します。

kubeconfig の編集

kubeconfig ファイルには、クラスター、ユーザー、名前空間、認証に関する情報が含まれています。

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. クラスターを選択し、ツールバーの (エディターで Kubeconfig ファイルを開く) をクリックします。 このアクションは、 サービス ツールウィンドウで任意の Kubernetes オブジェクトを右クリックした場合にも使用できます。

   これにより、エディターの新しいタブで kubeconfig ファイルが開きます。 このアクションによって開かれるデフォルトのファイルを変更するには、 kubeconfig ファイルへのパスで別のファイルへのパスを指定できます。

kubeconfig ファイルを変更すると、構成が自動的に再ロードされます。 クラスターまたは任意の Kubernetes オブジェクトを右クリックして 詳細 | 構成を自動的に再ロード を選択することにより、手動で再ロードするか、自動再ロードを無効にすることもできます。

名前空間を切り替える

Kubernetes 名前空間を使用すると、クラスター内のリソースを論理的に分離できます。 PhpStorm を使用すると、名前空間をすばやく切り替えることができます。

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. クラスターまたは任意のリソースを右クリックし、 名前空間 を選択し (またはツールバーの をクリックし)、必要な名前空間を選択します。

   すべての名前空間のリソースを表示するには、 すべての名前空間 を選択します。

   

現在のクラスターを選択

現在のクラスターとは、エディターおよび Project ツールウィンドウでリソースと対話するためのデフォルトとして設定されているクラスターを指します。

リソースファイルをローカルで変更または作成する場合、 をクリックするか、 フローティングツールバーを使用して、リソースを適用するクラスターを選択できます。 また、事前に選択しておくこともできます。

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. クラスターを右クリックし、 クラスターを現在のものとして設定 を選択します。

   

   または、クラスターを選択し、ツールバーの をクリックします。

クラスターにリソースを作成する

リソースファイルを作成したら、クラスター内に対応するリソースを作成できます。

1. 必要なリソースファイルをエディターで開きます。 現在のクラスターが設定されていない場合は、 フローティングツールバーを使用して選択してください。

   

   必要に応じて、リストから名前空間を選択することもできます。

2. 現在のクラスターと名前空間に変更を適用するには、 をクリックします。

クラスタリソースを変更する

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. リソースを右クリックし、 YAML の表示 を選択します。

   選択したリソースのマニフェストがエディターの新しいタブで開きます。 フィールドを変更すると、変更された行がガターでハイライト表示されます。 ガターのハイライト領域をクリックすると、変更内容をすぐにプレビューしたり、ロールバックしたりできます。

3. フローティングツールバーで現在のクラスターが選択されていることを確認し、変更を反映するには をクリックしてください。

リソースの詳細を表示

PhpStorm を使用すると、コマンドを手動で実行することなく、Kubernetes リソースの詳細をすばやく表示できます。

• サービス ツールウィンドウで、リソースを選択して詳細を表示します。

• PhpStorm は、デプロイされた Kubernetes リソースのライブステータスをエディターに直接表示します。 例: デプロイマニフェストを開くと、 replicas フィールドの横にステータスインジケーターが表示され、現在実行中、保留中、失敗している pods の数が表示されます。

  

  個々の pods およびジョブのステータスは、それぞれのマニフェストの name フィールドの横で確認できます。

  エラーが発生してリソースに障害が発生した場合、PhpStorm は ログを開く リンクを表示し、問題を説明する関連ログエントリにすばやく移動できます。

  

リソースの削除

次のいずれかの方法でリソースを削除できます。

• サービス ツールウィンドウでリソースを右クリックし、 削除 を選択します。

• サービス ツールウィンドウでリソースを選択し、ツールバーの (リソースの削除) をクリックします。

• リソース YAML ファイルがエディターで開かれている場合は、フローティングツールバーで現在のクラスターを選択し、 をクリックします。

• リソース YAML ファイルが開いている場合は、エディター内の任意の場所を右クリックし、フローティングツールバーでクラスターが選択されていない場合は 削除 (現在のクラスターは未構成) を選択し、クラスターが選択されている場合は クラスター「cluster_name」と名前空間「namespace_name」から削除する を選択します。

エディターでリソースログを開く

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. 次のいずれかの方法でログソースを選択します。

   • すべてのリソースのログを表示するには、Kubernetes クラスターを選択し、 サービス ツールウィンドウのツールバーで (ログの追跡) をクリックします。

     

   • 特定のリソースのログを表示するには、リソースを選択し、 サービス ツールウィンドウのツールバーで (ログの追跡) をクリックします。 または、リソースを右クリックして ログの追跡 を選択します。

     pod に複数のコンテナーが存在する場合は、表示されるコンテナーのリストからログを追跡するコンテナーを選択します。

     

これにより、選択したリソースのライブテールログが --follow=true フラグ付きで表示され、新しいエディタータグで開きます。

ログを管理する

クラスターログまたは選択したリソースのログを表示する際は、メインツールバー（1）またはフローティングツールバー（2）を使用してログ出力を操作できます。 フローティングツールバーを使用すると、頻繁に使用するアクションにすばやくアクセスできます。

• (末尾までスクロール): ログ出力の末尾に移動します。

• (ソフトラップ): エディターのサイズが変更されたときに、ログエントリのソフトラッピングを有効にします。

• (フィルターしたログのダウンロード): 適用されているフィルターを考慮して、エディターで現在開いているログをダウンロードします。

• (表示中のログをクリア): エディターに表示されているログエントリをクリアします。 このアクションは現在のビューにのみ影響します。 同じリソースのログを再度開くと、エントリが再表示されます。

ログをフィルタリングする

ログを開いたら、エディターの上部にある次のフィルターを使用してログリストを絞り込むことができます。

• (オープンパターンマッチング): ログデータと一致させる値またはパターンを入力または選択します。 例: ログにレベル情報が存在する場合は、 warn、 error 、またはその他のレベル値を選択して、これらのレベルに対応するログのみを表示できます。

• (ログソースを選択): ログを表示するクラスターリソースを選択します。

• (日付と時刻でフィルタリング): ログを表示する時間範囲を選択します。

• (ログフィールドを選択): ログのタイムスタンプ、ソース、メッセージを表示するかどうかを選択します。

• エディタータブの上部にある入力フィールドに、ログメッセージの値を入力します。 正規表現を使用するには をクリックし、大文字と小文字を区別して検索するには をクリックします。



• (すべてのログフィルターをクリア): 適用されたすべてのフィルター (ソースを除く) を破棄し、すべてのログを表示します。

• ログエントリーに対して正規表現ベースのハイライトルールを定義することで、エラー、警告、情報イベントなどの重要なメッセージを特定し区別できます。 IDE 設定 (Ctrl+Alt+S) の ビルド、実行、デプロイ | Kubernetes | ログ で、 フィルター テーブルを使ってルールを作成・管理できます。 各フィルターごとに正規表現パターンを指定し、太字、斜体、有効化や色の選択で見た目をカスタマイズできます。

単一のコンテナーのログをダウンロードする

1. Services ツールウィンドウを開きます。 表示 | ツールウィンドウ | サービス に移動するか、 Alt+8 を押します。

2. リソースを選択し、右側のツールバーの (ログのダウンロード) をクリックして、ログファイルを保存します。

ログオプションを構成する

ログオプションは、IDE の設定（Ctrl+Alt+S ）の ビルド、実行、デプロイ | Kubernetes | ログ で設定できます：

• スクラッチ以外の場所にログを自動保存したい場合は、 ログの保存先 にディレクトリを指定します。 または、 ダウンロードする前にログの保存場所を確認する を選択すると、ログを保存するたびに場所の指定を求められます。

  ファイル名にログのタイムスタンプを含める場合は、 ログファイル名にタイムスタンプを追加する を選択します。

• Kubernetes ログから ANSI の色やフォーマットコードを削除してプレーンテキストで表示したい場合は、 ログから ANSI コードを除去 を選択します。

• クラスターイベントの出力先 オプションを使うと、ログ出力の表示先としてエディターまたは サービス ツールウィンドウを選択できます。

• デフォルトのログキャッシングサイズは 300 MB です。 この上限を超えると、IDE から通知されます。 これらの通知のしきい値を変更したい場合は、 ログキャッシングが上限を超えたら警告する に希望の値を入力してください。

• エディターでのログ更新頻度を調整したい場合は、 ログエディターの更新遅延 (ミリ秒) でミリ秒単位の遅延を指定します。

CRD 仕様へのパスを指定する

1. Ctrl+Alt+S を押して設定を開き、 ビルド、実行、デプロイ | Kubernetes | スキーマ を選択します。

2. CRD および OpenAPI の仕様 テーブルで をクリックし、ローカルの CRD ファイルを選択するか URL を指定します。 次に、 OK をクリックします。

CRD ファイルのリストを並べ替えるには、 と を使用します。 これにより、競合する定義の優先順位が決まります。複数のファイルで定義されている場合、PhpStorm は最も低いものを使用します。

デフォルトでは、CRD は現在のプロジェクトにのみ適用されます。 この IDE インスタンスで開くプロジェクトで特定の CRD を使用できるようにする場合は、 スコープ: オプションを IDE に変更します。

実行中の Kubernetes クラスターから CRD を読み込むには、 可能な場合にアクティブなクラスターの API スキーマを使用 を有効にします。

ショートカットの割り当て

Kubernetes アクションにキーボードショートカットを割り当てることができます。

1. 設定 ダイアログ (Ctrl+Alt+S) で、 キーマップ を選択します。

2. 検索フィールドに kubernetes と入力してから、アクションをダブルクリックしてショートカットを設定します。

または、 アクションの検索 ダイアログ Ctrl+Shift+A を使用して、必要なアクションを入力し、 Alt+Enter を押すこともできます。

例: クラスターとの対話 にショートカットを割り当てて、リソース構成ファイルの 変更中にコンテキストメニューをすばやく開くことができます。

コードの折りたたみを構成する

デフォルトでは、PhpStorm は コード折りたたみを使用して、Helm テンプレートの値参照と Kubernetes 構成ファイルの定義を実際の値としてレンダリングします。 値をクリックして展開するか、 Ctrl+NumPad + と Ctrl+NumPad - を押して折りたたみを切り替えることができます。 参照と定義がデフォルトで展開されていることを確認するには、次のようにします。

1. 設定 ダイアログ (Ctrl+Alt+S) で、 エディター | 一般 | コードの折りたたみ を選択します。

2. コードの折りたたみ ページで、必要なチェックボックスをオフにします。

   • Kubernetes: Helm テンプレート内の値参照

   • Kubernetes: YAML ファイル内の EnvVar 定義

   • Kubernetes: YAML ファイル内の ExecAction 定義