patrickdk/redis-sentinel-proxy

redis-sentinel-proxy

镜像概述和主要用途

redis-sentinel-proxy是一个轻量级命令行工具，旨在解决Redis集群中主节点动态变化的访问问题。它通过定期查询Redis Sentinel服务器，自动获取指定主节点组的当前主节点地址，并将所有接收到的TCP请求转发至该主节点，使客户端无需直接感知主节点变化即可持续访问Redis服务。

核心功能和特性

• 自动主节点发现：定期向Redis Sentinel查询指定主节点组的当前主节点地址
• TCP请求代理：将绑定端口上的所有TCP请求转发至当前主节点
• 动态跟踪机制：支持配置轮询间隔（CHECKMS），实时检测主节点变化并更新代理目标
• 灵活配置选项：通过环境变量或命令行参数配置监听地址、Sentinel地址、认证密码、超时时间等关键参数
• 稳定性保障：提供连接超时控制（TIMEOUTMS）和调试输出（DEBUG）功能，便于问题排查

使用场景和适用范围

适用于采用Redis Sentinel进行主从复制和故障转移的Redis集群环境。当主节点发生故障并由Sentinel自动切换后，客户端可通过该代理工具继续访问新主节点，无需手动更新配置。尤其适合无法直接处理Sentinel协议的客户端或需要简化Redis访问配置的场景。

使用方法和配置说明

1. 配置参数说明

支持通过环境变量或命令行参数进行配置，参数说明如下：

2. 运行代理（Kubernetes环境）

步骤1：编辑部署配置文件

修改Kubernetes部署清单，配置主节点组名称和Sentinel地址：

bash
vim kubernetes/redis-sentinel-proxy-deployment.yaml
...
        args:
          - "-master"
          - "primary"  # 指定主节点组名称（替换为实际名称）
          - "-sentinel"
          - "redis-sentinel.$(NAMESPACE):26379"  # 替换为实际Sentinel服务地址

步骤2：应用部署配置

使用kubectl创建或更新deployment资源：

bash
kubectl apply -f kubernetes/redis-sentinel-proxy-deployment.yaml
deployment "redis-sentinel-proxy" configured

步骤3：检查部署状态

确认代理Pod正常运行：

bash
kubectl get pods
redis-sentinel-proxy-2064359825-s4n0k   1/1       Running   0          1d

步骤4：暴露代理服务

通过Service资源暴露代理，使客户端可访问：

bash
kubectl apply -f kubernetes/redis-sentinel-proxy-service.yaml

命令行参数格式

工具支持通过命令行参数直接配置，基础格式如下：

bash
./redis-sentinel-proxy -listen IP:PORT -sentinel :SENTINEL_PORT -master NAME

注：命令行参数与环境变量功能对应，具体优先级以工具实现为准（通常命令行参数优先级更高）。