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

Pin the NetBox Docker version in the docker-compose.yml file #520

Merged
merged 1 commit into from
May 31, 2021

Conversation

cimnine
Copy link
Collaborator

@cimnine cimnine commented May 26, 2021

Related Issue: n/a

New Behavior

The version of the NetBox Docker image in the docker-compose.yml file is pinned to the specific minor version compatible with the current release of NetBox Docker.

Contrast to Current Behavior

Currently we use the latest tag by default.

But the NetBox Docker images are tagged with the version of NetBox they contain.
But only certain releases of NetBox Docker support certain versions of NetBox.
This lead to frustration when upgrading for a lot of users, because it's not obvious how the versions (NetBox Docker, NetBox, NetBox Docker image) are tied to each other.

The latest tag might point to a version of NetBox, which is not yet supported by NetBox Docker. This leads to frustration.

Discussion: Benefits and Drawbacks

By pinning the specific version of NetBox we support, I hope to reduce that frustration. I.e. that a user runs docker compose pull in the project's directory, which will eventually fetch a version of the NetBox Docker image that is not yet supported.

Changes to the Wiki

There should be no changes necessary.

Proposed Release Note Entry

## The NetBox Docker image is pinned to the supported NetBox minor version in `docker-compose.yml`

Previously, the `docker-compose.yml` always pointed towards the `latest` tag of the NetBox Docker image.
This has lead to frustration, if `latest` pointed to a version of NetBox that was not yet supported by the NetBox Docker project.

By pinning the version of NetBox in the `docker-compose.yml`, we increase the chance that a given version of NetBox Docker fetches a NetBox Docker image that is compatible.

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.

@cimnine cimnine added the enhancement The issue describes an enhancement that we would like to implement in the future. label May 26, 2021
@cimnine cimnine added this to the next milestone May 26, 2021
@cimnine cimnine requested a review from tobiasge May 26, 2021 17:16
@cimnine cimnine merged commit 6658d06 into netbox-community:develop May 31, 2021
@cimnine cimnine deleted the PinNetboxMinor branch May 31, 2021 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement The issue describes an enhancement that we would like to implement in the future.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants