Skip to content

Commit 717724c

Browse files
committed
Update release notes
1 parent 3cfb0ba commit 717724c

File tree

1 file changed

+35
-23
lines changed

1 file changed

+35
-23
lines changed

docs/release-notes/version-3.0.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,34 @@
55
### Breaking Changes
66

77
* Python 3.6 is no longer supported.
8-
* The `invalidate` management command has been removed.
8+
* The secrets functionality present in prior releases of NetBox has been removed. The NetBox maintainers strongly recommend the adoption of [Hashicorp Vault](https://github.com/hashicorp/vault) in place of this feature. Development of a NetBox plugin to replace the legacy secrets functionality is also underway.
9+
* The `invalidate` management command (which clears cached database queries) has been removed.
910
* The default CSV export format for all objects now includes all available data. Additionally, the CSV headers now use human-friendly titles rather than the raw field names.
1011
* Support for queryset caching configuration (`caching_config`) has been removed from the plugins API (see [#6639](https://github.com/netbox-community/netbox/issues/6639)).
1112
* The `cacheops_*` metrics have been removed from the Prometheus exporter (see [#6639](https://github.com/netbox-community/netbox/issues/6639)).
12-
* The `displa_field` keyword argument has been removed from custom script ObjectVar and MultiObjectVar fields. These widgets will use the `display` value provided by the REST API.
13-
* The deprecated `display_name` field has been removed from all REST API serializers. (Clients should reference the `display` field instead.)
14-
* The redundant REST API endpoints for console, power, and interface connections have been removed. The same data can be retrieved using the respective model endpoints with the `?connected=True` filter applied.
13+
* The `display_field` keyword argument has been removed from custom script ObjectVar and MultiObjectVar fields. These widgets will use the `display` value provided by the REST API.
14+
* The deprecated `display_name` field has been removed from all REST API serializers. (API clients should reference the `display` field instead.)
15+
* The redundant REST API endpoints for console, power, and interface connections have been removed. The same data can be retrieved by querying the respective model endpoints with the `?connected=True` filter applied.
1516

1617
### New Features
1718

19+
#### Updated User Interface ([#5893](https://github.com/netbox-community/netbox/issues/5893))
20+
21+
The NetBox user interface has been completely overhauled with a fresh new look! Beyond the cosmetic improvements, this initiative has allowed us to modernize the entire front end, upgrading from Bootstrap 3 to Bootstrap 5, and eliminating dependencies on outdated libraries such as jQuery and jQuery-UI.
22+
23+
A huge thank you to NetBox maintainer [Matt Love](https://github.com/thatmattlove) for his tremendous work on this!
24+
25+
#### New Views for Models Previously Under the Admin UI ([#6466](https://github.com/netbox-community/netbox/issues/6466))
26+
27+
New UI views have been introduced to manage the following models:
28+
29+
* Custom fields
30+
* Custom links
31+
* Export templates
32+
* Webhooks
33+
34+
These models were previously managed under the admin section of the UI. Moving them to dedicated views ensures a more consistent and convenient user experience.
35+
1836
#### GraphQL API ([#2007](https://github.com/netbox-community/netbox/issues/2007))
1937

2038
A new [GraphQL API](https://graphql.org/) has been added to complement NetBox's REST API. GraphQL allows the client to specify which fields of the available data to return in each request. NetBox's implementation, which employs [Graphene](https://graphene-python.org/), also includes a user-friendly query interface known as GraphIQL.
@@ -59,6 +77,12 @@ And the response:
5977

6078
All GraphQL requests are made at the `/graphql` URL (which also serves the GraphiQL UI). The API is currently read-only. For more detail on NetBox's GraphQL implementation, see [the GraphQL API documentation](../graphql-api/overview.md).
6179

80+
#### IP Ranges ([#834](https://github.com/netbox-community/netbox/issues/834))
81+
82+
NetBox now supports arbitrary IP ranges, which are defined by specifying a starting and ending IP address. Similar to prefixes, each IP range may optionally be assigned to a VRF and/or tenant, and can be assigned a functional role. An IP range must be assigned a status of active, reserved, or deprecated. The REST API implementation for this model also includes an "available IPs" endpoint which functions similarly to the endpoint for prefixes.
83+
84+
More information about IP ranges is available [in the documentation](../models/ipam/iprange.md).
85+
6286
#### REST API Token Provisioning ([#5264](https://github.com/netbox-community/netbox/issues/5264))
6387

6488
This release introduces the `/api/users/tokens/` REST API endpoint, which includes a child endpoint that can be employed by a user to provision a new REST API token. This allows a user to gain REST API access without needing to first create a token via the web UI.
@@ -76,12 +100,6 @@ https://netbox/api/users/tokens/provision/
76100

77101
If the supplied credentials are valid, NetBox will create and return a new token for the user.
78102

79-
#### Updated User Interface ([#5893](https://github.com/netbox-community/netbox/issues/5893))
80-
81-
The NetBox user interface has been completely overhauled with a fresh new look! Beyond the cosmetic improvements, this initiative has allowed us to modernize the entire front end, upgrading from Bootstrap 3 to Bootstrap 5, and eliminating dependencies on outdated libraries such as jQuery and jQuery-UI.
82-
83-
A huge thank you to NetBox maintainer [Matt Love](https://github.com/thatmattlove) for his tremendous work on this!
84-
85103
#### Custom Model Validation ([#5963](https://github.com/netbox-community/netbox/issues/5963))
86104

87105
This release introduces the [`CUSTOM_VALIDATORS`](../configuration/optional-settings.md#custom_validators) configuration parameter, which allows administrators to map NetBox models to custom validator classes to enforce custom validation logic. For example, the following configuration requires every site to have a name of at least ten characters and a description:
@@ -115,17 +133,6 @@ GET /api/dcim/interfaces/<ID>>/trace/?render=svg
115133

116134
The width of the rendered image in pixels may optionally be specified by appending the `&width=<width>` parameter to the request. The default width is 400px.
117135

118-
#### New Views for Models Previously Under the Admin UI ([#6466](https://github.com/netbox-community/netbox/issues/6466))
119-
120-
New UI views have been introduced to manage the following models:
121-
122-
* Custom fields
123-
* Custom links
124-
* Export templates
125-
* Webhooks
126-
127-
These models were previously managed under the admin section of the UI. Moving them to dedicated views ensures a more consistent and convenient user experience.
128-
129136
#### New Housekeeping Command ([#6590](https://github.com/netbox-community/netbox/issues/6590))
130137

131138
A new management command has been added: `manage.py housekeeping`. This command is intended to be run nightly via a system cron job. It performs the following tasks:
@@ -182,12 +189,17 @@ Note that NetBox's `rqworker` process will _not_ service custom queues by defaul
182189

183190
### REST API Changes
184191

185-
* Added the `/api/users/tokens/` endpoint
186-
* The `provision/` child endpoint can be used to provision new REST API tokens by supplying a valid username and password
192+
* Removed all endpoints related to the secrets functionality:
193+
* `/api/secrets/generate-rsa-key-pair/`
194+
* `/api/secrets/get-session-key/`
195+
* `/api/secrets/secrets/`
196+
* `/api/secrets/secret-roles/`
187197
* Removed the following "connections" endpoints:
188198
* `/api/dcim/console-connections`
189199
* `/api/dcim/power-connections`
190200
* `/api/dcim/interface-connections`
201+
* Added the `/api/users/tokens/` endpoint
202+
* The `provision/` child endpoint can be used to provision new REST API tokens by supplying a valid username and password
191203
* dcim.Cable
192204
* `length` is now a decimal value
193205
* dcim.Device

0 commit comments

Comments
 (0)