malexer/twemproxy

twemproxy Docker镜像文档

镜像概述和主要用途

本镜像提供一个极小（<7mb）的twemproxy服务器（又称nut***er）Docker镜像，基于轻量级的Alpine Linux构建。twemproxy是一款高性能的Redis代理服务器，主要用于实现Redis集群的负载均衡、故障转移和连接池管理。本镜像特别适合作为sidecar容器与Redis集群配合使用，提供轻量级的代理解决方案。

核心功能和特性

• 超小体积：镜像大小小于7mb，仅包含运行twemproxy所需的必要依赖
• 轻量基础：基于Alpine Linux，减少资源占用和***面
• 灵活配置：支持通过环境变量快速配置，也可提供完整自定义配置文件
• 优雅关闭：支持twemproxy的优雅关闭（发送SIGINT信号）
• 透明构建：提供Dockerfile源码仓库，可查看内部构造确保安全性
• 可扩展性：可作为基础镜像轻松扩展，满足特定需求

使用场景和适用范围

• 需要轻量级Redis代理的微服务架构
• Kubernetes等容器编排平台中的sidecar模式部署
• 对镜像体积有严格要求的资源受限环境
• 需要快速配置和部署twemproxy的开发/测试环境
• 要求代理服务具备故障自动转移能力的生产环境

详细使用方法和配置说明

快速开始

通过环境变量REDIS_SERVERS指定Redis服务器列表即可快速使用。以下是创建自定义镜像的示例：

dockerfile
FROM malexer/twemproxy:latest

ENV REDIS_SERVERS 127.0.1.1:6379:1,127.0.1.2:6379:1,127.0.1.3:6379:1

容器启动时会自动生成如下默认配置：

yaml
pool:
    listen: 0.0.0.0:6380
    hash: fnv1a_64
    distribution: ketama
    redis: true
    auto_eject_hosts: true
    timeout: 2000
    server_retry_timeout: 5000
    server_failure_limit: 1
    server_connections: 40
    preconnect: true
    servers:
        - 127.0.1.1:6379:1
        - 127.0.1.2:6379:1
        - 127.0.1.3:6379:1

高级配置

本镜像提供两种高级配置方式：通过环境变量自定义部分配置，或提供完整的自定义配置文件。

通过环境变量配置

twemproxy配置将基于以下模板生成：

yaml
pool:
    listen: 0.0.0.0:${LISTEN_PORT}
    hash: fnv1a_64
    distribution: ketama
    redis: true
    auto_eject_hosts: ${AUTO_EJECT_HOSTS}
    timeout: ${TIMEOUT}
    server_retry_timeout: ${SERVER_RETRY_TIMEOUT}
    server_failure_limit: ${SERVER_FAILURE_LIMIT}
    server_connections: ${SERVER_CONNECTIONS}
    preconnect: ${PRECONNECT}
    servers:
        <LIST of SERVERS from ${REDIS_SERVERS}>

默认环境变量值：

使用方法：

至少需要重新定义REDIS_SERVERS环境变量。配置在容器启动时生成，因此可以在docker run命令或docker-compose配置中指定环境变量：

bash
docker run -d -e REDIS_SERVERS="redis1:6379:1,redis2:6379:1" -p 6380:6380 malexer/twemproxy:latest

注意：如果重新定义LISTEN_PORT，需要在自定义Dockerfile中同步修改EXPOSE指令。

自定义配置文件

创建完整的twemproxy配置文件，并复制到镜像的/etc/nutcracker.conf路径。初始化脚本会检测到自定义配置并跳过环境变量生成步骤。

示例配置文件（yourconfig.conf）：

yaml
staging:
    listen: 0.0.0.0:11380
    hash: fnv1a_64
    distribution: ketama
    servers:
        - server1:6379:1
        - server2:6379:1

自定义Dockerfile：

dockerfile
FROM malexer/twemproxy:latest

COPY yourconfig.conf /etc/nutcracker.conf

EXPOSE 11380

构建并运行自定义镜像：

bash
docker build -t my-twemproxy .
docker run -d -p ***:*** my-twemproxy