Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] note keyspace notifications, persistence requirement for redis #246

Merged
merged 1 commit into from
May 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/source/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,23 @@ c.JupyterHub.proxy_class = "traefik_redis"

**TraefikRedisProxy does not manage the Redis cluster** and assumes it is up and running before the proxy itself starts.

In order for traefik to reliably receive notifications of changes from redis, redis must enable [keyspace notifications](https://redis.io/docs/latest/develop/use/keyspace-notifications/),
e.g. with

```
--notify-keyspace-events KEA
```

To avoid losing configuration upon redis restart, the redis server should also enable persistence, e.g. with

```
--appendonly yes
```

:::

:::{note}

Based on how Redis is configured and started, TraefikRedisProxy needs to be told about some Redis configuration details, such as:

- Redis **address** where it accepts client requests
Expand Down