Closes #6781: Disable database query caching by default

docs/additional-features/caching.md

@@ -1,6 +1,9 @@
 # Caching
 
-NetBox supports database query caching using [django-cacheops](https://github.com/Suor/django-cacheops) and Redis. When a query is made, the results are cached in Redis for a short period of time, as defined by the [CACHE_TIMEOUT](../configuration/optional-settings.md#cache_timeout) parameter (15 minutes by default). Within that time, all recurrences of that specific query will return the pre-fetched results from the cache.
+NetBox supports database query caching using [django-cacheops](https://github.com/Suor/django-cacheops) and Redis. When a query is made, the results are cached in Redis for a short period of time, as defined by the [CACHE_TIMEOUT](../configuration/optional-settings.md#cache_timeout) parameter. Within that time, all recurrences of that specific query will return the pre-fetched results from the cache.
+
+!!! warning
+    In NetBox v2.11.10 and later queryset caching is disabled by default, and must be configured.
 
 If a change is made to any of the objects returned by the query within that time, or if the timeout expires, the results are automatically invalidated and the next request for those results will be sent to the database.
 

docs/configuration/optional-settings.md

@@ -54,9 +54,9 @@ BASE_PATH = 'netbox/'
 
 ## CACHE_TIMEOUT
 
-Default: 900
+Default: 0 (disabled)
 
-The number of seconds that cache entries will be retained before expiring.
+The number of seconds that cached database queries will be retained before expiring.
 
 ---
 

docs/release-notes/version-2.11.md

@@ -13,6 +13,10 @@
 * [#6780](https://github.com/netbox-community/netbox/issues/6780) - Include rack location in navigation breadcrumbs
 * [#6794](https://github.com/netbox-community/netbox/issues/6794) - Fix device name display on device status view
 
+### Other Changes
+
+* [#6781](https://github.com/netbox-community/netbox/issues/6781) - Database query caching is now disabled by default
+
 ---
 
 ## v2.11.9 (2021-07-08)

netbox/netbox/configuration.example.py

@@ -89,8 +89,8 @@ BANNER_LOGIN = ''
 # BASE_PATH = 'netbox/'
 BASE_PATH = ''
 
-# Cache timeout in seconds. Set to 0 to dissable caching. Defaults to 900 (15 minutes)
-CACHE_TIMEOUT = 900
+# Cache timeout in seconds. Defaults to zero (disabled).
+CACHE_TIMEOUT = 0
 
 # Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90)
 CHANGELOG_RETENTION = 90

netbox/netbox/settings.py

@@ -75,7 +75,7 @@ BANNER_TOP = getattr(configuration, 'BANNER_TOP', '')
 BASE_PATH = getattr(configuration, 'BASE_PATH', '')
 if BASE_PATH:
     BASE_PATH = BASE_PATH.strip('/') + '/'  # Enforce trailing slash only
-CACHE_TIMEOUT = getattr(configuration, 'CACHE_TIMEOUT', 900)
+CACHE_TIMEOUT = getattr(configuration, 'CACHE_TIMEOUT', 0)
 CHANGELOG_RETENTION = getattr(configuration, 'CHANGELOG_RETENTION', 90)
 CORS_ORIGIN_ALLOW_ALL = getattr(configuration, 'CORS_ORIGIN_ALLOW_ALL', False)
 CORS_ORIGIN_REGEX_WHITELIST = getattr(configuration, 'CORS_ORIGIN_REGEX_WHITELIST', [])
@@ -417,13 +417,7 @@ else:
         'ssl': CACHING_REDIS_SSL,
         'ssl_cert_reqs': None if CACHING_REDIS_SKIP_TLS_VERIFY else 'required',
     }
-
-if not CACHE_TIMEOUT:
-    CACHEOPS_ENABLED = False
-else:
-    CACHEOPS_ENABLED = True
-
-
+CACHEOPS_ENABLED = bool(CACHE_TIMEOUT)
 CACHEOPS_DEFAULTS = {
     'timeout': CACHE_TIMEOUT
 }