Support Redis Sentinel auth and TLS

[keliansb]

Hello,

It seems that NetBox does not support authentication with Redis Sentinel, I get the following error :

185.249.243.12 - - [17/Aug/2022:15:23:31 +0000] "GET /login/ HTTP/1.1" 500 0 "-" "kube-probe/1.21"
/opt/netbox/venv/lib/python3.10/site-packages/django/views/debug.py:462: ExceptionCycleWarning: Cycle in the exception chain detected: exception 'No slave found for 'mymaster'' encountered again.
  warnings.warn(
Internal Server Error: /login/
Traceback (most recent call last):
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/cache.py", line 31, in _decorator
    return method(self, *args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/cache.py", line 98, in _get
    return self.client.get(key, default=default, version=version, client=client)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/client/default.py", line 260, in get
    raise ConnectionInterrupted(connection=client) from e
django_redis.exceptions.ConnectionInterrupted: Redis SlaveNotFoundError: No slave found for 'mymaster'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/views/generic/base.py", line 84, in view
    return self.dispatch(request, *args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/utils/decorators.py", line 46, in _wrapper
    return bound_method(*args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/views/decorators/debug.py", line 92, in sensitive_post_parameters_wrapper
    return view(request, *args, **kwargs)
  File "/opt/netbox/netbox/users/views.py", line 38, in dispatch
    return super().dispatch(*args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/views/generic/base.py", line 119, in dispatch
    return handler(request, *args, **kwargs)
  File "/opt/netbox/netbox/users/views.py", line 51, in get
    return render(request, self.template_name, {
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/shortcuts.py", line 24, in render
    content = loader.render_to_string(template_name, context, request, using=using)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/template/loader.py", line 62, in render_to_string
    return template.render(context, request)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/template/backends/django.py", line 62, in render
    return self.template.render(context)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/template/base.py", line 173, in render
    with context.bind_template(self):
  File "/usr/lib/python3.10/contextlib.py", line 135, in __enter__
    return next(self.gen)
  File "/opt/netbox/venv/lib/python3.10/site-packages/debug_toolbar/panels/templates/panel.py", line 45, in _request_context_bind_template
    context = processor(self.request)
  File "/opt/netbox/netbox/netbox/context_processors.py", line 13, in settings_and_registry
    'config': get_config(),
  File "/opt/netbox/netbox/netbox/config/__init__.py", line 27, in get_config
    _thread_locals.config = Config()
  File "/opt/netbox/netbox/netbox/config/__init__.py", line 47, in __init__
    self._populate_from_cache()
  File "/opt/netbox/netbox/netbox/config/__init__.py", line 70, in _populate_from_cache
    self.config = cache.get('config') or {}
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/cache.py", line 91, in get
    value = self._get(key, default, version, client)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/cache.py", line 38, in _decorator
    raise e.__cause__
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/client/default.py", line 258, in get
    value = client.get(key)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/commands/core.py", line 1705, in get
    return self.execute_command("GET", name)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/client.py", line 1235, in execute_command
    conn = self.connection or pool.get_connection(command_name, **options)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/connection.py", line 1387, in get_connection
    connection.connect()
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/sentinel.py", line 54, in connect
    return self.retry.call_with_retry(self._connect_retry, lambda error: None)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/retry.py", line 51, in call_with_retry
    raise error
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/retry.py", line 46, in call_with_retry
    return do()
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/sentinel.py", line 46, in _connect_retry
    for slave in self.connection_pool.rotate_slaves():
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/sentinel.py", line 138, in rotate_slaves
    raise SlaveNotFoundError(f"No slave found for {self.service_name!r}")
redis.sentinel.SlaveNotFoundError: No slave found for 'mymaster'

There are also old discussions/issues that talk about this :

• Redis Sentinel #7684
• Netbox with Redis Sentinel - Issue when calling /api/status #7817

It seems that TLS is not supported either, here is the returned error when connecting to Sentinel configured for TLS :

Internal Server Error: /login/
Traceback (most recent call last):
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/connection.py", line 1380, in get_connection
    connection = self._available_connections.pop()
IndexError: pop from empty list

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/views/generic/base.py", line 84, in view
    return self.dispatch(request, *args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/utils/decorators.py", line 46, in _wrapper
    return bound_method(*args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/views/decorators/debug.py", line 92, in sensitive_post_parameters_wrapper
    return view(request, *args, **kwargs)
  File "/opt/netbox/netbox/users/views.py", line 38, in dispatch
    return super().dispatch(*args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/views/generic/base.py", line 119, in dispatch
    return handler(request, *args, **kwargs)
  File "/opt/netbox/netbox/users/views.py", line 51, in get
    return render(request, self.template_name, {
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/shortcuts.py", line 24, in render
    content = loader.render_to_string(template_name, context, request, using=using)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/template/loader.py", line 62, in render_to_string
    return template.render(context, request)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/template/backends/django.py", line 62, in render
    return self.template.render(context)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django/template/base.py", line 173, in render
    with context.bind_template(self):
  File "/usr/lib/python3.10/contextlib.py", line 135, in __enter__
    return next(self.gen)
  File "/opt/netbox/venv/lib/python3.10/site-packages/debug_toolbar/panels/templates/panel.py", line 45, in _request_context_bind_template
    context = processor(self.request)
  File "/opt/netbox/netbox/netbox/context_processors.py", line 13, in settings_and_registry
    'config': get_config(),
  File "/opt/netbox/netbox/netbox/config/__init__.py", line 27, in get_config
    _thread_locals.config = Config()
  File "/opt/netbox/netbox/netbox/config/__init__.py", line 47, in __init__
    self._populate_from_cache()
  File "/opt/netbox/netbox/netbox/config/__init__.py", line 70, in _populate_from_cache
    self.config = cache.get('config') or {}
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/cache.py", line 91, in get
    value = self._get(key, default, version, client)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/cache.py", line 31, in _decorator
    return method(self, *args, **kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/cache.py", line 98, in _get
    return self.client.get(key, default=default, version=version, client=client)
  File "/opt/netbox/venv/lib/python3.10/site-packages/django_redis/client/default.py", line 258, in get
    value = client.get(key)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/commands/core.py", line 1705, in get
    return self.execute_command("GET", name)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/client.py", line 1235, in execute_command
    conn = self.connection or pool.get_connection(command_name, **options)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/connection.py", line 1382, in get_connection
    connection = self.make_connection()
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/connection.py", line 1422, in make_connection
    return self.connection_class(**self.connection_kwargs)
  File "/opt/netbox/venv/lib/python3.10/site-packages/redis/connection.py", line 962, in __init__
    super().__init__(**kwargs)
TypeError: Connection.__init__() got an unexpected keyword argument 'connection_pool'

Is this something that can be considered ?