Kubernetes

Kubernetes(英語) は、デプロイ、スケーリング、コンテナー化されたアプリケーションの管理のためのコンテナーオーケストレーションエンジンです。 WebStorm 用の Kubernetes プラグインをインストールして有効化すると、Kubernetes クラスターの管理に使える次の機能が追加されます：

Kubernetes リソース設定ファイル(英語)のコーディング支援。
Helm(英語) チャートとテンプレートのコーディング支援。詳細については、 Helm 専用ページを参照してください。
カスタムリソース定義（CRD）仕様を使用したカスタムリソースの検証。
カスタマイズする(英語)ファイルのコーディング支援: フィールドおよびローカルファイルパスの補完、クイックドキュメント、Kustomize ファイルとパッチ間のナビゲーション。関連する Kustomize ファイルのリストは、開いている Kustomize パッチの上部にあるエディターに表示されます。
WebStorm からクラスターとのやり取り: サービスツールウィンドウを使って Kubernetes クラスターのすべてのリソースを表示し、関連リソース定義へジャンプしたり、pods 上で動作しているコンテナーのログを表示したりできます。

Kubernetes プラグインは、Kubernetes バージョン 1.26 から 1.34 までサポートします (該当するバージョンを選択できます)。

Kubernetes プラグインのインストール

この機能は、インストールして有効にする必要がある Kubernetes(英語) プラグインに依存しています。

Ctrl+Alt+S を押して設定を開き、プラグインを選択します。
マーケットプレースタブを開き、 Kubernetes プラグインを見つけて、インストールをクリックします (プロンプトが表示されたら、IDE を再起動します)。

kubectl へのカスタムパスを指定する

WebStorm は、 PATH 環境変数で決定されるデフォルトの kubectl（および helm を利用する場合）実行可能ファイルを使用します。

kubectl をカスタムディレクトリにインストールする場合は、そのパスを手動で指定できます。

設定ダイアログ（Ctrl+Alt+S ）で、ビルド、実行、デプロイ | Kubernetes を選択します。
kubectl 実行可能ファイルへのパスフィールドに、kubectl 実行可能ファイルへのパスを指定します。
テストをクリックしてファイルの場所を確認してください。見つからない場合はファイルの場所を手動で確認するか、インストールをクリックすると、WebStorm が不足しているソフトウェアをダウンロードしてインストールします。

カスタム Kubernetes 構成ファイルを使用する

クラスター情報は kubeconfig ファイルに保存されます。 WebStorm はデフォルトの kubeconfig ファイルを検出します。通常は $HOME/.kube/config （この場所は KUBECONFIG 環境変数で変更できます）。 WebStorm でカスタム kubeconfig ファイルからもクラスター情報を取得したい場合は、IDE の設定で指定できます。全体に適用するかプロジェクトごとに異なるファイルを利用できます。

設定ダイアログ（Ctrl+Alt+S ）で、ビルド、実行、デプロイ | Kubernetes を選択します。
構成で、をクリックし、 kubeconfig ファイルへのパスを指定します。
すべてのプロジェクトで構成ファイルを使用する場合は、スコープ列でグローバルを選択します。現在のプロジェクトでのみ使用するには、プロジェクトスコープを保持します。

ファイルを追加すると、WebStorm が構文を検証し、エラーがあれば報告します。

Kubernetes API バージョンを構成する

WebStorm は設定のキー値の補完、ガターアイコンによる関連セレクターおよび定義へのナビゲーション、非推奨値や必須キーを検査する専用インスペクション、その他の支援機能を提供します。これらの機能は、使用している API のバージョンによって異なります。 Kubernetes プラグインは、Kubernetes バージョン 1.26 から 1.34 をサポートしています。デフォルトでは、WebStorm は最新バージョンに設定されます。ただし、リソースで以前のバージョンを使用している場合は、変更できます。

設定ダイアログ（Ctrl+Alt+S ）で、言語 & フレームワーク | Kubernetes を選択します。
必要に応じて、 Kubernetes API バージョンおよび Kustomize バージョンオプションを変更します。

リソース構成ファイル

Kubernetes プラグインは、YAML のリソース構成ファイルの豊富なサポートを提供し、JSON 形式の基本的なサポートのみを提供します。

サポートされている機能

機能	YAML	JSON
自動補完	サポート	サポート
クイックドキュメント	サポート	サポート
インスペクションとクイックフィックス	無効なキー、不足しているキー、重複したキー編集不可能な（読み取り専用の）キーとリソース廃止予定のキーとリソース整数値と列挙型キーの値が無効です	無効なプロパティ、不足しているプロパティ、重複したプロパティ
ライブテンプレート	一般的なリソース種類の定義済みテンプレート	定義済みライブテンプレートなし
スマート補完	サポート	未サポート
カスタムリソース定義	サポート	未サポート
ラベル定義とセレクタ	ガターアイコンを使用したナビゲーション、使用箇所の検索、名前の変更	未サポート
オリジナルの Kubernetes モデルの強化	該当する場合はプレーン文字列の代わりに列挙型	なし

WebStorm は以下の必須フィールドを用いて Kubernetes リソース構成ファイルを認識します：

apiVersion: オブジェクト表現のバージョン管理されたスキーマを識別する
kind: リソースタイプを識別します (たとえば、 Service、 Pod、 Deployment などです。)

YAML ファイルまたは JSON ファイルに両方のフィールドが存在する場合、WebStorm は対応する Kubernetes アイコンでファイルをマークし、すべての利用可能な機能を有効にします。

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

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

プロジェクトツールウィンドウ（Alt+1 ）で、フォルダーを右クリックし、新規を選択するか、 Alt+Insert を押してから、 Kubernetes リソースを選択します。
名前フィールドにリソース名を入力し、リストからファイルテンプレートを選択します。
これにより、選択したファイルテンプレートに基づく内容で新しいファイルが作成されます。

また、YAML ファイルでは定義済みのライブテンプレートも利用できます。例えば：

kconfigmap: Kubernetes ConfigMap
kcronjob: Kubernetes CronJob
kdeployment: Kubernetes デプロイ
kingress: Kubernetes Ingress
kpod: Kubernetes Pod
kresource: Kubernetes リソースをゼロから構築
kservice: Kubernetes サービス

エディターで Kubernetes リソースファイルを開くと、WebStorm はインレイヒントと、主なアクションを含むツールバーを表示します。アクション例：

フローティングツールバーでは、以下のことが可能です。
- 現在のクラスターと名前空間を選択します
- 変更を適用し、現在のクラスターに配信します
- リソースを削除する
- クラスターバージョンとの変更点を比較する
- クラスターからコンテンツを再読み込みします
デプロイされたリソースのステータスを確認するためのインレイヒント
参照されているシークレットの値の表示とコピーができるインレイヒント
ポートを転送するためのインレイヒント

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

Ctrl+Alt+S を押して設定を開き、ビルド、実行、デプロイ | Kubernetes を選択します。
エディターにフローティングツールバーを表示するオプションを使用して、フローティングツールバーがいつ表示されるかを選択します。
- 常に表示
- マウスの動きに応じて表示
- 表示しない
または、フローティングツールバーを右クリックして必要なオプションを選択することもできます。

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

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

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

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

クラスターを管理する

サービスツールウィンドウを使用して、クラスターを表示し、名前空間を切り替え、クラスターリソースを変更します。

コンテキストの追加

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

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
サービスツールウィンドウで Kubernetes ノードを右クリックし、クラスターを追加を選択します。または、をクリックして Kubernetes｜クラスターを追加を選択します。
次に、追加する Kubernetes クラスターのソースを選択します：
- デフォルトディレクトリから: デフォルトの場所 (通常は $HOME/.kube/config) からクラスターを取得します。
- カスタム kubeconfigs から: コンピューターから任意の kubeconfig ファイルを選択します。
- kubeconfig の内容を貼り付け: 開いたテキストエリアに kubeconfig のコンテンツを貼り付けます。
開いたクラスターを追加ウィンドウで、追加するクラスターを選択し、クラスターを追加をクリックします。

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

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

クラスターに接続する

クラスターへ接続すると IDE でログの追跡、リソースのプレビュー、構成ファイルの閲覧、変更時のライブ更新などの操作ができます。クラスターへ接続しなくてもエディター内でリソースを変更できます。

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
サービスツールウィンドウにクラスターがない場合は、クラスターを追加します。
クラスターを右クリックし、クラスターの接続を選択します。

kubeconfig の編集

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

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
クラスターを選択し、ツールバーの (エディターで Kubeconfig ファイルを開く) をクリックします。このアクションは、サービスツールウィンドウで任意の Kubernetes オブジェクトを右クリックした場合にも使用できます。
これにより、エディターの新しいタブで kubeconfig ファイルが開きます。このアクションによって開かれるデフォルトのファイルを変更するには、 kubeconfig ファイルへのパスで別のファイルへのパスを指定できます。

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

名前空間を切り替える

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

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
クラスターまたは任意のリソースを右クリックし、名前空間を選択し (またはツールバーのをクリックし)、必要な名前空間を選択します。
すべての名前空間のリソースを表示するには、すべての名前空間を選択します。

現在のクラスターを選択

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

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

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
クラスターを右クリックし、クラスターを現在のクラスターとして設定を選択します。
または、クラスターを選択し、ツールバーのをクリックします。

この設定は、IDE 設定の言語 & フレームワーク | Kubernetes でも使用できます。

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

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

必要なリソースファイルをエディターで開きます。現在のクラスターが設定されていない場合は、フローティングツールバーを使用して選択してください。
必要に応じて、リストから名前空間を選択することもできます。
現在のクラスターと名前空間に変更を適用するには、をクリックします。

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

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
リソースを右クリックし、 YAML の表示を選択します。
選択したリソースのマニフェストがエディターの新しいタブで開きます。フィールドを変更すると、変更された行がガターでハイライト表示されます。ガターのハイライト領域をクリックすると、変更内容をすぐにプレビューしたり、ロールバックしたりできます。
フローティングツールバーで現在のクラスターが選択されていることを確認し、をクリックして変更を適用します。
Kubernetes オブジェクトの一部フィールドを変更すると、新しいオブジェクトが作成される場合があります。例: リソース名を変更した場合、この変更を適用すると新しいリソースが作成されます。また、名前空間を変更した場合、この変更を適用すると、指定された名前空間に新しいリソースが作成されます。

リソースの詳細を表示

WebStorm を使えばコマンドを手動で実行せずに Kubernetes リソースの詳細をすばやく確認できます。

サービスツールウィンドウで、リソースを選択して詳細を表示します。
WebStorm は、デプロイされた Kubernetes リソースのライブステータスをエディターに直接表示します。例: デプロイマニフェストを開くと、 replicas フィールドの横にステータスインジケーターが表示され、現在実行中、保留中、失敗している pods の数が表示されます。
個々の pods およびジョブのステータスは、それぞれのマニフェストの name フィールドの横で確認できます。
エラーが発生してリソースが失敗した場合、WebStorm はログを開くリンクを表示し、問題を説明する関連するログエントリへすばやく移動できます。

リソースの削除

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

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

ポートの転送

Kubernetes のポート転送を使うと、コンピューター上のローカルポートから Kubernetes Pod 上のポートへトラフィックをリダイレクトできます。 WebStorm ではポート転送を管理できます。複数のローカルポートをリモートポートに転送し、クラスター内のすべてのアクティブな転送セッション（WebStorm で確立したもの）を表示し、転送セッションの停止や再開が行えます。

次のいずれかの方法でポート転送を設定できます。
- サービスツールウィンドウを開き、表示 | ツールウィンドウ | サービスを選択するか Alt+8 を押します。ターゲット pod を右クリックし、ポートの転送を選択します。
- Kubernetes マニフェストのポートの転送インレイヒントをクリックします。宛先ポートが指定されている場合 (たとえば、 containerPort の値として)、WebStorm はインレイヒントを表示します。
ポートの転送ダイアログで:
- アドレスフィールドに、リッスンするアドレスをリストします。複数の値を入力する場合は、コンマで区切ってください。
- ポートフィールドでは、 <local port>:<remote port> 形式でポートを指定します。例: 8888:5000 はローカルポート 8888 をリッスンし、リモートポート 5000 との間でデータを転送します。
  WebStorm は対応する Kubernetes マニフェストで定義された値に基づいてポートマッピングを自動提案します。マニフェストで既にローカルマシンで使われているポートが指定された場合、WebStorm は利用可能なポートが見つかるまで提案値を徐々に増やします。
  指定された値が 1024 より小さい場合、推奨されるローカルポート値に 8000 が追加されます。
  現在ビジー状態のローカルポートを手動指定すると、転送開始前に WebStorm から通知されます。
進むをクリックしてください。

ポート転送セッションを管理する

すべてのアクティブなポート転送セッションを表示するには、サービスツールウィンドウで、Kubernetes クラスターのネットワーク | ポート転送を展開します。
各ポート転送セッションの横に、WebStorm はその現在の状態を示すバッジを表示します。
ポート転送セッションを終了するには、それを右クリックしてポート転送の停止を選択するか、ツールバーのをクリックします。
ポート転送セッションを再開するには、それを右クリックしてポート転送の再開を選択するか、ツールバーのをクリックします。

秘密を作成する

WebStorm を使えば Kubernetes のシークレットをすばやく作成できます。

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
クラスターを選択し、構成を展開します。
シークレットノードを右クリックし、新規シークレットの作成を選択します。または、シークレットノードを選択し、ツールバーのをクリックします。
開いた新規シークレットの作成ウィンドウで、シークレットの名前、タイプ、名前空間を指定します。シークレットの作成を高速化するため、WebStorm は選択したシークレットタイプに応じて必要なデータやアノテーションキーを追加します。
データおよびアノテーションセクションで、値をクリックして既存のキーの値を入力するか、をクリックして値を指定する方法を選択します。
- 手動で追加を使用して値を手動で入力します。
- ファイルデータの使用を使用してファイル (たとえば、SSH 鍵ファイルまたは Docker config.json ) を選択し、ファイルの内容を値として使用します。

すべてのシークレットは、サービスツールウィンドウの構成に表示できます。シークレットを編集するには、シークレットを右クリックしてシークレットを編集を選択するか、ツールバーのをクリックします。

Secret が作成されると、Pod 構成ファイルの secretName フィールドにその名前を入力できるようになります。これにより、クラスターまたはプロジェクトで使用可能な Secret 名の補完が呼び出されます。

シークレットを参照する YAML ファイル編集時、WebStorm は値の確認・再利用に役立つアクション付きのインレイヒントを提供します。

表示: 参照されたシークレットのデコードされた値をポップアップに表示します。
コピー: デコードされた秘密の値を一時的に使用するためにクリップボードにコピーします。

どちらのアクションも、YAML でエンコードされたテキストやプレースホルダーテキストではなく、シークレットで定義された実際の値にアクセスして表示します。

アカウントに十分な権限がない場合、ボタンをクリックすると対応するツールチップが表示されます。これにより、制限されたデータが誤って公開されることを防ぎます。

クラスター情報を最新の状態に保つ

WebStorm をクラスターと同期させるには次のアクションを使用します：

構成の再読み込みを実行して kubeconfig ファイルの最新変更を取得します。
リソースのリフレッシュを使用すると、Kubernetes リソースの最新の変更を取得できます。必要な権限があれば、通常は自動的に実行されます。

構成の再ロード

デフォルトでは、kubeconfig ファイルを変更すると、構成は自動的に再読み込みされます。手動で再読み込みすることもできます。

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
クラスターを右クリックし、詳細 | 構成の再ロードを選択します。

自動再ロードを無効にする場合は、構成を自動的に再ロードオプションをクリアします。

この設定は、ビルド、実行、デプロイ｜Kubernetes｜構成を自動的にリロードするの IDE 設定 (Ctrl+Alt+S) でも確認できます。

クラスターリソースを手動でリフレッシュする

クラスターに接続している場合、そのリソースに加えた変更は IDE に自動的に反映されます。リソースが自動的にリフレッシュされない場合 (クラスターロール(英語)の権限が不足しているため)、サービスツールウィンドウに自動リフレッシュが禁止されていることを示すメッセージが表示されます。この場合、リソースを手動でリフレッシュできます。

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
リソースグループを右クリックしてリフレッシュを選択するか、 Ctrl+F5 をクリックします。

ログの表示

WebStorm を使用するとクラスターのログおよび選択したリソースのログを表示できます。ログメッセージ内の日付、ソース、特定の値でフィルター処理できます。

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

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
次のいずれかの方法でログソースを選択します：
- すべてのリソースのログを表示するには、Kubernetes クラスターを選択し、サービスツールウィンドウのツールバーで (ログの追跡) をクリックします。
- 特定のリソースのログを表示するには、リソースを選択し、サービスツールウィンドウのツールバーで (ログの追跡) をクリックします。または、リソースを右クリックしてログの追跡を選択します。
  pod に複数のコンテナーが存在する場合は、表示されたコンテナーのリストからログを追跡したいコンテナーを選択します。

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

ログを管理する

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

(末尾までスクロール): ログ出力の末尾に移動します。
(行の折り返し): エディターのサイズが変更されたときに、ログエントリのソフトラッピングを有効にします。
(フィルターされたログのダウンロード): 適用されているフィルターを考慮して、エディターで現在開いているログをダウンロードします。
(表示されたログをクリアする): エディターに表示されているログエントリをクリアします。このアクションは現在のビューにのみ影響します。同じリソースのログを再度開くと、エントリが再表示されます。

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

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

(オープンパターンマッチング): ログデータと一致させる値またはパターンを入力または選択します。例: ログにレベル情報が存在する場合は、 warn、 error 、またはその他のレベル値を選択して、これらのレベルに対応するログのみを表示できます。
(ログソースを選択): ログを表示するクラスターリソースを選択します。
(日付と時刻でフィルタリング): ログを表示する時間範囲を選択します。
(ログフィールドを選択): ログのタイムスタンプ、ソース、メッセージを表示するかどうかを選択します。
ビルド、実行、デプロイ｜Kubernetes｜ログ｜デフォルトでログに表示されるフィールドの IDE 設定 (Ctrl+Alt+S) で、ログフィールドの可視性をグローバルに構成できます。
エディタータブの上部にある入力フィールドに、ログメッセージの値を入力します。正規表現を使用するにはをクリックし、大文字と小文字を区別して検索するにはをクリックします。

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

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

サービスツールウィンドウを開くには、表示 | ツールウィンドウ | サービスに移動するか、 Alt+8 を押します。
リソースを選択し、右側のツールバーの (ログのダウンロード) をクリックして、ログファイルを保存します。

ログ保存オプションを設定する

ログ保存オプションは、ビルド、実行、デプロイ｜Kubernetes｜ログの IDE 設定 (Ctrl+Alt+S) で設定できます。

スクラッチ以外の場所にログを保存する場合は、ログのダウンロード先のパスにディレクトリを指定します。または、ダウンロードする前にログの保存場所を確認するを選択すると、ログを保存するたびに場所の入力を求められます。
ファイル名にログのタイムスタンプを含める場合は、ログファイル名にタイムスタンプを追加するを選択します。

カスタムリソース定義のサポート

カスタムリソースで Kubernetes クラスターを拡張した場合、WebStorm はカスタムリソース定義（CRD）仕様を使って検証できます。

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

Ctrl+Alt+S を押して設定を開き、言語 & フレームワーク | Kubernetes を選択します。
をクリックしてローカルの CRD ファイルを選択するか URL を指定します。次に OK をクリックします。

CRD ファイルのリストを並べ替えるにはとを使用します。これは定義内容が競合した場合の優先度を決めます。複数ファイルで定義が重複する場合、WebStorm は最も優先度が低いものを使います。

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

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

サービスツールウィンドウの Kubernetes ノードに、現在のクラスターの CRD（適用されているすべてのリソースを含む）を表示できます。

Kubernetes プラグインは以下のタイプの CRD ファイルをサポートしています：

YAML の CustomResourceDefinition ファイル

次の例は、 CronTab の種類のカスタムリソース stable.example.com/v1 用の単純な CustomResourceDefinition 仕様を示しています。リソースを識別するための必須フィールドは metadata.name、 spec.group、 spec.versions、 spec.names です。

                apiVersion: apiextensions.k8s.io/v1beta1
                kind: CustomResourceDefinition
                metadata:
                  name: crontabs.stable.example.com # Obligatory field to identify the resource
                spec:
                  group: stable.example.com # Obligatory field to identify the resource
                  versions: # Obligatory field to identify the resource
                    - name: v1
                      served: true
                      storage: true
                  scope: Namespaced
                  names: # Obligatory field to identify the resource
                    plural: crontabs
                    singular: crontab
                    kind: CronTab
                    shortNames:
                      - ct
                validation:
                  openAPIV3Schema: # Schema for validating custom objects
                    properties:
                      spec:
                        properties:
                          cronSpec:
                            type: string
                            pattern: '^(\d+|\*)(/\d+)?(\s+(\d+|\*)(/\d+)?){4}$' # not supported for validation
                          replicas:
                            type: integer
                            minimum: 1 # not supported for validation
                            maximum: 10 # not supported for validation
            
   

JSON での OpenAPI v2.0 スキーマ

次の例は、 Config の種類のカスタムリソース sample/v1 の CRD 仕様を持つ単純な OpenAPI v2.0 スキーマを示しています。カスタムリソースのルート定義には、指定されたグループ、バージョン、種類を持つ x-kubernetes-group-version-kind フィールドを含める必要があります。この例では、 root.Definition オブジェクトは build プロパティを使用して some.Definition オブジェクトを参照しています。

                {
                    "swagger": "2.0",
                    "info": {
                        "title": "Sample Schema",
                        "version": "sample/v1"
                    },
                    "paths": {},
                    "definitions": {
                        "some.Definition": {
                            "description": "Example of a definition.",
                            "properties": {
                                "someProperty": {
                                    "type": "string"
                                }
                            }
                        },
                        "root.Definition": {
                            "description": "This is the root definition for the resource",
                            "properties": {
                                "build": {
                                    "$ref": "#/definitions/some.Definition"
                                }
                            },
                            "x-kubernetes-group-version-kind": [
                                {
                                    "group": "sample",
                                    "kind": "Config",
                                    "version": "v1"
                                }
                            ]
                        }
                    }
                }
            
   

CRD 検証の制限

WebStorm は次の OpenAPI v3 スキーマ機能をサポートしていません：

multipleOf
maximum
exclusiveMaximum
minimum
exclusiveMinimum
maxLength
minLength
pattern
maxItems
minItems
uniqueItems
maxProperties
minProperties
allOf
oneOf
anyOf
not
format
default
nullable
readOnly
writeOnly
xml
externalDocs
example
deprecated

生産性のヒント

ここに記載されている機能を頻繁に利用する場合、次のヒントが役立ちます：

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

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

設定ダイアログ（Ctrl+Alt+S ）で、キーマップを選択します。
検索フィールドに kubernetes と入力してから、アクションをダブルクリックしてショートカットを設定します。

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

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

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

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

設定ダイアログ（Ctrl+Alt+S ）で、エディター | 一般 | コードの折りたたみを選択します。
コードの折りたたみページで、必要なチェックボックスをオフにします。
- Kubernetes: Helm テンプレート内の値参照
- Kubernetes: YAML ファイル内の EnvVar 定義
- Kubernetes: YAML ファイル内の ExecAction 定義

2026 年 6 月 8 日