7.5. 动态插件参考

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

7.5.1. 动态插件扩展类型

7.5.1.1. `console.action/filter`

7.5.1.1.1. 概述

ActionFilter 可用于过滤操作。

7.5.1.1.2. Properties

Name	值类型	选填	描述
`contextId`	`string`	否	上下文 ID 有助于将贡献操作的范围缩小到应用的特定区域。示例包括 `topology` 和 `helm`。
`filter`	`CodeRef<(scope: any, action: Action) ⇒ boolean>`	否	将根据某些条件过滤操作的功能。`scope`：为其提供操作的范围。如果要使用 Pod 横向自动扩展 (HPA) 从部署中删除 `ModifyCount` 操作，则可能需要 hook。

7.5.1.2. `console.action/group`

7.5.1.2.1. 概述

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

7.5.1.2.2. Properties

Name	值类型	选填	描述
`id`	`string`	否	用于识别操作部分的 ID。
`label`	`string`	是	UI 中显示的标签。子菜单是必需的。
`submenu`	`布尔值`	是	此组是否应显示为子菜单。
`insertBefore`	`string` \| `string[]`	是	在此处引用的项目前插入此项。对于数组，使用按顺序找到的第一个。
`insertAfter`	`string` \| `string[]`	是	在此处引用的项目后插入此项。对于数组，使用按顺序找到的第一个。`insertBefore` 值具有优先权。

7.5.1.3. `console.action/provider`

7.5.1.3.1. 概述

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

7.5.1.3.2. Properties

Name	值类型	选填	描述
`contextId`	`string`	否	上下文 ID 有助于将贡献操作的范围缩小到应用的特定区域。示例包括 `topology` 和 `helm`。
`provider`	`CodeRef<ExtensionHook<Action[], any>>`	否	一个 React hook，用于返回给定范围的操作。如果 `contextId` = `resource`，则范围始终为 Kubernetes 资源对象。

7.5.1.4. `console.action/resource-provider`

7.5.1.4.1. 概述

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

7.5.1.4.2. Properties

Name	值类型	选填	描述
`model`	`ExtensionK8sKindVersionModel`	否	此提供程序提供操作的模型。
`provider`	`CodeRef<ExtensionHook<Action[], any>>`	否	反应 hook，它返回给定资源模型的操作

7.5.1.5. `console.alert-action`

7.5.1.5.1. 概述

（不可用）

7.5.1.5.2. Properties

Name	值类型	选填
`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. Properties

Name	值类型	选填	描述
`catalogId`	`string` \| `string[]`	否	此提供程序参与的目录的唯一标识符。
`type`	`string`	否	目录项目类型的类型 ID。
`filter`	`CodeRef<(item: CatalogItem) ⇒ boolean>`	否	过滤特定类型的项目。值是采用 `CatalogItem[]` 且根据过滤器标准返回子集的功能。

7.5.1.7. `console.catalog/item-metadata`

7.5.1.7.1. 概述

（不可用）

7.5.1.7.2. Properties

Name	值类型	选填	描述
`catalogId`	`string` \| `string[]`	否	此提供程序参与的目录的唯一标识符。
`type`	`string`	否	目录项目类型的类型 ID。
`provider`	`CodeRef<ExtensionHook<CatalogItemMetadataProviderFunction, CatalogExtensionHookOptions>>`	否	返回一个将用来向特定类型的目录项提供元数据的 hook。

7.5.1.8. `console.catalog/item-provider`

7.5.1.8.1. 概述

（不可用）

7.5.1.8.2. Properties

Name	值类型	选填	描述
`catalogId`	`string` \| `string[]`	否	此提供程序参与的目录的唯一标识符。
`type`	`string`	否	目录项目类型的类型 ID。
`title`	`string`	否	目录项提供程序的标题
`provider`	`CodeRef<ExtensionHook<CatalogItem<any>[], CatalogExtensionHookOptions>>`	否	为目录获取项目并进行规范化。值是对 hook 做出反应。
`priority`	`number`	是	此提供程序的优先级。默认值为 `0`。优先级更高的提供程序可能会覆盖由其他供应商提供的目录项。

7.5.1.9. `console.catalog/item-type`

7.5.1.9.1. 概述

（不可用）

7.5.1.9.2. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`component`	`CodeRef<React.ComponentType<{}>>`	否	要呈现的组件。

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

7.5.1.12.1. 概述

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

7.5.1.12.2. Properties

Name	值类型	选填	描述
`title`	`string`	否	使用项目的标题。
`getUtilizationQueries`	`CodeRef<GetMultilineQueries>`	否	Prometheus 使用率查询。
`humanize`	`CodeRef<Humanize>`	否	将 Prometheus 数据转换为人类可读形式。
`TopConsumerPopovers`	`CodeRef<React.ComponentType<TopConsumerPopoverProps>[]>`	是	显示顶部消费者弹出而不是普通值

7.5.1.13. `console.cluster-overview/utilization-item`

7.5.1.13.1. 概述

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

7.5.1.13.2. Properties

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>>`	是	显示顶部消费者弹出而不是普通值

