挂载位置

本章节介绍如何设置扩展组件在 KubeSphere Web 控制台的挂载位置。

可选挂载位置

扩展组件可以挂载到以下位置：

  • 顶部菜单栏

  • 扩展组件菜单

    在顶部菜单栏点击 图标打开菜单。

  • 工具箱菜单

    将光标悬停在页面右下角的 图标打开菜单。

  • 左侧导航栏

    KubeSphere 在集群管理、企业空间管理、项目管理、用户和角色管理、以及平台设置页面提供左侧导航栏。集群管理页面的左侧导航栏如下图所示。

设置挂载位置

在扩展组件前端源代码的入口文件（如 src/index.js）中的 menu 对象设置挂载位置，例如：

const menu = { 
  parent: 'global',
  name: 'hello-world',
  link: '/hellow-world',
  title: 'HELLO_WORLD',
  icon: 'cluster',
  order: 0,
  desc: 'HELLO_WORLD_DESC',
  authKey: 'hello',
  authAction: 'hello-view',
  skipAuth: true,
};
参数描述
parent扩展组件的挂载位置，取值可以为：
  • topbar：挂载到顶部菜单栏。
  • global：挂载到扩展组件菜单。
  • toolbox：挂载到工具箱菜单。
  • access：挂载到用户和角色管理页面左侧导航栏。
  • cluster：挂载到集群管理页面左侧导航栏。
  • workspace：挂载到企业空间管理页面左侧导航栏。
  • project：挂载到项目管理页面左侧导航栏。
  • platformSettings：挂载到平台设置页面左侧导航栏。
若要挂载到当前菜单的子菜单下，设置 parent 的路径为： parent: 'cluster.xxxx.xxxx'
name

扩展组件在菜单上的位置标识。

菜单的权限校验默认以 name 作为 key。设置 authKey 以指定模块权限进行校验。有关更多信息，请参阅访问控制。

link扩展组件的跳转路径。目前仅对 parent 取值为 global 和 topbar 时有效。
title扩展组件在菜单上显示的名称。请勿直接将参数值设置为硬编码的字符串，建议将参数值设置为词条的键，并通过 KubeSphere 提供的国际化接口实现多语言。有关更多信息，请参阅国际化。
icon扩展组件在菜单上显示的图标的名称。
order扩展组件在菜单上的排列位次，取值为 0 或正整数。若取值为 0，表示扩展组件在菜单首位。
desc扩展组件在菜单上显示的描述文字，目前仅对 parent 取值为 global 和 toolbox 时有效。请勿直接将参数值设置为硬编码的字符串，建议将参数值设置为词条的键，并通过 KubeSphere 提供的国际化接口实现多语言。有关更多信息，请参阅国际化。
skipAuth是否跳过用户权限检查。有关更多信息，请参阅访问控制。
authKey配置权限过滤。有关更多信息，请参阅访问控制。
authAction配置权限项。有关更多信息，请参阅访问控制。