You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This document describes all new features and changes in the release. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
4
+
5
+
## Release Overview
6
+
7
+
This major release marks the compatibility of the Device Onboarding App with Nautobot 3.0.0. Check out the [full details](https://docs.nautobot.com/projects/core/en/stable/release-notes/version-3.0/) of the changes included in this new major release of Nautobot. Highlights:
8
+
9
+
* Minimum Nautobot version supported is 3.0.
10
+
* Added support for Python 3.13 and removed support for 3.9.
11
+
* Updated UI framework to use latest Bootstrap 5.3.
12
+
13
+
We will continue to support the previous major release for users of Nautobot LTM 2.4 only with critical bug and security fixes as per the [Software Lifecycle Policy](https://networktocode.com/company/legal/software-lifecycle-policy/).
Copy file name to clipboardExpand all lines: docs/dev/dev_environment.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ This is a quick reference guide if you're already familiar with the development
13
13
14
14
The [Invoke](http://www.pyinvoke.org/) library is used to provide some helper commands based on the environment. There are a few configuration parameters which can be passed to Invoke to override the default configuration:
15
15
16
-
-`nautobot_ver`: the version of Nautobot to use as a base for any built docker containers (default: 2.4.20)
16
+
-`nautobot_ver`: the version of Nautobot to use as a base for any built docker containers (default: 3.0.0)
17
17
-`project_name`: the default docker compose project name (default: `nautobot-device-onboarding`)
18
18
-`python_ver`: the version of Python to use as a base for any built docker containers (default: 3.12)
19
19
-`local`: a boolean flag indicating if invoke tasks should be run on the host or inside the docker containers (default: False, commands will be run in docker containers)
@@ -225,7 +225,7 @@ Once the containers are fully up, you should be able to open up a web browser, a
225
225
- A live version of the documentation at [http://localhost:8001](http://localhost:8001)
226
226
227
227
!!! note
228
-
Sometimes the containers take a minute to fully spin up. If the page doesn't load right away, wait a minute and try again.
228
+
Sometimes the containers take a minute to fully spin up. If the page doesn't load right away, wait a minute and try again.
229
229
230
230
### Invoke - Creating a Superuser
231
231
@@ -236,7 +236,7 @@ The Nautobot development image will automatically provision a super user when sp
236
236
-`NAUTOBOT_SUPERUSER_PASSWORD=admin`
237
237
238
238
!!! note
239
-
The default username is **admin**, but can be overridden by specifying **NAUTOBOT_SUPERUSER_USERNAME**.
239
+
The default username is **admin**, but can be overridden by specifying **NAUTOBOT_SUPERUSER_USERNAME**.
240
240
241
241
If you need to create additional superusers, run the follow commands.
This will safely shut down all of your running Docker containers for this project. When you are ready to spin containers back up, it is as simple as running `invoke start` again [as seen previously](#invoke-starting-the-development-environment).
287
287
288
288
!!! warning
289
-
If you're wanting to reset the database and configuration settings, you can use the `invoke destroy` command, but **you will lose any data stored in those containers**, so make sure that is what you want to do.
289
+
If you're wanting to reset the database and configuration settings, you can use the `invoke destroy` command, but **you will lose any data stored in those containers**, so make sure that is what you want to do.
290
290
291
291
### Real-Time Updates? How Cool!
292
292
@@ -297,15 +297,15 @@ Now you can start developing your app in the project folder!
297
297
The magic here is the root directory is mounted inside your Docker containers when built and ran, so **any** changes made to the files in here are directly updated to the Nautobot app code running in Docker. This means that as you modify the code in your app folder, the changes will be instantly updated in Nautobot.
298
298
299
299
!!! warning
300
-
There are a few exceptions to this, as outlined in the section [To Rebuild or Not To Rebuild](#to-rebuild-or-not-to-rebuild).
300
+
There are a few exceptions to this, as outlined in the section [To Rebuild or Not To Rebuild](#to-rebuild-or-not-to-rebuild).
301
301
302
302
The back-end Django process is setup to automatically reload itself (it only takes a couple of seconds) every time a file is updated (saved). So for example, if you were to update one of the files like `tables.py`, then save it, the changes will be visible right away in the web browser!
303
303
304
304
!!! note
305
-
You may get connection refused while Django reloads, but it should be refreshed fairly quickly.
305
+
You may get connection refused while Django reloads, but it should be refreshed fairly quickly.
306
306
307
307
!!! note
308
-
Workers do not get automatically restarted and must be restarted manually, if running with docker-compose you can run `docker restart nautobot_device_onboarding_worker_1`.
308
+
Workers do not get automatically restarted and must be restarted manually, if running with docker-compose you can run `docker restart nautobot_device_onboarding_worker_1`.
309
309
310
310
### Docker Logs
311
311
@@ -316,7 +316,7 @@ When trying to debug an issue, one helpful thing you can look at are the logs wi
316
316
```
317
317
318
318
!!! note
319
-
The `-f` tag will keep the logs open, and output them in realtime as they are generated.
319
+
The `-f` tag will keep the logs open, and output them in realtime as they are generated.
320
320
321
321
!!! info
322
322
Want to limit the log output even further? Use the `--tail <#>` command line argument in conjunction with `-f`.
@@ -395,7 +395,7 @@ namespace.configure(
395
395
"nautobot_device_onboarding": {
396
396
...
397
397
"python_ver": "3.12",
398
-
...
398
+
...
399
399
}
400
400
}
401
401
)
@@ -413,8 +413,8 @@ namespace.configure(
413
413
{
414
414
"nautobot_device_onboarding": {
415
415
...
416
-
"nautobot_ver": "2.4.20",
417
-
...
416
+
"nautobot_ver": "3.0.0",
417
+
...
418
418
}
419
419
}
420
420
)
@@ -468,4 +468,4 @@ To run an individual test, you can run any or all of the following:
0 commit comments