7.5. 动态插件参考

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

7.5.1. 动态插件扩展类型

`console.action/filter`

ActionFilter 可用于过滤操作。

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

`console.action/group`

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

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

`console.action/provider`

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

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

`console.action/resource-provider`

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

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

`console.alert-action`

Name	值类型	选填
`alert`	`string`	否
`text`	`string`	否
`action`	`CodeRef<(alert: any) ⇒ void>`	否

`console.catalog/item-filter`

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

`console.catalog/item-metadata`

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

`console.catalog/item-provider`

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

`console.catalog/item-type`

Name	值类型	选填	描述
`type`	`string`	否	目录项的类型。
`title`	`string`	否	目录项的标题。
`catalogDescription`	`string` \| `CodeRef<React.ReactNode>`	是	特定与目录类型的描述。
`typeDescription`	`string`	是	目录项类型的描述。
`filters`	`CatalogItemAttribute[]`	是	特定于目录项的自定义过滤器。
`groupings`	`CatalogItemAttribute[]`	是	特定于目录项的自定义分组。

`console.catalog/item-type-metadata`

Name	值类型	选填	描述
`type`	`string`	否	目录项的类型。
`filters`	`CatalogItemAttribute[]`	是	特定于目录项的自定义过滤器。
`groupings`	`CatalogItemAttribute[]`	是	特定于目录项的自定义分组。

`console.cluster-overview/inventory-item`

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

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

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

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

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

`console.cluster-overview/utilization-item`

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

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 上下文提供程序。

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

`console.dashboards/card`

添加新的仪表板卡。

Name	值类型	选填	描述
`tab`	`string`	否	将添加到卡的仪表板标签的 ID。
`position`	`'LEFT' \| 'RIGHT' \| 'MAIN'`	否	该卡在仪表板上的网格位置。
`component`	`CodeRef<React.ComponentType<{}>>`	否	仪表板卡组件。
`span`	`OverviewCardSpan`	是	栏中卡的垂直范围。对于小屏幕会忽略，默认为 `12`。

`console.dashboards/overview/activity/resource`

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

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 仪表板的详情卡中添加项目。

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

`console.dashboards/overview/health/operator`

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

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 仪表板的状态卡中添加一个健康子系统。

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 资源。

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。

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`

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

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

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

添加清单状态组。

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

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

替换概述清单卡。

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

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

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

Name	值类型	选填	描述
`queries`	`string[]`	否	要监视的查询
`component`	`CodeRef<React.ComponentType<PrometheusActivityProps>>`	否	操作组件。
`isActivity`	`CodeRef<(results: PrometheusResponse[]) ⇒ boolean>`	是	确定给定资源是否代表该操作的功能。如果没有定义，则每个资源都代表活动。

`console.dashboards/project/overview/item`

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

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

`console.dashboards/tab`

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

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

`console.file-upload`

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

`console.flag`

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

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

`console.flag/hookProvider`

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

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

`console.flag/model`

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

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

`console.global-config`

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

`console.model-metadata`

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

Name	值类型	选填	描述
`model`	`ExtensionK8sGroupModel`	否	要定制的模型。只能指定组或可选版本和类型。
`badge`	`ModelBadge`	是	是否将这个模型视为技术预览还是开发者预览。
`color`	`string`	是	与这个模型关联的颜色。
`label`	`string`	是	覆盖标签。需要提供的 `kind`。
`labelPlural`	`string`	是	覆盖复数标签。需要提供的 `kind`。
`abbr`	`string`	是	自定义缩写。默认为 `kind` 中的所有字符的大写，最多 4 个字符。需要 `kind` 提供。

`console.navigation/href`

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`

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`

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`

Name	值类型	选填	描述
`id`	`string`	否	此项目的唯一标识符。
`perspective`	`string`	是	此项目所属的视角 ID。若未指定，则向默认视角。
`dataAttributes`	`{ [key: string]: string; }`	是	在 DOM 中添加数据属性。
`insertBefore`	`string` \| `string[]`	是	在此处引用的项目前插入此项。对于数组，使用按顺序找到的第一个。
`insertAfter`	`string` \| `string[]`	是	在此处引用的项目后插入此项。对于数组，使用按顺序找到的第一个。`insertBefore` 具有高优先级。
`name`	`string`	是	本节的名称。如果没有提供，上面部分将仅显示一个分隔符。

`console.navigation/separator`

Name	值类型	选填	描述
`id`	`string`	否	此项目的唯一标识符。
`perspective`	`string`	是	此项目所属的视角 ID。若未指定，则向默认视角。
`节`	`string`	是	导航此项目所属的导航部分。如果未指定，请将此项目呈现为顶级链接。
`dataAttributes`	`{ [key: string]: string; }`	是	在 DOM 中添加数据属性。
`insertBefore`	`string` \| `string[]`	是	在此处引用的项目前插入此项。对于数组，使用按顺序找到的第一个。
`insertAfter`	`string` \| `string[]`	是	在此处引用的项目后插入此项。对于数组，使用按顺序找到的第一个。`insertBefore` 具有高优先级。

`console.page/resource/details`

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

`console.page/resource/list`

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

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

`console.page/route`

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

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。

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

`console.perspective`

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 页面中添加一个新清单项。

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

`console.project-overview/utilization-item`

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

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`

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

`console.pvc/create-prop`

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

`console.pvc/delete`

Name	值类型	选填	描述
`predicate`	`CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>`	否	告知是否使用扩展名的 predicate。
`onPVCKill`	`CodeRef<(pvc: K8sResourceCommon) ⇒ Promise<void>>`	否	PVC 删除操作的方法。
`alert`	`CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>`	否	警报组件以显示其他信息。

`console.pvc/status`

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

`console.redux-reducer`

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

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

`console.resource/create`

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

`console.storage-provider`

Name	值类型	选填	描述
`name`	`string`	否
`组件`	`CodeRef<React.ComponentType<Partial<RouteComponentProps<{}, StaticContext, any>>>>`	否

`console.tab/horizontalNav`

Name	值类型	选填	描述
`model`	`ExtensionK8sKindVersionModel`	否	此提供程序显示选项卡的型号。
`page`	`{ name: string; href: string; }`	否	要在水平标签页中显示的页面。它取标签名称作为名称，并且是 href 的选项卡
`component`	`CodeRef<React.ComponentType<PageComponentProps<K8sResourceCommon>>>`	否	路由匹配时要呈现的组件。

`console.telemetry/listener`

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

`console.topology/adapter/build`

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

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

`console.topology/adapter/network`

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

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

`console.topology/adapter/pod`

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

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

`console.topology/component/factory`

ViewComponentFactory 的 getter。

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

`console.topology/create/connector`

创建连接器功能的 getter。

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

`console.topology/data/factory`

拓扑数据模型工厂扩展

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`

拓扑声明器供应商扩展

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

`console.topology/details/resource-alert`

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

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

`console.topology/details/resource-link`

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

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

`console.topology/details/tab`

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

Name	值类型	选填	描述
`id`	`string`	否	此详细信息标签的唯一标识符。
`label`	`string`	否	要在 UI 中显示的标签标签。
`insertBefore`	`string` \| `string[]`	是	在此处引用的项目前插入此项。对于数组，使用按顺序找到的第一个。
`insertAfter`	`string` \| `string[]`	是	在此处引用的项目后插入此项。对于数组，使用按顺序找到的第一个。`insertBefore` 值具有优先权。

`console.topology/details/tab-section`

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

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`

拓扑显示过滤器扩展

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

`console.topology/relationship/provider`

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

Name	值类型	选填
`provides`	`CodeRef<RelationshipProviderProvides>`	否
`工具提示`	`string`	否
`create`	`CodeRef<RelationshipProviderCreate>`	否
`priority`	`number`	否

`console.user-preference/group`

Name	值类型	选填	描述
`id`	`string`	否	用于识别用户首选项组的 ID。
`label`	`string`	否	用户首选项组的标签
`insertBefore`	`string`	是	应该放置此组前的用户首选项组群 ID
`insertAfter`	`string`	是	应该放置此组的用户首选项组群 ID

`console.user-preference/item`

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 模板。

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

`dev-console.add/action`

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`

Name	值类型	选填	描述
`id`	`string`	否	用于识别操作组的 ID。
`名称`	`string`	否	操作组的标题
`insertBefore`	`string`	是	应该放置此组的操作组群 ID
`insertAfter`	`string`	是	应该放置此组的操作组群 ID

`dev-console.import/environment`

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

`console.page/resource/tab`

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

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

7.5.2. OpenShift Container Platform 控制台 API

`useActivePerspective`

提供用于设置活跃视角的 hook，以及用于设置活跃视角的回调。它返回一个包含当前活跃视角和 setter 回调的元组。

const Component: React.FC = (props) => {
   const [activePerspective, setActivePerspective] = useActivePerspective();
   return <select
     value={activePerspective}
     onChange={(e) => setActivePerspective(e.target.value)}
   >
     {
       // ...perspective options
     }
   </select>
}

`GreenCheckCircleIcon`

显示绿色勾号图标的组件。

<GreenCheckCircleIcon title="Healthy" />

参数名称	描述
`className`	（可选）组件的额外类名称
`title`	（可选）图标标题
`size`	（可选）图标大小：('sm', 'md', 'lg', 'xl')

`RedExclamationCircleIcon`

用于显示感叹号圆圈图标的组件。

<RedExclamationCircleIcon title="Failed" />

参数名称	描述
`className`	（可选）组件的额外类名称
`title`	（可选）图标标题
`size`	（可选）图标大小：('sm', 'md', 'lg', 'xl')

`YellowExclamationTriangleIcon`

用于显示一个黄色三角形感叹号图标的组件。

<YellowExclamationTriangleIcon title="Warning" />

参数名称	描述
`className`	（可选）组件的额外类名称
`title`	（可选）图标标题
`size`	（可选）图标大小：('sm', 'md', 'lg', 'xl')

`BlueInfoCircleIcon`

用于显示信息的蓝色圆圈图标的组件。

<BlueInfoCircleIcon title="Info" />

参数名称	描述
`className`	（可选）组件的额外类名称
`title`	（可选）图标标题
`size`	（可选）图标大小：('sm', 'md', 'lg', 'xl')

`ErrorStatus`

用于显示错误状态弹出的组件。

<ErrorStatus title={errorMsg} />

参数名称	描述
`title`	（可选）状态文本
`iconOnly`	（可选）如果为 true，则仅显示图标
`noTooltip`	（可选）如果为 true，则不会显示工具提示
`className`	（可选）组件的额外类名称
`popoverTitle`	（可选）弹出的标题

`InfoStatus`

用于显示信息状态弹出窗口的组件。

<InfoStatus title={infoMsg} />

参数名称	描述
`title`	（可选）状态文本
`iconOnly`	（可选）如果为 true，则仅显示图标
`noTooltip`	（可选）如果为 true，则不会显示工具提示
`className`	（可选）组件的额外类名称
`popoverTitle`	（可选）弹出的标题

`ProgressStatus`

显示进度状态弹出的组件。

<ProgressStatus title={progressMsg} />

参数名称	描述
`title`	（可选）状态文本
`iconOnly`	（可选）如果为 true，则仅显示图标
`noTooltip`	（可选）如果为 true，则不会显示工具提示
`className`	（可选）组件的额外类名称
`popoverTitle`	（可选）弹出的标题

`SuccessStatus`

用于显示成功状态弹出窗口的组件。

<SuccessStatus title={successMsg} />

参数名称	描述
`title`	（可选）状态文本
`iconOnly`	（可选）如果为 true，则仅显示图标
`noTooltip`	（可选）如果为 true，则不会显示工具提示
`className`	（可选）组件的额外类名称
`popoverTitle`	（可选）弹出的标题

`checkAccess`

提供有关用户对给定资源的访问权限的信息。它返回一个具有资源访问信息的对象。

参数名称	描述
`resourceAttributes`	访问查看的资源属性
`impersonate`	模拟详情

`useAccessReview`

hook，提供有关用户对给定资源的访问权限的信息。它返回一个带有 isAllowed 和 loading 值的数组。

参数名称	描述
`resourceAttributes`	访问查看的资源属性
`impersonate`	模拟详情

`useResolvedExtensions`

使用已解析的 CodeRef 属性为消耗控制台扩展做出反应 hook。此 hook 接受与 useExtensions hook 相同的参数，并返回自适应扩展实例列表，从而解析每个扩展属性中的所有代码引用。最初，hook 返回一个空数组。完成解析后，React 组件将重新渲染，使用 hook 返回已修改的扩展列表。当匹配扩展列表更改时，会重启解析。hook 将继续返回前面的结果，直到解析完成为止。hook 结果元素保证在重新方之间保持稳定。它返回一个包含已解析代码引用的自适应扩展实例列表的元组、指示解析是否完成的布尔值标志，以及在解析过程中检测到的错误列表。

const [navItemExtensions, navItemsResolved] = useResolvedExtensions<NavItem>(isNavItem);
// process adapted extensions and render your component

参数名称	描述
`typeGuards`	每个接受动态插件扩展作为参数的回调列表，并返回布尔值标记，指示扩展是否满足所需的类型限制

`HorizontalNav`

为页面创建导航栏的组件。- Routing 作为组件的一部分处理。- console.tab/horizontalNav 用于向任何横向导航添加额外内容。

const HomePage: React.FC = (props) => {
    const page = {
      href: '/home',
      name: 'Home',
      component: () => <>Home</>
    }
    return <HorizontalNav match={props.match} pages={[page]} />
}

参数名称	描述
`resource`	与这个 Navigation 关联的资源，对象为 K8sResourceCommon 类型
`pages`	页面对象数组
`match`	匹配 React Router 提供的对象

`VirtualizedTable`

创建虚拟化表的组件。

const MachineList: React.FC<MachineListProps> = (props) => {
  return (
    <VirtualizedTable<MachineKind>
     {...props}
     aria-label='Machines'
     columns={getMachineColumns}
     Row={getMachineTableRow}
    />
  );
}

参数名称	描述
`data`	表的数据
`loaded`	表示数据已加载的标记
`loadError`	如果问题载入数据，则错误对象
`columns`	列设置
`Row`	行设置
`unfilteredData`	没有过滤器的原始数据
`NoDataEmptyMsg`	（可选）没有数据空消息组件
`EmptyMsg`	（可选）空消息组件
`scrollNode`	（可选）处理滚动的功能
`label`	（可选）表的标签
`ariaLabel`	（可选）aria 标签
`gridBreakPoint`	调整用于响应的网格如何分隔
`onSelect`	（可选）处理表选择的功能
`rowData`	（可选）特定于行的数据

`TableData`

用于在表行中显示表数据的组件。

const PodRow: React.FC<RowProps<K8sResourceCommon>> = ({ obj, activeColumnIDs }) => {
  return (
    <>
      <TableData id={columns[0].id} activeColumnIDs={activeColumnIDs}>
        <ResourceLink kind="Pod" name={obj.metadata.name} namespace={obj.metadata.namespace} />
      </TableData>
      <TableData id={columns[1].id} activeColumnIDs={activeColumnIDs}>
        <ResourceLink kind="Namespace" name={obj.metadata.namespace} />
      </TableData>
    </>
  );
};

参数名称	描述
`id`	表的唯一 id
`activeColumnIDs`	active 列
`className`	（可选）风格的选项类名称

`useActiveColumns`

