4.5. 动态插件参考
您可以添加允许您自定义插件的扩展。这些扩展随后会在运行时加载到控制台。
4.5.1. 动态插件扩展类型
console.action/filter
ActionFilter
可用于过滤操作。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
上下文 ID 有助于将贡献操作的范围缩小到应用的特定区域。示例包括 |
|
| 否 | 将根据某些条件过滤操作的功能。
|
console.action/group
ActionGroup
贡献一个操作组,也可以是一个子菜单
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于识别操作部分的 ID。 |
|
| 是 | UI 中显示的标签。子菜单是必需的。 |
|
| 是 | 此组是否应显示为子菜单。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
console.action/provider
ActionProvider
贡献了一个 hook,用于返回特定上下文的操作列表。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
上下文 ID 有助于将贡献操作的范围缩小到应用的特定区域。示例包括 |
|
| 否 |
一个 React hook,用于返回给定范围的操作。如果 |
console.action/resource-provider
ResourceActionProvider
贡献 hook,用于返回特定资源模型的操作列表。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此提供程序提供操作的模型。 |
|
| 否 | 反应 hook,它返回给定资源模型的操作 |
console.alert-action
当控制台根据其 rule.name
值观察特定 Prometheus 警报时,此扩展可用于触发特定操作。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
由 |
|
| 否 | |
|
| 否 | 执行副作用的功能 |
console.catalog/item-filter
此扩展可用于插件,以生成一个可以过滤特定目录项的处理程序。例如,插件可以贡献从特定提供程序过滤 helm chart 的过滤器。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此提供程序参与的目录的唯一标识符。 |
|
| 否 | 目录项目类型的类型 ID。 |
|
| 否 |
过滤特定类型的项目。值是采用 |
console.catalog/item-metadata
此扩展可用于贡献向特定目录项添加额外的元数据的供应商。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此提供程序参与的目录的唯一标识符。 |
|
| 否 | 目录项目类型的类型 ID。 |
|
| 否 | 返回一个将用来向特定类型的目录项提供元数据的 hook。 |
console.catalog/item-provider
此扩展允许插件为目录项类型贡献供应商。例如,Helm 插件可以添加一个供应商来获取所有 Helm Charts。此扩展也可以被其他插件使用,来向特定的目录项类型添加更多项目。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此提供程序参与的目录的唯一标识符。 |
|
| 否 | 目录项目类型的类型 ID。 |
|
| 否 | 目录项提供程序的标题 |
|
| 否 | 为目录获取项目并进行规范化。值是对 hook 做出反应。 |
|
| 是 |
此提供程序的优先级。默认值为 |
console.catalog/item-type
此扩展允许插件生成新的目录项。例如,Helm 插件可将新的目录项类型定义为它希望向 Developer Catalog 贡献的 HelmCharts。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 目录项的类型。 |
|
| 否 | 目录项的标题。 |
|
| 是 | 特定与目录类型的描述。 |
|
| 是 | 目录项类型的描述。 |
|
| 是 | 特定于目录项的自定义过滤器。 |
|
| 是 | 特定于目录项的自定义分组。 |
console.catalog/item-type-metadata
此扩展允许插件为任何目录项类型贡献额外的元数据,如自定义过滤器或分组。例如,插件可以为根据 Chart 供应商过滤的 HelmCharts 附加自定义过滤器。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 目录项的类型。 |
|
| 是 | 特定于目录项的自定义过滤器。 |
|
| 是 | 特定于目录项的自定义分组。 |
console.cluster-overview/inventory-item
将新清单项添加到集群概览页面中。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 要呈现的组件。 |
console.cluster-overview/multiline-utilization-item
添加新的集群概述多行使用项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 使用项目的标题。 |
|
| 否 | Prometheus 使用率查询。 |
|
| 否 | 将 Prometheus 数据转换为人类可读形式。 |
|
| 是 | 显示顶部消费者弹出而不是普通值 |
console.cluster-overview/utilization-item
添加新的集群概览使用率项目。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 使用项目的标题。 |
|
| 否 | Prometheus 使用率查询。 |
|
| 否 | 将 Prometheus 数据转换为人类可读形式。 |
|
| 是 | Prometheus 总计查询。 |
|
| 是 | Prometheus 请求查询。 |
|
| 是 | Prometheus 限制查询。 |
|
| 是 | 显示顶部消费者弹出而不是普通值 |
console.context-provider
在 web 控制台应用程序根目录中添加新的 React 上下文提供程序。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 上下文提供程序组件。 |
|
| 否 | 上下文值的 hook。 |
console.dashboards/card
添加新的仪表板卡。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 将添加到卡的仪表板标签的 ID。 |
|
| 否 | 该卡在仪表板上的网格位置。 |
|
| 否 | 仪表板卡组件。 |
|
| 是 |
栏中卡的垂直范围。对于小屏幕会忽略,默认为 |
console.dashboards/custom/overview/detail/item
在 Overview 仪表板的详情卡中添加项目。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 详情卡标题 |
|
| 否 | 由 OverviewDetailItem 组件呈现的值 |
|
| 是 | className 的值 |
|
| 是 | 返回组件的加载状态的功能 |
|
| 是 | 组件显示的功能返回错误 |
console.dashboards/overview/activity/resource
在 Overview 仪表板的活动卡中添加一个活动,其中根据监视 Kubernetes 资源触发活动。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 要替换的 utilization 项。 |
|
| 否 | 操作组件。 |
|
| 是 | 确定给定资源是否代表该操作的功能。如果没有定义,则每个资源都代表活动。 |
|
| 是 | 给定操作的时间戳,用于排序。 |
console.dashboards/overview/health/operator
在 Overview 仪表板的状态卡中添加一个健康子系统,其中状态源是 Kubernetes REST API。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 弹出菜单中的 Operators 部分的标题。 |
|
| 否 |
将获取并传递给 |
|
| 是 | 解析 Operator 的状态。 |
|
| 是 | 弹出行组件的加载程序。 |
|
| 是 | 链接到所有资源页面。如果没有提供,则使用资源 prop 中第一个资源的列表页面。 |
console.dashboards/overview/health/prometheus
在 Status 为 Prometheus 的 Overview 仪表板的状态卡中添加一个健康子系统。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 子系统的显示名称。 |
|
| 否 | Prometheus 查询。 |
|
| 否 | 解决子系统的健康状况。 |
|
| 是 |
将获取并传递给 |
|
| 是 | 弹出式菜单内容的加载程序。如果定义,健康项表示为链接,它会打开一个带有给定内容的弹出窗口。 |
|
| 是 | 弹出的标题。 |
|
| 是 | 应该隐藏子系统的 control plane 拓扑。 |
console.dashboards/overview/health/resource
在状态仪表板的 Overview 卡中添加一个健康子系统,其中状态源是一个 Kubernetes 资源。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 子系统的显示名称。 |
|
| 否 |
将获取并传递给 |
|
| 否 | 解决子系统的健康状况。 |
|
| 是 | 弹出式菜单内容的加载程序。如果定义,健康项表示为链接,它会打开一个带有给定内容的弹出窗口。 |
|
| 是 | 弹出的标题。 |
console.dashboards/overview/health/url
在状态仪表板的 Overview 卡中添加一个健康子系统,其中状态源是一个 Kubernetes REST API。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 子系统的显示名称。 |
|
| 否 | 从中获取数据的 URL。它将以基本 Kubernetes URL 作为前缀。 |
|
| 否 | 解决子系统的健康状况。 |
|
| 是 |
将获取并传递给 |
|
| 是 | 弹出内容的加载程序。如果定义,则一个健康项目将显示为一个链接,该链接会打开给定内容弹出窗口中。 |
|
| 是 | 弹出的标题。 |
console.dashboards/overview/inventory/item
在概述清单卡中添加资源标题。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
将获取的 |
|
| 是 | 将各种状态映射到组的功能。 |
|
| 是 |
将获取并传递给 |
console.dashboards/overview/inventory/item/group
添加清单状态组。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 状态组的 ID。 |
|
| 否 | 响应代表状态组图标的组件。 |
console.dashboards/overview/inventory/item/replacement
替换概述清单卡。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
将获取的 |
|
| 是 | 将各种状态映射到组的功能。 |
|
| 是 |
将获取并传递给 |
console.dashboards/overview/prometheus/activity/resource
在 Prometheus Overview 仪表板的 Activity 卡中添加一个活动,该仪表板根据监视 Kubernetes 资源来触发活动。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 要监视的查询。 |
|
| 否 | 操作组件。 |
|
| 是 | 确定给定资源是否代表该操作的功能。如果没有定义,则每个资源都代表活动。 |
console.dashboards/project/overview/item
为项目概述清单卡中添加资源标题。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
将获取的 |
|
| 是 | 将各种状态映射到组的功能。 |
|
| 是 |
将获取并传递给 |
console.dashboards/tab
添加新仪表板选项卡,它位于 Overview 选项卡的后面。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
唯一标签页标识符,用作标签链接 |
|
| 否 | 选项卡所属的导航部分。 |
|
| 否 | 选项卡的标题。 |
console.file-upload
此扩展可用于为特定文件扩展提供文件丢弃操作的处理程序。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 支持的文件扩展。 |
|
| 否 | 处理文件丢弃操作的功能。 |
console.flag
提供对 Web 控制台功能标记的完整控制。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于设置或取消设置任意功能标记。 |
console.flag/hookProvider
提供对带有 hook 处理程序的 Web 控制台功能标记的完整控制。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于设置或取消设置任意功能标记。 |
console.flag/model
通过在集群中存在 CustomResourceDefinition
(CRD) 对象来添加新的 Web 控制台功能标记。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 在检测到 CRD 后要设置的标记名称。 |
|
| 否 | 引用 CRD 的模型。 |
console.global-config
此扩展标识用于管理集群配置的资源。资源的链接将添加到 Administration
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 集群配置资源实例的唯一标识符。 |
|
| 否 | 集群配置资源实例的名称。 |
|
| 否 | 指代集群配置资源的模型。 |
|
| 否 | 集群配置资源实例的命名空间。 |
console.model-metadata
通过覆盖通过 API 发现检索并生成的值来自定义模型显示。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 要定制的模型。只能指定组或可选版本和类型。 |
|
| 是 | 是否将这个模型视为技术预览还是开发者预览。 |
|
| 是 | 与这个模型关联的颜色。 |
|
| 是 |
覆盖标签。需要提供的 |
|
| 是 |
覆盖复数标签。需要提供的 |
|
| 是 |
自定义缩写。默认为 |
console.navigation/href
此扩展可用于贡献指向 UI 中特定链接的导航项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此项目的唯一标识符。 |
|
| 否 | 此项目的名称。 |
|
| 否 |
链接 |
|
| 是 | 此项目所属的视角 ID。若未指定,则向默认视角。 |
|
| 是 | 导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。 |
|
| 是 | 在 DOM 中添加数据属性。 |
|
| 是 | 当 URL 从其中一个路径之一时,将此项标记为 active。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
如果为 |
|
| 是 |
如果为 |
console.navigation/resource-cluster
此扩展可用于贡献指向集群资源详情页面的导航项。该资源的 K8s 模型可用于定义导航项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此项目的唯一标识符。 |
|
| 否 | 此导航项目所链接的模型。 |
|
| 是 | 此项目所属的视角 ID。若未指定,则向默认视角。 |
|
| 是 | 导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。 |
|
| 是 | 在 DOM 中添加数据属性。 |
|
| 是 | 当 URL 从其中一个路径之一时,将此项标记为 active。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 | 覆盖默认名称。如果没有提供链接的名称,则会与模型的复数值相同。 |
console.navigation/resource-ns
此扩展可用于贡献指向命名空间资源详情页面的导航项。该资源的 K8s 模型可用于定义导航项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此项目的唯一标识符。 |
|
| 否 | 此导航项目所链接的模型。 |
|
| 是 | 此项目所属的视角 ID。若未指定,则向默认视角。 |
|
| 是 | 导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。 |
|
| 是 | 在 DOM 中添加数据属性。 |
|
| 是 | 当 URL 从其中一个路径之一时,将此项标记为 active。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 | 覆盖默认名称。如果没有提供链接的名称,则会与模型的复数值相同。 |
console.navigation/section
此扩展可用于在导航选项卡中定义导航项的新部分。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此项目的唯一标识符。 |
|
| 是 | 此项目所属的视角 ID。若未指定,则向默认视角。 |
|
| 是 | 在 DOM 中添加数据属性。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 | 本节的名称。如果没有提供,上面部分将仅显示一个分隔符。 |
console.navigation/separator
此扩展可用于在导航中的导航项目之间添加分隔符。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此项目的唯一标识符。 |
|
| 是 | 此项目所属的视角 ID。若未指定,则向默认视角。 |
|
| 是 | 导航此项目所属的导航部分。如果未指定,请将此项目呈现为顶级链接。 |
|
| 是 | 在 DOM 中添加数据属性。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
console.page/resource/details
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此资源页面链接到的型号。 |
|
| 否 | 路由匹配时要呈现的组件。 |
console.page/resource/list
向控制台路由器添加新的资源列表页面。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此资源页面链接到的型号。 |
|
| 否 | 路由匹配时要呈现的组件。 |
console.page/route
在 Web 控制台路由器中添加新页面。请参阅 React Router。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 路由匹配时要呈现的组件。 |
|
| 否 |
|
|
| 是 | 此页面所属的视图。如果没有指定,则会对所有视角贡献。 |
|
| 是 |
为 true 时,只有在路径与 |
console.page/route/standalone
向 web 控制台路由器中添加在通用页面布局外呈现的新独立页面。请参阅 React Router。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 路由匹配时要呈现的组件。 |
|
| 否 |
|
|
| 是 |
为 true 时,只有在路径与 |
console.perspective
此扩展为控制台贡献一个新的视角,它允许自定义导航菜单。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 透视图标识符。 |
|
| 否 | 视角显示名称。 |
|
| 否 | 视角显示图标。 |
|
| 否 | 获取视角登录页面 URL 的功能。 |
|
| 否 | 获取导入流的重定向 URL。 |
|
| 是 | 这个视角是默认的。只能有一个默认值。 |
|
| 是 | nav 上的默认固定资源 |
|
| 是 | 要检测默认视角的 hook |
console.project-overview/inventory-item
在 Project Overview 页面中添加一个新清单项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 要呈现的组件。 |
console.project-overview/utilization-item
添加新项目概述使用率项目。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 使用项目的标题。 |
|
| 否 | Prometheus 使用率查询。 |
|
| 否 | 将 Prometheus 数据转换为人类可读形式。 |
|
| 是 | Prometheus 总计查询。 |
|
| 是 | Prometheus 请求查询。 |
|
| 是 | Prometheus 限制查询。 |
|
| 是 | 显示 top consumer 弹出窗而不是纯值。 |
console.pvc/alert
此扩展可用于在 PVC 详情页面中贡献自定义警报。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 警报组件。 |
console.pvc/create-prop
此扩展可以用来指定在 PVC 列表页面中创建 PVC 资源时使用的附加属性。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 创建 prop 操作的标签。 |
|
| 否 | 创建 prop 操作的路径。 |
console.pvc/delete
此扩展允许 hook 删除 PVC 资源。它可以为警报提供额外的信息和自定义 PVC 删除逻辑。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 告知是否使用扩展名的 predicate。 |
|
| 否 | PVC 删除操作的方法。 |
|
| 否 | 警报组件以显示其他信息。 |
console.pvc/status
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 状态组件的优先级。较大的值代表优先级更高。 |
|
| 否 | 状态组件。 |
|
| 否 | 指示是否呈现状态组件的 predicate。 |
console.redux-reducer
为 Console Red Hatux 存储添加了新的减少程序,该存储在 plugins.<scope>
子状态上运行。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 代表 Red Hatux 状态对象中减少管理的子状态的关键。 |
|
| 否 | reducer 函数,在 reducer-managed substate 中操作。 |
console.resource/create
此扩展允许插件为特定资源提供自定义资源(如向导或表单)的自定义资源,当用户尝试创建新资源实例时,这些组件会被呈现。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此创建资源页面将呈现的型号 |
|
| 否 | 当模型匹配时要呈现的组件 |
console.resource/details-item
在详情页面的默认资源摘要中添加一个新的详情项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 主题资源的 API 组、版本和类型。 |
|
| 否 | 唯一标识符。 |
|
| 否 | 确定项目是否将显示在详细信息页面上的资源摘要的"左"或"右"列中。默认:"右" |
|
| 否 | 详情项标题。 |
|
| 是 | 一个可选的、完全限定的、资源属性的路径,用作详情项目值。只能 直接渲染原始类型 值。使用 component 属性处理其他数据类型。 |
|
| 是 | 可选的 React 组件,用于呈现详情项目值。 |
|
| 是 | 可选的排序权重,相对于同一列中的所有其他详细信息项目。由任何有效的 JavaScriptNumber 表示。每个列中的项目都独立排序,最低为最高。在项目带有排序权重的项目后,没有排序 weight。 |
console.storage-class/provisioner
在存储类创建过程中,添加新的存储类置备程序作为选项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 是 | Container Storage Interface provisioner 类型 |
|
| 是 | 其他置备程序类型 |
console.storage-provider
此扩展可用于生成新的存储供应商,以便在附加存储和供应商特定组件时进行选择。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 显示提供程序的名称。 |
|
| 否 | 要呈现的供应商特定组件。 |
console.tab
向与 contextId
匹配的 nav 中添加一个标签页。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
分配给水平 nav 的上下文 ID,在其中注入选项卡。可能的值: |
|
| 否 | 选项卡的显示标签 |
|
| 否 |
|
|
| 否 | 选项卡内容组件。 |
console.tab/horizontalNav
此扩展可用于在资源详情页面中添加标签页。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此提供程序显示选项卡的型号。 |
|
| 否 | 要在水平标签页中显示的页面。它取标签名称作为名称,并且是 href 的选项卡 |
|
| 否 | 路由匹配时要呈现的组件。 |
console.telemetry/listener
此组件可用于注册接收遥测事件的监听程序功能。这些事件包括用户识别、页面导航和其他特定应用程序的事件。侦听器可以使用这些数据进行报告和分析目的。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 侦听遥测事件 |
console.topology/adapter/build
BuildAdapter
贡献适配器将元素适应 Build 组件可以使用的数据
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于调整元素以适用于 Build 组件的适配器。 |
console.topology/adapter/network
NetworkAdpater
贡献适配器,将元素适应数据,以供 Networking
组件使用
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于调整元素以适用于 Networking 组件的适配器。 |
console.topology/adapter/pod
PodAdapter
贡献一个适配器,将元素适应 Pod
组件可以使用的数据。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于调整元素以适用于 Pod 组件的适配器。 |
console.topology/component/factory
ViewComponentFactory
的 getter。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
|
console.topology/create/connector
创建连接器功能的 getter。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 创建连接器功能的 getter。 |
console.topology/data/factory
拓扑数据模型工厂扩展
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 工厂的唯一 ID。 |
|
| 否 | 工厂的优先级 |
|
| 是 |
要从 |
|
| 是 | 包含工作负载的资源中的密钥。 |
|
| 是 | 数据模型工厂的 getter。 |
|
| 是 | 用于确定资源是否由这个模型描述的 getter。 |
|
| 是 | 在所有扩展模型加载后用于协调数据模型的功能。 |
console.topology/decorator/provider
拓扑声明器供应商扩展
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 拓扑 decorator 的 ID,特定于扩展 |
|
| 否 | 拓扑 decorator 的优先级,特定于扩展 |
|
| 否 | 拓扑 decorator 的 Quadrant,特定于扩展 |
|
| 否 | 特定于扩展的 decorator |
console.topology/details/resource-alert
DetailsResourceAlert
为特定拓扑上下文或图形元素贡献警报。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此警报的 ID。用于保存状态,如果警报在丢弃后不应显示。 |
|
| 否 | 返回警报内容的 hook。 |
console.topology/details/resource-link
DetailsResourceLink
为特定拓扑上下文或图形元素贡献一个链接。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
如果提供,则返回资源链接,否则未定义。将 |
|
| 是 | 一个高的优先级可以在第一个机会出现时创建链接。 |
console.topology/details/tab
DetailsTab
为拓扑详情面板提供标签页。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此详细信息标签的唯一标识符。 |
|
| 否 | 要在 UI 中显示的标签标签。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
console.topology/details/tab-section
DetailsTabSection
对拓扑详情面板中的特定标签页贡献了一个部分。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此详细信息选项卡部分的唯一标识符。 |
|
| 否 | 本节应贡献的父选项卡 ID。 |
|
| 否 |
返回组件的 hook,或者如果为 null 或未定义,会在拓扑栏中显示。SDK 组件: |
|
| 否 | Deprecated: 如果没有定义供应商会 Fallback,renderNull 已是一个 no-op。 |
|
| 是 | 在此处引用的项目前插入此项。对于数组,使用按顺序找到的第一个。 |
|
| 是 |
在此处引用的项目后插入此项。对于数组,使用按顺序找到的第一个。 |
console.topology/display/filters
拓扑显示过滤器扩展
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 特定于扩展的拓扑过滤器的 getter |
|
| 否 | 将过滤器应用到模型的功能 |
console.topology/relationship/provider
拓扑关系供应商连接器扩展
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于确定是否可以在源和目标节点之间创建连接 |
|
| 否 | 显示连接器操作将鼠标悬停在 drop 目标的工具,例如:"Create a Visual Connector" |
|
| 否 | 连接器通过目标节点丢弃时执行的回调以创建连接 |
|
| 否 | 关系的优先级,在有多个情况下,首选更高的优先级 |
console.user-preference/group
此扩展可用于在控制台 user-preferences 页面中添加组。它将在控制台 user-preferences 页面中显示为垂直标签页选项。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于识别用户首选项组的 ID。 |
|
| 否 | 用户首选项组的标签 |
|
| 是 | 应该放置此组前的用户首选项组群 ID |
|
| 是 | 应该放置此组的用户首选项组群 ID |
console.user-preference/item
此扩展可用于在控制台用户首选项页面中的用户首选项组群中添加项目。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | ID 用于识别用户首选项项目,并在 insertAfter 和 insertBefore 中引用来定义项目顺序 |
|
| 否 | 用户首选项的标签 |
|
| 否 | 用户首选项的描述 |
|
| 否 | 用于呈现值来设置用户首选项的输入字段选项 |
|
| 是 | 用于识别项目所属的用户首选项组的 ID |
|
| 是 | 应放置此项目前的用户首选项项目 ID |
|
| 是 | 用户首选项项目的 ID,之后应放置此项目 |
console.yaml-template
通过 yaml 编辑器编辑资源的 YAML 模板。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 与模板关联的模型。 |
|
| 否 | YAML 模板。 |
|
| 否 |
模板的名称。使用名称 |
dev-console.add/action
此扩展允许插件在开发人员视角的 add 页面中贡献 add action 项。例如,无服务器插件可以添加一个新的 action 项,用于在开发人员控制台的添加页面中添加无服务器功能。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于识别操作的 ID。 |
|
| 否 | 操作的标签。 |
|
| 否 | 操作的描述。 |
|
| 否 |
要进入到的 |
|
| 是 | 用于识别该操作所属的操作组的 ID。 |
|
| 是 | 视角显示图标。 |
|
| 是 | 可选访问查看来控制操作的可见性或启用。 |
dev-console.add/action-group
此扩展允许插件在开发人员控制台的添加页面中继续组。组可以被操作引用,这些操作将根据它们的扩展定义在 add 操作页面中分组。例如,Serverless 插件可以贡献 Serverless 组,以及多个 add 操作。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 用于识别操作组的 ID |
|
| 否 | 操作组的标题 |
|
| 是 | 应该放置此组的操作组群 ID |
|
| 是 | 应该放置此组的操作组群 ID |
dev-console.import/environment
此扩展可用于在开发人员控制台 git import 表单的构建器镜像选择器下指定额外的构建环境变量字段。设置后,字段将覆盖 build 部分中相同名称的环境变量。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 为提供自定义环境变量的镜像流名称 |
|
| 否 | 支持的镜像流标签列表 |
|
| 否 | 环境变量列表 |
console.dashboards/overview/detail/item
弃用。使用 CustomOverviewDetailItem
类型
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 |
基于 |
console.page/resource/tab
已弃用。使用 console.tab/horizontalNav
替代。添加新资源选项卡页面到控制台路由器。
Name | 值类型 | 选填 | 描述 |
---|---|---|---|
|
| 否 | 此资源页面链接到的型号。 |
|
| 否 | 路由匹配时要呈现的组件。 |
|
| 否 | 选项卡的名称。 |
|
| 是 |
选项卡链接的可选 |
|
| 是 |
为 true 时,只有在路径与 |
4.5.2. Red Hat OpenShift Service on AWS 控制台 API
useActivePerspective
提供用于设置活跃视角的 hook,以及用于设置活跃视角的回调。它返回一个包含当前活跃视角和 setter 回调的元组。
Example
const Component: React.FC = (props) => { const [activePerspective, setActivePerspective] = useActivePerspective(); return <select value={activePerspective} onChange={(e) => setActivePerspective(e.target.value)} > { // ...perspective options } </select> }
GreenCheckCircleIcon
显示绿色勾号图标的组件。
Example
<GreenCheckCircleIcon title="Healthy" />
参数名称 | 描述 |
---|---|
| (可选)组件的额外类名称 |
| (可选)图标标题 |
|
(可选)图标大小:( |
RedExclamationCircleIcon
用于显示感叹号圆圈图标的组件。
Example
<RedExclamationCircleIcon title="Failed" />
参数名称 | 描述 |
---|---|
| (可选)组件的额外类名称 |
| (可选)图标标题 |
|
(可选)图标大小:( |
YellowExclamationTriangleIcon
用于显示一个黄色三角形感叹号图标的组件。
Example
<YellowExclamationTriangleIcon title="Warning" />
参数名称 | 描述 |
---|---|
| (可选)组件的额外类名称 |
| (可选)图标标题 |
|
(可选)图标大小:( |
BlueInfoCircleIcon
用于显示信息的蓝色圆圈图标的组件。
Example
<BlueInfoCircleIcon title="Info" />
参数名称 | 描述 |
---|---|
| (可选)组件的额外类名称 |
| (可选)图标标题 |
| (可选)图标大小:('sm', 'md', 'lg', 'xl') |
ErrorStatus
用于显示错误状态弹出的组件。
Example
<ErrorStatus title={errorMsg} />
参数名称 | 描述 |
---|---|
| (可选)状态文本 |
| (可选)如果为 true,则仅显示图标 |
| (可选)如果为 true,则不会显示工具提示 |
| (可选)组件的额外类名称 |
| (可选)弹出的标题 |
InfoStatus
用于显示信息状态弹出窗口的组件。
Example
<InfoStatus title={infoMsg} />
参数名称 | 描述 |
---|---|
| (可选)状态文本 |
| (可选)如果为 true,则仅显示图标 |
| (可选)如果为 true,则不会显示工具提示 |
| (可选)组件的额外类名称 |
| (可选)弹出的标题 |
ProgressStatus
显示进度状态弹出的组件。
Example
<ProgressStatus title={progressMsg} />
参数名称 | 描述 |
---|---|
| (可选)状态文本 |
| (可选)如果为 true,则仅显示图标 |
| (可选)如果为 true,则不会显示工具提示 |
| (可选)组件的额外类名称 |
| (可选)弹出的标题 |
SuccessStatus
用于显示成功状态弹出窗口的组件。
Example
<SuccessStatus title={successMsg} />
参数名称 | 描述 |
---|---|
| (可选)状态文本 |
| (可选)如果为 true,则仅显示图标 |
| (可选)如果为 true,则不会显示工具提示 |
| (可选)组件的额外类名称 |
| (可选)弹出的标题 |
checkAccess
提供有关用户对给定资源的访问权限的信息。它返回一个具有资源访问信息的对象。
参数名称 | 描述 |
---|---|
| 访问查看的资源属性 |
| 模拟详情 |
useAccessReview
hook,提供有关用户对给定资源的访问权限的信息。它返回一个带有 isAllowed
和 loading
值的数组。
参数名称 | 描述 |
---|---|
| 访问查看的资源属性 |
| 模拟详情 |
useResolvedExtensions
使用已解析的 CodeRef
属性为消耗控制台扩展做出反应 hook。此 hook 接受与 useExtensions
hook 相同的参数,并返回自适应扩展实例列表,从而解析每个扩展属性中的所有代码引用。
最初,hook 返回一个空数组。完成解析后,React 组件将重新渲染,使用 hook 返回已修改的扩展列表。当匹配扩展列表更改时,会重启解析。hook 将继续返回前面的结果,直到解析完成为止。
hook 结果元素保证在重新方之间保持稳定。它返回一个包含已解析代码引用的自适应扩展实例列表的元组、指示解析是否完成的布尔值标志,以及在解析过程中检测到的错误列表。
Example
const [navItemExtensions, navItemsResolved] = useResolvedExtensions<NavItem>(isNavItem); // process adapted extensions and render your component
参数名称 | 描述 |
---|---|
| 每个接受动态插件扩展作为参数的回调列表,并返回布尔值标记,指示扩展是否满足所需的类型限制 |
HorizontalNav
为页面创建导航栏的组件。路由作为组件的一部分进行处理。console.tab/horizontalNav
可用于向任何横向导航中添加额外的内容。
Example
const HomePage: React.FC = (props) => { const page = { href: '/home', name: 'Home', component: () => <>Home</> } return <HorizontalNav match={props.match} pages={[page]} /> }
参数名称 | 描述 |
---|---|
| 与这个 Navigation 关联的资源,对象为 K8sResourceCommon 类型 |
| 页面对象数组 |
| 匹配 React Router 提供的对象 |
VirtualizedTable
创建虚拟化表的组件。
Example
const MachineList: React.FC<MachineListProps> = (props) => { return ( <VirtualizedTable<MachineKind> {...props} aria-label='Machines' columns={getMachineColumns} Row={getMachineTableRow} /> ); }
参数名称 | 描述 |
---|---|
| 表的数据 |
| 表示数据已加载的标记 |
| 如果问题载入数据,则错误对象 |
| 列设置 |
| 行设置 |
| 没有过滤器的原始数据 |
| (可选)没有数据空消息组件 |
| (可选)空消息组件 |
| (可选)处理滚动的功能 |
| (可选)表的标签 |
| (可选)aria 标签 |
| 调整用于响应的网格如何分隔 |
| (可选)处理表选择的功能 |
| (可选)特定于行的数据 |
TableData
用于在表行中显示表数据的组件。
Example
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> </> ); };