Redis Proxy

This is a simple network proxy for use in master-slave-sentinel redis deployments. The rust proxy queries the sentinel for each incoming client, then proxies incoming connections to the current master cache. The proxy also keeps track of known caches, to assist the proxy when the sentinel is unavailable.

Installation

Once rust has been installed, simply run:

cargo install --git https://github.com/findelabs/redis-rust-proxy.git

Arguments

USAGE:
    redis-rust-proxy [FLAGS] [OPTIONS] --master <master> --sentinel <sentinel>

FLAGS:
    -d, --debug      enable debugging
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -l, --listen <socket>                        listening socket [env: LISTEN_ADDR=]  [default: 0.0.0.0:6379]
    -m, --master <master>                        the sentinel's name for the cache [env: MASTER_NAME=]
    -p, --password <password>                    use redis auth [env: REDIS_PASSWORD=]  [default: ]
    -s, --sentinel <sentinel>                    sentinel address [env: SENTINEL_ADDR=]
    -t, --sentinel_timeout <sentinel_timeout>    sentinel connection timeout [env: SENTINEL_TIMEOUT=]  [default: 10]

Testing

You can deploy a test cluster with a master, slave, sentinel, and proxy, with the docker-compose.yml file under examples/. Creation of the cluster is as simple as:

# Install docker-compose
sudo wget -O /usr/local/bin/docker-compose https://github.com/docker/compose/releases/download/1.27.4/docker-compose-Linux-x86_64 && sudo chmod +x /usr/local/bin/docker-compose

# Run docker-compose
sudo docker-compose -f examples/docker-compose.yml up --build --remove-orphans