一个 hook，它提供了用户选择的 active TableColumns 列表。

  // See implementation for more details on TableColumn type
  const [activeColumns, userSettingsLoaded] = useActiveColumns({
    columns,
    showNamespaceOverride: false,
    columnManagementID,
  });
  return userSettingsAreLoaded ? <VirtualizedTable columns= {activeColumns} {...otherProps} /> : null

参数名称	描述
`options`	哪些作为键-值映射传递
``	\{TableColumn[]} options.columns - 所有可用 TableColumns 的数组
``	{boolean} [options.showNamespaceOverride] - （可选）如果为 true，则会包括命名空间列，而不考虑列管理选择
``	{string} [options.columnManagementID] - （可选）用于保留并检索列管理选择的唯一 id （用于从用户设置中和检索列管理选择）。通常是资源的 'group_verionkind' 字符串。

包含当前用户所选活跃列(options.columns 的子集)和布尔值标志，指示用户设置是否已加载。

`ListPageHeader`

用于生成页面标头的组件。

const exampleList: React.FC = () => {
  return (
    <>
      <ListPageHeader title="Example List Page"/>
    </>
  );
};

参数名称	描述
`title`	头标题
`helpText`	（可选） help 部分作为响应节点
`badge`	（可选）作为响应节点的徽标图标

`ListPageCreate`

用于为特定资源类型添加创建按钮的组件，它们会自动为该资源创建 YAML 生成链接。

const exampleList: React.FC<MyProps> = () => {
  return (
    <>
      <ListPageHeader title="Example Pod List Page"/>
        <ListPageCreate groupVersionKind="Pod">Create Pod</ListPageCreate>
      </ListPageHeader>
    </>
  );
};

参数名称	描述
`groupVersionKind`	要代表的资源组/版本/类型

`ListPageCreateLink`

用于创建样式链接的组件。

const exampleList: React.FC<MyProps> = () => {
 return (
  <>
   <ListPageHeader title="Example Pod List Page"/>
      <ListPageCreateLink to={'/link/to/my/page'}>Create Item</ListPageCreateLink>
   </ListPageHeader>
  </>
 );
};

参数名称	描述
`至`	链接应连接到的字符串位置
`createAccessReview`	（可选）用于决定访问的命名空间和 kind 的对象
`children`	（可选）组件的子项

`ListPageCreateButton`

创建按钮的组件。

const exampleList: React.FC<MyProps> = () => {
  return (
    <>
      <ListPageHeader title="Example Pod List Page"/>
        <ListPageCreateButton createAccessReview={access}>Create Pod</ListPageCreateButton>
      </ListPageHeader>
    </>
  );
};

参数名称	描述
`createAccessReview`	（可选）用于决定访问的命名空间和 kind 的对象
`pfButtonProps`	（可选） Patternfly Button props

`ListPageCreateDropdown`

创建权限检查嵌套的下拉菜单的组件。

const exampleList: React.FC<MyProps> = () => {
  const items = {
    SAVE: 'Save',
    DELETE: 'Delete',
  }
  return (
    <>
     <ListPageHeader title="Example Pod List Page"/>
       <ListPageCreateDropdown createAccessReview={access} items={items}>Actions</ListPageCreateDropdown>
     </ListPageHeader>
    </>
  );
};

参数名称	描述
`items`	Key:ReactNode 对，以便在组件下拉列表中显示
`onClick`	点下拉菜单项目的回调功能
`createAccessReview`	（可选）用于决定访问的命名空间和 kind 的对象
`children`	（可选）下拉菜单的子项

`ListPageFilter`

为列表页面生成过滤器的组件。

  // See implementation for more details on RowFilter and FilterValue types
  const [staticData, filteredData, onFilterChange] = useListPageFilter(
    data,
    rowFilters,
    staticFilters,
  );
  // ListPageFilter updates filter state based on user interaction and resulting filtered data can be rendered in an independent component.
  return (
    <>
      <ListPageHeader .../>
      <ListPagBody>
        <ListPageFilter data={staticData} onFilterChange={onFilterChange} />
        <List data={filteredData} />
      </ListPageBody>
    </>
  )

参数名称	描述
`data`	一个数据点的数组
`loaded`	表示数据已加载
`onFilterChange`	更新过滤器时的回调功能
`rowFilters`	（可选）定义可用过滤器选项的 RowFilter 元素的数组
`nameFilterPlaceholder`	（可选）名称过滤器的占位符
`labelFilterPlaceholder`	（可选）标签过滤器的占位符
`hideLabelFilter`	（可选）仅显示 name 过滤器，而不是 name 和 label 过滤器
`hideNameLabelFilter`	（可选）隐藏 name 和 label filter
`columnLayout`	（可选）列布局对象
`hideColumnManagement`	（可选）隐藏列管理的标记

`useListPageFilter`

管理 ListPageFilter 组件的过滤器状态的 hook。它返回一个 tuple，其中包含由所有静态过滤器过滤的数据、由所有静态和行过滤器过滤的数据，以及更新 rowFilters 的回调。

  // See implementation for more details on RowFilter and FilterValue types
  const [staticData, filteredData, onFilterChange] = useListPageFilter(
    data,
    rowFilters,
    staticFilters,
  );
  // ListPageFilter updates filter state based on user interaction and resulting filtered data can be rendered in an independent component.
  return (
    <>
      <ListPageHeader .../>
      <ListPagBody>
        <ListPageFilter data={staticData} onFilterChange={onFilterChange} />
        <List data={filteredData} />
      </ListPageBody>
    </>
  )

参数名称	描述
`data`	一个数据点的数组
`rowFilters`	（可选）定义可用过滤器选项的 RowFilter 元素的数组
`staticFilters`	（可选）静态应用到数据的 FilterValue 元素的数组

`ResourceLink`

创建指向带有图标徽标的特定资源类型的链接的组件。

  <ResourceLink
      kind="Pod"
      name="testPod"
      title={metadata.uid}
  />

参数名称	描述
`kind`	（可选）资源（如 Pod、Deployment、Namespace）的类型
`groupVersionKind`	（可选）带有 groupd、version 和 kind 的对象
`className`	（可选）组件类风格
`displayName`	（可选）组件显示名称，如果设置则覆盖资源名称
`inline`	（可选）使用子项创建图标徽标和名称标记
`linkTo`	（可选）创建 Link 对象的标记 - 默认为 true
`name`	（可选）资源名称
`namesapce`	（可选）要链接到的 kind 资源的特定命名空间
`hideIcon`	（可选）隐藏图标徽标的标记
`title`	（可选）链接对象的标题（未显示）
`dataTest`	（可选）用于测试的标识符
`onClick`	（可选）当点组件时的回调功能
`truncate`	（可选）用于截断链接（如果太长）的标记

`ResourceIcon`

为特定资源类型创建图标徽标的组件。

<ResourceIcon kind="Pod"/>

参数名称	描述
`kind`	（可选）资源（如 Pod、Deployment、Namespace）的类型
`groupVersionKind`	（可选）带有 group、version 和 kind 的对象
`className`	（可选）组件类风格

`useK8sModel`

用于为来自 redux 的 K8sGroupVersionKind 获取 k8s 模型的 hook。它返回一个数组，第一个项为 k8s 模型，第二个项目为 inFlight 状态。

const Component: React.FC = () => {
  const [model, inFlight] = useK8sModel({ group: 'app'; version: 'v1'; kind: 'Deployment' });
  return ...
}

参数名称	描述
`groupVersionKind`	k8s 资源的 group, version, kind of k8s \{@link K8sGroupVersionKind} 是首选的，它可以替代已被弃用的为 group, version, kind 传递参考的方法。例如 `group_versionkind` \{@link K8sResourceKindReference}。

`useK8sModels`

从 redux 检索所有当前 k8s 模型的 hook。它返回一个数组，第一个项是 k8s 模型列表，第二个项目是 inFlight 状态。

const Component: React.FC = () => {
  const [models, inFlight] = UseK8sModels();
  return ...
}

`useK8sWatchResource`

检索 k8s 资源以及加载和错误的状态的 hook。它返回一个数组，包含第一个项目作为资源，第二个项目作为加载的状态，第三个项目则作为错误状态（若有）。

const Component: React.FC = () => {
  const watchRes = {
        ...
      }
  const [data, loaded, error] = useK8sWatchResource(watchRes)
  return ...
}

参数名称	描述
`initResource`	监视资源所需的选项。

`useK8sWatchResources`

检索 k8s 资源的 hook，以及它们的相应状态用于加载和错误。它返回一个映射，在 initResouces 中提供的键，值有三个属性 data, loaded 和 error。

const Component: React.FC = () => {
  const watchResources = {
        'deployment': {...},
        'pod': {...}
        ...
      }
  const {deployment, pod} = useK8sWatchResources(watchResources)
  return ...
}

参数名称	描述
`initResources`	资源需要被监视为键值对，其中键对于资源是唯一的，值将是监视相应资源的选项。

`consoleFetch`

一个围绕 fetch 添加控制台特定标头的自定义打包程序，并允许重试和超时。它还验证响应状态代码，并抛出适当的错误或根据需要注销用户。它返回一个可以解析到响应的承诺。

参数名称	描述
`url`	要获取的 URL
`options`	传递给获取的选项
`timeout`	以毫秒为单位的超时时间

`consoleFetchJSON`

围绕 fetch 的自定义打包程序，添加特定于控制台的标头并允许重试和超时。它还验证响应状态代码，并在需要时抛出适当的错误或注销用户。它将响应返回为 JSON 对象。在内部使用 consoleFetch。它返回一个承诺，它将解析为 JSON 对象的响应。

参数名称	描述
`url`	要获取的 URL
`方法`	要使用的 HTTP 方法。默认为 GET
`options`	传递给获取的选项
`timeout`	以毫秒为单位的超时时间
`cluster`	发出请求的集群名称。默认为用户选择的活跃集群

`consoleFetchText`

围绕 fetch 的自定义打包程序，添加特定于控制台的标头并允许重试和超时。它还验证响应状态代码，并在需要时抛出适当的错误或注销用户。它将响应返回为文本。在内部使用 consoleFetch。它返回一个能以文本方式解析到响应的承诺。

参数名称	描述
`url`	要获取的 URL
`options`	传递给获取的选项
`timeout`	以毫秒为单位的超时时间
`cluster`	发出请求的集群名称。默认为用户选择的活跃集群

`getConsoleRequestHeaders`

