Skip to content

Commit 7cb83fc

Browse files
committed
docs: remove redis-stream-garnet, update docs for all destinations
- Remove redis-stream-garnet quickstart entirely (Garnet doesn't support XADD/Redis Streams, see github.com/microsoft/garnet/issues/64) - redis-stream.md: remove Garnet from compatible systems, add warning, add Quick Starts and See Also sections - redis-pubsub.md: add Quick Starts and See Also sections - support-matrix.md: remove redis-stream-garnet quickstart references, add Garnet limitation warning, clarify Pub/Sub only in matrix - overview.md: add Garnet to redis-pubsub compatible systems
1 parent 159458d commit 7cb83fc

7 files changed

Lines changed: 57 additions & 39 deletions

File tree

docs/user-guide/destinations/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ For detailed information about each loader and their properties, see **[Certific
248248
| **[amqp-1](amqp-1.md)** | AMQP 1 | ActiveMQ Artemis, Azure Service Bus, Azure Event Hubs, Qpid, RabbitMQ 4.0+ |
249249
| **[mqtt-3](mqtt-3.md)** | MQTT 3 | Mosquitto, HiveMQ, EMQX, VerneMQ, NanoMQ, RabbitMQ, AWS IoT, Azure IoT Hub |
250250
| **[mqtt-5](mqtt-5.md)** | MQTT 5 | HiveMQ, EMQX, VerneMQ, NanoMQ, Mosquitto 2.0+, RabbitMQ, Azure Event Grid |
251-
| **[redis-pubsub](redis-pubsub.md)** | Redis RESP | Redis, Valkey, Dragonfly, KeyDB, ElastiCache, Azure Cache for Redis, Upstash |
251+
| **[redis-pubsub](redis-pubsub.md)** | Redis RESP | Redis, Valkey, Dragonfly, KeyDB, Garnet, ElastiCache, Azure Cache for Redis, Upstash |
252252
| **[redis-stream](redis-stream.md)** | Redis RESP | Redis 5.0+, Valkey, Dragonfly, KeyDB, ElastiCache, Azure Cache for Redis, Upstash |
253253
| **[nats](nats.md)** | NATS Protocol | NATS Server, Synadia Cloud |
254254
| **[nats-jetstream](nats-jetstream.md)** | NATS JetStream | NATS Server, Synadia Cloud |

docs/user-guide/destinations/redis-pubsub.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,27 @@ kete.routes.auth-redis.destination.username=keycloak
186186
kete.routes.auth-redis.destination.password=secret
187187
kete.routes.auth-redis.destination.client-name=keycloak-events
188188
```
189+
190+
191+
192+
## Quick Starts
193+
194+
| Broker | Quickstart |
195+
|--------|------------|
196+
| Redis | [redis-pubsub-redis](../../quick-starts/redis-pubsub-redis/) |
197+
| Valkey | [redis-pubsub-valkey](../../quick-starts/redis-pubsub-valkey/) |
198+
| Dragonfly | [redis-pubsub-dragonfly](../../quick-starts/redis-pubsub-dragonfly/) |
199+
| KeyDB | [redis-pubsub-keydb](../../quick-starts/redis-pubsub-keydb/) |
200+
| Microsoft Garnet | [redis-pubsub-garnet](../../quick-starts/redis-pubsub-garnet/) |
201+
| Azure Cache for Redis | [redis-pubsub-azure-cache-for-redis](../../quick-starts/redis-pubsub-azure-cache-for-redis/) |
202+
| Upstash | [redis-pubsub-upstash](../../quick-starts/redis-pubsub-upstash/) |
203+
204+
205+
206+
## See Also
207+
208+
- [Redis Stream Destination](redis-stream.md) — Persistent alternative with consumer groups
209+
- [Serializers](../serializers/overview.md)
210+
- [Matchers](../matchers/overview.md)
211+
- [Event Types](../event-types.md)
212+
- [Certificate Loaders](../certificate-loaders/overview.md)

docs/user-guide/destinations/redis-stream.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Stream Keycloak events to Redis Stream for persistent, ordered message storage.
2222
| **Upstash** | Serverless Redis with Streams |
2323
| **Dragonfly** | Redis-compatible, multi-threaded |
2424
| **KeyDB** | Redis-compatible, multi-threaded |
25-
| **Microsoft Garnet** | High-performance Redis-compatible cache |
25+
26+
!!! warning "Microsoft Garnet"
27+
Garnet does **not** support Redis Streams (`XADD` command). Use [Redis Pub/Sub](redis-pubsub.md) with Garnet instead. See [github.com/microsoft/garnet/issues/64](https://github.com/microsoft/garnet/issues/64).
2628

2729

2830

@@ -239,3 +241,26 @@ kete.routes.trimmed-redis.destination.stream=keycloak-events
239241
kete.routes.trimmed-redis.destination.max-len=50000
240242
kete.routes.trimmed-redis.destination.approximate-trimming=true
241243
```
244+
245+
246+
247+
## Quick Starts
248+
249+
| Broker | Quickstart |
250+
|--------|------------|
251+
| Redis | [redis-stream-redis](../../quick-starts/redis-stream-redis/) |
252+
| Valkey | [redis-stream-valkey](../../quick-starts/redis-stream-valkey/) |
253+
| Dragonfly | [redis-stream-dragonfly](../../quick-starts/redis-stream-dragonfly/) |
254+
| KeyDB | [redis-stream-keydb](../../quick-starts/redis-stream-keydb/) |
255+
| Azure Cache for Redis | [redis-stream-azure-cache-for-redis](../../quick-starts/redis-stream-azure-cache-for-redis/) |
256+
| Upstash | [redis-stream-upstash](../../quick-starts/redis-stream-upstash/) |
257+
258+
259+
260+
## See Also
261+
262+
- [Redis Pub/Sub Destination](redis-pubsub.md) — Fire-and-forget alternative
263+
- [Serializers](../serializers/overview.md)
264+
- [Matchers](../matchers/overview.md)
265+
- [Event Types](../event-types.md)
266+
- [Certificate Loaders](../certificate-loaders/overview.md)

docs/user-guide/destinations/support-matrix.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This page provides a comprehensive cross-reference of message brokers and the de
1212
| **Valkey** ||||||||||||||
1313
| **Dragonfly** ||||||||||||||
1414
| **KeyDB** ||||||||||||||
15-
| **Microsoft Garnet** ||||||||||||||
15+
| **Microsoft Garnet** |||||||Pub/Sub only |||||||
1616
| **Amazon ElastiCache** ||||||||||||||
1717
| **Azure Cache for Redis** ||||||||||||||
1818
| **Google Cloud Memorystore** ||||||||||||||
@@ -233,15 +233,18 @@ Use `destination.kind=redis-pubsub` or `destination.kind=redis-stream`:
233233
- **Valkey** - Redis fork, fully compatible
234234
- **Dragonfly** - Redis-compatible, multi-threaded
235235
- **KeyDB** - Redis-compatible, multi-threaded
236-
- **Microsoft Garnet** - Redis-compatible, .NET-based
236+
- **Microsoft Garnet** - Redis-compatible, .NET-based (Pub/Sub only, no Streams)
237237
- **Amazon ElastiCache** - AWS-managed Redis
238238
- **Azure Cache for Redis** - Azure-managed Redis
239239
- **Google Cloud Memorystore** - GCP-managed Redis
240240
- **Upstash** - Serverless Redis
241241

242242
**Quickstarts available (Pub/Sub):** [redis-pubsub-redis](../../quick-starts/redis-pubsub-redis/), [redis-pubsub-valkey](../../quick-starts/redis-pubsub-valkey/), [redis-pubsub-dragonfly](../../quick-starts/redis-pubsub-dragonfly/), [redis-pubsub-keydb](../../quick-starts/redis-pubsub-keydb/), [redis-pubsub-garnet](../../quick-starts/redis-pubsub-garnet/), [redis-pubsub-azure-cache-for-redis](../../quick-starts/redis-pubsub-azure-cache-for-redis/), [redis-pubsub-upstash](../../quick-starts/redis-pubsub-upstash/)
243243

244-
**Quickstarts available (Streams):** [redis-stream-redis](../../quick-starts/redis-stream-redis/), [redis-stream-valkey](../../quick-starts/redis-stream-valkey/), [redis-stream-dragonfly](../../quick-starts/redis-stream-dragonfly/), [redis-stream-keydb](../../quick-starts/redis-stream-keydb/), [redis-stream-garnet](../../quick-starts/redis-stream-garnet/), [redis-stream-azure-cache-for-redis](../../quick-starts/redis-stream-azure-cache-for-redis/), [redis-stream-upstash](../../quick-starts/redis-stream-upstash/)
244+
**Quickstarts available (Streams):** [redis-stream-redis](../../quick-starts/redis-stream-redis/), [redis-stream-valkey](../../quick-starts/redis-stream-valkey/), [redis-stream-dragonfly](../../quick-starts/redis-stream-dragonfly/), [redis-stream-keydb](../../quick-starts/redis-stream-keydb/), [redis-stream-azure-cache-for-redis](../../quick-starts/redis-stream-azure-cache-for-redis/), [redis-stream-upstash](../../quick-starts/redis-stream-upstash/)
245+
246+
!!! warning "Microsoft Garnet"
247+
Garnet supports Redis Pub/Sub but does **not** support Redis Streams (`XADD`). See [github.com/microsoft/garnet/issues/64](https://github.com/microsoft/garnet/issues/64).
245248

246249
See: [Redis Pub/Sub Destination](redis-pubsub.md), [Redis Stream Destination](redis-stream.md)
247250

@@ -423,7 +426,6 @@ All quickstarts are in the `quick-starts/` directory:
423426
| Redis Stream | Valkey | `redis-stream-valkey/` |
424427
| Redis Stream | Dragonfly | `redis-stream-dragonfly/` |
425428
| Redis Stream | KeyDB | `redis-stream-keydb/` |
426-
| Redis Stream | Microsoft Garnet | `redis-stream-garnet/` |
427429
| Redis Stream | Azure Cache for Redis | `redis-stream-azure-cache-for-redis/` |
428430
| Redis Stream | Upstash | `redis-stream-upstash/` |
429431
| NATS | NATS Server | `nats-nats-server/` |

quick-starts/redis-stream-garnet/check-event-reception.ps1

Lines changed: 0 additions & 6 deletions
This file was deleted.

quick-starts/redis-stream-garnet/docker-compose.yml

Lines changed: 0 additions & 27 deletions
This file was deleted.

quick-starts/redis-stream-garnet/dont-run-this-quickstart

Whitespace-only changes.

0 commit comments

Comments
 (0)