Add support for Redis Sentinel sessions. (librenms#17203)

* Add support for Redis Sentinel sessions.
Updated Redis configuration to use environment variables for connections

* lint: fix database.php

* fix: Leftover cluster variable casued redis+sentinel to fail
If cluster is really needed, functionality for determining if cluster is used, shall be added. Having this variable in the config-file was causing redis+sentinel based solution to fail (only this particular set-up, normal redis was fine)

* Fix redis session config.

* docs: rename connection -> driver for redis session

* Style CI

* revert session config changes

This reverts commit 79ba4d9

* Revert cache config change

This partially reverts commit a997981.

* docs: Ensure that sessions use redis as well

* fix: remove php-logic for redis-sentinel

* docs: Update variables used for redis-sentinel configuration.

This aligns with the config changes.

* style ci

---------

Co-authored-by: Justin Lentz <[email protected]>

Author: dot-mike

config/database.php

@@ -125,7 +125,6 @@
         'client' => env('REDIS_CLIENT', 'predis'),
 
         'options' => [
-            'cluster' => env('REDIS_CLUSTER', 'redis'),
             'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_') . '_database_'),
         ],
 
@@ -149,6 +148,30 @@
             'database' => env('REDIS_CACHE_DB', '1'),
         ],
 
+        'sentinel_session' => [
+            ...explode(',', env('REDIS_SENTINEL_HOSTS', '')),
+            'options' => [
+                'replication' => 'sentinel',
+                'service' => env('REDIS_SENTINEL_SERVICE', 'mymaster'),
+                'parameters' => [
+                    'password' => env('REDIS_PASSWORD', ''),
+                    'database' => env('REDIS_SESSION_DB', '0'),
+                ],
+            ],
+        ],
+
+        'sentinel_cache' => [
+            ...explode(',', env('REDIS_SENTINEL_HOSTS', '')),
+            'options' => [
+                'replication' => 'sentinel',
+                'service' => env('REDIS_SENTINEL_SERVICE', 'mymaster'),
+                'parameters' => [
+                    'password' => env('REDIS_PASSWORD', ''),
+                    'database' => env('REDIS_CACHE_DB', '1'),
+                ],
+            ],
+        ],
+
     ],
 
 ];

doc/Extensions/Redis-Sentinel.md

@@ -16,18 +16,30 @@ To configure the Web UI to use a Redis Sentinel cluster, add the following param
 
 ```
 # Configure these values according to your environment
-REDIS_SENTINEL=192.168.1.10:26379,192.168.1.11:26379,192.168.1.12:26379
+REDIS_SENTINEL_HOSTS=redis://192.168.1.10:26379,redis://192.168.1.11:26379,redis://192.168.1.12:26379
 REDIS_SENTINEL_SERVICE=mymaster
-REDIS_SENTINEL_PASSWORD=your_sentinel_password
+# optionally set password if your redis-backend has it enabled, this is not for sentinel.
 REDIS_PASSWORD=your_redis_password
 
 # These values tell the web app to use Sentinel as the Redis backend - do not change
 REDIS_BROADCAST_CONNECTION=sentinel_cache
 REDIS_CACHE_CONNECTION=sentinel_cache
 REDIS_LOCK_CACHE_CONNECTION=sentinel_cache
+SESSION_DRIVER=redis
 SESSION_CONNECTION=sentinel_session
 ```
 
+### Redis Sentinel Authentication
+
+If your Redis Sentinel cluster is password-protected, you need to append `password=your_redis_password` to each Redis Sentinel URL in the `REDIS_SENTINEL_HOSTS` variable.
+Optionally, if you are using ACLs, you must also include `username=your_redis_username` in the URL.
+
+For example:
+
+```
+REDIS_SENTINEL_HOSTS=redis://192.168.1.10:26379?password=your_redis_password,redis://192.168.1.11:26379?password=your_redis_password,redis://192.168.1.12:26379?password=your_redis_password
+```
+
 ### Poller Configuration
 
 To configure the Poller to use a Redis Sentinel cluster, add the following to your `.env` file: