第8章 ConsoleYAMLSample [console.openshift.io/v1]
- 説明
- ConsoleYAMLSample は、OpenShift Web コンソールの YAML サンプルをカスタマイズするための拡張機能です。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- タイプ
-
object - 必須
-
metadata -
spec
-
8.1. 仕様
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| ConsoleYAMLSampleSpec は、必要な YAML サンプル設定です。Web コンソールでリソースを作成すると、サンプルがサンプルサイドバーに説明とともに表示されます。 |
8.1.1. .spec
- 説明
- ConsoleYAMLSampleSpec は、必要な YAML サンプル設定です。Web コンソールでリソースを作成すると、サンプルがサンプルサイドバーに説明とともに表示されます。
- タイプ
-
object - 必須
-
description -
targetResource -
title -
yaml
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| YAML サンプルの説明。 |
|
|
| スニペットは、YAML サンプルが完全な YAML リソース定義ではなく、ユーザーのカーソルで既存の YAML ドキュメントに挿入できるフラグメントであることを示しています。 |
|
|
| targetResource には apiVersion と、YAML サンプルが表すリソースの種類が含まれています。 |
|
|
| YAML サンプルのタイトル。 |
|
|
| yaml は表示する YAML サンプルです。 |
8.1.2. .spec.targetResource
- 説明
- targetResource には apiVersion と、YAML サンプルが表すリソースの種類が含まれています。
- タイプ
-
object
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
