Models from plugin not showing up for custom field selection #17836
Replies: 7 comments 5 replies
-
|
Just dropping in to say check your permission roles if you have that setup, may need to allow scopes added by the plugin. |
Beta Was this translation helpful? Give feedback.
-
|
thanks for the tip. does this also apply to superusers? i haven't set any explicit permissions, just using it as superuser |
Beta Was this translation helpful? Give feedback.
-
|
It should not apply if you're a superuser I imagine, so most likely a bug then :). Good luck! |
Beta Was this translation helpful? Give feedback.
-
|
@mraerino can you please open this as a discussion and close this ticket? You will probably get more response as a discussion. |
Beta Was this translation helpful? Give feedback.
-
|
@mraerino I had exactly the same issue with a custom-developed plugin. So, I searched for the error in the source code of our plugin. Netbox: 4.1.3
|
Beta Was this translation helpful? Give feedback.
-
|
hmm, i'm not using the |
Beta Was this translation helpful? Give feedback.
-
|
I found the same problem with |
Beta Was this translation helpful? Give feedback.
-
|
This is a reminder that additional information is needed in order to further triage this issue. If the requested details are not provided, the issue will soon be closed automatically. |
Beta Was this translation helpful? Give feedback.
-
|
Hello, I had the same problem. It used to work in NetBox 3: plugins models showed up automaticaly in the custom field object selection. I found a fix: I explicitly call "register_models" in the ready method of my plugin: It seems to work. And indeed, each Netbox app does call register_models in "apps.py": |
Beta Was this translation helpful? Give feedback.
-
|
@mraerino Unfortunately, this does not work for me. I created a simple "reloader" plugin and added it to the from netbox.plugins import PluginConfig
class ReloaderConfig(PluginConfig):
name = "plugin_reloader"
verbose_name = "Plugin Reloader"
description = "Reload plugin"
version = '0.0.1'
base_url = "plugin-reloader"
default_settings = {}
required_settings = []
min_version = "4.2.0"
max_version = "4.2.99"
def ready(self):
# Call the original ready method
super().ready()
from django.conf import settings
from django.apps import apps
from netbox.models.features import register_models
from netbox.models.features import ChangeLoggingMixin, CustomFieldsMixin
from core.models import ObjectType
plugins = settings.PLUGINS
for plugin in plugins:
app_config = apps.get_app_config(plugin)
# REGISTER ALL INSTALLED PLUGIN MODELS
register_models(*app_config.get_models())
# DEBUG: Checking that all models use CustomFieldsMixin, for example
for model in app_config.get_models():
print(model)
print(issubclass(model, CustomFieldsMixin))
print()
import ipdb; ipdb.set_trace()
# DEBUG: Listing all Models that have the feature of custom_fields
for x in ObjectType.objects.with_feature('custom_fields'):
print(x)
print()
config = ReloaderConfigHowever, when I navigate to the page https://NETBOX/extras/custom-fields/add/, many plugin apps/models are missing from the My PLUGINS = [
'inventory_monitor',
'cesnet_service_path_plugin',
'netbox_cesnet_services_plugin',
'netbox_authorized_keys',
'netbox_attachments',
'plugin_reloader'
]When I reorder the plugins, some of them become visible, but others are still missing. No matter the order, I cannot get all Additionally, all of the models I debugged in the code have the feature enabled. This issue is definitely not caused solely by the |
Beta Was this translation helpful? Give feedback.
-
|
Okay, I conducted further investigation. I examined the code at this link where the class CustomFieldForm(forms.ModelForm):
object_types = ContentTypeMultipleChoiceField(
label=_('Object types'),
queryset=ObjectType.objects.with_feature('custom_fields'),
help_text=_("The type(s) of object that have this custom field")
)
# My code to debug which models from plugins will be displayed in the Custom Field form
from django.conf import settings
plugins = settings.PLUGINS
for x in ObjectType.objects.with_feature('custom_fields').filter(app_label__in=plugins):
print(x.app_label, x.model)
print()With my configuration: PLUGINS = [
'netbox_authorized_keys', # OK
'cesnet_service_path_plugin', # Not Displayed
'netbox_cesnet_services_plugin', # Not Displayed
'plugin_reloader'
]Only models from If I modify the order of PLUGINS to: PLUGINS = [
'cesnet_service_path_plugin', # OK
'netbox_cesnet_services_plugin', # OK
'netbox_authorized_keys', # Not Displayed
'plugin_reloader'
]Then the |
Beta Was this translation helpful? Give feedback.
-
|
I have added a WORKAROUND to the plugin_reloader plugin: from netbox.plugins import PluginConfig
class ReloaderConfig(PluginConfig):
name = "plugin_reloader"
verbose_name = "Plugin Reloader"
description = "Reload plugin"
version = "0.0.1"
base_url = "plugin-reloader"
default_settings = {}
required_settings = []
min_version = "4.2.0"
max_version = "4.2.99"
def ready(self):
# Call the original ready method
super().ready()
from core.models import ObjectType
from django.apps import apps
from django.conf import settings
from netbox.models.features import register_models
from utilities.forms.fields import ContentTypeMultipleChoiceField
from django.utils.translation import gettext_lazy as _
from extras.forms.model_forms import CustomFieldForm
plugins = settings.PLUGINS
for plugin in plugins:
app_config = apps.get_app_config(plugin)
register_models(*app_config.get_models())
# NOTE: Reload the queryset behind the object_types field in CustomFieldForm
# NOTE: Copied from https://github.com/netbox-community/netbox/blob/2a56c08bc8bd6a8038edf69e0b08e727fb71bc2c/netbox/extras/forms/model_forms.py#L45
object_types = ContentTypeMultipleChoiceField(
label=_("Object types"),
queryset=ObjectType.objects.with_feature("custom_fields"),
help_text=_("The type(s) of object that have this custom field"),
)
# Reinit CustomFieldForm object_types queryset
CustomFieldForm.base_fields["object_types"] = object_types
# Debug message
for x in ObjectType.objects.with_feature('custom_fields').filter(app_label__in=plugins):
print(x.app_label, x.model)
print()
config = ReloaderConfigThis code recreates the When the original After reinitializing the This suggests that when the |
Beta Was this translation helpful? Give feedback.
-
Deployment Type
Self-hosted
Triage priority
N/A
NetBox Version
v4.0.11
Python Version
3.11
Steps to Reproduce
First up, i want to say that i'm sadly not able to reproduce this on a fresh installation of Netbox. I'm looking for debugging advice since I'm not able to diagnose why this is happening on our production instance.
/extras/custom-fields/add/Expected Behavior
I expect the models from the BGP plugin to show up in the dropdown for the object types selection. They do on a fresh install.
Observed Behavior
The models from the BGP plugin are missing while I see other models and also models from other plugins. I have opened an issue with them, but i'm not sure anything is wrong with the plugin.
What I'm looking for is advice for how to debug this situation so that it becomes reproducible. Or could this be a configuration problem?
What I've done so far:
I've used the
nbshellto dig into the data the object types widget uses.Here's a screenshot showing that the BGP models are missing at the place where they should be:
Beta Was this translation helpful? Give feedback.
All reactions