Merge pull request #705 from netbox-community/develop

Release 1.6.0

.dockerignore

@@ -7,5 +7,4 @@ build*
 docker-compose.override.yml
 .netbox/.git*
 .netbox/.travis.yml
-.netbox/docs
 .netbox/scripts

.ecrc

@@ -0,0 +1,23 @@
+{
+  "Verbose": false,
+  "Debug": false,
+  "IgnoreDefaults": false,
+  "SpacesAftertabs": false,
+  "NoColor": false,
+  "Exclude": [
+    "LICENSE",
+    "\\.initializers",
+    "\\.vscode"
+  ],
+  "AllowedContentTypes": [],
+  "PassedFiles": [],
+  "Disable": {
+    // set these options to true to disable specific checks
+    "EndOfLine": false,
+    "Indentation": false,
+    "InsertFinalNewline": false,
+    "TrimTrailingWhitespace": false,
+    "IndentSize": true,
+    "MaxLineLength": false
+  }
+}

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_size = 4

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 100
+extend-ignore = E203, W503
+per-file-ignores =
+  configuration/*:E131,E251,E266,E302,E305,E501,E722
+  startup_scripts/startup_script_utils/__init__.py:F401
+  docker/*:E266,E722

.github/FUNDING.yml

@@ -0,0 +1,14 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+- cimnine
+- tobiasge
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,77 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!--
-
-Before raising an issue here, answer the following questions for yourself, please:
-
-* Did you read through the troubleshooting section? (https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting)
-* Have you had a look at the rest of the wiki? (https://github.com/netbox-community/netbox-docker/wiki)
-* Have you updated to the latest version and tried again? (i.e. `git pull` and `docker-compose pull`)
-* Have you reset the project and tried again? (i.e. `docker-compose down -v`)
-* Are you confident that your problem is related to the Docker image or Docker Compose file this project provides?
-  (Otherwise ask on the Netbox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
-* Have you looked through the issues already resolved?
-
-Please try this means to get help before opening an issue here:
-
-* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/
-* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
-* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
-
-Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
-
--->
-
-## Current Behavior
-
-<!-- describe what you did and how it misbehaved -->
-...
-
-## Expected Behavior
-
-<!-- describe what you expected instead -->
-...
-
-## Debug Information
-
-<!-- please fill in the following information that might helps us debug your problem more quickly -->
-The output of `docker-compose version`: `XXXXX`
-The output of `docker version`: `XXXXX`
-The output of `git rev-parse HEAD`: `XXXXX`
-The command you used to start the project: `XXXXX`
-
-<!-- adjust the `latest` tag to the version you're using -->
-The output of `docker inspect netboxcommunity/netbox:latest --format "{{json .Config.Labels}}"`:
-
-```json
-{
-  "JSON JSON JSON":
-    "--> Please paste formatted json. (Use e.g. `jq` or https://jsonformatter.curiousconcept.com/)"
-}
-```
-
-The output of `docker-compose logs netbox`:
-<!--
-If your log is very long, create a Gist instead (and post the link to it): https://gist.github.com
--->
-
-```text
-LOG LOG LOG
-```
-
-The output of `docker-compose logs nginx`:
-<!--
-Only if you have gotten a 5xx http error, else delete this section.
-If your log is very long, create a Gist instead (and post the link to it): https://gist.github.com
--->
-
-```text
-LOG LOG LOG
-```

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,148 @@
+name: Bug report
+description: Create a report about a malfunction of the Docker setup
+body:
+- type: markdown
+  attributes:
+    value: |
+      Please only raise an issue if you're certain that you've found a bug.
+      Else, see these other means to get help:
+
+      - See our troubleshooting section:
+        https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
+      - Have a look at the rest of the wiki:
+        https://github.com/netbox-community/netbox-docker/wiki
+      - Check the release notes:
+        https://github.com/netbox-community/netbox-docker/releases
+      - Look through the issues already resolved:
+        https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
+
+      If you did not find what you're looking for,
+      try the help of our community:
+
+      - Post to Github Discussions:
+        https://github.com/netbox-community/netbox-docker/discussions
+      - Join the `#netbox-docker` channel on our Slack:
+        https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
+      - Ask on the NetBox mailing list:
+        https://groups.google.com/d/forum/netbox-discuss
+
+      Please don't open an issue to open a PR.
+      Just submit the PR, that's good enough.
+- type: textarea
+  id: current-behavior
+  attributes:
+    label: Current Behavior
+    description: Please describe what you did and how you think it misbehaved
+    placeholder: I tried to … by doing …, but it …
+  validations:
+    required: true
+- type: textarea
+  id: expected-behavior
+  attributes:
+    label: Expected Behavior
+    description: Please describe what you expected instead
+    placeholder: I expected that … when I do …
+  validations:
+    required: true
+- type: input
+  id: docker-compose-version
+  attributes:
+    label: Docker Compose Version
+    description: Please paste the output of `docker-compose version`
+    placeholder: Docker Compose version vX.Y.Z
+  validations:
+    required: true
+- type: textarea
+  id: docker-version
+  attributes:
+    label: Docker Version
+    description: Please paste the output of `docker version`
+    render: text
+    placeholder: |
+      Client:
+      Cloud integration: 1.0.17
+      Version:           20.10.8
+      API version:       1.41
+      Go version:        go1.16.6
+      Git commit:        3967b7d
+      Built:             Fri Jul 30 19:55:20 2021
+      OS/Arch:           darwin/amd64
+      Context:           default
+      Experimental:      true
+
+      Server: Docker Engine - Community
+      Engine:
+        Version:          20.10.8
+        API version:      1.41 (minimum version 1.12)
+        Go version:       go1.16.6
+        Git commit:       75249d8
+        Built:            Fri Jul 30 19:52:10 2021
+        OS/Arch:          linux/amd64
+        Experimental:     false
+      containerd:
+        Version:          1.4.9
+        GitCommit:        e25210fe30a0a703442421b0f60afac609f950a3
+      runc:
+        Version:          1.0.1
+        GitCommit:        v1.0.1-0-g4144b63
+      docker-init:
+        Version:          0.19.0
+        GitCommit:        de40ad0
+  validations:
+    required: true
+- type: input
+  id: git-rev
+  attributes:
+    label: The git Revision
+    description: Please paste the output of `git rev-parse HEAD`
+  validations:
+    required: true
+- type: textarea
+  id: git-status
+  attributes:
+    label: The git Status
+    description: Please paste the output of `git status`
+    render: text
+    placeholder: |
+      On branch main
+      nothing to commit, working tree clean
+  validations:
+    required: true
+- type: input
+  id: run-command
+  attributes:
+    label: Startup Command
+    description: Please specify the command you used to start the project
+    placeholder: docker compose up
+  validations:
+    required: true
+- type: textarea
+  id: netbox-logs
+  attributes:
+    label: NetBox Logs
+    description: Please paste the output of `docker-compose logs netbox` (or `docker compose logs netbox`)
+    render: text
+    placeholder: |
+      netbox_1  | ⚙️ Applying database migrations
+      netbox_1  | 🧬 loaded config '/etc/netbox/config/configuration.py'
+      netbox_1  | 🧬 loaded config '/etc/netbox/config/a.py'
+      netbox_1  | 🧬 loaded config '/etc/netbox/config/extra.py'
+      netbox_1  | 🧬 loaded config '/etc/netbox/config/logging.py'
+      netbox_1  | 🧬 loaded config '/etc/netbox/config/plugins.py'
+      ...
+  validations:
+    required: true
+- type: textarea
+  id: docker-compose-override-yml
+  attributes:
+    label: Content of docker-compose.override.yml
+    description: Please paste the output of `cat docker-compose.override.yml`
+    render: yaml
+    placeholder: |
+      version: '3.4'
+      services:
+        netbox:
+          ports:
+            - '8080:8080'
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,15 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question
+    url: https://github.com/netbox-community/netbox-docker/discussions
+    about: The Github Discussions are the right place to ask questions about how to use or do certain things with NetBox Docker.
+
+  - name: Chat
+    url: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
+    about: 'Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel.'
+
+  - name: Community Wiki
+    url: https://github.com/netbox-community/netbox-docker/wiki
+    about: |
+      Our wiki contains information for common problems and tips for operating NetBox Docker in production.
+      It's maintained by our excellent community.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,54 +0,0 @@
----
-name: Feature or Change Request
-about: Request a new feature or a change of the current behavior
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!--
-
-Before raising an issue here, answer the following questions for yourself, please:
-
-* Did you read through the troubleshooting section? (https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting)
-* Have you had a look at the rest of the wiki? (https://github.com/netbox-community/netbox-docker/wiki)
-* Have you read the release notes recently (https://github.com/netbox-community/netbox-docker/releases)
-* Are you confident that your feature/change request is related to the Docker image or Docker Compose file this project provides?
-  (Otherwise ask on the Netbox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
-* Have you looked through the issues already resolved?
-
-Please try this means to get help before opening an issue here:
-
-* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/
-* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
-* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
-
-Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
-
--->
-
-## Desired Behavior
-
-<!-- please describe the behavior you desire -->
-...
-
-## Contrast to Current Behavior
-
-<!-- please describe how the desired behavior is different from the current behavior -->
-...
-
-## Changes Required
-
-<!-- if you can, please elaborate what changes would exactly be required -->
-...
-
-## Discussion: Benefits and Drawbacks
-
-<!--
-Please make your case here:
-- Why do you think this project and the community will benefit from your suggestion?
-- What are the drawbacks of this change? Is it backwards-compatible?
-- Anything else that you think is relevant to the discussion of this feature/change request.
--->
-...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,68 @@
+name: Feature or Change Request
+description: Request a new feature or a change of the current behavior
+body:
+- type: markdown
+  attributes:
+    value: |
+      This issue type is to propose new features for the Docker setup.
+      To just spin an idea, see the Github Discussions section, please.
+
+      Before asking for help, see these links first:
+
+      - See our troubleshooting section:
+        https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
+      - Have a look at the rest of the wiki:
+        https://github.com/netbox-community/netbox-docker/wiki
+      - Check the release notes:
+        https://github.com/netbox-community/netbox-docker/releases
+      - Look through the issues already resolved:
+        https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
+
+      If you did not find what you're looking for,
+      try the help of our community:
+
+      - Post to Github Discussions:
+        https://github.com/netbox-community/netbox-docker/discussions
+      - Join the `#netbox-docker` channel on our Slack:
+        https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
+      - Ask on the NetBox mailing list:
+        https://groups.google.com/d/forum/netbox-discuss
+
+      Please don't open an issue to open a PR.
+      Just submit the PR, that's good enough.
+- type: textarea
+  id: desired-behavior
+  attributes:
+    label: Desired Behavior
+    description: Please describe the desired behavior
+    placeholder: To me, it would be useful, if … because …
+  validations:
+    required: true
+- type: textarea
+  id: contrast-to-current
+  attributes:
+    label: Contrast to Current Behavior
+    description: Please describe how the desired behavior is different from the current behavior
+    placeholder: The current behavior is …, but this lacks …
+  validations:
+    required: true
+- type: textarea
+  id: required-changes
+  attributes:
+    label: Required Changes
+    description: If you can, please elaborate what changes will be required to implement the desired behavior
+    placeholder: I suggest to change the file …
+  validations:
+    required: false
+- type: textarea
+  id: discussion
+  attributes:
+    label: 'Discussion: Benefits and Drawbacks'
+    description: |
+      Please make your case here:
+      - Why do you think this project and the community will benefit from your suggestion?
+      - What are the drawbacks of this change? Is it backwards-compatible?
+      - Anything else that you think is relevant to the discussion of this feature/change request.
+    placeholder: I suggest to change the file …
+  validations:
+    required: false

.github/no-response.yml

@@ -0,0 +1,10 @@
+# Configuration for probot-no-response - https://github.com/probot/no-response
+
+# Number of days of inactivity before an Issue is closed for lack of response
+daysUntilClose: 30
+# Label requiring a response
+responseRequiredLabel: awaiting answer
+# Comment to post when closing an Issue for lack of response. Set to `false` to disable
+closeComment: >
+  This issue has been automatically closed because there has been no response
+  to our request for more information from the original author.

.github/workflows/push.yml

@@ -4,27 +4,55 @@ on:
   push:
     branches-ignore:
       - release
+  pull_request:
+    branches-ignore:
+      - release
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Checks syntax of our code
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        # Full git history is needed to get a proper list of changed files within `super-linter`
+        fetch-depth: 0
+    - uses: actions/setup-python@v2
+    - name: Lint Code Base
+      uses: github/super-linter@v4
+      env:
+        DEFAULT_BRANCH: develop
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        SUPPRESS_POSSUM: true
+        LINTER_RULES_PATH: /
+        VALIDATE_ALL_CODEBASE: false
+        VALIDATE_DOCKERFILE: false
+        FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
+
+        EDITORCONFIG_FILE_NAME: .ecrc
+        DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
+        MARKDOWN_CONFIG_FILE: .markdown-lint.yml
+        PYTHON_BLACK_CONFIG_FILE: pyproject.toml
+        PYTHON_FLAKE8_CONFIG_FILE: .flake8
+        PYTHON_ISORT_CONFIG_FILE: pyproject.toml
   build:
+    continue-on-error: ${{ matrix.docker_from == 'alpine:edge' }}
     strategy:
       matrix:
         build_cmd:
         - ./build-latest.sh
         - PRERELEASE=true ./build-latest.sh
-        - ./build-branches.sh
+        - ./build.sh feature
+        - ./build.sh develop
         docker_from:
-        - '' # use the default of the DOCKERFILE
+        - '' # use the default of the build script
-        - python:3.7-alpine
-        - python:3.8-alpine
-        # - python:3.9-rc-alpine # disable until Netbox's unit tests work
       fail-fast: false
     runs-on: ubuntu-latest
-    name: Builds new Netbox Docker Images
+    name: Builds new NetBox Docker Images
     steps:
     - id: git-checkout
       name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
     - id: docker-build
       name: Build the image from '${{ matrix.docker_from }}' with '${{ matrix.build_cmd }}'
       run: ${{ matrix.build_cmd }}

.github/workflows/release.yml

@@ -1,9 +1,9 @@
 name: release
 
 on:
-  push:
+  release:
-    branches:
+    types:
-      - release
+      - published
   schedule:
     - cron: '45 5 * * *'
 
@@ -14,38 +14,74 @@ jobs:
         build_cmd:
         - ./build-latest.sh
         - PRERELEASE=true ./build-latest.sh
-        - ./build-branches.sh
+        - ./build.sh feature
+        - ./build.sh develop
       fail-fast: false
     runs-on: ubuntu-latest
-    name: Builds new Netbox Docker Images
+    name: Builds new NetBox Docker Images
+    env:
+      GH_ACTION: enable
     steps:
-    - id: git-checkout
+    -
       name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
-    - id: docker-build
+    -
+      name: Get Version of NetBox Docker
+      run: |
+        echo "::set-output name=version::$(cat VERSION)"
+      shell: bash
+    -
+      id: docker-build
       name: Build the image with '${{ matrix.build_cmd }}'
       run: ${{ matrix.build_cmd }}
-      env:
+    -
-        GH_ACTION: enable
-    - id: docker-test
       name: Test the image
       run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
       if: steps.docker-build.outputs.skipped != 'true'
-    - id: registry-login
+
-      name: Login to the Docker Registry
+    # docker.io
-      run: |
+    -
-        echo "::add-mask::$DOCKERHUB_USERNAME"
+      name: Login to docker.io
-        echo "::add-mask::$DOCKERHUB_PASSWORD"
+      uses: docker/login-action@v1
-        docker login -u "$DOCKERHUB_USERNAME" --password "${DOCKERHUB_PASSWORD}" "${DOCKER_REGISTRY}"
+      with:
-      env:
+        registry: docker.io
-        DOCKERHUB_USERNAME: ${{ secrets.dockerhub_username }}
+        username: ${{ secrets.dockerhub_username }}
-        DOCKERHUB_PASSWORD: ${{ secrets.dockerhub_password }}
+        password: ${{ secrets.dockerhub_password }}
       if: steps.docker-build.outputs.skipped != 'true'
-    - id: registry-push
+    -
-      name: Push the image
+      name: Push the image to docker.io
       run: ${{ matrix.build_cmd }} --push-only
       if: steps.docker-build.outputs.skipped != 'true'
-    - id: registry-logout
+
-      name: Logout of the Docker Registry
+    # quay.io
-      run: docker logout "${DOCKER_REGISTRY}"
+    -
+      name: Login to Quay.io
+      uses: docker/login-action@v1
+      with:
+        registry: quay.io
+        username: ${{ secrets.quayio_username }}
+        password: ${{ secrets.quayio_password }}
+      if: steps.docker-build.outputs.skipped != 'true'
+    -
+      name: Build and push the image with '${{ matrix.build_cmd }}'
+      run: ${{ matrix.build_cmd }} --push
+      env:
+        DOCKER_REGISTRY: quay.io
+      if: steps.docker-build.outputs.skipped != 'true'
+
+    # ghcr.io
+    -
+      name: Login to GitHub Container Registry
+      uses: docker/login-action@v1
+      with:
+        registry: ghcr.io
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+      if: steps.docker-build.outputs.skipped != 'true'
+    -
+      name: Build and push the image with '${{ matrix.build_cmd }}'
+      run: ${{ matrix.build_cmd }} --push
+      env:
+        DOCKER_REGISTRY: ghcr.io
+        DOCKER_ORG: netbox-community
       if: steps.docker-build.outputs.skipped != 'true'

.gitignore

@@ -2,3 +2,14 @@
 .netbox
 .initializers
 docker-compose.override.yml
+*.pem
+configuration/*
+!configuration/configuration.py
+!configuration/extra.py
+configuration/ldap/*
+!configuration/ldap/extra.py
+!configuration/ldap/ldap_config.py
+!configuration/logging.py
+!configuration/plugins.py
+prometheus.yml
+super-linter.log

.hadolint.yaml

@@ -0,0 +1,3 @@
+ignored:
+- DL3006
+- DL3018

.markdown-lint.yml

@@ -0,0 +1,2 @@
+MD013: false
+MD041: false

.travis.yml

@@ -1,32 +0,0 @@
-sudo: required
-language: python
-
-env:
-  - BUILD=release
-  - BUILD=prerelease
-  - BUILD=branches
-  - BUILD=special
-
-git:
-  depth: 5
-
-services:
-  - docker
-
-install:
-  - docker-compose pull --parallel
-  - docker-compose build
-
-script:
-  - docker-compose run netbox ./manage.py test
-
-after_script:
-  - docker-compose down
-
-after_success:
-  - docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
-  - ./build-all.sh --push
-
-notifications:
-  slack:
-    secure: F3VsWcvU/XYyjGjU8ZAVGpREe7F1NjKq6LuMRzhQORbXUvanxDQtLzEe0Y5zm/6+gHkx6t8cX/v2PiCI+v46pkapYMUimd+QEOL1WxbUdnw2kQxcgw/R3wX34l2FHXbG3/a+TmH3euqbSCTIrPy9ufju948i+Q0E0u0fyInmozl8qOT23C4joQOpVAq7y+wHxTxsEg46ZzL2Ties+dmqjMsvHocv7mPI2IWzAWA8SJZxS82Amoapww++QjgEmoY+tMimLkdeXCRgeoj41UGHDg54rbEXh/PTaWiuzyzTr1WLmsGRScC57fDRivp3mSM37/MlNxsRj1z+j4zrvWFQgNfJ2yMjBHroc1jOX/uCY4dwbpSPqUCpc4idMGCGZFItgzTQ3lAPYAsom0C6n8C08Xk8EsNKWwXrDSd4ZUhIwptkNPCFK+kXbLFsMzSApnaBYW0T+wba57nZdiWjOPYmvJr49MDm5NHv2KaRBX2gpw7t7ZLhTgwGEWcZvcDebiLneXcXY5hZ7v2NHJkx/2x1yNXo85xZDy0wK1FGoOOHwPhvqOB+pcQZ/pUOSPTKqGw5l/CexoRm1shFsK+19FnSgimqTHjcuCo4lFW3JlEvlFhtfFXIte2Wjp1ALZgTrSq8zSD5rRxYCUKmM7b3EJwdaIgbvKWPdS4sCXlXU1bHx0g=

Dockerfile

@@ -1,38 +1,50 @@
-ARG FROM=python:3.7-alpine
+ARG FROM
 FROM ${FROM} as builder
 
 RUN apk add --no-cache \
       bash \
       build-base \
+      cargo \
       ca-certificates \
+      cmake \
       cyrus-sasl-dev \
+      git \
       graphviz \
       jpeg-dev \
       libevent-dev \
       libffi-dev \
       libxslt-dev \
+      make \
+      musl-dev \
       openldap-dev \
-      postgresql-dev
+      postgresql-dev \
+      py3-pip \
+      python3-dev \
+  && python3 -m venv /opt/netbox/venv \
+  && /opt/netbox/venv/bin/python3 -m pip install --upgrade \
+      pip \
+      setuptools \
+      wheel
 
-WORKDIR /install
+# Build libcrc32c for google-crc32c python module
-
+RUN git clone https://github.com/google/crc32c \
-RUN pip install --prefix="/install" --no-warn-script-location \
+    && cd crc32c \
-# gunicorn is used for launching netbox
+    && git submodule update --init --recursive \
-      gunicorn \
+    && mkdir build \
-      greenlet \
+    && cd build \
-      eventlet \
+    && cmake \
-# napalm is used for gathering information from network devices
+        -DCMAKE_BUILD_TYPE=Release \
-      napalm \
+        -DCRC32C_BUILD_TESTS=no \
-# ruamel is used in startup_scripts
+        -DCRC32C_BUILD_BENCHMARKS=no \
-      'ruamel.yaml>=0.15,<0.16' \
+        -DBUILD_SHARED_LIBS=yes \
-# django_auth_ldap is required for ldap
+        .. \
-      django_auth_ldap \
+    && make all install
-# django-storages was introduced in 2.7 and is optional
-      django-storages
 
 ARG NETBOX_PATH
-COPY ${NETBOX_PATH}/requirements.txt /
+COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
-RUN pip install --prefix="/install" --no-warn-script-location -r /requirements.txt
+RUN /opt/netbox/venv/bin/pip install \
+      -r /requirements.txt \
+      -r /requirements-container.txt
 
 ###
 # Main stage
@@ -44,42 +56,54 @@ FROM ${FROM} as main
 RUN apk add --no-cache \
       bash \
       ca-certificates \
+      curl \
       graphviz \
       libevent \
       libffi \
       libjpeg-turbo \
-      libressl \
       libxslt \
+      openssl \
+      postgresql-client \
       postgresql-libs \
-      ttf-ubuntu-font-family
+      py3-pip \
+      python3 \
+      tini \
+      unit \
+      unit-python3
 
 WORKDIR /opt
 
-COPY --from=builder /install /usr/local
+COPY --from=builder /usr/local/lib/libcrc32c.* /usr/local/lib/
+COPY --from=builder /usr/local/include/crc32c /usr/local/include
+COPY --from=builder /usr/local/lib/cmake/Crc32c /usr/local/lib/cmake/
+COPY --from=builder /opt/netbox/venv /opt/netbox/venv
 
 ARG NETBOX_PATH
 COPY ${NETBOX_PATH} /opt/netbox
 
 COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py
-COPY configuration/gunicorn_config.py /etc/netbox/config/
-COPY docker/nginx.conf /etc/netbox-nginx/nginx.conf
 COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh
+COPY docker/housekeeping.sh /opt/netbox/housekeeping.sh
+COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
 COPY startup_scripts/ /opt/netbox/startup_scripts/
 COPY initializers/ /opt/netbox/initializers/
-COPY configuration/configuration.py /etc/netbox/config/configuration.py
+COPY configuration/ /etc/netbox/config/
+COPY docker/nginx-unit.json /etc/unit/
 
 WORKDIR /opt/netbox/netbox
 
-# Must set permissions for '/opt/netbox/netbox/static' directory
-# to g+w so that `./manage.py collectstatic` can be executed during
-# container startup.
 # Must set permissions for '/opt/netbox/netbox/media' directory
 # to g+w so that pictures can be uploaded to netbox.
-RUN mkdir static && chmod g+w static media
+RUN mkdir -p static /opt/unit/state/ /opt/unit/tmp/ \
+      && chown -R unit:root media /opt/unit/ \
+      && chmod -R g+w media /opt/unit/ \
+      && cd /opt/netbox/ && SECRET_KEY="dummy" /opt/netbox/venv/bin/python -m mkdocs build \
+          --config-file /opt/netbox/mkdocs.yml --site-dir /opt/netbox/netbox/project-static/docs/ \
+      && SECRET_KEY="dummy" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input
 
-ENTRYPOINT [ "/opt/netbox/docker-entrypoint.sh" ]
+ENTRYPOINT [ "/sbin/tini", "--" ]
 
-CMD ["gunicorn", "-c /etc/netbox/config/gunicorn_config.py", "netbox.wsgi"]
+CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
 
 LABEL ORIGINAL_TAG="" \
       NETBOX_GIT_BRANCH="" \
@@ -89,8 +113,8 @@ LABEL ORIGINAL_TAG="" \
 # Also https://microbadger.com/labels
       org.label-schema.schema-version="1.0" \
       org.label-schema.build-date="" \
-      org.label-schema.name="Netbox Docker" \
+      org.label-schema.name="NetBox Docker" \
-      org.label-schema.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
+      org.label-schema.description="A container based distribution of NetBox, the free and open IPAM and DCIM solution." \
       org.label-schema.vendor="The netbox-docker contributors." \
       org.label-schema.url="https://github.com/netbox-community/netbox-docker" \
       org.label-schema.usage="https://github.com/netbox-community/netbox-docker/wiki" \
@@ -99,8 +123,8 @@ LABEL ORIGINAL_TAG="" \
       org.label-schema.version="snapshot" \
 # See https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys
       org.opencontainers.image.created="" \
-      org.opencontainers.image.title="Netbox Docker" \
+      org.opencontainers.image.title="NetBox Docker" \
-      org.opencontainers.image.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
+      org.opencontainers.image.description="A container based distribution of NetBox, the free and open IPAM and DCIM solution." \
       org.opencontainers.image.licenses="Apache-2.0" \
       org.opencontainers.image.authors="The netbox-docker contributors." \
       org.opencontainers.image.vendor="The netbox-docker contributors." \
@@ -122,4 +146,3 @@ RUN apk add --no-cache \
       util-linux
 
 COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
-COPY configuration/ldap_config.py /etc/netbox/config/ldap_config.py

README.md

@@ -5,34 +5,97 @@
 ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/netbox-community/netbox-docker)
 ![Github release workflow](https://img.shields.io/github/workflow/status/netbox-community/netbox-docker/release)
 ![Docker Pulls](https://img.shields.io/docker/pulls/netboxcommunity/netbox)
-[![MicroBadger Layers](https://img.shields.io/microbadger/layers/netboxcommunity/netbox)][netbox-docker-microbadger]
-[![MicroBadger Size](https://img.shields.io/microbadger/image-size/netboxcommunity/netbox)][netbox-docker-microbadger]
 [![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license]
 
-[The Github repository](netbox-docker-github) houses the components needed to build Netbox as a Docker container.
+[The GitHub repository](netbox-docker-github) houses the components needed to build NetBox as a container.
-Images are built using this code and are released to [Docker Hub][netbox-dockerhub] once a day.
+Images are built regularly using the code in that repository and are pushed to [Docker Hub][netbox-dockerhub], [Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr].
 
-Do you have any questions? Before opening an issue on Github, please join the [Network To Code][ntc-slack] Slack and ask for help in our [`#netbox-docker`][netbox-docker-slack] channel.
+Do you have any questions?
+Before opening an issue on Github,
+please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel.
 
 [github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
 [github-release]: https://github.com/netbox-community/netbox-docker/releases
 [netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox
-[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/tags/
+[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/
+[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox
+[netbox-ghcr]: https://github.com/netbox-community/netbox-docker/pkgs/container/netbox
 [netbox-docker-github]: https://github.com/netbox-community/netbox-docker/
-[ntc-slack]: http://slack.networktocode.com/
+[netbox-docker-slack]: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
-[netbox-docker-slack]: https://slack.com/app_redirect?channel=netbox-docker&team=T09LQ7E9E
+[netbox-docker-slack-channel]: https://netdev-community.slack.com/archives/C01P0GEVBU7
+[netbox-slack-channel]: https://netdev-community.slack.com/archives/C01P0FRSXRV
 [netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
 
-## Docker Tags
+## Quickstart
 
-* `vX.Y.Z`: Release builds, built from [releases of Netbox][netbox-releases].
+To get _NetBox Docker_ up and running run the following commands.
-* `latest`: Release builds, built from [`master` branch of Netbox][netbox-master].
+There is a more complete [_Getting Started_ guide on our wiki][wiki-getting-started] which explains every step.
-* `snapshot`: Pre-release builds, built from the [`develop` branch of Netbox][netbox-develop].
-* `develop-X.Y`: Pre-release builds, built from the corresponding [branch of Netbox][netbox-branches].
 
-Then there is currently one extra tags for each of the above labels:
+```bash
+git clone -b release https://github.com/netbox-community/netbox-docker.git
+cd netbox-docker
+tee docker-compose.override.yml <<EOF
+version: '3.4'
+services:
+  netbox:
+    ports:
+      - 8000:8080
+EOF
+docker-compose pull
+docker-compose up
+```
 
-* `-ldap`: Contains additional dependencies and configurations for connecting Netbox to an LDAP directroy.
+The whole application will be available after a few minutes.
+Open the URL `http://0.0.0.0:8000/` in a web-browser.
+You should see the NetBox homepage.
+In the top-right corner you can login.
+The default credentials are:
+
+* Username: **admin**
+* Password: **admin**
+* API Token: **0123456789abcdef0123456789abcdef01234567**
+
+[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
+[docker-reception]: https://github.com/nxt-engineering/reception
+
+## Container Image Tags
+
+New container images are built and published automatically every ~24h.
+
+> We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production!
+
+* `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:
+  These are release builds containing _NetBox version_ `vX.Y.Z`.
+  They contain the support files of _NetBox Docker version_ `a.b.c`.
+  You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
+  These images are automatically built from [the corresponding releases of NetBox][netbox-releases].
+* `latest-a.b.c`:
+  These are release builds, containing the latest stable version of NetBox.
+  They contain the support files of _NetBox Docker version_ `a.b.c`.
+  You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
+  These images are automatically built from [the `master` branch of NetBox][netbox-master].
+* `snapshot-a.b.c`:
+  These are prerelease builds.
+  They contain the support files of _NetBox Docker version_ `a.b.c`.
+  You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
+  These images are automatically built from the [`develop` branch of NetBox][netbox-develop].
+
+For each of the above tag, there is an extra tag:
+
+* `vX.Y.Z`, `vX.Y`:
+  This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).
+  It always points to the latest version of _NetBox Docker_.
+* `latest`
+  This is the same version as `latest-a.b.c`.
+  It always points to the latest version of _NetBox Docker_.
+* `snapshot`
+  This is the same version as `snapshot-a.b.c`.
+  It always points to the latest version of _NetBox Docker_.
+
+Then there is currently one extra tags for each of the above tags:
+
+* `-ldap`:
+  These container images contain additional dependencies and configuration files for connecting NetBox to an LDAP directory.
   [Learn more about that in our wiki][netbox-docker-ldap].
 
 [netbox-releases]: https://github.com/netbox-community/netbox/releases
@@ -41,121 +104,64 @@ Then there is currently one extra tags for each of the above labels:
 [netbox-branches]: https://github.com/netbox-community/netbox/branches
 [netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP
 
-## Quickstart
+## Documentation
 
-To get Netbox up and running in Docker:
+Please refer [to our wiki on GitHub][netbox-docker-wiki] for further information on how to use the NetBox Docker image properly.
+The wiki covers advanced topics such as using files for secrets, configuring TLS, deployment to Kubernetes, monitoring and configuring NAPALM and LDAP.
 
-```bash
+Our wiki is a community effort.
-git clone -b release https://github.com/netbox-community/netbox-docker.git
+Feel free to correct errors, update outdated information or provide additional guides and insights.
-cd netbox-docker
-docker-compose pull
-docker-compose up -d
-```
 
-The application will be available after a few minutes.
+[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
-Use `docker-compose port nginx 8080` to find out where to connect to.
 
-```bash
+## Getting Help
-$ echo "http://$(docker-compose port nginx 8080)/"
-http://0.0.0.0:32768/
 
-# Open netbox in your default browser on macOS:
+Feel free to ask questions in our [GitHub Community][netbox-community]
-$ open "http://$(docker-compose port nginx 8080)/"
+or [join our Slack][netbox-docker-slack] and ask [in our channel `#netbox-docker`][netbox-docker-slack-channel],
+which is free to use and where there are almost always people online that can help you in the Slack channel.
 
-# Open netbox in your default browser on (most) linuxes:
+If you need help with using NetBox or developing for it or against it's API
-$ xdg-open "http://$(docker-compose port nginx 8080)/" &>/dev/null &
+you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.
-```
 
-Alternatively, use something like [Reception][docker-reception] to connect to _docker-compose_ projects.
+[netbox-community]: https://github.com/netbox-community/netbox-docker/discussions
-
-The default credentials are:
-
-* Username: **admin**
-* Password: **admin**
-* API Token: **0123456789abcdef0123456789abcdef01234567**
-
-There is a more complete [Getting Started guide on our Wiki][wiki-getting-started].
-
-[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
-[docker-reception]: https://github.com/nxt-engineering/reception
 
 ## Dependencies
 
 This project relies only on *Docker* and *docker-compose* meeting these requirements:
 
-* The *Docker version* must be at least `17.05`.
+* The *Docker version* must be at least `19.03`.
-* The *docker-compose version* must be at least `1.17.0`.
+* The *docker-compose version* must be at least `1.28.0`.
 
 To check the version installed on your system run `docker --version` and `docker-compose --version`.
 
-## Documentation
+## Updating
-
-Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this Netbox Docker image properly.
-It covers advanced topics such as using secret files, deployment to Kubernetes as well as NAPALM and LDAP configuration.
-
-[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
-
-## Netbox Version
-
-The `docker-compose.yml` file is prepared to run a specific version of Netbox.
-To use this feature, set the environment-variable `VERSION` before launching `docker-compose`, as shown below.
-`VERSION` may be set to the name of
-[any tag of the `netboxcommunity/netbox` Docker image on Docker Hub][netbox-dockerhub].
-
-```bash
-export VERSION=v2.7.1
-docker-compose pull netbox
-docker-compose up -d
-```
-
-You can also build a specific version of the Netbox Docker image yourself.
-`VERSION` can be any valid [git ref][git-ref] in that case.
-
-```bash
-export VERSION=v2.7.1
-./build.sh $VERSION
-docker-compose up -d
-```
-
-[git-ref]: https://git-scm.com/book/en/v2/Git-Internals-Git-References
-[netbox-github]: https://github.com/netbox-community/netbox/releases
-
-## Breaking Changes
-
-From time to time it might become necessary to re-engineer the structure of this setup.
-Things like the `docker-compose.yml` file or your Kubernetes or OpenShift configurations have to be adjusted as a consequence.
-
-Since November 2019 each image built from this repo contains a `org.opencontainers.image.version` label.
-(The images contained labels since April 2018, although in November 2019 the labels' names changed.)
-You can check the label of your local image by running `docker inspect netboxcommunity/netbox:v2.7.1 --format "{{json .Config.Labels}}"`.
 
 Please read [the release notes][releases] carefully when updating to a new image version.
+Note that the version of the NetBox Docker container image must stay in sync with the code.
+
+If you update for the first time, be sure [to follow our _How To Update NetBox Docker_ guide in the wiki][netbox-docker-wiki-updating].
 
 [releases]: https://github.com/netbox-community/netbox-docker/releases
+[netbox-docker-wiki-updating]: https://github.com/netbox-community/netbox-docker/wiki/Updating
 
 ## Rebuilding the Image
 
-`./build.sh` can be used to rebuild the Docker image. See `./build.sh --help` for more information.
+`./build.sh` can be used to rebuild the container image. See `./build.sh --help` for more information.
 
 For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
 
 [netbox-docker-wiki-build]: https://github.com/netbox-community/netbox-docker/wiki/Build
 
-### Pre-made Docker Images
-
-New Docker images are built and published every 24h.
-
 ## Tests
 
 We have a test script.
-It runs Netbox's own unit tests and ensures that all initializers work:
+It runs NetBox's own unit tests and ensures that all initializers work:
 
 ```bash
 IMAGE=netboxcommunity/netbox:latest ./test.sh
 ```
 
-## About
+## Support
 
-This repository is currently maintained and funded by [nxt][nxt].
+This repository is currently maintained by the community.
-
+Please consider sponsoring the maintainers of this project.
-[nxt]: https://nxt.engineering/en/

VERSION

@@ -1 +1 @@
-0.21.1
+1.6.0

build-all.sh

@@ -1,51 +0,0 @@
-#!/bin/bash
-# Builds all Docker images this project provides
-# Arguments:
-#   BUILD:     The release to build.
-#              Allowed: release, prerelease, branches, special
-#              Default: undefined
-
-echo "▶️ $0 $*"
-
-ALL_BUILDS=("release" "prerelease" "branches" "special")
-BUILDS=("${BUILD:-"${ALL_BUILDS[@]}"}")
-
-echo "⚙️ Configured builds: ${BUILDS[*]}"
-
-if [ -n "${DEBUG}" ]; then
-  export DEBUG
-fi
-
-ERROR=0
-
-for BUILD in "${BUILDS[@]}"; do
-  echo "🛠 Building '$BUILD' from '$DOCKERFILE'"
-  case $BUILD in
-    release)
-      # build the latest release
-      # shellcheck disable=SC2068
-      ./build-latest.sh $@ || ERROR=1
-      ;;
-    prerelease)
-      # build the latest pre-release
-      # shellcheck disable=SC2068
-      PRERELEASE=true ./build-latest.sh $@ || ERROR=1
-      ;;
-    branches)
-      # build all branches
-      # shellcheck disable=SC2068
-      ./build-branches.sh $@ || ERROR=1
-      ;;
-    *)
-      echo "🚨 Unrecognized build '$BUILD'."
-
-      if [ -z "$DEBUG" ]; then
-        exit 1
-      else
-        echo "⚠️ Would exit here with code '1', but DEBUG is enabled."
-      fi
-      ;;
-  esac
-done
-
-exit $ERROR

build-branches.sh

@@ -1,47 +0,0 @@
-#!/bin/bash
-# Builds develop, develop-* and master branches of Netbox
-
-echo "▶️ $0 $*"
-
-###
-# Checking for the presence of GITHUB_OAUTH_CLIENT_ID
-# and GITHUB_OAUTH_CLIENT_SECRET
-###
-if [ -n "${GITHUB_OAUTH_CLIENT_ID}" ] && [ -n "${GITHUB_OAUTH_CLIENT_SECRET}" ]; then
-  echo "🗝 Performing authenticated Github API calls."
-  GITHUB_OAUTH_PARAMS="client_id=${GITHUB_OAUTH_CLIENT_ID}&client_secret=${GITHUB_OAUTH_CLIENT_SECRET}"
-else
-  echo "🕶 Performing unauthenticated Github API calls. This might result in lower Github rate limits!"
-  GITHUB_OAUTH_PARAMS=""
-fi
-
-###
-# Calling Github to get the all branches
-###
-ORIGINAL_GITHUB_REPO="${SRC_ORG-netbox-community}/${SRC_REPO-netbox}"
-GITHUB_REPO="${GITHUB_REPO-$ORIGINAL_GITHUB_REPO}"
-URL_RELEASES="https://api.github.com/repos/${GITHUB_REPO}/branches?${GITHUB_OAUTH_PARAMS}"
-
-# Composing the JQ commans to extract the most recent version number
-JQ_BRANCHES='map(.name) | .[] | scan("^[^v].+") | match("^(master|develop).*") | .string'
-
-CURL="curl -sS"
-
-# Querying the Github API to fetch all branches
-BRANCHES=$($CURL "${URL_RELEASES}" | jq -r "$JQ_BRANCHES")
-
-###
-# Building each branch
-###
-
-# keeping track whether an error occured
-ERROR=0
-
-# calling build.sh for each branch
-for BRANCH in $BRANCHES; do
-  # shellcheck disable=SC2068
-  ./build.sh "${BRANCH}" $@ || ERROR=1
-done
-
-# returning whether an error occured
-exit $ERROR

build-functions/docker-functions.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+push_image_to_registry() {
+  local target_tag=$1
+  echo "⏫ Pushing '${target_tag}'"
+  $DRY docker push "${target_tag}"
+  echo "✅ Finished pushing the Docker image '${target_tag}'."
+}

build-functions/get-public-image-config.sh

@@ -0,0 +1,82 @@
+#!/bin/bash
+# Retrieves image configuration from public images in DockerHub
+# Functions from https://gist.github.com/cirocosta/17ea17be7ac11594cb0f290b0a3ac0d1
+# Optimised for our use case
+
+get_image_label() {
+  local label=$1
+  local image=$2
+  local tag=$3
+  local token
+  token=$(_get_token "$image")
+  local digest
+  digest=$(_get_digest "$image" "$tag" "$token")
+  local retval="null"
+  if [ "$digest" != "null" ]; then
+    retval=$(_get_image_configuration "$image" "$token" "$digest" "$label")
+  fi
+  echo "$retval"
+}
+
+get_image_layers() {
+  local image=$1
+  local tag=$2
+  local token
+  token=$(_get_token "$image")
+  _get_layers "$image" "$tag" "$token"
+}
+
+get_image_last_layer() {
+  local image=$1
+  local tag=$2
+  local token
+  token=$(_get_token "$image")
+  local layers
+  mapfile -t layers < <(_get_layers "$image" "$tag" "$token")
+  echo "${layers[-1]}"
+}
+
+_get_image_configuration() {
+  local image=$1
+  local token=$2
+  local digest=$3
+  local label=$4
+  curl \
+    --silent \
+    --location \
+    --header "Authorization: Bearer $token" \
+    "https://registry-1.docker.io/v2/$image/blobs/$digest" |
+    jq -r ".config.Labels.\"$label\""
+}
+
+_get_token() {
+  local image=$1
+  curl \
+    --silent \
+    "https://auth.docker.io/token?scope=repository:$image:pull&service=registry.docker.io" |
+    jq -r '.token'
+}
+
+_get_digest() {
+  local image=$1
+  local tag=$2
+  local token=$3
+  curl \
+    --silent \
+    --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
+    --header "Authorization: Bearer $token" \
+    "https://registry-1.docker.io/v2/$image/manifests/$tag" |
+    jq -r '.config.digest'
+}
+
+_get_layers() {
+  local image=$1
+  local tag=$2
+  local token=$3
+  curl \
+    --silent \
+    --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
+    --header "Authorization: Bearer $token" \
+    "https://registry-1.docker.io/v2/$image/manifests/$tag" |
+    jq -r '.layers[].digest'
+}

build-functions/gh-functions.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+###
+# A regular echo, that only prints if ${GH_ACTION} is defined.
+###
+gh_echo() {
+  if [ -n "${GH_ACTION}" ]; then
+    echo "${@}"
+  fi
+}
+
+###
+# Prints the output to the file defined in ${GITHUB_ENV}.
+# Only executes if ${GH_ACTION} is defined.
+# Example Usage: gh_env "FOO_VAR=bar_value"
+###
+gh_env() {
+  if [ -n "${GH_ACTION}" ]; then
+    echo "${@}" >>"${GITHUB_ENV}"
+  fi
+}

build-latest.sh

@@ -3,6 +3,14 @@
 
 echo "▶️ $0 $*"
 
+###
+# Check for the jq library needed for parsing JSON
+###
+if ! command -v jq; then
+  echo "⚠️  jq command missing from \$PATH!"
+  exit 1
+fi
+
 ###
 # Checking for the presence of GITHUB_OAUTH_CLIENT_ID
 # and GITHUB_OAUTH_CLIENT_SECRET
@@ -19,7 +27,7 @@ fi
 # Checking if PRERELEASE is either unset, 'true' or 'false'
 ###
 if [ -n "${PRERELEASE}" ] &&
-   { [ "${PRERELEASE}" != "true" ] && [ "${PRERELEASE}" != "false" ]; }; then
+  { [ "${PRERELEASE}" != "true" ] && [ "${PRERELEASE}" != "false" ]; }; then
 
   if [ -z "${DEBUG}" ]; then
     echo "⚠️ PRERELEASE must be either unset, 'true' or 'false', but was '${PRERELEASE}'!"
@@ -60,9 +68,10 @@ if [ "${PRERELEASE}" == "true" ]; then
   # shellcheck disable=SC2003
   MINOR_UNSTABLE=$(expr match "${VERSION}" 'v[0-9]\+\.\([0-9]\+\)')
 
-  if { [ "${MAJOR_STABLE}" -eq "${MAJOR_UNSTABLE}" ] \
+  if {
-       && [ "${MINOR_STABLE}" -ge "${MINOR_UNSTABLE}" ];
+    [ "${MAJOR_STABLE}" -eq "${MAJOR_UNSTABLE}" ] &&
-     } || [ "${MAJOR_STABLE}" -gt "${MAJOR_UNSTABLE}" ]; then
+      [ "${MINOR_STABLE}" -ge "${MINOR_UNSTABLE}" ]
+  } || [ "${MAJOR_STABLE}" -gt "${MAJOR_UNSTABLE}" ]; then
 
     echo "❎ Latest unstable version '${VERSION}' is not higher than the latest stable version '$STABLE_VERSION'."
     if [ -z "$DEBUG" ]; then

build.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Clones the Netbox repository with git from Github and builds the Dockerfile
+# Clones the NetBox repository with git from Github and builds the Dockerfile
 
 echo "▶️ $0 $*"
 
@@ -49,7 +49,7 @@ if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
   echo "  DOCKERFILE  The name of Dockerfile to use."
   echo "              Default: Dockerfile"
   echo "  DOCKER_FROM The base image to use."
-  echo "              Default: Whatever is defined as default in the Dockerfile."
+  echo "              Default: 'alpine:3.14'"
   echo "  DOCKER_TARGET A specific target to build."
   echo "              It's currently not possible to pass multiple targets."
   echo "              Default: main ldap"
@@ -95,6 +95,8 @@ if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
   fi
 fi
 
+source ./build-functions/gh-functions.sh
+
 ###
 # Enabling dry-run mode
 ###
@@ -105,8 +107,10 @@ else
   DRY="echo"
 fi
 
+gh_echo "::group::⤵️ Fetching the NetBox source code"
+
 ###
-# Variables for fetching the source
+# Variables for fetching the NetBox source
 ###
 SRC_ORG="${SRC_ORG-netbox-community}"
 SRC_REPO="${SRC_REPO-netbox}"
@@ -115,17 +119,23 @@ URL="${URL-https://github.com/${SRC_ORG}/${SRC_REPO}.git}"
 NETBOX_PATH="${NETBOX_PATH-.netbox}"
 
 ###
-# Fetching the source
+# Fetching the NetBox source
 ###
-if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ] ; then
+if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ]; then
-  echo "🌐 Checking out '${NETBOX_BRANCH}' of netbox from the url '${URL}' into '${NETBOX_PATH}'"
+  REMOTE_EXISTS=$(git ls-remote --heads --tags "${URL}" "${NETBOX_BRANCH}" | wc -l)
+  if [ "${REMOTE_EXISTS}" == "0" ]; then
+    echo "❌ Remote branch '${NETBOX_BRANCH}' not found in '${URL}'; Nothing to do"
+    gh_echo "::set-output name=skipped::true"
+    exit 0
+  fi
+  echo "🌐 Checking out '${NETBOX_BRANCH}' of NetBox from the url '${URL}' into '${NETBOX_PATH}'"
   if [ ! -d "${NETBOX_PATH}" ]; then
     $DRY git clone -q --depth 10 -b "${NETBOX_BRANCH}" "${URL}" "${NETBOX_PATH}"
   fi
 
   (
     $DRY cd "${NETBOX_PATH}"
-
+    # shellcheck disable=SC2030
     if [ -n "${HTTP_PROXY}" ]; then
       git config http.proxy "${HTTP_PROXY}"
     fi
@@ -135,9 +145,12 @@ if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ] ; then
     $DRY git checkout -qf FETCH_HEAD
     $DRY git prune
   )
-  echo "✅ Checked out netbox"
+  echo "✅ Checked out NetBox"
 fi
 
+gh_echo "::endgroup::"
+gh_echo "::group::🧮 Calculating Values"
+
 ###
 # Determining the value for DOCKERFILE
 # and checking whether it exists
@@ -153,6 +166,13 @@ if [ ! -f "${DOCKERFILE}" ]; then
   fi
 fi
 
+###
+# Determining the value for DOCKER_FROM
+###
+if [ -z "$DOCKER_FROM" ]; then
+  DOCKER_FROM="alpine:3.14"
+fi
+
 ###
 # Variables for labelling the docker image
 ###
@@ -167,9 +187,18 @@ PROJECT_VERSION="${PROJECT_VERSION-$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]
 
 # Get the Git information from the netbox directory
 if [ -d "${NETBOX_PATH}/.git" ]; then
-  NETBOX_GIT_REF=$(cd ${NETBOX_PATH}; git rev-parse HEAD)
+  NETBOX_GIT_REF=$(
-  NETBOX_GIT_BRANCH=$(cd ${NETBOX_PATH}; git rev-parse --abbrev-ref HEAD)
+    cd "${NETBOX_PATH}"
-  NETBOX_GIT_URL=$(cd ${NETBOX_PATH}; git remote get-url origin)
+    git rev-parse HEAD
+  )
+  NETBOX_GIT_BRANCH=$(
+    cd "${NETBOX_PATH}"
+    git rev-parse --abbrev-ref HEAD
+  )
+  NETBOX_GIT_URL=$(
+    cd "${NETBOX_PATH}"
+    git remote get-url origin
+  )
 fi
 
 ###
@@ -179,26 +208,32 @@ DOCKER_REGISTRY="${DOCKER_REGISTRY-docker.io}"
 DOCKER_ORG="${DOCKER_ORG-netboxcommunity}"
 DOCKER_REPO="${DOCKER_REPO-netbox}"
 case "${NETBOX_BRANCH}" in
-  master)
+master)
-    TAG="${TAG-latest}";;
+  TAG="${TAG-latest}"
-  develop)
+  ;;
-    TAG="${TAG-snapshot}";;
+develop)
-  *)
+  TAG="${TAG-snapshot}"
-    TAG="${TAG-$NETBOX_BRANCH}";;
+  ;;
+*)
+  TAG="${TAG-$NETBOX_BRANCH}"
+  ;;
 esac
 
 ###
 # Determine targets to build
 ###
 DEFAULT_DOCKER_TARGETS=("main" "ldap")
-DOCKER_TARGETS=( "${DOCKER_TARGET:-"${DEFAULT_DOCKER_TARGETS[@]}"}")
+DOCKER_TARGETS=("${DOCKER_TARGET:-"${DEFAULT_DOCKER_TARGETS[@]}"}")
 echo "🏭 Building the following targets:" "${DOCKER_TARGETS[@]}"
 
+gh_echo "::endgroup::"
+
 ###
 # Build each target
 ###
 export DOCKER_BUILDKIT=${DOCKER_BUILDKIT-1}
 for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
+  gh_echo "::group::🏗 Building the target '${DOCKER_TARGET}'"
   echo "🏗 Building the target '${DOCKER_TARGET}'"
 
   ###
@@ -208,31 +243,79 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
   if [ "${DOCKER_TARGET}" != "main" ]; then
     TARGET_DOCKER_TAG="${TARGET_DOCKER_TAG}-${DOCKER_TARGET}"
   fi
-  if [ -n "${GH_ACTION}" ]; then
+  TARGET_DOCKER_TAG_PROJECT="${TARGET_DOCKER_TAG}-${PROJECT_VERSION}"
-    echo "::set-env name=FINAL_DOCKER_TAG::${TARGET_DOCKER_TAG}"
+
-    echo "::set-output name=skipped::false"
+  gh_env "FINAL_DOCKER_TAG=${TARGET_DOCKER_TAG_PROJECT}"
-  fi
+  gh_echo "::set-output name=skipped::false"
 
   ###
   # composing the additional DOCKER_SHORT_TAG,
   # i.e. "v2.6.1" becomes "v2.6",
   # which is only relevant for version tags
+  # Also let "latest" follow the highest version
   ###
   if [[ "${TAG}" =~ ^v([0-9]+)\.([0-9]+)\.[0-9]+$ ]]; then
     MAJOR=${BASH_REMATCH[1]}
     MINOR=${BASH_REMATCH[2]}
 
     TARGET_DOCKER_SHORT_TAG="${DOCKER_SHORT_TAG-${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_REPO}:v${MAJOR}.${MINOR}}"
+    TARGET_DOCKER_LATEST_TAG="${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_REPO}:latest"
 
     if [ "${DOCKER_TARGET}" != "main" ]; then
       TARGET_DOCKER_SHORT_TAG="${TARGET_DOCKER_SHORT_TAG}-${DOCKER_TARGET}"
+      TARGET_DOCKER_LATEST_TAG="${TARGET_DOCKER_LATEST_TAG}-${DOCKER_TARGET}"
     fi
+
+    TARGET_DOCKER_SHORT_TAG_PROJECT="${TARGET_DOCKER_SHORT_TAG}-${PROJECT_VERSION}"
+    TARGET_DOCKER_LATEST_TAG_PROJECT="${TARGET_DOCKER_LATEST_TAG}-${PROJECT_VERSION}"
   fi
 
   ###
   # Proceeding to buils stage, except if `--push-only` is passed
   ###
-  if [ "${2}" != "--push-only" ] ; then
+  if [ "${2}" != "--push-only" ]; then
+    ###
+    # Checking if the build is necessary,
+    # meaning build only if one of those values changed:
+    # - Python base image digest (Label: PYTHON_BASE_DIGEST)
+    # - netbox git ref (Label: NETBOX_GIT_REF)
+    # - netbox-docker git ref (Label: org.label-schema.vcs-ref)
+    ###
+    # Load information from registry (only for docker.io)
+    SHOULD_BUILD="false"
+    BUILD_REASON=""
+    if [ -z "${GH_ACTION}" ]; then
+      # Asuming non Github builds should always proceed
+      SHOULD_BUILD="true"
+      BUILD_REASON="${BUILD_REASON} interactive"
+    elif [ "$DOCKER_REGISTRY" = "docker.io" ]; then
+      source ./build-functions/get-public-image-config.sh
+      IFS=':' read -ra DOCKER_FROM_SPLIT <<<"${DOCKER_FROM}"
+      if ! [[ ${DOCKER_FROM_SPLIT[0]} =~ .*/.* ]]; then
+        # Need to use "library/..." for images the have no two part name
+        DOCKER_FROM_SPLIT[0]="library/${DOCKER_FROM_SPLIT[0]}"
+      fi
+      PYTHON_LAST_LAYER=$(get_image_last_layer "${DOCKER_FROM_SPLIT[0]}" "${DOCKER_FROM_SPLIT[1]}")
+      mapfile -t IMAGES_LAYERS_OLD < <(get_image_layers "${DOCKER_ORG}"/"${DOCKER_REPO}" "${TAG}")
+      NETBOX_GIT_REF_OLD=$(get_image_label NETBOX_GIT_REF "${DOCKER_ORG}"/"${DOCKER_REPO}" "${TAG}")
+      GIT_REF_OLD=$(get_image_label org.label-schema.vcs-ref "${DOCKER_ORG}"/"${DOCKER_REPO}" "${TAG}")
+
+      if ! printf '%s\n' "${IMAGES_LAYERS_OLD[@]}" | grep -q -P "^${PYTHON_LAST_LAYER}\$"; then
+        SHOULD_BUILD="true"
+        BUILD_REASON="${BUILD_REASON} alpine"
+      fi
+      if [ "${NETBOX_GIT_REF}" != "${NETBOX_GIT_REF_OLD}" ]; then
+        SHOULD_BUILD="true"
+        BUILD_REASON="${BUILD_REASON} netbox"
+      fi
+      if [ "${GIT_REF}" != "${GIT_REF_OLD}" ]; then
+        SHOULD_BUILD="true"
+        BUILD_REASON="${BUILD_REASON} netbox-docker"
+      fi
+    else
+      SHOULD_BUILD="true"
+      BUILD_REASON="${BUILD_REASON} no-check"
+    fi
     ###
     # Composing all arguments for `docker build`
     ###
@@ -241,71 +324,89 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
       --target "${DOCKER_TARGET}"
       -f "${DOCKERFILE}"
       -t "${TARGET_DOCKER_TAG}"
+      -t "${TARGET_DOCKER_TAG_PROJECT}"
     )
     if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
-      DOCKER_BUILD_ARGS+=( -t "${TARGET_DOCKER_SHORT_TAG}" )
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_SHORT_TAG}")
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_SHORT_TAG_PROJECT}")
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_LATEST_TAG}")
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_LATEST_TAG_PROJECT}")
     fi
 
     # --label
-    if [ "${DOCKER_TARGET}" == "main" ]; then
+    DOCKER_BUILD_ARGS+=(
+      --label "ORIGINAL_TAG=${TARGET_DOCKER_TAG_PROJECT}"
+
+      --label "org.label-schema.build-date=${BUILD_DATE}"
+      --label "org.opencontainers.image.created=${BUILD_DATE}"
+
+      --label "org.label-schema.version=${PROJECT_VERSION}"
+      --label "org.opencontainers.image.version=${PROJECT_VERSION}"
+    )
+    if [ -d ".git" ]; then
       DOCKER_BUILD_ARGS+=(
-        --label "ORIGINAL_TAG=${TARGET_DOCKER_TAG}"
+        --label "org.label-schema.vcs-ref=${GIT_REF}"
-
+        --label "org.opencontainers.image.revision=${GIT_REF}"
-        --label "org.label-schema.build-date=${BUILD_DATE}"
-        --label "org.opencontainers.image.created=${BUILD_DATE}"
-
-        --label "org.label-schema.version=${PROJECT_VERSION}"
-        --label "org.opencontainers.image.version=${PROJECT_VERSION}"
       )
