第6章 ConsolePlugin [console.openshift.io/v1]

backend

object

backend は、コンソールのプラグインを提供するバックエンドの設定を保持します。

displayName

string

displayName は、プラグインの表示名です。dispalyName は 1 - 128 文字の間で指定する必要があります。

i18n

object

i18n は、プラグインのローカリゼーションリソースの設定です。

proxy

array

proxy は、プラグインが接続する必要のあるさまざまなサービスタイプを記述するプロキシーのリストです。

proxy[]

object

ConsolePluginProxy は、コンソールのバックエンドがプラグインのリクエストをプロキシーするさまざまなサービスタイプに関する情報を保持します。

service

object

service は、HTTP サーバーを使用したデプロイを使用してプラグインを公開する Kubernetes サービスです。Service は HTTPS と Service 提供証明書を使用する必要があります。コンソールバックエンドは、サービス CA バンドルを使用してサービスからプラグインアセットをプロキシーします。

type

string

type は、コンソールのプラグインを提供するバックエンドタイプです。現在、"Service" のみがサポートされています。--

basePath

string

basePath は、プラグインのアセットへのパスです。主な資産は、plugin-manifest.json と呼ばれるマニフェストファイルです。これは、プラグインと拡張機能に関するメタデータを含む JSON ドキュメントです。

name

string

プラグインアセットを提供している Service の名前です。

namespace

string

プラグインアセットを提供している Service の namespace です。

port

integer

プラグインを提供しているサービスがリッスンしているポート。

loadType

string

loadType は、プラグインのローカリゼーションリソースをロードする方法を示します。有効な値は、Preload、Lazy、および空の文字列です。Preload に設定すると、プラグインがロードされたときにすべてのローカリゼーションリソースが取得されます。Lazy に設定すると、ローカリゼーションリソースは、コンソールで要求されるときに遅延ロードされます。省略されるか空の文字列が設定されている場合、動作は Lazy タイプと同じになります。

alias

string

alias は、プラグインのプロキシーを識別するプロキシー名です。alias 名は、プラグインごとに一意である必要があります。コンソールバックエンドは、プロキシーエンドポイント /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> リクエストサンプルパス /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver を公開します。

authorization

string

authorization は、プロキシーされたリクエストに含まれる必要がある authorization タイプに関する情報を提供します。

caCertificate

string

caCertificate は、プロキシーされた Service がカスタムサービス CA を使用している場合に備えて、証明書機関の証明書の内容を提供します。デフォルトでは、service-ca Operator によって提供されるサービス CA バンドルが使用されます。

endpoint

object

エンドポイントは、リクエストがプロキシーされるエンドポイントに関する情報を提供します。

service

object

サービスは、プラグインが接続するクラスター内の Service です。この Service は HTTPS を使用する必要があります。コンソールバックエンドは、プラグインと Service 間の通信をプロキシーするためにエンドポイントを公開します。注記: 現在 "Service" タイプのみがサポートされているため、サービスフィールドは必須です。

type

string

type は、コンソールプラグインのプロキシーのタイプです。現在、"Service" のみがサポートされています。--

name

string

プラグインが接続する必要のある Service の名前です。

namespace

string

プラグインが接続する必要のある Service の namespace です。

port

integer

プラグインが接続する必要のある Service がリッスンしているポートです。