7.5. 動的プラグイン参照

プラグインのカスタマイズを可能にするエクステンションを追加できます。これらのエクステンションは、ランタイム時にコンソールにロードされます。

7.5.1. 動的プラグインエクステンションのタイプ

7.5.1.1. console.action/filter

7.5.1.1.1. summary

ActionFilter を使用してアクションを絞り込むことができます。

7.5.1.1.2. Properties
名前値のタイプ任意説明

contextId

string

いいえ

コンテキスト ID は、提供したアクションのスコープをアプリケーションの特定のエリアに限定するのに役立ちますたとえば、トポロジー および helm などがあります。

filter

CodeRef<(スコープ: any、action: Action) ⇒ boolean>

いいえ

一部の条件に基づいてアクションをフィルターする関数。scope: アクションを指定するスコープ。Horizontal Pod Autoscaler (HPA) のデプロイメントから ModifyCount アクションを削除する必要がある場合には、フックが必要になることがあります。

7.5.1.2. console.action/group

7.5.1.2.1. summary

ActionGroup は、サブメニューに指定可能なアクショングループを提供します。

7.5.1.2.2. Properties
名前値のタイプ任意説明

id

string

いいえ

アクションの選択を識別するための ID。

label

string

はい

UI に表示されるラベル。サブメニューに必要です。

submenu

boolean

はい

このグループをサブメニューとして表示するかどうか。

insertBefore

string | string[]

はい

ここで参照される項目の前に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。

insertAfter

string | string[]

はい

ここで参照される項目の後に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。insertBefore 値が優先されます。

7.5.1.3. console.action/provider

7.5.1.3.1. summary

ActionProvider は、特定のコンテキストに対するアクションのリストを返すフックを提供します。

7.5.1.3.2. Properties
名前値のタイプ任意説明

contextId

string

いいえ

コンテキスト ID は、提供したアクションのスコープをアプリケーションの特定のエリアに限定するのに役立ちますたとえば、トポロジー および helm などがあります。

provider

CodeRef<ExtensionHook<Action[], any>>

いいえ

指定のスコープのアクションを返す React フック。contextId = resource の場合には、スコープは常に Kubernetes リソースオブジェクトになります。

7.5.1.4. console.action/resource-provider

7.5.1.4.1. summary

ResourceActionProvider は、特定のリソースモデルに対するアクションのリストを返すフックを提供します。

7.5.1.4.2. Properties
名前値のタイプ任意説明

model

ExtensionK8sKindVersionModel

いいえ

このプロバイダーがアクションを提供するモデル。

provider

CodeRef<ExtensionHook<Action[], any>>

いいえ

指定のリソースモデルに対するアクションを返す反応フック

7.5.1.5. console.alert-action

7.5.1.5.1. 概要

(利用できません)

7.5.1.5.2. プロパティー
名前値のタイプ任意説明

alert

string

いいえ

 

text

string

いいえ

 

action

CodeRef<(alert: any) ⇒ void>

いいえ

 

7.5.1.6. console.catalog/item-filter

7.5.1.6.1. 概要

(利用できません)

7.5.1.6.2. プロパティー
名前値のタイプ任意説明

catalogId

string | string[]

いいえ

このプロバイダーが提供するカタログの一意の識別子。

type

string

いいえ

カタログ項目タイプのタイプ ID。

filter

CodeRef<(item: CatalogItem) ⇒ boolean>

いいえ

特定のタイプの項目をフィルタリングします。Value は、CatalogItem[] を受け取り、フィルター条件に基づいてサブセットを返す関数です。

7.5.1.7. console.catalog/item-metadata

7.5.1.7.1. 概要

(利用できません)

7.5.1.7.2. プロパティー
名前値のタイプ任意説明

catalogId

string | string[]

いいえ

このプロバイダーが提供するカタログの一意の識別子。

type

string

いいえ

カタログ項目タイプのタイプ ID。

provider

CodeRef<ExtensionHook<CatalogItemMetadataProviderFunction, CatalogExtensionHookOptions>>

いいえ

特定のタイプのカタログアイテムにメタデータを提供するために使用される関数を返すフック。

7.5.1.8. console.catalog/item-provider

7.5.1.8.1. 概要

(利用できません)

7.5.1.8.2. プロパティー
名前値のタイプ任意説明

catalogId

string | string[]

いいえ

このプロバイダーが提供するカタログの一意の識別子。

type

string

いいえ

カタログ項目タイプのタイプ ID。

title

string

いいえ

カタログ項目プロバイダーのタイトル

provider

CodeRef<ExtensionHook<CatalogItem<any>[], CatalogExtensionHookOptions>>

いいえ

項目を取得し、これをカタログ用に正規化します。値は反応効果フックです。

priority

number

はい

このプロバイダーの優先順位。デフォルトは 0 です。優先度の高いプロバイダーは、他のプロバイダーが提供するカタログ項目を上書きする可能性があります。

7.5.1.9. console.catalog/item-type

7.5.1.9.1. 概要

(利用できません)

7.5.1.9.2. プロパティー
名前値のタイプ任意説明

type

string

いいえ

カタログ項目をタイプ。

title

string

いいえ

カタログ項目のタイトル。

catalogDescription

string | CodeRef<React.ReactNode>

はい

カタログに固有のタイプの説明。

typeDescription

string

はい

カタログ項目タイプの説明。

filters

CatalogItemAttribute[]

はい

カタログ項目に固有のカスタムフィルター。

groupings

CatalogItemAttribute[]

はい

カタログ項目に固有のカスタムグルーピング。

7.5.1.10. console.catalog/item-type-metadata

7.5.1.10.1. 概要

(利用できません)

7.5.1.10.2. プロパティー
名前値のタイプ任意説明

type

string

いいえ

カタログ項目をタイプ。

filters

CatalogItemAttribute[]

はい

カタログ項目に固有のカスタムフィルター。

groupings

CatalogItemAttribute[]

はい

カタログ項目に固有のカスタムグルーピング。

7.5.1.11. console.cluster-overview/inventory-item

7.5.1.11.1. 概要

新しいインベントリー項目をクラスターの概要ページに追加します。

7.5.1.11.2. プロパティー
名前値のタイプ任意説明

component

CodeRef<React.ComponentType<{}>>

いいえ

レンダリングされるコンポーネント。

7.5.1.12. console.cluster-overview/multiline-utilization-item

7.5.1.12.1. summary

新しいクラスター概要のマルチライン使用状況項目を追加します。

7.5.1.12.2. Properties
名前値のタイプ任意説明

title

string

いいえ

使用状況項目のタイトル。

getUtilizationQueries

CodeRef<GetMultilineQueries>

いいえ

Prometheus 使用状況クエリー。

humanize

CodeRef<Humanize>

いいえ

Prometheus データを人間が判読できる形式に変換します。

TopConsumerPopovers

CodeRef<React.ComponentType<TopConsumerPopoverProps>[]>

はい

プレーン値の代わりに Top コンシューマーのポップオーバーを表示します。

7.5.1.13. console.cluster-overview/utilization-item

7.5.1.13.1. 概要

新しいクラスター概要の使用状況項目を追加します。

7.5.1.13.2. プロパティー
名前値のタイプ任意説明

title

string

いいえ

使用状況項目のタイトル。

getUtilizationQuery

CodeRef<GetQuery>

いいえ

Prometheus 使用状況クエリー。

humanize

CodeRef<Humanize>

いいえ

Prometheus データを人間が判読できる形式に変換します。

getTotalQuery

CodeRef<GetQuery>

はい

Prometheus 合計のクエリー。

getRequestQuery

CodeRef<GetQuery>

はい

Prometheus 要求のクエリー。

getLimitQuery

CodeRef<GetQuery>

はい

Prometheus 制限のクエリー。

TopConsumerPopover

CodeRef<React.ComponentType<TopConsumerPopoverProps>>

はい

プレーン値の代わりに Top コンシューマーのポップオーバーを表示します。

7.5.1.14. console.context-provider

7.5.1.14.1. summary

新しい React コンテキストプロバイダーを Web コンソールのアプリケーションルートに追加します。

7.5.1.14.2. Properties
名前値のタイプ任意説明

provider

CodeRef<Provider<T>>

いいえ

Context プロバイダーコンポーネント。

useValueHook

CodeRef<() ⇒ T>

いいえ

コンテキスト値のフック。

7.5.1.15. console.dashboards/card

7.5.1.15.1. 概要

新しいダッシュボードカードを追加します。

7.5.1.15.2. プロパティー
名前値のタイプ任意説明

tab

string

いいえ

カードを追加するダッシュボードタブの ID。

position

'LEFT' | 'RIGHT' | 'MAIN'

いいえ

ダッシュボードのカードのグリッド位置。

component

CodeRef<React.ComponentType<{}>>

いいえ

ダッシュボードカードのコンポーネント。

span

OverviewCardSpan

はい

列内のカードの垂直スパン。小さな画面では無視され、デフォルトは 12 です。

7.5.1.16. console.dashboards/overview/activity/resource

7.5.1.16.1. summary

Kubernetes リソースの監視に基づいてアクティビティーをトリガーしている Overview ダッシュボードの Activity カードにアクティビティーを追加します。

7.5.1.16.2. Properties
名前値のタイプ任意説明

k8sResource

CodeRef<FirehoseResource & { isList: true; }>

いいえ

置き換える使用状況項目。

component

CodeRef<React.ComponentType<K8sActivityProps<T>>>

いいえ

アクションコンポーネント。

isActivity

CodeRef<(resource: T) ⇒ boolean>

はい

指定のリソースがアクションを表すかどうかを判断する関数。定義されていない場合は、すべてのリソースがアクティビティーを表します。

getTimestamp

CodeRef<(resource: T) ⇒ Date>

はい

指定のアクションのタイムスタンプで、順序付けに使用されます。

7.5.1.17. console.dashboards/overview/detail/item

7.5.1.17.1. summary

Overview ダッシュボードの Details カードに項目を追加します。

7.5.1.17.2. Properties
名前値のタイプ任意説明

component

CodeRef<React.ComponentType<{}>>

いいえ

DetailItem コンポーネントに基づく値

7.5.1.18. console.dashboards/overview/health/operator

7.5.1.18.1. summary

ステータスのソースが Kubernetes REST API である Overview ダッシュボードのステータスカードに health サブシステムを追加します。

7.5.1.18.2. Properties
名前値のタイプ任意説明

title

string

いいえ

ポップアップメニューの Operators セクションのタイトル。

resources

CodeRef<FirehoseResource[]>

いいえ

フェッチされ、healthHandler に渡される Kubernetes リソース。

getOperatorsWithStatuses

CodeRef<GetOperatorsWithStatuses<T>>

はい

Operator のステータスを解決します。

operatorRowLoader

CodeRef<React.ComponentType<OperatorRowProps<T>>>

はい

ポップアップ行コンポーネントのローダー。

viewAllLink

string

はい

すべてのリソースページへのリンク。指定しない場合は、resources prop から最初のリソースのリストページが使用されます。

7.5.1.19. console.dashboards/overview/health/prometheus

7.5.1.19.1. 概要

ステータスのソースが Prometheus である Overview ダッシュボードのステータスカードに health サブシステムを追加します。

7.5.1.19.2. プロパティー
名前値のタイプ任意説明

title

string

いいえ

サブシステムの表示名。

クエリー

string[]

いいえ

Prometheus クエリー

healthHandler

CodeRef<PrometheusHealthHandler>

いいえ

サブシステムの健全性を解決します。

additionalResource

CodeRef<FirehoseResource>

はい

フェッチされ、healthHandler に渡される追加のリソース。

popupComponent

CodeRef<React.ComponentType<PrometheusHealthPopupProps>>

はい

ポップアップメニューコンテンツのローダー。定義された場合、health 項目はリンクとして表され、指定のコンテンツを含むポップアップメニューが開きます。

popupTitle

string

はい

ポップオーバーのタイトル。

disallowedControlPlaneTopology

string[]

はい

サブシステムを非表示にする必要のあるコントロールプレーントポロジー。

7.5.1.20. console.dashboards/overview/health/resource

7.5.1.20.1. summary

ステータスのソースが Kubernetes リソースである概要ダッシュボードのステータスカードに health サブシステムを追加します。

7.5.1.20.2. Properties
名前値のタイプ任意説明

title

string

いいえ

サブシステムの表示名。

resources

CodeRef<WatchK8sResources<T>>

いいえ

フェッチされ、healthHandler に渡される Kubernetes リソース。

healthHandler

CodeRef<ResourceHealthHandler<T>>

いいえ

サブシステムの健全性を解決します。

popupComponent

CodeRef<WatchK8sResults<T>>

はい

ポップアップメニューコンテンツのローダー。定義された場合、health 項目はリンクとして表され、指定のコンテンツを含むポップアップメニューが開きます。

popupTitle

string

はい

ポップオーバーのタイトル。

7.5.1.21. console.dashboards/overview/health/url

7.5.1.21.1. summary

ステータスのソースが Kubernetes REST API である概要ダッシュボードのステータスカードに health サブシステムを追加します。

7.5.1.21.2. Properties
名前値のタイプ任意説明

title

string

いいえ

サブシステムの表示名。

url

string

いいえ

データの取得元の URL。これには、ベース Kubernetes URL が接頭辞として付けられます。

healthHandler

`CodeRef<URLHealthHandler<T, K8sResourceCommon

K8sResourceCommon[]>>`

いいえ

サブシステムの健全性を解決します。

additionalResource

CodeRef<FirehoseResource>

はい

フェッチされ、healthHandler に渡される追加のリソース。

popupComponent

CodeRef<React.ComponentType<{ healthResult?: T; healthResultError?: any; k8sResult?: FirehoseResult<R>; }>>

はい

ポップアップコンテンツのローダー。定義された場合、health 項目は指定のコンテンツのポップアップが開くリンクとして表示されます。

popupTitle

string

はい

7.5.1.22. console.dashboards/overview/inventory/item

7.5.1.22.1. 概要

概要インベントリーカードにリソースタイルを追加します。

7.5.1.22.2. プロパティー
名前値のタイプ任意説明

model

CodeRef<T>

いいえ

取得する resource のモデル。モデルの label または abbr の取得に使用します。

mapper

CodeRef<StatusGroupMapper<T, R>>

はい

さまざまなステータスをグループにマッピングする関数。

additionalResources

CodeRef<WatchK8sResources<R>>

はい

フェッチされ、mapper 関数に渡される追加のリソース。

7.5.1.23. console.dashboards/overview/inventory/item/group

7.5.1.23.1. 概要

インベントリーのステータスグループを追加します。

7.5.1.23.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

ステータスグループの ID。

icon

CodeRef<React.ReactElement<any, string | React.JSXElementConstructor<any>>>

いいえ

ステータスグループアイコンを表す React コンポーネント。

7.5.1.24. console.dashboards/overview/inventory/item/replacement

7.5.1.24.1. 概要

概要のインベントリーカードを置き換えます。

7.5.1.24.2. プロパティー
名前値のタイプ任意説明

model

CodeRef<T>

いいえ

取得する resource のモデル。モデルの label または abbr の取得に使用します。

mapper

CodeRef<StatusGroupMapper<T, R>>

はい

さまざまなステータスをグループにマッピングする関数。

additionalResources

CodeRef<WatchK8sResources<R>>

はい

フェッチされ、mapper 関数に渡される追加のリソース。

7.5.1.25. console.dashboards/overview/prometheus/activity/resource

7.5.1.25.1. summary

Kubernetes リソースの監視に基づいてアクティビティーをトリガーしている Prometheus Overview ダッシュボードの Activity カードにアクティビティーを追加します。

7.5.1.25.2. Properties
名前値のタイプ任意説明

クエリー

string[]

いいえ

監視するクエリー

component

CodeRef<React.ComponentType<PrometheusActivityProps>>

いいえ

アクションコンポーネント。

isActivity

CodeRef<(results: PrometheusResponse[]) ⇒ boolean>

はい

指定のリソースがアクションを表すかどうかを判断する関数。定義されていない場合は、すべてのリソースがアクティビティーを表します。

7.5.1.26. console.dashboards/project/overview/item

7.5.1.26.1. 概要

プロジェクトの概要インベントリーカードにリソースタイルを追加します。

7.5.1.26.2. プロパティー
名前値のタイプ任意説明

model

CodeRef<T>

いいえ

取得する resource のモデル。モデルの label または abbr の取得に使用します。

mapper

CodeRef<StatusGroupMapper<T, R>>

はい

さまざまなステータスをグループにマッピングする関数。

additionalResources

CodeRef<WatchK8sResources<R>>

はい

フェッチされ、mapper 関数に渡される追加のリソース。

7.5.1.27. console.dashboards/tab

7.5.1.27.1. summary

Overview タブの後に置かれた新規ダッシュボードタブを追加します。

7.5.1.27.2. Properties
名前値のタイプ任意説明

id

string

いいえ

このタブにカードを追加する場合にタブリンク href として使用される一意のタブ ID。

navSection

'home' | 'storage'

いいえ

タブが属するナビゲーションセクション。

title

string

いいえ

タブのタイトル。

7.5.1.28. console.file-upload

7.5.1.28.1. 概要

(利用できません)

7.5.1.28.2. プロパティー
名前値のタイプ任意説明

fileExtensions

string[]

いいえ

サポートされるファイル拡張子。

handler

CodeRef<FileUploadHandler>

いいえ

ファイルドロップアクションを処理する関数。

7.5.1.29. console.flag

7.5.1.29.1. summary

Web コンソール機能フラグを完全に制御します。

7.5.1.29.2. Properties
名前値のタイプ任意説明

handler

CodeRef<FeatureFlagHandler>

いいえ

任意の機能フラグを設定または設定解除するのに使用されます。

7.5.1.30. console.flag/hookProvider

7.5.1.30.1. summary

フックハンドラーを使用して Web コンソール機能フラグを完全に制御します。

7.5.1.30.2. Properties
名前値のタイプ任意説明

handler

CodeRef<FeatureFlagHandler>

いいえ

任意の機能フラグを設定または設定解除するのに使用されます。

7.5.1.31. console.flag/model

7.5.1.31.1. summary

クラスターに CRD の存在によって駆動される新規 Web コンソール機能フラグを追加します。

7.5.1.31.2. Properties
名前値のタイプ任意説明

flag

string

いいえ

CRD が検出されると設定するフラグの名前。

model

ExtensionK8sModel

いいえ

CustomResourceDefinition を参照するモデル。

7.5.1.32. console.global-config

7.5.1.32.1. 概要

(利用できません)

7.5.1.32.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

クラスター設定リソースインスタンスの一意の識別子。

name

string

いいえ

クラスター設定リソースインスタンスの名前。

model

ExtensionK8sModel

いいえ

クラスター設定リソースを参照するモデル。

namespace

string

いいえ

クラスター設定リソースインスタンスの namespace。

7.5.1.33. console.model-metadata

7.5.1.33.1. 概要

API 検出で取得および生成される値を上書きして、モデルの表示をカスタマイズします。

7.5.1.33.2. プロパティー
名前値のタイプ任意説明

model

ExtensionK8sGroupModel

いいえ

カスタマイズするモデル。グループのみ、またはオプションのバージョンおよび種類を指定できます。

badge

ModelBadge

はい

このモデル参照をテクノロジープレビューまたは開発者プレビューとみなすかどうか。

color

string

はい

このモデルに関連付ける色。

label

string

はい

ラベルをオーバーライドします。kind を指定する必要があります。

labelPlural

string

はい

複数形のラベルをオーバーライドします。kind を指定する必要があります。

abbr

string

はい

省略形をカスタマイズします。デフォルトは kind のすべての大文字 (最大 4 文字) です。その kind を指定する必要があります。

7.5.1.34. console.navigation/href

7.5.1.34.1. 概要

(利用できません)

7.5.1.34.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

この項目の一意の識別子。

name

string

いいえ

この項目の名前。

href

string

いいえ

リンクの href の値。

perspective

string

はい

この項目が属するパースペクティブ ID。指定されていない場合は、デフォルトのパースペクティブに提供します。

section

string

はい

この項目が属するナビゲーションセクション。指定されていない場合は、この項目を最上位のリンクとしてレンダリングします。

dataAttributes

{ [key: string]: string; }

はい

データ属性を DOM に追加します。

startsWith

string[]

はい

URL がこのパスのいずれかで始まる場合は、この項目をアクティブと識別します。

insertBefore

string | string[]

はい

ここで参照される項目の前に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。

insertAfter

string | string[]

はい

ここで参照される項目の後に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。insertBefore が優先されます。

namespaced

boolean

はい

true の場合、/ns/active-namespace を最後に追加します。

prefixNamespaced

boolean

はい

true の場合、/k8s/ns/active-namespace を最初に追加します。

7.5.1.35. console.navigation/resource-cluster

7.5.1.35.1. 概要

(利用できません)

7.5.1.35.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

この項目の一意の識別子。

model

ExtensionK8sModel

いいえ

このナビゲーション項目がリンクするモデル。

perspective

string

はい

この項目が属するパースペクティブ ID。指定されていない場合は、デフォルトのパースペクティブに提供します。

section

string

はい

この項目が属するナビゲーションセクション。指定しない場合は、この項目をトップレベルのリンクとしてレンダリングします。

dataAttributes

{ [key: string]: string; }

はい

データ属性を DOM に追加します。

startsWith

string[]

はい

URL がこのパスのいずれかで始まる場合は、この項目をアクティブと識別します。

insertBefore

string | string[]

はい

ここで参照される項目の前に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。

insertAfter

string | string[]

はい

ここで参照される項目の後に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。insertBefore が優先されます。

name

string

はい

デフォルト名をオーバーライドします。指定されていない場合、リンクの名前はモデルの複数形の値と同じになります。

7.5.1.36. console.navigation/resource-ns

7.5.1.36.1. 概要

(利用できません)

7.5.1.36.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

この項目の一意の識別子。

model

ExtensionK8sModel

いいえ

このナビゲーション項目がリンクするモデル。

perspective

string

はい

この項目が属するパースペクティブ ID。指定されていない場合は、デフォルトのパースペクティブに提供します。

section

string

はい

この項目が属するナビゲーションセクション。指定しない場合は、この項目をトップレベルのリンクとしてレンダリングします。

dataAttributes

{ [key: string]: string; }

はい

データ属性を DOM に追加します。

startsWith

string[]

はい

URL がこのパスのいずれかで始まる場合は、この項目をアクティブと識別します。

insertBefore

string | string[]

はい

ここで参照される項目の前に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。

insertAfter

string | string[]

はい

ここで参照される項目の後に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。insertBefore が優先されます。

name

string

はい

デフォルト名をオーバーライドします。指定されていない場合、リンクの名前はモデルの複数形の値と同じになります。

7.5.1.37. console.navigation/section

7.5.1.37.1. 概要

(利用できません)

7.5.1.37.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

この項目の一意の識別子。

perspective

string

はい

この項目が属するパースペクティブ ID。指定されていない場合は、デフォルトのパースペクティブに提供します。

dataAttributes

{ [key: string]: string; }

はい

データ属性を DOM に追加します。

insertBefore

string | string[]

はい

ここで参照される項目の前に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。

insertAfter

string | string[]

はい

ここで参照される項目の後に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。insertBefore が優先されます。

name

string

はい

このセクションの名前。指定しない場合は、セクションの上に区切り記号のみが表示されます。

7.5.1.38. console.navigation/separator

7.5.1.38.1. 概要

(利用できません)

7.5.1.38.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

この項目の一意の識別子。

perspective

string

はい

この項目が属するパースペクティブ ID。指定されていない場合は、デフォルトのパースペクティブに提供します。

section

string

はい

この項目が属するナビゲーションセクション。指定されていない場合は、この項目を最上位のリンクとしてレンダリングします。

dataAttributes

{ [key: string]: string; }

はい

データ属性を DOM に追加します。

insertBefore

string | string[]

はい

ここで参照される項目の前に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。

insertAfter

string | string[]

はい

ここで参照される項目の後に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。insertBefore が優先されます。

7.5.1.39. console.page/resource/details

7.5.1.39.1. summary

Web コンソールルーターに新しいリソースの詳細ページを追加します。

7.5.1.39.2. Properties
名前値のタイプ任意説明

model

ExtensionK8sGroupKindModel

いいえ

このリソースページがリンクするモデル。

component

CodeRef<React.ComponentType<{ match: match<{}>; namespace: string; model: ExtensionK8sModel; }>>

いいえ

ルートがマッチしたときにレンダリングされるコンポーネント。

7.5.1.40. console.page/resource/list

7.5.1.40.1. 概要

Console ルーターに新しいリソースリストのページを追加します。

7.5.1.40.2. プロパティー
名前値のタイプ任意説明

model

ExtensionK8sGroupKindModel

いいえ

このリソースページがリンクするモデル。

component

CodeRef<React.ComponentType<{ match: match<{}>; namespace: string; model: ExtensionK8sModel; }>>

いいえ

ルートがマッチしたときにレンダリングされるコンポーネント。

7.5.1.41. console.page/route

7.5.1.41.1. summary

Web コンソールルーターに新しいページを追加します。React Router を参照してください。

7.5.1.41.2. Properties
名前値のタイプ任意説明

component

CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>

いいえ

ルートがマッチしたときにレンダリングされるコンポーネント。

path

string | string[]

いいえ

path-to-regexp@^1.7.0 が理解する有効な URL パスまたはパスの配列。

perspective

string

はい

このページが属するパースペクティブ。指定されていない場合は、すべてのパースペクティブに提供します。

exact

boolean

はい

true の場合、パスが location.pathname と完全に一致する場合にのみマッチします。

7.5.1.42. console.page/route/standalone

7.5.1.42.1. summary

一般的なページレイアウトの外部でレンダリングされる新しいスタンドアロンページを Web コンソールルーターに追加します。React Router を参照してください。

7.5.1.42.2. Properties
名前値のタイプ任意説明

component

CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>

いいえ

ルートがマッチしたときにレンダリングされるコンポーネント。

path

string | string[]

いいえ

path-to-regexp@^1.7.0 が理解する有効な URL パスまたはパスの配列。

exact

boolean

はい

true の場合、パスが location.pathname と完全に一致する場合にのみマッチします。

7.5.1.43. console.perspective

7.5.1.43.1. 概要

(利用できません)

7.5.1.43.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

パースペクティブの識別子。

name

string

いいえ

パースペクティブの表示名。

icon

CodeRef<LazyComponent>

いいえ

パースペクティブの表示アイコン。

landingPageURL

CodeRef<(flags: { [key: string]: boolean; }, isFirstVisit: boolean) ⇒ string>

いいえ

パースペクティブのランディングページの URL を取得する関数。

importRedirectURL

CodeRef<(namespace: string) ⇒ string>

いいえ

インポートフローのリダイレクト URL を取得する関数。

default

boolean

はい

パースペクティブがデフォルトであるかどうか。デフォルトは 1 つのみです。

defaultPins

ExtensionK8sModel[]

はい

ナビゲーション上のデフォルトの固定されたリソース

usePerspectiveDetection

CodeRef<() ⇒ [boolean, boolean]>

はい

デフォルトのパースペクティブを検出するフック

7.5.1.44. console.project-overview/inventory-item

7.5.1.44.1. summary

新しいインベントリー項目を プロジェクトの概要 ページに追加します。

7.5.1.44.2. Properties
名前値のタイプ任意説明

