@@ -20,9 +20,9 @@ to utilize a cluster of servers to provide redundancy and/or fail-over is also a
20
20
21
21
**Requirements: ** At least one `Redis server `_ must be installed and running to use this
22
22
adapter. Additionally, this adapter requires a compatible extension or library that implements
23
- ``\Redis ``, ``\RedisArray ``, ``RedisCluster ``, ``\Relay\Relay `` or ``\Predis ``.
23
+ ``\Redis ``, ``\RedisArray ``, ``RedisCluster ``, ``\Relay\Relay ``, `` \Relay\Cluster `` or ``\Predis ``.
24
24
25
- This adapter expects a `Redis `_, `RedisArray `_, `RedisCluster `_, `Relay `_ or `Predis `_ instance to be
25
+ This adapter expects a `Redis `_, `RedisArray `_, `RedisCluster `_, `Relay `_, ` RelayCluster `_ or `Predis `_ instance to be
26
26
passed as the first parameter. A namespace and default cache lifetime can optionally be passed
27
27
as the second and third parameters::
28
28
@@ -48,6 +48,10 @@ as the second and third parameters::
48
48
?MarshallerInterface $marshaller = null
49
49
);
50
50
51
+ .. versionadded :: 7.3
52
+
53
+ Support for ``Relay\Cluster `` was introduced in Symfony 7.3.
54
+
51
55
Configure the Connection
52
56
------------------------
53
57
@@ -226,11 +230,34 @@ Available Options
226
230
``ssl `` (type: ``array ``, default: ``null ``)
227
231
SSL context options. See `php.net/context.ssl `_ for more information.
228
232
233
+ ``relay_cluster_context `` (type: ``array ``, default: ``[] ``)
234
+ Defines configuration options specific to ``\Relay\Cluster ``. For example, to
235
+ user a self-signed certificate for testing in local environment::
236
+
237
+ $options = [
238
+ // ...
239
+ 'relay_cluster_context' => [
240
+ // ...
241
+ 'stream' => [
242
+ 'verify_peer' => false,
243
+ 'verify_peer_name' => false,
244
+ 'allow_self_signed' => true,
245
+ 'local_cert' => '/valkey.crt',
246
+ 'local_pk' => '/valkey.key',
247
+ 'cafile' => '/valkey.crt',
248
+ ],
249
+ ],
250
+ ];
251
+
229
252
.. versionadded :: 7.1
230
253
231
254
The option ``sentinel_master `` as an alias for ``redis_sentinel `` was introduced
232
255
in Symfony 7.1.
233
256
257
+ .. versionadded :: 7.3
258
+
259
+ The ``relay_cluster_context `` option was introduced in Symfony 7.3.
260
+
234
261
.. note ::
235
262
236
263
When using the `Predis `_ library some additional Predis-specific options are available.
@@ -359,6 +386,7 @@ Supports key rotation, ensuring secure decryption with both old and new keys::
359
386
.. _`RedisArray` : https://github.com/phpredis/phpredis/blob/develop/arrays.md
360
387
.. _`RedisCluster` : https://github.com/phpredis/phpredis/blob/develop/cluster.md
361
388
.. _`Relay` : https://relay.so/
389
+ .. _`RelayCluster` : https://relay.so/docs/1.x/connections#cluster
362
390
.. _`Predis` : https://packagist.org/packages/predis/predis
363
391
.. _`Predis Connection Parameters` : https://github.com/nrk/predis/wiki/Connection-Parameters#list-of-connection-parameters
364
392
.. _`TCP-keepalive` : https://redis.io/topics/clients#tcp-keepalive
0 commit comments