Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 2.3.0 #869

Merged
merged 18 commits into from
Nov 2, 2022
Merged

Version 2.3.0 #869

merged 18 commits into from
Nov 2, 2022

Conversation

cimnine
Copy link
Collaborator

@cimnine cimnine commented Oct 25, 2022

Related Issue: #857 #860 #852 #856 #779 #840

New Behavior

New release

Contrast to Current Behavior

In the previous version, we began to clean up NetBox Docker to make it easier to maintain and so that it breaks less often, when the upstream NetBox team releases a new version.

This version continues with more maintenance related work. It also exposes two new variables as environment variables (one general, one ldap-specific) and allows the dynamic configuration parameters to be used, while still allowing them to be set via the environment for backwards compatibility.

Discussion: Benefits and Drawbacks

Please see the individual PRs.

Changes to the Wiki

n/a

Proposed Release Note Entry


# Noteworthy Changes

In the previous version, we began to clean up NetBox Docker to make it easier to maintain and so that it breaks less often, when the upstream NetBox team releases a new version.

This version continues with more maintenance related work. It also exposes two new variables as environment variables (one general, one ldap-specific) and allows the _dynamic configuration parameters_ to be used, while still allowing them to be set via the environment for backwards compatibility.

In the next version we will probably update the PostgreSQL version from 14 to 15.

## Dependency Updates

- Update dependency psycopg2 to v2.9.4 #856

## Adding the `JOBRESULT_RETENTION` variable #840

The PR #840 exposes a new variable `JOBRESULT_RETENTION` as an environment variable.

Thanks @tymekxxl for the PR!

## Adding the `AUTH_LDAP_BIND_AS_AUTHENTICATING_USER` variable #779

The PR #779 adds the new  environment variable `AUTH_LDAP_BIND_AS_AUTHENTICATING_USER` to the ldap configuration file. This allows NetBox Docker to bind to an LDAP server using username and password provided by the user being authenticated.

Thanks @BegBlev for the PR.

## A volume for the caching Redis #852

Fixes the behavior that the caching Redis, which is actually ephemeral, creates a lot of unmanaged volumes. That is, because that's what the Redis container declares in its manifest. #852 fixes this by defining a managed volume for the caching Redis, even though it's not required otherwise.

Thanks to @Delta1977 for the PR.

## Support dynamic configuration parameters #857

All the [dynamic configuration parameters](https://docs.netbox.dev/en/stable/configuration/#dynamic-configuration-parameters) can now be configured via the web administration of NetBox. (You can still configure them via environment variables).

The following additional configuration parameters are now available to be configured via environment variables:

    ALLOWED_URL_SCHEMES
    DEVELOPER
    INTERNAL_IPS
    LOGIN_PERSISTENCE
    CSRF_COOKIE_NAME
    SESSION_COOKIE_NAME
    POWERFEED_DEFAULT_AMPERAGE
    POWERFEED_DEFAULT_MAX_UTILIZATION
    POWERFEED_DEFAULT_VOLTAGE

Please refer [to the NetBox documentation](https://docs.netbox.dev/en/stable/configuration/#dynamic-configuration-parameters) for their allowed values and proper use.

Thanks go out to @benwa for the submitting an earlier draft and bringing the topic onto our plate.

# Compatibility

This version of NetBox Docker is only compatible with NetBox v3.3.x and above.
For older versions, use [a previous release of NetBox Docker](https://github.com/netbox-community/netbox-docker/releases/).

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 the release branch.

@cimnine cimnine added the maintenance The issue describes a maintenance task, such as upgrading a dependency to a certain version. label Oct 25, 2022
@cimnine cimnine self-assigned this Oct 25, 2022
@cimnine cimnine merged commit 8b16b16 into release Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance The issue describes a maintenance task, such as upgrading a dependency to a certain version.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants