[REQUEST] Support Redis Cluster mode (AWS ElastiCache cluster-mode-enabled)

Offen
  • Stimmt etwas nicht?
#9,734 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
aws, node.js, redis, typescript
Bereich
backend, databases

Rechercherichtung

Start by locating the standalone ioredis client construction and the Redis pub/sub paths; the issue does not name their files, so search for REDIS_URL and the subscriber setup. Check how TLS settings reach the client and how live status handles subscriptions. Done means cluster mode can connect to Redis Cluster with TLS and key/value operations and live status both work; the issue leaves the configuration shape and pub/sub approach open.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Is your feature request related to a problem? Please describe.

Self-hosted Sim cannot use a Redis Cluster, which rules out AWS ElastiCache in
cluster-mode-enabled (and ElastiCache Serverless, which requires a cluster-capable
client). The only managed option left is a cluster-mode-disabled replication group,
which caps scaling at a single primary.

The env surface is a single endpoint:

REDIS_URL:            z.string().url().optional()
REDIS_TLS_SERVERNAME: z.string().min(1).optional()

There is no cluster flag and no seed-node list, and Sim never constructs an ioredis
Cluster — a standalone client is built from that one URL. Pointing it at a
configuration endpoint connects to a single shard, so any key hashing to another
slot fails with MOVED.

Notably ioredis 5.11.1 is already bundled and exports Cluster, so the capability
is present in the dependency tree and simply isn't reachable through configuration.

Describe the solution you'd like

Let REDIS_URL (or an additional variable) drive an ioredis Cluster client when
cluster mode is requested. Something like:

  • REDIS_CLUSTER_MODE=true, or a comma-separated REDIS_CLUSTER_NODES, selecting
    new Redis.Cluster(nodes, opts) instead of new Redis(url)
  • the existing REDIS_TLS_SERVERNAME / rediss:// handling carried through to
    redisOptions, since in-transit encryption is the norm on ElastiCache

The pub/sub paths matter as much as the key/value ones here: cluster pub/sub needs
either sharded pub/sub (SSUBSCRIBE) or a node-aware subscriber, so a transparent
swap of the client constructor alone may not be sufficient for live status.

Describe alternatives you've considered

  • Cluster-mode-disabled replication group — what I'm doing now. Works, but it
    caps scaling at a single primary.
  • A cluster-aware proxy (Envoy Redis filter, twemproxy) — not viable. Envoy's
    Redis proxy does not support pub/sub, which is exactly what Sim needs Redis for.
    Caching would work while live status silently never streams.
  • Patching Sim to build a Cluster — possible since ioredis is already present,
    but that means maintaining a fork and rebuilding the image on every upgrade.

Additional context

Observed on ghcr.io/simstudioai/simstudio:latest (pulled 2026-11-06), ioredis
5.11.1, Docker Compose self-host.

Per the compose comments, Redis is optional for storage (Postgres is the fallback)
but the pub/sub channels have no fallback — so for anyone wanting live status on a
managed Redis, the cluster-mode constraint decides the architecture. Happy to test
a patch against ElastiCache if that's useful.

Vorherrschende Sprache
TypeScript
Sterne
29.8k
Forks
3.9k
Ø Merge
1 Std. 44 Min.
Gemergte PRs (30 T.)
841

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus simstudioai/sim

Alle Issues in simstudioai/sim

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.