Merge pull request #1298 from netbox-community/develop

Version 3.0.0
2025-06-12 13:06:39 +02:00 · 2024-09-03 22:03:12 +02:00 · 2024-09-03 22:03:12 +02:00 · ab2a7bc8e5
commit ab2a7bc8e5
parent 0c99ff8b56 09ba1d3f4e
17 changed files with 302 additions and 274 deletions
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -6,7 +6,7 @@ contact_links:

  - 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.'
+    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
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@ -57,7 +57,7 @@ body:
  - type: textarea
    id: discussion
    attributes:
-    label: 'Discussion: Benefits and Drawbacks'
+      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?
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@ -80,6 +80,6 @@ into the release notes.
 Please put an x into the brackets (like `[x]`) if you've completed that task.
 -->

-* [ ] I have read the comments and followed the PR template.
-* [ ] I have explained my PR according to the information in the comments.
-* [ ] My PR targets the `develop` branch.
+- [ ] I have read the comments and followed the PR template.
+- [ ] I have explained my PR according to the information in the comments.
+- [ ] My PR targets the `develop` branch.
--- a/.github/workflows/push.yml
+++ b/.github/workflows/push.yml
@ -26,9 +26,9 @@ jobs:
          fetch-depth: 0
      - uses: actions/setup-python@v5
        with:
-          python-version: '3.9'
+          python-version: "3.9"
      - name: Lint Code Base
-        uses: github/super-linter@v6
+        uses: github/super-linter@v7
        env:
          DEFAULT_BRANCH: develop
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@ -6,7 +6,7 @@ on:
    types:
      - published
  schedule:
-    - cron: '45 5 * * *'
+    - cron: "45 5 * * *"
  workflow_dispatch:

 jobs:
--- a/.yamllint.yaml
+++ b/.yamllint.yaml
@ -1,5 +1,4 @@
 ---
-
 rules:
  line-length:
-    max: 120
+    max: 160
--- a/9
+++ b/9
@ -63,17 +63,16 @@ RUN export DEBIAN_FRONTEND=noninteractive \
      openssh-client \
      openssl \
      python3 \
-      python3-distutils \
      tini \
-    && curl --silent --output /usr/share/keyrings/nginx-keyring.gpg \
+    && curl --silent --output /etc/apt/keyrings/nginx-keyring.gpg \
      https://unit.nginx.org/keys/nginx-keyring.gpg \
-    && echo "deb [signed-by=/usr/share/keyrings/nginx-keyring.gpg] https://packages.nginx.org/unit/ubuntu/ mantic unit" \
+    && echo "deb [signed-by=/etc/apt/keyrings/nginx-keyring.gpg] https://packages.nginx.org/unit/ubuntu/ mantic unit" \
      > /etc/apt/sources.list.d/unit.list \
    && apt-get update -qq \
    && apt-get install \
      --yes -qq --no-install-recommends \
-      unit=1.32.0-1~mantic \
-      unit-python3.11=1.32.0-1~mantic \
+      unit=1.32.1-1~mantic \
+      unit-python3.12=1.32.1-1~mantic \
    && rm -rf /var/lib/apt/lists/*

 COPY --from=builder /opt/netbox/venv /opt/netbox/venv
--- a/2
+++ b/2
@ -1 +1 @@
-2.9.1
+3.0.0
--- a/build.sh
+++ b/build.sh
@ -61,7 +61,7 @@ DOCKERFILE  The name of Dockerfile to use.
            ${_GREEN}Default:${_CLEAR} Dockerfile

 DOCKER_FROM The base image to use.
-            ${_GREEN}Default:${_CLEAR} 'ubuntu:23.10'
+            ${_GREEN}Default:${_CLEAR} 'ubuntu:24.04'

 BUILDX_PLATFORMS
            Specifies the platform(s) to build the image for.
@ -219,7 +219,7 @@ fi
 # Determining the value for DOCKER_FROM
 ###
 if [ -z "$DOCKER_FROM" ]; then
-  DOCKER_FROM="docker.io/ubuntu:23.10"
+  DOCKER_FROM="docker.io/ubuntu:24.04"
 fi

 ###
--- a/configuration/configuration.py
+++ b/configuration/configuration.py
@ -200,10 +200,10 @@ if 'CENSUS_REPORTING_ENABLED' in environ:
 EXEMPT_VIEW_PERMISSIONS = _environ_get_and_map('EXEMPT_VIEW_PERMISSIONS', '', _AS_LIST)

 # HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks).
-# HTTP_PROXIES = {
-#     'http': 'http://10.10.1.10:3128',
-#     'https': 'http://10.10.1.10:1080',
-# }
+HTTP_PROXIES = {
+    'http': environ.get('HTTP_PROXY', None),
+    'https': environ.get('HTTPS_PROXY', None),
+}

 # IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing
 # NetBox from an internal IP.
@ -221,9 +221,9 @@ if 'GRAPHQL_ENABLED' in environ:
 # authenticated to NetBox indefinitely.
 LOGIN_PERSISTENCE = _environ_get_and_map('LOGIN_PERSISTENCE', 'False', _AS_BOOL)

-# Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users
-# are permitted to access most data in NetBox (excluding secrets) but not make any changes.
-LOGIN_REQUIRED = _environ_get_and_map('LOGIN_REQUIRED', 'False', _AS_BOOL)
+# When enabled, only authenticated users are permitted to access any part of NetBox.
+# Disabling this will allow unauthenticated users to access most areas of NetBox (but not make any changes).
+LOGIN_REQUIRED = _environ_get_and_map('LOGIN_REQUIRED', 'True', _AS_BOOL)

 # The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to
 # re-authenticate. (Default: 1209600 [14 days])
@ -286,12 +286,23 @@ if 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH' in environ:
    RACK_ELEVATION_DEFAULT_UNIT_WIDTH = _environ_get_and_map('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', None, _AS_INT)

 # Remote authentication support
-REMOTE_AUTH_ENABLED = _environ_get_and_map('REMOTE_AUTH_ENABLED', 'False', _AS_BOOL)
-REMOTE_AUTH_BACKEND = _environ_get_and_map('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend', _AS_LIST)
-REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
+REMOTE_AUTH_AUTO_CREATE_GROUPS = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_GROUPS', 'False', _AS_BOOL)
 REMOTE_AUTH_AUTO_CREATE_USER = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_USER', 'False', _AS_BOOL)
+REMOTE_AUTH_BACKEND = _environ_get_and_map('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend', _AS_LIST)
 REMOTE_AUTH_DEFAULT_GROUPS = _environ_get_and_map('REMOTE_AUTH_DEFAULT_GROUPS', '', _AS_LIST)
-# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
+# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} # dicts can't be configured via environment variables. See extra.py instead.
+REMOTE_AUTH_ENABLED = _environ_get_and_map('REMOTE_AUTH_ENABLED', 'False', _AS_BOOL)
+REMOTE_AUTH_GROUP_HEADER = _environ_get_and_map('REMOTE_AUTH_GROUP_HEADER', 'HTTP_REMOTE_USER_GROUP')
+REMOTE_AUTH_GROUP_SEPARATOR = _environ_get_and_map('REMOTE_AUTH_GROUP_SEPARATOR', '|')
+REMOTE_AUTH_GROUP_SYNC_ENABLED = _environ_get_and_map('REMOTE_AUTH_GROUP_SYNC_ENABLED', 'False', _AS_BOOL)
+REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
+REMOTE_AUTH_USER_EMAIL = environ.get('REMOTE_AUTH_USER_EMAIL', 'HTTP_REMOTE_USER_EMAIL')
+REMOTE_AUTH_USER_FIRST_NAME = environ.get('REMOTE_AUTH_USER_FIRST_NAME', 'HTTP_REMOTE_USER_FIRST_NAME')
+REMOTE_AUTH_USER_LAST_NAME = environ.get('REMOTE_AUTH_USER_LAST_NAME', 'HTTP_REMOTE_USER_LAST_NAME')
+REMOTE_AUTH_SUPERUSER_GROUPS = _environ_get_and_map('REMOTE_AUTH_SUPERUSER_GROUPS', '', _AS_LIST)
+REMOTE_AUTH_SUPERUSERS = _environ_get_and_map('REMOTE_AUTH_SUPERUSERS', '', _AS_LIST)
+REMOTE_AUTH_STAFF_GROUPS = _environ_get_and_map('REMOTE_AUTH_STAFF_GROUPS', '', _AS_LIST)
+REMOTE_AUTH_STAFF_USERS = _environ_get_and_map('REMOTE_AUTH_STAFF_USERS', '', _AS_LIST)

 # 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.
--- a/docker-compose.test.yml
+++ b/docker-compose.test.yml
@ -1,6 +1,6 @@
 services:
  netbox: &netbox
-    image: ${IMAGE-netboxcommunity/netbox:latest}
+    image: ${IMAGE-docker.io/netboxcommunity/netbox:latest}
    depends_on:
      postgres:
        condition: service_healthy
@ -13,10 +13,10 @@ services:
    volumes:
    - ./test-configuration/test_config.py:/etc/netbox/config/test_config.py:z,ro
    healthcheck:
+      test: curl -f http://localhost:8080/login/ || exit 1
      start_period: ${NETBOX_START_PERIOD-120s}
      timeout: 3s
      interval: 15s
-      test: "curl -f http://localhost:8080/api/ || exit 1"
  netbox-worker:
    <<: *netbox
    command:
@ -24,42 +24,47 @@ services:
    - /opt/netbox/netbox/manage.py
    - rqworker
    healthcheck:
+      test: ps -aux | grep -v grep | grep -q rqworker || exit 1
      start_period: 40s
      timeout: 3s
      interval: 15s
-      test: "ps -aux | grep -v grep | grep -q rqworker || exit 1"
  netbox-housekeeping:
    <<: *netbox
    command:
    - /opt/netbox/housekeeping.sh
    healthcheck:
+      test: ps -aux | grep -v grep | grep -q housekeeping || exit 1
      start_period: 40s
      timeout: 3s
      interval: 15s
-      test: "ps -aux | grep -v grep | grep -q housekeeping || exit 1"
+
  postgres:
-    image: postgres:16-alpine
+    image: docker.io/postgres:16-alpine
    env_file: env/postgres.env
    healthcheck:
-      test: "pg_isready -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER" ## $$ because of docker-compose
-      interval: 10s
+      test: pg_isready -q -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER ## $$ because of docker-compose
+      start_period: 20s
+      interval: 1s
      timeout: 5s
      retries: 5
+
  redis: &redis
-    image: redis:7-alpine
+    image: docker.io/valkey/valkey:8.0-alpine
    command:
    - sh
    - -c # this is to evaluate the $REDIS_PASSWORD from the env
-    - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    - valkey-server --save "" --appendonly no --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
    env_file: env/redis.env
    healthcheck:
-      start_period: 20s
+      test: "[ $$(valkey-cli --pass \"$${REDIS_PASSWORD}\" ping) = 'PONG' ]"
+      start_period: 5s
      timeout: 3s
-      interval: 15s
-      test: "timeout 2 redis-cli ping"
+      interval: 1s
+      retries: 5
  redis-cache:
    <<: *redis
    env_file: env/redis-cache.env
+
 volumes:
  netbox-media-files:
    driver: local
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -1,17 +1,17 @@
 services:
  netbox: &netbox
-    image: docker.io/netboxcommunity/netbox:${VERSION-v4.0-2.9.1}
+    image: docker.io/netboxcommunity/netbox:${VERSION-v4.1-3.0.0}
    depends_on:
      - postgres
      - redis
      - redis-cache
    env_file: env/netbox.env
-    user: 'unit:root'
+    user: "unit:root"
    healthcheck:
-      start_period: 60s
+      test: curl -f http://localhost:8080/login/ || exit 1
+      start_period: 90s
      timeout: 3s
      interval: 15s
-      test: "curl -f http://localhost:8080/login/ || exit 1"
    volumes:
      - ./configuration:/etc/netbox/config:z,ro
      - netbox-media-files:/opt/netbox/netbox/media:rw
@ -27,10 +27,10 @@ services:
      - /opt/netbox/netbox/manage.py
      - rqworker
    healthcheck:
+      test: ps -aux | grep -v grep | grep -q rqworker || exit 1
      start_period: 20s
      timeout: 3s
      interval: 15s
-      test: "ps -aux | grep -v grep | grep -q rqworker || exit 1"
  netbox-housekeeping:
    <<: *netbox
    depends_on:
@ -39,34 +39,47 @@ services:
    command:
      - /opt/netbox/housekeeping.sh
    healthcheck:
+      test: ps -aux | grep -v grep | grep -q housekeeping || exit 1
      start_period: 20s
      timeout: 3s
      interval: 15s
-      test: "ps -aux | grep -v grep | grep -q housekeeping || exit 1"

  # postgres
  postgres:
    image: docker.io/postgres:16-alpine
+    healthcheck:
+      test: pg_isready -q -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER
+      start_period: 20s
+      timeout: 30s
+      interval: 10s
+      retries: 5
    env_file: env/postgres.env
    volumes:
      - netbox-postgres-data:/var/lib/postgresql/data

  # redis
  redis:
-    image: docker.io/redis:7-alpine
+    image: docker.io/valkey/valkey:8.0-alpine
    command:
      - sh
      - -c # this is to evaluate the $REDIS_PASSWORD from the env
-    - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+      - valkey-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    healthcheck: &redis-healthcheck
+      test: '[ $$(valkey-cli --pass "$${REDIS_PASSWORD}" ping) = ''PONG'' ]'
+      start_period: 5s
+      timeout: 3s
+      interval: 1s
+      retries: 5
    env_file: env/redis.env
    volumes:
      - netbox-redis-data:/data
  redis-cache:
-    image: docker.io/redis:7-alpine
+    image: docker.io/valkey/valkey:8.0-alpine
    command:
      - sh
      - -c # this is to evaluate the $REDIS_PASSWORD from the env
-    - redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+      - valkey-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    healthcheck: *redis-healthcheck
    env_file: env/redis-cache.env
    volumes:
      - netbox-redis-cache-data:/data
--- a/requirements-container.txt
+++ b/requirements-container.txt
@ -1,5 +1,5 @@
 django-auth-ldap==4.8.0
-django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.14.3
+django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.14.4
 dulwich==0.22.1
-python3-saml==1.16.0 --no-binary lxml
-sentry-sdk[django]==2.1.1
+python3-saml==1.16.0 --no-binary lxml,xmlsec
+sentry-sdk[django]==2.12.0
--- a/test-configuration/test_config.py
+++ b/test-configuration/test_config.py
@ -4,3 +4,4 @@ LOGGING = {
 }

 DEFAULT_PERMISSIONS = {}
+LOGIN_REQUIRED = False
--- a/test.sh
+++ b/test.sh
@ -84,7 +84,7 @@ test_netbox_web() {
      --retry 5 \
      --retry-delay 0 \
      --retry-max-time 40 \
-      http://127.0.0.1:8000/
+      http://127.0.0.1:8000/login/
  )
  if [ "$RESP_CODE" == "200" ]; then
    echo "Webservice running"
 @ -1 +1 @@
 .9.1
 .0.0