Release 1.2.0

[tobiasge]

Related Issue: -

New Behavior

• Compatibility with Netbox 2.11

Contrast to Current Behavior

• None

Discussion: Benefits and Drawbacks

• None

Changes to the Wiki

• None

Proposed Release Note Entry

---

This release adds support for for NetBox 2.11 and drops support for older releases. It also fixes some bugs in the initializers and in the handling of custom configuration files.

Noteworthy Changes

Initializers need updates! #485

As upstream NetBox evolves, our initializers have to follow suit. Therefore you need to adjust the following files if you make use of them. Also, rack_groups.yml was renamed to locations.yml.

# custom_links.yml

 - name: link_to_repo
-  text: 'Link to Netbox Docker'
-  url: 'https://github.com/netbox-community/netbox-docker'
+  link_text: 'Link to Netbox Docker'
+  link_url: 'https://github.com/netbox-community/netbox-docker'

# power_panels.yml

-  rack_group: cage 101
+  location: cage 101

# racks.yml

-  group: cage 101
+  location: cage 101

There are also some new features in devices.yml and vlan_groups.yml, see the respective files. We're very grateful for this work by @tobiasge.

Fixes for User, Groups and Permissions initializers #497

The underlying permission system changed in a recent NetBox version, which broke our initializer scripts.
@ryanmerolle has provided a fix for this.

Changes are required, if you use the initializers to set permissions!
Please see the PR and / or the current users.yml, groups.yml and object_permissions.yml files.

Removed the random port exposure #495

Previously, NetBox Docker's docker-compose.yml contained a line to expose NetBox Docker's internal port 8080 to a random port.
We have removed this now.

Because for a while now, we advise users to customize their setup using the docker-compose.override.yml file.
In it, you can bind NetBox Docker's port 8080 to a port of your choosing, often that would be 8080:8080.
Yet, because of the way Docker merges the two YAML files, it was only possible to add another port mapping.
But the old port mapping stayed around.
This was now changed.

This was initially suggested in #407 by @centum – thank you for starting the discussion – and @tobiasge provided the PR that was finally merged.

Extra configuration example for LDAP #448

Some things are better not configured through environment variables.
Until recently it was very hard to adjust such settings.
But we recently introduced the possibility for custom configuration files, that can be mounted into the container (or built-in by extending the container).

@ryanmerolle took the effort to propose an example configuration file, configuration/ldap/extra.py, which showcases some of the LDAP settings for which there is otherwise no obvious solution for their configuration.

RE: TLS

We previously recommended to use Hitch in order to set up TLS for NetBox Docker.
It turns out that this solution had some flaws.
We now suggest the same setup (from an architectural point of view), but with Caddy instead of Hitch.
Please find all the relevant information in the Wiki on our TLS page. (It even has an example showing how to configure that setup with automatic certificates from Let's Encrypt!)

Thanks to @ryanmerolle for the hard work of figuring out the nuts and bolts of this new setup.
This shall also be a short reminder that our wiki is a community wiki and that anyone is welcome to improve it or provide alternative solutions!

Fixed CMD passing #492

If you need to use a custom command with your NetBox Docker container, then may have experienced troubles before. @jhujhiti provided a fix for this. Thanks a lot!

Updated Dependencies #483 #486 #479 #477

The following pre-installed dependencies, that are not dependencies of NetBox itself, have been updated:

• ruamel.yaml is now at v0.17.4
• django-auth-ldap is now at v2.4.0

These were provided by @renovate-bot – thanks for the awesome service!

Examples for plugin configuration and enhanced logging #496

There are now two additional configuration files, that are exemplarily for how to configure plugins and also for how to configure more fine-grained logging.

Note: If you turn on the logging, don't forget to add the LOGGING variable to your netbox.env or docker-compose.override.yml.

This improvement was proposed and implemented by @ryanmerolle.

Compatibility

This version of NetBox Docker is only compatible with NetBox v2.11.x. For older versions, use a previous release of NetBox Docker.

Known Issues

There are no confirmed critical issues at the time of writing this. See the issues labelled bug in our issues section.

Sponsoring

Consider buying the maintainers of this project a beer or drink:

• Sponsor @cimnine
• Sponser @tobiasge

---

Double Check

• I have read the comments and followed the PR template.
• I have explained my PR according to the information in the comments.
• My PR targets the develop branch.

[ryanmerolle]

Depending on your thoughts of each PR, I'd love #496 & #497 to get reviewed for possible merging into this release.

[cimnine]

I have updated the release notes proposal. I hope there aren't too many typos and funny grammar errors 🙈 Since @ryanmerolle has some PRs open that he would like to have merged into this release, I'm going to wait a little longer with approving. (Also the "bug" above found by @jcollie can hopefully be rectified before we merge into release.)

[cimnine]

When the checks turn green, then this should be ready to be released 🎉