Mount Point

This section describes how to configure the mount point of an extension in the KubeSphere web console.

Available mount points

You can mount extensions to the following points:

  • Top navigation bar

  • Extensions menu

    In the top navigation bar, click to open the menu.

  • Toolbox menu

    Hover over the icon in the bottom right corner of the page to open the menu.

  • Left navigation pane

    KubeSphere provides a left navigation pane for each of the following modules: users and roles, cluster management, workspace management, project management, and platform settings. Example:

Configure a mount point

Set the mount point in the menu object of src/index.js. For example:

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,
};
ParameterDescription
parentThe mount point of the extension. Valid values:
  • topbar: mounts to the top navigation bar.
  • global: mounts to the extensions menu.
  • toolbox: mounts to the toolbox menu.
  • access: mounts to the left navigation pane on the Users and Roles page.
  • cluster: mounts the left navigation pane on the Cluster Management page.
  • workspace: mounts the left navigation pane on the Workspace Management page.
  • project: mounts the left navigation pane on the Project Management page.
  • platformSettings: mounts the left navigation pane on the Platform Settings page.
To mount to a submenu of the current menu, set the path to: parent: 'cluster.xxxx.xxxx'.
name

The identifier of the extension on the menu.

Menu permission validation uses the 'name' as the key by default. Set 'authKey' to specify module permissions for validation. For more information, please refer to Access Control.

linkThe link to the extension. This parameter is valid only when parent is set to global or topbar.
titleThe extension name displayed on the menu. Please do not hard-code the parameter values. Instead, configure the parameters as keys in the UI text and enable multi-language support by using the internationalization API of KubeSphere. For more information, please refer to Internationalization.
iconThe icon name of the extension displayed on the menu.
orderThe sequence of the extension on the menu. Valid values: 0 or a positive integer. Value 0 indicates that the extension is at the top of the menu.
descThe description of the extension. This parameter is valid only when parent is set to global or topbar. We recommend that you do not hard-code the parameter settings. Instead, you can configure the parameters as keys in the UI text and enable multi-language support by using the internationalization API of KubeSphere. For more information, please refer to Internationalization.
skipAuthWhether to skip user permission check. For more information, please refer to Access control.
authKeyConfigure permission filtering. For more information, please refer to Access Control.
authActionConfigure permission items. For more information, please refer to Access Control.