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 #5455] [MERGED] Release v2.10.0 #13025

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

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/5455
Author: @jeremystretch
Created: 12/14/2020
Status: ✅ Merged
Merged: 12/14/2020
Merged by: @jeremystretch

Base: master ← Head: develop

📝 Commits (10+)

  • 1b55285 Relocate CSS classes for ChoiceFields from model to ChoiceSet
  • 18a8a91 Introduce ChoiceFieldColumn to replace template columns
  • 28f0da0 Introduce LinkedCountColumn to standardize approach to counting related items in tables
  • 12e2537 General cleanup of tables
  • 587e6fc Initial work on cable paths (WIP)
  • 9851977 Add initial tests
  • 319329e Extend cable path tests
  • cd71799 Ignore the position stack when traversing single-position rear ports
  • e53ae1d Extend cable path tests
  • 46df5a9 Remove extraneous test objects

📊 Changes

462 files changed (+45646 additions, -21437 deletions)

View changed files

📝 .github/workflows/ci.yml (+1 -1)
📝 CONTRIBUTING.md (+0 -2)
📝 docs/additional-features/custom-fields.md (+58 -15)
➖ docs/additional-features/graphs.md (+0 -30)
📝 docs/administration/netbox-shell.md (+4 -4)
📝 docs/configuration/optional-settings.md (+1 -1)
📝 docs/core-functionality/ipam.md (+1 -0)
📝 docs/index.md (+1 -1)
📝 docs/installation/1-postgresql.md (+17 -17)
📝 docs/installation/2-redis.md (+4 -5)
📝 docs/installation/3-netbox.md (+40 -36)
📝 docs/installation/4-gunicorn.md (+21 -18)
📝 docs/installation/5-http-server.md (+15 -16)
📝 docs/installation/6-ldap.md (+6 -7)
📝 docs/installation/index.md (+10 -0)
📝 docs/installation/upgrading.md (+25 -40)
➕ docs/models/ipam/routetarget.md (+5 -0)
📝 docs/models/ipam/vrf.md (+2 -0)
📝 docs/release-notes/index.md (+1 -1)
➕ docs/release-notes/version-2.10.md (+147 -0)

...and 80 more files

📄 Description

v2.10.0 (2020-12-14)

NOTE: This release completely removes support for embedded graphs.

NOTE: The Django templating language (DTL) is no longer supported for export templates. Ensure that all export templates use Jinja2 before upgrading.

New Features