使用当前的 redux 状态为 API 请求创建模拟和多集群相关标头的功能。它根据红色状态返回包含适当模拟和冲突的对象，为 API 请求创建模拟和多集群相关标头。

参数名称	描述
`targetCluster`	使用提供的 targetCluster 覆盖当前活跃的集群

`k8sGetResource`

它根据提供的选项从集群获取资源。如果提供了名称，它会返回一个资源，它会返回与模型匹配的所有资源。如果名称被提供，它会返回一个承诺，它将作为 JSON 对象解析到 JSON 对象（如果其返回与模型匹配的所有资源）。如果出现故障，则承诺将被拒绝，并附带 HTTP 错误响应。

参数名称	描述
`options`	在映射中作为键值对传递
``	options.model - k8s model
``	options.name - 如果不提供资源名称，则会查找与模型匹配的所有资源。
``	options.ns - 要查找的命名空间，不应为集群范围的资源指定。
``	options.path - 如果提供，则附录为子路径
``	options.queryParams - URL 中包含的查询参数。
``	options.requestInit - 要使用的 fetch init 对象。这可以具有请求标头、方法、重定向等。更多信息 (链接: https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html)

`k8sCreateResource`

它会根据提供的选项在集群中创建资源。它返回一个能够解析所创建的资源响应的承诺。如果失败承诺，则拒绝 HTTP 错误响应。

参数名称	描述
`options`	在映射中作为键值对传递
``	options.model - k8s model
``	options.data - 要创建的资源的有效负载
``	options.path - 如果提供，则附录为子路径
``	options.queryParams - URL 中包含的查询参数。

`k8sUpdateResource`

它根据提供的选项更新集群中的整个资源。当客户端需要完全替换现有资源时，它们可以使用 k8sUpdate。或者，也可以使用 k8sPatch 执行部分更新。它返回一个可以解析到更新的资源响应的承诺。如果失败承诺，则拒绝 HTTP 错误响应。

参数名称	描述
`options`	在映射中作为键值对传递
``	options.model - k8s model
``	options.data - 要更新的 k8s 资源的有效负载
``	options.ns - 要查找的命名空间，不应为集群范围的资源指定。
``	options.name - 要更新的资源名称。
``	options.path - 如果提供，则附录为子路径
``	options.queryParams - URL 中包含的查询参数。

`k8sPatchResource`

它根据提供的选项对集群中的任何资源进行补丁。当客户端需要执行部分更新时，可以使用 k8sPatch。或者可以使用 k8sUpdate 来完全替换现有资源。请参阅更多数据跟踪器。它返回一个可以解析到修补资源响应的承诺。如果失败承诺，则拒绝 HTTP 错误响应。

参数名称	描述
`options`	在映射中作为键值对传递。
``	options.model - k8s model
``	options.resource - 要修补的资源。
``	options.data - 只有要修补现有资源的数据带有操作、路径和值。
``	options.path - 如果提供，则附录为子路径。
``	options.queryParams - URL 中包含的查询参数。

`k8sDeleteResource`

它根据提供的模型资源从集群中删除资源。垃圾回收的工作方式基于 'Foreground'|'Background'，可以在提供的模型中使用 propagationPolicy 属性进行配置，或者在 json 中传递。它返回一个解析为 Status 的响应的承诺。如果失败承诺，则拒绝 HTTP 错误响应。

{ kind: 'DeleteOptions', apiVersion: 'v1', propagationPolicy }

参数名称	描述
`options`	在映射中作为键值对传递。
``	options.model - k8s model
``	options.resource - 要删除的资源。
``	options.path - 如果提供，则附录为子路径
``	options.queryParams - URL 中包含的查询参数。
``	options.requestInit - 要使用的 fetch init 对象。这可以具有请求标头、方法、重定向等。更多信息 \{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html }
``	options.json - 如果其他提供的资源被默认设置为"propagationPolicy"，则可以明确控制资源的垃圾回收。

`k8sListResource`

根据提供的选项，将资源列为集群中的数组。它返回一个可以解析到响应的承诺。

参数名称	描述
`options`	在映射中作为键值对传递
``	options.model - k8s model
``	options.queryParams - URL 中包含的查询参数，并可使用键 "labelSelector" 传递标签选择器。
``	options.requestInit - 要使用的 fetch init 对象。这可以具有请求标头、方法、重定向等。更多信息 \{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html }

`k8sListResourceItems`

与 \{@link k8sListResource} 相同的接口，但返回子项目。它返回模型的 apiVersion，如 group/version。

`getAPIVersionForModel`

为 k8s 模型提供 apiVersion。

参数名称	描述
`model`	k8s 模型

`getGroupVersionKindForResource`

为资源提供组、版本和类型。它返回提供的资源的组 version 和 kind。如果资源没有 API 组，则返回组 "core"。如果资源具有无效的 apiVersion，则会抛出 Error。

参数名称	描述
`resource`	k8s 资源

`getGroupVersionKindForModel`

为 k8s 模型提供组、版本和类型。这会返回提供的模型的组版本 kind。如果模型没有 apiGroup，则会返回组"core"。

参数名称	描述
`model`	k8s 模型

`StatusPopupSection`

在弹出窗口中显示状态的组件。用于构建 console.dashboards/overview/health/resource 扩展的有用组件。

  <StatusPopupSection
    firstColumn={
      <>
        <span>{title}</span>
        <span className="text-secondary">
          My Example Item
        </span>
      </>
    }
    secondColumn='Status'
  >

参数名称	描述
`firstColumn`	弹出的第一列的值
`secondColumn`	（可选）弹出的第二列的值
`children`	（可选）弹出窗口的子项

`StatusPopupItem`

状态弹出窗口中使用的 status 元素；在 StatusPopupSection 中使用。

<StatusPopupSection
   firstColumn='Example'
   secondColumn='Status'
>
   <StatusPopupItem icon={healthStateMapping[MCGMetrics.state]?.icon}>
      Complete
   </StatusPopupItem>
   <StatusPopupItem icon={healthStateMapping[RGWMetrics.state]?.icon}>
       Pending
   </StatusPopupItem>
</StatusPopupSection>

参数名称	描述
`value`	（可选）要显示的文本值
`icon`	（可选）要显示的图标
`children`	子元素

`概述`

为仪表板创建一个打包程序组件。

    <Overview>
      <OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
    </Overview>

参数名称	描述
`className`	（可选） div 的风格类
`children`	（可选）仪表板的元素

`OverviewGrid`

为仪表板创建卡元素的网格；在 Overview 中使用。

    <Overview>
      <OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
    </Overview>

参数名称	描述
`mainCards`	网格的卡
`leftCards`	（可选）网格左侧的卡
`rightCards`	（可选）网格右侧的卡

`InventoryItem`

创建清单卡项。

  return (
    <InventoryItem>
      <InventoryItemTitle>{title}</InventoryItemTitle>
      <InventoryItemBody error={loadError}>
        {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
      </InventoryItemBody>
    </InventoryItem>
  )

参数名称	描述
`children`	在项目内呈现的元素

`InventoryItemTitle`

为清单卡项目创建标题；在 InventoryItem 内使用。

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )

参数名称	描述
`children`	在标题内呈现的元素

`InventoryItemBody`

创建清单卡的正文；在 InventoryCard 中使用，并可与 InventoryTitle 一起使用。

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )

参数名称	描述
`children`	在清单卡或标题内呈现的元素
`错误`	div 的元素

`InventoryItemStatus`

为带有可选链接地址的清单卡创建一个计数和图标；在 InventoryItemBody 中使用

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )

参数名称	描述
`æ•°é‡�`	显示计数
`icon`	显示图标
`linkTo`	（可选）链接地址

`InventoryItemLoading`

为清单卡加载时创建框架容器；与 InventoryItem 和相关组件一起使用

if (loadError) {
   title = <Link to={workerNodesLink}>{t('Worker Nodes')}</Link>;
} else if (!loaded) {
  title = <><InventoryItemLoading /><Link to={workerNodesLink}>{t('Worker Nodes')}</Link></>;
}
return (
  <InventoryItem>
    <InventoryItemTitle>{title}</InventoryItemTitle>
  </InventoryItem>
)

`useFlag`

从 FLAGS redux 状态返回给定功能标记的 hook。它返回请求的功能标记或未定义的布尔值。

参数名称	描述
`flag`	要返回的功能标志

`YAMLEditor`

有一个基本的 lazy 加载的 YAML 编辑器，带有悬停的帮助和完成。

<React.Suspense fallback={<LoadingBox />}>
  <YAMLEditor
    value={code}
  />
</React.Suspense>

参数名称	描述
`value`	代表要呈现的 yaml 代码的字符串。
`options`	Monaco 编辑器选项.如需更多详细信息，请访问 https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IStandaloneEditorConstructionOptions.html。
`minHeight`	有效 CSS 高度中的值的最小编辑器高度。
`showShortcuts`	布尔值，以显示编辑器顶部的快捷方式。
`toolbarLinks`	编辑器顶部的工具栏链接部分上 ReactNode rendered 的数组。
`onChange`	代码更改事件的回调。
`onSave`	触发命令 CTRL / CMD + S 时调用的回调。
`ref`	对 `{ editor?: IStandaloneCodeEditor }` 的响应参考。使用 'editor' 属性，您可以访问所有方法来控制编辑器。如需更多信息，请访问 https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IStandaloneCodeEditor.html。

`ResourceYAMLEditor`

一个 lazy 载入的 Kubernetes 资源的 YAML 编辑器，带有悬停的帮助和完成。组件使用 YAMLEditor 并在其之上添加更多功能，如资源更新处理、警报、保存、取消和重新加载按钮、可访问性等。除非提供了 onSave 回调，否则自动处理资源更新。它应该嵌套在 React.Suspense 组件中。

<React.Suspense fallback={<LoadingBox />}>
  <ResourceYAMLEditor
    initialResource={resource}
    header="Create resource"
    onSave={(content) => updateResource(content)}
  />
</React.Suspense>

参数名称	描述
`initialResource`	代表编辑器显示资源的 YAML/Object。这个 prop 仅在初始呈现过程中使用
`header`	在 YAML 编辑器之上添加一个标头
`onSave`	保存按钮的回调。传递它将覆盖编辑器对资源执行的默认更新

`ResourceEventStream`

显示与特定资源相关的事件的组件。

const [resource, loaded, loadError] = useK8sWatchResource(clusterResource);
return <ResourceEventStream resource={resource} />

参数名称	描述
`resource`	应该会显示相关事件的对象。

`usePrometheusPoll`

为单个查询设置对 Prometheus 的轮询。它返回一个包含查询响应的元组、指示响应是否已完成的布尔值标志，以及请求请求或后处理过程中遇到的任何错误。

参数名称	描述
``	{PrometheusEndpoint} props.endpoint - 一个 PrometheusEndpoint （label, query, range, rules, targets）
``	{string} [props.query] - （可选）Prometheus 查询字符串。如果为空或未定义，则不会启动轮询。
``	{number} [props.delay] - （可选）轮询延迟间隔 (ms)
``	{number} [props.endTime] - （可选）用于 QUERY_RANGE enpoint，查询范围的末尾
``	{number} [props.samples] - （可选）用于 QUERY_RANGE enpoint
``	{number} [options.timespan] - （可选）用于 QUERY_RANGE enpoint
``	{string} [options.namespace] - （可选）用于附加搜索参数
``	{string} [options.timeout] - （可选）用于附加搜索参数

`Timestamp`

呈现时间戳的组件。时间戳在 Timestamp 组件的 invidual 实例之间同步。提供的时间戳会根据用户区域设置进行格式化。

参数名称	描述
`timestamp`	呈现的时间戳。格式预期为 ISO 8601 （由 Kubernetes 使用）、epo 时间时间戳或日期的实例。
`simple`	呈现组件的简单版本，省略图标和工具提示。
`omitSuffix`	格式化日期消息后缀。
`className`	组件的额外类名称。

`useModal`

用于启动修改的 hook。

const context: AppPage: React.FC = () => {<br/> const [launchModal] = useModal();<br/> const onClick = () => launchModal(ModalComponent);<br/> return (<br/>   <Button onClick={onClick}>Launch a Modal</Button><br/> )<br/>}<br/>`

`ActionServiceProvider`

允许从 console.action/provider 扩展类型的其他插件接收贡献的组件。

   const context: ActionContext = { 'a-context-id': { dataFromDynamicPlugin } };

   ...

   <ActionServiceProvider context={context}>
       {({ actions, options, loaded }) =>
         loaded && (
           <ActionMenu actions={actions} options={options} variant={ActionMenuVariant.DROPDOWN} />
         )
       }
   </ActionServiceProvider>

参数名称	描述
`context`	带有 contextId 和可选插件数据的对象

`NamespaceBar`

一个组件，它呈现一个水平工具栏，其中有一个命名空间下拉菜单（在最左边）。其他组件可以作为子项传递，并呈现到命名空间下拉菜单的右侧。此组件设计为在页面的顶部使用。它应用于用户需要更改活动命名空间的页面，如 k8s 资源的页面中。

   const logNamespaceChange = (namespace) => console.log(`New namespace: ${namespace}`);

   ...

   <NamespaceBar onNamespaceChange={logNamespaceChange}>
     <NamespaceBarApplicationSelector />
   </NamespaceBar>
   <Page>

     ...

参数名称	描述
`onNamespaceChange`	（可选）当选择命名空间选项时执行的功能。它接受字符串形式的新命名空间作为其唯一参数。选择了选项时，活跃命名空间会自动更新，但可通过此功能应用其他逻辑。当更改命名空间时，URL 中的 namespace 参数将从以前的命名空间改为新选择的命名空间。
`isDisabled`	（可选）如果设为 true，则禁用命名空间下拉菜单的布尔值标志。这个选项只适用于命名空间下拉菜单，对子组件没有影响。
`children`	（可选）在命名空间下拉菜单右侧的工具栏中呈现的其他元素。

`ErrorBoundaryFallbackPage`

创建全页 ErrorBoundaryFallbackPage 组件以显示 "Oh no!Something went wrong." 消息与堆栈跟踪和其他有帮助的调试信息一起。这与组件一起使用。

//in ErrorBoundary component
 return (
   if (this.state.hasError) {
     return <ErrorBoundaryFallbackPage errorMessage={errorString} componentStack={componentStackString}
      stack={stackTraceString} title={errorString}/>;
   }

   return this.props.children;
)

参数名称	描述
`errorMessage`	错误消息的文本描述
`componentStack`	异常的组件追踪
`queue`	异常的堆栈追踪
`title`	将标题显示为错误边界页面的标头

`PerspectiveContext`

@deprecated - 使用提供的 usePerspectiveContext，而不是创建视角上下文。

参数名称	描述
`PerspectiveContextType`	带有活跃视角和 setter 的对象

`useAccessReviewAllowed`

@deprecated - 使用 @console/dynamic-plugin-sdk instead.Hook 中的 AccessReview，提供用户对给定资源的访问权限。它返回 isAllowed 布尔值。

参数名称	描述
`resourceAttributes`	访问查看的资源属性
`impersonate`	模拟详情

`useSafetyFirst`

@deprecated - 此 hook 与 console functionality.Hook 无关，确保在可以卸载给定组件时确保安全 asynchronnous 设置 React 状态。它返回一个数组，它带有一对状态值，并且是设置函数。

参数名称	描述
`initialState`	初始状态值

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

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

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

其他资源

了解服务用证书