starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

[PR #14636] [MERGED] Release v3.7.0 #14435

New Issue
Closed
opened 2025-12-29 23:24:27 +01:00 by adam · 0 comments
adam commented 2025-12-29 23:24:27 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/14636
Author: @jeremystretch
Created: 12/29/2023
Status: ✅ Merged
Merged: 12/29/2023
Merged by: @jeremystretch

Base: master ← Head: develop

📝 Commits (10+)

📊 Changes

400 files changed (+81924 additions, -3878 deletions)

View changed files

📝 .github/ISSUE_TEMPLATE/bug_report.yaml (+1 -1)
📝 .github/ISSUE_TEMPLATE/feature_request.yaml (+1 -1)
📝 base_requirements.txt (+3 -9)
📝 docs/administration/error-reporting.md (+3 -15)
📝 docs/configuration/data-validation.md (+21 -0)
📝 docs/configuration/error-reporting.md (+3 -0)
📝 docs/configuration/miscellaneous.md (+16 -2)
📝 docs/configuration/required-parameters.md (+3 -6)
📝 docs/customization/custom-fields.md (+12 -4)
📝 docs/customization/custom-validation.md (+2 -0)
📝 docs/development/application-registry.md (+9 -1)
📝 docs/development/extending-models.md (+26 -13)
📝 docs/development/models.md (+23 -15)
📝 docs/development/search.md (+1 -0)
📝 docs/development/signals.md (+24 -0)
📝 docs/features/api-integration.md (+2 -2)
➕ docs/features/event-rules.md (+31 -0)
➕ docs/features/vpn-tunnels.md (+49 -0)
📝 docs/index.md (+1 -1)
📝 docs/installation/3-netbox.md (+11 -0)

...and 80 more files

📄 Description

Breaking Changes

  • The following fields have been removed from the Webhook model: content_types, type_create, type_update, type_delete, type_job_start, type_job_end, enabled, and conditions. Webhooks are now tied to events via event rules. New event rules will be created for any existing webhooks automatically upon upgrade.
  • The ui_visibility field on the custom field model has been replaced with two new fields: ui_visible and ui_editable. These new fields will have their values mapped from the original field automatically upon upgrade.
  • The FeatureQuery class used internally for querying content types by model feature has been removed. It has been replaced by the new with_feature() manager method on NetBox's proxy model for ContentType (core.models.ContentType).
  • The internal ConfigRevision model has moved from extras to core. Configuration history will be retained throughout the upgrade process.
  • The L2VPN and L2VPNTermination models have moved from the ipam app to the new vpn app. All object data will be retained, however please note that the relevant API endpoints have likewise moved to /api/vpn/.
  • The CustomFieldsMixin, SavedFiltersMixin, and TagsMixin classes have moved from the extras.forms.mixins module to netbox.forms.mixins.

New Features

VPN Tunnels (#9816)

Several new models have been introduced to enable VPN tunnel management. Users can now define tunnels with two or more terminations to represent peer-to-peer or hub-and-spoke topologies. Each termination is made to a virtual interface on a device or virtual machine. Additionally, users can define IKE and IPSec proposals and policies, which can be applied to tunnels to document encryption and authentication strategies.

Event Rules (#14132)

This release introduces event rules, which can be used to send webhooks or execute custom scripts automatically in response to events that occur in NetBox. For example, it's now possible to run a custom script whenever a new site is created with a particular status or tag.

Event rules replace and extend functionality that was previously built into the webhook model. New event rules will be created for any existing webhooks automatically upon upgrade.

Virtual Machine Disks (#8356)

A new VirtualDisk model has been introduced to enable tracking the assignment of discrete virtual disks to virtual machines. The size field has been retained on the VirtualMachine model, and will be populated automatically with the aggregate size of all assigned virtual disks. (Users who opt to eschew the new model may continue using the VirtualMachine size attribute independently as in previous releases.)

Object Protection Rules (#10244)

A new PROTECTION_RULES configuration parameter has been introduced. Similar to how custom validation rules can be used to enforce certain values for object attributes, protection rules guard against the deletion of objects which do not meet specified criteria. This enables an administrator to prevent, for example, the deletion of a site which has a status of "active."

Improved Custom Field Visibility Controls (#13299)

The ui_visible field on the custom field model has been superseded by two new fields, ui_visible and ui_editable, which control how and whether a custom field is displayed when view and editing an object, respectively. Separating these two functions into discrete fields allows more control over how each custom field is presented to users. The values of these fields will be appropriately set automatically during the upgrade process from the value of the original field.

Improved Global Search Results (#14134)

Global search results now include additional context about each object, such as a description, status, and/or related objects. The set of attributes to be displayed is specific to each object type, and is defined by setting display_attrs under the object's SearchIndex class.

Table Column Registration for Plugins (#14173)

Plugins can now register their own custom columns for inclusion on core NetBox tables. For example, a plugin can register a new column on SiteTable using the new register_table_column() utility function, and it will become available for users to select for display.

Data Backend Registration for Plugins (#13381)

Plugins can now register their own data backends for use with synchronized data sources. This enables plugins to introduce new backends in addition to the git, S3, and local path backends provided natively.

Enhancements

  • #12135 - Avoid orphaned interfaces by preventing the deletion of interfaces which have children assigned
  • #12216 - Add a color field for circuit types
  • #13230 - Allow device types to be excluded from consideration when calculating a rack's utilization
  • #13334 - Add an error field to the Job model to record any errors associated with its execution
  • #13427 - Introduce a mechanism for excluding models from general-purpose lists of object types
  • #13690 - Display any dependent objects to be deleted prior to deleting an object via the web UI
  • #13794 - Any models with a relationship to Tenant are now included automatically in the list of related objects under the tenant view
  • #13808 - Add a /render-config REST API endpoint for virtual machines
  • #14035 - Order objects of equivalent weight by value in global search results to improve readability
  • #14147 - Avoid recording empty changelog entries via the new CHANGELOG_SKIP_EMPTY_CHANGES config parameter
  • #14156 - Enable custom fields for contact assignments
  • #14240 - Increase maximum values for custom field minimum & maximum numeric validators
  • #14361 - Add a description field for webhooks
  • #14365 - Introduce job_start and job_end signals to allow automated plugin actions
  • #14434 - Add model-specific termination object filters for cables (e.g. interface_id and consoleport_id)
  • #14436 - Add PostgreSQL indexes for all GenericForeignKey fields
  • #14579 - Allow users to specify a preferred language for UI translations

Translations

  • #14075 - Add Spanish translation
  • #14096 - Add French translation
  • #14145 - Add Portuguese translation
  • #14266 - Add Russian translation

Bug Fixes

  • #14432 - Fix hyperlinks for global search result attributes
  • #14472 - Fix display of hidden custom fields in object edit forms
  • #14499 - Relax requirements for encryption/auth algorithms on IKE & IPSec proposals
  • #14550 - Fix changing action type of existing event rule

Other Changes

  • #13550 - Optimize the format for declaring view actions under ActionsMixin (backward compatibility has been retained)
  • #13645 - Installation of the sentry-sdk Python library is now required only if Sentry reporting is enabled
  • #14036 - Move plugin resources from the extras app into netbox (backward compatibility has been retained)
  • #14153 - Replace FeatureQuery with new with_feature() method on proxy ContentType manager
  • #14311 - Move the L2VPN models from the ipam app to the new vpn app
  • #14312 - Move the ConfigRevision model from the extras app to core
  • #14326 - Form feature mixin classes have been moved from the extras app to netbox
  • #14395 - Move extras.webhooks_worker.process_webhook() to extras.webhooks.send_webhook() (backward compatibility has been retained)
  • #14424 - Remove change logging functionality from StagedChange
  • #14458 - Remove the obsolete clearcache management command
  • #14536 - Enforce uniqueness by default for non-VRF prefixes & IP addresses (ENFORCE_GLOBAL_UNIQUE now defaults to true)

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/14636 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 12/29/2023 **Status:** ✅ Merged **Merged:** 12/29/2023 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `master` ← **Head:** `develop` --- ### 📝 Commits (10+) - [`3f40ee5`](https://github.com/netbox-community/netbox/commit/3f40ee5501badc9ed342ef58563fa36f04212ec3) Closes #14036: Move extras.plugins to netbox.plugins (#14086) - [`450790a`](https://github.com/netbox-community/netbox/commit/450790ab4a84d5813bcc88a41a359a64fcfbcfb8) Closes #13550: Refactor view action mappings (#14062) - [`ae447bd`](https://github.com/netbox-community/netbox/commit/ae447bd18749f1d768f184b2dc6e928b1f958c41) 12216 Add color to circuit-type and add to SVG rendering (#14098) - [`7274e75`](https://github.com/netbox-community/netbox/commit/7274e75b26b6153a3a22c74f214de52bba53c1a8) 13230 Allow Devices to be excluded from Rack utilization (#14099) - [`30ce9ed`](https://github.com/netbox-community/netbox/commit/30ce9edf1c44ae181b376461bcd4c29f115fc80b) Closes #13381: Enable plugins to register custom data backends (#14095) - [`c4e765c`](https://github.com/netbox-community/netbox/commit/c4e765c4a8a5fa4ab653181e8e3e34597b6e1556) Closes #14141: translation cleanup (#14143) - [`edc4a35`](https://github.com/netbox-community/netbox/commit/edc4a35296b80d11851be49fbe3abaae8004e841) Initial work on #10244: Protection rules (#14097) - [`7323668`](https://github.com/netbox-community/netbox/commit/7323668dd0a5a1452a7e94c2f43c9bce60383755) Closes #13334: Record error message on failed jobs (#14106) - [`77208bf`](https://github.com/netbox-community/netbox/commit/77208bf5f3af6e7f2500baf676a127f07fea319a) Fix migrations - [`c2d1988`](https://github.com/netbox-community/netbox/commit/c2d1988cb3f74f8a4f7c6005d32caadc69164610) Closes #14035: Order global search results of equivalent weight by value (#14140) ### 📊 Changes **400 files changed** (+81924 additions, -3878 deletions) <details> <summary>View changed files</summary> 📝 `.github/ISSUE_TEMPLATE/bug_report.yaml` (+1 -1) 📝 `.github/ISSUE_TEMPLATE/feature_request.yaml` (+1 -1) 📝 `base_requirements.txt` (+3 -9) 📝 `docs/administration/error-reporting.md` (+3 -15) 📝 `docs/configuration/data-validation.md` (+21 -0) 📝 `docs/configuration/error-reporting.md` (+3 -0) 📝 `docs/configuration/miscellaneous.md` (+16 -2) 📝 `docs/configuration/required-parameters.md` (+3 -6) 📝 `docs/customization/custom-fields.md` (+12 -4) 📝 `docs/customization/custom-validation.md` (+2 -0) 📝 `docs/development/application-registry.md` (+9 -1) 📝 `docs/development/extending-models.md` (+26 -13) 📝 `docs/development/models.md` (+23 -15) 📝 `docs/development/search.md` (+1 -0) 📝 `docs/development/signals.md` (+24 -0) 📝 `docs/features/api-integration.md` (+2 -2) ➕ `docs/features/event-rules.md` (+31 -0) ➕ `docs/features/vpn-tunnels.md` (+49 -0) 📝 `docs/index.md` (+1 -1) 📝 `docs/installation/3-netbox.md` (+11 -0) _...and 80 more files_ </details> ### 📄 Description ### Breaking Changes * The following fields have been removed from the Webhook model: `content_types`, `type_create`, `type_update`, `type_delete`, `type_job_start`, `type_job_end`, `enabled`, and `conditions`. Webhooks are now tied to events via [event rules](https://docs.netbox.dev/en/stable/features/event-rules/). New event rules will be created for any existing webhooks automatically upon upgrade. * The `ui_visibility` field on the [custom field model](https://docs.netbox.dev/en/stable/models/extras/customfield/) has been replaced with two new fields: `ui_visible` and `ui_editable`. These new fields will have their values mapped from the original field automatically upon upgrade. * The `FeatureQuery` class used internally for querying content types by model feature has been removed. It has been replaced by the new `with_feature()` manager method on NetBox's proxy model for ContentType (`core.models.ContentType`). * The internal ConfigRevision model has moved from `extras` to `core`. Configuration history will be retained throughout the upgrade process. * The [L2VPN](https://docs.netbox.dev/en/stable/models/vpn/l2vpn/) and [L2VPNTermination](https://docs.netbox.dev/en/stable/models/vpn/l2vpntermination/) models have moved from the `ipam` app to the new `vpn` app. All object data will be retained, however please note that the relevant API endpoints have likewise moved to `/api/vpn/`. * The `CustomFieldsMixin`, `SavedFiltersMixin`, and `TagsMixin` classes have moved from the `extras.forms.mixins` module to `netbox.forms.mixins`. ### New Features #### VPN Tunnels ([#9816](https://github.com/netbox-community/netbox/issues/9816)) Several new models have been introduced to enable [VPN tunnel management](https://docs.netbox.dev/en/stable/features/vpn-tunnels/). Users can now define tunnels with two or more terminations to represent peer-to-peer or hub-and-spoke topologies. Each termination is made to a virtual interface on a device or virtual machine. Additionally, users can define IKE and IPSec proposals and policies, which can be applied to tunnels to document encryption and authentication strategies. #### Event Rules ([#14132](https://github.com/netbox-community/netbox/issues/14132)) This release introduces [event rules](https://docs.netbox.dev/en/stable/features/event-rules/), which can be used to send webhooks or execute custom scripts automatically in response to events that occur in NetBox. For example, it's now possible to run a custom script whenever a new site is created with a particular status or tag. Event rules replace and extend functionality that was previously built into the webhook model. New event rules will be created for any existing webhooks automatically upon upgrade. #### Virtual Machine Disks ([#8356](https://github.com/netbox-community/netbox/issues/8356)) A new [VirtualDisk](https://docs.netbox.dev/en/stable/models/virtualization/virtualdisk/) model has been introduced to enable tracking the assignment of discrete virtual disks to virtual machines. The `size` field has been retained on the VirtualMachine model, and will be populated automatically with the aggregate size of all assigned virtual disks. (Users who opt to eschew the new model may continue using the VirtualMachine `size` attribute independently as in previous releases.) #### Object Protection Rules ([#10244](https://github.com/netbox-community/netbox/issues/10244)) A new [`PROTECTION_RULES`](https://docs.netbox.dev/en/stable/configuration/data-validation.md#protection_rules) configuration parameter has been introduced. Similar to how [custom validation rules](https://docs.netbox.dev/en/stable/customization/custom-validation/) can be used to enforce certain values for object attributes, protection rules guard against the deletion of objects which do not meet specified criteria. This enables an administrator to prevent, for example, the deletion of a site which has a status of "active." #### Improved Custom Field Visibility Controls ([#13299](https://github.com/netbox-community/netbox/issues/13299)) The `ui_visible` field on [the custom field model](https://docs.netbox.dev/en/stable/models/extras/customfield/) has been superseded by two new fields, `ui_visible` and `ui_editable`, which control how and whether a custom field is displayed when view and editing an object, respectively. Separating these two functions into discrete fields allows more control over how each custom field is presented to users. The values of these fields will be appropriately set automatically during the upgrade process from the value of the original field. #### Improved Global Search Results ([#14134](https://github.com/netbox-community/netbox/issues/14134)) Global search results now include additional context about each object, such as a description, status, and/or related objects. The set of attributes to be displayed is specific to each object type, and is defined by setting `display_attrs` under the object's [SearchIndex class](https://docs.netbox.dev/en/stable/plugins/development/search.md#netbox.search.SearchIndex). #### Table Column Registration for Plugins ([#14173](https://github.com/netbox-community/netbox/issues/14173)) Plugins can now [register their own custom columns](https://docs.netbox.dev/en/stable/plugins/development/tables.md#extending-core-tables) for inclusion on core NetBox tables. For example, a plugin can register a new column on SiteTable using the new `register_table_column()` utility function, and it will become available for users to select for display. #### Data Backend Registration for Plugins ([#13381](https://github.com/netbox-community/netbox/issues/13381)) Plugins can now [register their own data backends](https://docs.netbox.dev/en/stable/plugins/development/data-backends/) for use with [synchronized data sources](https://docs.netbox.dev/en/stable/features/synchronized-data/). This enables plugins to introduce new backends in addition to the git, S3, and local path backends provided natively. ### Enhancements * [#12135](https://github.com/netbox-community/netbox/issues/12135) - Avoid orphaned interfaces by preventing the deletion of interfaces which have children assigned * [#12216](https://github.com/netbox-community/netbox/issues/12216) - Add a `color` field for circuit types * [#13230](https://github.com/netbox-community/netbox/issues/13230) - Allow device types to be excluded from consideration when calculating a rack's utilization * [#13334](https://github.com/netbox-community/netbox/issues/13334) - Add an `error` field to the Job model to record any errors associated with its execution * [#13427](https://github.com/netbox-community/netbox/issues/13427) - Introduce a mechanism for excluding models from general-purpose lists of object types * [#13690](https://github.com/netbox-community/netbox/issues/13690) - Display any dependent objects to be deleted prior to deleting an object via the web UI * [#13794](https://github.com/netbox-community/netbox/issues/13794) - Any models with a relationship to Tenant are now included automatically in the list of related objects under the tenant view * [#13808](https://github.com/netbox-community/netbox/issues/13808) - Add a `/render-config` REST API endpoint for virtual machines * [#14035](https://github.com/netbox-community/netbox/issues/14035) - Order objects of equivalent weight by value in global search results to improve readability * [#14147](https://github.com/netbox-community/netbox/issues/14147) - Avoid recording empty changelog entries via the new `CHANGELOG_SKIP_EMPTY_CHANGES` config parameter * [#14156](https://github.com/netbox-community/netbox/issues/14156) - Enable custom fields for contact assignments * [#14240](https://github.com/netbox-community/netbox/issues/14240) - Increase maximum values for custom field minimum & maximum numeric validators * [#14361](https://github.com/netbox-community/netbox/issues/14361) - Add a `description` field for webhooks * [#14365](https://github.com/netbox-community/netbox/issues/14365) - Introduce `job_start` and `job_end` signals to allow automated plugin actions * [#14434](https://github.com/netbox-community/netbox/issues/14434) - Add model-specific termination object filters for cables (e.g. `interface_id` and `consoleport_id`) * [#14436](https://github.com/netbox-community/netbox/issues/14436) - Add PostgreSQL indexes for all GenericForeignKey fields * [#14579](https://github.com/netbox-community/netbox/issues/14579) - Allow users to specify a preferred language for UI translations ### Translations * [#14075](https://github.com/netbox-community/netbox/issues/14075) - Add Spanish translation * [#14096](https://github.com/netbox-community/netbox/issues/14096) - Add French translation * [#14145](https://github.com/netbox-community/netbox/issues/14145) - Add Portuguese translation * [#14266](https://github.com/netbox-community/netbox/issues/14266) - Add Russian translation ### Bug Fixes * [#14432](https://github.com/netbox-community/netbox/issues/14432) - Fix hyperlinks for global search result attributes * [#14472](https://github.com/netbox-community/netbox/issues/14472) - Fix display of hidden custom fields in object edit forms * [#14499](https://github.com/netbox-community/netbox/issues/14499) - Relax requirements for encryption/auth algorithms on IKE & IPSec proposals * [#14550](https://github.com/netbox-community/netbox/issues/14550) - Fix changing action type of existing event rule ### Other Changes * [#13550](https://github.com/netbox-community/netbox/issues/13550) - Optimize the format for declaring view actions under `ActionsMixin` (backward compatibility has been retained) * [#13645](https://github.com/netbox-community/netbox/issues/13645) - Installation of the `sentry-sdk` Python library is now required only if Sentry reporting is enabled * [#14036](https://github.com/netbox-community/netbox/issues/14036) - Move plugin resources from the `extras` app into `netbox` (backward compatibility has been retained) * [#14153](https://github.com/netbox-community/netbox/issues/14153) - Replace `FeatureQuery` with new `with_feature()` method on proxy ContentType manager * [#14311](https://github.com/netbox-community/netbox/issues/14311) - Move the L2VPN models from the `ipam` app to the new `vpn` app * [#14312](https://github.com/netbox-community/netbox/issues/14312) - Move the ConfigRevision model from the `extras` app to `core` * [#14326](https://github.com/netbox-community/netbox/issues/14326) - Form feature mixin classes have been moved from the `extras` app to `netbox` * [#14395](https://github.com/netbox-community/netbox/issues/14395) - Move `extras.webhooks_worker.process_webhook()` to `extras.webhooks.send_webhook()` (backward compatibility has been retained) * [#14424](https://github.com/netbox-community/netbox/issues/14424) - Remove change logging functionality from StagedChange * [#14458](https://github.com/netbox-community/netbox/issues/14458) - Remove the obsolete `clearcache` management command * [#14536](https://github.com/netbox-community/netbox/issues/14536) - Enforce uniqueness by default for non-VRF prefixes & IP addresses (`ENFORCE_GLOBAL_UNIQUE` now defaults to true) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 23:24:27 +01:00
adam closed this issue 2025-12-29 23:24:27 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#14435
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?