From d4b96a5a276d29b41653a63b4da59411e502864b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 12 Oct 2020 09:51:11 -0400 Subject: [PATCH 01/26] Post-release version bump --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index e27939408..3db1c40cd 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.9.7' +VERSION = '2.9.8-dev' # Hostname HOSTNAME = platform.node() From 0d01a3fce8d97e319cde32d7235f3a5a130257b9 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 14 Oct 2020 10:42:31 -0400 Subject: [PATCH 02/26] Add schema migrations to plugins installation doc --- docs/plugins/index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 1f5587539..202e0a96b 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -64,6 +64,15 @@ PLUGINS_CONFIG = { } ``` +### Run Database Migrations + +If the plugin introduces new database models, run the provided schema migrations: + +```no-highlight +(venv) $ cd /opt/netbox/netbox/ +(venv) $ python3 manage.py migrate +``` + ### Collect Static Files Plugins may package static files to be served directly by the HTTP front end. Ensure that these are copied to the static root directory with the `collectstatic` management command: From 87c13a876b6a1975e79b8a12ca0ad8569a3e8aea Mon Sep 17 00:00:00 2001 From: John Anderson Date: Wed, 14 Oct 2020 20:10:21 -0400 Subject: [PATCH 03/26] fixes #5113 - incorrect caching of permission object assignments to user groups in the admin panel --- docs/release-notes/version-2.9.md | 6 ++++++ netbox/users/admin.py | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.9.md b/docs/release-notes/version-2.9.md index 4e758ead7..9fe32ff5f 100644 --- a/docs/release-notes/version-2.9.md +++ b/docs/release-notes/version-2.9.md @@ -1,5 +1,11 @@ # NetBox v2.9 +## v2.9.8 (FUTURE) + +### Bug Fixes + +* [#5113](https://github.com/netbox-community/netbox/issues/5113) - Fix incorrect caching of permission object assignments to user groups in the admin panel + ## v2.9.7 (2020-10-12) ### Bug Fixes diff --git a/netbox/users/admin.py b/netbox/users/admin.py index 1fac75899..5228fe6bf 100644 --- a/netbox/users/admin.py +++ b/netbox/users/admin.py @@ -22,7 +22,7 @@ class ObjectPermissionInline(admin.TabularInline): verbose_name_plural = 'Permissions' def get_queryset(self, request): - return super().get_queryset(request).prefetch_related('objectpermission__object_types') + return super().get_queryset(request).prefetch_related('objectpermission__object_types').nocache() @staticmethod def object_types(instance): From dde52309d25d6fd6ecc5f05c7a373fa81cb719dc Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 15 Oct 2020 16:55:20 -0400 Subject: [PATCH 04/26] Fixes #5243: Redirect user to appropriate tab after modifying device components --- docs/release-notes/version-2.9.md | 3 + netbox/dcim/tables.py | 24 ++++-- netbox/templates/dcim/device.html | 102 ++++++++++++++------------ netbox/templates/dcim/devicetype.html | 46 ++++++++++-- netbox/utilities/tables.py | 9 ++- 5 files changed, 119 insertions(+), 65 deletions(-) diff --git a/docs/release-notes/version-2.9.md b/docs/release-notes/version-2.9.md index 9fe32ff5f..bd11c0c76 100644 --- a/docs/release-notes/version-2.9.md +++ b/docs/release-notes/version-2.9.md @@ -5,6 +5,9 @@ ### Bug Fixes * [#5113](https://github.com/netbox-community/netbox/issues/5113) - Fix incorrect caching of permission object assignments to user groups in the admin panel +* [#5243](https://github.com/netbox-community/netbox/issues/5243) - Redirect user to appropriate tab after modifying device components + +--- ## v2.9.7 (2020-10-12) diff --git a/netbox/dcim/tables.py b/netbox/dcim/tables.py index 371eff9db..3106ed2a1 100644 --- a/netbox/dcim/tables.py +++ b/netbox/dcim/tables.py @@ -432,7 +432,8 @@ class ComponentTemplateTable(BaseTable): class ConsolePortTemplateTable(ComponentTemplateTable): actions = ButtonsColumn( model=ConsolePortTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_consoleports' ) class Meta(BaseTable.Meta): @@ -444,7 +445,8 @@ class ConsolePortTemplateTable(ComponentTemplateTable): class ConsoleServerPortTemplateTable(ComponentTemplateTable): actions = ButtonsColumn( model=ConsoleServerPortTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_consoleserverports' ) class Meta(BaseTable.Meta): @@ -456,7 +458,8 @@ class ConsoleServerPortTemplateTable(ComponentTemplateTable): class PowerPortTemplateTable(ComponentTemplateTable): actions = ButtonsColumn( model=PowerPortTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_powerports' ) class Meta(BaseTable.Meta): @@ -468,7 +471,8 @@ class PowerPortTemplateTable(ComponentTemplateTable): class PowerOutletTemplateTable(ComponentTemplateTable): actions = ButtonsColumn( model=PowerOutletTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_poweroutlets' ) class Meta(BaseTable.Meta): @@ -483,7 +487,8 @@ class InterfaceTemplateTable(ComponentTemplateTable): ) actions = ButtonsColumn( model=InterfaceTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_interfaces' ) class Meta(BaseTable.Meta): @@ -498,7 +503,8 @@ class FrontPortTemplateTable(ComponentTemplateTable): ) actions = ButtonsColumn( model=FrontPortTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_frontports' ) class Meta(BaseTable.Meta): @@ -510,7 +516,8 @@ class FrontPortTemplateTable(ComponentTemplateTable): class RearPortTemplateTable(ComponentTemplateTable): actions = ButtonsColumn( model=RearPortTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_rearports' ) class Meta(BaseTable.Meta): @@ -522,7 +529,8 @@ class RearPortTemplateTable(ComponentTemplateTable): class DeviceBayTemplateTable(ComponentTemplateTable): actions = ButtonsColumn( model=DeviceBayTemplate, - buttons=('edit', 'delete') + buttons=('edit', 'delete'), + return_url_extra='%23tab_devicebays' ) class Meta(BaseTable.Meta): diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index 477953a97..c42ef828e 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -48,28 +48,28 @@
    {% if perms.dcim.add_consoleport %} -
  • Console Ports
    • +
  • Console Ports
    • {% endif %} {% if perms.dcim.add_consoleserverport %} -
  • Console Server Ports
    • +
  • Console Server Ports
    • {% endif %} {% if perms.dcim.add_powerport %} -
  • Power Ports
    • +
  • Power Ports
    • {% endif %} {% if perms.dcim.add_poweroutlet %} -
  • Power Outlets
    • +
  • Power Outlets
    • {% endif %} {% if perms.dcim.add_interface %} -
  • Interfaces
    • +
  • Interfaces
    • {% endif %} {% if perms.dcim.add_frontport %} -
  • Front Ports
    • +
  • Front Ports
    • {% endif %} {% if perms.dcim.add_rearport %} -
  • Rear Ports
    • +
  • Rear Ports
    • {% endif %} {% if perms.dcim.add_devicebay %} -
  • Device Bays
    • +
  • Device Bays
    • {% endif %} {% if perms.dcim.add_inventoryitem %}
  • Inventory Items
    • @@ -537,26 +537,26 @@
    {% if interfaces and perms.dcim.change_interface %} - - {% endif %} {% if interfaces and perms.dcim.change_interface %} - {% endif %} {% if interfaces and perms.dcim.delete_interface %} - {% endif %} {% if perms.dcim.add_interface %}
    - + Add interfaces
    @@ -597,24 +597,24 @@
    {% if frontports and perms.dcim.change_frontport %} - - - {% endif %} {% if frontports and perms.dcim.delete_frontport %} - {% endif %} {% if perms.dcim.add_frontport %}
    - + Add front ports
    @@ -654,24 +654,24 @@
    {% if rearports and perms.dcim.change_rearport %} - - - {% endif %} {% if rearports and perms.dcim.delete_rearport %} - {% endif %} {% if perms.dcim.add_rearport %}
    - + Add rear ports
    @@ -708,24 +708,24 @@
    {% if consoleports and perms.dcim.change_consoleport %} - - - {% endif %} {% if consoleports and perms.dcim.delete_consoleport %} - {% endif %} {% if perms.dcim.add_consoleport %}
    - + Add console port
    @@ -763,24 +763,24 @@
    {% if consoleserverports and perms.dcim.change_consoleport %} - - - {% endif %} {% if consoleserverports and perms.dcim.delete_consoleserverport %} - {% endif %} {% if perms.dcim.add_consoleserverport %}
    - + Add console server ports
    @@ -818,24 +818,24 @@
    {% if powerports and perms.dcim.change_powerport %} - - - {% endif %} {% if powerports and perms.dcim.delete_powerport %} - {% endif %} {% if perms.dcim.add_powerport %}
    - + Add power port
    @@ -874,24 +874,24 @@
    {% if poweroutlets and perms.dcim.change_powerport %} - - - {% endif %} {% if poweroutlets and perms.dcim.delete_poweroutlet %} - {% endif %} {% if perms.dcim.add_poweroutlet %}
    - + Add power outlets
    @@ -933,18 +933,18 @@
    {% if devicebays and perms.dcim.change_devicebay %} - {% endif %} {% if devicebays and perms.dcim.delete_devicebay %} - {% endif %} {% if perms.dcim.add_devicebay %}
    - + Add device bays
    @@ -963,6 +963,16 @@ {% block javascript %} +{% endblock %} diff --git a/netbox/utilities/tables.py b/netbox/utilities/tables.py index 9b0af61bc..5dddf24ed 100644 --- a/netbox/utilities/tables.py +++ b/netbox/utilities/tables.py @@ -130,6 +130,7 @@ class ButtonsColumn(tables.TemplateColumn): :param model: Model class to use for calculating URL view names :param prepend_content: Additional template content to render in the column (optional) + :param return_url_extra: String to append to the return URL (e.g. for specifying a tab) (optional) """ buttons = ('changelog', 'edit', 'delete') attrs = {'td': {'class': 'text-right text-nowrap noprint'}} @@ -141,18 +142,19 @@ class ButtonsColumn(tables.TemplateColumn): {{% endif %}} {{% if "edit" in buttons and perms.{app_label}.change_{model_name} %}} - + {{% endif %}} {{% if "delete" in buttons and perms.{app_label}.delete_{model_name} %}} - + {{% endif %}} """ - def __init__(self, model, *args, pk_field='pk', buttons=None, prepend_template=None, **kwargs): + def __init__(self, model, *args, pk_field='pk', buttons=None, prepend_template=None, return_url_extra='', + **kwargs): if prepend_template: prepend_template = prepend_template.replace('{', '{{') prepend_template = prepend_template.replace('}', '}}') @@ -169,6 +171,7 @@ class ButtonsColumn(tables.TemplateColumn): self.extra_context.update({ 'buttons': buttons or self.buttons, + 'return_url_extra': return_url_extra, }) def header(self): From 3ba18633de14522e48dd9ac50c27ad308a18bb7c Mon Sep 17 00:00:00 2001 From: John Anderson Date: Tue, 20 Oct 2020 01:07:22 -0400 Subject: [PATCH 05/26] initial work on config context performance improvements --- netbox/dcim/api/views.py | 13 ++++++++- netbox/dcim/models/devices.py | 3 +- netbox/extras/models/models.py | 7 +++-- netbox/extras/querysets.py | 51 +++++++++++++++++++++++++++++++++- 4 files changed, 69 insertions(+), 5 deletions(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index f5b37021d..1967b5a3e 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -340,7 +340,18 @@ class DeviceViewSet(CustomFieldModelViewSet): queryset = Device.objects.prefetch_related( 'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'site', 'rack', 'parent_bay', 'virtual_chassis__master', 'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'tags', - ) + ).add_config_context_annotation() + + #queryset = Device.objects.annotate( + # config_contexts=Subquery( + # ConfigContext.objects.filter( + # Q(sites=OuterRef('site')) | Q(sites=None) + # ).annotate( + # _data=EmptyGroupByJSONBAgg('data') + # ).values("_data") + # ) + #) + filterset_class = filters.DeviceFilterSet def get_serializer_class(self): diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index e96becadf..413ba73c0 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -15,6 +15,7 @@ from taggit.managers import TaggableManager from dcim.choices import * from dcim.constants import * from extras.models import ChangeLoggedModel, ConfigContextModel, CustomFieldModel, TaggedItem +from extras.querysets import ConfigContextQuerySetMixin from extras.utils import extras_features from utilities.choices import ColorChoices from utilities.fields import ColorField, NaturalOrderingField @@ -594,7 +595,7 @@ class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): ) tags = TaggableManager(through=TaggedItem) - objects = RestrictedQuerySet.as_manager() + objects = ConfigContextQuerySetMixin.as_manager() csv_headers = [ 'name', 'device_role', 'tenant', 'manufacturer', 'device_type', 'platform', 'serial', 'asset_tag', 'status', diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index e57caf091..e5577b5a9 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -542,8 +542,11 @@ class ConfigContextModel(models.Model): # Compile all config data, overwriting lower-weight values with higher-weight values where a collision occurs data = OrderedDict() - for context in ConfigContext.objects.get_for_object(self): - data = deepmerge(data, context.data) + #for context in ConfigContext.objects.get_for_object(self): + # data = deepmerge(data, context.data) + + for context in self.config_contexts: + data = deepmerge(data, context) # If the object has local config context data defined, merge it last if self.local_context_data: diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index 9d9b55778..c8b15f5a2 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -1,6 +1,7 @@ from collections import OrderedDict -from django.db.models import Q, QuerySet +from django.contrib.postgres.aggregates import JSONBAgg +from django.db.models import OuterRef, Subquery, Q, QuerySet from utilities.querysets import RestrictedQuerySet @@ -57,3 +58,51 @@ class ConfigContextQuerySet(RestrictedQuerySet): Q(tags__slug__in=obj.tags.slugs()) | Q(tags=None), is_active=True, ).order_by('weight', 'name') + + +class EmptyGroupByJSONBAgg(JSONBAgg): + contains_aggregate = False + + +class ConfigContextQuerySetMixin(RestrictedQuerySet): + + def add_config_context_annotation(self): + from extras.models import ConfigContext + return self.annotate( + config_contexts=Subquery( + ConfigContext.objects.filter( + self._add_config_context_filters() + ).order_by( + 'weight', + 'name' + ).annotate( + _data=EmptyGroupByJSONBAgg('data') + ).values("_data") + ) + ) + + def _add_config_context_filters(self): + + + if self.model._meta.model_name == 'device': + return Q( + Q(sites=OuterRef('site')) | Q(sites=None), + Q(roles=OuterRef('device_role')) | Q(roles=None), + Q(platforms=OuterRef('platform')) | Q(platforms=None), + Q(tenant_groups=OuterRef('tenant__group')) | Q(tenant_groups=None), + Q(tenants=OuterRef('tenant')) | Q(tenants=None), + Q(tags=OuterRef('tags')) | Q(tags=None), + is_active=True, + ) + else: + return Q( + Q(sites=OuterRef('site')) | Q(sites=None), + Q(roles=OuterRef('role')) | Q(roles=None), + Q(platforms=OuterRef('platform')) | Q(platforms=None), + Q(cluster_groups=OuterRef('cluster__group')) | Q(cluster_groups=None), + Q(clusters=OuterRef('cluster')) | Q(clusters=None), + Q(tenant_groups=OuterRef('tenant__group')) | Q(tenant_groups=None), + Q(tenants=OuterRef('tenant')) | Q(tenants=None), + Q(tags=OuterRef('tags')) | Q(tags=None), + is_active=True, + ) From 22d2289ed2b809f9e676d8966fa99aa6268b150e Mon Sep 17 00:00:00 2001 From: John Anderson Date: Fri, 23 Oct 2020 01:18:04 -0400 Subject: [PATCH 06/26] add support for regions and vms --- netbox/dcim/api/views.py | 28 +++++++----- netbox/dcim/models/devices.py | 4 +- netbox/dcim/views.py | 2 +- netbox/extras/models/models.py | 4 +- netbox/extras/querysets.py | 68 +++++++++++++++++------------ netbox/utilities/query_functions.py | 10 +++++ netbox/virtualization/api/views.py | 15 +++++++ netbox/virtualization/models.py | 3 +- netbox/virtualization/views.py | 2 +- 9 files changed, 87 insertions(+), 49 deletions(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 1967b5a3e..956b0cbff 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -340,20 +340,24 @@ class DeviceViewSet(CustomFieldModelViewSet): queryset = Device.objects.prefetch_related( 'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'site', 'rack', 'parent_bay', 'virtual_chassis__master', 'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'tags', - ).add_config_context_annotation() - - #queryset = Device.objects.annotate( - # config_contexts=Subquery( - # ConfigContext.objects.filter( - # Q(sites=OuterRef('site')) | Q(sites=None) - # ).annotate( - # _data=EmptyGroupByJSONBAgg('data') - # ).values("_data") - # ) - #) - + ) filterset_class = filters.DeviceFilterSet + def get_queryset(self): + """ + Build the proper queryset based on the request context + + If the `brief` query param equates to True or the `exclude` query param + includes `config_context` as a value, return the base queryset. + + Else, return the queryset annotated with config context data + """ + + request = self.get_serializer_context()['request'] + if request.query_params.get('brief') or 'config_context' in request.query_params.get('exclude', []): + return self.queryset + return self.queryset.annotate_config_context_data() + def get_serializer_class(self): """ Select the specific serializer based on the request context. diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index 413ba73c0..6fe2cea2f 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -15,7 +15,7 @@ from taggit.managers import TaggableManager from dcim.choices import * from dcim.constants import * from extras.models import ChangeLoggedModel, ConfigContextModel, CustomFieldModel, TaggedItem -from extras.querysets import ConfigContextQuerySetMixin +from extras.querysets import ConfigContextModelQuerySet from extras.utils import extras_features from utilities.choices import ColorChoices from utilities.fields import ColorField, NaturalOrderingField @@ -595,7 +595,7 @@ class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): ) tags = TaggableManager(through=TaggedItem) - objects = ConfigContextQuerySetMixin.as_manager() + objects = ConfigContextModelQuerySet.as_manager() csv_headers = [ 'name', 'device_role', 'tenant', 'manufacturer', 'device_type', 'platform', 'serial', 'asset_tag', 'status', diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index c6c0ced97..886f3e702 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -1163,7 +1163,7 @@ class DeviceConfigView(ObjectView): class DeviceConfigContextView(ObjectConfigContextView): - queryset = Device.objects.all() + queryset = Device.objects.annotate_config_context_data() base_template = 'dcim/device.html' diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index e5577b5a9..efb165a06 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -542,10 +542,8 @@ class ConfigContextModel(models.Model): # Compile all config data, overwriting lower-weight values with higher-weight values where a collision occurs data = OrderedDict() - #for context in ConfigContext.objects.get_for_object(self): - # data = deepmerge(data, context.data) - for context in self.config_contexts: + for context in self.config_context_data: data = deepmerge(data, context) # If the object has local config context data defined, merge it last diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index c8b15f5a2..dea03bccd 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -1,8 +1,8 @@ from collections import OrderedDict -from django.contrib.postgres.aggregates import JSONBAgg from django.db.models import OuterRef, Subquery, Q, QuerySet +from utilities.query_functions import EmptyGroupByJSONBAgg from utilities.querysets import RestrictedQuerySet @@ -60,18 +60,14 @@ class ConfigContextQuerySet(RestrictedQuerySet): ).order_by('weight', 'name') -class EmptyGroupByJSONBAgg(JSONBAgg): - contains_aggregate = False +class ConfigContextModelQuerySet(RestrictedQuerySet): - -class ConfigContextQuerySetMixin(RestrictedQuerySet): - - def add_config_context_annotation(self): + def annotate_config_context_data(self): from extras.models import ConfigContext return self.annotate( - config_contexts=Subquery( + config_context_data=Subquery( ConfigContext.objects.filter( - self._add_config_context_filters() + self._get_config_context_filters() ).order_by( 'weight', 'name' @@ -81,28 +77,42 @@ class ConfigContextQuerySetMixin(RestrictedQuerySet): ) ) - def _add_config_context_filters(self): + def _get_config_context_filters(self): + base_query = Q( + Q(platforms=OuterRef('platform')) | Q(platforms=None), + Q(tenant_groups=OuterRef('tenant__group')) | Q(tenant_groups=None), + Q(tenants=OuterRef('tenant')) | Q(tenants=None), + Q(tags=OuterRef('tags')) | Q(tags=None), + is_active=True, + ) if self.model._meta.model_name == 'device': - return Q( - Q(sites=OuterRef('site')) | Q(sites=None), - Q(roles=OuterRef('device_role')) | Q(roles=None), - Q(platforms=OuterRef('platform')) | Q(platforms=None), - Q(tenant_groups=OuterRef('tenant__group')) | Q(tenant_groups=None), - Q(tenants=OuterRef('tenant')) | Q(tenants=None), - Q(tags=OuterRef('tags')) | Q(tags=None), - is_active=True, + base_query.add((Q(roles=OuterRef('device_role')) | Q(roles=None)), Q.AND) + base_query.add( + (Q( + regions__tree_id=OuterRef('site__region__tree_id'), + regions__level__lte=OuterRef('site__region__level'), + regions__lft__lte=OuterRef('site__region__lft'), + regions__rght__gte=OuterRef('site__region__rght'), + ) | Q(regions=None)), + Q.AND ) - else: - return Q( - Q(sites=OuterRef('site')) | Q(sites=None), - Q(roles=OuterRef('role')) | Q(roles=None), - Q(platforms=OuterRef('platform')) | Q(platforms=None), - Q(cluster_groups=OuterRef('cluster__group')) | Q(cluster_groups=None), - Q(clusters=OuterRef('cluster')) | Q(clusters=None), - Q(tenant_groups=OuterRef('tenant__group')) | Q(tenant_groups=None), - Q(tenants=OuterRef('tenant')) | Q(tenants=None), - Q(tags=OuterRef('tags')) | Q(tags=None), - is_active=True, + base_query.add((Q(sites=OuterRef('site')) | Q(sites=None)), Q.AND) + + elif self.model._meta.model_name == 'virtualmachine': + base_query.add((Q(roles=OuterRef('role')) | Q(roles=None)), Q.AND) + base_query.add((Q(cluster_groups=OuterRef('cluster__group')) | Q(cluster_groups=None)), Q.AND) + base_query.add((Q(clusters=OuterRef('cluster')) | Q(clusters=None)), Q.AND) + base_query.add( + (Q( + regions__tree_id=OuterRef('cluster__site__region__tree_id'), + regions__level__lte=OuterRef('cluster__site__region__level'), + regions__lft__lte=OuterRef('cluster__site__region__lft'), + regions__rght__gte=OuterRef('cluster__site__region__rght'), + ) | Q(regions=None)), + Q.AND ) + base_query.add((Q(sites=OuterRef('cluster__site')) | Q(sites=None)), Q.AND) + + return base_query diff --git a/netbox/utilities/query_functions.py b/netbox/utilities/query_functions.py index ee4310ea7..8ad7ceead 100644 --- a/netbox/utilities/query_functions.py +++ b/netbox/utilities/query_functions.py @@ -1,3 +1,4 @@ +from django.contrib.postgres.aggregates import JSONBAgg from django.db.models import F, Func @@ -7,3 +8,12 @@ class CollateAsChar(Func): """ function = 'C' template = '(%(expressions)s) COLLATE "%(function)s"' + + +class EmptyGroupByJSONBAgg(JSONBAgg): + """ + JSONBAgg is a builtin aggregation function which means it includes the use of a GROUP BY clause. + When used as an annotation for collecting config context data objects, the GROUP BY is + incorrect. This subclass overrides the Django ORM aggregation control to remove the GROUP BY. + """ + contains_aggregate = False diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index 1bf41c2b7..d19f0f9fa 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -64,6 +64,21 @@ class VirtualMachineViewSet(CustomFieldModelViewSet): ) filterset_class = filters.VirtualMachineFilterSet + def get_queryset(self): + """ + Build the proper queryset based on the request context + + If the `brief` query param equates to True or the `exclude` query param + includes `config_context` as a value, return the base queryset. + + Else, return the queryset annotated with config context data + """ + + request = self.get_serializer_context()['request'] + if request.query_params.get('brief') or 'config_context' in request.query_params.get('exclude', []): + return self.queryset + return self.queryset.annotate_config_context_data() + def get_serializer_class(self): """ Select the specific serializer based on the request context. diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index 7d0b99872..39f579e30 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -8,6 +8,7 @@ from taggit.managers import TaggableManager from dcim.choices import InterfaceModeChoices from dcim.models import BaseInterface, Device from extras.models import ChangeLoggedModel, ConfigContextModel, CustomFieldModel, ObjectChange, TaggedItem +from extras.querysets import ConfigContextModelQuerySet from extras.utils import extras_features from utilities.fields import NaturalOrderingField from utilities.ordering import naturalize_interface @@ -282,7 +283,7 @@ class VirtualMachine(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): ) tags = TaggableManager(through=TaggedItem) - objects = RestrictedQuerySet.as_manager() + objects = ConfigContextModelQuerySet.as_manager() csv_headers = [ 'name', 'status', 'role', 'cluster', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', diff --git a/netbox/virtualization/views.py b/netbox/virtualization/views.py index a06a2e5ff..4cabfedeb 100644 --- a/netbox/virtualization/views.py +++ b/netbox/virtualization/views.py @@ -261,7 +261,7 @@ class VirtualMachineView(ObjectView): class VirtualMachineConfigContextView(ObjectConfigContextView): - queryset = VirtualMachine.objects.all() + queryset = VirtualMachine.objects.annotate_config_context_data() base_template = 'virtualization/virtualmachine.html' From 82f5d0070e2d97672b7b27937da094b5c90fa811 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Fri, 23 Oct 2020 10:56:02 -0400 Subject: [PATCH 07/26] account for null value annotations --- netbox/extras/models/models.py | 9 ++++++++- netbox/extras/querysets.py | 28 +++++++++++++++++++++++++--- 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index efb165a06..fe4531b51 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -543,7 +543,14 @@ class ConfigContextModel(models.Model): # Compile all config data, overwriting lower-weight values with higher-weight values where a collision occurs data = OrderedDict() - for context in self.config_context_data: + if not hasattr(self, 'config_context_data'): + # The annotation is not available, so we fall back to manually querying for the config context objects + config_context_data = ConfigContext.objects.get_for_object(self, aggregate_data=True) + else: + # The attribute may exist, but the annotated value could be None if there is no config context data + config_context_data = self.config_context_data or [] + + for context in config_context_data: data = deepmerge(data, context) # If the object has local config context data defined, merge it last diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index dea03bccd..c5b3de35b 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -1,5 +1,6 @@ from collections import OrderedDict +from django.contrib.postgres.aggregates import JSONBAgg from django.db.models import OuterRef, Subquery, Q, QuerySet from utilities.query_functions import EmptyGroupByJSONBAgg @@ -24,9 +25,12 @@ class CustomFieldQueryset: class ConfigContextQuerySet(RestrictedQuerySet): - def get_for_object(self, obj): + def get_for_object(self, obj, aggregate_data=False): """ Return all applicable ConfigContexts for a given object. Only active ConfigContexts will be included. + + Args: + aggregate_data: If True, use the JSONBAgg aggregate function to return only the list of JSON data objects """ # `device_role` for Device; `role` for VirtualMachine @@ -46,7 +50,7 @@ class ConfigContextQuerySet(RestrictedQuerySet): else: regions = [] - return self.filter( + queryset = self.filter( Q(regions__in=regions) | Q(regions=None), Q(sites=obj.site) | Q(sites=None), Q(roles=role) | Q(roles=None), @@ -59,10 +63,28 @@ class ConfigContextQuerySet(RestrictedQuerySet): is_active=True, ).order_by('weight', 'name') + if aggregate_data: + queryset = queryset.aggregate(config_context_data=JSONBAgg('data'))['config_context_data'] + + return queryset + class ConfigContextModelQuerySet(RestrictedQuerySet): + """ + QuerySet manager used by models which support ConfigContext (device and virtual machine). + + Includes a method which appends an annotation of aggregated config context JSON data objects. This is + implemented as a subquery which performs all the joins necessary to filter relevant config context objects. + This offers a substantial performance gain over ConfigContextQuerySet.get_for_object() when dealing with + multiple objects. + + This allows the annotation to be entirely optional. + """ def annotate_config_context_data(self): + """ + Attach the subquery annotation to the base queryset + """ from extras.models import ConfigContext return self.annotate( config_context_data=Subquery( @@ -78,7 +100,7 @@ class ConfigContextModelQuerySet(RestrictedQuerySet): ) def _get_config_context_filters(self): - + # Construct the set of Q objects for the specific object types base_query = Q( Q(platforms=OuterRef('platform')) | Q(platforms=None), Q(tenant_groups=OuterRef('tenant__group')) | Q(tenant_groups=None), From 9e84e3b83bddc796f5031aa3888bcd4bab585291 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 25 Oct 2020 16:49:18 -0400 Subject: [PATCH 08/26] added tests --- netbox/extras/querysets.py | 13 +- netbox/extras/tests/test_models.py | 280 +++++++++++++++++++++++++++- netbox/utilities/query_functions.py | 12 +- 3 files changed, 295 insertions(+), 10 deletions(-) diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index c5b3de35b..b48d82287 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -1,9 +1,9 @@ from collections import OrderedDict from django.contrib.postgres.aggregates import JSONBAgg -from django.db.models import OuterRef, Subquery, Q, QuerySet +from django.db.models import OuterRef, Subquery, Q, QuerySet, OrderBy, F, ExpressionWrapper -from utilities.query_functions import EmptyGroupByJSONBAgg +from utilities.query_functions import EmptyGroupByJSONBAgg, OrderableJSONBAgg from utilities.querysets import RestrictedQuerySet @@ -64,7 +64,9 @@ class ConfigContextQuerySet(RestrictedQuerySet): ).order_by('weight', 'name') if aggregate_data: - queryset = queryset.aggregate(config_context_data=JSONBAgg('data'))['config_context_data'] + return queryset.aggregate( + config_context_data=OrderableJSONBAgg('data', ordering=['weight', 'name']) + )['config_context_data'] return queryset @@ -90,11 +92,8 @@ class ConfigContextModelQuerySet(RestrictedQuerySet): config_context_data=Subquery( ConfigContext.objects.filter( self._get_config_context_filters() - ).order_by( - 'weight', - 'name' ).annotate( - _data=EmptyGroupByJSONBAgg('data') + _data=EmptyGroupByJSONBAgg('data', ordering=['weight', 'name']) ).values("_data") ) ) diff --git a/netbox/extras/tests/test_models.py b/netbox/extras/tests/test_models.py index 22e6e1f8f..b0c5fb402 100644 --- a/netbox/extras/tests/test_models.py +++ b/netbox/extras/tests/test_models.py @@ -1,9 +1,11 @@ from django.contrib.contenttypes.models import ContentType from django.test import TestCase -from dcim.models import Site +from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Platform, Site, Region from extras.choices import TemplateLanguageChoices -from extras.models import Graph, Tag +from extras.models import ConfigContext, Graph, Tag +from tenancy.models import Tenant, TenantGroup +from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine class GraphTest(TestCase): @@ -53,3 +55,277 @@ class TagTest(TestCase): tag.save() self.assertEqual(tag.slug, 'testing-unicode-台灣') + + +class ConfigContextTest(TestCase): + """ + These test cases deal with the weighting, ordering, and deep merge logic of config context data. + + It also ensures the various config context querysets are consistent. + """ + + def setUp(self): + + manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1') + self.devicetype = DeviceType.objects.create(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1') + self.devicerole = DeviceRole.objects.create(name='Device Role 1', slug='device-role-1') + self.region = Region.objects.create(name="Region") + self.site = Site.objects.create(name='Site-1', slug='site-1', region=self.region) + self.platform = Platform.objects.create(name="Platform") + self.tenantgroup = TenantGroup.objects.create(name="Tenant Group") + self.tenant = Tenant.objects.create(name="Tenant", group=self.tenantgroup) + self.tag = Tag.objects.create(name="Tag", slug="tag") + + self.device = Device.objects.create( + name='Device 1', + device_type=self.devicetype, + device_role=self.devicerole, + site=self.site + ) + + def test_higher_weight_wins(self): + + context1 = ConfigContext( + name="context 1", + weight=101, + data={ + "a": 123, + "b": 456, + "c": 777 + } + ) + context2 = ConfigContext( + name="context 2", + weight=100, + data={ + "a": 123, + "b": 456, + "c": 789 + } + ) + ConfigContext.objects.bulk_create([context1, context2]) + + expected_data = { + "a": 123, + "b": 456, + "c": 777 + } + self.assertEqual(self.device.get_config_context(), expected_data) + + def test_name_ordering_after_weight(self): + + context1 = ConfigContext( + name="context 1", + weight=100, + data={ + "a": 123, + "b": 456, + "c": 777 + } + ) + context2 = ConfigContext( + name="context 2", + weight=100, + data={ + "a": 123, + "b": 456, + "c": 789 + } + ) + ConfigContext.objects.bulk_create([context1, context2]) + + expected_data = { + "a": 123, + "b": 456, + "c": 789 + } + self.assertEqual(self.device.get_config_context(), expected_data) + + def test_annotation_same_as_get_for_object(self): + """ + This test incorperates features from all of the above tests cases to ensure + the annotate_config_context_data() and get_for_object() queryset methods are the same. + """ + context1 = ConfigContext( + name="context 1", + weight=101, + data={ + "a": 123, + "b": 456, + "c": 777 + } + ) + context2 = ConfigContext( + name="context 2", + weight=100, + data={ + "a": 123, + "b": 456, + "c": 789 + } + ) + context3 = ConfigContext( + name="context 3", + weight=99, + data={ + "d": 1 + } + ) + context4 = ConfigContext( + name="context 4", + weight=99, + data={ + "d": 2 + } + ) + ConfigContext.objects.bulk_create([context1, context2, context3, context4]) + + annotated_queryset = Device.objects.filter(name=self.device.name).annotate_config_context_data() + self.assertEqual(self.device.get_config_context(), annotated_queryset[0].get_config_context()) + + def test_annotation_same_as_get_for_object_device_relations(self): + + site_context = ConfigContext.objects.create( + name="site", + weight=100, + data={ + "site": 1 + } + ) + site_context.sites.add(self.site) + region_context = ConfigContext.objects.create( + name="region", + weight=100, + data={ + "region": 1 + } + ) + region_context.regions.add(self.region) + platform_context = ConfigContext.objects.create( + name="platform", + weight=100, + data={ + "platform": 1 + } + ) + platform_context.platforms.add(self.platform) + tenant_group_context = ConfigContext.objects.create( + name="tenant group", + weight=100, + data={ + "tenant_group": 1 + } + ) + tenant_group_context.tenant_groups.add(self.tenantgroup) + tenant_context = ConfigContext.objects.create( + name="tenant", + weight=100, + data={ + "tenant": 1 + } + ) + tenant_context.tenants.add(self.tenant) + tag_context = ConfigContext.objects.create( + name="tag", + weight=100, + data={ + "tag": 1 + } + ) + tag_context.tags.add(self.tag) + + device = Device.objects.create( + name="Device 2", + site=self.site, + tenant=self.tenant, + platform=self.platform, + device_role=self.devicerole, + device_type=self.devicetype + ) + device.tags.add(self.tag) + + annotated_queryset = Device.objects.filter(name=device.name).annotate_config_context_data() + self.assertEqual(device.get_config_context(), annotated_queryset[0].get_config_context()) + + def test_annotation_same_as_get_for_object_virtualmachine_relations(self): + + site_context = ConfigContext.objects.create( + name="site", + weight=100, + data={ + "site": 1 + } + ) + site_context.sites.add(self.site) + region_context = ConfigContext.objects.create( + name="region", + weight=100, + data={ + "region": 1 + } + ) + region_context.regions.add(self.region) + platform_context = ConfigContext.objects.create( + name="platform", + weight=100, + data={ + "platform": 1 + } + ) + platform_context.platforms.add(self.platform) + tenant_group_context = ConfigContext.objects.create( + name="tenant group", + weight=100, + data={ + "tenant_group": 1 + } + ) + tenant_group_context.tenant_groups.add(self.tenantgroup) + tenant_context = ConfigContext.objects.create( + name="tenant", + weight=100, + data={ + "tenant": 1 + } + ) + tenant_context.tenants.add(self.tenant) + tag_context = ConfigContext.objects.create( + name="tag", + weight=100, + data={ + "tag": 1 + } + ) + tag_context.tags.add(self.tag) + cluster_group = ClusterGroup.objects.create(name="Cluster Group") + cluster_group_context = ConfigContext.objects.create( + name="cluster group", + weight=100, + data={ + "cluster_group": 1 + } + ) + cluster_group_context.cluster_groups.add(cluster_group) + cluster_type = ClusterType.objects.create(name="Cluster Type 1") + cluster = Cluster.objects.create(name="Cluster", group=cluster_group, type=cluster_type) + cluster_context = ConfigContext.objects.create( + name="cluster", + weight=100, + data={ + "cluster": 1 + } + ) + cluster_context.clusters.add(cluster) + + + virtual_machine = VirtualMachine.objects.create( + name="VM 1", + cluster=cluster, + tenant=self.tenant, + platform=self.platform, + role=self.devicerole + ) + virtual_machine.tags.add(self.tag) + + annotated_queryset = VirtualMachine.objects.filter(name=virtual_machine.name).annotate_config_context_data() + self.assertEqual(virtual_machine.get_config_context(), annotated_queryset[0].get_config_context()) \ No newline at end of file diff --git a/netbox/utilities/query_functions.py b/netbox/utilities/query_functions.py index 8ad7ceead..abdc61b6b 100644 --- a/netbox/utilities/query_functions.py +++ b/netbox/utilities/query_functions.py @@ -1,4 +1,5 @@ from django.contrib.postgres.aggregates import JSONBAgg +from django.contrib.postgres.aggregates.mixins import OrderableAggMixin from django.db.models import F, Func @@ -10,10 +11,19 @@ class CollateAsChar(Func): template = '(%(expressions)s) COLLATE "%(function)s"' -class EmptyGroupByJSONBAgg(JSONBAgg): +class OrderableJSONBAgg(OrderableAggMixin, JSONBAgg): + """ + TODO in Django 3.2 ordering is supported natively on JSONBAgg so this is no longer needed. + """ + template = '%(function)s(%(distinct)s%(expressions)s %(ordering)s)' + + +class EmptyGroupByJSONBAgg(OrderableJSONBAgg): """ JSONBAgg is a builtin aggregation function which means it includes the use of a GROUP BY clause. When used as an annotation for collecting config context data objects, the GROUP BY is incorrect. This subclass overrides the Django ORM aggregation control to remove the GROUP BY. + + TODO in Django 3.2 ordering is supported natively on JSONBAgg so we only need to inherit from JSONBAgg. """ contains_aggregate = False From 26ff33c41a228db42f42d091c13d7159f039d56d Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 25 Oct 2020 17:56:42 -0400 Subject: [PATCH 09/26] pep8 --- netbox/extras/tests/test_models.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/netbox/extras/tests/test_models.py b/netbox/extras/tests/test_models.py index b0c5fb402..280da75b6 100644 --- a/netbox/extras/tests/test_models.py +++ b/netbox/extras/tests/test_models.py @@ -317,7 +317,6 @@ class ConfigContextTest(TestCase): ) cluster_context.clusters.add(cluster) - virtual_machine = VirtualMachine.objects.create( name="VM 1", cluster=cluster, @@ -328,4 +327,4 @@ class ConfigContextTest(TestCase): virtual_machine.tags.add(self.tag) annotated_queryset = VirtualMachine.objects.filter(name=virtual_machine.name).annotate_config_context_data() - self.assertEqual(virtual_machine.get_config_context(), annotated_queryset[0].get_config_context()) \ No newline at end of file + self.assertEqual(virtual_machine.get_config_context(), annotated_queryset[0].get_config_context()) From 9bfb89fffdacc43ad84dbf3dea7b4971db8d12eb Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 25 Oct 2020 18:17:07 -0400 Subject: [PATCH 10/26] fixes #3672 - update django-cacheops to 5.1.0 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 502d97795..f26d44471 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ Django==3.1 -django-cacheops==5.0.1 +django-cacheops==5.1.0 django-cors-headers==3.4.0 django-debug-toolbar==2.2 django-filter==2.3.0 From 034ff2fb3f59e5332daaa657d2d8bd9278fb33cb Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 25 Oct 2020 18:18:57 -0400 Subject: [PATCH 11/26] #3672 changelog --- docs/release-notes/version-2.9.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.9.md b/docs/release-notes/version-2.9.md index bd11c0c76..7eaf276a2 100644 --- a/docs/release-notes/version-2.9.md +++ b/docs/release-notes/version-2.9.md @@ -3,7 +3,7 @@ ## v2.9.8 (FUTURE) ### Bug Fixes - +* [#3672](https://github.com/netbox-community/netbox/issues/3672) - Fix a caching issue causing incorrect related object counts in API responses * [#5113](https://github.com/netbox-community/netbox/issues/5113) - Fix incorrect caching of permission object assignments to user groups in the admin panel * [#5243](https://github.com/netbox-community/netbox/issues/5243) - Redirect user to appropriate tab after modifying device components From 478d82196a4c0b29b7f0e876d9b4700eba53d3f3 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 25 Oct 2020 18:20:21 -0400 Subject: [PATCH 12/26] rebase develop --- docs/release-notes/version-2.9.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.9.md b/docs/release-notes/version-2.9.md index 7eaf276a2..870f77ed4 100644 --- a/docs/release-notes/version-2.9.md +++ b/docs/release-notes/version-2.9.md @@ -3,7 +3,7 @@ ## v2.9.8 (FUTURE) ### Bug Fixes -* [#3672](https://github.com/netbox-community/netbox/issues/3672) - Fix a caching issue causing incorrect related object counts in API responses +* [#3672](https://github.com/netbox-community/netbox/issues/3672) - Fix a caching issue causing incorrect related object counts in API responses * [#5113](https://github.com/netbox-community/netbox/issues/5113) - Fix incorrect caching of permission object assignments to user groups in the admin panel * [#5243](https://github.com/netbox-community/netbox/issues/5243) - Redirect user to appropriate tab after modifying device components From 047f03a58c085b736f243e4a1d801dec5864dc7a Mon Sep 17 00:00:00 2001 From: John Anderson Date: Sun, 25 Oct 2020 19:00:56 -0400 Subject: [PATCH 13/26] clean up imports --- netbox/extras/querysets.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index b48d82287..5e7884a0d 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -1,7 +1,6 @@ from collections import OrderedDict -from django.contrib.postgres.aggregates import JSONBAgg -from django.db.models import OuterRef, Subquery, Q, QuerySet, OrderBy, F, ExpressionWrapper +from django.db.models import OuterRef, Subquery, Q from utilities.query_functions import EmptyGroupByJSONBAgg, OrderableJSONBAgg from utilities.querysets import RestrictedQuerySet From 2f3557c18f1ff5bec8f85626e2786df534b357b7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 27 Oct 2020 10:01:49 -0400 Subject: [PATCH 14/26] Fixes #5273: Fix exception when validating a new permission with no models selected --- docs/release-notes/version-2.9.md | 1 + netbox/users/admin.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.9.md b/docs/release-notes/version-2.9.md index 870f77ed4..f54b3a907 100644 --- a/docs/release-notes/version-2.9.md +++ b/docs/release-notes/version-2.9.md @@ -6,6 +6,7 @@ * [#3672](https://github.com/netbox-community/netbox/issues/3672) - Fix a caching issue causing incorrect related object counts in API responses * [#5113](https://github.com/netbox-community/netbox/issues/5113) - Fix incorrect caching of permission object assignments to user groups in the admin panel * [#5243](https://github.com/netbox-community/netbox/issues/5243) - Redirect user to appropriate tab after modifying device components +* [#5273](https://github.com/netbox-community/netbox/issues/5273) - Fix exception when validating a new permission with no models selected --- diff --git a/netbox/users/admin.py b/netbox/users/admin.py index 5228fe6bf..c03e6f740 100644 --- a/netbox/users/admin.py +++ b/netbox/users/admin.py @@ -185,7 +185,7 @@ class ObjectPermissionForm(forms.ModelForm): # Validate the specified model constraints by attempting to execute a query. We don't care whether the query # returns anything; we just want to make sure the specified constraints are valid. - if constraints: + if object_types and constraints: # Normalize the constraints to a list of dicts if type(constraints) is not list: constraints = [constraints] From 6404657f9989ffa8570e961f84818c3de9be44d2 Mon Sep 17 00:00:00 2001 From: systeembeheerder <19684880+systeembeheerder@users.noreply.github.com> Date: Tue, 27 Oct 2020 16:07:38 +0100 Subject: [PATCH 15/26] Update upgrading.md confirm 5275; use absolute paths --- docs/installation/upgrading.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/installation/upgrading.md b/docs/installation/upgrading.md index 34274342c..307682d55 100644 --- a/docs/installation/upgrading.md +++ b/docs/installation/upgrading.md @@ -28,44 +28,44 @@ Download and extract the latest version: # wget https://github.com/netbox-community/netbox/archive/vX.Y.Z.tar.gz # tar -xzf vX.Y.Z.tar.gz -C /opt # cd /opt/ -# ln -sfn netbox-X.Y.Z/ netbox +# ln -sfn /opt/netbox-X.Y.Z/ /opt/netbox ``` Copy the 'configuration.py' you created when first installing to the new version: ```no-highlight -# cp netbox-X.Y.Z/netbox/netbox/configuration.py netbox/netbox/netbox/configuration.py +# cp /opt/netbox-X.Y.Z/netbox/netbox/configuration.py /opt/netbox/netbox/netbox/configuration.py ``` Copy your local requirements file if used: ```no-highlight -# cp netbox-X.Y.Z/local_requirements.txt netbox/local_requirements.txt +# cp /opt/netbox-X.Y.Z/local_requirements.txt /opt/netbox/local_requirements.txt ``` Also copy the LDAP configuration if using LDAP: ```no-highlight -# cp netbox-X.Y.Z/netbox/netbox/ldap_config.py netbox/netbox/netbox/ldap_config.py +# cp /opt/netbox-X.Y.Z/netbox/netbox/ldap_config.py /opt/netbox/netbox/netbox/ldap_config.py ``` Be sure to replicate your uploaded media as well. (The exact action necessary will depend on where you choose to store your media, but in general moving or copying the media directory will suffice.) ```no-highlight -# cp -pr netbox-X.Y.Z/netbox/media/ netbox/netbox/ +# cp -pr /opt/netbox-X.Y.Z/netbox/media/ netbox/netbox/ ``` Also make sure to copy over any custom scripts and reports that you've made. Note that if these are stored outside the project root, you will not need to copy them. (Check the `SCRIPTS_ROOT` and `REPORTS_ROOT` parameters in the configuration file above if you're unsure.) ```no-highlight -# cp -r /opt/netbox-X.Y.Z/netbox/scripts /opt/netbox/netbox/scripts/ -# cp -r /opt/netbox-X.Y.Z/netbox/reports /opt/netbox/netbox/reports/ +# cp -r /opt/netbox-X.Y.Z/netbox/scripts /opt/netbox/netbox/ +# cp -r /opt/netbox-X.Y.Z/netbox/reports /opt/netbox/netbox/ ``` If you followed the original installation guide to set up gunicorn, be sure to copy its configuration as well: ```no-highlight -# cp netbox-X.Y.Z/gunicorn.py netbox/gunicorn.py +# cp /opt/netbox-X.Y.Z/gunicorn.py /opt/netbox/gunicorn.py ``` ### Option B: Clone the Git Repository From 4672f16fda334d6bf81028ec997d95cdc0801389 Mon Sep 17 00:00:00 2001 From: Markku Leinio Date: Wed, 28 Oct 2020 21:03:35 +0200 Subject: [PATCH 16/26] Fix #5265: Change systemctl status outputs to venv era --- docs/installation/migrating-to-systemd.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/installation/migrating-to-systemd.md b/docs/installation/migrating-to-systemd.md index 65f42a6bc..4e8d1e78f 100644 --- a/docs/installation/migrating-to-systemd.md +++ b/docs/installation/migrating-to-systemd.md @@ -38,14 +38,14 @@ You can use the command `systemctl status netbox` to verify that the WSGI servic # systemctl status netbox.service ● netbox.service - NetBox WSGI Service Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled) - Active: active (running) since Thu 2019-12-12 19:23:40 UTC; 25s ago + Active: active (running) since sat 2020-10-24 19:23:40 UTC; 25s ago Docs: https://netbox.readthedocs.io/en/stable/ Main PID: 11993 (gunicorn) Tasks: 6 (limit: 2362) CGroup: /system.slice/netbox.service - ├─11993 /usr/bin/python3 /usr/local/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... - ├─12015 /usr/bin/python3 /usr/local/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... - ├─12016 /usr/bin/python3 /usr/local/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... + ├─11993 /opt/netbox/venv/bin/python3 /opt/netbox/venv/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... + ├─12015 /opt/netbox/venv/bin/python3 /opt/netbox/venv/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... + ├─12016 /opt/netbox/venv/bin/python3 /opt/netbox/venv/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... ... ``` From 02f348b15fb2d5b8c8ce42e0573fef453691e624 Mon Sep 17 00:00:00 2001 From: Markku Leinio Date: Wed, 28 Oct 2020 21:06:20 +0200 Subject: [PATCH 17/26] Fix typo in weekday --- docs/installation/migrating-to-systemd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/migrating-to-systemd.md b/docs/installation/migrating-to-systemd.md index 4e8d1e78f..51508392f 100644 --- a/docs/installation/migrating-to-systemd.md +++ b/docs/installation/migrating-to-systemd.md @@ -38,7 +38,7 @@ You can use the command `systemctl status netbox` to verify that the WSGI servic # systemctl status netbox.service ● netbox.service - NetBox WSGI Service Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled) - Active: active (running) since sat 2020-10-24 19:23:40 UTC; 25s ago + Active: active (running) since Sat 2020-10-24 19:23:40 UTC; 25s ago Docs: https://netbox.readthedocs.io/en/stable/ Main PID: 11993 (gunicorn) Tasks: 6 (limit: 2362) From b871d2a8c4c09614e20fc6bcdc781dd502f547ea Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 29 Oct 2020 12:30:10 -0400 Subject: [PATCH 18/26] Fixes #5285: Include plugin API endpoints in root view without needing app_name set --- netbox/extras/plugins/views.py | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/netbox/extras/plugins/views.py b/netbox/extras/plugins/views.py index f30e0f539..7484b9632 100644 --- a/netbox/extras/plugins/views.py +++ b/netbox/extras/plugins/views.py @@ -10,8 +10,6 @@ from rest_framework.response import Response from rest_framework.reverse import reverse from rest_framework.views import APIView -from extras.plugins.utils import import_object - class InstalledPluginsAdminView(View): """ @@ -62,11 +60,7 @@ class PluginsAPIRootView(APIView): @staticmethod def _get_plugin_entry(plugin, app_config, request, format): # Check if the plugin specifies any API URLs - api_app_name = import_object(f"{plugin}.api.urls.app_name") - if api_app_name is None: - # Plugin does not expose an API - return None - + api_app_name = f'{app_config.name}-api' try: entry = (getattr(app_config, 'base_url', app_config.label), reverse( f"plugins-api:{api_app_name}:api-root", From 8ac2ee7b4977da1166361026b35265041f420d88 Mon Sep 17 00:00:00 2001 From: systeembeheerder <19684880+systeembeheerder@users.noreply.github.com> Date: Thu, 29 Oct 2020 22:05:19 +0100 Subject: [PATCH 19/26] Update upgrading.md make destination path for cp media absolute --- docs/installation/upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/upgrading.md b/docs/installation/upgrading.md index 307682d55..028fcb2a4 100644 --- a/docs/installation/upgrading.md +++ b/docs/installation/upgrading.md @@ -52,7 +52,7 @@ Also copy the LDAP configuration if using LDAP: Be sure to replicate your uploaded media as well. (The exact action necessary will depend on where you choose to store your media, but in general moving or copying the media directory will suffice.) ```no-highlight -# cp -pr /opt/netbox-X.Y.Z/netbox/media/ netbox/netbox/ +# cp -pr /opt/netbox-X.Y.Z/netbox/media/ /opt/netbox/netbox/ ``` Also make sure to copy over any custom scripts and reports that you've made. Note that if these are stored outside the project root, you will not need to copy them. (Check the `SCRIPTS_ROOT` and `REPORTS_ROOT` parameters in the configuration file above if you're unsure.) From 2ccc543542f3559e7d889034033a6eeb87745db1 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 29 Oct 2020 17:10:19 -0400 Subject: [PATCH 20/26] Document the available template blocks within base.html --- docs/plugins/development.md | 41 +++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index 3dadddb9c..d65e7d830 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -201,26 +201,37 @@ class RandomAnimalView(View): }) ``` -This view retrieves a random animal from the database and and passes it as a context variable when rendering a template named `animal.html`, which doesn't exist yet. To create this template, first create a directory named `templates/netbox_animal_sounds/` within the plugin source directory. (We use the plugin's name as a subdirectory to guard against naming collisions with other plugins.) Then, create `animal.html`: +This view retrieves a random animal from the database and and passes it as a context variable when rendering a template named `animal.html`, which doesn't exist yet. To create this template, first create a directory named `templates/netbox_animal_sounds/` within the plugin source directory. (We use the plugin's name as a subdirectory to guard against naming collisions with other plugins.) Then, create a template named `animal.html` as described below. + +### Extending the Base Template + +NetBox provides a base template to ensure a consistent user experience, which plugins can extend with their own content. This template includes four content blocks: + +* `title` - The page title +* `header` - The upper portion of the page +* `content` - The main page body +* `javascript` - A section at the end of the page for including Javascript code + +For more information on how template blocks work, consult the [Django documentation](https://docs.djangoproject.com/en/stable/ref/templates/builtins/#block). ```jinja2 {% extends 'base.html' %} {% block content %} -{% with config=settings.PLUGINS_CONFIG.netbox_animal_sounds %} -

    - {% if animal %} - The {{ animal.name|lower }} says - {% if config.loud %} - {{ animal.sound|upper }}! - {% else %} - {{ animal.sound }} - {% endif %} - {% else %} - No animals have been created yet! - {% endif %} -

    -{% endwith %} + {% with config=settings.PLUGINS_CONFIG.netbox_animal_sounds %} +

    + {% if animal %} + The {{ animal.name|lower }} says + {% if config.loud %} + {{ animal.sound|upper }}! + {% else %} + {{ animal.sound }} + {% endif %} + {% else %} + No animals have been created yet! + {% endif %} +

    + {% endwith %} {% endblock %} ``` From 2b154dcfdf45f1e678c879b8062afe12f2062ef0 Mon Sep 17 00:00:00 2001 From: Nick Niehoff Date: Thu, 29 Oct 2020 15:14:52 -0600 Subject: [PATCH 21/26] Fixing #5282 - moving logging configuration from authentication.py to configuration.py --- docs/installation/6-ldap.md | 28 ++++++++++++++++++++-------- netbox/netbox/authentication.py | 5 ----- 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/docs/installation/6-ldap.md b/docs/installation/6-ldap.md index bb1300c08..47093b2c1 100644 --- a/docs/installation/6-ldap.md +++ b/docs/installation/6-ldap.md @@ -143,17 +143,29 @@ AUTH_LDAP_CACHE_TIMEOUT = 3600 `systemctl restart netbox` restarts the Netbox service, and initiates any changes made to `ldap_config.py`. If there are syntax errors present, the NetBox process will not spawn an instance, and errors should be logged to `/var/log/messages`. -For troubleshooting LDAP user/group queries, add the following lines to the start of `ldap_config.py` after `import ldap`. +For troubleshooting LDAP user/group queries, add or merge the following [logging](/configuration/optional-settings.md#logging) configuration to `configuration.py`: ```python -import logging, logging.handlers logfile = "/opt/netbox/logs/django-ldap-debug.log" -my_logger = logging.getLogger('django_auth_ldap') -my_logger.setLevel(logging.DEBUG) -handler = logging.handlers.RotatingFileHandler( - logfile, maxBytes=1024 * 500, backupCount=5 -) -my_logger.addHandler(handler) +LOGGING = { + "version": 1, + "disable_existing_loggers": False, + "handlers": { + 'netbox_auth_log': { + 'level': 'DEBUG', + 'class': 'logging.handlers.RotatingFileHandler', + 'filename': logfile, + 'maxBytes': 1024 * 500, + 'backupCount': 5, + }, + }, + 'loggers': { + 'django_auth_ldap': { + 'handlers': ['netbox_auth_log'], + 'level': 'DEBUG', + }, + }, +} ``` Ensure the file and path specified in logfile exist and are writable and executable by the application service account. Restart the netbox service and attempt to log into the site to trigger log entries to this file. diff --git a/netbox/netbox/authentication.py b/netbox/netbox/authentication.py index 6328c40d7..21fb3e229 100644 --- a/netbox/netbox/authentication.py +++ b/netbox/netbox/authentication.py @@ -172,9 +172,4 @@ class LDAPBackend: if getattr(ldap_config, 'LDAP_IGNORE_CERT_ERRORS', False): ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER) - # Enable logging for django_auth_ldap - ldap_logger = logging.getLogger('django_auth_ldap') - ldap_logger.addHandler(logging.StreamHandler()) - ldap_logger.setLevel(logging.INFO) - return obj From db87a694884dca4eca214018b6ca1211ea3f1c76 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Fri, 30 Oct 2020 02:56:26 -0400 Subject: [PATCH 22/26] convert region fields to f-string --- netbox/extras/querysets.py | 30 ++++++++++++------------------ 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index 5e7884a0d..9bfa5da83 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -109,30 +109,24 @@ class ConfigContextModelQuerySet(RestrictedQuerySet): if self.model._meta.model_name == 'device': base_query.add((Q(roles=OuterRef('device_role')) | Q(roles=None)), Q.AND) - base_query.add( - (Q( - regions__tree_id=OuterRef('site__region__tree_id'), - regions__level__lte=OuterRef('site__region__level'), - regions__lft__lte=OuterRef('site__region__lft'), - regions__rght__gte=OuterRef('site__region__rght'), - ) | Q(regions=None)), - Q.AND - ) base_query.add((Q(sites=OuterRef('site')) | Q(sites=None)), Q.AND) + region_field = 'site__region' elif self.model._meta.model_name == 'virtualmachine': base_query.add((Q(roles=OuterRef('role')) | Q(roles=None)), Q.AND) base_query.add((Q(cluster_groups=OuterRef('cluster__group')) | Q(cluster_groups=None)), Q.AND) base_query.add((Q(clusters=OuterRef('cluster')) | Q(clusters=None)), Q.AND) - base_query.add( - (Q( - regions__tree_id=OuterRef('cluster__site__region__tree_id'), - regions__level__lte=OuterRef('cluster__site__region__level'), - regions__lft__lte=OuterRef('cluster__site__region__lft'), - regions__rght__gte=OuterRef('cluster__site__region__rght'), - ) | Q(regions=None)), - Q.AND - ) base_query.add((Q(sites=OuterRef('cluster__site')) | Q(sites=None)), Q.AND) + region_field = 'cluster__site__region' + + base_query.add( + (Q( + regions__tree_id=OuterRef(f'{region_field}__tree_id'), + regions__level__lte=OuterRef(f'{region_field}__level'), + regions__lft__lte=OuterRef(f'{region_field}__lft'), + regions__rght__gte=OuterRef(f'{region_field}__rght'), + ) | Q(regions=None)), + Q.AND + ) return base_query From 28c17f33ab398f20f6c62644ccf9a3ac98cad5d1 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Fri, 30 Oct 2020 02:56:43 -0400 Subject: [PATCH 23/26] move get_queryset() to common mixin --- netbox/dcim/api/views.py | 19 ++----------------- netbox/extras/api/views.py | 23 +++++++++++++++++++++++ netbox/virtualization/api/views.py | 19 ++----------------- 3 files changed, 27 insertions(+), 34 deletions(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 956b0cbff..427aecd5f 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -24,7 +24,7 @@ from dcim.models import ( VirtualChassis, ) from extras.api.serializers import RenderedGraphSerializer -from extras.api.views import CustomFieldModelViewSet +from extras.api.views import ConfigContextQuerySetMixin, CustomFieldModelViewSet from extras.models import Graph from ipam.models import Prefix, VLAN from utilities.api import ( @@ -336,28 +336,13 @@ class PlatformViewSet(ModelViewSet): # Devices # -class DeviceViewSet(CustomFieldModelViewSet): +class DeviceViewSet(CustomFieldModelViewSet, ConfigContextQuerySetMixin): queryset = Device.objects.prefetch_related( 'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'site', 'rack', 'parent_bay', 'virtual_chassis__master', 'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'tags', ) filterset_class = filters.DeviceFilterSet - def get_queryset(self): - """ - Build the proper queryset based on the request context - - If the `brief` query param equates to True or the `exclude` query param - includes `config_context` as a value, return the base queryset. - - Else, return the queryset annotated with config context data - """ - - request = self.get_serializer_context()['request'] - if request.query_params.get('brief') or 'config_context' in request.query_params.get('exclude', []): - return self.queryset - return self.queryset.annotate_config_context_data() - def get_serializer_class(self): """ Select the specific serializer based on the request context. diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index a63dbe44d..74c9ea889 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -26,6 +26,29 @@ from utilities.utils import copy_safe_request from . import serializers +class ConfigContextQuerySetMixin: + """ + Used by views that work with config context models (device and virtual machine). + Provides a get_queryset() method which deals with adding the config context + data annotation or not. + """ + + def get_queryset(self): + """ + Build the proper queryset based on the request context + + If the `brief` query param equates to True or the `exclude` query param + includes `config_context` as a value, return the base queryset. + + Else, return the queryset annotated with config context data + """ + + request = self.get_serializer_context()['request'] + if request.query_params.get('brief') or 'config_context' in request.query_params.get('exclude', []): + return self.queryset + return self.queryset.annotate_config_context_data() + + class ExtrasRootView(APIRootView): """ Extras API root view diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index d19f0f9fa..55393b110 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -6,7 +6,7 @@ from rest_framework.routers import APIRootView from dcim.models import Device from extras.api.serializers import RenderedGraphSerializer -from extras.api.views import CustomFieldModelViewSet +from extras.api.views import ConfigContextQuerySetMixin, CustomFieldModelViewSet from extras.models import Graph from utilities.api import ModelViewSet from utilities.utils import get_subquery @@ -58,27 +58,12 @@ class ClusterViewSet(CustomFieldModelViewSet): # Virtual machines # -class VirtualMachineViewSet(CustomFieldModelViewSet): +class VirtualMachineViewSet(CustomFieldModelViewSet, ConfigContextQuerySetMixin): queryset = VirtualMachine.objects.prefetch_related( 'cluster__site', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags' ) filterset_class = filters.VirtualMachineFilterSet - def get_queryset(self): - """ - Build the proper queryset based on the request context - - If the `brief` query param equates to True or the `exclude` query param - includes `config_context` as a value, return the base queryset. - - Else, return the queryset annotated with config context data - """ - - request = self.get_serializer_context()['request'] - if request.query_params.get('brief') or 'config_context' in request.query_params.get('exclude', []): - return self.queryset - return self.queryset.annotate_config_context_data() - def get_serializer_class(self): """ Select the specific serializer based on the request context. From 97ea15e978344c05c7257432b5fd340e66f6b93c Mon Sep 17 00:00:00 2001 From: Nick Niehoff Date: Fri, 30 Oct 2020 06:32:12 -0600 Subject: [PATCH 24/26] Removing logfile variable --- docs/installation/6-ldap.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/installation/6-ldap.md b/docs/installation/6-ldap.md index 47093b2c1..b7d525413 100644 --- a/docs/installation/6-ldap.md +++ b/docs/installation/6-ldap.md @@ -146,15 +146,14 @@ AUTH_LDAP_CACHE_TIMEOUT = 3600 For troubleshooting LDAP user/group queries, add or merge the following [logging](/configuration/optional-settings.md#logging) configuration to `configuration.py`: ```python -logfile = "/opt/netbox/logs/django-ldap-debug.log" LOGGING = { - "version": 1, - "disable_existing_loggers": False, - "handlers": { + 'version': 1, + 'disable_existing_loggers': False, + 'handlers': { 'netbox_auth_log': { 'level': 'DEBUG', 'class': 'logging.handlers.RotatingFileHandler', - 'filename': logfile, + 'filename': '/opt/netbox/logs/django-ldap-debug.log', 'maxBytes': 1024 * 500, 'backupCount': 5, }, From 70cc36822528511d647cc806197cca3b529b6889 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 30 Oct 2020 09:14:52 -0400 Subject: [PATCH 25/26] Changelog for #4559, #5282, #5285 --- docs/release-notes/version-2.9.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/release-notes/version-2.9.md b/docs/release-notes/version-2.9.md index f54b3a907..34cd2f41c 100644 --- a/docs/release-notes/version-2.9.md +++ b/docs/release-notes/version-2.9.md @@ -2,11 +2,18 @@ ## v2.9.8 (FUTURE) +### Enhancements + +* [#4559](https://github.com/netbox-community/netbox/issues/4559) - Improve device/VM context data rendering performance + ### Bug Fixes + * [#3672](https://github.com/netbox-community/netbox/issues/3672) - Fix a caching issue causing incorrect related object counts in API responses * [#5113](https://github.com/netbox-community/netbox/issues/5113) - Fix incorrect caching of permission object assignments to user groups in the admin panel * [#5243](https://github.com/netbox-community/netbox/issues/5243) - Redirect user to appropriate tab after modifying device components * [#5273](https://github.com/netbox-community/netbox/issues/5273) - Fix exception when validating a new permission with no models selected +* [#5282](https://github.com/netbox-community/netbox/issues/5282) - Fix high CPU load when LDAP authentication is enabled +* [#5285](https://github.com/netbox-community/netbox/issues/5285) - Plugins no longer need to define `app_name` for API URLs to be included in the root view --- From cbd155406bf566ed198267ff0a44b8836d86d50b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 30 Oct 2020 10:11:13 -0400 Subject: [PATCH 26/26] Release v2.9.8 --- docs/release-notes/version-2.9.md | 2 +- netbox/netbox/settings.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.9.md b/docs/release-notes/version-2.9.md index 34cd2f41c..dc6a10dae 100644 --- a/docs/release-notes/version-2.9.md +++ b/docs/release-notes/version-2.9.md @@ -1,6 +1,6 @@ # NetBox v2.9 -## v2.9.8 (FUTURE) +## v2.9.8 (2020-10-30) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 3db1c40cd..2dfbf04d4 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.9.8-dev' +VERSION = '2.9.8' # Hostname HOSTNAME = platform.node()