Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Commit 1a2fd47

Browse files
author
Pablo Mercado
authored
Merge pull request #355 from triggermesh/task/add-redis-cluster-support
Add redis cluster support
2 parents c421869 + 6640ec7 commit 1a2fd47

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/brokers/redisbroker.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
The Redis Broker uses a backing Redis instance to store events, thereby providing durability that is suitable for production uses cases where event loss in not acceptable during crashes or restarts.
44

5-
The management of the Redis instance is greatly simplified by TriggerMesh. It is also possible to point the Broker to any Redis instance, such as a managed instance from a cloud provider.
5+
The management of the Redis instance is greatly simplified by TriggerMesh. It is also possible to point the Broker to any Redis instance, such as a managed instance from a cloud provider.
66

77
With `tmctl`:
88

99
!!! warning "Work in progress"
1010
This component is not yet available with `tmctl`. By default, Brokers created with `tmctl` are [Memory Brokers](memorybroker.md). However, when you export your configuration to Kubernetes manifests using `tmctl dump`, TriggerMesh will export a `Redis Broker`, thereby providing message durability by default. You can switch to a Memory Broker if you prefer by updating the exported manifest.
1111

12-
TriggerMesh will add support for Redis Broker in `tmctl` in the future.
12+
TriggerMesh will add support for Redis Broker in `tmctl` in the future.
1313

1414
On Kubernetes:
1515

@@ -21,7 +21,9 @@ metadata:
2121
spec:
2222
redis:
2323
connection: <Provides a connection to an external Redis instance. Optional>
24-
url: <redis URL. Required>
24+
url: <redis URL. Required if clusterURLs not informed>
25+
clusterURLs:
26+
- <an entry for each redis URL in the cluster. Required if url not informed>
2527
username: <redis username, referenced using a Kubernetes secret>
2628
secretKeyRef:
2729
name: <Kubernetes secret name>
@@ -43,6 +45,8 @@ spec:
4345
The only `RedisBroker` specific parameters are:
4446

4547
- `spec.redis.connection`. When not used the broker will spin up a managed Redis Deployment. However for production scenarios that require HA and hardened security it is recommended to provide the connection to a user managed Redis instance.
48+
- `spec.redis.connection.url`. URL to the standalone Redis instance. This should not be informed for Redis clusters.
49+
- `spec.redis.connection.clusterURLs`. Array of URLs to each node of a Redis cluster. This should not be informed for standalone Redis.
4650
- `spec.stream` is the Redis stream name to be used by the broker. If it doesn't exists the Broker will create it.
4751
- `spec.streamMaxLen` is the maximum number of elements that the stream will contain.
4852

0 commit comments

Comments
 (0)