Plugin Menu Registration Order #570

New Issue

MrUnknownDE · 2026-04-05T16:44:47+02:00

MrUnknownDE commented

2026-04-05 16:44:47 +02:00

Originally created by @Littlericket on 1/15/2026

NetBox Edition

NetBox Community

NetBox Version

v4.5.0 (and likely earlier versions)

Python Version

3.12

Steps to Reproduce

Install multiple plugins that register menus via navigation.py and PluginConfig.ready():
- netbox_dns
- netbox_topology_views
- ...

Ensure each plugin has a navigation.py file with a menu variable:

from netbox.plugins import PluginMenu, PluginMenuButton, PluginMenuItem
from django.utils.translation import gettext_lazy as _

menu = PluginMenu(
    label='Plugin',
    icon_class='mdi mdi-lan',
    groups=(...)
)

Configure plugins in configuration/plugins.py:

PLUGINS = [
    'netbox_dns',
    'netbox_topology_views',
    'netbox_....'
]

Start NetBox and view the navigation sidebar
Observe which plugin menus appear in the sidebar

Expected Behavior

All plugin menus should appear in the navigation sidebar regardless of plugin load order:

DNS
Topology Views
...

Observed Behavior

Only some plugin menus appear in the navigation sidebar:

DNS (appears)
Topology Views (MISSING)
... (MISSING)

The missing menus are registered but not included in the final MENUS list.

In netbox/netbox/navigation/menu.py, the MENUS list is built at import time:

MENUS = [
    ORGANIZATION_MENU,
    RACKS_MENU,
    # ... other base menus ...
]

# Add top-level plugin menus
for menu in registry['plugins']['menus']:
    MENUS.append(menu)

This code executes when navigation/menu.py is imported during Django startup (in settings.py). At that point, only the first few plugins have called PluginConfig.ready() and registered their menus.

settings.py imports plugins and calls PluginConfig.ready() for each
PluginConfig.ready() imports the plugin's navigation.menu module
navigation.menu calls register_menu() to add the menu to registry['plugins']['menus']
But netbox/navigation/menu.py is imported BEFORE all plugins complete ready()
The MENUS list is built with only the menus registered so far

*Originally created by @Littlericket on 1/15/2026* ### NetBox Edition NetBox Community ### NetBox Version v4.5.0 (and likely earlier versions) ### Python Version 3.12 ### Steps to Reproduce 1. Install multiple plugins that register menus via `navigation.py` and `PluginConfig.ready()`: - netbox_dns - netbox_topology_views - ... 2. Ensure each plugin has a `navigation.py` file with a `menu` variable: ```python from netbox.plugins import PluginMenu, PluginMenuButton, PluginMenuItem from django.utils.translation import gettext_lazy as _ menu = PluginMenu( label='Plugin', icon_class='mdi mdi-lan', groups=(...) ) ``` 3. Configure plugins in `configuration/plugins.py`: ```python PLUGINS = [ 'netbox_dns', 'netbox_topology_views', 'netbox_....' ] ``` 4. Start NetBox and view the navigation sidebar 5. Observe which plugin menus appear in the sidebar ### Expected Behavior All plugin menus should appear in the navigation sidebar regardless of plugin load order: - DNS - Topology Views - ... ### Observed Behavior Only some plugin menus appear in the navigation sidebar: - DNS (appears) - Topology Views (MISSING) - ... (MISSING) The missing menus are registered but not included in the final MENUS list. --- In `netbox/netbox/navigation/menu.py`, the MENUS list is built at import time: ```python MENUS = [ ORGANIZATION_MENU, RACKS_MENU, # ... other base menus ... ] # Add top-level plugin menus for menu in registry['plugins']['menus']: MENUS.append(menu) ``` This code executes when navigation/menu.py is imported during Django startup (in settings.py). At that point, only the first few plugins have called PluginConfig.ready() and registered their menus. 1. settings.py imports plugins and calls `PluginConfig.ready()` for each 2. `PluginConfig.ready()` imports the plugin's `navigation.menu` module 3. `navigation.menu` calls `register_menu()` to add the menu to `registry['plugins']['menus']` 4. But `netbox/navigation/menu.py` is imported BEFORE all plugins complete `ready()` 5. The MENUS list is built with only the menus registered so far

MrUnknownDE closed this issue

2026-04-05 16:44:47 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug type: bug

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#570