7.5.1.14. `console.context-provider`

7.5.1.14.1. 概述

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

7.5.1.14.2. Properties

Name	值类型	选填	描述
`provider`	`CodeRef<Provider<T>>`	否	上下文提供程序组件。
`useValueHook`	`CodeRef<() ⇒ T>`	否	上下文值的 hook。

7.5.1.15. `console.dashboards/card`

7.5.1.15.1. 概述

添加新的仪表板卡。

7.5.1.15.2. Properties

Name	值类型	选填	描述
`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. 概述

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

7.5.1.16.2. Properties

Name	值类型	选填	描述
`k8sResource`	`CodeRef<FirehoseResource & { isList: true; }>`	否	要替换的 utilization 项。
`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. 概述

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

7.5.1.17.2. Properties

Name	值类型	选填	描述
`component`	`CodeRef<React.ComponentType<{}>>`	否	基于 `DetailItem` 组件的值

7.5.1.18. `console.dashboards/overview/health/operator`

7.5.1.18.1. 概述

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

7.5.1.18.2. Properties

Name	值类型	选填	描述
`title`	`string`	否	弹出菜单中的 Operators 部分的标题。
`资源`	`CodeRef<FirehoseResource[]>`	否	将获取并传递给 `healthHandler` 的 Kubernetes 资源。
`getOperatorsWithStatuses`	`CodeRef<GetOperatorsWithStatuses<T>>`	是	解析 Operator 的状态。
`operatorRowLoader`	`CodeRef<React.ComponentType<OperatorRowProps<T>>>`	是	弹出行组件的加载程序。
`viewAllLink`	`string`	是	链接到所有资源页面。如果没有提供，则使用资源 prop 中第一个资源的列表页面。

7.5.1.19. `console.dashboards/overview/health/prometheus`

7.5.1.19.1. 概述

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

7.5.1.19.2. Properties

Name	值类型	选填	描述
`title`	`string`	否	子系统的显示名称。
`queries`	`string[]`	否	Prometheus 查询
`healthHandler`	`CodeRef<PrometheusHealthHandler>`	否	解决子系统的健康状况。
`additionalResource`	`CodeRef<FirehoseResource>`	是	将获取并传递给 `healthHandler` 的其他资源。
`popupComponent`	`CodeRef<React.ComponentType<PrometheusHealthPopupProps>>`	是	弹出式菜单内容的加载程序。如果定义，健康项表示为链接，它会打开一个带有给定内容的弹出窗口。
`popupTitle`	`string`	是	弹出的标题。
`disallowedControlPlaneTopology`	`string[]`	是	应该隐藏子系统的 control plane 拓扑。

7.5.1.20. `console.dashboards/overview/health/resource`

7.5.1.20.1. 概述

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

7.5.1.20.2. Properties

