第6章 ConsolePlugin [console.openshift.io/v1]
- 説明
- ConsolePlugin は、クラスターで実行されている別のサービスからコードを動的にロードすることにより、OpenShift Web コンソールをカスタマイズするための拡張機能です。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
metadata -
spec
-
6.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 を参照してください。 | |
|
|
| ConsolePluginSpec は、必要なプラグイン設定です。 |
6.1.1. .spec
- Description
- ConsolePluginSpec は、必要なプラグイン設定です。
- タイプ
-
object - 必須
-
バックエンド -
displayName
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| バックエンドは、提供コンソールのプラグインであるバックエンドの設定を保持します。 |
|
|
| displayName は、プラグインの表示名です。dispalyName は 1 〜 128 文字の間で指定する必要があります。 |
|
|
| i18n は、プラグインのローカリゼーションリソースの設定です。 |
|
|
| proxy は、プラグインが接続する必要のあるさまざまなサービスタイプを記述するプロキシーのリストです。 |
|
|
| ConsolePluginProxy コンソールのバックエンドがプラグインのリクエストをプロキシーするさまざまなサービスタイプの情報を保持します。 |
6.1.2. .spec.backend
- 説明
- バックエンドは、提供コンソールのプラグインであるバックエンドの設定を保持します。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| service は、HTTP サーバーを使用したデプロイを使用してプラグインを公開する Kubernetes サービスです。サービスは HTTPS とサービス提供証明書を使用する必要があります。コンソールバックエンドは、サービス CA バンドルを使用してサービスからプラグインアセットをプロキシーします。 |
|
|
| type は、コンソールのプラグインをサーバーするバックエンドタイプです。現在、Service のみがサポートされています。-- |
6.1.3. .spec.backend.service
- 説明
- service は、HTTP サーバーを使用したデプロイを使用してプラグインを公開する Kubernetes サービスです。サービスは HTTPS とサービス提供証明書を使用する必要があります。コンソールバックエンドは、サービス CA バンドルを使用してサービスからプラグインアセットをプロキシーします。
- タイプ
-
object - 必須
-
name -
namespace -
port
-
| プロパティー | 型 | Description |
|---|---|---|
|
|
|
basePath は、プラグインのアセットへのパスです。主な資産は、 |
|
|
| プラグインを提供しているサービスの名前。 |
|
|
| プラグインを提供しているサービスの名前空間。 |
|
|
| プラグインを提供しているサービスがリッスンしているポート。 |
6.1.4. .spec.i18n
- 説明
- i18n は、プラグインのローカリゼーションリソースの設定です。
- 型
-
object - 必須
-
loadType
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| loadType は、プラグインのローカリゼーションリソースをロードする方法を示します。有効な値は、Preload、Lazy、および空の文字列です。Preload に設定すると、プラグインがロードされたときにすべてのローカリゼーションリソースがフェッチされます。Lazy に設定すると、ローカリゼーションリソースは、コンソールで要求されるときに遅延してロードされます。省略されるか空の文字列が設定されている場合、動作は Lazy 型と同等です。 |
6.1.5. .spec.proxy
- 説明
- proxy は、プラグインが接続する必要のあるさまざまなサービスタイプを記述するプロキシーのリストです。
- 型
-
array
6.1.6. .spec.proxy[]
- 説明
- ConsolePluginProxy コンソールのバックエンドがプラグインのリクエストをプロキシーするさまざまなサービスタイプの情報を保持します。
- 型
-
object - 必須
-
alias -
endpoint
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| alias は、プラグインのプロキシーを識別するプロキシー名です。エイリアス名は、プラグインごとに一意である必要があります。コンソールバックエンドは、以下のプロキシーエンドポイントを公開します：/api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> Request path: /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver |
|
|
| 承認は、プロキシーされたリクエストに含まれる必要がある承認タイプに関する情報を提供します。 |
|
|
| caCertificate は、プロキシーされたサービスがカスタムサービス CA を使用している場合に備えて、証明書機関の証明書の内容を提供します。デフォルトでは、service-ca Operator によって提供されるサービス CA バンドルが使用されます。 |
|
|
| Endpoint は、リクエストがプロキシーされるエンドポイントに関する情報を提供します。 |
6.1.7. .spec.proxy[].endpoint
- 説明
- Endpoint は、リクエストがプロキシーされるエンドポイントに関する情報を提供します。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| サービスは、プラグインが接続するクラスター内のサービスです。このサービスは HTTPS を使用する必要があります。コンソールバックエンドは、プラグインとサービス間の通信をプロキシーするためにエンドポイントを公開します。注記：現在サービスタイプのみがサポートされているため、サービスフィールドは必須です。 |
|
|
| type は、コンソールプラグインのプロキシーのタイプです。現在、Service のみがサポートされています。-- |
6.1.8. .spec.proxy[].endpoint.service
- 説明
- サービスは、プラグインが接続するクラスター内のサービスです。このサービスは HTTPS を使用する必要があります。コンソールバックエンドは、プラグインとサービス間の通信をプロキシーするためにエンドポイントを公開します。注記：現在サービスタイプのみがサポートされているため、サービスフィールドは必須です。
- 型
-
object - 必須
-
name -
namespace -
port
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| プラグインが接続する必要のあるサービスの名前。 |
|
|
| プラグインが接続する必要のあるサービスの namespace |
|
|
| プラグインが接続する必要のあるサービスがリッスンしているポート。 |
