7.5. 动态插件参考


您可以添加允许您自定义插件的扩展。这些扩展随后会在运行时加载到控制台。

7.5.1. 动态插件扩展类型

console.action/filter

ActionFilter 可用于过滤操作。

Expand
Name值类型选填描述

contextId

string

上下文 ID 有助于将贡献操作的范围缩小到应用的特定区域。示例包括 topologyhelm

filter

CodeRef<(scope: any, action: Action) ⇒ boolean>

将根据某些条件过滤操作的功能。scope:为其提供操作的范围。如果要使用 Pod 横向自动扩展 (HPA) 从部署中删除 ModifyCount 操作,则可能需要 hook。

console.action/group

ActionGroup 贡献一个操作组,也可以是一个子菜单

Expand
Name值类型选填描述

id

string

用于识别操作部分的 ID。

label

string

UI 中显示的标签。子菜单是必需的。

submenu

布尔值

此组是否应显示为子菜单。

insertBefore

string | string[]

在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。

insertAfter

string | string[]

在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。insertBefore 值具有优先权。

console.action/provider

ActionProvider 贡献了一个 hook,用于返回特定上下文的操作列表。

Expand
Name值类型选填描述

contextId

string

上下文 ID 有助于将贡献操作的范围缩小到应用的特定区域。示例包括 topologyhelm

provider

CodeRef<ExtensionHook<Action[], any>>

一个 React hook,用于返回给定范围的操作。如果 contextId = resource,则范围始终为 Kubernetes 资源对象。

console.action/resource-provider

ResourceActionProvider 贡献 hook,用于返回特定资源模型的操作列表。

Expand
Name值类型选填描述

model

ExtensionK8sKindVersionModel

此提供程序提供操作的模型。

provider

CodeRef<ExtensionHook<Action[], any>>

反应 hook,它返回给定资源模型的操作

console.alert-action
Expand
Name值类型选填描述

alert

string

 

text

string

 

action

CodeRef<(alert: any) ⇒ void>

 
console.catalog/item-filter
Expand
Name值类型选填描述

catalogId

string | string[]

此提供程序参与的目录的唯一标识符。

type

string

目录项目类型的类型 ID。

filter

CodeRef<(item: CatalogItem) ⇒ boolean>

过滤特定类型的项目。值是采用 CatalogItem[] 且根据过滤器标准返回子集的功能。

console.catalog/item-metadata
Expand
Name值类型选填描述

catalogId

string | string[]

此提供程序参与的目录的唯一标识符。

type

string

目录项目类型的类型 ID。

provider

CodeRef<ExtensionHook<CatalogItemMetadataProviderFunction, CatalogExtensionHookOptions>>

返回一个将用来向特定类型的目录项提供元数据的 hook。

console.catalog/item-provider
Expand
Name值类型选填描述

catalogId

string | string[]

此提供程序参与的目录的唯一标识符。

type

string

目录项目类型的类型 ID。

title

string

目录项提供程序的标题

provider

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

为目录获取项目并进行规范化。值是对 hook 做出反应。

priority

number

此提供程序的优先级。默认值为 0。优先级更高的提供程序可能会覆盖由其他供应商提供的目录项。

console.catalog/item-type
Expand
Name值类型选填描述

type

string

目录项的类型。

title

string

目录项的标题。

catalogDescription

string | CodeRef<React.ReactNode>

特定与目录类型的描述。

typeDescription

string

目录项类型的描述。

filters

CatalogItemAttribute[]

特定于目录项的自定义过滤器。

groupings

CatalogItemAttribute[]

特定于目录项的自定义分组。

console.catalog/item-type-metadata
Expand
Name值类型选填描述

type

string

目录项的类型。

filters

CatalogItemAttribute[]

特定于目录项的自定义过滤器。

groupings

CatalogItemAttribute[]

特定于目录项的自定义分组。

console.cluster-overview/inventory-item

将新清单项添加到集群概览页面中。

Expand
Name值类型选填描述

component

CodeRef<React.ComponentType<{}>>

要呈现的组件。

console.cluster-overview/multiline-utilization-item

添加新的集群概述多行使用项。

Expand
Name值类型选填描述

title

string

使用项目的标题。

getUtilizationQueries

CodeRef<GetMultilineQueries>

Prometheus 使用率查询。

humanize

CodeRef<Humanize>

将 Prometheus 数据转换为人类可读形式。

TopConsumerPopovers

CodeRef<React.ComponentType<TopConsumerPopoverProps>[]>

显示顶部消费者弹出而不是普通值

console.cluster-overview/utilization-item

添加新的集群概览使用率项目。

Expand
Name值类型选填描述

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>>

显示顶部消费者弹出而不是普通值

console.context-provider

在 web 控制台应用程序根目录中添加新的 React 上下文提供程序。

Expand
Name值类型选填描述

provider

CodeRef<Provider<T>>

上下文提供程序组件。

useValueHook

CodeRef<() ⇒ T>

上下文值的 hook。

console.dashboards/card

添加新的仪表板卡。

Expand
Name值类型选填描述

tab

string

将添加到卡的仪表板标签的 ID。

position

'LEFT' | 'RIGHT' | 'MAIN'

该卡在仪表板上的网格位置。

component

CodeRef<React.ComponentType<{}>>

仪表板卡组件。

span

OverviewCardSpan

栏中卡的垂直范围。对于小屏幕会忽略,默认为 12

console.dashboards/overview/activity/resource

在 Overview 仪表板的活动卡中添加一个活动,其中根据监视 Kubernetes 资源触发活动。

Expand
Name值类型选填描述

k8sResource

CodeRef<FirehoseResource & { isList: true; }>

要替换的 utilization 项。

component

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

操作组件。

isActivity

CodeRef<(resource: T) ⇒ boolean>

确定给定资源是否代表该操作的功能。如果没有定义,则每个资源都代表活动。

getTimestamp

CodeRef<(resource: T) ⇒ Date>

给定操作的时间戳,用于排序。

console.dashboards/overview/detail/item

Overview 仪表板的详情卡中添加项目。

Expand
Name值类型选填描述

component

CodeRef<React.ComponentType<{}>>

基于 DetailItem 组件的值

console.dashboards/overview/health/operator

Overview 仪表板的状态卡中添加一个健康子系统,其中状态源是 Kubernetes REST API。

Expand
Name值类型选填描述

title

string

弹出菜单中的 Operators 部分的标题。

资源

CodeRef<FirehoseResource[]>

将获取并传递给 healthHandler 的 Kubernetes 资源。

getOperatorsWithStatuses

CodeRef<GetOperatorsWithStatuses<T>>

解析 Operator 的状态。

operatorRowLoader

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

弹出行组件的加载程序。

viewAllLink

string

链接到所有资源页面。如果没有提供,则使用资源 prop 中第一个资源的列表页面。

console.dashboards/overview/health/prometheus

在 Status 为 Prometheus 的 Overview 仪表板的状态卡中添加一个健康子系统。

Expand
Name值类型选填描述

title

string

子系统的显示名称。

queries

string[]

Prometheus 查询

healthHandler

CodeRef<PrometheusHealthHandler>

解决子系统的健康状况。

additionalResource

CodeRef<FirehoseResource>

将获取并传递给 healthHandler 的其他资源。

popupComponent

CodeRef<React.ComponentType<PrometheusHealthPopupProps>>

弹出式菜单内容的加载程序。如果定义,健康项表示为链接,它会打开一个带有给定内容的弹出窗口。

popupTitle

string

弹出的标题。

disallowedControlPlaneTopology

string[]

应该隐藏子系统的 control plane 拓扑。

console.dashboards/overview/health/resource

在状态仪表板的 Overview 卡中添加一个健康子系统,其中状态源是一个 Kubernetes 资源。

Expand
Name值类型选填描述

title

string

子系统的显示名称。

资源

CodeRef<WatchK8sResources<T>>

将获取并传递给 healthHandler 的 Kubernetes 资源。

healthHandler

CodeRef<ResourceHealthHandler<T>>

解决子系统的健康状况。

popupComponent

CodeRef<WatchK8sResults<T>>

弹出式菜单内容的加载程序。如果定义,健康项表示为链接,它会打开一个带有给定内容的弹出窗口。

popupTitle

string

弹出的标题。

console.dashboards/overview/health/url

在状态仪表板的 Overview 卡中添加一个健康子系统,其中状态源是一个 Kubernetes REST API。

Expand
Name值类型选填描述

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>; }>>

弹出内容的加载程序。如果定义,则一个健康项目将显示为一个链接,该链接会打开给定内容弹出窗口中。

popupTitle

string

console.dashboards/overview/inventory/item

在概述清单卡中添加资源标题。

Expand
Name值类型选填描述

model

CodeRef<T>

将获取的资源模型。用于获取模型的 labelabbr

mapper

CodeRef<StatusGroupMapper<T, R>>

将各种状态映射到组的功能。

additionalResources

CodeRef<WatchK8sResources<R>>

将获取并传递给映射程序函数的其他资源。

console.dashboards/overview/inventory/item/group

添加清单状态组。

Expand
Name值类型选填描述

id

string

状态组的 id。

icon

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

响应代表状态组图标的组件。

console.dashboards/overview/inventory/item/replacement

替换概述清单卡。

Expand
Name值类型选填描述

model

CodeRef<T>

将获取的资源模型。用于获取模型的 labelabbr

mapper

CodeRef<StatusGroupMapper<T, R>>

将各种状态映射到组的功能。

additionalResources

CodeRef<WatchK8sResources<R>>

将获取并传递给映射程序函数的其他资源。

console.dashboards/overview/prometheus/activity/resource

在 Prometheus Overview 仪表板的 Activity 卡中添加一个活动,该仪表板根据监视 Kubernetes 资源来触发活动。

Expand
Name值类型选填描述

queries

string[]

要监视的查询

component

CodeRef<React.ComponentType<PrometheusActivityProps>>

操作组件。

isActivity

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

确定给定资源是否代表该操作的功能。如果没有定义,则每个资源都代表活动。

console.dashboards/project/overview/item

为项目概述清单卡中添加资源标题。

Expand
Name值类型选填描述

model

CodeRef<T>

将获取的资源模型。用于获取模型的 labelabbr

mapper

CodeRef<StatusGroupMapper<T, R>>

将各种状态映射到组的功能。

additionalResources

CodeRef<WatchK8sResources<R>>

将获取并传递给映射程序函数的其他资源。

console.dashboards/tab

添加新仪表板选项卡,它位于 Overview 选项卡的后面。

Expand
Name值类型选填描述

id

string

唯一标签页标识符,用作标签链接 href 以及在此标签页中添加卡时。

navSection

'home' | 'storage'

选项卡所属的导航部分。

title

string

选项卡的标题。

console.file-upload
Expand
Name值类型选填描述

fileExtensions

string[]

支持的文件扩展。

handler

CodeRef<FileUploadHandler>

处理文件丢弃操作的功能。

console.flag

提供对 Web 控制台功能标记的完整控制。

Expand
Name值类型选填描述

handler

CodeRef<FeatureFlagHandler>

用于设置或取消设置任意功能标记。

console.flag/hookProvider

提供对带有 hook 处理程序的 Web 控制台功能标记的完整控制。

Expand
Name值类型选填描述

handler

CodeRef<FeatureFlagHandler>

用于设置或取消设置任意功能标记。

console.flag/model

通过在集群中存在 CRD 来添加新的 Web 控制台功能标记。

Expand
Name值类型选填描述

flag

string

在检测到 CRD 后设置的标记名称。

model

ExtensionK8sModel

引用 CustomResourceDefinition 的模型。

console.global-config
Expand
Name值类型选填描述

id

string

集群配置资源实例的唯一标识符。

name

string

集群配置资源实例的名称。

model

ExtensionK8sModel

指代集群配置资源的模型。

namespace

string

集群配置资源实例的命名空间。

console.model-metadata

通过覆盖通过 API 发现检索并生成的值来自定义模型显示。

Expand
Name值类型选填描述

model

ExtensionK8sGroupModel

要定制的模型。只能指定组或可选版本和类型。

badge

ModelBadge

是否将这个模型视为技术预览还是开发者预览。

color

string

与这个模型关联的颜色。

label

string

覆盖标签。需要提供的 kind

labelPlural

string

覆盖复数标签。需要提供的 kind

abbr

string

自定义缩写。默认为 kind 中的所有字符的大写,最多 4 个字符。需要 kind 提供。

console.navigation/href
Expand
Name值类型选填描述

id

string

此项目的唯一标识符。

name

string

此项目的名称。

href

string

链接 href 值。

perspective

string

此项目所属的视角 ID。若未指定,则向默认视角。

string

导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。

dataAttributes

{ [key: string]: string; }

在 DOM 中添加数据属性。

startsWith

string[]

当 URL 从其中一个路径之一时,将此项标记为 active。

insertBefore

string | string[]

在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。

insertAfter

string | string[]

在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。insertBefore 具有高优先级。

namespaced

布尔值

如果为 true,请在末尾添加 /ns/active-namespace

prefixNamespaced

布尔值

如果为 true,将 /k8s/ns/active-namespace 添加到起始位置

console.navigation/resource-cluster
Expand
Name值类型选填描述

id

string

此项目的唯一标识符。

model

ExtensionK8sModel

此导航项目所链接的模型。

perspective

string

此项目所属的视角 ID。若未指定,则向默认视角。

string

导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。

dataAttributes

{ [key: string]: string; }

在 DOM 中添加数据属性。

startsWith

string[]

当 URL 从其中一个路径之一时,将此项标记为 active。

insertBefore

string | string[]

在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。

insertAfter

string | string[]

在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。insertBefore 具有高优先级。

name

string

覆盖默认名称。如果没有提供链接的名称,则会与模型的复数值相同。

console.navigation/resource-ns
Expand
Name值类型选填描述

id

string

此项目的唯一标识符。

model

ExtensionK8sModel

此导航项目所链接的模型。

perspective

string

此项目所属的视角 ID。若未指定,则向默认视角。

string

导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。

dataAttributes

{ [key: string]: string; }

在 DOM 中添加数据属性。

startsWith

string[]

当 URL 从其中一个路径之一时,将此项标记为 active。

insertBefore

string | string[]

在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。

insertAfter

string | string[]

在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。insertBefore 具有高优先级。

name

string

覆盖默认名称。如果没有提供链接的名称,则会与模型的复数值相同。

console.navigation/section
Expand
Name值类型选填描述

id

string

此项目的唯一标识符。

perspective

string

此项目所属的视角 ID。若未指定,则向默认视角。

dataAttributes

{ [key: string]: string; }

在 DOM 中添加数据属性。

insertBefore

string | string[]

在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。

insertAfter

string | string[]

在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。insertBefore 具有高优先级。

name

string

本节的名称。如果没有提供,上面部分将仅显示一个分隔符。

console.navigation/separator
Expand
Name值类型选填描述

id

string

此项目的唯一标识符。

perspective

string

此项目所属的视角 ID。若未指定,则向默认视角。

string

导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。

dataAttributes

{ [key: string]: string; }

在 DOM 中添加数据属性。

insertBefore

string | string[]

在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。

insertAfter

string | string[]

在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。insertBefore 具有高优先级。

console.page/resource/details
Expand
Name值类型选填描述

model

ExtensionK8sGroupKindModel

此资源页面链接到的型号。

component

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

路由匹配时要呈现的组件。

console.page/resource/list

向控制台路由器添加新的资源列表页面。

Expand
Name值类型选填描述

model

ExtensionK8sGroupKindModel

此资源页面链接到的型号。

component

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

路由匹配时要呈现的组件。

console.page/route

在 Web 控制台路由器中添加新页面。请参阅 React Router

Expand
Name值类型选填描述

component

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

路由匹配时要呈现的组件。

path

string | string[]

path-to-regexp@^1.7.0 可以理解的有效 URL 路径或路径数组。

perspective

string

此页面所属的视图。如果没有指定,则会对所有视角贡献。

exact

布尔值

为 true 时,只有在路径与 location.pathname 完全匹配时才会匹配。

console.page/route/standalone

向 web 控制台路由器中添加在通用页面布局外呈现的新独立页面。请参阅 React Router

Expand
Name值类型选填描述

component

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

路由匹配时要呈现的组件。

path

string | string[]

path-to-regexp@^1.7.0 可以理解的有效 URL 路径或路径数组。

exact

布尔值

为 true 时,只有在路径与 location.pathname 完全匹配时才会匹配。

console.perspective
Expand
Name值类型选填描述

id

string

透视图标识符。

name

string

视角显示名称。

icon

CodeRef<LazyComponent>

视角显示图标。

landingPageURL

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

获取视角登录页面 URL 的功能。

importRedirectURL

CodeRef<(namespace: string) ⇒ string>

获取导入流的重定向 URL。

default

布尔值

这个视角是默认的。只能有一个默认值。

defaultPins

ExtensionK8sModel[]

nav 上的默认固定资源

usePerspectiveDetection

CodeRef<() ⇒ [boolean, boolean]>

要检测默认视角的 hook

console.project-overview/inventory-item

Project Overview 页面中添加一个新清单项。

Expand
Name值类型选填描述

component

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

要呈现的组件。

console.project-overview/utilization-item

添加新项目概述使用率项目。

Expand
Name值类型选填描述

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>>

显示 top consumer 弹出窗而不是纯值。

console.pvc/alert
Expand
Name值类型选填描述

alert

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

警报组件。

console.pvc/create-prop
Expand
Name值类型选填描述

label

string

创建 prop 操作的标签。

path

string

创建 prop 操作的路径。

console.pvc/delete
Expand
Name值类型选填描述

predicate

CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>

告知是否使用扩展名的 predicate。

onPVCKill

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

PVC 删除操作的方法。

alert

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

警报组件以显示其他信息。

console.pvc/status
Expand
Name值类型选填描述

priority

number

状态组件的优先级。较大的值代表优先级更高。

status

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

状态组件。

predicate

CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>

指示是否呈现状态组件的 predicate。

console.redux-reducer

为 Console Red Hatux 存储添加了新的减少程序,该存储在 plugins.<scope> 子状态上运行。

Expand
Name值类型选填描述

scope

string

代表 Red Hatux 状态对象中减少管理的子状态的关键。

reducer

CodeRef<Reducer<any, AnyAction>>

reducer 函数,在 reducer-managed substate 中操作。

console.resource/create
Expand
Name值类型选填描述

model

ExtensionK8sModel

此创建资源页面将呈现的型号。

component

CodeRef<React.ComponentType<CreateResourceComponentProps>>

当模型匹配时要呈现的组件

console.storage-provider
Expand
Name值类型选填描述

name

string

 

组件

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

 
console.tab/horizontalNav
Expand
Name值类型选填描述

model

ExtensionK8sKindVersionModel

此提供程序显示选项卡的型号。

page

{ name: string; href: string; }

要在水平标签页中显示的页面。它取标签名称作为名称,并且是 href 的选项卡

component

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

路由匹配时要呈现的组件。

console.telemetry/listener
Expand
Name值类型选填描述

listener

CodeRef<TelemetryEventListener>

侦听遥测事件

console.topology/adapter/build

BuildAdapter 贡献适配器将元素适应 Build 组件可以使用的数据

Expand
Name值类型选填描述

adapt

'codeRef< (element: GraphElement) HEKETI AdapterDataType<BuildConfigData>

undefined>`

console.topology/adapter/network

NetworkAdpater 贡献适配器,将元素适应数据,以供 Networking 组件使用

Expand
Name值类型选填描述

adapt

'codeRef< (element: GraphElement) HEKETI NetworkAdapterType

undefined>`

console.topology/adapter/pod

PodAdapter 贡献一个适配器,将元素适应 Pod 组件可以使用的数据。

Expand
Name值类型选填描述

adapt

'codeRef< (element: GraphElement) Generate AdapterDataType<PodsAdapterDataType>

undefined>`

console.topology/component/factory

ViewComponentFactory 的 getter。

Expand
Name值类型选填描述

getFactory

CodeRef<ViewComponentFactory>

ViewComponentFactory 的 getter。

console.topology/create/connector

创建连接器功能的 getter。

Expand
Name值类型选填描述

getCreateConnector

CodeRef<CreateConnectionGetter>

创建连接器功能的 getter。

console.topology/data/factory

拓扑数据模型工厂扩展

Expand
Name值类型选填描述

id

string

工厂的唯一 ID。

priority

number

工厂的优先级

资源

WatchK8sResourcesGeneric

要从 useK8sWatchResources hook 获取的资源。

workloadKeys

string[]

包含工作负载的资源中的密钥。

getDataModel

CodeRef<TopologyDataModelGetter>

数据模型工厂的 getter。

isResourceDepicted

CodeRef<TopologyDataModelDepicted>

用于确定资源是否由这个模型描述的 getter。

getDataModelReconciler

CodeRef<TopologyDataModelReconciler>

在所有扩展模型加载后用于协调数据模型的功能。

console.topology/decorator/provider

拓扑声明器供应商扩展

Expand
Name值类型选填描述

id

string

 

priority

number

 

quadrant

TopologyQuadrant

 

decorator

CodeRef<TopologyDecoratorGetter>

 
console.topology/details/resource-alert

DetailsResourceAlert 为特定拓扑上下文或图形元素贡献警报。

Expand
Name值类型选填描述

id

string

此警报的 ID。用于保存状态,如果警报在丢弃后不应显示。

contentProvider

'codeRef< (element: GraphElement) HEKETI DetailsResourceAlertContent

null>`

DetailsResourceLink 为特定拓扑上下文或图形元素贡献一个链接。

Expand
Name值类型选填描述

link

'codeRef< (element: GraphElement) React React.Component

undefined>`

如果提供,则返回资源链接,否则未定义。将 ResourceIconResourceLink 属性用于风格。

priority

number

console.topology/details/tab

DetailsTab 为拓扑详情面板提供标签页。

Expand
Name值类型选填描述

id

string

此详细信息标签的唯一标识符。

label

string

要在 UI 中显示的标签标签。

insertBefore

string | string[]

在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。

insertAfter

string | string[]

在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。insertBefore 值具有优先权。

console.topology/details/tab-section

DetailsTabSection 对拓扑详情面板中的特定标签页贡献了一个部分。

Expand
Name值类型选填描述

id

string

此详细信息选项卡部分的唯一标识符。

tab

string

本节应贡献的父选项卡 ID。

provider

CodeRef<DetailsTabSectionExtensionHook>

返回一个组件,或者在拓扑侧边栏中显示 null 或未定义的 hook:<Section title=\{}>…​ padded area

'codeRef< (element: GraphElement, renderNull?: () demonstrates null)MERGE React.Component

undefined>`

如果未定义提供程序,则 @deprecated Fallback。renderNull 属于 no-op。

insertBefore

string | string[]

在引用 here.For 数组的项目前插入此项目,使用第一个按顺序找到的项目。

insertAfter

string | string[]

console.topology/display/filters

拓扑显示过滤器扩展

Expand
Name值类型选填描述

getTopologyFilters

CodeRef<() ⇒ TopologyDisplayOption[]>

 

applyDisplayOptions

CodeRef<TopologyApplyDisplayOptions>

 
console.topology/relationship/provider

拓扑关系供应商连接器扩展

Expand
Name值类型选填描述

provides

CodeRef<RelationshipProviderProvides>

 

工具提示

string

 

create

CodeRef<RelationshipProviderCreate>

 

priority

number

 
console.user-preference/group
Expand
Name值类型选填描述

id

string

用于识别用户首选项组的 ID。

label

string

用户首选项组的标签

insertBefore

string

应该放置此组前的用户首选项组群 ID

insertAfter

string

应该放置此组的用户首选项组群 ID

console.user-preference/item
Expand
Name值类型选填描述

id

string

ID 用于识别用户首选项项目,并在 insertAfter 和 insertBefore 中引用来定义项目顺序。

label

string

用户首选项的标签

description

string

用户首选项的描述。

field

UserPreferenceField

用于呈现值设定用户首选项的输入字段选项。

groupId

string

用于识别项目所属的用户首选项组的 ID。

insertBefore

string

应放置此项目前的用户首选项项目 ID

insertAfter

string

用户首选项项目的 ID,之后应放置此项目

console.yaml-template

通过 yaml 编辑器编辑资源的 YAML 模板。

Expand
Name值类型选填描述

model

ExtensionK8sModel

与模板关联的模型。

模板

CodeRef<string>

YAML 模板。

name

string

模板的名称。使用名称 default 将其标记为默认模板。

dev-console.add/action
Expand
Name值类型选填描述

id

string

用于识别操作的 ID。

label

string

操作的标签

description

string

操作的描述。

href

string

要导航到的 href。

groupId

string

用于识别该操作所属的操作组的 ID。

icon

CodeRef<React.ReactNode>

视角显示图标。

accessReview

AccessReviewResourceAttributes[]

可选访问查看来控制操作的可见性或启用。

dev-console.add/action-group
Expand
Name值类型选填描述

id

string

用于识别操作组的 ID。

name

string

操作组的标题

insertBefore

string

应该放置此组的操作组群 ID

insertAfter

string

应该放置此组的操作组群 ID

dev-console.import/environment
Expand
Name值类型选填描述

imageStreamName

string

为提供自定义环境变量的镜像流名称

imageStreamTags

string[]

支持的镜像流标签列表

environments

ImageEnvironment[]

环境变量列表

console.page/resource/tab

已弃用。使用 console.tab/horizontalNav 替代。添加新资源选项卡页面到控制台路由器。

Expand
Name值类型选填描述

model

ExtensionK8sGroupKindModel

此资源页面链接到的型号。

component

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

路由匹配时要呈现的组件。

name

string

选项卡的名称。

href

string

选项卡链接的可选 href。如果没有提供,则使用第一个 path

exact

布尔值

为 true 时,只有在路径与 location.pathname 完全匹配时才会匹配。

Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

关于红帽文档

Legal Notice

Theme

© 2026 Red Hat
返回顶部