Merge pull request #659 from netbox-community/develop

Version 1.5.1

.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,67 +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
-```

.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

@@ -1,13 +1,15 @@
 blank_issues_enabled: false
 contact_links:
-  - name: The \#netbox-docker Slack channel
-    url: http://slack.networktocode.com/
-    about: It's usually the quickest way to seek help when you're in trouble with regards to Netbox Docker.
-    
-  - name: Github Discussions
+  - name: Question
     url: https://github.com/netbox-community/netbox-docker/discussions
-    about: This is the right place to ask questions about how to use or do certain things with Netbox Docker.
+    about: The Github Discussions are the right place to ask questions about how to use or do certain things with NetBox Docker.
 
-  - name: Have you had a look at our Wiki?
+  - 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.
+    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

@@ -9,6 +9,32 @@ on:
       - release
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Checks syntax of our code
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        # Full git history is needed to get a proper list of changed files within `super-linter`
+        fetch-depth: 0
+    - uses: actions/setup-python@v2
+    - name: Lint Code Base
+      uses: github/super-linter@v4
+      env:
+        DEFAULT_BRANCH: develop
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        SUPPRESS_POSSUM: true
+        LINTER_RULES_PATH: /
+        VALIDATE_ALL_CODEBASE: false
+        VALIDATE_DOCKERFILE: false
+        FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
+
+        EDITORCONFIG_FILE_NAME: .ecrc
+        DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
+        MARKDOWN_CONFIG_FILE: .markdown-lint.yml
+        PYTHON_BLACK_CONFIG_FILE: pyproject.toml
+        PYTHON_FLAKE8_CONFIG_FILE: .flake8
+        PYTHON_ISORT_CONFIG_FILE: pyproject.toml
   build:
     continue-on-error: ${{ matrix.docker_from == 'alpine:edge' }}
     strategy:
@@ -16,14 +42,14 @@ jobs:
         build_cmd:
         - ./build-latest.sh
         - PRERELEASE=true ./build-latest.sh
-        - ./build-next.sh
+        - ./build.sh feature
         - ./build.sh develop
         docker_from:
         - '' # use the default of the build script
         - alpine:edge
       fail-fast: false
     runs-on: ubuntu-latest
-    name: Builds new Netbox Docker Images
+    name: Builds new NetBox Docker Images
     steps:
     - id: git-checkout
       name: Checkout

.github/workflows/release.yml

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

.gitignore

@@ -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,3 @@
+ignored:
+- DL3006
+- DL3018

.markdown-lint.yml

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

Dockerfile

@@ -4,23 +4,47 @@ FROM ${FROM} as builder
 RUN apk add --no-cache \
       bash \
       build-base \
+      cargo \
       ca-certificates \
+      cmake \
       cyrus-sasl-dev \
+      git \
       graphviz \
       jpeg-dev \
       libevent-dev \
       libffi-dev \
       libxslt-dev \
+      make \
+      musl-dev \
       openldap-dev \
       postgresql-dev \
       py3-pip \
       python3-dev \
-      && python3 -m venv /opt/netbox/venv \
-      && /opt/netbox/venv/bin/python3 -m pip install --upgrade pip setuptools
+  && python3 -m venv /opt/netbox/venv \
+  && /opt/netbox/venv/bin/python3 -m pip install --upgrade \
+      pip \
+      setuptools \
+      wheel
+
+# Build libcrc32c for google-crc32c python module
+RUN git clone https://github.com/google/crc32c \
+    && cd crc32c \
+    && git submodule update --init --recursive \
+    && mkdir build \
+    && cd build \
+    && cmake \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DCRC32C_BUILD_TESTS=no \
+        -DCRC32C_BUILD_BENCHMARKS=no \
+        -DBUILD_SHARED_LIBS=yes \
+        .. \
+    && make all install
 
 ARG NETBOX_PATH
 COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
-RUN /opt/netbox/venv/bin/pip install -r /requirements.txt -r /requirements-container.txt
+RUN /opt/netbox/venv/bin/pip install \
+      -r /requirements.txt \
+      -r /requirements-container.txt
 
 ###
 # Main stage
@@ -37,17 +61,21 @@ RUN apk add --no-cache \
       libevent \
       libffi \
       libjpeg-turbo \
-      libressl \
       libxslt \
+      openssl \
+      postgresql-client \
       postgresql-libs \
-      python3 \
       py3-pip \
-      ttf-ubuntu-font-family \
+      python3 \
+      tini \
       unit \
       unit-python3
 
 WORKDIR /opt
 
+COPY --from=builder /usr/local/lib/libcrc32c.* /usr/local/lib/
+COPY --from=builder /usr/local/include/crc32c /usr/local/include
+COPY --from=builder /usr/local/lib/cmake/Crc32c /usr/local/lib/cmake/
 COPY --from=builder /opt/netbox/venv /opt/netbox/venv
 
 ARG NETBOX_PATH
@@ -55,6 +83,7 @@ COPY ${NETBOX_PATH} /opt/netbox
 
 COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py
 COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh
+COPY docker/housekeeping.sh /opt/netbox/housekeeping.sh
 COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
 COPY startup_scripts/ /opt/netbox/startup_scripts/
 COPY initializers/ /opt/netbox/initializers/
@@ -66,12 +95,15 @@ WORKDIR /opt/netbox/netbox
 # Must set permissions for '/opt/netbox/netbox/media' directory
 # to g+w so that pictures can be uploaded to netbox.
 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/ && /opt/netbox/venv/bin/python -m mkdocs build \
+          --config-file /opt/netbox/mkdocs.yml --site-dir /opt/netbox/netbox/project-static/docs/ \
       && SECRET_KEY="dummy" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input
 
-ENTRYPOINT [ "/opt/netbox/docker-entrypoint.sh" ]
+ENTRYPOINT [ "/sbin/tini", "--" ]
 
-CMD [ "/opt/netbox/launch-netbox.sh" ]
+CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
 
 LABEL ORIGINAL_TAG="" \
       NETBOX_GIT_BRANCH="" \
@@ -81,8 +113,8 @@ LABEL ORIGINAL_TAG="" \
 # Also https://microbadger.com/labels
       org.label-schema.schema-version="1.0" \
       org.label-schema.build-date="" \
-      org.label-schema.name="Netbox Docker" \
-      org.label-schema.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
+      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" \
@@ -91,8 +123,8 @@ LABEL ORIGINAL_TAG="" \
       org.label-schema.version="snapshot" \
 # See https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys
       org.opencontainers.image.created="" \
-      org.opencontainers.image.title="Netbox Docker" \
-      org.opencontainers.image.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." \

README.md

@@ -5,49 +5,30 @@
 ![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://ghcr.io/netbox-community/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
@@ -66,7 +47,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:
 
@@ -77,19 +58,70 @@ The default credentials are:
 [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 pre-release builds.
+  They contain the support files of _NetBox Docker version_ `a.b.c`.
+  You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
+  These images are automatically built from the [`develop` branch of NetBox][netbox-develop].
+
+For each of the above tag, there is an extra tag:
+
+* `vX.Y.Z`, `vX.Y`:
+  This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).
+  It always points to the latest version of _NetBox Docker_.
+* `latest`
+  This is the same version as `latest-a.b.c`.
+  It always points to the latest version of _NetBox Docker_.
+* `snapshot`
+  This is the same version as `snapshot-a.b.c`.
+  It always points to the latest version of _NetBox Docker_.
+
+Then there is currently one extra tags for each of the above tags:
+
+* `-ldap`:
+  These container images contain additional dependencies and configuration files for connecting NetBox to an LDAP directory.
+  [Learn more about that in our wiki][netbox-docker-ldap].
+
+[netbox-releases]: https://github.com/netbox-community/netbox/releases
+[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
+
 ## 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
 
@@ -97,52 +129,24 @@ If you need help with using Netbox or developing for it or against it's API you
 
 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 `19.03`.
+* 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 +155,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 @@
-1.0.1
+1.5.1

build-functions/docker-functions.sh

@@ -5,4 +5,4 @@ push_image_to_registry() {
   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,5 +1,5 @@
 #!/bin/bash
-# Clones the Netbox repository with git from Github and builds the Dockerfile
+# Clones the NetBox repository with git from Github and builds the Dockerfile
 
 echo "▶️ $0 $*"
 
@@ -49,7 +49,7 @@ if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
   echo "  DOCKERFILE  The name of Dockerfile to use."
   echo "              Default: Dockerfile"
   echo "  DOCKER_FROM The base image to use."
-  echo "              Default: 'alpine:3.13'"
+  echo "              Default: 'alpine:3.14'"
   echo "  DOCKER_TARGET A specific target to build."
   echo "              It's currently not possible to pass multiple targets."
   echo "              Default: main ldap"
@@ -95,6 +95,8 @@ if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
   fi
 fi
 
+source ./build-functions/gh-functions.sh
+
 ###
 # Enabling dry-run mode
 ###
@@ -105,8 +107,10 @@ else
   DRY="echo"
 fi
 
+gh_echo "::group::⤵️ Fetching the NetBox source code"
+
 ###
-# Variables for fetching the Netbox source
+# Variables for fetching the NetBox source
 ###
 SRC_ORG="${SRC_ORG-netbox-community}"
 SRC_REPO="${SRC_REPO-netbox}"
@@ -115,17 +119,23 @@ URL="${URL-https://github.com/${SRC_ORG}/${SRC_REPO}.git}"
 NETBOX_PATH="${NETBOX_PATH-.netbox}"
 
 ###
-# Fetching the Netbox 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 +145,12 @@ if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ] ; then
     $DRY git checkout -qf FETCH_HEAD
     $DRY git prune
   )
-  echo "✅ Checked out Netbox"
+  echo "✅ Checked out NetBox"
 fi
 
+gh_echo "::endgroup::"
+gh_echo "::group::🧮 Calculating Values"
+
 ###
 # Determining the value for DOCKERFILE
 # and checking whether it exists
@@ -157,7 +170,7 @@ fi
 # Determining the value for DOCKER_FROM
 ###
 if [ -z "$DOCKER_FROM" ]; then
-  DOCKER_FROM="alpine:3.13"
+  DOCKER_FROM="alpine:3.14"
 fi
 
 ###
@@ -174,9 +187,18 @@ PROJECT_VERSION="${PROJECT_VERSION-$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]
 
 # Get the Git information from the netbox directory
 if [ -d "${NETBOX_PATH}/.git" ]; then
-  NETBOX_GIT_REF=$(cd "${NETBOX_PATH}"; git rev-parse HEAD)
-  NETBOX_GIT_BRANCH=$(cd "${NETBOX_PATH}"; git rev-parse --abbrev-ref HEAD)
-  NETBOX_GIT_URL=$(cd "${NETBOX_PATH}"; git remote get-url origin)
+  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,26 +208,32 @@ 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
 ###
 DEFAULT_DOCKER_TARGETS=("main" "ldap")
-DOCKER_TARGETS=( "${DOCKER_TARGET:-"${DEFAULT_DOCKER_TARGETS[@]}"}")
+DOCKER_TARGETS=("${DOCKER_TARGET:-"${DEFAULT_DOCKER_TARGETS[@]}"}")
 echo "🏭 Building the following targets:" "${DOCKER_TARGETS[@]}"
 
+gh_echo "::endgroup::"
+
 ###
 # Build each target
 ###
 export DOCKER_BUILDKIT=${DOCKER_BUILDKIT-1}
 for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
+  gh_echo "::group::🏗 Building the target '${DOCKER_TARGET}'"
   echo "🏗 Building the target '${DOCKER_TARGET}'"
 
   ###
@@ -215,10 +243,10 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
   if [ "${DOCKER_TARGET}" != "main" ]; then
     TARGET_DOCKER_TAG="${TARGET_DOCKER_TAG}-${DOCKER_TARGET}"
   fi
-  if [ -n "${GH_ACTION}" ]; then
-    echo "FINAL_DOCKER_TAG=${TARGET_DOCKER_TAG}" >> $GITHUB_ENV
-    echo "::set-output name=skipped::false"
-  fi
+  TARGET_DOCKER_TAG_PROJECT="${TARGET_DOCKER_TAG}-${PROJECT_VERSION}"
+
+  gh_env "FINAL_DOCKER_TAG=${TARGET_DOCKER_TAG_PROJECT}"
+  gh_echo "::set-output name=skipped::false"
 
   ###
   # composing the additional DOCKER_SHORT_TAG,
@@ -237,12 +265,15 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
       TARGET_DOCKER_SHORT_TAG="${TARGET_DOCKER_SHORT_TAG}-${DOCKER_TARGET}"
       TARGET_DOCKER_LATEST_TAG="${TARGET_DOCKER_LATEST_TAG}-${DOCKER_TARGET}"
     fi
+
+    TARGET_DOCKER_SHORT_TAG_PROJECT="${TARGET_DOCKER_SHORT_TAG}-${PROJECT_VERSION}"
+    TARGET_DOCKER_LATEST_TAG_PROJECT="${TARGET_DOCKER_LATEST_TAG}-${PROJECT_VERSION}"
   fi
 
   ###
   # Proceeding to buils stage, except if `--push-only` is passed
   ###
-  if [ "${2}" != "--push-only" ] ; then
+  if [ "${2}" != "--push-only" ]; then
     ###
     # Checking if the build is necessary,
     # meaning build only if one of those values changed:
@@ -259,7 +290,7 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
       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}"
+      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]}"
@@ -293,15 +324,18 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
       --target "${DOCKER_TARGET}"
       -f "${DOCKERFILE}"
       -t "${TARGET_DOCKER_TAG}"
+      -t "${TARGET_DOCKER_TAG_PROJECT}"
     )
     if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
-      DOCKER_BUILD_ARGS+=( -t "${TARGET_DOCKER_SHORT_TAG}" )
-      DOCKER_BUILD_ARGS+=( -t "${TARGET_DOCKER_LATEST_TAG}" )
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_SHORT_TAG}")
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_SHORT_TAG_PROJECT}")
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_LATEST_TAG}")
+      DOCKER_BUILD_ARGS+=(-t "${TARGET_DOCKER_LATEST_TAG_PROJECT}")
     fi
 
     # --label
     DOCKER_BUILD_ARGS+=(
-      --label "ORIGINAL_TAG=${TARGET_DOCKER_TAG}"
+      --label "ORIGINAL_TAG=${TARGET_DOCKER_TAG_PROJECT}"
 
       --label "org.label-schema.build-date=${BUILD_DATE}"
       --label "org.opencontainers.image.created=${BUILD_DATE}"
@@ -323,34 +357,35 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
       )
     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}" )
+      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}" )
+    DOCKER_BUILD_ARGS+=(--build-arg "NETBOX_PATH=${NETBOX_PATH}")
 
     if [ -n "${DOCKER_FROM}" ]; then
-      DOCKER_BUILD_ARGS+=( --build-arg "FROM=${DOCKER_FROM}" )
+      DOCKER_BUILD_ARGS+=(--build-arg "FROM=${DOCKER_FROM}")
     fi
+    # shellcheck disable=SC2031
     if [ -n "${HTTP_PROXY}" ]; then
-      DOCKER_BUILD_ARGS+=( --build-arg "http_proxy=${HTTP_PROXY}" )
-      DOCKER_BUILD_ARGS+=( --build-arg "https_proxy=${HTTPS_PROXY}" )
+      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}" )
+      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 "🐳 Building the Docker image '${TARGET_DOCKER_TAG_PROJECT}'."
       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}}"
+      echo "✅ Finished building the Docker images '${TARGET_DOCKER_TAG_PROJECT}'"
+      echo "🔎 Inspecting labels on '${TARGET_DOCKER_TAG_PROJECT}'"
+      $DRY docker inspect "${TARGET_DOCKER_TAG_PROJECT}" --format "{{json .Config.Labels}}"
     else
       echo "Build skipped because sources didn't change"
       echo "::set-output name=skipped::true"
@@ -360,13 +395,18 @@ for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
   ###
   # Pushing the docker images if either `--push` or `--push-only` are passed
   ###
-  if [ "${2}" == "--push" ] || [ "${2}" == "--push-only" ] ; then
+  if [ "${2}" == "--push" ] || [ "${2}" == "--push-only" ]; then
     source ./build-functions/docker-functions.sh
     push_image_to_registry "${TARGET_DOCKER_TAG}"
+    push_image_to_registry "${TARGET_DOCKER_TAG_PROJECT}"
 
     if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
       push_image_to_registry "${TARGET_DOCKER_SHORT_TAG}"
+      push_image_to_registry "${TARGET_DOCKER_SHORT_TAG_PROJECT}"
       push_image_to_registry "${TARGET_DOCKER_LATEST_TAG}"
+      push_image_to_registry "${TARGET_DOCKER_LATEST_TAG_PROJECT}"
     fi
   fi
+
+  gh_echo "::endgroup::"
 done

configuration/configuration.py

@@ -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))
 
@@ -211,9 +211,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

@@ -9,7 +9,7 @@ services:
     env_file: env/netbox.env
     environment:
       SKIP_STARTUP_SCRIPTS: ${SKIP_STARTUP_SCRIPTS-false}
-    user: '101'
+    user: 'unit:root'
     volumes:
     - ./startup_scripts:/opt/netbox/startup_scripts:z,ro
     - ./${INITIALIZERS_DIR-initializers}:/opt/netbox/initializers:z,ro
@@ -17,10 +17,8 @@ services:
     - ./reports:/etc/netbox/reports:z,ro
     - ./scripts:/etc/netbox/scripts:z,ro
     - netbox-media-files:/opt/netbox/netbox/media:z
-    ports:
-    - 8080
   postgres:
-    image: postgres:12-alpine
+    image: postgres:14-alpine
     env_file: env/postgres.env
   redis:
     image: redis:6-alpine

docker-compose.yml

@@ -1,14 +1,14 @@
 version: '3.4'
 services:
   netbox: &netbox
-    image: netboxcommunity/netbox:${VERSION-latest}
+    image: netboxcommunity/netbox:${VERSION-v3.1-1.5.1}
     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
@@ -16,22 +16,26 @@ services:
     - ./reports:/etc/netbox/reports:z,ro
     - ./scripts:/etc/netbox/scripts:z,ro
     - netbox-media-files:/opt/netbox/netbox/media:z
-    ports:
-    - "8080"
   netbox-worker:
     <<: *netbox
     depends_on:
     - redis
-    entrypoint:
+    - postgres
+    command:
     - /opt/netbox/venv/bin/python
     - /opt/netbox/netbox/manage.py
-    command:
     - rqworker
-    ports: []
+  netbox-housekeeping:
+    <<: *netbox
+    depends_on:
+    - 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

docker/configuration.docker.py

@@ -4,58 +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
@@ -66,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,28 +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
@@ -35,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}'):
@@ -67,6 +91,4 @@ echo "✅ Initialisation is done."
 
 # Launch whatever is passed by docker
 # (i.e. the RUN instruction in the Dockerfile)
-#
-# shellcheck disable=SC2068
-exec $@
+exec "$@"

docker/housekeeping.sh

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

docker/launch-netbox.sh

@@ -22,17 +22,18 @@ load_configuration() {
   # 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";
+  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
-            )
+  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)"
@@ -45,9 +46,11 @@ load_configuration() {
 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/
+  --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

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

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=
+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/custom_fields.yml

@@ -53,20 +53,20 @@
 #   - 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
+#   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?

initializers/custom_links.yml

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

initializers/devices.yml

@@ -42,3 +42,12 @@
 #   position: 3
 #   custom_field_data:
 #     text_field: Description
+# - name: server04
+#   device_role: server
+#   device_type: Other
+#   site: SING 1
+#   location: cage 101
+#   face: front
+#   position: 3
+#   custom_field_data:
+#     text_field: Description

initializers/groups.yml

@@ -1,35 +1,9 @@
-## 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
+#     - technical_user
 # readers:
 #   users:
-#   - reader
+#     - reader
 # writers:
 #   users:
-#   - writer
-#   permissions:
-#   - delete_device
-#   - delete_virtualmachine
-#   - add_*
-#   - change_*
-# vm_managers:
-#   permissions:
-#   - '*_virtualmachine'
-# device_managers:
-#   permissions:
-#   - '*device*'
-# creators:
-#   permissions:
-#   - add_*
+#     - writer

initializers/object_permissions.yml

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

initializers/power_panels.yml

@@ -2,4 +2,4 @@
 #   site: AMS 1   
 # - name: power panel SING 1
 #   site: SING 1 
-#   rack_group: cage 101
+#   location: cage 101

initializers/racks.yml

@@ -32,7 +32,7 @@
 #     text_field: Description
 # - site: SING 1
 #   name: rack-03
-#   group: cage 101
+#   location: cage 101
 #   role: Role 3
 #   type: 4-post-cabinet
 #   width: 19

initializers/secret_roles.yml

@@ -1,4 +0,0 @@
-# - name: Super Secret Passwords
-#   slug: super-secret
-# - name: SNMP Communities
-#   slug: snmp

initializers/sites.yml

@@ -20,6 +20,7 @@
 #   status: active
 #   facility: Amsterdam 3
 #   asn: 67890
+#   tenant: tenant1
 #   custom_field_data:
 #     text_field: Description for AMS3
 # - name: SING 1
@@ -28,5 +29,6 @@
 #   status: active
 #   facility: Singapore 1
 #   asn: 09876
+#   tenant: tenant2
 #   custom_field_data:
 #     text_field: Description for SING1

initializers/users.yml

@@ -1,23 +1,14 @@
-## 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_*
+# jdoe:
+#   first_name: John
+#   last_name: Doe
+#   api_token: 0123456789jdoe789abcdef01234567jdoe
+#   is_active: True
+#   is_superuser: False
+#   is_staff: False
+#   email: john.doe@example.com

initializers/vlan_groups.yml

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

initializers/webhooks.yml

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

pyproject.toml

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

release.sh

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

renovate.json

@@ -1,6 +1,7 @@
 {
   "extends": [
-    "config:base"
+    "config:base",
+    ":disableDependencyDashboard"
   ],
   "enabled": true,
   "labels": ["maintenance"],

requirements-container.txt

@@ -1,4 +1,5 @@
-napalm==3.2.0
-ruamel.yaml==0.16.12
-django-auth-ldap==2.2.0
-django-storages==1.11.1
+napalm==3.3.1
+ruamel.yaml==0.17.17
+django-auth-ldap==3.0.0
+google-crc32c==1.3.0
+django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.12.3

startup_scripts/000_users.py

@@ -1,23 +1,21 @@
 import sys
 
 from django.contrib.auth.models import User
-from startup_script_utils import load_yaml, set_permissions
+from startup_script_utils import load_yaml
 from users.models import Token
 
-users = load_yaml('/opt/netbox/initializers/users.yml')
+users = load_yaml("/opt/netbox/initializers/users.yml")
 if users is None:
-  sys.exit()
+    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())
+    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)
+        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)
+        if user_details.get("api_token", 0):
+            Token.objects.create(user=user, key=user_details["api_token"])

startup_scripts/010_groups.py

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

startup_scripts/015_object_permissions.py

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

startup_scripts/020_custom_fields.py

@@ -3,56 +3,65 @@ 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
+    import importlib
 
-  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)
+    from django.contrib.contenttypes.models import ContentType
 
-customfields = load_yaml('/opt/netbox/initializers/custom_fields.yml')
+    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()
+    sys.exit()
 
 for cf_name, cf_details in customfields.items():
-  custom_field, created = CustomField.objects.get_or_create(name = cf_name)
+    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 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("description", False):
+            custom_field.description = cf_details["description"]
 
-    if cf_details.get('label', False):
-      custom_field.label = cf_details['label']
+        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))
+        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("required", False):
+            custom_field.required = cf_details["required"]
 
-    if cf_details.get('type', False):
-      custom_field.type = cf_details['type']
+        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("filter_logic", False):
+            custom_field.filter_logic = cf_details["filter_logic"]
 
-    if cf_details.get('choices', False):
-      custom_field.choices = []
+        if cf_details.get("weight", -1) >= 0:
+            custom_field.weight = cf_details["weight"]
 
-      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)
+        if cf_details.get("choices", False):
+            custom_field.choices = []
 
-    custom_field.save()
+            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)
 
-    print("🔧 Created custom field", cf_name)
+        custom_field.save()
+
+        print("🔧 Created custom field", cf_name)

startup_scripts/020_tags.py

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

startup_scripts/020_tenant_groups.py

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

startup_scripts/030_regions.py

@@ -1,26 +1,25 @@
-from dcim.models import Region
-from startup_script_utils import load_yaml
 import sys
 
-regions = load_yaml('/opt/netbox/initializers/regions.yml')
+from dcim.models import Region
+from startup_script_utils import load_yaml
+
+regions = load_yaml("/opt/netbox/initializers/regions.yml")
 
 if regions is None:
-  sys.exit()
+    sys.exit()
 
-optional_assocs = {
-  'parent': (Region, 'name')
-}
+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) }
+    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)
+            params[assoc] = model.objects.get(**query)
 
-  region, created = Region.objects.get_or_create(**params)
+    region, created = Region.objects.get_or_create(**params)
 
-  if created:
-    print("🌐 Created region", region.name)
+    if created:
+        print("🌐 Created region", region.name)

startup_scripts/030_tenants.py

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

startup_scripts/040_sites.py

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

startup_scripts/050_manufacturers.py

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

startup_scripts/060_device_types.py

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

startup_scripts/070_rack_roles.py

@@ -1,23 +1,23 @@
-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')
+from dcim.models import RackRole
+from startup_script_utils import load_yaml
+from utilities.choices import ColorChoices
+
+rack_roles = load_yaml("/opt/netbox/initializers/rack_roles.yml")
 
 if rack_roles is None:
-  sys.exit()
+    sys.exit()
 
 for params in rack_roles:
-  if 'color' in params:
-    color = params.pop('color')
+    if "color" in params:
+        color = params.pop("color")
 
-    for color_tpl in ColorChoices:
-      if color in color_tpl:
-        params['color'] = color_tpl[0]
+        for color_tpl in ColorChoices:
+            if color in color_tpl:
+                params["color"] = color_tpl[0]
 
-  rack_role, created = RackRole.objects.get_or_create(**params)
+    rack_role, created = RackRole.objects.get_or_create(**params)
 
-  if created:
-    print("🎨 Created rack role", rack_role.name)
+    if created:
+        print("🎨 Created rack role", rack_role.name)

startup_scripts/075_locations.py

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

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 +1,41 @@
 import sys
 
-from dcim.models import Site, RackRole, Rack, RackGroup
-from startup_script_utils import *
+from dcim.models import Location, Rack, RackRole, Site
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
 from tenancy.models import Tenant
 
-racks = load_yaml('/opt/netbox/initializers/racks.yml')
+racks = load_yaml("/opt/netbox/initializers/racks.yml")
 
 if racks is None:
-  sys.exit()
+    sys.exit()
 
-required_assocs = {
-  'site': (Site, 'name')
-}
+required_assocs = {"site": (Site, "name")}
 
 optional_assocs = {
-  'role': (RackRole, 'name'),
-  'tenant': (Tenant, 'name'),
-  'group': (RackGroup, 'name')
+    "role": (RackRole, "name"),
+    "tenant": (Tenant, "name"),
+    "location": (Location, "name"),
 }
 
 for params in racks:
-  custom_field_data = pop_custom_fields(params)
+    custom_field_data = pop_custom_fields(params)
 
-  for assoc, details in required_assocs.items():
-    model, field = details
-    query = { field: params.pop(assoc) }
+    for assoc, details in required_assocs.items():
+        model, field = details
+        query = {field: params.pop(assoc)}
 
-    params[assoc] = model.objects.get(**query)
+        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) }
+    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)
+            params[assoc] = model.objects.get(**query)
 
-  rack, created = Rack.objects.get_or_create(**params)
+    rack, created = Rack.objects.get_or_create(**params)
 
-  if created:
-    set_custom_fields_values(rack, custom_field_data)
+    if created:
+        set_custom_fields_values(rack, custom_field_data)
 
-    print("🔳 Created rack", rack.site, rack.name)
+        print("🔳 Created rack", rack.site, rack.name)

startup_scripts/090_device_roles.py

@@ -1,24 +1,24 @@
-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')
+from dcim.models import DeviceRole
+from startup_script_utils import load_yaml
+from utilities.choices import ColorChoices
+
+device_roles = load_yaml("/opt/netbox/initializers/device_roles.yml")
 
 if device_roles is None:
-  sys.exit()
+    sys.exit()
 
 for params in device_roles:
 
-  if 'color' in params:
-    color = params.pop('color')
+    if "color" in params:
+        color = params.pop("color")
 
-    for color_tpl in ColorChoices:
-      if color in color_tpl:
-        params['color'] = color_tpl[0]
+        for color_tpl in ColorChoices:
+            if color in color_tpl:
+                params["color"] = color_tpl[0]
 
-  device_role, created = DeviceRole.objects.get_or_create(**params)
+    device_role, created = DeviceRole.objects.get_or_create(**params)
 
-  if created:
-    print("🎨 Created device role", device_role.name)
+    if created:
+        print("🎨 Created device role", device_role.name)

startup_scripts/100_platforms.py

@@ -1,26 +1,27 @@
-from dcim.models import Manufacturer, Platform
-from startup_script_utils import load_yaml
 import sys
 
-platforms = load_yaml('/opt/netbox/initializers/platforms.yml')
+from dcim.models import Manufacturer, Platform
+from startup_script_utils import load_yaml
+
+platforms = load_yaml("/opt/netbox/initializers/platforms.yml")
 
 if platforms is None:
-  sys.exit()
+    sys.exit()
 
 optional_assocs = {
-  'manufacturer': (Manufacturer, 'name'),
+    "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) }
+    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)
+            params[assoc] = model.objects.get(**query)
 
-  platform, created = Platform.objects.get_or_create(**params)
+    platform, created = Platform.objects.get_or_create(**params)
 
-  if created:
-    print("💾 Created platform", platform.name)
+    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_cluster_types.py

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

startup_scripts/135_cluster_groups.py

@@ -1,14 +1,15 @@
-from virtualization.models import ClusterGroup
-from startup_script_utils import load_yaml
 import sys
 
-cluster_groups = load_yaml('/opt/netbox/initializers/cluster_groups.yml')
+from startup_script_utils import load_yaml
+from virtualization.models import ClusterGroup
+
+cluster_groups = load_yaml("/opt/netbox/initializers/cluster_groups.yml")
 
 if cluster_groups is None:
-  sys.exit()
+    sys.exit()
 
 for params in cluster_groups:
-  cluster_group, created = ClusterGroup.objects.get_or_create(**params)
+    cluster_group, created = ClusterGroup.objects.get_or_create(**params)
 
-  if created:
-    print("🗄️ Created Cluster Group", cluster_group.name)
+    if created:
+        print("🗄️ Created Cluster Group", cluster_group.name)

startup_scripts/135_clusters.py

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

startup_scripts/140_clusters.py

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

startup_scripts/140_devices.py

@@ -1,51 +1,52 @@
 import sys
 
-from dcim.models import Site, Rack, DeviceRole, DeviceType, Device, Platform
-from startup_script_utils import *
+from dcim.models import Device, DeviceRole, DeviceType, Location, Platform, Rack, Site
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
 from tenancy.models import Tenant
 from virtualization.models import Cluster
 
-devices = load_yaml('/opt/netbox/initializers/devices.yml')
+devices = load_yaml("/opt/netbox/initializers/devices.yml")
 
 if devices is None:
-  sys.exit()
+    sys.exit()
 
 required_assocs = {
-  'device_role': (DeviceRole, 'name'),
-  'device_type': (DeviceType, 'model'),
-  'site': (Site, 'name')
+    "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')
+    "tenant": (Tenant, "name"),
+    "platform": (Platform, "name"),
+    "rack": (Rack, "name"),
+    "cluster": (Cluster, "name"),
+    "location": (Location, "name"),
 }
 
 for params in devices:
-  custom_field_data = pop_custom_fields(params)
+    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)
+    # 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) }
+    for assoc, details in required_assocs.items():
+        model, field = details
+        query = {field: params.pop(assoc)}
 
-    params[assoc] = model.objects.get(**query)
+        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) }
+    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)
+            params[assoc] = model.objects.get(**query)
 
-  device, created = Device.objects.get_or_create(**params)
+    device, created = Device.objects.get_or_create(**params)
 
-  if created:
-    set_custom_fields_values(device, custom_field_data)
+    if created:
+        set_custom_fields_values(device, custom_field_data)
 
-    print("🖥️  Created device", device.name)
+        print("🖥️  Created device", device.name)

startup_scripts/145_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/150_rirs.py

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

startup_scripts/160_aggregates.py

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

startup_scripts/165_cluster_groups.py

@@ -1,14 +1,15 @@
-from virtualization.models import ClusterGroup
-from startup_script_utils import load_yaml
 import sys
 
-cluster_groups = load_yaml('/opt/netbox/initializers/cluster_groups.yml')
+from startup_script_utils import load_yaml
+from virtualization.models import ClusterGroup
+
+cluster_groups = load_yaml("/opt/netbox/initializers/cluster_groups.yml")
 
 if cluster_groups is None:
-  sys.exit()
+    sys.exit()
 
 for params in cluster_groups:
-  cluster_group, created = ClusterGroup.objects.get_or_create(**params)
+    cluster_group, created = ClusterGroup.objects.get_or_create(**params)
 
-  if created:
-    print("🗄️ Created Cluster Group", cluster_group.name)
+    if created:
+        print("🗄️ Created Cluster Group", cluster_group.name)

startup_scripts/175_route_targets.py

@@ -1,31 +1,29 @@
 import sys
 
 from ipam.models import RouteTarget
-from startup_script_utils import *
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
 from tenancy.models import Tenant
 
-route_targets = load_yaml('/opt/netbox/initializers/route_targets.yml')
+route_targets = load_yaml("/opt/netbox/initializers/route_targets.yml")
 
 if route_targets is None:
-  sys.exit()
+    sys.exit()
 
-optional_assocs = {
-  'tenant': (Tenant, 'name')
-}
+optional_assocs = {"tenant": (Tenant, "name")}
 
 for params in route_targets:
-  custom_field_data = pop_custom_fields(params)
+    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) }
+    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)
+            params[assoc] = model.objects.get(**query)
 
-  route_target, created = RouteTarget.objects.get_or_create(**params)
+    route_target, created = RouteTarget.objects.get_or_create(**params)
 
-  if created:
-    set_custom_fields_values(route_target, custom_field_data)
+    if created:
+        set_custom_fields_values(route_target, custom_field_data)
 
-    print("🎯 Created Route Target", route_target.name)
+        print("🎯 Created Route Target", route_target.name)

startup_scripts/180_vrfs.py

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

startup_scripts/190_prefix_vlan_roles.py

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

startup_scripts/200_vlan_groups.py

@@ -1,31 +1,40 @@
 import sys
 
-from dcim.models import Site
+from django.contrib.contenttypes.models import ContentType
 from ipam.models import VLANGroup
-from startup_script_utils import *
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
 
-vlan_groups = load_yaml('/opt/netbox/initializers/vlan_groups.yml')
+vlan_groups = load_yaml("/opt/netbox/initializers/vlan_groups.yml")
 
 if vlan_groups is None:
-  sys.exit()
+    sys.exit()
 
-optional_assocs = {
-  'site': (Site, 'name')
-}
+optional_assocs = {"scope": (None, "name")}
 
 for params in vlan_groups:
-  custom_field_data = pop_custom_fields(params)
+    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) }
+    for assoc, details in optional_assocs.items():
+        if assoc in params:
+            model, field = details
+            query = {field: params.pop(assoc)}
+            # Get model from Contenttype
+            scope_type = params.pop("scope_type", None)
+            if not scope_type:
+                print(f"VLAN Group '{params['name']}': scope_type is missing from VLAN Group")
+                continue
+            app_label, model = str(scope_type).split(".")
+            ct = ContentType.objects.filter(app_label=app_label, model=model).first()
+            if not ct:
+                print(
+                    f"VLAN Group '{params['name']}': ContentType for "
+                    + f"app_label = '{app_label}' and model = '{model}' not found"
+                )
+                continue
+            params["scope_id"] = ct.model_class().objects.get(**query).id
+    vlan_group, created = VLANGroup.objects.get_or_create(**params)
 
-      params[assoc] = model.objects.get(**query)
+    if created:
+        set_custom_fields_values(vlan_group, custom_field_data)
 
-  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)
+        print("🏘️ Created VLAN Group", vlan_group.name)

startup_scripts/210_vlans.py

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

startup_scripts/220_prefixes.py

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

startup_scripts/230_virtual_machines.py

@@ -1,48 +1,46 @@
 import sys
 
-from dcim.models import Platform, DeviceRole
-from startup_script_utils import *
+from dcim.models import DeviceRole, Platform
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
 from tenancy.models import Tenant
 from virtualization.models import Cluster, VirtualMachine
 
-virtual_machines = load_yaml('/opt/netbox/initializers/virtual_machines.yml')
+virtual_machines = load_yaml("/opt/netbox/initializers/virtual_machines.yml")
 
 if virtual_machines is None:
-  sys.exit()
+    sys.exit()
 
-required_assocs = {
-  'cluster': (Cluster, 'name')
-}
+required_assocs = {"cluster": (Cluster, "name")}
 
 optional_assocs = {
-  'tenant': (Tenant, 'name'),
-  'platform': (Platform, 'name'),
-  'role': (DeviceRole, 'name')
+    "tenant": (Tenant, "name"),
+    "platform": (Platform, "name"),
+    "role": (DeviceRole, "name"),
 }
 
 for params in virtual_machines:
-  custom_field_data = pop_custom_fields(params)
+    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)
+    # 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) }
+    for assoc, details in required_assocs.items():
+        model, field = details
+        query = {field: params.pop(assoc)}
 
-    params[assoc] = model.objects.get(**query)
+        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) }
+    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)
+            params[assoc] = model.objects.get(**query)
 
-  virtual_machine, created = VirtualMachine.objects.get_or_create(**params)
+    virtual_machine, created = VirtualMachine.objects.get_or_create(**params)
 
-  if created:
-    set_custom_fields_values(virtual_machine, custom_field_data)
+    if created:
+        set_custom_fields_values(virtual_machine, custom_field_data)
 
-    print("🖥️ Created virtual machine", virtual_machine.name)
+        print("🖥️ Created virtual machine", virtual_machine.name)

startup_scripts/240_virtualization_interfaces.py

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

startup_scripts/250_dcim_interfaces.py

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

startup_scripts/260_ip_addresses.py

@@ -5,56 +5,58 @@ from django.contrib.contenttypes.models import ContentType
 from django.db.models import Q
 from ipam.models import VRF, IPAddress
 from netaddr import IPNetwork
-from startup_script_utils import *
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
 from tenancy.models import Tenant
 from virtualization.models import VirtualMachine, VMInterface
 
-ip_addresses = load_yaml('/opt/netbox/initializers/ip_addresses.yml')
+ip_addresses = load_yaml("/opt/netbox/initializers/ip_addresses.yml")
 
 if ip_addresses is None:
-  sys.exit()
-
-optional_assocs = {
-  'tenant': (Tenant, 'name'),
-  'vrf': (VRF, 'name'),
-  'interface': (None, None)
-}
-
-vm_interface_ct = ContentType.objects.filter(Q(app_label='virtualization', model='vminterface')).first()
-interface_ct = ContentType.objects.filter(Q(app_label='dcim', model='interface')).first()
-
-for params in ip_addresses:
-  custom_field_data = pop_custom_fields(params)
-
-  vm = params.pop('virtual_machine', None)
-  device = params.pop('device', None)
-  params['address'] = IPNetwork(params['address'])
-
-  if vm and device:
-    print("IP Address can only specify one of the following: virtual_machine or device.")
     sys.exit()
 
-  for assoc, details in optional_assocs.items():
-    if assoc in params:
-      model, field = details
-      if assoc == 'interface':
-          if vm:
-              vm_id = VirtualMachine.objects.get(name=vm).id
-              query = { 'name': params.pop(assoc), "virtual_machine_id": vm_id }
-              params['assigned_object_type'] = vm_interface_ct
-              params['assigned_object_id'] = VMInterface.objects.get(**query).id
-          elif device:
-              dev_id = Device.objects.get(name=device).id
-              query = { 'name': params.pop(assoc), "device_id": dev_id }
-              params['assigned_object_type'] = interface_ct
-              params['assigned_object_id'] = Interface.objects.get(**query).id
-      else:
-          query = { field: params.pop(assoc) }
-          params[assoc] = model.objects.get(**query)
+optional_assocs = {
+    "tenant": (Tenant, "name"),
+    "vrf": (VRF, "name"),
+    "interface": (None, None),
+}
 
-  ip_address, created = IPAddress.objects.get_or_create(**params)
+vm_interface_ct = ContentType.objects.filter(
+    Q(app_label="virtualization", model="vminterface")
+).first()
+interface_ct = ContentType.objects.filter(Q(app_label="dcim", model="interface")).first()
 
-  if created:
-    set_custom_fields_values(ip_address, custom_field_data)
+for params in ip_addresses:
+    custom_field_data = pop_custom_fields(params)
 
-    print("🧬 Created IP Address", ip_address.address)
+    vm = params.pop("virtual_machine", None)
+    device = params.pop("device", None)
+    params["address"] = IPNetwork(params["address"])
+
+    if vm and device:
+        print("IP Address can only specify one of the following: virtual_machine or device.")
+        sys.exit()
+
+    for assoc, details in optional_assocs.items():
+        if assoc in params:
+            model, field = details
+            if assoc == "interface":
+                if vm:
+                    vm_id = VirtualMachine.objects.get(name=vm).id
+                    query = {"name": params.pop(assoc), "virtual_machine_id": vm_id}
+                    params["assigned_object_type"] = vm_interface_ct
+                    params["assigned_object_id"] = VMInterface.objects.get(**query).id
+                elif device:
+                    dev_id = Device.objects.get(name=device).id
+                    query = {"name": params.pop(assoc), "device_id": dev_id}
+                    params["assigned_object_type"] = interface_ct
+                    params["assigned_object_id"] = Interface.objects.get(**query).id
+            else:
+                query = {field: params.pop(assoc)}
+                params[assoc] = model.objects.get(**query)
+
+    ip_address, created = IPAddress.objects.get_or_create(**params)
+
+    if created:
+        set_custom_fields_values(ip_address, custom_field_data)
+
+        print("🧬 Created IP Address", ip_address.address)

startup_scripts/270_primary_ips.py

@@ -1,44 +1,47 @@
-from dcim.models import Device
-from ipam.models import IPAddress
-from virtualization.models import VirtualMachine
-from startup_script_utils import load_yaml
 import sys
 
+from dcim.models import Device
+from ipam.models import IPAddress
+from startup_script_utils import load_yaml
+from virtualization.models import VirtualMachine
+
+
 def link_primary_ip(assets, asset_model):
-  for params in assets:
-    primary_ip_fields = set(params) & {'primary_ip4', 'primary_ip6'}
-    if not primary_ip_fields:
-      continue
+    for params in assets:
+        primary_ip_fields = set(params) & {"primary_ip4", "primary_ip6"}
+        if not primary_ip_fields:
+            continue
 
-    for assoc, details in optional_assocs.items():
-      if assoc in params:
-        model, field = details
-        query = { field: params.pop(assoc) }
+        for assoc, details in optional_assocs.items():
+            if assoc in params:
+                model, field = details
+                query = {field: params.pop(assoc)}
 
-        try:
-          params[assoc] = model.objects.get(**query)
-        except model.DoesNotExist:
-          primary_ip_fields -= {assoc}
-          print(f"⚠️ IP Address '{query[field]}' not found")
+                try:
+                    params[assoc] = model.objects.get(**query)
+                except model.DoesNotExist:
+                    primary_ip_fields -= {assoc}
+                    print(f"⚠️ IP Address '{query[field]}' not found")
 
-    asset = asset_model.objects.get(name=params['name'])
-    for field in primary_ip_fields:
-      if getattr(asset, field) != params[field]:
-        setattr(asset, field, params[field])
-        print(f"🔗 Define primary IP '{params[field].address}' on '{asset.name}'")
-    asset.save()
+        asset = asset_model.objects.get(name=params["name"])
+        for field in primary_ip_fields:
+            if getattr(asset, field) != params[field]:
+                setattr(asset, field, params[field])
+                print(f"🔗 Define primary IP '{params[field].address}' on '{asset.name}'")
+        asset.save()
 
-devices = load_yaml('/opt/netbox/initializers/devices.yml')
-virtual_machines = load_yaml('/opt/netbox/initializers/virtual_machines.yml')
+
+devices = load_yaml("/opt/netbox/initializers/devices.yml")
+virtual_machines = load_yaml("/opt/netbox/initializers/virtual_machines.yml")
 
 optional_assocs = {
-    'primary_ip4': (IPAddress, 'address'),
-    'primary_ip6': (IPAddress, 'address')
+    "primary_ip4": (IPAddress, "address"),
+    "primary_ip6": (IPAddress, "address"),
 }
 
 if devices is None and virtual_machines is None:
     sys.exit()
 if devices is not None:
-  link_primary_ip(devices, Device)
+    link_primary_ip(devices, Device)
 if virtual_machines is not None:
-  link_primary_ip(virtual_machines, VirtualMachine)
+    link_primary_ip(virtual_machines, VirtualMachine)

startup_scripts/280_custom_links.py

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

startup_scripts/280_providers.py

@@ -1,18 +1,19 @@
-from circuits.models import Provider
-from startup_script_utils import *
 import sys
 
-providers = load_yaml('/opt/netbox/initializers/providers.yml')
+from circuits.models import Provider
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
+
+providers = load_yaml("/opt/netbox/initializers/providers.yml")
 
 if providers is None:
-  sys.exit()
+    sys.exit()
 
 for params in providers:
-  custom_field_data = pop_custom_fields(params)
+    custom_field_data = pop_custom_fields(params)
 
-  provider, created = Provider.objects.get_or_create(**params)
+    provider, created = Provider.objects.get_or_create(**params)
 
-  if created:
-    set_custom_fields_values(provider, custom_field_data)
+    if created:
+        set_custom_fields_values(provider, custom_field_data)
 
-    print("📡 Created provider", provider.name)
+        print("📡 Created provider", provider.name)

startup_scripts/290_circuit_types.py

@@ -1,18 +1,19 @@
-from circuits.models import CircuitType
-from startup_script_utils import *
 import sys
 
-circuit_types = load_yaml('/opt/netbox/initializers/circuit_types.yml')
+from circuits.models import CircuitType
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
+
+circuit_types = load_yaml("/opt/netbox/initializers/circuit_types.yml")
 
 if circuit_types is None:
-  sys.exit()
+    sys.exit()
 
 for params in circuit_types:
-  custom_field_data = pop_custom_fields(params)
+    custom_field_data = pop_custom_fields(params)
 
-  circuit_type, created = CircuitType.objects.get_or_create(**params)
+    circuit_type, created = CircuitType.objects.get_or_create(**params)
 
-  if created:
-    set_custom_fields_values(circuit_type, custom_field_data)
+    if created:
+        set_custom_fields_values(circuit_type, custom_field_data)
 
-    print("⚡ Created Circuit Type", circuit_type.name)
+        print("⚡ Created Circuit Type", circuit_type.name)

startup_scripts/290_webhooks.py

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

startup_scripts/300_circuits.py

@@ -1,41 +1,37 @@
-from circuits.models import Circuit, Provider, CircuitType
-from tenancy.models import Tenant
-from startup_script_utils import *
 import sys
 
-circuits = load_yaml('/opt/netbox/initializers/circuits.yml')
+from circuits.models import Circuit, CircuitType, Provider
+from startup_script_utils import load_yaml, pop_custom_fields, set_custom_fields_values
+from tenancy.models import Tenant
+
+circuits = load_yaml("/opt/netbox/initializers/circuits.yml")
 
 if circuits is None:
-  sys.exit()
+    sys.exit()
 
-required_assocs = {
-  'provider': (Provider, 'name'),
-  'type': (CircuitType, 'name')
-}
+required_assocs = {"provider": (Provider, "name"), "type": (CircuitType, "name")}
 
-optional_assocs = {
-  'tenant': (Tenant, 'name')
-}
+optional_assocs = {"tenant": (Tenant, "name")}
 
 for params in circuits:
-  custom_field_data = pop_custom_fields(params)
+    custom_field_data = pop_custom_fields(params)
 
-  for assoc, details in required_assocs.items():
-    model, field = details
-    query = { field: params.pop(assoc) }
+    for assoc, details in required_assocs.items():
+        model, field = details
+        query = {field: params.pop(assoc)}
 
-    params[assoc] = model.objects.get(**query)
+        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) }
+    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)
+            params[assoc] = model.objects.get(**query)
 
-  circuit, created = Circuit.objects.get_or_create(**params)
+    circuit, created = Circuit.objects.get_or_create(**params)
 
-  if created:
-    set_custom_fields_values(circuit, custom_field_data)
+    if created:
+        set_custom_fields_values(circuit, custom_field_data)
 
-    print("⚡ Created Circuit", circuit.cid)
+        print("⚡ Created Circuit", circuit.cid)

startup_scripts/310_secret_roles.py

@@ -1,14 +0,0 @@
-from secrets.models import SecretRole
-from startup_script_utils import load_yaml
-import sys
-
-secret_roles = load_yaml('/opt/netbox/initializers/secret_roles.yml')
-
-if secret_roles is None:
-  sys.exit()
-
-for params in secret_roles:
-  secret_role, created = SecretRole.objects.get_or_create(**params)
-
-  if created:
-    print("🔑 Created Secret Role", secret_role.name)