byjg/easy-haproxy

Easy HAProxy

该Docker镜像可基于Docker容器标签或YAML文件动态生成haproxy.cfg，实现HAProxy的自动化配置。

核心功能和特性

• 启用/禁用1936端口的统计页面，支持自定义密码
• 基于Docker标签自动发现并配置HAProxy
• 基于Docker标签配置请求重定向
• 通过YAML文件静态配置HAProxy

使用场景和适用范围

适用于需要快速部署和动态管理HAProxy的场景，尤其适合Docker或Swarm环境中多容器服务的负载均衡配置，也支持静态YAML配置的使用场景。

使用方法和配置说明

基本用法

Easy HAProxy会根据容器标签或提供的YAML文件自动创建haproxy.cfg。基本运行命令如下：

bash
docker run -d \ 
    --name easy-haproxy-container \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -e DISCOVER="swarm|docker|static" \
    # + 环境变量 \
    # + 映射到主机的端口 \
    byjg/easy-haproxy

说明：

• 必须挂载/var/run/docker.sock以发现Docker容器并获取标签；
• 通过环境变量配置HAProxy的各项参数。

环境变量配置

详细配置指南

DISCOVER模式说明

1. docker模式

适用于常规Docker环境，通过容器标签自动发现并配置HAProxy。要求Easy HAProxy与目标容器处于同一Docker网络，配置每1分钟自动更新。

网络创建示例：

bash
docker create network easyhaproxy
docker run --network easyhaproxy docker.xuanyuan.run/byjg/easy-haproxy
docker run --network easyhaproxy docker.xuanyuan.run/myimage # 目标容器需加入同一网络

2. swarm模式

适用于Docker Swarm集群，通过服务部署标签（deploy层级）自动发现配置，配置每1分钟自动更新。要求Easy HAProxy与目标服务处于同一网络。

Stack部署标签示例：

yaml
services:
  foo:
    deploy:
      labels:
        com.byjg.easyhaproxy.definitions: "http,https"
        # 其他标签参数...

容器/服务标签说明

单一定义示例：

bash
docker run \
    -l com.byjg.easyhaproxy.definitions=http \
    -l com.byjg.easyhaproxy.port.http=80 \
    -l com.byjg.easyhaproxy.host.http=byjg.com.br \
    docker.xuanyuan.run/myimage

多定义示例：

bash
docker run \
    -l com.byjg.easyhaproxy.definitions=express,admin \
    # express定义
    -l com.byjg.easyhaproxy.port.express=80 \
    -l com.byjg.easyhaproxy.localport.express=3000 \
    -l com.byjg.easyhaproxy.host.express=express.byjg.com.br \
    # admin定义
    -l com.byjg.easyhaproxy.port.admin=80 \
    -l com.byjg.easyhaproxy.localport.admin=3001 \
    -l com.byjg.easyhaproxy.host.admin=admin.byjg.com.br \
    myimage

重定向示例：

bash
docker run \
    -l com.byjg.easyhaproxy.redirect.http=www.byjg.com.br--http://byjg.com.br,byjg.com--http://byjg.com.br \
    docker.xuanyuan.run/myimage

3. static模式

通过YAML文件静态配置HAProxy，需将YAML文件挂载至容器内/etc/haproxy/easyconfig.yml。

YAML配置示例：

yaml
stats:
  username: admin
  password: password
  port: 1936  # 可选，默认1936

customerrors: true  # 可选，默认false

easymapping:
  - port: 80
    hosts:
      host1.com.br: container:5000
      host2.com.br: other:3000
    redirect:
      www.host1.com.br: http://host1.com.br
      
  - port: 443
    ssl_cert: BASE64_PEM_CERTIFICATE  # Base64编码的PEM证书
    hosts:
      host1.com.br: container:80

  - port: 8080
    hosts:
      host3.com.br: domain:8181

运行命令：

bash
docker run -v /path/to/easyconfig.yml:/etc/haproxy/easyconfig.yml docker.xuanyuan.run/byjg/easy-haproxy

映射自定义.cfg文件

将包含HAProxy配置文件（.cfg）的目录挂载至/etc/haproxy/conf.d，文件内容将被合并到最终的haproxy.cfg中。

bash
docker run \
    -v /your/local/conf.d:/etc/haproxy/conf.d \
    docker.xuanyuan.run/byjg/easy-haproxy

处理SSL证书

1. 创建PEM文件：合并证书和私钥为单个PEM文件

   bash
   cat example.com.crt example.com.key > single.pem
   

2. 转换为Base64编码（单行）：

   bash
   cat single.pem | base64 -w0
   

3. 配置标签：将Base64字符串设置为com.byjg.easyhaproxy.sslcert.[definition]标签的值

设置自定义错误页面

启用HAPROXY_CUSTOMERRORS=true后，挂载目录/etc/haproxy/errors-custom/至容器，放入命名为ERROR_NUMBER.http的文件（如503.http），其中ERROR_NUMBER为HTTP错误码。

构建镜像

bash
docker build -t byjg/easy-haproxy .