Skip to content

Commit

Permalink
Add docs on active redirection
Browse files Browse the repository at this point in the history
  • Loading branch information
doyoubi committed Apr 11, 2020
1 parent 0537b54 commit 9105816
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- Cluster management through HTTP API
- Automatic failover for both master and replica
- Fast scaling
- Both cluster-mode clients and non-cluster-mode clients.
- String value compression

Any storage system implementing redis protocol could also somehow work with undermoon,
Expand Down Expand Up @@ -200,6 +201,7 @@ $ curl -XDELETE http://localhost:7799/api/v2/proxies/meta/server_proxy3:6003
- [Chunk](./docs/chunk.md)
- [Slot Migration](./docs/slots_migration.md)
- [Memory Broker Replica](./docs/mem_broker_replica.md)
- [Configure to support non-cluster-mode clients](./docs/active_redirection.md)

## API
- [Proxy UMCTL command](./docs/meta_command.md)
Expand Down
16 changes: 16 additions & 0 deletions docs/active_redirection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Active Redirection Mode
When server proxies run in `active redirection` mode,
they will expose themselves in a single Redis client protocol.
Clients don't need to support [Redis Cluster Protocol](./redis_cluster_protocol.md).

## Enable Active Redirection
Inside the server proxy config file`server-proxy.toml`,
set `active_redirection` to `true`,
or use environment variable `UNDERMOON_ACTIVE_REDIRECTION=true`.

## How it works?
When `active redirection` mode is enabled,
a server proxy will automatically redirect the requests to other server proxies.
Then if needed, other server proxies will keep redirecting the requests
until they find the owner or exceed maximum redirection limit
set by `max_redirections` in server proxy config file.

0 comments on commit 9105816

Please sign in to comment.