cyre/nginx-l4-proxy-helper

nginx-l4-proxy配置自动生成辅助容器

概述

该镜像作为辅助工具容器，专注于自动生成nginx-l4-proxy的配置文件，旨在简化nginx-l4-proxy的配置管理流程，减少手动配置工作量及错误风险，提升部署效率。

核心功能与特性

• 配置自动化：支持基于输入参数或配置源自动生成nginx-l4-proxy所需的配置文件
• 标准化配置：通过预设规则生成符合nginx-l4-proxy规范的配置，降低手动编写错误率
• 无缝集成：可直接与nginx-l4-proxy容器配合使用，形成完整的配置-部署流程
• 灵活扩展：支持自定义配置模板，适应不同场景下的个性化配置需求

使用场景与适用范围

• 部署nginx-l4-proxy作为四层负载均衡器的环境
• 需要频繁更新或动态调整nginx-l4-proxy配置的场景
• 微服务架构中为多个服务自动生成负载均衡规则的场景
• 多环境（开发、测试、生产）部署时快速生成环境适配配置的场景

使用方法

基本工作流程

1. 运行辅助容器并指定配置生成参数
2. 容器自动生成nginx-l4-proxy配置文件
3. 将生成的配置文件挂载到nginx-l4-proxy容器中使用

Docker Run命令示例

bash
docker run -v /host/config-source:/input \
           -v /host/generated-config:/output \
           [镜像名称] \
           --input /input/proxy-rules.yaml \
           --output /output/nginx-l4.conf

Docker Compose配置示例

yaml
version: '3.8'
services:
  config-generator:
    image: docker.xuanyuan.run/[镜像名称]
    volumes:
      - ./proxy-rules:/input
      - ./nginx-l4-config:/output
    command: --input /input/rules.yaml --output /output/default.conf
  
  nginx-l4-proxy:
    image: docker.xuanyuan.run/nginx-l4-proxy
    volumes:
      - ./nginx-l4-config:/etc/nginx-l4
    ports:
      - "80:80"
      - "443:443"
    depends_on:
      - config-generator

配置参数说明

命令行参数

• --input：配置源文件路径（必填），指定包含代理规则的输入文件（支持YAML/JSON格式）
• --output：生成配置文件路径（必填），指定输出的nginx-l4-proxy配置文件位置
• --template：自定义模板路径（可选），指定生成配置使用的自定义模板文件，默认使用内置模板

环境变量配置

• INPUT_PATH：替代--input参数，通过环境变量指定配置源文件路径
• OUTPUT_PATH：替代--output参数，通过环境变量指定配置输出路径
• LOG_LEVEL：日志输出级别（可选，默认info），可选值：debug、info、warn、error

注意事项

• 输入配置源文件需遵循指定格式，否则可能导致配置生成失败
• 生成的配置文件需确保权限正确，以便nginx-l4-proxy容器可读取
• 建议对输入配置文件进行版本控制，便于追踪配置变更历史