Merge pull request #839 from netbox-community/develop

Version 2.2.0

.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/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/workflows/push.yml

@@ -1,3 +1,4 @@
+---
 name: push
 
 on:
@@ -9,31 +10,70 @@ on:
       - release
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Checks syntax of our code
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+      - 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
+          YAML_CONFIG_FILE: .yamllint.yaml
   build:
+    continue-on-error: ${{ matrix.build_cmd != './build-latest.sh' }}
     strategy:
       matrix:
         build_cmd:
-        - ./build-latest.sh
-        - PRERELEASE=true ./build-latest.sh
-        - ./build-next.sh
-        - ./build.sh develop
-        docker_from:
-        - '' # use the default of the build script
-        # - python:3.10-rc-alpine # disable until dependencies work
+          - ./build-latest.sh
+          - PRERELEASE=true ./build-latest.sh
+          - ./build.sh feature
+          - ./build.sh develop
+        platform:
+          - linux/amd64
+          - linux/arm64
       fail-fast: false
+    env:
+      GH_ACTION: enable
+      IMAGE_NAMES: docker.io/netboxcommunity/netbox
     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
-    - id: docker-build
-      name: Build the image from '${{ matrix.docker_from }}' with '${{ matrix.build_cmd }}'
-      run: ${{ matrix.build_cmd }}
-      env:
-        DOCKER_FROM: ${{ matrix.docker_from }}
-        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: git-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+      - id: qemu-setup
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - id: buildx-setup
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - id: docker-build
+        name: Build the image for '${{ matrix.platform }}' with '${{ matrix.build_cmd }}'
+        run: ${{ matrix.build_cmd }}
+        env:
+          BUILDX_PLATFORM: ${{ matrix.platform }}
+          BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
+      - id: docker-test
+        name: Test the image
+        run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
+        if: steps.docker-build.outputs.skipped != 'true'

.github/workflows/release.yml

@@ -1,83 +1,83 @@
+---
 name: release
 
 on:
-  push:
-    branches:
-      - release
+  release:
+    types:
+      - published
   schedule:
     - cron: '45 5 * * *'
+  workflow_dispatch:
 
 jobs:
   build:
     strategy:
       matrix:
         build_cmd:
-        - ./build-latest.sh
-        - PRERELEASE=true ./build-latest.sh
-        - ./build-next.sh
-        - ./build.sh develop
+          - ./build-latest.sh
+          - PRERELEASE=true ./build-latest.sh
+          - ./build.sh feature
+          - ./build.sh develop
+        platform:
+          - linux/amd64,linux/arm64
       fail-fast: false
     runs-on: ubuntu-latest
-    name: Builds new Netbox Docker Images
+    name: Builds new NetBox Docker Images
+    env:
+      GH_ACTION: enable
+      IMAGE_NAMES: docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox ghcr.io/netbox-community/netbox
     steps:
-    - id: git-checkout
-      name: Checkout
-      uses: actions/checkout@v2
-    - 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
-      run: |
-        echo "::add-mask::$DOCKERHUB_USERNAME"
-        echo "::add-mask::$DOCKERHUB_PASSWORD"
-        docker login -u "$DOCKERHUB_USERNAME" --password "${DOCKERHUB_PASSWORD}" "${DOCKER_REGISTRY}"
-      env:
-        DOCKERHUB_USERNAME: ${{ secrets.dockerhub_username }}
-        DOCKERHUB_PASSWORD: ${{ secrets.dockerhub_password }}
-      if: steps.docker-build.outputs.skipped != 'true'
-    - id: registry-push
-      name: Push the image
-      run: ${{ matrix.build_cmd }} --push-only
-      if: steps.docker-build.outputs.skipped != 'true'
-    - id: registry-logout
-      name: Logout of the Docker Registry
-      run: docker logout "${DOCKER_REGISTRY}"
-      if: steps.docker-build.outputs.skipped != 'true'
-
-    # Quay.io
-    - id: quayio-docker-build
-      name: Build the image with '${{ matrix.build_cmd }}'
-      run: ${{ matrix.build_cmd }}
-      env:
-        DOCKER_REGISTRY: quay.io
-        GH_ACTION: enable
-    - id: quayio-registry-login
-      name: Login to the Quay.io Registry
-      run: |
-        echo "::add-mask::$QUAYIO_USERNAME"
-        echo "::add-mask::$QUAYIO_PASSWORD"
-        docker login -u "$QUAYIO_USERNAME" --password "${QUAYIO_PASSWORD}" "${DOCKER_REGISTRY}"
-      env:
-        DOCKER_REGISTRY: quay.io
-        QUAYIO_USERNAME: ${{ secrets.quayio_username }}
-        QUAYIO_PASSWORD: ${{ secrets.quayio_password }}
-      if: steps.docker-build.outputs.skipped != 'true'
-    - id: quayio-registry-push
-      name: Push the image
-      run: ${{ matrix.build_cmd }} --push-only
-      env:
-        DOCKER_REGISTRY: quay.io
-      if: steps.docker-build.outputs.skipped != 'true'
-    - id: quayio-registry-logout
-      name: Logout of the Docker Registry
-      run: docker logout "${DOCKER_REGISTRY}"
-      env:
-        DOCKER_REGISTRY: quay.io
-      if: steps.docker-build.outputs.skipped != 'true'
+      - id: source-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+      - id: set-netbox-docker-version
+        name: Get Version of NetBox Docker
+        run: echo "::set-output name=version::$(cat VERSION)"
+        shell: bash
+      - id: qemu-setup
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - id: buildx-setup
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - id: docker-build
+        name: Build the image with '${{ matrix.build_cmd }}'
+        run: ${{ matrix.build_cmd }}
+      - id: test-image
+        name: Test the image
+        run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
+        if: steps.docker-build.outputs.skipped != 'true'
+      # docker.io
+      - id: docker-io-login
+        name: Login to docker.io
+        uses: docker/login-action@v2
+        with:
+          registry: docker.io
+          username: ${{ secrets.dockerhub_username }}
+          password: ${{ secrets.dockerhub_password }}
+        if: steps.docker-build.outputs.skipped != 'true'
+      # quay.io
+      - id: quay-io-login
+        name: Login to Quay.io
+        uses: docker/login-action@v2
+        with:
+          registry: quay.io
+          username: ${{ secrets.quayio_username }}
+          password: ${{ secrets.quayio_password }}
+        if: steps.docker-build.outputs.skipped != 'true'
+      # ghcr.io
+      - id: ghcr-io-login
+        name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+        if: steps.docker-build.outputs.skipped != 'true'
+      - id: build-and-push
+        name: Push the image
+        run: ${{ matrix.build_cmd }} --push
+        if: steps.docker-build.outputs.skipped != 'true'
+        env:
+          BUILDX_PLATFORM: ${{ matrix.platform }}
+          BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}

.gitignore

@@ -7,5 +7,9 @@ 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,4 @@
+ignored:
+- DL3006
+- DL3008
+- DL3003

.markdown-lint.yml

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

.yamllint.yaml

@@ -0,0 +1,5 @@
+---
+
+rules:
+  line-length:
+    max: 120

Dockerfile

@@ -1,38 +1,32 @@
 ARG FROM
 FROM ${FROM} as builder
 
-RUN apk add --no-cache \
-      bash \
-      build-base \
+RUN export DEBIAN_FRONTEND=noninteractive \
+    && apt-get update -qq \
+    && apt-get upgrade \
+      --yes -qq --no-install-recommends \
+    && apt-get install \
+      --yes -qq --no-install-recommends \
+      build-essential \
       ca-certificates \
-      cyrus-sasl-dev \
-      graphviz \
-      jpeg-dev \
-      libevent-dev \
-      libffi-dev \
-      libxslt-dev \
-      openldap-dev \
-      postgresql-dev
-
-WORKDIR /install
-
-RUN pip install --prefix="/install" --no-warn-script-location \
-# gunicorn is used for launching netbox
-      gunicorn \
-      greenlet \
-      eventlet \
-# napalm is used for gathering information from network devices
-      napalm \
-# ruamel is used in startup_scripts
-      'ruamel.yaml>=0.15,<0.16' \
-# django_auth_ldap is required for ldap
-      django_auth_ldap \
-# django-storages was introduced in 2.7 and is optional
-      django-storages
+      libldap-dev \
+      libpq-dev \
+      libsasl2-dev \
+      libssl-dev \
+      python3-dev \
+      python3-pip \
+      python3-venv \
+    && python3 -m venv /opt/netbox/venv \
+    && /opt/netbox/venv/bin/python3 -m pip install --upgrade \
+      pip \
+      setuptools \
+      wheel
 
 ARG NETBOX_PATH
-COPY ${NETBOX_PATH}/requirements.txt /
-RUN pip install --prefix="/install" --no-warn-script-location -r /requirements.txt
+COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
+RUN /opt/netbox/venv/bin/pip install \
+      -r /requirements.txt \
+      -r /requirements-container.txt
 
 ###
 # Main stage
@@ -41,66 +35,69 @@ RUN pip install --prefix="/install" --no-warn-script-location -r /requirements.t
 ARG FROM
 FROM ${FROM} as main
 
-RUN apk add --no-cache \
-      bash \
+RUN export DEBIAN_FRONTEND=noninteractive \
+    && apt-get update -qq \
+    && apt-get upgrade \
+      --yes -qq --no-install-recommends \
+    && apt-get install \
+      --yes -qq --no-install-recommends \
+      bzip2 \
       ca-certificates \
-      graphviz \
-      libevent \
-      libffi \
-      libjpeg-turbo \
-      libressl \
-      libxslt \
-      postgresql-libs \
-      ttf-ubuntu-font-family
+      curl \
+      libldap-common \
+      libpq5 \
+      openssl \
+      python3 \
+      python3-distutils \
+      tini \
+    && curl -sL https://nginx.org/keys/nginx_signing.key \
+      > /etc/apt/trusted.gpg.d/nginx.asc && \
+    echo "deb https://packages.nginx.org/unit/ubuntu/ jammy unit" \
+      > /etc/apt/sources.list.d/unit.list \
+    && apt-get update -qq \
+    && apt-get install \
+      --yes -qq --no-install-recommends \
+      unit=1.27.0-1~jammy \
+      unit-python3.10=1.27.0-1~jammy \
+    && rm -rf /var/lib/apt/lists/*
 
-WORKDIR /opt
-
-COPY --from=builder /install /usr/local
+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 docker/gunicorn_config.py /etc/netbox/
-COPY docker/nginx.conf /etc/netbox-nginx/nginx.conf
+COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
 COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh
-COPY startup_scripts/ /opt/netbox/startup_scripts/
-COPY initializers/ /opt/netbox/initializers/
+COPY docker/housekeeping.sh /opt/netbox/housekeeping.sh
+COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
 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 -R 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" ]
+ENV LANG=C.UTF-8 PATH=/opt/netbox/venv/bin:$PATH
+ENTRYPOINT [ "/usr/bin/tini", "--" ]
 
-CMD ["gunicorn", "-c /etc/netbox/gunicorn_config.py", "netbox.wsgi"]
+CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
 
-LABEL ORIGINAL_TAG="" \
-      NETBOX_GIT_BRANCH="" \
-      NETBOX_GIT_REF="" \
-      NETBOX_GIT_URL="" \
-# See http://label-schema.org/rc1/#build-time-labels
-# 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.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" \
-      org.label-schema.vcs-url="https://github.com/netbox-community/netbox-docker.git" \
-      org.label-schema.vcs-ref="" \
-      org.label-schema.version="snapshot" \
+LABEL netbox.original-tag="" \
+      netbox.git-branch="" \
+      netbox.git-ref="" \
+      netbox.git-url="" \
 # 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.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
+      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.licenses="Apache-2.0" \
       org.opencontainers.image.authors="The netbox-docker contributors." \
       org.opencontainers.image.vendor="The netbox-docker contributors." \
@@ -108,17 +105,4 @@ LABEL ORIGINAL_TAG="" \
       org.opencontainers.image.documentation="https://github.com/netbox-community/netbox-docker/wiki" \
       org.opencontainers.image.source="https://github.com/netbox-community/netbox-docker.git" \
       org.opencontainers.image.revision="" \
-      org.opencontainers.image.version="snapshot"
-
-#####
-## LDAP specific configuration
-#####
-
-FROM main as ldap
-
-RUN apk add --no-cache \
-      libsasl \
-      libldap \
-      util-linux
-
-COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
+      org.opencontainers.image.version=""

README.md

@@ -5,49 +5,29 @@
 ![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.
-Images are built using this code and are released to [Docker Hub][netbox-dockerhub] and [Quay.io][netbox-quayio] once a day.
+[The GitHub repository][netbox-docker-github] houses the components needed to build NetBox as a container.
+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.
+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/
-[netbox-docker-github]: https://github.com/netbox-community/netbox-docker/
-[ntc-slack]: http://slack.networktocode.com/
-[netbox-docker-slack]: https://slack.com/app_redirect?channel=netbox-docker&team=T09LQ7E9E
-[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
 [netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox
-
-## Docker Tags
-
-* `vX.Y.Z`: These are release builds, automatically built from [the corresponding releases of Netbox][netbox-releases].
-* `latest`: These are release builds, automatically built from [the `master` branch of Netbox][netbox-master].
-* `snapshot`: These are pre-release builds, automatically built from the [`develop` branch of Netbox][netbox-develop].
-* `develop-X.Y`: These are pre-release builds, automatically built from the corresponding [branch of Netbox][netbox-branches].
-
-Then there is currently one extra tags for each of the above tags:
-
-* `-ldap`: Contains additional dependencies and configurations for connecting Netbox to an LDAP directory.
-  [Learn more about that in our wiki][netbox-docker-ldap].
-
-New images are built and published automatically every ~24h.
-
-[netbox-releases]: https://github.com/netbox-community/netbox/releases
-[netbox-master]: https://github.com/netbox-community/netbox/tree/master
-[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
-[netbox-branches]: https://github.com/netbox-community/netbox/branches
-[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP
+[netbox-ghcr]: https://github.com/netbox-community/netbox-docker/pkgs/container/netbox
+[netbox-docker-github]: https://github.com/netbox-community/netbox-docker/
+[netbox-docker-slack]: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
+[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
 
 ## Quickstart
 
-To get Netbox Docker up and running run the following commands.
+To get _NetBox Docker_ up and running run the following commands.
 There is a more complete [_Getting Started_ guide on our wiki][wiki-getting-started] which explains every step.
 
 ```bash
@@ -56,7 +36,7 @@ cd netbox-docker
 tee docker-compose.override.yml <<EOF
 version: '3.4'
 services:
-  nginx:
+  netbox:
     ports:
       - 8000:8080
 EOF
@@ -66,7 +46,7 @@ docker-compose up
 
 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.
+You should see the NetBox homepage.
 In the top-right corner you can login.
 The default credentials are:
 
@@ -75,74 +55,89 @@ The default credentials are:
 * 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_.
+
+[netbox-releases]: https://github.com/netbox-community/netbox/releases
+[netbox-master]: https://github.com/netbox-community/netbox/tree/master
+[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
 
 ## Documentation
 
-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 files for secrets, deployment to Kubernetes, monitoring and configuring NAPALM or LDAP.
+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.
+
+Our wiki is a community effort.
+Feel free to correct errors, update outdated information or provide additional guides and insights.
 
 [netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
 
 ## Getting Help
 
-Feel free to ask questions in our [Github Community][netbox-community] or join [our Slack channel `#netbox-docker`][netbox-docker-slack] on the [Network To Code Slack][ntc-slack],
+Feel free to ask questions in our [GitHub Community][netbox-community]
+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.
 
-If you need help with using Netbox or developing for it or against it's API you may find the `#netbox` channel on the same Slack instance very helpful.
+If you need help with using NetBox or developing for it or against it's API
+you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.
 
 [netbox-community]: https://github.com/netbox-community/netbox-docker/discussions
 
 ## Dependencies
 
-This project relies only on *Docker* and *docker-compose* meeting these requirements:
+This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
 
-* The *Docker version* must be at least `17.05`.
-* The *docker-compose version* must be at least `1.17.0`.
+* The _Docker version_ must be at least `20.10.10`.
+* The _containerd version_ must be at least `1.5.6`.
+* 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`.
 
-## Use a Specific Netbox Version
-
-The `docker-compose.yml` file is prepared to run a specific version of Netbox, instead of `latest`.
-To use this feature, set and export 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] or [Quay.io][netbox-quayio].
-
-```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}}"`.
+## Updating
 
 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].
 
@@ -151,14 +146,13 @@ For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
 ## 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].
-
-[nxt]: https://nxt.engineering/en/
+This repository is currently maintained by the community.
+Please consider sponsoring the maintainers of this project.

VERSION

@@ -1 +1 @@
-0.27.0
+2.2.0

build-functions/docker-functions.sh

@@ -1,8 +0,0 @@
-#!/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

@@ -45,16 +45,16 @@ _get_image_configuration() {
     --silent \
     --location \
     --header "Authorization: Bearer $token" \
-    "https://registry-1.docker.io/v2/$image/blobs/$digest" \
-    | jq -r ".config.Labels.\"$label\""
+    "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'
+    "https://auth.docker.io/token?scope=repository:$image:pull&service=registry.docker.io" |
+    jq -r '.token'
 }
 
 _get_digest() {
@@ -65,8 +65,8 @@ _get_digest() {
     --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'
+    "https://registry-1.docker.io/v2/$image/manifests/$tag" |
+    jq -r '.config.digest'
 }
 
 _get_layers() {
@@ -77,6 +77,6 @@ _get_layers() {
     --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'
+    "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}" ] \
-       && [ "${MINOR_STABLE}" -ge "${MINOR_UNSTABLE}" ];
-     } || [ "${MAJOR_STABLE}" -gt "${MAJOR_UNSTABLE}" ]; then
+  if {
+    [ "${MAJOR_STABLE}" -eq "${MAJOR_UNSTABLE}" ] &&
+      [ "${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-next.sh

@@ -1,39 +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_NEXT='map(.name) | .[] | scan("^[^v].+") | match("^(develop-).*") | .string'
-
-CURL="curl -sS"
-
-# Querying the Github API to fetch all branches
-NEXT=$($CURL "${URL_RELEASES}" | jq -r "$JQ_NEXT")
-
-if [ -n "$NEXT" ]; then
-  # shellcheck disable=SC2068
-  ./build.sh "${NEXT}" $@
-else
-  echo "No branch matching 'develop-*' found"
-  echo "::set-output name=skipped::true"
-fi

build.sh

@@ -1,15 +1,14 @@
 #!/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 $*"
 
 set -e
 
 if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
-  echo "Usage: ${0} <branch> [--push|--push-only]"
+  echo "Usage: ${0} <branch> [--push]"
   echo "  branch       The branch or tag to build. Required."
   echo "  --push       Pushes the built Docker image to the registry."
-  echo "  --push-only  Only pushes the Docker image to the registry, but does not build it."
   echo ""
   echo "You can use the following ENV variables to customize the build:"
   echo "  SRC_ORG     Which fork of netbox to use (i.e. github.com/\${SRC_ORG}/\${SRC_REPO})."
@@ -30,15 +29,10 @@ if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
   echo "                When <branch>=master:  latest"
   echo "                When <branch>=develop: snapshot"
   echo "                Else:                  same as <branch>"
-  echo "  DOCKER_REGISTRY The Docker repository's registry (i.e. '\${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}'')"
+  echo "  IMAGE_NAMES The names used for the image including the registry"
   echo "              Used for tagging the image."
-  echo "              Default: docker.io"
-  echo "  DOCKER_ORG  The Docker repository's organisation (i.e. '\${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}'')"
-  echo "              Used for tagging the image."
-  echo "              Default: netboxcommunity"
-  echo "  DOCKER_REPO The Docker repository's name (i.e. '\${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}'')"
-  echo "              Used for tagging the image."
-  echo "              Default: netbox"
+  echo "              Default: docker.io/netboxcommunity/netbox"
+  echo "              Example: 'docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox'"
   echo "  DOCKER_TAG  The name of the tag which is applied to the image."
   echo "              Useful for pushing into another registry than hub.docker.com."
   echo "              Default: \${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}:\${TAG}"
@@ -49,10 +43,25 @@ 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: 'python:3.9-alpine'"
-  echo "  DOCKER_TARGET A specific target to build."
-  echo "              It's currently not possible to pass multiple targets."
-  echo "              Default: main ldap"
+  echo "              Default: 'ubuntu:22.04'"
+  echo "  BUILDX_PLATFORMS"
+  echo "            Specifies the platform(s) to build the image for."
+  echo "            Example: 'linux/amd64,linux/arm64'"
+  echo "            Default: 'linux/amd64'"
+  echo "  BUILDX_BUILDER_NAME"
+  echo "              If defined, the image build will be assigned to the given builder."
+  echo "              If you specify this variable, make sure that the builder exists."
+  echo "              If this value is not defined, a new builx builder with the directory name of the"
+  echo "              current directory (i.e. '$(basename "${PWD}")') is created."
+  echo "              Example: 'clever_lovelace'"
+  echo "              Default: undefined"
+  echo "  BUILDX_REMOVE_BUILDER"
+  echo "              If defined (and only if BUILDX_BUILDER_NAME is undefined),"
+  echo "              then the buildx builder created by this script will be removed after use."
+  echo "              This is useful if you build NetBox Docker on an automated system that does"
+  echo "              not manage the builders for you."
+  echo "              Example: 'on'"
+  echo "              Default: undefined"
   echo "  HTTP_PROXY  The proxy to use for http requests."
   echo "              Example: http://proxy.domain.tld:3128"
   echo "              Default: undefined"
@@ -95,6 +104,11 @@ if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
   fi
 fi
 
+source ./build-functions/gh-functions.sh
+
+IMAGE_NAMES="${IMAGE_NAMES-docker.io/netboxcommunity/netbox}"
+IFS=' ' read -ra IMAGE_NAMES <<<"${IMAGE_NAMES}"
+
 ###
 # Enabling dry-run mode
 ###
@@ -105,8 +119,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 +131,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
-  echo "🌐 Checking out '${NETBOX_BRANCH}' of netbox from the url '${URL}' into '${NETBOX_PATH}'"
+if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ]; then
+  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 +157,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
@@ -157,7 +182,7 @@ fi
 # Determining the value for DOCKER_FROM
 ###
 if [ -z "$DOCKER_FROM" ]; then
-  DOCKER_FROM="python:3.9-alpine"
+  DOCKER_FROM="ubuntu:22.04"
 fi
 
 ###
@@ -165,7 +190,7 @@ fi
 ###
 BUILD_DATE="$(date -u '+%Y-%m-%dT%H:%M+00:00')"
 
-if [ -d ".git" ]; then
+if [ -d ".git" ] && [ -z "${SKIP_GIT}" ]; then
   GIT_REF="$(git rev-parse HEAD)"
 fi
 
@@ -173,10 +198,19 @@ fi
 PROJECT_VERSION="${PROJECT_VERSION-$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' VERSION)}"
 
 # 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_BRANCH=$(cd "${NETBOX_PATH}"; git rev-parse --abbrev-ref HEAD)
-  NETBOX_GIT_URL=$(cd "${NETBOX_PATH}"; git remote get-url origin)
+if [ -d "${NETBOX_PATH}/.git" ] && [ -z "${SKIP_GIT}" ]; then
+  NETBOX_GIT_REF=$(
+    cd "${NETBOX_PATH}"
+    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
 
 ###
@@ -186,187 +220,206 @@ DOCKER_REGISTRY="${DOCKER_REGISTRY-docker.io}"
 DOCKER_ORG="${DOCKER_ORG-netboxcommunity}"
 DOCKER_REPO="${DOCKER_REPO-netbox}"
 case "${NETBOX_BRANCH}" in
-  master)
-    TAG="${TAG-latest}";;
-  develop)
-    TAG="${TAG-snapshot}";;
-  *)
-    TAG="${TAG-$NETBOX_BRANCH}";;
+master)
+  TAG="${TAG-latest}"
+  ;;
+develop)
+  TAG="${TAG-snapshot}"
+  ;;
+*)
+  TAG="${TAG-$NETBOX_BRANCH}"
+  ;;
 esac
 
 ###
-# Determine targets to build
+# composing the final TARGET_DOCKER_TAG
 ###
-DEFAULT_DOCKER_TARGETS=("main" "ldap")
-DOCKER_TARGETS=( "${DOCKER_TARGET:-"${DEFAULT_DOCKER_TARGETS[@]}"}")
-echo "🏭 Building the following targets:" "${DOCKER_TARGETS[@]}"
+TARGET_DOCKER_TAG="${DOCKER_TAG-${TAG}}"
+TARGET_DOCKER_TAG_PROJECT="${TARGET_DOCKER_TAG}-${PROJECT_VERSION}"
 
 ###
-# Build each target
+# 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
 ###
-export DOCKER_BUILDKIT=${DOCKER_BUILDKIT-1}
-for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
-  echo "🏗 Building the target '${DOCKER_TARGET}'"
+if [[ "${TAG}" =~ ^v([0-9]+)\.([0-9]+)\.[0-9]+$ ]]; then
+  MAJOR=${BASH_REMATCH[1]}
+  MINOR=${BASH_REMATCH[2]}
 
-  ###
-  # composing the final TARGET_DOCKER_TAG
-  ###
-  TARGET_DOCKER_TAG="${DOCKER_TAG-${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_REPO}:${TAG}}"
-  if [ "${DOCKER_TARGET}" != "main" ]; then
-    TARGET_DOCKER_TAG="${TARGET_DOCKER_TAG}-${DOCKER_TARGET}"
-  fi
-  if [ -n "${GH_ACTION}" ]; then
-    echo "FINAL_DOCKER_TAG=${TARGET_DOCKER_TAG}" >> $GITHUB_ENV
-    echo "::set-output name=skipped::false"
-  fi
+  TARGET_DOCKER_SHORT_TAG="${DOCKER_SHORT_TAG-v${MAJOR}.${MINOR}}"
+  TARGET_DOCKER_LATEST_TAG="latest"
+  TARGET_DOCKER_SHORT_TAG_PROJECT="${TARGET_DOCKER_SHORT_TAG}-${PROJECT_VERSION}"
+  TARGET_DOCKER_LATEST_TAG_PROJECT="${TARGET_DOCKER_LATEST_TAG}-${PROJECT_VERSION}"
+fi
 
-  ###
-  # 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
-  fi
-
-  ###
-  # Proceeding to buils stage, except if `--push-only` is passed
-  ###
-  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} python"
-      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`
-    ###
-    DOCKER_BUILD_ARGS=(
-      --pull
-      --target "${DOCKER_TARGET}"
-      -f "${DOCKERFILE}"
-      -t "${TARGET_DOCKER_TAG}"
-    )
-    if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
-      DOCKER_BUILD_ARGS+=( -t "${TARGET_DOCKER_SHORT_TAG}" )
-      DOCKER_BUILD_ARGS+=( -t "${TARGET_DOCKER_LATEST_TAG}" )
-    fi
-
-    # --label
-    DOCKER_BUILD_ARGS+=(
-      --label "ORIGINAL_TAG=${TARGET_DOCKER_TAG}"
-
-      --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 "org.label-schema.vcs-ref=${GIT_REF}"
-        --label "org.opencontainers.image.revision=${GIT_REF}"
-      )
-    fi
-    if [ -d "${NETBOX_PATH}/.git" ]; then
-      DOCKER_BUILD_ARGS+=(
-        --label "NETBOX_GIT_BRANCH=${NETBOX_GIT_BRANCH}"
-        --label "NETBOX_GIT_REF=${NETBOX_GIT_REF}"
-        --label "NETBOX_GIT_URL=${NETBOX_GIT_URL}"
-      )
-    fi
-    if [ -n "${BUILD_REASON}" ]; then
-      BUILD_REASON=$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' <<< "$BUILD_REASON")
-      DOCKER_BUILD_ARGS+=( --label "BUILD_REASON=${BUILD_REASON}" )
-    fi
-
-    # --build-arg
-    DOCKER_BUILD_ARGS+=(   --build-arg "NETBOX_PATH=${NETBOX_PATH}" )
-
-    if [ -n "${DOCKER_FROM}" ]; then
-      DOCKER_BUILD_ARGS+=( --build-arg "FROM=${DOCKER_FROM}" )
-    fi
-    if [ -n "${HTTP_PROXY}" ]; then
-      DOCKER_BUILD_ARGS+=( --build-arg "http_proxy=${HTTP_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}" )
-    fi
-
-    ###
-    # Building the docker image
-    ###
-    if [ "${SHOULD_BUILD}" == "true" ]; then
-      echo "🐳 Building the Docker image '${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}'"
-      echo "🔎 Inspecting labels on '${TARGET_DOCKER_TAG}'"
-      $DRY docker inspect "${TARGET_DOCKER_TAG}" --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
-    source ./build-functions/docker-functions.sh
-    push_image_to_registry "${TARGET_DOCKER_TAG}"
-
-    if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
-      push_image_to_registry "${TARGET_DOCKER_SHORT_TAG}"
-      push_image_to_registry "${TARGET_DOCKER_LATEST_TAG}"
-    fi
-  fi
+IMAGE_NAME_TAGS=()
+for IMAGE_NAME in "${IMAGE_NAMES[@]}"; do
+  IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_TAG}")
+  IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_TAG_PROJECT}")
 done
+if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
+  for IMAGE_NAME in "${IMAGE_NAMES[@]}"; do
+    IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_SHORT_TAG}")
+    IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_SHORT_TAG_PROJECT}")
+    IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_LATEST_TAG}")
+    IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_LATEST_TAG_PROJECT}")
+  done
+fi
+
+gh_env "FINAL_DOCKER_TAG=${IMAGE_NAME_TAGS[0]}"
+
+###
+# Checking if the build is necessary,
+# meaning build only if one of those values changed:
+# - base image digest
+# - netbox git ref (Label: netbox.git-ref)
+# - netbox-docker git ref (Label: org.opencontainers.image.revision)
+###
+# 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 [[ "${IMAGE_NAME_TAGS[0]}" = 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
+  IFS='/' read -ra ORG_REPO <<<"${IMAGE_NAMES[0]}"
+  echo "Checking labels for '${ORG_REPO[1]}' and '${ORG_REPO[2]}'"
+  BASE_LAST_LAYER=$(get_image_last_layer "${DOCKER_FROM_SPLIT[0]}" "${DOCKER_FROM_SPLIT[1]}")
+  mapfile -t IMAGES_LAYERS_OLD < <(get_image_layers "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
+  NETBOX_GIT_REF_OLD=$(get_image_label netbox.git-ref "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
+  GIT_REF_OLD=$(get_image_label org.opencontainers.image.revision "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
+
+  if ! printf '%s\n' "${IMAGES_LAYERS_OLD[@]}" | grep -q -P "^${BASE_LAST_LAYER}\$"; then
+    SHOULD_BUILD="true"
+    BUILD_REASON="${BUILD_REASON} debian"
+  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
+
+if [ "${SHOULD_BUILD}" != "true" ]; then
+  echo "Build skipped because sources didn't change"
+  echo "::set-output name=skipped::true"
+  exit 0 # Nothing to do -> exit
+else
+  gh_echo "::set-output name=skipped::false"
+fi
+gh_echo "::endgroup::"
+
+###
+# Build the image
+###
+gh_echo "::group::🏗 Building the image"
+###
+# Composing all arguments for `docker build`
+###
+DOCKER_BUILD_ARGS=(
+  --pull
+  --target main
+  -f "${DOCKERFILE}"
+)
+for IMAGE_NAME in "${IMAGE_NAME_TAGS[@]}"; do
+  DOCKER_BUILD_ARGS+=(-t "${IMAGE_NAME}")
+done
+
+# --label
+DOCKER_BUILD_ARGS+=(
+  --label "netbox.original-tag=${TARGET_DOCKER_TAG_PROJECT}"
+  --label "org.opencontainers.image.created=${BUILD_DATE}"
+  --label "org.opencontainers.image.version=${PROJECT_VERSION}"
+)
+if [ -d ".git" ] && [ -z "${SKIP_GIT}" ]; then
+  DOCKER_BUILD_ARGS+=(
+    --label "org.opencontainers.image.revision=${GIT_REF}"
+  )
+fi
+if [ -d "${NETBOX_PATH}/.git" ] && [ -z "${SKIP_GIT}" ]; then
+  DOCKER_BUILD_ARGS+=(
+    --label "netbox.git-branch=${NETBOX_GIT_BRANCH}"
+    --label "netbox.git-ref=${NETBOX_GIT_REF}"
+    --label "netbox.git-url=${NETBOX_GIT_URL}"
+  )
+fi
+if [ -n "${BUILD_REASON}" ]; then
+  BUILD_REASON=$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' <<<"$BUILD_REASON")
+  DOCKER_BUILD_ARGS+=(--label "netbox.build-reason=${BUILD_REASON}")
+fi
+
+# --build-arg
+DOCKER_BUILD_ARGS+=(--build-arg "NETBOX_PATH=${NETBOX_PATH}")
+
+if [ -n "${DOCKER_FROM}" ]; then
+  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 "https_proxy=${HTTPS_PROXY}")
+fi
+if [ -n "${NO_PROXY}" ]; then
+  DOCKER_BUILD_ARGS+=(--build-arg "no_proxy=${NO_PROXY}")
+fi
+
+DOCKER_BUILD_ARGS+=(--platform "${BUILDX_PLATFORM-linux/amd64}")
+if [ "${2}" == "--push" ]; then
+  # output type=docker does not work with pushing
+  DOCKER_BUILD_ARGS+=(
+    --output=type=image
+    --push
+  )
+else
+  DOCKER_BUILD_ARGS+=(
+    --output=type=docker
+  )
+fi
+
+###
+# Building the docker image
+###
+if [ -z "${BUILDX_BUILDER_NAME}" ]; then
+  BUILDX_BUILDER_NAME="$(basename "${PWD}")"
+fi
+if ! docker buildx ls | grep --quiet --word-regexp "${BUILDX_BUILDER_NAME}"; then
+  echo "👷  Creating new Buildx Builder '${BUILDX_BUILDER_NAME}'"
+  $DRY docker buildx create --name "${BUILDX_BUILDER_NAME}"
+  BUILDX_BUILDER_CREATED="yes"
+fi
+
+echo "🐳 Building the Docker image '${TARGET_DOCKER_TAG_PROJECT}'."
+echo "    Build reason set to: ${BUILD_REASON}"
+$DRY docker buildx \
+  --builder "${BUILDX_BUILDER_NAME}" \
+  build \
+  "${DOCKER_BUILD_ARGS[@]}" \
+  .
+echo "✅ Finished building the Docker images"
+gh_echo "::endgroup::" # End group for Build
+
+gh_echo "::group::🏗 Image Labels"
+echo "🔎 Inspecting labels on '${IMAGE_NAME_TAGS[0]}'"
+$DRY docker inspect "${IMAGE_NAME_TAGS[0]}" --format "{{json .Config.Labels}}" | jq
+gh_echo "::endgroup::"
+
+gh_echo "::group::🏗 Clean up"
+if [ -n "${BUILDX_REMOVE_BUILDER}" ] && [ "${BUILDX_BUILDER_CREATED}" == "yes" ]; then
+  echo "👷  Removing Buildx Builder '${BUILDX_BUILDER_NAME}'"
+  $DRY docker buildx rm "${BUILDX_BUILDER_NAME}"
+fi
+gh_echo "::endgroup::"

configuration/configuration.py

@@ -5,9 +5,8 @@
 ####
 
 import re
-
-from os.path import dirname, abspath, join
 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
@@ -39,16 +38,18 @@ ALLOWED_HOSTS = environ.get('ALLOWED_HOSTS', '*').split(' ')
 # 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': environ.get('DB_NAME', 'netbox'),            # Database name
-    'USER': environ.get('DB_USER', ''),                  # PostgreSQL username
+    'NAME': environ.get('DB_NAME', 'netbox'),       # Database name
+    'USER': environ.get('DB_USER', ''),             # PostgreSQL username
     'PASSWORD': _read_secret('db_password', environ.get('DB_PASSWORD', '')),
-                                                         # PostgreSQL password
-    'HOST': environ.get('DB_HOST', 'localhost'),         # Database server
-    'PORT': environ.get('DB_PORT', ''),                  # Database port (leave blank for default)
+                                                    # PostgreSQL password
+    'HOST': environ.get('DB_HOST', 'localhost'),    # Database server
+    'PORT': environ.get('DB_PORT', ''),             # Database port (leave blank for default)
     'OPTIONS': {'sslmode': environ.get('DB_SSLMODE', 'prefer')},
-                                                         # Database connection SSLMODE
+                                                    # Database connection SSLMODE
     'CONN_MAX_AGE': int(environ.get('DB_CONN_MAX_AGE', '300')),
-                                                         # Max database connection age
+                                                    # 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
@@ -61,6 +62,7 @@ REDIS = {
         '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')),
@@ -68,6 +70,7 @@ REDIS = {
         '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',
     },
 }
 
@@ -107,9 +110,6 @@ BANNER_LOGIN = environ.get('BANNER_LOGIN', '')
 # BASE_PATH = 'netbox/'
 BASE_PATH = environ.get('BASE_PATH', '')
 
-# Cache timeout in seconds. Set to 0 to dissable caching. Defaults to 900 (15 minutes)
-CACHE_TIMEOUT = int(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(environ.get('CHANGELOG_RETENTION', 90))
 
@@ -120,6 +120,11 @@ CORS_ORIGIN_ALLOW_ALL = environ.get('CORS_ORIGIN_ALLOW_ALL', 'False').lower() ==
 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, environ.get('CORS_ORIGIN_REGEX_WHITELIST', '').split(' ')))]
 
+# Cross-Site-Request-Forgery-Attack settings. If Netbox is sitting behind a reverse proxy, you might need to set the CSRF_TRUSTED_ORIGINS flag.
+# Django 4.0 requires to specify the URL Scheme in this setting. An example environment variable could be specified like:
+# CSRF_TRUSTED_ORIGINS=https://demo.netbox.dev http://demo.netbox.dev
+CSRF_TRUSTED_ORIGINS = list(filter(None, environ.get('CSRF_TRUSTED_ORIGINS', '').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.
@@ -147,6 +152,9 @@ ENFORCE_GLOBAL_UNIQUE = environ.get('ENFORCE_GLOBAL_UNIQUE', 'False').lower() ==
 # by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models.
 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/stable/topics/logging/
 LOGGING = {}
@@ -162,6 +170,9 @@ 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 = environ.get('MAINTENANCE_MODE', 'False').lower() == 'true'
 
+# Maps provider
+MAPS_URL = environ.get('MAPS_URL', None)
+
 # 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".
@@ -211,9 +222,6 @@ 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 determines how often the GitHub API is called to check the latest release of NetBox. Must be at least 1 hour.
-RELEASE_CHECK_TIMEOUT = int(environ.get('RELEASE_CHECK_TIMEOUT', 24 * 3600))
-
 # 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

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

@@ -1,9 +1,10 @@
-import ldap
-
-from django_auth_ldap.config import LDAPSearch
 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:
@@ -47,9 +48,11 @@ LDAP_IGNORE_CERT_ERRORS = environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower(
 
 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)")
+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.

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

@@ -7,47 +7,32 @@ services:
     - 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
+    - ./test-configuration/logging.py:/etc/netbox/config/logging.py: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.19-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:12-alpine
+    image: postgres:14-alpine
     env_file: env/postgres.env
   redis:
-    image: redis:6-alpine
+    image: redis:7-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
+    image: redis:7-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-cache.env
 volumes:
-  netbox-static-files:
-    driver: local
-  netbox-nginx-config:
-    driver: local
   netbox-media-files:
     driver: local

docker-compose.yml

@@ -1,55 +1,46 @@
 version: '3.4'
 services:
   netbox: &netbox
-    image: netboxcommunity/netbox:${VERSION-latest}
+    image: netboxcommunity/netbox:${VERSION-v3.3-2.2.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:
-    - python3
-    - /opt/netbox/netbox/manage.py
+    - postgres
     command:
+    - /opt/netbox/venv/bin/python
+    - /opt/netbox/netbox/manage.py
     - rqworker
-
-  # nginx
-  nginx:
-    command: nginx -c /etc/netbox-nginx/nginx.conf
-    image: nginx:1.19-alpine
+  netbox-housekeeping:
+    <<: *netbox
     depends_on:
-    - netbox
-    ports:
-    - 8080
-    volumes:
-    - netbox-static-files:/opt/netbox/netbox/static:ro
-    - netbox-nginx-config:/etc/netbox-nginx/:ro
+    - redis
+    - postgres
+    command:
+    - /opt/netbox/housekeeping.sh
 
   # postgres
   postgres:
-    image: postgres:12-alpine
+    image: postgres:14-alpine
     env_file: env/postgres.env
     volumes:
     - netbox-postgres-data:/var/lib/postgresql/data
 
   # redis
   redis:
-    image: redis:6-alpine
+    image: redis:7-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
@@ -58,7 +49,7 @@ services:
     volumes:
     - netbox-redis-data:/data
   redis-cache:
-    image: redis:6-alpine
+    image: redis:7-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
@@ -66,10 +57,6 @@ services:
     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

@@ -4,57 +4,61 @@
 #
 # They can be imported by other code (see `ldap_config.py` for an example).
 
-from os.path import abspath, isfile
-from os import scandir
 import importlib.util
 import sys
+from os import scandir
+from os.path import abspath, isfile
+
 
 def _filename(f):
-  return f.name
+    return f.name
 
 
 def _import(module_name, path, loaded_configurations):
-  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
+    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)
+    loaded_configurations.insert(0, module)
 
-  print(f"🧬 loaded config '{path}'")
+    print(f"🧬 loaded config '{path}'")
 
 
 def read_configurations(config_module, config_dir, main_config):
-  loaded_configurations = []
+    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.")
+    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
+    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 f.name.startswith("__"):
+                continue
 
-      if not f.name.endswith('.py'):
-        continue
+            if not f.name.endswith(".py"):
+                continue
 
-      if f.name == f'{config_dir}.py':
-        continue
+            if f.name == f"{main_config}.py":
+                continue
 
-      module_name = f"{config_module}.{f.name[:-len('.py')]}".replace(".", "_")
-      _import(module_name, f.path, loaded_configurations)
+            if f.name == f"{config_dir}.py":
+                continue
 
-  if len(loaded_configurations) == 0:
-    print(f"‼️ No configuration files found in '{config_dir}'.")
-    raise ImportError(f"No configuration files found in '{config_dir}'.")
+            module_name = f"{config_module}.{f.name[:-len('.py')]}".replace(".", "_")
+            _import(module_name, f.path, loaded_configurations)
 
-  return 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
@@ -65,15 +69,23 @@ def read_configurations(config_module, config_dir, main_config):
 
 
 _loaded_configurations = read_configurations(
-  config_dir = '/etc/netbox/config/',
-  config_module = 'netbox.configuration',
-  main_config = 'configuration')
+    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
+    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
@@ -32,17 +59,17 @@ else
     SUPERUSER_EMAIL='admin@example.com'
   fi
   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
     SUPERUSER_PASSWORD='admin'
   fi
   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
     SUPERUSER_API_TOKEN='0123456789abcdef0123456789abcdef01234567'
   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}'):
@@ -53,20 +80,17 @@ END
   echo "💡 Superuser Username: ${SUPERUSER_NAME}, E-Mail: ${SUPERUSER_EMAIL}"
 fi
 
-# Run the startup scripts (and initializers)
+# Print warning if startup scripts (and initializers) would've been run # Remove for next release
 if [ "$SKIP_STARTUP_SCRIPTS" == "true" ]; then
-  echo "↩️ Skipping startup scripts"
+  # Nothing to do
+  echo "" # Empty block not allowed
 else
-  echo "import runpy; runpy.run_path('../startup_scripts')" | ./manage.py shell --interface python
+  echo "⚠️⚠️⚠️ WARNING: The initializers have been moved to a plugin. See release notes."
+  echo "⚠️⚠️⚠️ Set environment variable 'SKIP_STARTUP_SCRIPTS' to 'true' to remove this warning."
 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)
-#
-# shellcheck disable=SC2068
-exec $@
+exec "$@"

docker/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 = 'info'

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,21 +1,23 @@
 from .configuration import read_configurations
 
 _loaded_configurations = read_configurations(
-  config_dir = '/etc/netbox/config/ldap/',
-  config_module = 'netbox.configuration.ldap',
-  main_config = 'ldap_config')
+    config_dir="/etc/netbox/config/ldap/",
+    config_module="netbox.configuration.ldap",
+    main_config="ldap_config",
+)
 
 
 def __getattr__(name):
-  for config in _loaded_configurations:
-    try:
-      return getattr(config, name)
-    except:
-      pass
-  raise AttributeError
+    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
+    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${uri}"
+      }
+    },
+
+    {
+      "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,44 +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;
-            add_header P3P 'CP="ALL DSP COR PSAa PSDa OUR NOR ONL UNI COM NAV"';
-        }
-    }
-
-    server {
-        listen      8081;
-        access_log  off;
-
-        location = /stub_status {
-            stub_status;
-        }
-    }
-}

env/netbox.env

@@ -1,39 +1,42 @@
 CORS_ORIGIN_ALLOW_ALL=True
-DB_NAME=netbox
-DB_USER=netbox
-DB_PASSWORD=J5brHrAXFLQSif0K
 DB_HOST=postgres
-EMAIL_SERVER=localhost
-EMAIL_PORT=25
-EMAIL_USERNAME=netbox
-EMAIL_PASSWORD=
-EMAIL_TIMEOUT=5
+DB_NAME=netbox
+DB_PASSWORD=J5brHrAXFLQSif0K
+DB_USER=netbox
 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
-EMAIL_SSL_CERTFILE=
-EMAIL_SSL_KEYFILE=
+GRAPHQL_ENABLED=true
+HOUSEKEEPING_INTERVAL=86400
 MAX_PAGE_SIZE=1000
 MEDIA_ROOT=/opt/netbox/netbox/media
 METRICS_ENABLED=false
-NAPALM_USERNAME=
 NAPALM_PASSWORD=
 NAPALM_TIMEOUT=10
-REDIS_HOST=redis
-REDIS_PASSWORD=H733Kdjndks81
-REDIS_DATABASE=0
-REDIS_SSL=false
-REDIS_CACHE_HOST=redis-cache
-REDIS_CACHE_PASSWORD=t4Ph722qJ5QHeQ1qfu36
+NAPALM_USERNAME=
 REDIS_CACHE_DATABASE=1
+REDIS_CACHE_HOST=redis-cache
+REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY=false
+REDIS_CACHE_PASSWORD=t4Ph722qJ5QHeQ1qfu36
 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,6 +0,0 @@
-# - prefix: 10.0.0.0/16
-#   rir: RFC1918
-# - prefix: fd00:ccdd::/32
-#   rir: RFC4193 ULA
-# - prefix: 2001:db8::/32
-#   rir: RFC3849

initializers/cluster_types.yml

@@ -1,2 +0,0 @@
-# - name: Hyper-V
-#   slug: hyper-v

initializers/clusters.yml

@@ -1,5 +0,0 @@
-# - name: cluster1
-#   type: Hyper-V
-# - name: cluster2
-#   type: Hyper-V
-#   site: SING 1

initializers/custom_fields.yml

@@ -1,93 +0,0 @@
-## Possible Choices:
-##   type:
-##   - text
-##   - integer
-##   - boolean
-##   - date
-##   - url
-##   - select
-##   filter_logic:
-##   - disabled
-##   - loose
-##   - exact
-##
-## Examples:
-
-# text_field:
-#   type: text
-#   label: Custom Text
-#   description: Enter text in a text field.
-#   required: false
-#   weight: 0
-#   on_objects:
-#   - dcim.models.Device
-#   - dcim.models.Rack
-#   - dcim.models.Site
-#   - dcim.models.DeviceType
-#   - ipam.models.IPAddress
-#   - ipam.models.Prefix
-#   - tenancy.models.Tenant
-#   - virtualization.models.VirtualMachine
-# integer_field:
-#   type: integer
-#   label: Custom Number
-#   description: Enter numbers into an integer field.
-#   required: true
-#   filter_logic: loose
-#   weight: 10
-#   on_objects:
-#   - tenancy.models.Tenant
-# select_field:
-#   type: select
-#   label: Choose between items
-#   required: false
-#   filter_logic: exact
-#   weight: 30
-#   default: First Item
-#   on_objects:
-#   - dcim.models.Device
-#   choices:
-#   - First Item
-#   - Second Item
-#   - Third Item
-#   - Fifth Item
-#   - Fourth Item
-# select_field_legacy_format:
-#    type: select
-#    label: Choose between items
-#    required: false
-#    filter_logic: loose
-#    weight: 30
-#    on_objects:
-#     - dcim.models.Device
-#    choices:
-#     - value: A # this is the deprecated format.
-#     - value: B # we only use it for the tests.
-#     - value: C # please see above for the new format.
-#     - value: "D like deprecated"
-#       weight: 999
-#     - value: E
-# boolean_field:
-#   type: boolean
-#   label: Yes Or No?
-#   required: true
-#   filter_logic: loose
-#   default: "false" # important: put "false" in quotes!
-#   weight: 90
-#   on_objects:
-#   - dcim.models.Device
-# url_field:
-#   type: url
-#   label: Hyperlink
-#   description: Link to something nice.
-#   required: true
-#   filter_logic: disabled
-#   on_objects:
-#   - tenancy.models.Tenant
-# date_field:
-#   type: date
-#   label: Important Date
-#   required: false
-#   filter_logic: disabled
-#   on_objects:
-#   - dcim.models.Device

initializers/dcim_interfaces.yml

@@ -1,18 +0,0 @@
-## Possible Choices:
-##   type:
-##   - virtual
-##   - lag
-##   - 1000base-t
-##   - ... and many more. See for yourself:
-##     https://github.com/netbox-community/netbox/blob/295d4f0394b431351c0cb2c3ecc791df68c6c2fb/netbox/dcim/choices.py#L510
-##
-## Examples:
-
-# - device: server01
-#   enabled: true
-#   type: virtual
-#   name: to-server02
-# - device: server02
-#   enabled: true
-#   type: virtual
-#   name: to-server01

initializers/device_roles.yml

@@ -1,15 +0,0 @@
-# - name: switch
-#   slug: switch
-#   color: Grey
-# - name: router
-#   slug: router
-#   color: Cyan
-# - name: load-balancer
-#   slug: load-balancer
-#   color: Red
-# - name: server
-#   slug: server
-#   color: Blue
-# - name: patchpanel
-#   slug: patchpanel
-#   color: Black

initializers/device_types.yml

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

initializers/devices.yml

@@ -1,44 +0,0 @@
-## Possible Choices:
-##   face:
-##   - front
-##   - rear
-##   status:
-##   - offline
-##   - active
-##   - planned
-##   - staged
-##   - failed
-##   - inventory
-##   - decommissioning
-##
-## Examples:
-
-# - name: server01
-#   device_role: server
-#   device_type: Other
-#   site: AMS 1
-#   rack: rack-01
-#   face: front
-#   position: 1
-#   custom_field_data:
-#     text_field: Description
-# - name: server02
-#   device_role: server
-#   device_type: Other
-#   site: AMS 2
-#   rack: rack-02
-#   face: front
-#   position: 2
-#   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
-#   device_type: Other
-#   site: SING 1
-#   rack: rack-03
-#   face: front
-#   position: 3
-#   custom_field_data:
-#     text_field: Description

initializers/groups.yml

@@ -1,35 +0,0 @@
-## To list all permissions, run:
-## 
-## docker-compose run --rm --entrypoint /bin/bash netbox
-## $ ./manage.py migrate
-## $ ./manage.py shell
-## > from django.contrib.auth.models import Permission
-## > print('\n'.join([p.codename for p in Permission.objects.all()]))
-##
-## Permission lists support wildcards. See the examples below.
-##
-## Examples:
-
-# applications:
-#   users:
-#   - technical_user
-# readers:
-#   users:
-#   - reader
-# writers:
-#   users:
-#   - writer
-#   permissions:
-#   - delete_device
-#   - delete_virtualmachine
-#   - add_*
-#   - change_*
-# vm_managers:
-#   permissions:
-#   - '*_virtualmachine'
-# device_managers:
-#   permissions:
-#   - '*device*'
-# creators:
-#   permissions:
-#   - add_*

initializers/ip_addresses.yml

@@ -1,44 +0,0 @@
-## Possible Choices:
-##   status:
-##   - active
-##   - reserved
-##   - deprecated
-##   - dhcp
-##   role:
-##   - loopback
-##   - secondary
-##   - anycast
-##   - vip
-##   - vrrp
-##   - hsrp
-##   - glbp
-##   - carp
-##
-## Examples:
-
-# - address: 10.1.1.1/24
-#   device: server01
-#   interface: to-server02
-#   status: active
-#   vrf: vrf1
-# - address: 2001:db8:a000:1::1/64
-#   device: server01
-#   interface: to-server02
-#   status: active
-#   vrf: vrf1
-# - address: 10.1.1.2/24
-#   device: server02
-#   interface: to-server01
-#   status: active
-# - address: 2001:db8:a000:1::2/64
-#   device: server02
-#   interface: to-server01
-#   status: active
-# - address: 10.1.1.10/24
-#   description: reserved IP
-#   status: reserved
-#   tenant: tenant1
-# - address: 2001:db8:a000:1::10/64
-#   description: reserved IP
-#   status: reserved
-#   tenant: tenant1

initializers/manufacturers.yml

@@ -1,6 +0,0 @@
-# - name: Manufacturer 1
-#   slug: manufacturer-1
-# - name: Manufacturer 2
-#   slug: manufacturer-2
-# - name: No Name
-#   slug: no-name

initializers/platforms.yml

@@ -1,15 +0,0 @@
-# - name: Platform 1
-#   slug: platform-1
-#   manufacturer: Manufacturer 1
-#   napalm_driver: driver1
-#   napalm_args: "{'arg1': 'value1', 'arg2': 'value2'}"
-# - name: Platform 2
-#   slug: platform-2
-#   manufacturer: Manufacturer 2
-#   napalm_driver: driver2
-#   napalm_args: "{'arg1': 'value1', 'arg2': 'value2'}"
-# - name: Platform 3
-#   slug: platform-3
-#   manufacturer: No Name
-#   napalm_driver: driver3
-#   napalm_args: "{'arg1': 'value1', 'arg2': 'value2'}"

initializers/prefix_vlan_roles.yml

@@ -1,2 +0,0 @@
-# - name: Main Management
-#   slug: main-management

initializers/prefixes.yml

@@ -1,29 +0,0 @@
-## Possible Choices:
-##   status:
-##   - container
-##   - active
-##   - reserved
-##   - deprecated
-##
-## Examples:
-
-# - description: prefix1
-#   prefix: 10.1.1.0/24
-#   site: AMS 1
-#   status: active
-#   tenant: tenant1
-#   vlan: vlan1
-# - description: prefix2
-#   prefix: 10.1.2.0/24
-#   site: AMS 2
-#   status: active
-#   tenant: tenant2
-#   vlan: vlan2
-#   is_pool: true
-#   vrf: vrf2
-# - description: ipv6 prefix1
-#   prefix: 2001:db8:a000:1::/64
-#   site: AMS 2
-#   status: active
-#   tenant: tenant2
-#   vlan: vlan2

initializers/rack_groups.yml

@@ -1,3 +0,0 @@
-# - name: cage 101
-#   slug: cage-101
-#   site: SING 1

initializers/rack_roles.yml

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

initializers/racks.yml

@@ -1,41 +0,0 @@
-## Possible Choices:
-##   width:
-##   - 19
-##   - 23
-##   types:
-##   - 2-post-frame
-##   - 4-post-frame
-##   - 4-post-cabinet
-##   - wall-frame
-##   - wall-cabinet
-##   outer_unit:
-##   - mm
-##   - in
-##
-## Examples:
-
-# - site: AMS 1
-#   name: rack-01
-#   role: Role 1
-#   type: 4-post-cabinet
-#   width: 19
-#   u_height: 47
-#   custom_field_data:
-#     text_field: Description
-# - site: AMS 2
-#   name: rack-02
-#   role: Role 2
-#   type: 4-post-cabinet
-#   width: 19
-#   u_height: 47
-#   custom_field_data:
-#     text_field: Description
-# - site: SING 1
-#   name: rack-03
-#   group: cage 101
-#   role: Role 3
-#   type: 4-post-cabinet
-#   width: 19
-#   u_height: 47
-#   custom_field_data:
-#     text_field: Description

initializers/regions.yml

@@ -1,10 +0,0 @@
-# - name: Singapore
-#   slug: singapore
-# - name: Amsterdam
-#   slug: amsterdam
-# - name: Downtown
-#   slug: downtown
-#   parent: Amsterdam
-# - name: Suburbs
-#   slug: suburbs
-#   parent: Amsterdam

initializers/rirs.yml

@@ -1,9 +0,0 @@
-# - is_private: true
-#   name: RFC1918
-#   slug: rfc1918
-# - is_private: true
-#   name: RFC4193 ULA
-#   slug: rfc4193-ula
-# - is_private: true
-#   name: RFC3849
-#   slug: rfc3849

initializers/sites.yml

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

initializers/tenant_groups.yml

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

initializers/tenants.yml

@@ -1,5 +0,0 @@
-# - name: tenant1
-#   slug: tenant1
-# - name: tenant2
-#   slug: tenant2
-#   group: Tenant Group 2

initializers/users.yml

@@ -1,23 +0,0 @@
-## To list all permissions, run:
-## 
-## docker-compose run --rm --entrypoint /bin/bash netbox
-## $ ./manage.py migrate
-## $ ./manage.py shell
-## > from django.contrib.auth.models import Permission
-## > print('\n'.join([p.codename for p in Permission.objects.all()]))
-##
-## Permission lists support wildcards. See the examples below.
-##
-## Examples:
-
-# technical_user:
-#   api_token: 0123456789technicaluser789abcdef01234567 # must be looooong!
-# reader:
-#   password: reader
-# writer:
-#   password: writer
-#   permissions:
-#   - delete_device
-#   - delete_virtualmachine
-#   - add_*
-#   - change_*

initializers/virtual_machines.yml

@@ -1,28 +0,0 @@
-## Possible Choices:
-##   status:
-##   - active
-##   - offline
-##   - staged
-##
-## Examples:
-
-# - cluster: cluster1
-#   comments: VM1
-#   disk: 200
-#   memory: 4096
-#   name: virtual machine 1
-#   platform: Platform 2
-#   status: active
-#   tenant: tenant1
-#   vcpus: 8
-# - cluster: cluster1
-#   comments: VM2
-#   disk: 100
-#   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/virtualization_interfaces.yml

@@ -1,12 +0,0 @@
-# - description: Network Interface 1
-#   enabled: true
-#   mac_address: 00:77:77:77:77:77
-#   mtu: 1500
-#   name: Network Interface 1
-#   virtual_machine: virtual machine 1
-# - description: Network Interface 2
-#   enabled: true
-#   mac_address: 00:55:55:55:55:55
-#   mtu: 1500
-#   name: Network Interface 2
-#   virtual_machine: virtual machine 1

initializers/vlan_groups.yml

@@ -1,6 +0,0 @@
-# - name: VLAN group 1
-#   site: AMS 1
-#   slug: vlan-group-1
-# - name: VLAN group 2
-#   site: AMS 1
-#   slug: vlan-group-2

initializers/vlans.yml

@@ -1,19 +0,0 @@
-## Possible Choices:
-##   status:
-##   - active
-##   - reserved
-##   - deprecated
-##
-## Examples:
-
-# - name: vlan1
-#   site: AMS 1
-#   status: active
-#   vid: 5
-#   role: Main Management
-#   description: VLAN 5 for MGMT
-# - group: VLAN group 2
-#   name: vlan2
-#   site: AMS 1
-#   status: active
-#   vid: 1300

initializers/vrfs.yml

@@ -1,8 +0,0 @@
-# - enforce_unique: true
-#   name: vrf1
-#   tenant: tenant1
-#   description: main VRF
-# - enforce_unique: true
-#   name: vrf2
-#   rd: "6500:6500"
-#   tenant: tenant2

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"
+    ]
+  }
+}

requirements-container.txt

@@ -0,0 +1,5 @@
+django-auth-ldap==4.1.0
+django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.13.1
+napalm==4.0.0
+psycopg2==2.9.3
+social-auth-core[openidconnect]==4.3.0

startup_scripts/000_users.py

@@ -1,23 +0,0 @@
-import sys
-
-from django.contrib.auth.models import User
-from startup_script_utils import load_yaml, set_permissions
-from users.models import Token
-
-users = load_yaml('/opt/netbox/initializers/users.yml')
-if users is None:
-  sys.exit()
-
-for username, user_details in users.items():
-  if not User.objects.filter(username=username):
-    user = User.objects.create_user(
-      username = username,
-      password = user_details.get('password', 0) or User.objects.make_random_password())
-
-    print("👤 Created user",username)
-
-    if user_details.get('api_token', 0):
-      Token.objects.create(user=user, key=user_details['api_token'])
-
-    yaml_permissions = user_details.get('permissions', [])
-    set_permissions(user.user_permissions, yaml_permissions)

startup_scripts/010_groups.py

@@ -1,23 +0,0 @@
-import sys
-
-from django.contrib.auth.models import Group, User
-from startup_script_utils import load_yaml, set_permissions
-
-groups = load_yaml('/opt/netbox/initializers/groups.yml')
-if groups is None:
-  sys.exit()
-
-for groupname, group_details in groups.items():
-  group, created = Group.objects.get_or_create(name=groupname)
-
-  if created:
-    print("👥 Created group", groupname)
-
-  for username in group_details.get('users', []):
-    user = User.objects.get(username=username)
-
-    if user:
-      user.groups.add(group)
-
-  yaml_permissions = group_details.get('permissions', [])
-  set_permissions(group.permissions, yaml_permissions)

startup_scripts/020_custom_fields.py

@@ -1,58 +0,0 @@
-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('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,26 +0,0 @@
-from dcim.models import Region
-from startup_script_utils import load_yaml
-import sys
-
-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/040_sites.py

@@ -1,32 +0,0 @@
-import sys
-
-from dcim.models import Region, Site
-from startup_script_utils import *
-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/050_manufacturers.py

@@ -1,14 +0,0 @@
-from dcim.models import Manufacturer
-from startup_script_utils import load_yaml
-import sys
-
-manufacturers = load_yaml('/opt/netbox/initializers/manufacturers.yml')
-
-if manufacturers is None:
-  sys.exit()
-
-for params in manufacturers:
-  manufacturer, created = Manufacturer.objects.get_or_create(**params)
-
-  if created:
-    print("🏭 Created Manufacturer", manufacturer.name)

startup_scripts/060_device_types.py

@@ -1,42 +0,0 @@
-import sys
-
-from dcim.models import DeviceType, Manufacturer, Region
-from startup_script_utils import *
-from tenancy.models import Tenant
-
-device_types = load_yaml('/opt/netbox/initializers/device_types.yml')
-
-if device_types is None:
-  sys.exit()
-
-required_assocs = {
-  'manufacturer': (Manufacturer, 'name')
-}
-
-optional_assocs = {
-  'region': (Region, 'name'),
-  'tenant': (Tenant, 'name')
-}
-
-for params in device_types:
-  custom_field_data = pop_custom_fields(params)
-
-  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:
-    set_custom_fields_values(device_type, custom_field_data)
-
-    print("🔡 Created device type", device_type.manufacturer, device_type.model)

startup_scripts/070_rack_roles.py

@@ -1,23 +0,0 @@
-from dcim.models import RackRole
-from utilities.choices import ColorChoices
-
-from startup_script_utils import load_yaml
-import sys
-
-rack_roles = load_yaml('/opt/netbox/initializers/rack_roles.yml')
-
-if rack_roles is None:
-  sys.exit()
-
-for params in rack_roles:
-  if 'color' in params:
-    color = params.pop('color')
-
-    for color_tpl in ColorChoices:
-      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/075_rack_groups.py

@@ -1,25 +0,0 @@
-from dcim.models import Site,RackGroup
-from startup_script_utils import load_yaml
-import sys
-
-rack_groups = load_yaml('/opt/netbox/initializers/rack_groups.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)
-
-  rack_group, created = RackGroup.objects.get_or_create(**params)
-
-  if created:
-    print("🎨 Created rack group", rack_group.name)
-

startup_scripts/080_racks.py

@@ -1,43 +0,0 @@
-import sys
-
-from dcim.models import Site, RackRole, Rack, RackGroup
-from startup_script_utils import *
-from tenancy.models import Tenant
-
-racks = load_yaml('/opt/netbox/initializers/racks.yml')
-
-if racks is None:
-  sys.exit()
-
-required_assocs = {
-  'site': (Site, 'name')
-}
-
-optional_assocs = {
-  'role': (RackRole, 'name'),
-  'tenant': (Tenant, 'name'),
-  'group': (RackGroup, 'name')
-}
-
-for params in racks:
-  custom_field_data = pop_custom_fields(params)
-
-  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:
-    set_custom_fields_values(rack, custom_field_data)
-
-    print("🔳 Created rack", rack.site, rack.name)

startup_scripts/090_device_roles.py

@@ -1,24 +0,0 @@
-from dcim.models import DeviceRole
-from utilities.choices import ColorChoices
-
-from startup_script_utils import load_yaml
-import sys
-
-device_roles = load_yaml('/opt/netbox/initializers/device_roles.yml')
-
-if device_roles is None:
-  sys.exit()
-
-for params in device_roles:
-
-  if 'color' in params:
-    color = params.pop('color')
-
-    for color_tpl in ColorChoices:
-      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/100_platforms.py

@@ -1,26 +0,0 @@
-from dcim.models import Manufacturer, Platform
-from startup_script_utils import load_yaml
-import sys
-
-platforms = load_yaml('/opt/netbox/initializers/platforms.yml')
-
-if platforms is None:
-  sys.exit()
-
-optional_assocs = {
-  'manufacturer': (Manufacturer, 'name'),
-}
-
-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_tenant_groups.py

@@ -1,14 +0,0 @@
-from tenancy.models import TenantGroup
-from startup_script_utils import load_yaml
-import sys
-
-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/120_tenants.py

@@ -1,30 +0,0 @@
-import sys
-
-from startup_script_utils import *
-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/130_devices.py

@@ -1,51 +0,0 @@
-import sys
-
-from dcim.models import Site, Rack, DeviceRole, DeviceType, Device, Platform
-from startup_script_utils import *
-from tenancy.models import Tenant
-from virtualization.models import Cluster
-
-devices = load_yaml('/opt/netbox/initializers/devices.yml')
-
-if devices is None:
-  sys.exit()
-
-required_assocs = {
-  'device_role': (DeviceRole, 'name'),
-  'device_type': (DeviceType, 'model'),
-  'site': (Site, 'name')
-}
-
-optional_assocs = {
-  'tenant': (Tenant, 'name'),
-  'platform': (Platform, 'name'),
-  'rack': (Rack, 'name'),
-  'cluster': (Cluster, 'name')
-}
-
-for params in devices:
-  custom_field_data = pop_custom_fields(params)
-
-  # primary ips are handled later in `270_primary_ips.py`
-  params.pop('primary_ip4', None)
-  params.pop('primary_ip6', 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, created = Device.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(device, custom_field_data)
-
-    print("🖥️  Created device", device.name)

startup_scripts/140_cluster_types.py

@@ -1,14 +0,0 @@
-from virtualization.models import ClusterType
-from startup_script_utils import load_yaml
-import sys
-
-cluster_types = load_yaml('/opt/netbox/initializers/cluster_types.yml')
-
-if cluster_types is None:
-  sys.exit()
-
-for params in cluster_types:
-  cluster_type, created = ClusterType.objects.get_or_create(**params)
-
-  if created:
-    print("🧰 Created Cluster Type", cluster_type.name)

startup_scripts/150_rirs.py

@@ -1,14 +0,0 @@
-from ipam.models import RIR
-from startup_script_utils import load_yaml
-import sys
-
-rirs = load_yaml('/opt/netbox/initializers/rirs.yml')
-
-if rirs is None:
-  sys.exit()
-
-for params in rirs:
-  rir, created = RIR.objects.get_or_create(**params)
-
-  if created:
-    print("🗺️ Created RIR", rir.name)

startup_scripts/160_aggregates.py

@@ -1,32 +0,0 @@
-import sys
-
-from ipam.models import Aggregate, RIR
-from netaddr import IPNetwork
-from startup_script_utils import *
-
-aggregates = load_yaml('/opt/netbox/initializers/aggregates.yml')
-
-if aggregates is None:
-  sys.exit()
-
-required_assocs = {
-  'rir': (RIR, 'name')
-}
-
-for params in aggregates:
-  custom_field_data = pop_custom_fields(params)
-
-  params['prefix'] = IPNetwork(params['prefix'])
-
-  for assoc, details in required_assocs.items():
-    model, field = details
-    query = { field: params.pop(assoc) }
-
-    params[assoc] = model.objects.get(**query)
-
-  aggregate, created = Aggregate.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(aggregate, custom_field_data)
-
-    print("🗞️ Created Aggregate", aggregate.prefix)

startup_scripts/170_clusters.py

@@ -1,42 +0,0 @@
-import sys
-
-from dcim.models import Site
-from startup_script_utils import *
-from virtualization.models import Cluster, ClusterType, ClusterGroup
-
-clusters = load_yaml('/opt/netbox/initializers/clusters.yml')
-
-if clusters is None:
-  sys.exit()
-
-required_assocs = {
-  'type': (ClusterType, 'name')
-}
-
-optional_assocs = {
-  'site': (Site, 'name'),
-  'group': (ClusterGroup, 'name')
-}
-
-for params in clusters:
-  custom_field_data = pop_custom_fields(params)
-
-  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)
-
-  cluster, created = Cluster.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(cluster, custom_field_data)
-
-    print("🗄️ Created cluster", cluster.name)

startup_scripts/180_vrfs.py

@@ -1,31 +0,0 @@
-import sys
-
-from ipam.models import VRF
-from startup_script_utils import *
-from tenancy.models import Tenant
-
-vrfs = load_yaml('/opt/netbox/initializers/vrfs.yml')
-
-if vrfs is None:
-  sys.exit()
-
-optional_assocs = {
-  'tenant': (Tenant, 'name')
-}
-
-for params in vrfs:
-  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)
-
-  vrf, created = VRF.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(vrf, custom_field_data)
-
-    print("📦 Created VRF", vrf.name)

startup_scripts/190_prefix_vlan_roles.py

@@ -1,14 +0,0 @@
-from ipam.models import Role
-from startup_script_utils import load_yaml
-import sys
-
-roles = load_yaml('/opt/netbox/initializers/prefix_vlan_roles.yml')
-
-if roles is None:
-  sys.exit()
-
-for params in roles:
-  role, created = Role.objects.get_or_create(**params)
-
-  if created:
-    print("⛹️‍ Created Prefix/VLAN Role", role.name)

startup_scripts/200_vlan_groups.py

@@ -1,31 +0,0 @@
-import sys
-
-from dcim.models import Site
-from ipam.models import VLANGroup
-from startup_script_utils import *
-
-vlan_groups = load_yaml('/opt/netbox/initializers/vlan_groups.yml')
-
-if vlan_groups is None:
-  sys.exit()
-
-optional_assocs = {
-  'site': (Site, 'name')
-}
-
-for params in vlan_groups:
-  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)
-
-  vlan_group, created = VLANGroup.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(vlan_group, custom_field_data)
-
-    print("🏘️ Created VLAN Group", vlan_group.name)

startup_scripts/210_vlans.py

@@ -1,36 +0,0 @@
-import sys
-
-from dcim.models import Site
-from ipam.models import VLAN, VLANGroup, Role
-from startup_script_utils import *
-from tenancy.models import Tenant, TenantGroup
-
-vlans = load_yaml('/opt/netbox/initializers/vlans.yml')
-
-if vlans is None:
-  sys.exit()
-
-optional_assocs = {
-  'site': (Site, 'name'),
-  'tenant': (Tenant, 'name'),
-  'tenant_group': (TenantGroup, 'name'),
-  'group': (VLANGroup, 'name'),
-  'role': (Role, 'name')
-}
-
-for params in vlans:
-  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)
-
-  vlan, created = VLAN.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(vlan, custom_field_data)
-
-    print("🏠 Created VLAN", vlan.name)

startup_scripts/220_prefixes.py

@@ -1,39 +0,0 @@
-import sys
-
-from dcim.models import Site
-from ipam.models import Prefix, VLAN, Role, VRF
-from netaddr import IPNetwork
-from startup_script_utils import *
-from tenancy.models import Tenant, TenantGroup
-
-prefixes = load_yaml('/opt/netbox/initializers/prefixes.yml')
-
-if prefixes is None:
-  sys.exit()
-
-optional_assocs = {
-  'site': (Site, 'name'),
-  'tenant': (Tenant, 'name'),
-  'tenant_group': (TenantGroup, 'name'),
-  'vlan': (VLAN, 'name'),
-  'role': (Role, 'name'),
-  'vrf': (VRF, 'name')
-}
-
-for params in prefixes:
-  custom_field_data = pop_custom_fields(params)
-
-  params['prefix'] = IPNetwork(params['prefix'])
-
-  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)
-
-  prefix, created = Prefix.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(prefix, custom_field_data)
-
-    print("📌 Created Prefix", prefix.prefix)

startup_scripts/230_virtual_machines.py

@@ -1,48 +0,0 @@
-import sys
-
-from dcim.models import Platform, DeviceRole
-from startup_script_utils import *
-from tenancy.models import Tenant
-from virtualization.models import Cluster, VirtualMachine
-
-virtual_machines = load_yaml('/opt/netbox/initializers/virtual_machines.yml')
-
-if virtual_machines is None:
-  sys.exit()
-
-required_assocs = {
-  'cluster': (Cluster, 'name')
-}
-
-optional_assocs = {
-  'tenant': (Tenant, 'name'),
-  'platform': (Platform, 'name'),
-  'role': (DeviceRole, 'name')
-}
-
-for params in virtual_machines:
-  custom_field_data = pop_custom_fields(params)
-
-  # primary ips are handled later in `270_primary_ips.py`
-  params.pop('primary_ip4', None)
-  params.pop('primary_ip6', 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)
-
-  virtual_machine, created = VirtualMachine.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(virtual_machine, custom_field_data)
-
-    print("🖥️ Created virtual machine", virtual_machine.name)

startup_scripts/240_virtualization_interfaces.py

@@ -1,29 +0,0 @@
-import sys
-
-from startup_script_utils import *
-from virtualization.models import VirtualMachine, VMInterface
-
-interfaces = load_yaml('/opt/netbox/initializers/virtualization_interfaces.yml')
-
-if interfaces is None:
-  sys.exit()
-
-required_assocs = {
-  'virtual_machine': (VirtualMachine, 'name')
-}
-
-for params in interfaces:
-  custom_field_data = pop_custom_fields(params)
-
-  for assoc, details in required_assocs.items():
-    model, field = details
-    query = { field: params.pop(assoc) }
-
-    params[assoc] = model.objects.get(**query)
-
-  interface, created = VMInterface.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(interface, custom_field_data)
-
-    print("🧷 Created interface", interface.name, interface.virtual_machine.name)

startup_scripts/250_dcim_interfaces.py

@@ -1,29 +0,0 @@
-import sys
-
-from dcim.models import Interface, Device
-from startup_script_utils import *
-
-interfaces = load_yaml('/opt/netbox/initializers/dcim_interfaces.yml')
-
-if interfaces is None:
-  sys.exit()
-
-required_assocs = {
-  'device': (Device, 'name')
-}
-
-for params in interfaces:
-  custom_field_data = pop_custom_fields(params)
-
-  for assoc, details in required_assocs.items():
-    model, field = details
-    query = { field: params.pop(assoc) }
-
-    params[assoc] = model.objects.get(**query)
-
-  interface, created = Interface.objects.get_or_create(**params)
-
-  if created:
-    set_custom_fields_values(interface, custom_field_data)
-
-    print("🧷 Created interface", interface.name, interface.device.name)