Route Targets (#259)

This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF may be assigned one or more route targets in the import and/or export direction. Like VRFs, route targets may be assigned to tenants and support tag assignment.

REST API Bulk Deletion (#3436)

The REST API now supports the bulk deletion of objects of the same type in a single request. Send a DELETE HTTP request to the list to the model's list endpoint (e.g. /api/dcim/sites/) with a list of JSON objects specifying the numeric ID of each object to be deleted. For example, to delete sites with IDs 10, 11, and 12, issue the following request:

curl -s -X DELETE \
-H "Authorization: Token $TOKEN" \
-H "Content-Type: application/json" \
http://netbox/api/dcim/sites/ \
--data '[{"id": 10}, {"id": 11}, {"id": 12}]'

REST API Bulk Update (#4882)

Similar to bulk deletion, the REST API also now supports bulk updates. Send a PUT or PATCH HTTP request to the list to the model's list endpoint (e.g. /api/dcim/sites/) with a list of JSON objects specifying the numeric ID of each object and the attribute(s) to be updated. For example, to set a description for sites with IDs 10 and 11, issue the following request:

curl -s -X PATCH \
-H "Authorization: Token $TOKEN" \
-H "Content-Type: application/json" \
http://netbox/api/dcim/sites/ \
--data '[{"id": 10, "description": "Foo"}, {"id": 11, "description": "Bar"}]'

Reimplementation of Custom Fields (#4878)

NetBox v2.10 introduces a completely overhauled approach to custom fields. Whereas previous versions used CustomFieldValue instances to store values, custom field data is now stored directly on each model instance as JSON data and may be accessed using the cf property:

>>> site = Site.objects.first()
>>> site.cf
{'site_code': 'US-RAL01'}
>>> site.cf['foo'] = 'ABC'
>>> site.full_clean()
>>> site.save()
>>> site = Site.objects.first()
>>> site.cf
{'foo': 'ABC', 'site_code': 'US-RAL01'}

Additionally, custom selection field choices are now defined on the CustomField model within the admin UI, which greatly simplifies working with choice values.

Improved Cable Trace Performance (#4900)

All end-to-end cable paths are now cached using the new CablePath backend model. This allows NetBox to now immediately return the complete path originating from any endpoint directly from the database, rather than having to trace each cable recursively. It also resolves some systemic validation issues present in the original implementation.

Note: As part of this change, cable traces will no longer traverse circuits: A circuit termination will be considered the origin or destination of an end-to-end path.

Enhancements

  • #609 - Add min/max value and regex validation for custom fields
  • #1503 - Allow assigment of secrets to virtual machines
  • #1692 - Allow assigment of inventory items to parent items in web UI
  • #2179 - Support the use of multiple port numbers when defining a service
  • #4897 - Allow filtering by content type identified as <app>.<model> string
  • #4918 - Add a REST API endpoint (/api/status/) which returns NetBox's current operational status
  • #4956 - Include inventory items on primary device view
  • #4967 - Support tenant assignment for aggregates
  • #5003 - CSV import now accepts slug values for choice fields
  • #5146 - Add custom field support for cables, power panels, rack reservations, and virtual chassis
  • #5154 - The web interface now consumes the entire browser window
  • #5190 - Add a REST API endpoint for retrieving content types (/api/extras/content-types/)
  • #5274 - Add REST API support for custom fields
  • #5399 - Show options for cable endpoint types during bulk import
  • #5411 - Include cable tags in trace view

Other Changes

  • #1846 - Enable MPTT for InventoryItem hierarchy
  • #2755 - Switched from Font Awesome/Glyphicons to Material Design icons
  • #4349 - Dropped support for embedded graphs
  • #4360 - Dropped support for the Django template language from export templates
  • #4711 - Renamed Webhook obj_type to content_types
  • #4941 - commit argument is now required argument in a custom script's run() method
  • #5011 - Standardized name field lengths across all models
  • #5139 - Omit utilization statistics from RIR list
  • #5225 - Circuit termination port speed is now an optional field

REST API Changes

  • Added support for PUT, PATCH, and DELETE operations on list endpoints (bulk update and delete)
  • Added the /extras/content-types/ endpoint for Django ContentTypes
  • Added the /extras/custom-fields/ endpoint for custom fields
  • Removed the /extras/_custom_field_choices/ endpoint (replaced by new custom fields endpoint)
  • Added the /status/ endpoint to convey NetBox's current status
  • circuits.CircuitTermination:
    • Added the /trace/ endpoint
    • Replaced connection_status with connected_endpoint_reachable (boolean)
    • Added cable_peer and cable_peer_type
    • port_speed may now be null
  • dcim.Cable: Added custom_fields
  • dcim.ConsolePort:
    • Replaced connection_status with connected_endpoint_reachable (boolean)
    • Added cable_peer and cable_peer_type
    • Removed connection_status from nested serializer
  • dcim.ConsoleServerPort:
    • Replaced connection_status with connected_endpoint_reachable (boolean)
    • Added cable_peer and cable_peer_type
    • Removed connection_status from nested serializer
  • dcim.FrontPort:
    • Replaced the /trace/ endpoint with /paths/, which returns a list of cable paths
    • Added cable_peer and cable_peer_type
  • dcim.Interface:
    • Replaced connection_status with connected_endpoint_reachable (boolean)
    • Added cable_peer and cable_peer_type
    • Removed connection_status from nested serializer
  • dcim.InventoryItem: The _depth field has been added to reflect MPTT positioning
  • dcim.PowerFeed:
    • Added the /trace/ endpoint
    • Added fields connected_endpoint, connected_endpoint_type, connected_endpoint_reachable, cable_peer, and cable_peer_type
  • dcim.PowerOutlet:
    • Replaced connection_status with connected_endpoint_reachable (boolean)
    • Added cable_peer and cable_peer_type
    • Removed connection_status from nested serializer
  • dcim.PowerPanel: Added custom_fields
  • dcim.PowerPort
    • Replaced connection_status with connected_endpoint_reachable (boolean)
    • Added cable_peer and cable_peer_type
    • Removed connection_status from nested serializer
  • dcim.RackReservation: Added custom_fields
  • dcim.RearPort:
    • Replaced the /trace/ endpoint with /paths/, which returns a list of cable paths
    • Added cable_peer and cable_peer_type
  • dcim.VirtualChassis: Added custom_fields
  • extras.ExportTemplate: The template_language field has been removed
  • extras.Graph: This API endpoint has been removed (see #4349)
  • extras.ImageAttachment: Filtering by content_type now takes a string in the form <app>.<model>
  • extras.ObjectChange: Filtering by changed_object_type now takes a string in the form <app>.<model>
  • ipam.Aggregate: Added tenant field
  • ipam.RouteTarget: New endpoint
  • ipam.Service: Renamed port to ports; now holds a list of one or more port numbers
  • ipam.VRF: Added import_targets and export_targets fields
  • secrets.Secret: Removed device field; replaced with assigned_object generic foreign key. This may represent either a device or a virtual machine. Assign an object by setting assigned_object_type and assigned_object_id.

🔄 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/5455 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 12/14/2020 **Status:** ✅ Merged **Merged:** 12/14/2020 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `master` ← **Head:** `develop` --- ### 📝 Commits (10+) - [`1b55285`](https://github.com/netbox-community/netbox/commit/1b55285167c7ce33f5624298c9fd8810414c0d64) Relocate CSS classes for ChoiceFields from model to ChoiceSet - [`18a8a91`](https://github.com/netbox-community/netbox/commit/18a8a91d57271b632583ba53572dc9d010113b2d) Introduce ChoiceFieldColumn to replace template columns - [`28f0da0`](https://github.com/netbox-community/netbox/commit/28f0da0bc1570bd17e1846c921a72eb7f2697a9c) Introduce LinkedCountColumn to standardize approach to counting related items in tables - [`12e2537`](https://github.com/netbox-community/netbox/commit/12e2537222139795e4a82406bed67b45f32d5650) General cleanup of tables - [`587e6fc`](https://github.com/netbox-community/netbox/commit/587e6fcf72fe05a7597b8e565b782f659aacefb1) Initial work on cable paths (WIP) - [`9851977`](https://github.com/netbox-community/netbox/commit/985197788b0039976299de1fc56be25d90756dd8) Add initial tests - [`319329e`](https://github.com/netbox-community/netbox/commit/319329e2b230a65122031130d861816cf3f75160) Extend cable path tests - [`cd71799`](https://github.com/netbox-community/netbox/commit/cd7179937376ea7c7b81deedf37509717ed85143) Ignore the position stack when traversing single-position rear ports - [`e53ae1d`](https://github.com/netbox-community/netbox/commit/e53ae1d584267cd2a40e0ae701e150334364e10d) Extend cable path tests - [`46df5a9`](https://github.com/netbox-community/netbox/commit/46df5a97b22bfd4f3d5bb24525c346f78194f3c6) Remove extraneous test objects ### 📊 Changes **462 files changed** (+45646 additions, -21437 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/ci.yml` (+1 -1) 📝 `CONTRIBUTING.md` (+0 -2) 📝 `docs/additional-features/custom-fields.md` (+58 -15) ➖ `docs/additional-features/graphs.md` (+0 -30) 📝 `docs/administration/netbox-shell.md` (+4 -4) 📝 `docs/configuration/optional-settings.md` (+1 -1) 📝 `docs/core-functionality/ipam.md` (+1 -0) 📝 `docs/index.md` (+1 -1) 📝 `docs/installation/1-postgresql.md` (+17 -17) 📝 `docs/installation/2-redis.md` (+4 -5) 📝 `docs/installation/3-netbox.md` (+40 -36) 📝 `docs/installation/4-gunicorn.md` (+21 -18) 📝 `docs/installation/5-http-server.md` (+15 -16) 📝 `docs/installation/6-ldap.md` (+6 -7) 📝 `docs/installation/index.md` (+10 -0) 📝 `docs/installation/upgrading.md` (+25 -40) ➕ `docs/models/ipam/routetarget.md` (+5 -0) 📝 `docs/models/ipam/vrf.md` (+2 -0) 📝 `docs/release-notes/index.md` (+1 -1) ➕ `docs/release-notes/version-2.10.md` (+147 -0) _...and 80 more files_ </details> ### 📄 Description ## v2.10.0 (2020-12-14) **NOTE:** This release completely removes support for embedded graphs. **NOTE:** The Django templating language (DTL) is no longer supported for export templates. Ensure that all export templates use Jinja2 before upgrading. ### New Features #### Route Targets ([#259](https://github.com/netbox-community/netbox/issues/259)) This release introduces support for modeling L3VPN route targets, which can be used to control the redistribution of advertised prefixes among VRFs. Each VRF may be assigned one or more route targets in the import and/or export direction. Like VRFs, route targets may be assigned to tenants and support tag assignment. #### REST API Bulk Deletion ([#3436](https://github.com/netbox-community/netbox/issues/3436)) The REST API now supports the bulk deletion of objects of the same type in a single request. Send a `DELETE` HTTP request to the list to the model's list endpoint (e.g. `/api/dcim/sites/`) with a list of JSON objects specifying the numeric ID of each object to be deleted. For example, to delete sites with IDs 10, 11, and 12, issue the following request: ```no-highlight curl -s -X DELETE \ -H "Authorization: Token $TOKEN" \ -H "Content-Type: application/json" \ http://netbox/api/dcim/sites/ \ --data '[{"id": 10}, {"id": 11}, {"id": 12}]' ``` #### REST API Bulk Update ([#4882](https://github.com/netbox-community/netbox/issues/4882)) Similar to bulk deletion, the REST API also now supports bulk updates. Send a `PUT` or `PATCH` HTTP request to the list to the model's list endpoint (e.g. `/api/dcim/sites/`) with a list of JSON objects specifying the numeric ID of each object and the attribute(s) to be updated. For example, to set a description for sites with IDs 10 and 11, issue the following request: ```no-highlight curl -s -X PATCH \ -H "Authorization: Token $TOKEN" \ -H "Content-Type: application/json" \ http://netbox/api/dcim/sites/ \ --data '[{"id": 10, "description": "Foo"}, {"id": 11, "description": "Bar"}]' ``` #### Reimplementation of Custom Fields ([#4878](https://github.com/netbox-community/netbox/issues/4878)) NetBox v2.10 introduces a completely overhauled approach to custom fields. Whereas previous versions used CustomFieldValue instances to store values, custom field data is now stored directly on each model instance as JSON data and may be accessed using the `cf` property: ```python >>> site = Site.objects.first() >>> site.cf {'site_code': 'US-RAL01'} >>> site.cf['foo'] = 'ABC' >>> site.full_clean() >>> site.save() >>> site = Site.objects.first() >>> site.cf {'foo': 'ABC', 'site_code': 'US-RAL01'} ``` Additionally, custom selection field choices are now defined on the CustomField model within the admin UI, which greatly simplifies working with choice values. #### Improved Cable Trace Performance ([#4900](https://github.com/netbox-community/netbox/issues/4900)) All end-to-end cable paths are now cached using the new CablePath backend model. This allows NetBox to now immediately return the complete path originating from any endpoint directly from the database, rather than having to trace each cable recursively. It also resolves some systemic validation issues present in the original implementation. **Note:** As part of this change, cable traces will no longer traverse circuits: A circuit termination will be considered the origin or destination of an end-to-end path. ### Enhancements * [#609](https://github.com/netbox-community/netbox/issues/609) - Add min/max value and regex validation for custom fields * [#1503](https://github.com/netbox-community/netbox/issues/1503) - Allow assigment of secrets to virtual machines * [#1692](https://github.com/netbox-community/netbox/issues/1692) - Allow assigment of inventory items to parent items in web UI * [#2179](https://github.com/netbox-community/netbox/issues/2179) - Support the use of multiple port numbers when defining a service * [#4897](https://github.com/netbox-community/netbox/issues/4897) - Allow filtering by content type identified as `<app>.<model>` string * [#4918](https://github.com/netbox-community/netbox/issues/4918) - Add a REST API endpoint (`/api/status/`) which returns NetBox's current operational status * [#4956](https://github.com/netbox-community/netbox/issues/4956) - Include inventory items on primary device view * [#4967](https://github.com/netbox-community/netbox/issues/4967) - Support tenant assignment for aggregates * [#5003](https://github.com/netbox-community/netbox/issues/5003) - CSV import now accepts slug values for choice fields * [#5146](https://github.com/netbox-community/netbox/issues/5146) - Add custom field support for cables, power panels, rack reservations, and virtual chassis * [#5154](https://github.com/netbox-community/netbox/issues/5154) - The web interface now consumes the entire browser window * [#5190](https://github.com/netbox-community/netbox/issues/5190) - Add a REST API endpoint for retrieving content types (`/api/extras/content-types/`) * [#5274](https://github.com/netbox-community/netbox/issues/5274) - Add REST API support for custom fields * [#5399](https://github.com/netbox-community/netbox/issues/5399) - Show options for cable endpoint types during bulk import * [#5411](https://github.com/netbox-community/netbox/issues/5411) - Include cable tags in trace view ### Other Changes * [#1846](https://github.com/netbox-community/netbox/issues/1846) - Enable MPTT for InventoryItem hierarchy * [#2755](https://github.com/netbox-community/netbox/issues/2755) - Switched from Font Awesome/Glyphicons to Material Design icons * [#4349](https://github.com/netbox-community/netbox/issues/4349) - Dropped support for embedded graphs * [#4360](https://github.com/netbox-community/netbox/issues/4360) - Dropped support for the Django template language from export templates * [#4711](https://github.com/netbox-community/netbox/issues/4711) - Renamed Webhook `obj_type` to `content_types` * [#4941](https://github.com/netbox-community/netbox/issues/4941) - `commit` argument is now required argument in a custom script's `run()` method * [#5011](https://github.com/netbox-community/netbox/issues/5011) - Standardized name field lengths across all models * [#5139](https://github.com/netbox-community/netbox/issues/5139) - Omit utilization statistics from RIR list * [#5225](https://github.com/netbox-community/netbox/issues/5225) - Circuit termination port speed is now an optional field ### REST API Changes * Added support for `PUT`, `PATCH`, and `DELETE` operations on list endpoints (bulk update and delete) * Added the `/extras/content-types/` endpoint for Django ContentTypes * Added the `/extras/custom-fields/` endpoint for custom fields * Removed the `/extras/_custom_field_choices/` endpoint (replaced by new custom fields endpoint) * Added the `/status/` endpoint to convey NetBox's current status * circuits.CircuitTermination: * Added the `/trace/` endpoint * Replaced `connection_status` with `connected_endpoint_reachable` (boolean) * Added `cable_peer` and `cable_peer_type` * `port_speed` may now be null * dcim.Cable: Added `custom_fields` * dcim.ConsolePort: * Replaced `connection_status` with `connected_endpoint_reachable` (boolean) * Added `cable_peer` and `cable_peer_type` * Removed `connection_status` from nested serializer * dcim.ConsoleServerPort: * Replaced `connection_status` with `connected_endpoint_reachable` (boolean) * Added `cable_peer` and `cable_peer_type` * Removed `connection_status` from nested serializer * dcim.FrontPort: * Replaced the `/trace/` endpoint with `/paths/`, which returns a list of cable paths * Added `cable_peer` and `cable_peer_type` * dcim.Interface: * Replaced `connection_status` with `connected_endpoint_reachable` (boolean) * Added `cable_peer` and `cable_peer_type` * Removed `connection_status` from nested serializer * dcim.InventoryItem: The `_depth` field has been added to reflect MPTT positioning * dcim.PowerFeed: * Added the `/trace/` endpoint * Added fields `connected_endpoint`, `connected_endpoint_type`, `connected_endpoint_reachable`, `cable_peer`, and `cable_peer_type` * dcim.PowerOutlet: * Replaced `connection_status` with `connected_endpoint_reachable` (boolean) * Added `cable_peer` and `cable_peer_type` * Removed `connection_status` from nested serializer * dcim.PowerPanel: Added `custom_fields` * dcim.PowerPort * Replaced `connection_status` with `connected_endpoint_reachable` (boolean) * Added `cable_peer` and `cable_peer_type` * Removed `connection_status` from nested serializer * dcim.RackReservation: Added `custom_fields` * dcim.RearPort: * Replaced the `/trace/` endpoint with `/paths/`, which returns a list of cable paths * Added `cable_peer` and `cable_peer_type` * dcim.VirtualChassis: Added `custom_fields` * extras.ExportTemplate: The `template_language` field has been removed * extras.Graph: This API endpoint has been removed (see #4349) * extras.ImageAttachment: Filtering by `content_type` now takes a string in the form `<app>.<model>` * extras.ObjectChange: Filtering by `changed_object_type` now takes a string in the form `<app>.<model>` * ipam.Aggregate: Added `tenant` field * ipam.RouteTarget: New endpoint * ipam.Service: Renamed `port` to `ports`; now holds a list of one or more port numbers * ipam.VRF: Added `import_targets` and `export_targets` fields * secrets.Secret: Removed `device` field; replaced with `assigned_object` generic foreign key. This may represent either a device or a virtual machine. Assign an object by setting `assigned_object_type` and `assigned_object_id`. --- <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 22:24:59 +01:00
adam closed this issue 2025-12-29 22:24:59 +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#13025
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?