deliveroo/nginx-sidecar

nginx-sidecar

概述

nginx-sidecar是一个简单的nginx反向代理边车，可置于应用Web容器前方，用于请求排队及向New Relic提供请求排队统计信息。

核心功能与特性

• 反向代理：作为应用容器的前端代理，处理入站请求
• 请求排队：对请求进行排队管理，优化请求处理流程
• 统计功能：向New Relic提供请求排队相关的统计数据

使用要求

• 应用容器必须通过Docker --link或ECS links配置链接为app
• 需设置环境变量NGINX_PORT：指定nginx边车绑定的端口
• 需设置环境变量APP_PORT：指定应用容器内部绑定的端口

使用场景

适用于需要在Web应用前添加反向代理层以实现请求排队管理和请求统计的容器化部署场景，尤其适合需要监控请求处理状态的应用。

使用方法与配置说明

容器配置要点

1. 应用容器配置：

   • 按常规定义应用容器，但无需包含portMappings部分
   • 确保容器可通过链接被边车容器访问

2. nginx边车容器配置：

   • 指定边车镜像
   • 配置CPU和内存资源
   • 设置与应用容器的链接（links）
   • 配置端口映射（portMappings）
   • 设置环境变量NGINX_PORT和APP_PORT

部署示例

在.hopper/config.yml中的配置示例：

yaml
# ...

services:
  web:
    containerDefinitions:
      # 应用容器，按常规定义，但无需`portMappings`部分：
      app:
        cpu: 1024
        memory: 1024
        essential: true
        command: "exec puma -p 3001 -C config/puma.rb"

      # 为nginx边车添加单独的`containerDefinition`
      # 边车不关心该容器的名称，但需与应用Terraform中的`process_name`匹配，因为Hopper会在此处查找绑定端口
      web:
        # 指定边车镜像（需替换为实际镜像地址）
        image: 517902663915.dkr.ecr.eu-west-1.amazonaws.com/nginx-sidecar:740797ae4525cceb81625dd70b0035516aaf80ba

        cpu: 128
        memory: 256
        essential: true

        # 链接应用容器，使边车可转发请求
        # 若应用容器名称不是`app`（如`appcontainer`），可使用`appcontainer:app`指定
        links:
        - app

        portMappings:
        - containerPort: 3000

        # 指定nginx监听端口（需与上述portMappings匹配）和应用容器监听端口
        environment:
        - name: NGINX_PORT
          value: '3000'
        - name: APP_PORT
          value: '3001'

  # ...

注意事项

该边车依赖Docker/ECS的legacy --link标志，且需要使用桥接（bridged）网络模式。