Merge pull request #3604 from netbox-community/3282-seperate-redis-config

implements #3282 - seperate webhooks and caching redis configs

netbox/netbox/configuration.example.py

@@ -26,14 +26,25 @@ DATABASE = {
 SECRET_KEY = ''
 
 # Redis database settings. The Redis database is used for caching and background processing such as webhooks
+# Seperate sections for webhooks and caching allow for connecting to seperate Redis instances/datbases if desired.
+# Full connection details are required in both sections, even if they are the same.
 REDIS = {
-    'HOST': 'localhost',
-    'PORT': 6379,
-    'PASSWORD': '',
-    'DATABASE': 0,
-    'CACHE_DATABASE': 1,
-    'DEFAULT_TIMEOUT': 300,
-    'SSL': False,
+    'webhooks': {
+        'HOST': 'redis.example.com',
+        'PORT': 1234,
+        'PASSWORD': 'foobar',
+        'DATABASE': 0,
+        'DEFAULT_TIMEOUT': 300,
+        'SSL': False,
+    },
+    'caching': {
+        'HOST': 'localhost',
+        'PORT': 6379,
+        'PASSWORD': '',
+        'DATABASE': 1,
+        'DEFAULT_TIMEOUT': 300,
+        'SSL': False,
+    }
 }
 
 

netbox/netbox/settings.py

@@ -118,13 +118,30 @@ DATABASES = {
 # Redis
 #
 
-REDIS_HOST = REDIS.get('HOST', 'localhost')
-REDIS_PORT = REDIS.get('PORT', 6379)
-REDIS_PASSWORD = REDIS.get('PASSWORD', '')
-REDIS_DATABASE = REDIS.get('DATABASE', 0)
-REDIS_CACHE_DATABASE = REDIS.get('CACHE_DATABASE', 1)
-REDIS_DEFAULT_TIMEOUT = REDIS.get('DEFAULT_TIMEOUT', 300)
-REDIS_SSL = REDIS.get('SSL', False)
+if 'webhooks' not in REDIS:
+    raise ImproperlyConfigured(
+        "REDIS section in configuration.py is missing webhooks subsection."
+    )
+if 'caching' not in REDIS:
+    raise ImproperlyConfigured(
+        "REDIS section in configuration.py is missing caching subsection."
+    )
+
+WEBHOOKS_REDIS = REDIS.get('webhooks', {})
+WEBHOOKS_REDIS_HOST = WEBHOOKS_REDIS.get('HOST', 'localhost')
+WEBHOOKS_REDIS_PORT = WEBHOOKS_REDIS.get('PORT', 6379)
+WEBHOOKS_REDIS_PASSWORD = WEBHOOKS_REDIS.get('PASSWORD', '')
+WEBHOOKS_REDIS_DATABASE = WEBHOOKS_REDIS.get('DATABASE', 0)
+WEBHOOKS_REDIS_DEFAULT_TIMEOUT = WEBHOOKS_REDIS.get('DEFAULT_TIMEOUT', 300)
+WEBHOOKS_REDIS_SSL = WEBHOOKS_REDIS.get('SSL', False)
+
+CACHING_REDIS = REDIS.get('caching', {})
+CACHING_REDIS_HOST = WEBHOOKS_REDIS.get('HOST', 'localhost')
+CACHING_REDIS_PORT = WEBHOOKS_REDIS.get('PORT', 6379)
+CACHING_REDIS_PASSWORD = WEBHOOKS_REDIS.get('PASSWORD', '')
+CACHING_REDIS_DATABASE = WEBHOOKS_REDIS.get('DATABASE', 0)
+CACHING_REDIS_DEFAULT_TIMEOUT = WEBHOOKS_REDIS.get('DEFAULT_TIMEOUT', 300)
+CACHING_REDIS_SSL = WEBHOOKS_REDIS.get('SSL', False)
 
 
 #
@@ -341,15 +358,20 @@ if LDAP_CONFIG is not None:
 # Caching
 #
 
-if REDIS_SSL:
+if CACHING_REDIS_SSL:
     REDIS_CACHE_CON_STRING = 'rediss://'
 else:
     REDIS_CACHE_CON_STRING = 'redis://'
 
-if REDIS_PASSWORD:
-    REDIS_CACHE_CON_STRING = '{}:{}@'.format(REDIS_CACHE_CON_STRING, REDIS_PASSWORD)
+if CACHING_REDIS_PASSWORD:
+    REDIS_CACHE_CON_STRING = '{}:{}@'.format(REDIS_CACHE_CON_STRING, CACHING_REDIS_PASSWORD)
 
-REDIS_CACHE_CON_STRING = '{}{}:{}/{}'.format(REDIS_CACHE_CON_STRING, REDIS_HOST, REDIS_PORT, REDIS_CACHE_DATABASE)
+REDIS_CACHE_CON_STRING = '{}{}:{}/{}'.format(
+    REDIS_CACHE_CON_STRING,
+    CACHING_REDIS_HOST,
+    CACHING_REDIS_PORT,
+    CACHING_REDIS_DATABASE
+)
 
 if not CACHE_TIMEOUT:
     CACHEOPS_ENABLED = False
@@ -467,12 +489,12 @@ SWAGGER_SETTINGS = {
 
 RQ_QUEUES = {
     'default': {
-        'HOST': REDIS_HOST,
-        'PORT': REDIS_PORT,
-        'DB': REDIS_DATABASE,
-        'PASSWORD': REDIS_PASSWORD,
-        'DEFAULT_TIMEOUT': REDIS_DEFAULT_TIMEOUT,
-        'SSL': REDIS_SSL,
+        'HOST': WEBHOOKS_REDIS_HOST,
+        'PORT': WEBHOOKS_REDIS_PORT,
+        'DB': WEBHOOKS_REDIS_DATABASE,
+        'PASSWORD': WEBHOOKS_REDIS_PASSWORD,
+        'DEFAULT_TIMEOUT': WEBHOOKS_REDIS_DEFAULT_TIMEOUT,
+        'SSL': WEBHOOKS_REDIS_SSL,
     }
 }