Customizing the Left Navigation
This guide explains how to customize the Administrator view and Projects view left navigation by modifying custom-navconfig-platform and custom-navconfig-project ConfigMaps.
TOC
Where to configure
In the cpaas-system namespace of the global cluster, you can find:
custom-navconfig-platform: for Administrator view navigation customizationcustom-navconfig-project: for Projects view navigation customization
Basic operation example
To hide Licenses in the Administrator view, add the following to custom-navconfig-platform:
apiVersion: v1
data:
buildIn: |
{
"license_manage": {
"hidden": true
}
}
kind: ConfigMap
metadata:
name: custom-navconfig-platform
namespace: cpaas-system
Field description
buildIn: Modifies built-in navigation.license_manage: The Licenses menu.hidden: true: Hides this navigation item.
Refresh your browser to see changes after editing.
Supported customization capabilities
You can:
- Hide navigation items
- Add custom top-level navigation
- Modify navigation labels
- Modify navigation icons
Example configuration:
apiVersion: v1
kind: ConfigMap
metadata:
name: custom-navconfig-platform
namespace: cpaas-system
data:
buildIn: |
{
"<name>": {
"label": "<Example Name>",
"hidden": true
}
}
customs: |
[
{
"label": "<Example>",
"iconData": "<Base64 encoded icon>",
"hidden": false,
"href": "http://www.example.com"
}
]
Reference
Navigation Configuration Structure Example
The following YAML illustrates the navigation structure syntax with comments to guide users on how to write and understand navigation configurations:
- name: cluster # Top-level navigation name. If no translation is available, this name is displayed.
icon: basic:server_s # (Optional) Navigation icon.
children:
- name: cluster # Sub-navigation name. Displays as is if no translation exists.
href: cluster # Navigation link. Use absolute URLs (http:// or https://) for non-platform functions.
- name: resource_management
href: resource_management
# If there is no `children` field, you can define direct links, for example:
- name: notification # Top-level navigation name
icon: basic:notice_s # (Optional) Icon
href: notification # Navigation link, can be an internal route or external URL
label: Notification # (Optional) Display label; if set, this overrides translation
gate: notification # (Optional) Feature flag controlling display visibility
- name: Unique identifier for navigation. Displays as is if no translation is found.
- icon: Optional navigation icon.
- children: List of sub-navigation items.
- href: Route path or external URL.
- label: Optional display label that overrides the default translation.
- gate: Optional feature flag that controls whether this navigation item is displayed.
Default left navigation
Below are the full name, href, gate, and structure references for direct copy and modification.
Administrator view
- name: overview
icon: bar_chart
href: overview
- name: cluster_management
icon: server
children:
- name: clusters
href: cluster-management/cluster
- name: cloud_credentials
href: cluster-management/cloud-credential
- name: crds
href: $cluster/cluster-management/crd
- name: resource_management
href: $cluster/cluster-management/resource
gate: acp-safemode
negate: true
- name: backup_recover
gate: backup-recovery
children:
- name: backup_manage
href: $cluster/cluster-management/backup-restore/backup-manage
- name: restore_manage
href: $cluster/cluster-management/backup-restore/restore-manage
- name: backup_warehouse
href: cluster-management/backup-restore/backup-warehouse
- name: network_management
icon: internet
children:
- name: domains
href: network-management/domain
- name: certificates
href: network-management/certificate
- name: subnets
href: $cluster/network-management/subnet
publicCloud: false
gate: acp-safemode
negate: true
- name: bridge_network
href: $cluster/network-management/bridge-network
publicCloud: false
gate: acp-safemode
negate: true
- name: vlan
href: $cluster/network-management/vlan
publicCloud: false
gate: acp-safemode
negate: true
- name: alb2
gate: alb2
href: $cluster/network-management/load-balancer
- name: cluster_network_policy
href: $cluster/network-management/cluster-network-policy
- name: storage_management
icon: storage
children:
- name: storageclasses
href: $cluster/storage-management/storageclass
- name: nav_pv
href: $cluster/storage-management/pv
- name: object_storage_class
href: $cluster/storage-management/object-storageclass
gate: cosi
- name: bucket
href: $cluster/storage-management/bucket
gate: cosi
- name: distributed_storage
href: $cluster/storage-management/distributed-storage
gate: storage-ceph
- name: local_storage
href: $cluster/storage-management/local-storage
gate: acp-topolvm
- name: object_storage
href: $cluster/storage-management/object-storage
gate: minio
- name: maintenance_center
icon: operation_center
children:
- name: monitor
children:
- name: blackbox_monitoring
href: $cluster/maintenance-center/monitor/blackbox-monitoring
- name: dashboard
href: $cluster/maintenance-center/monitor/dashboard
- name: log
children:
- name: log_query
href: $cluster/maintenance-center/log/log-query
- name: log_strategy_management
href: maintenance-center/log/strategy-management
- name: events
href: $cluster/maintenance-center/event
- name: alarm
children:
- name: alarm_realtime
href: maintenance-center/alarm_realtime
- name: alarm_strategy
href: $cluster/maintenance-center/alarm
- name: alarm_template
href: maintenance-center/alarm_template
- name: alarm_history
href: maintenance-center/alarm_history
- name: alarm_setting
href: maintenance-center/alarm_setting
- name: notification
href: maintenance-center/notification
- name: inspection
children:
- name: basic_inspection
href: maintenance-center/inspection
- name: app_market_management
icon: catalog
children:
- name: operators
href: $cluster/catalog-management/operator
- name: cluster_plugin
href: $cluster/catalog-management/cluster-plugin
- name: chartrepo
href: catalog-management/chartrepo
- name: application_package_management
href: $cluster/catalog-management/application-package
gate: acp-artifact-manage
- name: security_setting
icon: security
children:
- name: node_isolation_policy
href: $cluster/security-management/node-isolation-policy
gate: node-isolation
- name: platform_certificate_manage
icon: certificate
href: certificate
- name: user_role_management
icon: user_role
children:
- name: user_manage
href: user-role-management/user
- name: user_group_manage
href: user-role-management/group
- name: role_manage
href: user-role-management/role
- name: idp_option
href: user-role-management/idp
- name: user_security_policy
href: user-role-management/security-policy
- name: meter
icon: bill
gate: ait-billing
negate: true
children:
- name: meter_summary
href: meter/summary
- name: meter_report
href: meter/report
- name: meter_detail
href: meter/detail
- name: audit
icon: audit
href: $cluster/audit
- name: platform_setting
icon: platform_settings
children:
- name: license_manage
href: platform-setting/license
gate: license-manage
- name: login_page
href: platform-setting/login-page
- name: portal
href: platform-setting/portal
- name: logo
href: platform-setting/logo
- name: notification_server
href: platform-setting/notification-server
- name: message_manage
href: platform-setting/message-manage
- name: manage_region
href: platform-setting/manage-region
- name: platform_ops
href: platform-setting/online-ops
Projects view
- name: project_overview
icon: bar_chart
href: overview
- name: project_detail
icon: project
href: detail
- name: project_member
icon: member
href: member
- name: namespaces
icon: namespace
href: namespace
- name: notification
href: notification
icon: notice