component

CodeRef<React.ComponentType<{ projectName: string; }>>

いいえ

レンダリングされるコンポーネント。

7.5.1.45. console.project-overview/utilization-item

7.5.1.45.1. 概要

新しいプロジェクト概要の使用状況項目を追加します。

7.5.1.45.2. プロパティー
名前値のタイプ任意説明

title

string

いいえ

使用状況項目のタイトル。

getUtilizationQuery

CodeRef<GetProjectQuery>

いいえ

Prometheus 使用状況クエリー。

humanize

CodeRef<Humanize>

いいえ

Prometheus データを人間が判読できる形式に変換します。

getTotalQuery

CodeRef<GetProjectQuery>

はい

Prometheus 合計のクエリー。

getRequestQuery

CodeRef<GetProjectQuery>

はい

Prometheus 要求のクエリー。

getLimitQuery

CodeRef<GetProjectQuery>

はい

Prometheus 制限のクエリー。

TopConsumerPopover

CodeRef<React.ComponentType<TopConsumerPopoverProps>>

はい

プレーン値の代わりに最上位のコンシューマーポップオーバーを表示します。

7.5.1.46. console.pvc/alert

7.5.1.46.1. 概要

(利用できません)

7.5.1.46.2. プロパティー
名前値のタイプ任意説明

alert

CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>

いいえ

アラートコンポーネント。

7.5.1.47. console.pvc/create-prop

7.5.1.47.1. 概要

(利用できません)

7.5.1.47.2. プロパティー
名前値のタイプ任意説明

label

string

いいえ

prop アクション作成のラベル。

path

string

いいえ

prop アクション作成のパス。

7.5.1.48. console.pvc/delete

7.5.1.48.1. 概要

(利用できません)

7.5.1.48.2. プロパティー
名前値のタイプ任意説明

predicate

CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>

いいえ

エクステンションを使用するかどうかを示す述語。

onPVCKill

CodeRef<(pvc: K8sResourceCommon) ⇒ Promise<void>>

いいえ

PVC 削除操作の方法。

alert

CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>

いいえ

追加情報を表示するアラートコンポーネント。

7.5.1.49. console.pvc/status

7.5.1.49.1. 概要

(利用できません)

7.5.1.49.2. プロパティー
名前値のタイプ任意説明

priority

number

いいえ

status コンポーネントの優先度。値が大きいほど優先度が高くなります。

status

CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>

いいえ

status コンポーネント。

predicate

CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>

いいえ

ステータスコンポーネントをレンダリングするかどうかを示す述語。

7.5.1.50. console.redux-reducer

7.5.1.50.1. 概要

plugins.<scope> サブ状態で動作する Console Redux ストアに新しい reducer を追加します。

7.5.1.50.2. プロパティー
名前値のタイプ任意説明

scope

string

いいえ

Redux 状態オブジェクト内の reducer が管理するサブ状態を表すキー。

reducer

CodeRef<Reducer<any, AnyAction>>

いいえ

reducer が管理するサブ状態で動作する reducer 関数

7.5.1.51. console.resource/create

7.5.1.51.1. 概要

(利用できません)

7.5.1.51.2. プロパティー
名前値のタイプ任意説明

model

ExtensionK8sModel

いいえ

この create resource ページがレンダリングされるモデル。

component

CodeRef<React.ComponentType<CreateResourceComponentProps>>

いいえ

モデルがマッチする場合にレンダリングされるコンポーネント

7.5.1.52. console.storage-provider

7.5.1.52.1. 概要

(利用できません)

7.5.1.52.2. プロパティー
名前値のタイプ任意説明

name

string

いいえ

 

コンポーネント

CodeRef<React.ComponentType<Partial<RouteComponentProps<{}, StaticContext, any>>>>

いいえ

 

7.5.1.53. console.tab/horizontalNav

7.5.1.53.1. 概要

(利用できません)

7.5.1.53.2. プロパティー
名前値のタイプ任意説明

model

ExtensionK8sKindVersionModel

いいえ

このプロバイダーがタブを表示するモデル。

page

{ name: string; href: string; }

いいえ

水平タブに表示されるページ。名前としてタブ名およびタブの href を取ります。

component

CodeRef<React.ComponentType<PageComponentProps<K8sResourceCommon>>>

いいえ

ルートがマッチしたときにレンダリングされるコンポーネント。

7.5.1.54. console.telemetry/listener

7.5.1.54.1. 概要

(利用できません)

7.5.1.54.2. プロパティー
名前値のタイプ任意説明

listener

CodeRef<TelemetryEventListener>

いいえ

テレメトリーイベントをリッスンします

7.5.1.55. console.topology/adapter/build

7.5.1.55.1. summary

BuildAdapter は、Build コンポーネントで使用できるデータに要素を適応させるアダプターを提供します。

7.5.1.55.2. Properties
名前値のタイプ任意説明

adapt

CodeRef<(element: GraphElement) ⇒ AdapterDataType<BuildConfigData>

undefined>

いいえ

7.5.1.56. console.topology/adapter/network

7.5.1.56.1. summary

NetworkAdapater は、Networking コンポーネントで使用できるデータに要素を適応させるアダプターを提供します。

7.5.1.56.2. Properties
名前値のタイプ任意説明

adapt

<(element: GraphElement) ⇒ NetworkAdapterType

undefined>

いいえ

7.5.1.57. console.topology/adapter/pod

7.5.1.57.1. summary

PodAdapter はアダプターを提供し、Pod コンポーネントで使用できるデータに要素を適合させます。

7.5.1.57.2. Properties
名前値のタイプ任意説明

adapt

`CodeRef<(element: GraphElement) ⇒ AdapterDataType<PodsAdapterDataType>

undefined>

いいえ

7.5.1.58. console.topology/component/factory

7.5.1.58.1. summary

ViewComponentFactory の Getter。

7.5.1.58.2. Properties
名前値のタイプ任意説明

getFactory

CodeRef<ViewComponentFactory>

いいえ

ViewComponentFactory の Getter。

7.5.1.59. console.topology/create/connector

7.5.1.59.1. summary

コネクター作成関数の getter。

7.5.1.59.2. Properties
名前値のタイプ任意説明

getCreateConnector

CodeRef<CreateConnectionGetter>

いいえ

コネクター作成関数の getter。

7.5.1.60. console.topology/data/factory

7.5.1.60.1. 概要

トポロジーデータモデルファクトリーエクステンション

7.5.1.60.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

ファクトリーの一意の ID。

priority

number

いいえ

ファクトリーの優先度

resources

WatchK8sResourcesGeneric

はい

useK8sWatchResources フックから取得されるリソース。

workloadKeys

string[]

はい

ワークロードが含まれるリソースのキー。

getDataModel

CodeRef<TopologyDataModelGetter>

はい

データモデルファクトリーの Getter。

isResourceDepicted

CodeRef<TopologyDataModelDepicted>

はい

リソースがこのモデルファクトリーによって記述されているかどうかを判断する関数の Getter。

getDataModelReconciler

CodeRef<TopologyDataModelReconciler>

はい

すべてのエクステンションのモデルがロードされた後にデータモデルを調整する関数の Getter。

7.5.1.61. console.topology/decorator/provider

7.5.1.61.1. 概要

トポロジーデコレータープロバイダーエクステンション

7.5.1.61.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

 

priority

number

いいえ

 

quadrant

TopologyQuadrant

いいえ

 

decorator

CodeRef<TopologyDecoratorGetter>

いいえ

 

7.5.1.62. console.topology/details/resource-alert

7.5.1.62.1. summary

DetailsResourceAlert は、特定のトポロジーコンテキストまたはグラフ要素のアラートを提供します。

7.5.1.62.2. Properties
名前値のタイプ任意説明

id

string

いいえ

このアラートの ID。アラートの破棄後に表示しない場合に状態を保存するために使用されます。

contentProvider

CodeRef<(element: GraphElement) ⇒ DetailsResourceAlertContent

null>

いいえ

7.5.1.64. console.topology/details/tab

7.5.1.64.1. summary

DetailsTab は、トポロジーの詳細パネルのタブを提供します。

7.5.1.64.2. Properties
名前値のタイプ任意説明

id

string

いいえ

この詳細タブの一意の識別子。

label

string

いいえ

UI に表示されるタブのラベル。

insertBefore

string | string[]

はい

ここで参照される項目の前に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。

insertAfter

string | string[]

はい

ここで参照される項目の後に、この項目を挿入します。配列の場合は、最初に見つかったものが順番に使用されます。insertBefore 値が優先されます。

7.5.1.65. console.topology/details/tab-section

7.5.1.65.1. summary

DetailsTabSection は、トポロジーの詳細パネルの特定タブのセクションを提供します。

7.5.1.65.2. Properties
名前値のタイプ任意説明

id

string

いいえ

この詳細タブセクションの一意の識別子。

tab

string

いいえ

このセクションが提供する必要のある親タブ ID。

provider

CodeRef<DetailsTabSectionExtensionHook>

いいえ

トポロジー/サイドバーでレンダリングされるコンポーネントまたは null/undefined を返すフック。SKD コンポーネント:<Section title=\{}>…​ padded area

section

CodeRef<(element: GraphElement, renderNull?: () ⇒ null) ⇒ React.Component

undefined>

いいえ

プロバイダーが定義されていない場合 @非推奨のフォールバック。renderNull はすでに運用されません。

insertBefore

string | string[]

はい

ここで参照される項目の前にこの項目を挿入します。配列の場合は、最初に見つかった項目が順番に使用されます。

insertAfter

string | string[]

はい

7.5.1.66. console.topology/display/filters

7.5.1.66.1. 概要

トポロジー表示フィルターエクステンション

7.5.1.66.2. プロパティー
名前値のタイプ任意説明

getTopologyFilters

CodeRef<() ⇒ TopologyDisplayOption[]>

いいえ

 

applyDisplayOptions

CodeRef<TopologyApplyDisplayOptions>

いいえ

 

7.5.1.67. console.topology/relationship/provider

7.5.1.67.1. 概要

トポロジー関係プロバイダーコネクターエクステンション

7.5.1.67.2. プロパティー
名前値のタイプ任意説明

provides

CodeRef<RelationshipProviderProvides>

いいえ

 

ヒント

string

いいえ

 

create

CodeRef<RelationshipProviderCreate>

いいえ

 

priority

number

いいえ

 

7.5.1.68. console.user-preference/group

7.5.1.68.1. 概要

(利用できません)

7.5.1.68.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

ユーザー設定グループを識別するのに使用される ID。

label

string

いいえ

ユーザー設定グループのラベル

insertBefore

string

はい

このユーザー設定グループの後に配置しなければならないグループの ID

insertAfter

string

はい

このユーザー設定グループの前に配置しなければならないグループの ID

7.5.1.69. console.user-preference/item

7.5.1.69.1. 概要

(利用できません)

7.5.1.69.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

ユーザー設定項目を特定するのに使用され、項目の順序を定義するのに insertAfter および insertBefore で参照される ID。

label

string

いいえ

ユーザー設定のラベル

description

string

いいえ

ユーザー設定の説明。

field

UserPreferenceField

いいえ

ユーザー設定を定義するために値をレンダリングするのに使用される入力フィールドのオプション。

groupId

string

はい

項目が属するユーザー優先グループを識別するのに使用される ID。

insertBefore

string

はい

このユーザー設定項目の後に配置しなければならない項目の ID

insertAfter

string

はい

このユーザー設定項目の前に配置しなければならない項目の ID

7.5.1.70. console.yaml-template

7.5.1.70.1. 概要

yaml エディターを使用してリソースを編集するための YAML テンプレート。

7.5.1.70.2. プロパティー
名前値のタイプ任意説明

model

ExtensionK8sModel

いいえ

テンプレートに関連付けられたモデル。

template

CodeRef<string>

いいえ

YAML テンプレート。

name

string

いいえ

テンプレートの名前。名前 default を使用して、これをデフォルトテンプレートと識別します。

7.5.1.71. dev-console.add/action

7.5.1.71.1. 概要

(利用できません)

7.5.1.71.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

アクションを識別するための ID。

label

string

いいえ

アクションのラベル

description

string

いいえ

アクションの説明。

href

string

いいえ

移動先の href。

groupId

string

はい

アクションが属するアクショングループを識別するのに使用される ID。

icon

CodeRef<React.ReactNode>

はい

パースペクティブの表示アイコン。

accessReview

AccessReviewResourceAttributes[]

はい

アクションの可視性または有効化を制御するオプションのアクセスレビュー。

7.5.1.72. dev-console.add/action-group

7.5.1.72.1. 概要

(利用できません)

7.5.1.72.2. プロパティー
名前値のタイプ任意説明

id

string

いいえ

アクショングループを識別するのに使用される ID。

name

string

いいえ

アクショングループのタイトル

insertBefore

string

はい

このアクショングループの後に配置しなければならないグループの ID

insertAfter

string

はい

このアクショングループの前に配置しなければならないグループの ID

7.5.1.73. dev-console.import/environment

7.5.1.73.1. 概要

(利用できません)

7.5.1.73.2. プロパティー
名前値のタイプ任意説明

imageStreamName

string

いいえ

カスタム環境変数を指定するイメージストリームの名前

imageStreamTags

string[]

いいえ

サポートされるイメージストリームタグのリスト

environments

ImageEnvironment[]

いいえ

環境変数のリスト

7.5.1.74. console.page/resource/tab

7.5.1.74.1. 概要 [非推奨]

非推奨。代わりに console.tab/horizontalNav を使用してください。Console ルーターに新しいリソースタブページを追加します。

7.5.1.74.2. Properties
名前値のタイプ任意説明

model

ExtensionK8sGroupKindModel

いいえ

このリソースページがリンクするモデル。

component

CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>

いいえ

ルートがマッチしたときにレンダリングされるコンポーネント。

name

string

いいえ

タブの名前。

href

string

はい

タブリンクのオプション href。指定しない場合は、最初の path が使用されます。

exact

boolean

はい

true の場合、パスが location.pathname と完全に一致する場合にのみマッチします。

7.5.2. 動的プラグインのトラブルシューティング

プラグインのロードで問題が発生した場合は、このトラブルシューティングのヒントのリストを参照してください。

  • 以下のコマンドを実行して、コンソールの Operator 設定でプラグインが有効になっており、プラグイン名が出力されていることを確認します。

    $ oc get console.operator.openshift.io cluster -o jsonpath='{.spec.plugins}'
    • Administrator perspectiveOverview ページのステータスカードで、有効なプラグインを確認します。プラグインが最近有効になった場合は、ブラウザーを更新する必要があります。
  • 次の方法で、プラグインサービスが正常であることを確認します。

    • プラグイン Pod のステータスが実行中であり、コンテナーの準備が整っていることを確認します。
    • サービスラベルセレクターが Pod と一致し、ターゲットポートが正しいことを確認します。
    • コンソール Pod 上のターミナルまたはクラスター上の別の Pod のサービスから、curl コマンドを plugin-manifest.json とともに使用します。
  • ConsolePlugin リソース名 (consolePlugin.name) が package.json で使用されているプラグイン名と一致することを確認します。
  • サービス名、namespace、ポート、およびパスが ConsolePlugin リソースで正しく宣言されていることを確認します。
  • プラグインサービスが HTTPS とサービス提供証明書を使用していることを確認します。
  • コンソール Pod ログで証明書または接続エラーを確認します。
  • プラグインが依存する機能フラグが無効になっていないことを確認します。
  • プラグインの package.json に一致しない consolePlugin.dependencies がないことを確認します。

    • これには、コンソールバージョンの依存関係または他のプラグインへの依存関係が含まれる場合があります。ブラウザーで JS コンソールをプラグインの名前でフィルタリングして、ログに記録されたメッセージを表示します。
  • ナビゲーション拡張パースペクティブまたはセクション ID にタイプミスがないことを確認します。

    • プラグインは読み込まれている可能性がありますが、ID が間違っているとナビゲーション項目が失われる可能性があります。URL を編集して、プラグインページに直接移動してみてください。
  • コンソール Pod からプラグインサービスへのトラフィックをブロックしているネットワークポリシーがないことを確認します。

    • 必要に応じて、ネットワークポリシーを調整して、openshift-console namespace のコンソール Pod がサービスにリクエストを送信できるようにします。
  • 開発者ツールブラウザーの Console タブで、ブラウザーにロードされる動的プラグインのリストを確認します。

    • window.SERVER_FLAGS.consolePlugins を評価して、コンソールフロントエンドの動的プラグインを確認します。