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

Ouverte
  • Quelque chose ne va pas ?
#9,734 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
45/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
aws, node.js, redis, typescript
Domaine
backend, databases

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
29.8k
Forks
3.9k
Merge moyen
1 h 44 min
PR mergées (30 j)
841

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de simstudioai/sim

Toutes les issues de simstudioai/sim

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.