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

backend

object

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

contentSecurityPolicy

array

contentSecurityPolicy は、プラグインの Content-Security-Policy (CSP) ディレクティブのリストです。各ディレクティブは、指定されたディレクティブタイプに適した値のリストを指定します。たとえば、ScriptSrc などの fetch ディレクティブのリモートエンドポイントのリストなどです。コンソール Web アプリケーションは、CSP を使用して、クロスサイトスクリプティング (XSS) やデータインジェクション攻撃などの特定の種類の攻撃を検出し、緩和します。動的プラグインでは、クラスター外部からアセットをロードする必要がある場合、または違反レポートが観察された場合に、このフィールドを指定する必要があります。動的プラグインでは、常にクラスター内からのアセット取得を優先する必要があります。その場合、アセットのベンダー化とクラスターサービスからの取得のいずれかの方法を使用します。CSP 違反レポートは、OpenShift Web コンソールでのプラグイン開発およびテスト時に、ブラウザーのコンソールログで表示できます。使用可能なディレクティブタイプは、DefaultSrc、ScriptSrc、StyleSrc、ImgSrc、FontSrc、ConnectSrc です。使用可能な各ディレクティブは、リスト内で 1 回だけ定義できます。'self' の値は、OpenShift Web コンソールのバックエンドによってすべての fetch ディレクティブに自動的に追加されます。CSP ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy を参照してください。

OpenShift Web コンソールサーバーは、独自のデフォルト値とすべての有効な ConsolePlugin CR で CSP ディレクティブと値を集約し、それらを 1 つのポリシー文字列にマージして、Content-Security-Policy HTTP 応答ヘッダーを介してブラウザーに送信します。

例: ConsolePlugin A ディレクティブ: script-src: https://script1.com/, https://script2.com/ font-src: https://font1.com/

ConsolePlugin B ディレクティブ: script-src: https://script2.com/, https://script3.com/ font-src: https://font2.com/ img-src: https://img1.com/

OpenShift Web コンソールサーバーに渡される CSP ディレクティブの統合セット: script-src: https://script1.com/, https://script2.com/, https://script3.com/ font-src: https://font1.com/, https://font2.com/ img-src: https://img1.com/

OpenShift Web コンソールサーバー CSP 応答ヘッダー: Content-Security-Policy: default-src 'self'; base-uri 'self'; script-src 'self' https://script1.com/ https://script2.com/ https://script3.com/; font-src 'self' https://font1.com/ https://font2.com/; img-src 'self' https://img1.com/; style-src 'self'; frame-src 'none'; object-src 'none'

contentSecurityPolicy[]

object

ConsolePluginCSP は特定の CSP ディレクティブの設定を保持します

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

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

directive

string

directive は、どの Content-Security-Policy ディレクティブを設定するか指定します。使用可能なディレクティブタイプは、DefaultSrc、ScriptSrc、StyleSrc、ImgSrc、FontSrc、ConnectSrc です。DefaultSrc ディレクティブは、他の CSP fetch ディレクティブのフォールバックとして機能します。DefaultSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src を参照してください。ScriptSrc ディレクティブは、JavaScript の有効なソースを指定します。ScriptSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src を参照してください。StyleSrc ディレクティブは、スタイルシートの有効なソースを指定します。StyleSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src を参照してください。ImgSrc ディレクティブは、イメージとファビコンの有効なソースを指定します。ImgSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/img-src を参照してください。FontSrc ディレクティブは、@font-face を使用して読み込まれたフォントの有効なソースを指定します。FontSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/font-src を参照してください。ConnectSrc ディレクティブは、スクリプトインターフェイスを使用して読み込むことができる URL を制限します。ConnectSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src を参照してください。

values

array (string)

values は、このディレクティブのコンソールのデフォルトに追加する値の配列を定義します。各 ConsolePlugin は、独自のディレクティブと値を定義できます。これらは、OpenShift Web コンソールのバックエンドによって、Content-Security-Policy ヘッダーの一部として設定されます。配列には最大 16 個の値を含めることができます。各ディレクティブ値の最大長は 1024 文字で、空白、コンマ (,)、セミコロン (;)、一重引用符 (') を含めることはできません。値 '*' は使用できません。配列内の各値は一意である必要があります。

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 がリッスンしているポートです。