-      if [ -d ".git" ]; then
+    fi
-        DOCKER_BUILD_ARGS+=(
+    if [ -d "${NETBOX_PATH}/.git" ]; then
-          --label "org.label-schema.vcs-ref=${GIT_REF}"
+      DOCKER_BUILD_ARGS+=(
-          --label "org.opencontainers.image.revision=${GIT_REF}"
+        --label "NETBOX_GIT_BRANCH=${NETBOX_GIT_BRANCH}"
-        )
+        --label "NETBOX_GIT_REF=${NETBOX_GIT_REF}"
-      fi
+        --label "NETBOX_GIT_URL=${NETBOX_GIT_URL}"
-      if [ -d "${NETBOX_PATH}/.git" ]; then
+      )
-        DOCKER_BUILD_ARGS+=(
+    fi
-          --label "NETBOX_GIT_BRANCH=${NETBOX_GIT_BRANCH}"
+    if [ -n "${BUILD_REASON}" ]; then
-          --label "NETBOX_GIT_REF=${NETBOX_GIT_REF}"
+      BUILD_REASON=$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' <<<"$BUILD_REASON")
-          --label "NETBOX_GIT_URL=${NETBOX_GIT_URL}"
+      DOCKER_BUILD_ARGS+=(--label "BUILD_REASON=${BUILD_REASON}")
-        )
-      fi
     fi
 
     # --build-arg
-    DOCKER_BUILD_ARGS+=(   --build-arg "NETBOX_PATH=${NETBOX_PATH}" )
+    DOCKER_BUILD_ARGS+=(--build-arg "NETBOX_PATH=${NETBOX_PATH}")
 
     if [ -n "${DOCKER_FROM}" ]; then
-      DOCKER_BUILD_ARGS+=( --build-arg "FROM=${DOCKER_FROM}" )
+      DOCKER_BUILD_ARGS+=(--build-arg "FROM=${DOCKER_FROM}")
     fi
+    # shellcheck disable=SC2031
     if [ -n "${HTTP_PROXY}" ]; then
-      DOCKER_BUILD_ARGS+=( --build-arg "http_proxy=${HTTP_PROXY}" )
+      DOCKER_BUILD_ARGS+=(--build-arg "http_proxy=${HTTP_PROXY}")
-      DOCKER_BUILD_ARGS+=( --build-arg "https_proxy=${HTTPS_PROXY}" )
+      DOCKER_BUILD_ARGS+=(--build-arg "https_proxy=${HTTPS_PROXY}")
     fi
     if [ -n "${NO_PROXY}" ]; then
-      DOCKER_BUILD_ARGS+=( --build-arg "no_proxy=${NO_PROXY}" )
+      DOCKER_BUILD_ARGS+=(--build-arg "no_proxy=${NO_PROXY}")
     fi
 
     ###
     # Building the docker image
     ###
-    echo "🐳 Building the Docker image '${TARGET_DOCKER_TAG}'."
+    if [ "${SHOULD_BUILD}" == "true" ]; then
-    $DRY docker build "${DOCKER_BUILD_ARGS[@]}" .
+      echo "🐳 Building the Docker image '${TARGET_DOCKER_TAG_PROJECT}'."
-    echo "✅ Finished building the Docker images '${TARGET_DOCKER_TAG}'"
+      echo "    Build reason set to: ${BUILD_REASON}"
+      $DRY docker build "${DOCKER_BUILD_ARGS[@]}" .
+      echo "✅ Finished building the Docker images '${TARGET_DOCKER_TAG_PROJECT}'"
+      echo "🔎 Inspecting labels on '${TARGET_DOCKER_TAG_PROJECT}'"
+      $DRY docker inspect "${TARGET_DOCKER_TAG_PROJECT}" --format "{{json .Config.Labels}}"
+    else
+      echo "Build skipped because sources didn't change"
+      echo "::set-output name=skipped::true"
+    fi
   fi
 
   ###
   # Pushing the docker images if either `--push` or `--push-only` are passed
   ###
-  if [ "${2}" == "--push" ] || [ "${2}" == "--push-only" ] ; then
+  if [ "${2}" == "--push" ] || [ "${2}" == "--push-only" ]; then
-    echo "⏫ Pushing '${TARGET_DOCKER_TAG}"
+    source ./build-functions/docker-functions.sh
-    $DRY docker push "${TARGET_DOCKER_TAG}"
+    push_image_to_registry "${TARGET_DOCKER_TAG}"
-    echo "✅ Finished pushing the Docker image '${TARGET_DOCKER_TAG}'."
+    push_image_to_registry "${TARGET_DOCKER_TAG_PROJECT}"
 
     if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
-      echo "⏫ Pushing '${TARGET_DOCKER_SHORT_TAG}'"
+      push_image_to_registry "${TARGET_DOCKER_SHORT_TAG}"
-      $DRY docker push "${TARGET_DOCKER_SHORT_TAG}"
+      push_image_to_registry "${TARGET_DOCKER_SHORT_TAG_PROJECT}"
-      echo "✅ Finished pushing the Docker image '${TARGET_DOCKER_SHORT_TAG}'."
+      push_image_to_registry "${TARGET_DOCKER_LATEST_TAG}"
+      push_image_to_registry "${TARGET_DOCKER_LATEST_TAG_PROJECT}"
     fi
   fi
+
+  gh_echo "::endgroup::"
 done

configuration/configuration.py

@@ -1,21 +1,27 @@
-import os
+####
-import re
+## We recommend to not edit this file.
-import socket
+## Create separate files to overwrite the settings.
+## See `extra.py` as an example.
+####
 
-# For reference see http://netbox.readthedocs.io/en/latest/configuration/mandatory-settings/
+import re
-# Based on https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/configuration.example.py
+from os import environ
+from os.path import abspath, dirname, join
+
+# For reference see https://netbox.readthedocs.io/en/stable/configuration/
+# Based on https://github.com/netbox-community/netbox/blob/master/netbox/netbox/configuration.example.py
 
 # Read secret from file
-def read_secret(secret_name):
+def _read_secret(secret_name, default = None):
     try:
         f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8')
     except EnvironmentError:
-        return ''
+        return default
     else:
         with f:
             return f.readline().strip()
 
-BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+_BASE_DIR = dirname(dirname(abspath(__file__)))
 
 #########################
 #                       #
@@ -27,47 +33,53 @@ BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 # access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name.
 #
 # Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local']
-ALLOWED_HOSTS = os.environ.get('ALLOWED_HOSTS', '*').split(' ')
+ALLOWED_HOSTS = environ.get('ALLOWED_HOSTS', '*').split(' ')
 
-# PostgreSQL database configuration.
+# PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
+#   https://docs.djangoproject.com/en/stable/ref/settings/#databases
 DATABASE = {
-    'NAME': os.environ.get('DB_NAME', 'netbox'),         # Database name
+    'NAME': environ.get('DB_NAME', 'netbox'),       # Database name
-    'USER': os.environ.get('DB_USER', ''),               # PostgreSQL username
+    'USER': environ.get('DB_USER', ''),             # PostgreSQL username
-    'PASSWORD': os.environ.get('DB_PASSWORD', read_secret('db_password')),
+    'PASSWORD': _read_secret('db_password', environ.get('DB_PASSWORD', '')),
-                                                         # PostgreSQL password
+                                                    # PostgreSQL password
-    'HOST': os.environ.get('DB_HOST', 'localhost'),      # Database server
+    'HOST': environ.get('DB_HOST', 'localhost'),    # Database server
-    'PORT': os.environ.get('DB_PORT', ''),               # Database port (leave blank for default)
+    'PORT': environ.get('DB_PORT', ''),             # Database port (leave blank for default)
-    'OPTIONS': {'sslmode': os.environ.get('DB_SSLMODE', 'prefer')},
+    'OPTIONS': {'sslmode': environ.get('DB_SSLMODE', 'prefer')},
-                                                         # Database connection SSLMODE
+                                                    # Database connection SSLMODE
-    'CONN_MAX_AGE': int(os.environ.get('DB_CONN_MAX_AGE', '300')),
+    'CONN_MAX_AGE': int(environ.get('DB_CONN_MAX_AGE', '300')),
-                                                         # Database connection persistence
+                                                    # Max database connection age
+    'DISABLE_SERVER_SIDE_CURSORS': environ.get('DB_DISABLE_SERVER_SIDE_CURSORS', 'False').lower() == 'true',
+                                                    # Disable the use of server-side cursors transaction pooling
+}
+
+# Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate
+# configuration exists for each. Full connection details are required in both sections, and it is strongly recommended
+# to use two separate database IDs.
+REDIS = {
+    'tasks': {
+        'HOST': environ.get('REDIS_HOST', 'localhost'),
+        'PORT': int(environ.get('REDIS_PORT', 6379)),
+        'PASSWORD': _read_secret('redis_password', environ.get('REDIS_PASSWORD', '')),
+        'DATABASE': int(environ.get('REDIS_DATABASE', 0)),
+        'SSL': environ.get('REDIS_SSL', 'False').lower() == 'true',
+        'INSECURE_SKIP_TLS_VERIFY': environ.get('REDIS_INSECURE_SKIP_TLS_VERIFY', 'False').lower() == 'true',
+    },
+    'caching': {
+        'HOST': environ.get('REDIS_CACHE_HOST', environ.get('REDIS_HOST', 'localhost')),
+        'PORT': int(environ.get('REDIS_CACHE_PORT', environ.get('REDIS_PORT', 6379))),
+        'PASSWORD': _read_secret('redis_cache_password', environ.get('REDIS_CACHE_PASSWORD', environ.get('REDIS_PASSWORD', ''))),
+        'DATABASE': int(environ.get('REDIS_CACHE_DATABASE', 1)),
+        'SSL': environ.get('REDIS_CACHE_SSL', environ.get('REDIS_SSL', 'False')).lower() == 'true',
+        'INSECURE_SKIP_TLS_VERIFY': environ.get('REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY', environ.get('REDIS_INSECURE_SKIP_TLS_VERIFY', 'False')).lower() == 'true',
+    },
 }
 
 # This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file.
 # For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and
 # symbols. NetBox will not run without this defined. For more information, see
-# https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY
+# https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-SECRET_KEY
-SECRET_KEY = os.environ.get('SECRET_KEY', read_secret('secret_key'))
+SECRET_KEY = _read_secret('secret_key', environ.get('SECRET_KEY', ''))
 
-# Redis database settings. The Redis database is used for caching and background processing such as webhooks
-REDIS = {
-    'webhooks': {
-        'HOST': os.environ.get('REDIS_HOST', 'localhost'),
-        'PORT': int(os.environ.get('REDIS_PORT', 6379)),
-        'PASSWORD': os.environ.get('REDIS_PASSWORD', read_secret('redis_password')),
-        'DATABASE': int(os.environ.get('REDIS_DATABASE', 0)),
-        'DEFAULT_TIMEOUT': int(os.environ.get('REDIS_TIMEOUT', 300)),
-        'SSL': os.environ.get('REDIS_SSL', 'False').lower() == 'true',
-    },
-    'caching': {
-        'HOST': os.environ.get('REDIS_CACHE_HOST', os.environ.get('REDIS_HOST', 'localhost')),
-        'PORT': int(os.environ.get('REDIS_CACHE_PORT', os.environ.get('REDIS_PORT', 6379))),
-        'PASSWORD': os.environ.get('REDIS_CACHE_PASSWORD', os.environ.get('REDIS_PASSWORD', read_secret('redis_cache_password'))),
-        'DATABASE': int(os.environ.get('REDIS_CACHE_DATABASE', 1)),
-        'DEFAULT_TIMEOUT': int(os.environ.get('REDIS_CACHE_TIMEOUT', os.environ.get('REDIS_TIMEOUT', 300))),
-        'SSL': os.environ.get('REDIS_CACHE_SSL', os.environ.get('REDIS_SSL', 'False')).lower() == 'true',
-    },
-}
 
 #########################
 #                       #
@@ -81,111 +93,156 @@ ADMINS = [
     # ['John Doe', 'jdoe@example.com'],
 ]
 
+# URL schemes that are allowed within links in NetBox
+ALLOWED_URL_SCHEMES = (
+    'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
+)
+
 # Optionally display a persistent banner at the top and/or bottom of every page. HTML is allowed. To display the same
 # content in both banners, define BANNER_TOP and set BANNER_BOTTOM = BANNER_TOP.
-BANNER_TOP = os.environ.get('BANNER_TOP', '')
+BANNER_TOP = environ.get('BANNER_TOP', '')
-BANNER_BOTTOM = os.environ.get('BANNER_BOTTOM', '')
+BANNER_BOTTOM = environ.get('BANNER_BOTTOM', '')
 
 # Text to include on the login page above the login form. HTML is allowed.
-BANNER_LOGIN = os.environ.get('BANNER_LOGIN', '')
+BANNER_LOGIN = environ.get('BANNER_LOGIN', '')
 
 # Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
 # BASE_PATH = 'netbox/'
-BASE_PATH = os.environ.get('BASE_PATH', '')
+BASE_PATH = environ.get('BASE_PATH', '')
-
-# Cache timeout in seconds. Set to 0 to dissable caching. Defaults to 900 (15 minutes)
-CACHE_TIMEOUT = int(os.environ.get('CACHE_TIMEOUT', 900))
 
 # Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90)
-CHANGELOG_RETENTION = int(os.environ.get('CHANGELOG_RETENTION', 90))
+CHANGELOG_RETENTION = int(environ.get('CHANGELOG_RETENTION', 90))
 
 # API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be
 # allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or
 # CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers
-CORS_ORIGIN_ALLOW_ALL = os.environ.get('CORS_ORIGIN_ALLOW_ALL', 'False').lower() == 'true'
+CORS_ORIGIN_ALLOW_ALL = environ.get('CORS_ORIGIN_ALLOW_ALL', 'False').lower() == 'true'
-CORS_ORIGIN_WHITELIST = list(filter(None, os.environ.get('CORS_ORIGIN_WHITELIST', 'https://localhost').split(' ')))
+CORS_ORIGIN_WHITELIST = list(filter(None, environ.get('CORS_ORIGIN_WHITELIST', 'https://localhost').split(' ')))
-CORS_ORIGIN_REGEX_WHITELIST = [re.compile(r) for r in list(filter(None, os.environ.get('CORS_ORIGIN_REGEX_WHITELIST', '').split(' ')))]
+CORS_ORIGIN_REGEX_WHITELIST = [re.compile(r) for r in list(filter(None, environ.get('CORS_ORIGIN_REGEX_WHITELIST', '').split(' ')))]
 
 # Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal
 # sensitive information about your installation. Only enable debugging while performing testing. Never enable debugging
 # on a production system.
-DEBUG = os.environ.get('DEBUG', 'False').lower() == 'true'
+DEBUG = environ.get('DEBUG', 'False').lower() == 'true'
 
 # Email settings
 EMAIL = {
-    'SERVER': os.environ.get('EMAIL_SERVER', 'localhost'),
+    'SERVER': environ.get('EMAIL_SERVER', 'localhost'),
-    'PORT': int(os.environ.get('EMAIL_PORT', 25)),
+    'PORT': int(environ.get('EMAIL_PORT', 25)),
-    'USERNAME': os.environ.get('EMAIL_USERNAME', ''),
+    'USERNAME': environ.get('EMAIL_USERNAME', ''),
-    'PASSWORD': os.environ.get('EMAIL_PASSWORD', read_secret('email_password')),
+    'PASSWORD': _read_secret('email_password', environ.get('EMAIL_PASSWORD', '')),
-    'TIMEOUT': int(os.environ.get('EMAIL_TIMEOUT', 10)),  # seconds
+    'USE_SSL': environ.get('EMAIL_USE_SSL', 'False').lower() == 'true',
-    'FROM_EMAIL': os.environ.get('EMAIL_FROM', ''),
+    'USE_TLS': environ.get('EMAIL_USE_TLS', 'False').lower() == 'true',
+    'SSL_CERTFILE': environ.get('EMAIL_SSL_CERTFILE', ''),
+    'SSL_KEYFILE': environ.get('EMAIL_SSL_KEYFILE', ''),
+    'TIMEOUT': int(environ.get('EMAIL_TIMEOUT', 10)),  # seconds
+    'FROM_EMAIL': environ.get('EMAIL_FROM', ''),
 }
 
-# Enforcement of unique IP space can be toggled on a per-VRF basis.
+# Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table
-# To enforce unique IP space within the global table (all prefixes and IP addresses not assigned to a VRF),
+# (all prefixes and IP addresses not assigned to a VRF), set ENFORCE_GLOBAL_UNIQUE to True.
-# set ENFORCE_GLOBAL_UNIQUE to True.
+ENFORCE_GLOBAL_UNIQUE = environ.get('ENFORCE_GLOBAL_UNIQUE', 'False').lower() == 'true'
-ENFORCE_GLOBAL_UNIQUE = os.environ.get('ENFORCE_GLOBAL_UNIQUE', 'False').lower() == 'true'
 
 # Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and
 # by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models.
-EXEMPT_VIEW_PERMISSIONS = list(filter(None, os.environ.get('EXEMPT_VIEW_PERMISSIONS', '').split(' ')))
+EXEMPT_VIEW_PERMISSIONS = list(filter(None, environ.get('EXEMPT_VIEW_PERMISSIONS', '').split(' ')))
+
+# Enable GraphQL API.
+GRAPHQL_ENABLED = environ.get('GRAPHQL_ENABLED', 'True').lower() == 'true'
 
 # Enable custom logging. Please see the Django documentation for detailed guidance on configuring custom logs:
-#   https://docs.djangoproject.com/en/1.11/topics/logging/
+#   https://docs.djangoproject.com/en/stable/topics/logging/
 LOGGING = {}
 
 # Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users
 # are permitted to access most data in NetBox (excluding secrets) but not make any changes.
-LOGIN_REQUIRED = os.environ.get('LOGIN_REQUIRED', 'False').lower() == 'true'
+LOGIN_REQUIRED = environ.get('LOGIN_REQUIRED', 'False').lower() == 'true'
+
+# The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to
+# re-authenticate. (Default: 1209600 [14 days])
+LOGIN_TIMEOUT = int(environ.get('LOGIN_TIMEOUT', 1209600))
 
 # Setting this to True will display a "maintenance mode" banner at the top of every page.
-MAINTENANCE_MODE = os.environ.get('MAINTENANCE_MODE', 'False').lower() == 'true'
+MAINTENANCE_MODE = environ.get('MAINTENANCE_MODE', 'False').lower() == 'true'
 
 # An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g.
 # "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request
 # all objects by specifying "?limit=0".
-MAX_PAGE_SIZE = int(os.environ.get('MAX_PAGE_SIZE', 1000))
+MAX_PAGE_SIZE = int(environ.get('MAX_PAGE_SIZE', 1000))
 
 # The file path where uploaded media such as image attachments are stored. A trailing slash is not needed. Note that
 # the default value of this setting is derived from the installed location.
-MEDIA_ROOT = os.environ.get('MEDIA_ROOT', os.path.join(BASE_DIR, 'media'))
+MEDIA_ROOT = environ.get('MEDIA_ROOT', join(_BASE_DIR, 'media'))
 
 # Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics'
-METRICS_ENABLED = os.environ.get('METRICS_ENABLED', 'False').lower() == 'true'
+METRICS_ENABLED = environ.get('METRICS_ENABLED', 'False').lower() == 'true'
 
-# Credentials that NetBox will use to access live devices.
+# Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM.
-NAPALM_USERNAME = os.environ.get('NAPALM_USERNAME', '')
+NAPALM_USERNAME = environ.get('NAPALM_USERNAME', '')
-NAPALM_PASSWORD = os.environ.get('NAPALM_PASSWORD', read_secret('napalm_password'))
+NAPALM_PASSWORD = _read_secret('napalm_password', environ.get('NAPALM_PASSWORD', ''))
 
 # NAPALM timeout (in seconds). (Default: 30)
-NAPALM_TIMEOUT = int(os.environ.get('NAPALM_TIMEOUT', 30))
+NAPALM_TIMEOUT = int(environ.get('NAPALM_TIMEOUT', 30))
 
 # NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
 # be provided as a dictionary.
 NAPALM_ARGS = {}
 
 # Determine how many objects to display per page within a list. (Default: 50)
-PAGINATE_COUNT = int(os.environ.get('PAGINATE_COUNT', 50))
+PAGINATE_COUNT = int(environ.get('PAGINATE_COUNT', 50))
+
+# Enable installed plugins. Add the name of each plugin to the list.
+PLUGINS = []
+
+# Plugins configuration settings. These settings are used by various plugins that the user may have installed.
+# Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
+PLUGINS_CONFIG = {
+}
 
 # When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to
 # prefer IPv4 instead.
-PREFER_IPV4 = os.environ.get('PREFER_IPV4', 'False').lower() == 'true'
+PREFER_IPV4 = environ.get('PREFER_IPV4', 'False').lower() == 'true'
+
+# Rack elevation size defaults, in pixels. For best results, the ratio of width to height should be roughly 10:1.
+RACK_ELEVATION_DEFAULT_UNIT_HEIGHT = int(environ.get('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', 22))
+RACK_ELEVATION_DEFAULT_UNIT_WIDTH = int(environ.get('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', 220))
+
+# Remote authentication support
+REMOTE_AUTH_ENABLED = environ.get('REMOTE_AUTH_ENABLED', 'False').lower() == 'true'
+REMOTE_AUTH_BACKEND = environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend')
+REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
+REMOTE_AUTH_AUTO_CREATE_USER = environ.get('REMOTE_AUTH_AUTO_CREATE_USER', 'True').lower() == 'true'
+REMOTE_AUTH_DEFAULT_GROUPS = list(filter(None, environ.get('REMOTE_AUTH_DEFAULT_GROUPS', '').split(' ')))
+
+# This repository is used to check whether there is a new release of NetBox available. Set to None to disable the
+# version check or use the URL below to check for release in the official NetBox repository.
+# https://api.github.com/repos/netbox-community/netbox/releases
+RELEASE_CHECK_URL = environ.get('RELEASE_CHECK_URL', None)
+
 # The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of
 # this setting is derived from the installed location.
-REPORTS_ROOT = os.environ.get('REPORTS_ROOT', '/etc/netbox/reports')
+REPORTS_ROOT = environ.get('REPORTS_ROOT', '/etc/netbox/reports')
+
+# Maximum execution time for background tasks, in seconds.
+RQ_DEFAULT_TIMEOUT = int(environ.get('RQ_DEFAULT_TIMEOUT', 300))
 
 # The file path where custom scripts will be stored. A trailing slash is not needed. Note that the default value of
 # this setting is derived from the installed location.
-SCRIPTS_ROOT = os.environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts')
+SCRIPTS_ROOT = environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts')
+
+# By default, NetBox will store session data in the database. Alternatively, a file path can be specified here to use
+# local file storage instead. (This can be useful for enabling authentication on a standby instance with read-only
+# database access.) Note that the user as which NetBox runs must have read and write permissions to this path.
+SESSION_FILE_PATH = environ.get('SESSIONS_ROOT', None)
 
 # Time zone (default: UTC)
-TIME_ZONE = os.environ.get('TIME_ZONE', 'UTC')
+TIME_ZONE = environ.get('TIME_ZONE', 'UTC')
 
 # Date/time formatting. See the following link for supported formats:
-# https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date
+# https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date
-DATE_FORMAT = os.environ.get('DATE_FORMAT', 'N j, Y')
+DATE_FORMAT = environ.get('DATE_FORMAT', 'N j, Y')
-SHORT_DATE_FORMAT = os.environ.get('SHORT_DATE_FORMAT', 'Y-m-d')
+SHORT_DATE_FORMAT = environ.get('SHORT_DATE_FORMAT', 'Y-m-d')
-TIME_FORMAT = os.environ.get('TIME_FORMAT', 'g:i a')
+TIME_FORMAT = environ.get('TIME_FORMAT', 'g:i a')
-SHORT_TIME_FORMAT = os.environ.get('SHORT_TIME_FORMAT', 'H:i:s')
+SHORT_TIME_FORMAT = environ.get('SHORT_TIME_FORMAT', 'H:i:s')
-DATETIME_FORMAT = os.environ.get('DATETIME_FORMAT', 'N j, Y g:i a')
+DATETIME_FORMAT = environ.get('DATETIME_FORMAT', 'N j, Y g:i a')
-SHORT_DATETIME_FORMAT = os.environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i')
+SHORT_DATETIME_FORMAT = environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i')

configuration/extra.py

@@ -0,0 +1,55 @@
+####
+## This file contains extra configuration options that can't be configured
+## directly through environment variables.
+####
+
+## Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of
+## application errors (assuming correct email settings are provided).
+# ADMINS = [
+#     # ['John Doe', 'jdoe@example.com'],
+# ]
+
+
+## URL schemes that are allowed within links in NetBox
+# ALLOWED_URL_SCHEMES = (
+#     'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
+# )
+
+
+## NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
+## be provided as a dictionary.
+# NAPALM_ARGS = {}
+
+
+## Enable installed plugins. Add the name of each plugin to the list.
+# from netbox.configuration.configuration import PLUGINS
+# PLUGINS.append('my_plugin')
+
+## Plugins configuration settings. These settings are used by various plugins that the user may have installed.
+## Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
+# from netbox.configuration.configuration import PLUGINS_CONFIG
+# PLUGINS_CONFIG['my_plugin'] = {
+#   'foo': 'bar',
+#   'buzz': 'bazz'
+# }
+
+
+## Remote authentication support
+# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
+
+
+## By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the
+## class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example:
+# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage'
+# STORAGE_CONFIG = {
+#     'AWS_ACCESS_KEY_ID': 'Key ID',
+#     'AWS_SECRET_ACCESS_KEY': 'Secret',
+#     'AWS_STORAGE_BUCKET_NAME': 'netbox',
+#     'AWS_S3_REGION_NAME': 'eu-west-1',
+# }
+
+
+## This file can contain arbitrary Python code, e.g.:
+# from datetime import datetime
+# now = datetime.now().strftime("%d/%m/%Y %H:%M:%S")
+# BANNER_TOP = f'<marquee width="200px">This instance started on {now}.</marquee>'

configuration/gunicorn_config.py

@@ -1,8 +0,0 @@
-command = '/usr/bin/gunicorn'
-pythonpath = '/opt/netbox/netbox'
-bind = '0.0.0.0:8001'
-workers = 3
-errorlog = '-'
-accesslog = '-'
-capture_output = False
-loglevel = 'debug'

configuration/ldap/extra.py

@@ -0,0 +1,28 @@
+####
+## This file contains extra configuration options that can't be configured
+## directly through environment variables.
+## All vairables set here overwrite any existing found in ldap_config.py
+####
+
+# # This Python script inherits all the imports from ldap_config.py
+# from django_auth_ldap.config import LDAPGroupQuery # Imported since not in ldap_config.py
+
+# # Sets a base requirement of membetship to netbox-user-ro, netbox-user-rw, or netbox-user-admin.
+# AUTH_LDAP_REQUIRE_GROUP = (
+#     LDAPGroupQuery("cn=netbox-user-ro,ou=groups,dc=example,dc=com")
+#     | LDAPGroupQuery("cn=netbox-user-rw,ou=groups,dc=example,dc=com")
+#     | LDAPGroupQuery("cn=netbox-user-admin,ou=groups,dc=example,dc=com")
+# )
+
+# # Sets LDAP Flag groups variables with example.
+# AUTH_LDAP_USER_FLAGS_BY_GROUP = {
+#     "is_staff": (
+#         LDAPGroupQuery("cn=netbox-user-ro,ou=groups,dc=example,dc=com")
+#         | LDAPGroupQuery("cn=netbox-user-rw,ou=groups,dc=example,dc=com")
+#         | LDAPGroupQuery("cn=netbox-user-admin,ou=groups,dc=example,dc=com")
+#     ),
+#     "is_superuser": "cn=netbox-user-admin,ou=groups,dc=example,dc=com",
+# }
+
+# # Sets LDAP Mirror groups variables with example groups
+# AUTH_LDAP_MIRROR_GROUPS = ["netbox-user-ro", "netbox-user-rw", "netbox-user-admin"]

configuration/ldap/ldap_config.py

@@ -0,0 +1,90 @@
+from importlib import import_module
+from os import environ
+
+import ldap
+from django_auth_ldap.config import LDAPSearch
+
+
+# Read secret from file
+def _read_secret(secret_name, default=None):
+    try:
+        f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8')
+    except EnvironmentError:
+        return default
+    else:
+        with f:
+            return f.readline().strip()
+
+# Import and return the group type based on string name
+def _import_group_type(group_type_name):
+    mod = import_module('django_auth_ldap.config')
+    try:
+        return getattr(mod, group_type_name)()
+    except:
+        return None
+
+# Server URI
+AUTH_LDAP_SERVER_URI = environ.get('AUTH_LDAP_SERVER_URI', '')
+
+# The following may be needed if you are binding to Active Directory.
+AUTH_LDAP_CONNECTION_OPTIONS = {
+    ldap.OPT_REFERRALS: 0
+}
+
+# Set the DN and password for the NetBox service account.
+AUTH_LDAP_BIND_DN = environ.get('AUTH_LDAP_BIND_DN', '')
+AUTH_LDAP_BIND_PASSWORD = _read_secret('auth_ldap_bind_password', environ.get('AUTH_LDAP_BIND_PASSWORD', ''))
+
+# Set a string template that describes any user’s distinguished name based on the username.
+AUTH_LDAP_USER_DN_TEMPLATE = environ.get('AUTH_LDAP_USER_DN_TEMPLATE', None)
+
+# Enable STARTTLS for ldap authentication.
+AUTH_LDAP_START_TLS = environ.get('AUTH_LDAP_START_TLS', 'False').lower() == 'true'
+
+# Include this setting if you want to ignore certificate errors. This might be needed to accept a self-signed cert.
+# Note that this is a NetBox-specific setting which sets:
+#     ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
+LDAP_IGNORE_CERT_ERRORS = environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true'
+
+AUTH_LDAP_USER_SEARCH_BASEDN = environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '')
+AUTH_LDAP_USER_SEARCH_ATTR = environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName')
+AUTH_LDAP_USER_SEARCH = LDAPSearch(
+    AUTH_LDAP_USER_SEARCH_BASEDN,
+    ldap.SCOPE_SUBTREE,
+    "(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)"
+)
+
+# This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
+# heirarchy.
+AUTH_LDAP_GROUP_SEARCH_BASEDN = environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '')
+AUTH_LDAP_GROUP_SEARCH_CLASS = environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group')
+AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_SEARCH_BASEDN, ldap.SCOPE_SUBTREE,
+                                    "(objectClass=" + AUTH_LDAP_GROUP_SEARCH_CLASS + ")")
+AUTH_LDAP_GROUP_TYPE = _import_group_type(environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType'))
+
+# Define a group required to login.
+AUTH_LDAP_REQUIRE_GROUP = environ.get('AUTH_LDAP_REQUIRE_GROUP_DN')
+
+# Define special user types using groups. Exercise great caution when assigning superuser status.
+AUTH_LDAP_USER_FLAGS_BY_GROUP = {}
+
+if AUTH_LDAP_REQUIRE_GROUP is not None:
+    AUTH_LDAP_USER_FLAGS_BY_GROUP = {
+        "is_active": environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', ''),
+        "is_staff": environ.get('AUTH_LDAP_IS_ADMIN_DN', ''),
+        "is_superuser": environ.get('AUTH_LDAP_IS_SUPERUSER_DN', '')
+    }
+
+# For more granular permissions, we can map LDAP groups to Django groups.
+AUTH_LDAP_FIND_GROUP_PERMS = environ.get('AUTH_LDAP_FIND_GROUP_PERMS', 'True').lower() == 'true'
+AUTH_LDAP_MIRROR_GROUPS = environ.get('AUTH_LDAP_MIRROR_GROUPS', '').lower() == 'true'
+
+# Cache groups for one hour to reduce LDAP traffic
+AUTH_LDAP_CACHE_TIMEOUT = int(environ.get('AUTH_LDAP_CACHE_TIMEOUT', 3600))
+
+# Populate the Django user from the LDAP directory.
+AUTH_LDAP_USER_ATTR_MAP = {
+    "first_name": environ.get('AUTH_LDAP_ATTR_FIRSTNAME', 'givenName'),
+    "last_name": environ.get('AUTH_LDAP_ATTR_LASTNAME', 'sn'),
+    "email": environ.get('AUTH_LDAP_ATTR_MAIL', 'mail')
+}

configuration/ldap_config.py

@@ -1,81 +0,0 @@
-import ldap
-import os
-
-from django_auth_ldap.config import LDAPSearch
-from importlib import import_module
-
-# Read secret from file
-def read_secret(secret_name):
-    try:
-        f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8')
-    except EnvironmentError:
-        return ''
-    else:
-        with f:
-            return f.readline().strip()
-
-# Import and return the group type based on string name
-def import_group_type(group_type_name):
-    mod = import_module('django_auth_ldap.config')
-    try:
-        return getattr(mod, group_type_name)()
-    except:
-        return None
-
-# Server URI
-AUTH_LDAP_SERVER_URI = os.environ.get('AUTH_LDAP_SERVER_URI', '')
-
-# The following may be needed if you are binding to Active Directory.
-AUTH_LDAP_CONNECTION_OPTIONS = {
-    ldap.OPT_REFERRALS: 0
-}
-
-# Set the DN and password for the NetBox service account.
-AUTH_LDAP_BIND_DN = os.environ.get('AUTH_LDAP_BIND_DN', '')
-AUTH_LDAP_BIND_PASSWORD = os.environ.get('AUTH_LDAP_BIND_PASSWORD', read_secret('auth_ldap_bind_password'))
-
-# Set a string template that describes any user’s distinguished name based on the username.
-AUTH_LDAP_USER_DN_TEMPLATE = os.environ.get('AUTH_LDAP_USER_DN_TEMPLATE', None)
-
-# Include this setting if you want to ignore certificate errors. This might be needed to accept a self-signed cert.
-# Note that this is a NetBox-specific setting which sets:
-#     ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
-LDAP_IGNORE_CERT_ERRORS = os.environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true'
-
-AUTH_LDAP_USER_SEARCH_BASEDN = os.environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '')
-AUTH_LDAP_USER_SEARCH_ATTR = os.environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName')
-AUTH_LDAP_USER_SEARCH = LDAPSearch(AUTH_LDAP_USER_SEARCH_BASEDN,
-                                   ldap.SCOPE_SUBTREE,
-                                   "(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)")
-
-# This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
-# heirarchy.
-AUTH_LDAP_GROUP_SEARCH_BASEDN = os.environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '')
-AUTH_LDAP_GROUP_SEARCH_CLASS = os.environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group')
-AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_SEARCH_BASEDN, ldap.SCOPE_SUBTREE,
-                                    "(objectClass=" + AUTH_LDAP_GROUP_SEARCH_CLASS + ")")
-AUTH_LDAP_GROUP_TYPE = import_group_type(os.environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType'))
-
-# Define a group required to login.
-AUTH_LDAP_REQUIRE_GROUP = os.environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', '')
-
-# Define special user types using groups. Exercise great caution when assigning superuser status.
-AUTH_LDAP_USER_FLAGS_BY_GROUP = {
-    "is_active": os.environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', ''),
-    "is_staff": os.environ.get('AUTH_LDAP_IS_ADMIN_DN', ''),
-    "is_superuser": os.environ.get('AUTH_LDAP_IS_SUPERUSER_DN', '')
-}
-
-# For more granular permissions, we can map LDAP groups to Django groups.
-AUTH_LDAP_FIND_GROUP_PERMS = os.environ.get('AUTH_LDAP_FIND_GROUP_PERMS', 'True').lower() == 'true'
-
-# Cache groups for one hour to reduce LDAP traffic
-AUTH_LDAP_CACHE_GROUPS = os.environ.get('AUTH_LDAP_CACHE_GROUPS', 'True').lower() == 'true'
-AUTH_LDAP_GROUP_CACHE_TIMEOUT = int(os.environ.get('AUTH_LDAP_GROUP_CACHE_TIMEOUT', 3600))
-
-# Populate the Django user from the LDAP directory.
-AUTH_LDAP_USER_ATTR_MAP = {
-    "first_name": os.environ.get('AUTH_LDAP_ATTR_FIRSTNAME', 'givenName'),
-    "last_name": os.environ.get('AUTH_LDAP_ATTR_LASTNAME', 'sn'),
-    "email": os.environ.get('AUTH_LDAP_ATTR_MAIL', 'mail')
-}

configuration/logging.py

@@ -0,0 +1,55 @@
+# # Remove first comment(#) on each line to implement this working logging example.
+# # Add LOGLEVEL environment variable to netbox if you use this example & want a different log level.
+# from os import environ
+
+# # Set LOGLEVEL in netbox.env or docker-compose.overide.yml to override a logging level of INFO.
+# LOGLEVEL = environ.get('LOGLEVEL', 'INFO')
+
+# LOGGING = {
+
+#    'version': 1,
+#    'disable_existing_loggers': False,
+#    'formatters': {
+#        'verbose': {
+#            'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
+#            'style': '{',
+#        },
+#        'simple': {
+#            'format': '{levelname} {message}',
+#            'style': '{',
+#        },
+#    },
+#    'filters': {
+#        'require_debug_false': {
+#            '()': 'django.utils.log.RequireDebugFalse',
+#        },
+#    },
+#    'handlers': {
+#        'console': {
+#            'level': LOGLEVEL,
+#            'filters': ['require_debug_false'],
+#            'class': 'logging.StreamHandler',
+#            'formatter': 'simple'
+#        },
+#        'mail_admins': {
+#            'level': 'ERROR',
+#            'class': 'django.utils.log.AdminEmailHandler',
+#            'filters': ['require_debug_false']
+#        }
+#    },
+#    'loggers': {
+#        'django': {
+#            'handlers': ['console'],
+#            'propagate': True,
+#        },
+#        'django.request': {
+#            'handlers': ['mail_admins'],
+#            'level': 'ERROR',
+#            'propagate': False,
+#        },
+#        'django_auth_ldap': {
+#            'handlers': ['console',],
+#            'level': LOGLEVEL,
+#        }
+#    }
+# }

configuration/plugins.py

@@ -0,0 +1,13 @@
+# Add your plugins and plugin settings here.
+# Of course uncomment this file out.
+
+# To learn how to build images with your required plugins
+# See https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins
+
+# PLUGINS = ["netbox_bgp"]
+
+# PLUGINS_CONFIG = {
+#   "netbox_bgp": {
+#     ADD YOUR SETTINGS HERE
+#   }
+# }

docker-compose.override.yml.example

@@ -0,0 +1,5 @@
+version: '3.4'
+services:
+  netbox:
+    ports:
+      - 8000:8080

docker-compose.test.yml

@@ -5,41 +5,35 @@ services:
     depends_on:
     - postgres
     - redis
+    - redis-cache
     env_file: env/netbox.env
-    user: '101'
+    environment:
+      SKIP_STARTUP_SCRIPTS: ${SKIP_STARTUP_SCRIPTS-false}
+    user: 'unit:root'
     volumes:
     - ./startup_scripts:/opt/netbox/startup_scripts:z,ro
     - ./${INITIALIZERS_DIR-initializers}:/opt/netbox/initializers:z,ro
     - ./configuration:/etc/netbox/config:z,ro
     - ./reports:/etc/netbox/reports:z,ro
     - ./scripts:/etc/netbox/scripts:z,ro
-    - netbox-nginx-config:/etc/netbox-nginx:z
-    - netbox-static-files:/opt/netbox/netbox/static:z
     - netbox-media-files:/opt/netbox/netbox/media:z
-  nginx:
-    command: nginx -c /etc/netbox-nginx/nginx.conf
-    image: nginx:1.17-alpine
-    depends_on:
-    - netbox
-    ports:
-    - 8080
-    volumes:
-    - netbox-static-files:/opt/netbox/netbox/static:ro
-    - netbox-nginx-config:/etc/netbox-nginx/:ro
   postgres:
-    image: postgres:11-alpine
+    image: postgres:14-alpine
     env_file: env/postgres.env
   redis:
-    image: redis:5-alpine
+    image: redis:6-alpine
+    command:
+    - sh
+    - -c # this is to evaluate the $REDIS_PASSWORD from the env
+    - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    env_file: env/redis.env
+  redis-cache:
+    image: redis:6-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
     - redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
-    env_file: env/redis.env
+    env_file: env/redis-cache.env
 volumes:
-  netbox-static-files:
-    driver: local
-  netbox-nginx-config:
-    driver: local
   netbox-media-files:
     driver: local

docker-compose.yml

@@ -1,49 +1,48 @@
 version: '3.4'
 services:
   netbox: &netbox
-    image: netboxcommunity/netbox:${VERSION-latest}
+    image: netboxcommunity/netbox:${VERSION-v3.1-1.6.0}
     depends_on:
     - postgres
     - redis
     - redis-cache
     - netbox-worker
     env_file: env/netbox.env
-    user: '101'
+    user: 'unit:root'
     volumes:
     - ./startup_scripts:/opt/netbox/startup_scripts:z,ro
     - ./initializers:/opt/netbox/initializers:z,ro
     - ./configuration:/etc/netbox/config:z,ro
     - ./reports:/etc/netbox/reports:z,ro
     - ./scripts:/etc/netbox/scripts:z,ro
-    - netbox-nginx-config:/etc/netbox-nginx:z
-    - netbox-static-files:/opt/netbox/netbox/static:z
     - netbox-media-files:/opt/netbox/netbox/media:z
   netbox-worker:
     <<: *netbox
     depends_on:
     - redis
-    entrypoint:
+    - postgres
-    - python3
-    - /opt/netbox/netbox/manage.py
     command:
+    - /opt/netbox/venv/bin/python
+    - /opt/netbox/netbox/manage.py
     - rqworker
-  nginx:
+  netbox-housekeeping:
-    command: nginx -c /etc/netbox-nginx/nginx.conf
+    <<: *netbox
-    image: nginx:1.17-alpine
     depends_on:
-    - netbox
+    - redis
-    ports:
+    - postgres
-    - 8080
+    command:
-    volumes:
+    - /opt/netbox/housekeeping.sh
-    - netbox-static-files:/opt/netbox/netbox/static:ro
+
-    - netbox-nginx-config:/etc/netbox-nginx/:ro
+  # postgres
   postgres:
-    image: postgres:11-alpine
+    image: postgres:14-alpine
     env_file: env/postgres.env
     volumes:
     - netbox-postgres-data:/var/lib/postgresql/data
+
+  # redis
   redis:
-    image: redis:5-alpine
+    image: redis:6-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
@@ -52,17 +51,14 @@ services:
     volumes:
     - netbox-redis-data:/data
   redis-cache:
-    image: redis:5-alpine
+    image: redis:6-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
     - redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
-    env_file: env/redis.env
+    env_file: env/redis-cache.env
+
 volumes:
-  netbox-static-files:
-    driver: local
-  netbox-nginx-config:
-    driver: local
   netbox-media-files:
     driver: local
   netbox-postgres-data:

docker/configuration.docker.py

@@ -1,10 +1,91 @@
+## Generic Parts
+# These functions are providing the functionality to load
+# arbitrary configuration files.
+#
+# They can be imported by other code (see `ldap_config.py` for an example).
+
 import importlib.util
 import sys
+from os import scandir
+from os.path import abspath, isfile
 
-try:
+
-  spec = importlib.util.spec_from_file_location('configuration', '/etc/netbox/config/configuration.py')
+def _filename(f):
-  module = importlib.util.module_from_spec(spec)
+    return f.name
-  spec.loader.exec_module(module)
+
-  sys.modules['netbox.configuration'] = module
+
-except:
+def _import(module_name, path, loaded_configurations):
-  raise ImportError('')
+    spec = importlib.util.spec_from_file_location("", path)
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    sys.modules[module_name] = module
+
+    loaded_configurations.insert(0, module)
+
+    print(f"🧬 loaded config '{path}'")
+
+
+def read_configurations(config_module, config_dir, main_config):
+    loaded_configurations = []
+
+    main_config_path = abspath(f"{config_dir}/{main_config}.py")
+    if isfile(main_config_path):
+        _import(f"{config_module}.{main_config}", main_config_path, loaded_configurations)
+    else:
+        print(f"⚠️ Main configuration '{main_config_path}' not found.")
+
+    with scandir(config_dir) as it:
+        for f in sorted(it, key=_filename):
+            if not f.is_file():
+                continue
+
+            if f.name.startswith("__"):
+                continue
+
+            if not f.name.endswith(".py"):
+                continue
+
+            if f.name == f"{main_config}.py":
+                continue
+
+            if f.name == f"{config_dir}.py":
+                continue
+
+            module_name = f"{config_module}.{f.name[:-len('.py')]}".replace(".", "_")
+            _import(module_name, f.path, loaded_configurations)
+
+    if len(loaded_configurations) == 0:
+        print(f"‼️ No configuration files found in '{config_dir}'.")
+        raise ImportError(f"No configuration files found in '{config_dir}'.")
+
+    return loaded_configurations
+
+
+## Specific Parts
+# This section's code actually loads the various configuration files
+# into the module with the given name.
+# It contains the logic to resolve arbitrary configuration options by
+# levaraging dynamic programming using `__getattr__`.
+
+
+_loaded_configurations = read_configurations(
+    config_dir="/etc/netbox/config/",
+    config_module="netbox.configuration",
+    main_config="configuration",
+)
+
+
+def __getattr__(name):
+    for config in _loaded_configurations:
+        try:
+            return getattr(config, name)
+        except:
+            pass
+    raise AttributeError
+
+
+def __dir__():
+    names = []
+    for config in _loaded_configurations:
+        names.extend(config.__dir__())
+    return names

docker/docker-entrypoint.sh

@@ -1,25 +1,52 @@
 #!/bin/bash
-# Runs on every start of the Netbox Docker container
+# Runs on every start of the NetBox Docker container
 
 # Stop when an error occures
 set -e
 
-# Allows Netbox to be run as non-root users
+# Allows NetBox to be run as non-root users
 umask 002
 
+# Load correct Python3 env
+# shellcheck disable=SC1091
+source /opt/netbox/venv/bin/activate
+
 # Try to connect to the DB
 DB_WAIT_TIMEOUT=${DB_WAIT_TIMEOUT-3}
 MAX_DB_WAIT_TIME=${MAX_DB_WAIT_TIME-30}
 CUR_DB_WAIT_TIME=0
-while ! ./manage.py migrate 2>&1 && [ "${CUR_DB_WAIT_TIME}" -lt "${MAX_DB_WAIT_TIME}" ]; do
+while [ "${CUR_DB_WAIT_TIME}" -lt "${MAX_DB_WAIT_TIME}" ]; do
+  # Read and truncate connection error tracebacks to last line by default
+  exec {psfd}< <(./manage.py showmigrations 2>&1)
+  read -rd '' DB_ERR <&$psfd || :
+  exec {psfd}<&-
+  wait $! && break
+  if [ -n "$DB_WAIT_DEBUG" ]; then
+    echo "$DB_ERR"
+  else
+    readarray -tn 0 DB_ERR_LINES <<<"$DB_ERR"
+    echo "${DB_ERR_LINES[@]: -1}"
+    echo "[ Use DB_WAIT_DEBUG=1 in netbox.env to print full traceback for errors here ]"
+  fi
   echo "⏳ Waiting on DB... (${CUR_DB_WAIT_TIME}s / ${MAX_DB_WAIT_TIME}s)"
   sleep "${DB_WAIT_TIMEOUT}"
-  CUR_DB_WAIT_TIME=$(( CUR_DB_WAIT_TIME + DB_WAIT_TIMEOUT ))
+  CUR_DB_WAIT_TIME=$((CUR_DB_WAIT_TIME + DB_WAIT_TIMEOUT))
 done
 if [ "${CUR_DB_WAIT_TIME}" -ge "${MAX_DB_WAIT_TIME}" ]; then
   echo "❌ Waited ${MAX_DB_WAIT_TIME}s or more for the DB to become ready."
   exit 1
 fi
+# Check if update is needed
+if ! ./manage.py migrate --check >/dev/null 2>&1; then
+  echo "⚙️ Applying database migrations"
+  ./manage.py migrate --no-input
+  echo "⚙️ Running trace_paths"
+  ./manage.py trace_paths --no-input
+  echo "⚙️ Removing stale content types"
+  ./manage.py remove_stale_contenttypes --no-input
+  echo "⚙️ Removing expired user sessions"
+  ./manage.py clearsessions
+fi
 
 # Create Superuser if required
 if [ "$SKIP_SUPERUSER" == "true" ]; then
@@ -31,22 +58,18 @@ else
   if [ -z ${SUPERUSER_EMAIL+x} ]; then
     SUPERUSER_EMAIL='admin@example.com'
   fi
-  if [ -z ${SUPERUSER_PASSWORD+x} ]; then
+  if [ -f "/run/secrets/superuser_password" ]; then
-    if [ -f "/run/secrets/superuser_password" ]; then
+    SUPERUSER_PASSWORD="$(</run/secrets/superuser_password)"
-      SUPERUSER_PASSWORD="$(< /run/secrets/superuser_password)"
+  elif [ -z ${SUPERUSER_PASSWORD+x} ]; then
-    else
+    SUPERUSER_PASSWORD='admin'
-      SUPERUSER_PASSWORD='admin'
-    fi
   fi
-  if [ -z ${SUPERUSER_API_TOKEN+x} ]; then
+  if [ -f "/run/secrets/superuser_api_token" ]; then
-    if [ -f "/run/secrets/superuser_api_token" ]; then
+    SUPERUSER_API_TOKEN="$(</run/secrets/superuser_api_token)"
-      SUPERUSER_API_TOKEN="$(< /run/secrets/superuser_api_token)"
+  elif [ -z ${SUPERUSER_API_TOKEN+x} ]; then
-    else
+    SUPERUSER_API_TOKEN='0123456789abcdef0123456789abcdef01234567'
-      SUPERUSER_API_TOKEN='0123456789abcdef0123456789abcdef01234567'
-    fi
   fi
 
-  ./manage.py shell --interface python << END
+  ./manage.py shell --interface python <<END
 from django.contrib.auth.models import User
 from users.models import Token
 if not User.objects.filter(username='${SUPERUSER_NAME}'):
@@ -64,13 +87,8 @@ else
   echo "import runpy; runpy.run_path('../startup_scripts')" | ./manage.py shell --interface python
 fi
 
-# Copy static files
-./manage.py collectstatic --no-input
-
 echo "✅ Initialisation is done."
 
 # Launch whatever is passed by docker
 # (i.e. the RUN instruction in the Dockerfile)
-#
+exec "$@"
-# shellcheck disable=SC2068
-exec $@

docker/housekeeping.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+SECONDS=${HOUSEKEEPING_INTERVAL:=86400}
+echo "Interval set to ${SECONDS} seconds"
+while true; do
+  date
+  /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py housekeeping
+  sleep "${SECONDS}s"
+done

docker/launch-netbox.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+UNIT_CONFIG="${UNIT_CONFIG-/etc/unit/nginx-unit.json}"
+UNIT_SOCKET="/opt/unit/unit.sock"
+
+load_configuration() {
+  MAX_WAIT=10
+  WAIT_COUNT=0
+  while [ ! -S $UNIT_SOCKET ]; do
+    if [ $WAIT_COUNT -ge $MAX_WAIT ]; then
+      echo "⚠️ No control socket found; configuration will not be loaded."
+      return 1
+    fi
+
+    WAIT_COUNT=$((WAIT_COUNT + 1))
+    echo "⏳ Waiting for control socket to be created... (${WAIT_COUNT}/${MAX_WAIT})"
+
+    sleep 1
+  done
+
+  # even when the control socket exists, it does not mean unit has finished initialisation
+  # this curl call will get a reply once unit is fully launched
+  curl --silent --output /dev/null --request GET --unix-socket $UNIT_SOCKET http://localhost/
+
+  echo "⚙️ Applying configuration from $UNIT_CONFIG"
+
+  RESP_CODE=$(
+    curl \
+      --silent \
+      --output /dev/null \
+      --write-out '%{http_code}' \
+      --request PUT \
+      --data-binary "@${UNIT_CONFIG}" \
+      --unix-socket $UNIT_SOCKET \
+      http://localhost/config
+  )
+  if [ "$RESP_CODE" != "200" ]; then
+    echo "⚠️ Could no load Unit configuration"
+    kill "$(cat /opt/unit/unit.pid)"
+    return 1
+  fi
+
+  echo "✅ Unit configuration loaded successfully"
+}
+
+load_configuration &
+
+exec unitd \
+  --no-daemon \
+  --control unix:$UNIT_SOCKET \
+  --pid /opt/unit/unit.pid \
+  --log /dev/stdout \
+  --state /opt/unit/state/ \
+  --tmp /opt/unit/tmp/ \
+  --user unit \
+  --group root

docker/ldap_config.docker.py

@@ -1,10 +1,23 @@
-import importlib.util
+from .configuration import read_configurations
-import sys
 
-try:
+_loaded_configurations = read_configurations(
-  spec = importlib.util.spec_from_file_location('ldap_config', '/etc/netbox/config/ldap_config.py')
+    config_dir="/etc/netbox/config/ldap/",
-  module = importlib.util.module_from_spec(spec)
+    config_module="netbox.configuration.ldap",
-  spec.loader.exec_module(module)
+    main_config="ldap_config",
-  sys.modules['netbox.ldap_config'] = module
+)
-except:
+
-  raise ImportError('')
+
+def __getattr__(name):
+    for config in _loaded_configurations:
+        try:
+            return getattr(config, name)
+        except:
+            pass
+    raise AttributeError
+
+
+def __dir__():
+    names = []
+    for config in _loaded_configurations:
+        names.extend(config.__dir__())
+    return names

docker/nginx-unit.json

@@ -0,0 +1,40 @@
+{
+  "listeners": {
+    "*:8080": {
+      "pass": "routes"
+    }
+  },
+
+  "routes": [
+    {
+      "match": {
+        "uri": "/static/*"
+      },
+      "action": {
+        "share": "/opt/netbox/netbox"
+      }
+    },
+
+    {
+      "action": {
+        "pass": "applications/netbox"
+      }
+    }
+  ],
+
+  "applications": {
+    "netbox": {
+      "type": "python 3",
+      "path": "/opt/netbox/netbox/",
+      "module": "netbox.wsgi",
+      "home": "/opt/netbox/venv",
+      "processes": {
+        "max": 4,
+        "spare": 1,
+        "idle_timeout": 120
+      }
+    }
+  },
+
+  "access_log": "/dev/stdout"
+}

docker/nginx.conf

@@ -1,36 +0,0 @@
-daemon off;
-worker_processes 1;
-
-error_log /dev/stderr info;
-
-events {
-    worker_connections 1024;
-}
-
-http {
-    include              /etc/nginx/mime.types;
-    default_type         application/octet-stream;
-    sendfile             on;
-    tcp_nopush           on;
-    keepalive_timeout    65;
-    gzip                 on;
-    server_tokens        off;
-    client_max_body_size 10M;
-
-    server {
-        listen      8080;
-        access_log  off;
-
-        location /static/ {
-            alias /opt/netbox/netbox/static/;
-        }
-
-        location / {
-            proxy_pass http://netbox:8001;
-            proxy_set_header X-Forwarded-Host $http_host;
-            proxy_set_header X-Real-IP $remote_addr;
-            proxy_set_header X-Forwarded-Proto $scheme;
-            add_header P3P 'CP="ALL DSP COR PSAa PSDa OUR NOR ONL UNI COM NAV"';
-        }
-    }
-}

env/netbox.env

@@ -1,32 +1,43 @@
 CORS_ORIGIN_ALLOW_ALL=True
-DB_NAME=netbox
-DB_USER=netbox
-DB_PASSWORD=J5brHrAXFLQSif0K
 DB_HOST=postgres
-EMAIL_SERVER=localhost
+DB_NAME=netbox
-EMAIL_PORT=25
+DB_PASSWORD=J5brHrAXFLQSif0K
-EMAIL_USERNAME=netbox
+DB_USER=netbox
-EMAIL_PASSWORD=
-EMAIL_TIMEOUT=5
 EMAIL_FROM=netbox@bar.com
+EMAIL_PASSWORD=
+EMAIL_PORT=25
+EMAIL_SERVER=localhost
+EMAIL_SSL_CERTFILE=
+EMAIL_SSL_KEYFILE=
+EMAIL_TIMEOUT=5
+EMAIL_USERNAME=netbox
+# EMAIL_USE_SSL and EMAIL_USE_TLS are mutually exclusive, i.e. they can't both be `true`!
+EMAIL_USE_SSL=false
+EMAIL_USE_TLS=false
+GRAPHQL_ENABLED=true
+HOUSEKEEPING_INTERVAL=86400
+MAX_PAGE_SIZE=1000
 MEDIA_ROOT=/opt/netbox/netbox/media
-NAPALM_USERNAME=
+METRICS_ENABLED=false
 NAPALM_PASSWORD=
 NAPALM_TIMEOUT=10
-MAX_PAGE_SIZE=1000
+NAPALM_USERNAME=
-REDIS_HOST=redis
+REDIS_CACHE_DATABASE=1
-REDIS_PASSWORD=H733Kdjndks81
-REDIS_DATABASE=0
-REDIS_SSL=false
 REDIS_CACHE_HOST=redis-cache
+REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY=false
 REDIS_CACHE_PASSWORD=t4Ph722qJ5QHeQ1qfu36
-REDIS_CACHE_DATABASE=0
 REDIS_CACHE_SSL=false
+REDIS_DATABASE=0
+REDIS_HOST=redis
+REDIS_INSECURE_SKIP_TLS_VERIFY=false
+REDIS_PASSWORD=H733Kdjndks81
+REDIS_SSL=false
+RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
 SECRET_KEY=r8OwDznj!!dci#P9ghmRfdu1Ysxm0AiPeDCQhKE+N_rClfWNj
 SKIP_STARTUP_SCRIPTS=false
 SKIP_SUPERUSER=false
-SUPERUSER_NAME=admin
-SUPERUSER_EMAIL=admin@example.com
-SUPERUSER_PASSWORD=admin
 SUPERUSER_API_TOKEN=0123456789abcdef0123456789abcdef01234567
+SUPERUSER_EMAIL=admin@example.com
+SUPERUSER_NAME=admin
+SUPERUSER_PASSWORD=admin
 WEBHOOKS_ENABLED=true

env/postgres.env

@@ -1,3 +1,3 @@
-POSTGRES_USER=netbox
-POSTGRES_PASSWORD=J5brHrAXFLQSif0K
 POSTGRES_DB=netbox
+POSTGRES_PASSWORD=J5brHrAXFLQSif0K
+POSTGRES_USER=netbox

initializers/aggregates.yml

@@ -1,5 +1,6 @@
 # - prefix: 10.0.0.0/16
 #   rir: RFC1918
+#   tenant: tenant1
 # - prefix: fd00:ccdd::/32
 #   rir: RFC4193 ULA
 # - prefix: 2001:db8::/32

initializers/asns.yml

@@ -0,0 +1,7 @@
+# - asn: 1
+#   rir: RFC1918
+#   tenant: tenant1
+# - asn: 2
+#   rir: RFC4193 ULA
+# - asn: 3
+#   rir: RFC3849

initializers/circuit_types.yml

@@ -0,0 +1,6 @@
+# - name: VPLS
+#   slug: vpls
+# - name: MPLS
+#   slug: mpls
+# - name: Internet
+#   slug: internet

initializers/circuits.yml

@@ -0,0 +1,7 @@
+# - cid: Circuit_ID-1
+#   provider: Provider1
+#   type: Internet
+#   tenant: tenant1
+# - cid: Circuit_ID-2
+#   provider: Provider2
+#   type: MPLS

initializers/cluster_groups.yml

@@ -0,0 +1,4 @@
+# - name: Group 1
+#   slug: group-1
+# - name: Group 2
+#   slug: group-2

initializers/clusters.yml

@@ -1,5 +1,7 @@
 # - name: cluster1
 #   type: Hyper-V
+#   group: Group 1
+#   tenant: tenant1
 # - name: cluster2
 #   type: Hyper-V
 #   site: SING 1

initializers/custom_fields.yml

@@ -43,40 +43,36 @@
 #   required: false
 #   filter_logic: exact
 #   weight: 30
+#   default: First Item
 #   on_objects:
 #   - dcim.models.Device
 #   choices:
-#   - value: First Item
+#   - First Item
-#     weight: 10
+#   - Second Item
-#   - value: Second Item
+#   - Third Item
-#     weight: 20
+#   - Fifth Item
-#   - value: Third Item
+#   - Fourth Item
-#     weight: 30
+# select_field_legacy_format:
-#   - value: Fifth Item
+#   type: select
-#     weight: 50
+#   label: Choose between items
-#   - value: Fourth Item
+#   required: false
-#     weight: 40
+#   filter_logic: loose
-# select_field_auto_weight:
+#   weight: 30
-#    type: select
+#   on_objects:
-#    label: Choose between items
+#   - dcim.models.Device
-#    required: false
+#   choices:
-#    filter_logic: loose
+#   - value: A # this is the deprecated format.
-#    weight: 30
+#   - value: B # we only use it for the tests.
-#    on_objects:
+#   - value: C # please see above for the new format.
-#     - dcim.models.Device
+#   - value: "D like deprecated"
-#    choices:
+#     weight: 999
-#     - value: A
+#   - value: E
-#     - value: B
-#     - value: C
-#     - value: "D like deprecated"
-#       weight: 999
-#     - value: E
 # boolean_field:
 #   type: boolean
 #   label: Yes Or No?
 #   required: true
 #   filter_logic: loose
-#   default: "false" # important: but "false" in quotes!
+#   default: "false" # important: put "false" in quotes!
 #   weight: 90
 #   on_objects:
 #   - dcim.models.Device

initializers/custom_links.yml

@@ -0,0 +1,21 @@
+## Possible Choices:
+##   new_window:
+##   - True
+##   - False
+##   content_type:
+##   - device
+##   - site
+##   - any-other-content-type
+##
+## Examples:
+
+# - name: link_to_repo
+#   link_text: 'Link to Netbox Docker'
+#   link_url: 'https://github.com/netbox-community/netbox-docker'
+#   new_window: False
+#   content_type: device
+# - name: link_to_localhost
+#   link_text: 'Link to localhost'
+#   link_url: 'http://localhost'
+#   new_window: True
+#   content_type: device

initializers/device_types.yml

@@ -2,22 +2,22 @@
 #   manufacturer: Manufacturer 1
 #   slug: model-1
 #   u_height: 2
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description
 # - model: Model 2
 #   manufacturer: Manufacturer 1
 #   slug: model-2
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description
 # - model: Model 3
 #   manufacturer: Manufacturer 1
 #   slug: model-3
 #   is_full_depth: false
 #   u_height: 0
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description
 # - model: Other
 #   manufacturer: No Name
 #   slug: other
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description

initializers/devices.yml

@@ -20,7 +20,7 @@
 #   rack: rack-01
 #   face: front
 #   position: 1
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description
 # - name: server02
 #   device_role: server
@@ -29,7 +29,9 @@
 #   rack: rack-02
 #   face: front
 #   position: 2
-#   custom_fields:
+#   primary_ip4: 10.1.1.2/24
+#   primary_ip6: 2001:db8:a000:1::2/64
+#   custom_field_data:
 #     text_field: Description
 # - name: server03
 #   device_role: server
@@ -38,5 +40,14 @@
 #   rack: rack-03
 #   face: front
 #   position: 3
-#   custom_fields:
+#   custom_field_data:
+#     text_field: Description
+# - name: server04
+#   device_role: server
+#   device_type: Other
+#   site: SING 1
+#   location: cage 101
+#   face: front
+#   position: 3
+#   custom_field_data:
 #     text_field: Description

initializers/groups.yml

@@ -1,16 +1,9 @@
 # applications:
 #   users:
-#   - technical_user
+#     - technical_user
 # readers:
 #   users:
-#   - reader
+#     - reader
 # writers:
 #   users:
-#   - writer
+#     - writer
-#   permissions:
-#   - add_device
-#   - change_device
-#   - delete_device
-#   - add_virtualmachine
-#   - change_virtualmachine
-#   - delete_virtualmachine

initializers/object_permissions.yml

@@ -0,0 +1,48 @@
+# all.ro:
+#   actions:
+#     - view
+#   description: 'Read Only for All Objects'
+#   enabled: true
+#   groups:
+#     - applications
+#     - readers
+#   object_types: all
+#   users:
+#     - jdoe
+# all.rw:
+#   actions:
+#     - add
+#     - change
+#     - delete
+#     - view
+#   description: 'Read/Write for All Objects'
+#   enabled: true
+#   groups:
+#     - writers
+#   object_types: all
+# network_team.rw:
+#   actions:
+#     - add
+#     - change
+#     - delete
+#     - view
+#   description: "Network Team Permissions"
+#   enabled: true
+#   object_types:
+#     circuits:
+#       - circuit
+#       - circuittermination
+#       - circuittype
+#       - provider
+#     dcim: all
+#     ipam:
+#       - aggregate
+#       - ipaddress
+#       - prefix
+#       - rir
+#       - role
+#       - routetarget
+#       - service
+#       - vlan
+#       - vlangroup
+#       - vrf

initializers/power_feeds.yml

@@ -0,0 +1,14 @@
+# - name: power feed 1
+#   power_panel: power panel AMS 1
+#   voltage: 208
+#   amperage: 50
+#   max_utilization: 80
+#   phase: Single phase
+#   rack: rack-01
+# - name: power feed 2
+#   power_panel: power panel SING 1
+#   voltage: 208
+#   amperage: 50
+#   max_utilization: 80
+#   phase: Three-phase
+#   rack: rack-03

initializers/power_panels.yml

@@ -0,0 +1,5 @@
+# - name: power panel AMS 1
+#   site: AMS 1   
+# - name: power panel SING 1
+#   site: SING 1 
+#   location: cage 101

initializers/providers.yml

@@ -0,0 +1,6 @@
+# - name: Provider1
+#   slug: provider1
+#   asn: 121
+# - name: Provider2
+#   slug: provider2
+#   asn: 122

initializers/racks.yml

@@ -20,7 +20,7 @@
 #   type: 4-post-cabinet
 #   width: 19
 #   u_height: 47
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description
 # - site: AMS 2
 #   name: rack-02
@@ -28,14 +28,14 @@
 #   type: 4-post-cabinet
 #   width: 19
 #   u_height: 47
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description
 # - site: SING 1
 #   name: rack-03
-#   group: cage 101
+#   location: cage 101
 #   role: Role 3
 #   type: 4-post-cabinet
 #   width: 19
 #   u_height: 47
-#   custom_fields:
+#   custom_field_data:
 #     text_field: Description

initializers/route_targets.yml

@@ -0,0 +1,3 @@
+# - name: 65000:1001
+#   tenant: tenant1
+# - name: 65000:1002

initializers/services.yml

@@ -0,0 +1,15 @@
+# - name: DNS
+#   protocol: TCP
+#   ports:
+#     - 53
+#   virtual_machine: virtual machine 1
+# - name: DNS
+#   protocol: UDP
+#   ports:
+#     - 53
+#   virtual_machine: virtual machine 1
+# - name: MISC
+#   protocol: UDP
+#   ports: 
+#     - 4000
+#   device: server01

initializers/sites.yml

@@ -1,32 +1,30 @@
 # - name: AMS 1
 #   slug: ams1
 #   region: Downtown
-#   status: 1
+#   status: active
 #   facility: Amsterdam 1
-#   asn: 12345
+#   custom_field_data:
-#   custom_fields:
+#     text_field: Description for AMS1
-#     text_field: Description
 # - name: AMS 2
 #   slug: ams2
 #   region: Downtown
-#   status: 1
+#   status: active
 #   facility: Amsterdam 2
-#   asn: 54321
+#   custom_field_data:
-#   custom_fields:
+#     text_field: Description for AMS2
-#     text_field: Description
 # - name: AMS 3
 #   slug: ams3
 #   region: Suburbs
-#   status: 1
+#   status: active
 #   facility: Amsterdam 3
-#   asn: 67890
+#   tenant: tenant1
-#   custom_fields:
+#   custom_field_data:
-#     text_field: Description
+#     text_field: Description for AMS3
 # - name: SING 1
 #   slug: sing1
 #   region: Singapore
-#   status: 1
+#   status: active
 #   facility: Singapore 1
-#   asn: 09876
+#   tenant: tenant2
-#   custom_fields:
+#   custom_field_data:
-#     text_field: Description
+#     text_field: Description for SING1

initializers/tags.yml

@@ -0,0 +1,12 @@
+# - name: Tag 1
+#   slug: tag-1
+#   color: Pink
+# - name: Tag 2
+#   slug: tag-2
+#   color: Cyan
+# - name: Tag 3
+#   slug: tag-3
+#   color: Grey
+# - name: Tag 4
+#   slug: tag-4
+#   color: Teal

initializers/users.yml

@@ -4,10 +4,11 @@
 #   password: reader
 # writer:
 #   password: writer
-#   permissions:
+# jdoe:
-#   - add_device
+#   first_name: John
-#   - change_device
+#   last_name: Doe
-#   - delete_device
+#   api_token: 0123456789jdoe789abcdef01234567jdoe
-#   - add_virtualmachine
+#   is_active: True
-#   - change_virtualmachine
+#   is_superuser: False
-#   - delete_virtualmachine
+#   is_staff: False
+#   email: john.doe@example.com

initializers/virtual_machines.yml

@@ -21,6 +21,8 @@
 #   memory: 2048
 #   name: virtual machine 2
 #   platform: Platform 2
+#   primary_ip4: 10.1.1.10/24
+#   primary_ip6: 2001:db8:a000:1::10/64
 #   status: active
 #   tenant: tenant1
 #   vcpus: 8

initializers/vlan_groups.yml

@@ -1,6 +1,24 @@
 # - name: VLAN group 1
-#   site: AMS 1
+#   scope_type: dcim.region
+#   scope: Amsterdam
 #   slug: vlan-group-1
 # - name: VLAN group 2
-#   site: AMS 1
+#   scope_type: dcim.site
+#   scope: AMS 1
 #   slug: vlan-group-2
+# - name: VLAN group 3
+#   scope_type: dcim.location
+#   scope: cage 101
+#   slug: vlan-group-3
+# - name: VLAN group 4
+#   scope_type: dcim.rack
+#   scope: rack-01
+#   slug: vlan-group-4
+# - name: VLAN group 5
+#   scope_type: virtualization.cluster
+#   scope: cluster1
+#   slug: vlan-group-5
+# - name: VLAN group 6
+#   scope_type: virtualization.clustergroup
+#   scope: Group 1
+#   slug: vlan-group-6

initializers/webhooks.yml

@@ -0,0 +1,27 @@
+## Possible Choices:
+##   object_types:
+##   - device
+##   - site
+##   - any-other-content-type
+##   types:
+##   - type_create
+##   - type_update
+##   - type_delete
+## Examples:
+
+# - name: device_creation
+#   payload_url: 'http://localhost:8080'
+#   object_types:
+#     - device
+#     - cable
+#   type_create: True
+# - name: device_update
+#   payload_url: 'http://localhost:8080'
+#   object_types:
+#     - device
+#   type_update: True
+# - name: device_delete
+#   payload_url: 'http://localhost:8080'
+#   object_types:
+#     - device
+#   type_delete: True

pyproject.toml

@@ -0,0 +1,26 @@
+[tool.black]
+line_length = 100
+target-version = ['py38']
+include = '\.pyi?$'
+exclude = '''
+(
+  /(
+      \.git
+    | \.venv
+    | \.netbox
+    | \.vscode
+    | configuration
+  )/
+)
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 100
+
+[tool.pylint.messages_control]
+disable = "C0330, C0326"
+
+[tool.pylint.format]
+max-line-length = "100"

release.sh

@@ -0,0 +1,188 @@
+#!/bin/bash
+
+DEFAULT_REPO=netbox-community/netbox-docker
+REPO="${REPO-${DEFAULT_REPO}}"
+
+echomoji() {
+  EMOJI=${1}
+  TEXT=${2}
+  shift 2
+  if [ -z "$DISABLE_EMOJI" ]; then
+    echo "${EMOJI}" "${@}"
+  else
+    echo "${TEXT}" "${@}"
+  fi
+}
+
+echo_nok() {
+  echomoji "❌" "!" "${@}"
+}
+echo_ok() {
+  echomoji "✅" "-" "${@}"
+}
+echo_hint() {
+  echomoji "👉" ">" "${@}"
+}
+
+# check errors shall exit with code 1
+
+check_clean_repo() {
+  changes=$(git status --porcelain 2>/dev/null)
+  if [ ${?} ] && [ -n "$changes" ]; then
+    echo_nok "There are git changes pending:"
+    echo "$changes"
+    echo_hint "Please clean the repository before continueing: git stash --include-untracked"
+    exit 1
+  fi
+  echo_ok "Repository has no pending changes."
+}
+
+check_branch() {
+  expected_branch="${1}"
+  actual_branch=$(git rev-parse --abbrev-ref HEAD 2>/dev/null)
+  if [ ${?} ] && [ "${actual_branch}" != "${expected_branch}" ]; then
+    echo_nok "Current branch should be '${expected_branch}', but is '${actual_branch}'."
+    echo_hint "Please change to the '${expected_branch}' branch: git checkout ${expected_branch}"
+    exit 1
+  fi
+  echo_ok "The current branch is '${actual_branch}'."
+}
+
+check_upstream() {
+  expected_upstream_branch="origin/${1}"
+  actual_upstream_branch=$(git rev-parse --abbrev-ref '@{upstream}' 2>/dev/null)
+  if [ ${?} ] && [ "${actual_upstream_branch}" != "${expected_upstream_branch}" ]; then
+    echo_nok "Current upstream branch should be '${expected_upstream_branch}', but is '${actual_upstream_branch}'."
+    echo_hint "Please set '${expected_upstream_branch}' as the upstream branch: git branch --set-upstream-to=${expected_upstream_branch}"
+    exit 1
+  fi
+  echo_ok "The current upstream branch is '${actual_upstream_branch}'."
+}
+
+check_origin() {
+  expected_origin="git@github.com:${REPO}.git"
+  actual_origin=$(git remote get-url origin 2>/dev/null)
+  if [ ${?} ] && [ "${actual_origin}" != "${expected_origin}" ]; then
+    echo_nok "The url of origin is '${actual_origin}', but '${expected_origin}' is expected."
+    echo_hint "Please set '${expected_origin}' as the url for origin: git origin set-url '${expected_origin}'"
+    exit 1
+  fi
+  echo_ok "The current origin url is '${actual_origin}'."
+}
+
+check_latest() {
+  git fetch --tags origin
+
+  local_head_commit=$(git rev-parse HEAD 2>/dev/null)
+  remote_head_commit=$(git rev-parse FETCH_HEAD 2>/dev/null)
+  if [ "${local_head_commit}" != "${remote_head_commit}" ]; then
+    echo_nok "HEAD is at '${local_head_commit}', but FETCH_HEAD is at '${remote_head_commit}'."
+    echo_hint "Please ensure that you have pushed and pulled all the latest chanegs: git pull --prune --rebase origin; git push origin"
+    exit 1
+  fi
+  echo_ok "HEAD and FETCH_HEAD both point to '${local_head_commit}'."
+}
+
+check_tag() {
+  local tag
+
+  tag=$(<VERSION)
+  if git rev-parse "${tag}" 2>/dev/null >/dev/null; then
+    echo_nok "The tag '${tag}' already points to '$(git rev-parse "${tag}" 2>/dev/null)'."
+    echo_hint "Please ensure that the 'VERSION' file has been updated before trying to release: echo X.Y.Z > VERSION"
+    exit 1
+  fi
+  echo_ok "The tag '${tag}' does not exist yet."
+}
+
+check_develop() {
+  echomoji 📋 "?" "Checking 'develop' branch"
+
+  check_branch develop
+  check_upstream develop
+  check_clean_repo
+  check_latest
+}
+
+check_release() {
+  echomoji 📋 "?" "Checking 'release' branch"
+
+  check_upstream release
+  check_clean_repo
+  check_latest
+}
+
+# git errors shall exit with code 2
+
+git_switch() {
+  echomoji 🔀 "≈" "Switching to '${1}' branch…"
+  if ! git checkout "${1}" >/dev/null; then
+    echo_nok "It was not possible to switch to the branch '${1}'."
+    exit 2
+  fi
+  echo_ok "The branch is now '${1}'."
+}
+
+git_tag() {
+  echomoji 🏷 "X" "Tagging version '${1}'…"
+  if ! git tag "${1}"; then
+    echo_nok "The tag '${1}' was not created because of an error."
+    exit 2
+  fi
+  echo_ok "The tag '$(<VERSION)' was created."
+}
+
+git_push() {
+  echomoji ⏩ "»" "Pushing the tag '${2}' to '${1}'…"
+  if ! git push "${1}" "${2}"; then
+    echo_nok "The tag '${2}' could not be pushed to '${1}'."
+    exit 2
+  fi
+  echo_ok "The tag '${2}' was pushed."
+}
+
+git_merge() {
+  echomoji ⏩ "»" "Merging '${1}'…"
+  if ! git merge --no-ff "${1}"; then
+    echo_nok "The branch '${1}' could not be merged."
+    exit 2
+  fi
+  echo_ok "The branch '${2}' was merged."
+}
+
+git_merge() {
+  echomoji ⏩ "»" "Rebasing onto '${1}'…"
+  if ! git rebase "${1}"; then
+    echo_nok "Could not rebase onto '${1}'."
+    exit 2
+  fi
+  echo_ok "Rebased onto '${2}'."
+}
+
+###
+# MAIN
+###
+
+echomoji 📋 "▶︎" "Checking pre-requisites for releasing '$(<VERSION)'"
+
+check_origin
+
+check_develop
+check_tag
+
+git_switch release
+check_release
+
+echomoji 📋 "▶︎" "Releasing '$(<VERSION)'"
+
+git_merge develop
+check_tag
+git_tag "$(<VERSION)"
+
+git_push "origin" release
+git_push "origin" "$(<VERSION)"
+
+git_switch develop
+git_rebase release
+
+echomoji ✅ "◼︎" "The release of '$(<VERSION)' is complete."

renovate.json

@@ -0,0 +1,14 @@
+{
+  "extends": [
+    "config:base",
+    ":disableDependencyDashboard"
+  ],
+  "enabled": true,
+  "labels": ["maintenance"],
+  "baseBranches": ["develop"],
+  "pip_requirements": {
+    "fileMatch": [
+      "requirements-container.txt"
+    ]
+  }
+}

reports/devices.py.example

@@ -1,4 +1,4 @@
-from dcim.constants import CONNECTION_STATUS_PLANNED, DEVICE_STATUS_ACTIVE
+from dcim.choices import DeviceStatusChoices
 from dcim.models import ConsolePort, Device, PowerPort
 from extras.reports import Report
 
@@ -9,13 +9,14 @@ class DeviceConnectionsReport(Report):
     def test_console_connection(self):
 
         # Check that every console port for every active device has a connection defined.
-        for console_port in ConsolePort.objects.select_related('device').filter(device__status=DEVICE_STATUS_ACTIVE):
+        active = DeviceStatusChoices.STATUS_ACTIVE
+        for console_port in ConsolePort.objects.prefetch_related('device').filter(device__status=active):
             if console_port.connected_endpoint is None:
                 self.log_failure(
                     console_port.device,
                     "No console connection defined for {}".format(console_port.name)
                 )
-            elif console_port.connection_status == CONNECTION_STATUS_PLANNED:
+            elif not console_port.connection_status:
                 self.log_warning(
                     console_port.device,
                     "Console connection for {} marked as planned".format(console_port.name)
@@ -26,12 +27,12 @@ class DeviceConnectionsReport(Report):
     def test_power_connections(self):
 
         # Check that every active device has at least two connected power supplies.
-        for device in Device.objects.filter(status=DEVICE_STATUS_ACTIVE):
+        for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
             connected_ports = 0
             for power_port in PowerPort.objects.filter(device=device):
                 if power_port.connected_endpoint is not None:
                     connected_ports += 1
-                    if power_port.connection_status == CONNECTION_STATUS_PLANNED:
+                    if not power_port.connection_status:
                         self.log_warning(
                             device,
                             "Power connection for {} marked as planned".format(power_port.name)
@@ -43,4 +44,3 @@ class DeviceConnectionsReport(Report):
                 )
             else:
                 self.log_success(device)
-

requirements-container.txt

@@ -0,0 +1,6 @@
+django-auth-ldap==4.0.0
+django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.12.3
+google-crc32c==1.3.0
+napalm==3.3.1
+ruamel.yaml==0.17.21
+tzdata==2021.5

startup_scripts/000_users.py

@@ -1,34 +1,21 @@
-from django.contrib.auth.models import Permission, Group, User
-from users.models import Token
-
-from ruamel.yaml import YAML
-from pathlib import Path
 import sys
 
-file = Path('/opt/netbox/initializers/users.yml')
+from django.contrib.auth.models import User
-if not file.is_file():
+from startup_script_utils import load_yaml
-  sys.exit()
+from users.models import Token
 
-with file.open('r') as stream:
+users = load_yaml("/opt/netbox/initializers/users.yml")
-  yaml=YAML(typ='safe')
+if users is None:
-  users = yaml.load(stream)
+    sys.exit()
 
-  if users is not None:
+for username, user_details in users.items():
-    for username, user_details in users.items():
+    if not User.objects.filter(username=username):
-      if not User.objects.filter(username=username):
         user = User.objects.create_user(
-          username = username,
+            username=username,
-          password = user_details.get('password', 0) or User.objects.make_random_password)
+            password=user_details.get("password", 0) or User.objects.make_random_password(),
+        )
 
-        print("👤 Created user ",username)
+        print("👤 Created user", username)
 
-        if user_details.get('api_token', 0):
+        if user_details.get("api_token", 0):
-          Token.objects.create(user=user, key=user_details['api_token'])
+            Token.objects.create(user=user, key=user_details["api_token"])
-
-        user_permissions = user_details.get('permissions', [])
-        if user_permissions:
-          user.user_permissions.clear()
-          for permission_codename in user_details.get('permissions', []):
-            for permission in Permission.objects.filter(codename=permission_codename):
-              user.user_permissions.add(permission)
-          user.save()

startup_scripts/010_groups.py

@@ -1,32 +1,23 @@
-from django.contrib.auth.models import Permission, Group, User
-from ruamel.yaml import YAML
-from pathlib import Path
 import sys
 
-file = Path('/opt/netbox/initializers/groups.yml')
+from startup_script_utils import load_yaml
-if not file.is_file():
+from users.models import AdminGroup, AdminUser
-  sys.exit()
 
-with file.open('r') as stream:
+groups = load_yaml("/opt/netbox/initializers/groups.yml")
-  yaml=YAML(typ='safe')
+if groups is None:
-  groups = yaml.load(stream)
+    sys.exit()
 
-  if groups is not None:
+for groupname, group_details in groups.items():
-    for groupname, group_details in groups.items():
+    group, created = AdminGroup.objects.get_or_create(name=groupname)
-      group, created = Group.objects.get_or_create(name=groupname)
 
-      if created:
+    if created:
         print("👥 Created group", groupname)
 
-      for username in group_details.get('users', []):
+    for username in group_details.get("users", []):
-        user = User.objects.get(username=username)
+        user = AdminUser.objects.get(username=username)
 
         if user:
-          user.groups.add(group)
+            group.user_set.add(user)
+            print(" 👤 Assigned user %s to group %s" % (username, group.name))
 
-      group_permissions = group_details.get('permissions', [])
+    group.save()
-      if group_permissions:
-        group.permissions.clear()
-        for permission_codename in group_details.get('permissions', []):
-          for permission in Permission.objects.filter(codename=permission_codename):
-            group.permissions.add(permission)

startup_scripts/020_custom_fields.py

@@ -1,59 +0,0 @@
-from extras.models import CustomField, CustomFieldChoice
-
-from ruamel.yaml import YAML
-from pathlib import Path
-import sys
-
-def get_class_for_class_path(class_path):
-  import importlib
-  from django.contrib.contenttypes.models import ContentType
-
-  module_name, class_name = class_path.rsplit(".", 1)
-  module = importlib.import_module(module_name)
-  clazz = getattr(module, class_name)
-  return ContentType.objects.get_for_model(clazz)
-
-file = Path('/opt/netbox/initializers/custom_fields.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml = YAML(typ='safe')
-  customfields = yaml.load(stream)
-
-  if customfields is not None:
-    for cf_name, cf_details in customfields.items():
-      custom_field, created = CustomField.objects.get_or_create(name = cf_name)
-
-      if created:
-        if cf_details.get('default', 0):
-          custom_field.default = cf_details['default']
-
-        if cf_details.get('description', 0):
-          custom_field.description = cf_details['description']
-
-        if cf_details.get('label', 0):
-          custom_field.label = cf_details['label']
-
-        for object_type in cf_details.get('on_objects', []):
-          custom_field.obj_type.add(get_class_for_class_path(object_type))
-
-        if cf_details.get('required', 0):
-          custom_field.required = cf_details['required']
-
-        if cf_details.get('type', 0):
-          custom_field.type = cf_details['type']
-
-        if cf_details.get('weight', 0):
-          custom_field.weight = cf_details['weight']
-
-        custom_field.save()
-
-        for idx, choice_details in enumerate(cf_details.get('choices', [])):
-          choice, _ = CustomFieldChoice.objects.get_or_create(
-            field=custom_field,
-            value=choice_details['value'],
-            defaults={'weight': idx * 10}
-          )
-
-        print("🔧 Created custom field", cf_name)

startup_scripts/020_object_permissions.py

@@ -0,0 +1,66 @@
+import sys
+
+from django.contrib.contenttypes.models import ContentType
+from startup_script_utils import load_yaml
+from users.models import AdminGroup, AdminUser, ObjectPermission
+
+object_permissions = load_yaml("/opt/netbox/initializers/object_permissions.yml")
+
+if object_permissions is None:
+    sys.exit()
+
+
+for permission_name, permission_details in object_permissions.items():
+
+    object_permission, created = ObjectPermission.objects.get_or_create(
+        name=permission_name,
+        description=permission_details["description"],
+        enabled=permission_details["enabled"],
+        actions=permission_details["actions"],
+    )
+
+    if permission_details.get("object_types", 0):
+        object_types = permission_details["object_types"]
+
+        if object_types == "all":
+            object_permission.object_types.set(ContentType.objects.all())
+
+        else:
+            for app_label, models in object_types.items():
+                if models == "all":
+                    app_models = ContentType.objects.filter(app_label=app_label)
+
+                    for app_model in app_models:
+                        object_permission.object_types.add(app_model.id)
+                else:
+                    # There is
+                    for model in models:
+                        object_permission.object_types.add(
+                            ContentType.objects.get(app_label=app_label, model=model)
+                        )
+
+    print("🔓 Created object permission", object_permission.name)
+
+    if permission_details.get("groups", 0):
+        for groupname in permission_details["groups"]:
+            group = AdminGroup.objects.filter(name=groupname).first()
+
+            if group:
+                object_permission.groups.add(group)
+                print(
+                    " 👥 Assigned group %s object permission of %s"
+                    % (groupname, object_permission.name)
+                )
+
+    if permission_details.get("users", 0):
+        for username in permission_details["users"]:
+            user = AdminUser.objects.filter(username=username).first()
+
+            if user:
+                object_permission.users.add(user)
+                print(
+                    " 👤 Assigned user %s object permission of %s"
+                    % (username, object_permission.name)
+                )
+
+    object_permission.save()

startup_scripts/030_custom_fields.py

@@ -0,0 +1,67 @@
+import sys
+
+from extras.models import CustomField
+from startup_script_utils import load_yaml
+
+
+def get_class_for_class_path(class_path):
+    import importlib
+
+    from django.contrib.contenttypes.models import ContentType
+
+    module_name, class_name = class_path.rsplit(".", 1)
+    module = importlib.import_module(module_name)
+    clazz = getattr(module, class_name)
+    return ContentType.objects.get_for_model(clazz)
+
+
+customfields = load_yaml("/opt/netbox/initializers/custom_fields.yml")
+
+if customfields is None:
+    sys.exit()
+
+for cf_name, cf_details in customfields.items():
+    custom_field, created = CustomField.objects.get_or_create(name=cf_name)
+
+    if created:
+        if cf_details.get("default", False):
+            custom_field.default = cf_details["default"]
+
+        if cf_details.get("description", False):
+            custom_field.description = cf_details["description"]
+
+        if cf_details.get("label", False):
+            custom_field.label = cf_details["label"]
+
+        for object_type in cf_details.get("on_objects", []):
+            custom_field.content_types.add(get_class_for_class_path(object_type))
+
+        if cf_details.get("required", False):
+            custom_field.required = cf_details["required"]
+
+        if cf_details.get("type", False):
+            custom_field.type = cf_details["type"]
+
+        if cf_details.get("filter_logic", False):
+            custom_field.filter_logic = cf_details["filter_logic"]
+
+        if cf_details.get("weight", -1) >= 0:
+            custom_field.weight = cf_details["weight"]
+
+        if cf_details.get("choices", False):
+            custom_field.choices = []
+
+            for choice_detail in cf_details.get("choices", []):
+                if isinstance(choice_detail, dict) and "value" in choice_detail:
+                    # legacy mode
+                    print(
+                        f"⚠️ Please migrate the choice '{choice_detail['value']}' of '{cf_name}'"
+                        + " to the new format, as 'weight' is no longer supported!"
+                    )
+                    custom_field.choices.append(choice_detail["value"])
+                else:
+                    custom_field.choices.append(choice_detail)
+
+        custom_field.save()
+
+        print("🔧 Created custom field", cf_name)

startup_scripts/030_regions.py

@@ -1,31 +0,0 @@
-from dcim.models import Region
-from ruamel.yaml import YAML
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/regions.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml=YAML(typ='safe')
-  regions = yaml.load(stream)
-
-  optional_assocs = {
-    'parent': (Region, 'name')
-  }
-
-  if regions is not None:
-    for params in regions:
-
-      for assoc, details in optional_assocs.items():
-        if assoc in params:
-          model, field = details
-          query = { field: params.pop(assoc) }
-
-          params[assoc] = model.objects.get(**query)
-
-      region, created = Region.objects.get_or_create(**params)
-
-      if created:
-        print("🌐 Created region", region.name)

startup_scripts/040_custom_links.py

@@ -0,0 +1,33 @@
+import sys
+
+from django.contrib.contenttypes.models import ContentType
+from extras.models import CustomLink
+from startup_script_utils import load_yaml
+
+custom_links = load_yaml("/opt/netbox/initializers/custom_links.yml")
+
+if custom_links is None:
+    sys.exit()
+
+
+def get_content_type_id(content_type):
+    try:
+        return ContentType.objects.get(model=content_type).id
+    except ContentType.DoesNotExist:
+        pass
+
+
+for link in custom_links:
+    content_type = link.pop("content_type")
+    link["content_type_id"] = get_content_type_id(content_type)
+    if link["content_type_id"] is None:
+        print(
+            "⚠️ Unable to create Custom Link '{0}': The content_type '{1}' is unknown".format(
+                link.get("name"), content_type
+            )
+        )
+        continue
+
+    custom_link, created = CustomLink.objects.get_or_create(**link)
+    if created:
+        print("🔗 Created Custom Link '{0}'".format(custom_link.name))

startup_scripts/040_sites.py

@@ -1,46 +0,0 @@
-from dcim.models import Region, Site
-from extras.models import CustomField, CustomFieldValue
-from tenancy.models import Tenant
-from ruamel.yaml import YAML
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/sites.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml = YAML(typ='safe')
-  sites = yaml.load(stream)
-
-  optional_assocs = {
-    'region': (Region, 'name'),
-    'tenant': (Tenant, 'name')
-  }
-
-  if sites is not None:
-    for params in sites:
-      custom_fields = params.pop('custom_fields', None)
-
-      for assoc, details in optional_assocs.items():
-        if assoc in params:
-          model, field = details
-          query = { field: params.pop(assoc) }
-
-          params[assoc] = model.objects.get(**query)
-
-      site, created = Site.objects.get_or_create(**params)
-
-      if created:
-        if custom_fields is not None:
-          for cf_name, cf_value in custom_fields.items():
-            custom_field = CustomField.objects.get(name=cf_name)
-            custom_field_value = CustomFieldValue.objects.create(
-              field=custom_field,
-              obj=site,
-              value=cf_value
-            )
-
-            site.custom_field_values.add(custom_field_value)
-
-        print("📍 Created site", site.name)

startup_scripts/050_manufacturers.py

@@ -1,19 +0,0 @@
-from dcim.models import Manufacturer
-from ruamel.yaml import YAML
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/manufacturers.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml = YAML(typ='safe')
-  manufacturers = yaml.load(stream)
-
-  if manufacturers is not None:
-    for params in manufacturers:
-      manufacturer, created = Manufacturer.objects.get_or_create(**params)
-
-      if created:
-        print("🏭 Created Manufacturer", manufacturer.name)

startup_scripts/050_tags.py

@@ -0,0 +1,23 @@
+import sys
+
+from extras.models import Tag
+from startup_script_utils import load_yaml
+from utilities.choices import ColorChoices
+
+tags = load_yaml("/opt/netbox/initializers/tags.yml")
+
+if tags is None:
+    sys.exit()
+
+for params in tags:
+    if "color" in params:
+        color = params.pop("color")
+
+        for color_tpl in ColorChoices:
+            if color in color_tpl:
+                params["color"] = color_tpl[0]
+
+    tag, created = Tag.objects.get_or_create(**params)
+
+    if created:
+        print("🎨 Created Tag", tag.name)

startup_scripts/060_device_types.py

@@ -1,56 +0,0 @@
-from dcim.models import DeviceType, Manufacturer, Region
-from tenancy.models import Tenant
-from extras.models import CustomField, CustomFieldValue
-from ruamel.yaml import YAML
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/device_types.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml = YAML(typ='safe')
-  device_types = yaml.load(stream)
-
-  required_assocs = {
-    'manufacturer': (Manufacturer, 'name')
-  }
-
-  optional_assocs = {
-    'region': (Region, 'name'),
-    'tenant': (Tenant, 'name')
-  }
-
-  if device_types is not None:
-    for params in device_types:
-      custom_fields = params.pop('custom_fields', None)
-
-      for assoc, details in required_assocs.items():
-        model, field = details
-        query = { field: params.pop(assoc) }
-
-        params[assoc] = model.objects.get(**query)
-
-      for assoc, details in optional_assocs.items():
-        if assoc in params:
-          model, field = details
-          query = { field: params.pop(assoc) }
-
-          params[assoc] = model.objects.get(**query)
-
-      device_type, created = DeviceType.objects.get_or_create(**params)
-
-      if created:
-        if custom_fields is not None:
-          for cf_name, cf_value in custom_fields.items():
-            custom_field = CustomField.objects.get(name=cf_name)
-            custom_field_value = CustomFieldValue.objects.create(
-              field=custom_field,
-              obj=device_type,
-              value=cf_value
-            )
-
-            device_type.custom_field_values.add(custom_field_value)
-
-        print("🔡 Created device type", device_type.manufacturer, device_type.model)

startup_scripts/060_webhooks.py

@@ -0,0 +1,34 @@
+import sys
+
+from django.contrib.contenttypes.models import ContentType
+from extras.models import Webhook
+from startup_script_utils import load_yaml
+
+webhooks = load_yaml("/opt/netbox/initializers/webhooks.yml")
+
+if webhooks is None:
+    sys.exit()
+
+
+def get_content_type_id(hook_name, content_type):
+    try:
+        return ContentType.objects.get(model=content_type).id
+    except ContentType.DoesNotExist as ex:
+        print("⚠️ Webhook '{0}': The object_type '{1}' is unknown.".format(hook_name, content_type))
+        raise ex
+
+
+for hook in webhooks:
+    obj_types = hook.pop("object_types")
+
+    try:
+        obj_type_ids = [get_content_type_id(hook["name"], obj) for obj in obj_types]
+    except ContentType.DoesNotExist:
+        continue
+
+    webhook, created = Webhook.objects.get_or_create(**hook)
+    if created:
+        webhook.content_types.set(obj_type_ids)
+        webhook.save()
+
+        print("🪝 Created Webhook {0}".format(webhook.name))

startup_scripts/070_rack_roles.py

@@ -1,28 +0,0 @@
-from dcim.models import RackRole
-from ruamel.yaml import YAML
-from utilities.forms import COLOR_CHOICES
-
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/rack_roles.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml=YAML(typ='safe')
-  rack_roles = yaml.load(stream)
-
-  if rack_roles is not None:
-    for params in rack_roles:
-      if 'color' in params:
-        color = params.pop('color')
-
-        for color_tpl in COLOR_CHOICES:
-          if color in color_tpl:
-            params['color'] = color_tpl[0]
-
-      rack_role, created = RackRole.objects.get_or_create(**params)
-
-      if created:
-        print("🎨 Created rack role", rack_role.name)

startup_scripts/070_tenant_groups.py

@@ -0,0 +1,15 @@
+import sys
+
+from startup_script_utils import load_yaml
+from tenancy.models import TenantGroup
+
+tenant_groups = load_yaml("/opt/netbox/initializers/tenant_groups.yml")
+
+if tenant_groups is None:
+    sys.exit()
+
+for params in tenant_groups:
+    tenant_group, created = TenantGroup.objects.get_or_create(**params)
+
+    if created:
+        print("🔳 Created Tenant Group", tenant_group.name)

startup_scripts/075_rack_groups.py

@@ -1,31 +0,0 @@
-from dcim.models import Site,RackGroup
-from ruamel.yaml import YAML
-
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/rack_groups.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml=YAML(typ='safe')
-  rack_groups= yaml.load(stream)
-
-  required_assocs = {
-    'site': (Site, 'name')
-  }
-
-  if rack_groups is not None:
-    for params in rack_groups:
-
-      for assoc, details in required_assocs.items():
-        model, field = details
-        query = { field: params.pop(assoc) }
-        params[assoc] = model.objects.get(**query)
-
-      rack_group, created = RackGroup.objects.get_or_create(**params)
-
-      if created:
-        print("🎨 Created rack group", rack_group.name)
-

startup_scripts/080_racks.py

@@ -1,57 +0,0 @@
-from dcim.models import Site, RackRole, Rack, RackGroup
-from tenancy.models import Tenant
-from extras.models import CustomField, CustomFieldValue
-from ruamel.yaml import YAML
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/racks.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml = YAML(typ='safe')
-  racks = yaml.load(stream)
-
-  required_assocs = {
-    'site': (Site, 'name')
-  }
-
-  optional_assocs = {
-    'role': (RackRole, 'name'),
-    'tenant': (Tenant, 'name'),
-    'group': (RackGroup, 'name')
-  }
-
-  if racks is not None:
-    for params in racks:
-      custom_fields = params.pop('custom_fields', None)
-
-      for assoc, details in required_assocs.items():
-        model, field = details
-        query = { field: params.pop(assoc) }
-
-        params[assoc] = model.objects.get(**query)
-
-      for assoc, details in optional_assocs.items():
-        if assoc in params:
-          model, field = details
-          query = { field: params.pop(assoc) }
-
-          params[assoc] = model.objects.get(**query)
-
-      rack, created = Rack.objects.get_or_create(**params)
-
-      if created:
-        if custom_fields is not None:
-          for cf_name, cf_value in custom_fields.items():
-            custom_field = CustomField.objects.get(name=cf_name)
-            custom_field_value = CustomFieldValue.objects.create(
-              field=custom_field,
-              obj=rack,
-              value=cf_value
-            )
-
-            rack.custom_field_values.add(custom_field_value)
-
-        print("🔳 Created rack", rack.site, rack.name)

startup_scripts/080_tenants.py

@@ -0,0 +1,28 @@
+import sys
+
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
+from tenancy.models import Tenant, TenantGroup
+
+tenants = load_yaml("/opt/netbox/initializers/tenants.yml")
+
+if tenants is None:
+    sys.exit()
+
+optional_assocs = {"group": (TenantGroup, "name")}
+
+for params in tenants:
+    custom_field_data = pop_custom_fields(params)
+
+    for assoc, details in optional_assocs.items():
+        if assoc in params:
+            model, field = details
+            query = {field: params.pop(assoc)}
+
+            params[assoc] = model.objects.get(**query)
+
+    tenant, created = Tenant.objects.get_or_create(**params)
+
+    if created:
+        set_custom_fields_values(tenant, custom_field_data)
+
+        print("👩‍💻 Created Tenant", tenant.name)

startup_scripts/090_device_roles.py

@@ -1,29 +0,0 @@
-from dcim.models import DeviceRole
-from ruamel.yaml import YAML
-from utilities.forms import COLOR_CHOICES
-
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/device_roles.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml=YAML(typ='safe')
-  device_roles = yaml.load(stream)
-
-  if device_roles is not None:
-    for params in device_roles:
-
-      if 'color' in params:
-        color = params.pop('color')
-
-        for color_tpl in COLOR_CHOICES:
-          if color in color_tpl:
-            params['color'] = color_tpl[0]
-
-      device_role, created = DeviceRole.objects.get_or_create(**params)
-
-      if created:
-        print("🎨 Created device role", device_role.name)

startup_scripts/090_regions.py

@@ -0,0 +1,25 @@
+import sys
+
+from dcim.models import Region
+from startup_script_utils import load_yaml
+
+regions = load_yaml("/opt/netbox/initializers/regions.yml")
+
+if regions is None:
+    sys.exit()
+
+optional_assocs = {"parent": (Region, "name")}
+
+for params in regions:
+
+    for assoc, details in optional_assocs.items():
+        if assoc in params:
+            model, field = details
+            query = {field: params.pop(assoc)}
+
+            params[assoc] = model.objects.get(**query)
+
+    region, created = Region.objects.get_or_create(**params)
+
+    if created:
+        print("🌐 Created region", region.name)

startup_scripts/100_platforms.py

@@ -1,32 +0,0 @@
-from dcim.models import Manufacturer, Platform
-from ruamel.yaml import YAML
-
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/platforms.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml = YAML(typ='safe')
-  platforms = yaml.load(stream)
-
-  optional_assocs = {
-    'manufacturer': (Manufacturer, 'name'),
-  }
-
-  if platforms is not None:
-    for params in platforms:
-
-      for assoc, details in optional_assocs.items():
-        if assoc in params:
-          model, field = details
-          query = { field: params.pop(assoc) }
-
-          params[assoc] = model.objects.get(**query)
-
-      platform, created = Platform.objects.get_or_create(**params)
-
-      if created:
-        print("💾 Created platform", platform.name)

startup_scripts/110_sites.py

@@ -0,0 +1,29 @@
+import sys
+
+from dcim.models import Region, Site
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
+from tenancy.models import Tenant
+
+sites = load_yaml("/opt/netbox/initializers/sites.yml")
+
+if sites is None:
+    sys.exit()
+
+optional_assocs = {"region": (Region, "name"), "tenant": (Tenant, "name")}
+
+for params in sites:
+    custom_field_data = pop_custom_fields(params)
+
+    for assoc, details in optional_assocs.items():
+        if assoc in params:
+            model, field = details
+            query = {field: params.pop(assoc)}
+
+            params[assoc] = model.objects.get(**query)
+
+    site, created = Site.objects.get_or_create(**params)
+
+    if created:
+        set_custom_fields_values(site, custom_field_data)
+
+        print("📍 Created site", site.name)

startup_scripts/110_tenant_groups.py

@@ -1,19 +0,0 @@
-from tenancy.models import TenantGroup
-from ruamel.yaml import YAML
-from pathlib import Path
-import sys
-
-file = Path('/opt/netbox/initializers/tenant_groups.yml')
-if not file.is_file():
-  sys.exit()
-
-with file.open('r') as stream:
-  yaml = YAML(typ='safe')
-  tenant_groups = yaml.load(stream)
-
-  if tenant_groups is not None:
-    for params in tenant_groups:
-      tenant_group, created = TenantGroup.objects.get_or_create(**params)
-
-      if created:
-        print("🔳 Created Tenant Group", tenant_group.name)

startup_scripts/120_locations.py

@@ -0,0 +1,23 @@
+import sys
+
+from dcim.models import Location, Site
+from startup_script_utils import load_yaml
+
+rack_groups = load_yaml("/opt/netbox/initializers/locations.yml")
+
+if rack_groups is None:
+    sys.exit()
+
+required_assocs = {"site": (Site, "name")}
+
+for params in rack_groups:
+
+    for assoc, details in required_assocs.items():
+        model, field = details
+        query = {field: params.pop(assoc)}
+        params[assoc] = model.objects.get(**query)
+
+    location, created = Location.objects.get_or_create(**params)
+
+    if created:
+        print("🎨 Created location", location.name)