Name	值类型	选填	描述
`title`	`string`	否	子系统的显示名称。
`资源`	`CodeRef<WatchK8sResources<T>>`	否	将获取并传递给 `healthHandler` 的 Kubernetes 资源。
`healthHandler`	`CodeRef<ResourceHealthHandler<T>>`	否	解决子系统的健康状况。
`popupComponent`	`CodeRef<WatchK8sResults<T>>`	是	弹出式菜单内容的加载程序。如果定义，健康项表示为链接，它会打开一个带有给定内容的弹出窗口。
`popupTitle`	`string`	是	弹出的标题。

7.5.1.21. `console.dashboards/overview/health/url`

7.5.1.21.1. 概述

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

7.5.1.21.2. Properties

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

7.5.1.22. `console.dashboards/overview/inventory/item`

7.5.1.22.1. 概述

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

7.5.1.22.2. Properties

Name	值类型	选填	描述
`model`	`CodeRef<T>`	否	将获取的`资源`模型。用于获取模型的 `label` 或 `abbr`。
`mapper`	`CodeRef<StatusGroupMapper<T, R>>`	是	将各种状态映射到组的功能。
`additionalResources`	`CodeRef<WatchK8sResources<R>>`	是	将获取并传递给`映射程序`函数的其他资源。

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

7.5.1.23.1. 概述

添加清单状态组。

7.5.1.23.2. Properties

Name	值类型	选填	描述
`id`	`string`	否	状态组的 id。
`icon`	`CodeRef<React.ReactElement<any, string` \| `React.JSXElementConstructor<any>>>`	否	响应代表状态组图标的组件。

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

7.5.1.24.1. 概述

替换概述清单卡。

7.5.1.24.2. Properties

Name	值类型	选填	描述
`model`	`CodeRef<T>`	否	将获取的`资源`模型。用于获取模型的 `label` 或 `abbr`。
`mapper`	`CodeRef<StatusGroupMapper<T, R>>`	是	将各种状态映射到组的功能。
`additionalResources`	`CodeRef<WatchK8sResources<R>>`	是	将获取并传递给`映射程序`函数的其他资源。

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

7.5.1.25.1. 概述

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

7.5.1.25.2. Properties

Name	值类型	选填	描述
`queries`	`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. Properties

Name	值类型	选填	描述
`model`	`CodeRef<T>`	否	将获取的`资源`模型。用于获取模型的 `label` 或 `abbr`。
`mapper`	`CodeRef<StatusGroupMapper<T, R>>`	是	将各种状态映射到组的功能。
`additionalResources`	`CodeRef<WatchK8sResources<R>>`	是	将获取并传递给`映射程序`函数的其他资源。

7.5.1.27. `console.dashboards/tab`

7.5.1.27.1. 概述

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

7.5.1.27.2. Properties

Name	值类型	选填	描述
`id`	`string`	否	唯一标签页标识符，用作标签链接 `href` 以及在此标签页中添加卡时。
`navSection`	`'home' \| 'storage'`	否	选项卡所属的导航部分。
`title`	`string`	否	选项卡的标题。

7.5.1.28. `console.file-upload`

7.5.1.28.1. 概述

（不可用）

7.5.1.28.2. Properties

Name	值类型	选填	描述
`fileExtensions`	`string[]`	否	支持的文件扩展。
`handler`	`CodeRef<FileUploadHandler>`	否	处理文件丢弃操作的功能。

7.5.1.29. `console.flag`

7.5.1.29.1. 概述

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

7.5.1.29.2. Properties

Name	值类型	选填	描述
`handler`	`CodeRef<FeatureFlagHandler>`	否	用于设置或取消设置任意功能标记。

7.5.1.30. `console.flag/hookProvider`

7.5.1.30.1. 概述

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

7.5.1.30.2. Properties

Name	值类型	选填	描述
`handler`	`CodeRef<FeatureFlagHandler>`	否	用于设置或取消设置任意功能标记。

7.5.1.31. `console.flag/model`

7.5.1.31.1. 概述

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

7.5.1.31.2. Properties

Name	值类型	选填	描述
`flag`	`string`	否	在检测到 CRD 后设置的标记名称。
`model`	`ExtensionK8sModel`	否	引用 `CustomResourceDefinition` 的模型。

7.5.1.32. `console.global-config`

7.5.1.32.1. 概述

（不可用）

7.5.1.32.2. Properties

Name	值类型	选填	描述
`id`	`string`	否	集群配置资源实例的唯一标识符。
`name`	`string`	否	集群配置资源实例的名称。
`model`	`ExtensionK8sModel`	否	指代集群配置资源的模型。
`namespace`	`string`	否	集群配置资源实例的命名空间。

7.5.1.33. `console.model-metadata`

7.5.1.33.1. 概述

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

7.5.1.33.2. Properties

Name	值类型	选填	描述
`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. Properties

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` 添加到起始位置

7.5.1.35. `console.navigation/resource-cluster`

7.5.1.35.1. 概述

（不可用）

7.5.1.35.2. Properties

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`	是	覆盖默认名称。如果没有提供链接的名称，则会与模型的复数值相同。

7.5.1.36. `console.navigation/resource-ns`

7.5.1.36.1. 概述

（不可用）

7.5.1.36.2. Properties

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`	是	覆盖默认名称。如果没有提供链接的名称，则会与模型的复数值相同。

7.5.1.37. `console.navigation/section`

7.5.1.37.1. 概述

（不可用）

7.5.1.37.2. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`id`	`string`	否	此项目的唯一标识符。
`perspective`	`string`	是	此项目所属的视角 ID。若未指定，则向默认视角。
`节`	`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. 概述

在 Web 控制台路由器中添加一个新的资源详情页面。

7.5.1.39.2. Properties

Name	值类型	选填	描述
`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. 概述

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

7.5.1.40.2. Properties

Name	值类型	选填	描述
`model`	`ExtensionK8sGroupKindModel`	否	此资源页面链接到的型号。
`component`	`CodeRef<React.ComponentType<{ match: match<{}>; namespace: string; model: ExtensionK8sModel; }>>`	否	路由匹配时要呈现的组件。

7.5.1.41. `console.page/route`

7.5.1.41.1. 概述

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

7.5.1.41.2. Properties

Name	值类型	选填	描述
`component`	`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`	否	路由匹配时要呈现的组件。
`path`	`string` \| `string[]`	否	`path-to-regexp@^1.7.0` 可以理解的有效 URL 路径或路径数组。
`perspective`	`string`	是	此页面所属的视图。如果没有指定，则会对所有视角贡献。
`exact`	`布尔值`	是	为 true 时，只有在路径与 `location.pathname` 完全匹配时才会匹配。

7.5.1.42. `console.page/route/standalone`

7.5.1.42.1. 概述

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

7.5.1.42.2. Properties

Name	值类型	选填	描述
`component`	`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`	否	路由匹配时要呈现的组件。
`path`	`string` \| `string[]`	否	`path-to-regexp@^1.7.0` 可以理解的有效 URL 路径或路径数组。
`exact`	`布尔值`	是	为 true 时，只有在路径与 `location.pathname` 完全匹配时才会匹配。

7.5.1.43. `console.perspective`

7.5.1.43.1. 概述

（不可用）

7.5.1.43.2. Properties

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

7.5.1.44. `console.project-overview/inventory-item`

7.5.1.44.1. 概述

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

7.5.1.44.2. Properties

Name	值类型	选填	描述
`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. Properties

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 弹出窗而不是纯值。

7.5.1.46. `console.pvc/alert`

7.5.1.46.1. 概述

（不可用）

7.5.1.46.2. Properties

Name	值类型	选填	描述
`alert`	`CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>`	否	警报组件。

7.5.1.47. `console.pvc/create-prop`

7.5.1.47.1. 概述

（不可用）

7.5.1.47.2. Properties

Name	值类型	选填	描述
`label`	`string`	否	创建 prop 操作的标签。
`path`	`string`	否	创建 prop 操作的路径。

7.5.1.48. `console.pvc/delete`

7.5.1.48.1. 概述

（不可用）

7.5.1.48.2. Properties

Name	值类型	选填	描述
`predicate`	`CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>`	否	告知是否使用扩展名的 predicate。
`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. Properties

Name	值类型	选填	描述
`priority`	`number`	否	状态组件的优先级。较大的值代表优先级更高。
`status`	`CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>`	否	状态组件。
`predicate`	`CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>`	否	指示是否呈现状态组件的 predicate。

7.5.1.50. `console.redux-reducer`

7.5.1.50.1. 概述

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

7.5.1.50.2. Properties

Name	值类型	选填	描述
`scope`	`string`	否	代表 Red Hatux 状态对象中减少管理的子状态的关键。
`reducer`	`CodeRef<Reducer<any, AnyAction>>`	否	reducer 函数，在 reducer-managed substate 中操作。

7.5.1.51. `console.resource/create`

7.5.1.51.1. 概述

（不可用）

7.5.1.51.2. Properties

Name	值类型	选填	描述
`model`	`ExtensionK8sModel`	否	此创建资源页面将呈现的型号。
`component`	`CodeRef<React.ComponentType<CreateResourceComponentProps>>`	否	当模型匹配时要呈现的组件

7.5.1.52. `console.storage-provider`

7.5.1.52.1. 概述

（不可用）

7.5.1.52.2. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`listener`	`CodeRef<TelemetryEventListener>`	否	侦听遥测事件

7.5.1.55. `console.topology/adapter/build`

7.5.1.55.1. 概述

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

7.5.1.55.2. Properties

Name	值类型	选填	描述
`adapt`	'CodeRef< (element: GraphElement) jpeg AdapterDataType<BuildConfigData>	undefined>`	否

7.5.1.56. `console.topology/adapter/network`

7.5.1.56.1. 概述

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

7.5.1.56.2. Properties

Name	值类型	选填	描述
`adapt`	'CodeRef< (element: GraphElement) jpeg NetworkAdapterType	undefined>`	否

7.5.1.57. `console.topology/adapter/pod`

7.5.1.57.1. 概述

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

7.5.1.57.2. Properties

Name	值类型	选填	描述
`adapt`	'CodeRef< (element: GraphElement) jpeg AdapterDataType<PodsAdapterDataType>	undefined>`	否

7.5.1.58. `console.topology/component/factory`

7.5.1.58.1. 概述

ViewComponentFactory 的 getter。

7.5.1.58.2. Properties

Name	值类型	选填	描述
`getFactory`	`CodeRef<ViewComponentFactory>`	否	`ViewComponentFactory` 的 getter。

7.5.1.59. `console.topology/create/connector`

7.5.1.59.1. 概述

创建连接器功能的 getter。

7.5.1.59.2. Properties

Name	值类型	选填	描述
`getCreateConnector`	`CodeRef<CreateConnectionGetter>`	否	创建连接器功能的 getter。

7.5.1.60. `console.topology/data/factory`

7.5.1.60.1. 概述

拓扑数据模型工厂扩展

7.5.1.60.2. Properties

Name	值类型	选填	描述
`id`	`string`	否	工厂的唯一 ID。
`priority`	`number`	否	工厂的优先级
`资源`	`WatchK8sResourcesGeneric`	是	要从 useK8sWatchResources hook 获取的资源。
`workloadKeys`	`string[]`	是	包含工作负载的资源中的密钥。
`getDataModel`	`CodeRef<TopologyDataModelGetter>`	是	数据模型工厂的 getter。
`isResourceDepicted`	`CodeRef<TopologyDataModelDepicted>`	是	用于确定资源是否由这个模型描述的 getter。
`getDataModelReconciler`	`CodeRef<TopologyDataModelReconciler>`	是	在所有扩展模型加载后用于协调数据模型的功能。

7.5.1.61. `console.topology/decorator/provider`

7.5.1.61.1. 概述

拓扑声明器供应商扩展

7.5.1.61.2. Properties

Name	值类型	选填
`id`	`string`	否
`priority`	`number`	否
`quadrant`	`TopologyQuadrant`	否
`decorator`	`CodeRef<TopologyDecoratorGetter>`	否

7.5.1.62. `console.topology/details/resource-alert`

7.5.1.62.1. 概述

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

7.5.1.62.2. Properties

Name	值类型	选填	描述
`id`	`string`	否	此警报的 ID。用于保存状态，如果警报在丢弃后不应显示。
`contentProvider`	'CodeRef< (element: GraphElement) jpeg DetailsResourceAlertContent	null>`	否

7.5.1.63. `console.topology/details/resource-link`

7.5.1.63.1. 概述

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

7.5.1.63.2. Properties

Name	值类型	选填	描述
`link`	'CodeRef< (element: GraphElement) jpeg React.Component	undefined>`	否
如果提供，则返回资源链接，否则未定义。将 `ResourceIcon` 和 `ResourceLink` 属性用于风格。	`priority`	`number`	是

7.5.1.64. `console.topology/details/tab`

7.5.1.64.1. 概述

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

7.5.1.64.2. Properties

Name	值类型	选填	描述
`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. 概述

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

7.5.1.65.2. Properties

Name	值类型	选填	描述
`id`	`string`	否	此详细信息选项卡部分的唯一标识符。
`tab`	`string`	否	本节应贡献的父选项卡 ID。
`provider`	`CodeRef<DetailsTabSectionExtensionHook>`	否	返回一个组件，或者在拓扑侧边栏中显示 null 或未定义的 hook：<Section title=\{}>… padded area
`节`	'CodeRef< (element: GraphElement, renderNull?: （) especially null）TOKEN React.Component	undefined>`	否
如果未定义提供程序，则 @deprecated Fallback。renderNull 属于 no-op。	`insertBefore`	`string` \| `string[]`	是
在引用 here.For 数组的项目前插入此项目，使用第一个按顺序找到的项目。	`insertAfter`	`string` \| `string[]`	是

7.5.1.66. `console.topology/display/filters`

7.5.1.66.1. 概述

拓扑显示过滤器扩展

7.5.1.66.2. Properties

Name	值类型	选填	描述
`getTopologyFilters`	`CodeRef<() ⇒ TopologyDisplayOption[]>`	否
`applyDisplayOptions`	`CodeRef<TopologyApplyDisplayOptions>`	否

7.5.1.67. `console.topology/relationship/provider`

7.5.1.67.1. 概述

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

7.5.1.67.2. Properties

Name	值类型	选填
`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. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`id`	`string`	否	ID 用于识别用户首选项项目，并在 insertAfter 和 insertBefore 中引用来定义项目顺序。
`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. Properties

Name	值类型	选填	描述
`model`	`ExtensionK8sModel`	否	与模板关联的模型。
`模板`	`CodeRef<string>`	否	YAML 模板。
`name`	`string`	否	模板的名称。使用名称 `default` 将其标记为默认模板。

7.5.1.71. `dev-console.add/action`

7.5.1.71.1. 概述

（不可用）

7.5.1.71.2. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`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. Properties

Name	值类型	选填	描述
`imageStreamName`	`string`	否	为提供自定义环境变量的镜像流名称
`imageStreamTags`	`string[]`	否	支持的镜像流标签列表
`environments`	`ImageEnvironment[]`	否	环境变量列表

7.5.1.74. `console.page/resource/tab`

7.5.1.74.1. Summary [DEPRECATED]

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

7.5.1.74.2. Properties

Name	值类型	选填	描述
`model`	`ExtensionK8sGroupKindModel`	否	此资源页面链接到的型号。
`component`	`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`	否	路由匹配时要呈现的组件。
`name`	`string`	否	选项卡的名称。
`href`	`string`	是	选项卡链接的可选 href。如果没有提供，则使用第一个 `path`。
`exact`	`布尔值`	是	为 true 时，只有在路径与 `location.pathname` 完全匹配时才会匹配。

7.5.2. 对动态插件进行故障排除

如果您在加载插件时遇到问题，请参阅此故障排除提示列表。

运行以下命令，在控制台 Operator 配置中启用了插件，并且您的插件名称是输出：
```
$ oc get console.operator.openshift.io cluster -o jsonpath='{.spec.plugins}'
```
- 在 Administrator 视角中的 Overview 页面的状态卡中验证已启用的插件。如果插件最近启用，您必须刷新浏览器。
通过以下方法验证您的插件服务是否健康：
- 验证您的插件 pod 状态正在运行，容器已就绪。
- 验证服务标签选择器与 pod 和目标端口匹配是否正确。
- 在控制台 pod 或集群中的另一个 pod 终端中，使用带有来自服务的 plugin-manifest.json 的 curl 命令。
验证 ConsolePlugin 资源名称 (consolePlugin.name) 与 package.json 中使用的插件名称匹配。
在 ConsolePlugin 资源中验证您的服务名称、命名空间、端口和路径是否已正确声明。
验证您的插件服务使用 HTTPS 和服务证书。
验证控制台 pod 日志中是否有证书或连接错误。
验证插件依赖的功能标志没有被禁用。
验证您的插件没有在 package.json 中不满足 consolePlugin.dependencies 的问题。
- 这包括控制台版本依赖项或依赖其他插件。在浏览器中为您的插件的名称过滤 JS 控制台，以查看日志记录的消息。
验证导航扩展视角或部分 ID 中没有拼写错误。
- 您的插件可能会被加载，但如果 ID 不正确，可以缺少导航项。编辑 URL 尝试直接导航到插件页面。
验证没有网络策略阻止从控制台 Pod 到插件服务的流量。
- 如有必要，调整网络策略，以允许 openshift-console 命名空间中的控制台 pod 向服务发出请求。
在开发人员工具浏览器的 Console 选项卡中，验证要在浏览器中载入的动态插件列表。
- 评估 window.SERVER_FLAGS.consolePlugins，以查看 Console 前端的动态插件。

其他资源

了解服务用证书

7.5. 动态插件参考

7.5.1. 动态插件扩展类型

7.5.1.1. console.action/filter

7.5.1.1.1. 概述

7.5.1.1.2. Properties

7.5.1.2. console.action/group

7.5.1.2.1. 概述

7.5.1.2.2. Properties

7.5.1.3. console.action/provider

7.5.1.3.1. 概述

7.5.1.3.2. Properties

7.5.1.4. console.action/resource-provider

7.5.1.4.1. 概述

7.5.1.4.2. Properties

7.5.1.5. console.alert-action

7.5.1.5.1. 概述

7.5.1.5.2. Properties

7.5.1.6. console.catalog/item-filter

7.5.1.6.1. 概述

7.5.1.6.2. Properties

7.5.1.7. console.catalog/item-metadata

7.5.1.7.1. 概述

7.5.1.7.2. Properties

7.5.1.8. console.catalog/item-provider

7.5.1.8.1. 概述

7.5.1.8.2. Properties

7.5.1.9. console.catalog/item-type

7.5.1.9.1. 概述

7.5.1.9.2. Properties

7.5.1.10. console.catalog/item-type-metadata

7.5.1.10.1. 概述

7.5.1.10.2. Properties

7.5.1.11. console.cluster-overview/inventory-item

7.5.1.11.1. 概述

7.5.1.11.2. Properties

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

7.5.1.12.1. 概述

7.5.1.12.2. Properties

7.5.1.13. console.cluster-overview/utilization-item

7.5.1.13.1. 概述

7.5.1.13.2. Properties

7.5.1.14. console.context-provider

7.5.1.14.1. 概述

7.5.1.14.2. Properties

7.5.1.15. console.dashboards/card

7.5.1.15.1. 概述

7.5.1.15.2. Properties

7.5.1.16. console.dashboards/overview/activity/resource

7.5.1.16.1. 概述

7.5.1.16.2. Properties

7.5.1.17. console.dashboards/overview/detail/item

7.5.1.17.1. 概述

7.5.1.17.2. Properties

7.5.1.18. console.dashboards/overview/health/operator

7.5.1.18.1. 概述

7.5.1.18.2. Properties

7.5.1.19. console.dashboards/overview/health/prometheus

7.5.1.19.1. 概述

7.5.1.19.2. Properties

7.5.1.20. console.dashboards/overview/health/resource

7.5.1.20.1. 概述

7.5.1.20.2. Properties

7.5.1.21. console.dashboards/overview/health/url

7.5.1.21.1. 概述

7.5.1.21.2. Properties

7.5.1.22. console.dashboards/overview/inventory/item

7.5.1.22.1. 概述

7.5.1.22.2. Properties

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

7.5.1.23.1. 概述

7.5.1.23.2. Properties

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

7.5.1.24.1. 概述

7.5.1.24.2. Properties

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

7.5.1.25.1. 概述

7.5.1.25.2. Properties

7.5.1.26. console.dashboards/project/overview/item

7.5.1.26.1. 概述

7.5.1.26.2. Properties

7.5.1.1. `console.action/filter`

7.5.1.2. `console.action/group`

7.5.1.3. `console.action/provider`

7.5.1.4. `console.action/resource-provider`

7.5.1.5. `console.alert-action`

7.5.1.6. `console.catalog/item-filter`

7.5.1.7. `console.catalog/item-metadata`

7.5.1.8. `console.catalog/item-provider`

7.5.1.9. `console.catalog/item-type`

7.5.1.10. `console.catalog/item-type-metadata`

7.5.1.11. `console.cluster-overview/inventory-item`

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

7.5.1.13. `console.cluster-overview/utilization-item`

7.5.1.14. `console.context-provider`

7.5.1.15. `console.dashboards/card`

7.5.1.16. `console.dashboards/overview/activity/resource`

7.5.1.17. `console.dashboards/overview/detail/item`

7.5.1.18. `console.dashboards/overview/health/operator`

7.5.1.19. `console.dashboards/overview/health/prometheus`

7.5.1.20. `console.dashboards/overview/health/resource`

7.5.1.21. `console.dashboards/overview/health/url`

7.5.1.22. `console.dashboards/overview/inventory/item`

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

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

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

7.5.1.26. `console.dashboards/project/overview/item`

7.5.1.27. `console.dashboards/tab`

7.5.1.28. `console.file-upload`

7.5.1.29. `console.flag`

7.5.1.30. `console.flag/hookProvider`

7.5.1.31. `console.flag/model`

7.5.1.32. `console.global-config`

7.5.1.33. `console.model-metadata`

7.5.1.34. `console.navigation/href`

7.5.1.35. `console.navigation/resource-cluster`

7.5.1.36. `console.navigation/resource-ns`

7.5.1.37. `console.navigation/section`

7.5.1.38. `console.navigation/separator`

7.5.1.39. `console.page/resource/details`

7.5.1.40. `console.page/resource/list`

7.5.1.41. `console.page/route`

7.5.1.42. `console.page/route/standalone`

7.5.1.43. `console.perspective`

7.5.1.44. `console.project-overview/inventory-item`

7.5.1.45. `console.project-overview/utilization-item`

7.5.1.46. `console.pvc/alert`

7.5.1.47. `console.pvc/create-prop`

7.5.1.48. `console.pvc/delete`

7.5.1.49. `console.pvc/status`

7.5.1.50. `console.redux-reducer`