第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
- 説明
- ConsolePluginSpec は、必要なプラグイン設定です。
- タイプ
-
object - 必須
-
backend -
displayName
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| backend は、コンソールのプラグインを提供するバックエンドの設定を保持します。 |
|
|
| displayName は、プラグインの表示名です。dispalyName は 1 - 128 文字の間で指定する必要があります。 |
|
|
| i18n は、プラグインのローカリゼーションリソースの設定です。 |
|
|
| proxy は、プラグインが接続する必要のあるさまざまなサービスタイプを記述するプロキシーのリストです。 |
|
|
| ConsolePluginProxy は、コンソールのバックエンドがプラグインのリクエストをプロキシーするさまざまなサービスタイプに関する情報を保持します。 |
6.1.2. .spec.backend
- 説明
- backend は、コンソールのプラグインを提供するバックエンドの設定を保持します。
- タイプ
-
object - 必須
-
type
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| service は、HTTP サーバーを使用したデプロイを使用してプラグインを公開する Kubernetes サービスです。Service は HTTPS と Service 提供証明書を使用する必要があります。コンソールバックエンドは、サービス CA バンドルを使用してサービスからプラグインアセットをプロキシーします。 |
|
|
| type は、コンソールのプラグインを提供するバックエンドタイプです。現在、"Service" のみがサポートされています。-- |
6.1.3. .spec.backend.service
- 説明
- service は、HTTP サーバーを使用したデプロイを使用してプラグインを公開する Kubernetes サービスです。Service は HTTPS と Service 提供証明書を使用する必要があります。コンソールバックエンドは、サービス CA バンドルを使用してサービスからプラグインアセットをプロキシーします。
- タイプ
-
object - 必須
-
name -
namespace -
port
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
|
basePath は、プラグインのアセットへのパスです。主な資産は、 |
|
|
| プラグインアセットを提供している Service の名前です。 |
|
|
| プラグインアセットを提供している Service の namespace です。 |
|
|
| プラグインを提供しているサービスがリッスンしているポート。 |
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 は、プラグインのプロキシーを識別するプロキシー名です。alias 名は、プラグインごとに一意である必要があります。コンソールバックエンドは、プロキシーエンドポイント /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> リクエストサンプルパス /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver を公開します。 |
|
|
| authorization は、プロキシーされたリクエストに含まれる必要がある authorization タイプに関する情報を提供します。 |
|
|
| caCertificate は、プロキシーされた Service がカスタムサービス CA を使用している場合に備えて、証明書機関の証明書の内容を提供します。デフォルトでは、service-ca Operator によって提供されるサービス CA バンドルが使用されます。 |
|
|
| エンドポイントは、リクエストがプロキシーされるエンドポイントに関する情報を提供します。 |
6.1.7. .spec.proxy[].endpoint
- 説明
- エンドポイントは、リクエストがプロキシーされるエンドポイントに関する情報を提供します。
- タイプ
-
object - 必須
-
type
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| サービスは、プラグインが接続するクラスター内の Service です。この Service は HTTPS を使用する必要があります。コンソールバックエンドは、プラグインと Service 間の通信をプロキシーするためにエンドポイントを公開します。注記: 現在 "Service" タイプのみがサポートされているため、サービスフィールドは必須です。 |
|
|
| type は、コンソールプラグインのプロキシーのタイプです。現在、"Service" のみがサポートされています。-- |
6.1.8. .spec.proxy[].endpoint.service
- 説明
- サービスは、プラグインが接続するクラスター内の Service です。この Service は HTTPS を使用する必要があります。コンソールバックエンドは、プラグインと Service 間の通信をプロキシーするためにエンドポイントを公開します。注記: 現在 "Service" タイプのみがサポートされているため、サービスフィールドは必須です。
- タイプ
-
object - 必須
-
name -
namespace -
port
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| プラグインが接続する必要のある Service の名前です。 |
|
|
| プラグインが接続する必要のある Service の namespace です。 |
|
|
| プラグインが接続する必要のある Service がリッスンしているポートです。 |
