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

Release 0.23.0 #265

Merged
merged 16 commits into from
Mar 30, 2020
Merged

Release 0.23.0 #265

merged 16 commits into from
Mar 30, 2020

Conversation

cimnine
Copy link
Collaborator

@cimnine cimnine commented Mar 30, 2020

Related Issue: n/a

New Behavior

Contrast to Current Behavior

The current release contains one bug: The Redis configuration is not consistent. Also Netbox evolved and introduced new features, for which we have to account for. Namely the embedded documentation and the release check.

Discussion: Benefits and Drawbacks

All potentially backward-incompatible changes only affect the image, not the surrounding files. I therefore don't expect problems with backwards compatibility. En contraire: The Redis bug was a bug in the surrounding configuration files and should be fixed for earlier Netbox images as well.

Changes to the Wiki

n/a

Proposed Release Note Entry

This is mostly a maintenance release. We don't expect any problems when updating from the previous version to this version.

Improved maintenance of Startup Scripts by reducing duplicates #244

This is an internal change and unifies the creation of the users and groups in the respective startup scripts. It also lays the foundation for more of this, i.e. more removal of duplicate code.

Fix inconsistent Redis configuration #245

We've introduced an error when we split the Redis instances into two: The cache and the work queue. This change fixes this bug.

Fix embedded documentation #255

Netbox recently introduced embedded documentation. This change adds the respective documentation files to the Netbox image.

Improve README #258

The README file, which is potentially the first contact with our project for new users, was inconsistent with our wiki. It was overhauled to better suit newcomers.

Expose RELEASE_CHECK_URL as env var #263

Netbox recently introduced new variables in the configuration file: RELEASE_CHECK_URL and RELEASE_CHECK_TIMEOUT. These are now exposed in the Netbox Docker default configuration file and can be defined through environment variables.

Compatibility

This version of Netbox Docker is compatible with Netbox v2.7.x (and hopefully later versions as well).

Known Issues

There are no known issues.

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 master branch.

tobiasge and others added 16 commits February 10, 2020 07:47
This commit starts to remove some code redundancy from the startup
scripts for easier maintenance.
This move the setting of user and group permissions in the startup
script to its own function.
Permission handling in external function
In the configuration.py we use database 1 as the default but in the .env
file we used 0. This sets both values to 1 as the default.
Our docker-compose.yml pointed the env file for the Redis cache to the
wrong file. Now the Redis cache password between the netbox.env and
redis-cache.env match.
When running tests with ´test.sh´ some errors where logged because now
redis-cache instance was running.
…encies

Fix configuration inconsistencies
Fix embedded documents for Netbox version v2.7.10 and higher.
- adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki
- Adds a new _Getting Help_ section
- Improvements in explaining the tags of the published Docker image
Co-Authored-By: Christian Mäder <cimnine@users.noreply.github.com>
Add RELEASE_CHECK_URL to configuration and default env.
@cimnine cimnine added this to the 0.23.0 milestone Mar 30, 2020
@cimnine cimnine requested a review from tobiasge March 30, 2020 13:32
@cimnine cimnine merged commit 5769684 into release Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants