openlmis/nginx

openlmis-nginx

镜像概述和主要用途

openlmis-nginx镜像基于官方Nginx镜像构建，集成https://www.consul.io/%EF%BC%88%E6%9C%8D%E5%8A%A1%E6%B3%A8%E5%86%8C%E4%B8%AD%E5%BF%83%EF%BC%89%E5%92%8Chttps://github.com/hashicorp/consul-template%EF%BC%8C%E5%9C%A8OpenLMIS%E7%8E%AF%E5%A2%83%E4%B8%AD%E5%85%85%E5%BD%93API%E7%BD%91%E5%85%B3%EF%BC%8C%E6%8F%90%E4%BE%9B%E5%8A%A8%E6%80%81%E8%B7%AF%E7%94%B1%E5%8A%9F%E8%83%BD%E3%80%82%E9%80%9A%E8%BF%87%E7%9B%91%E5%90%ACConsul%E6%9C%8D%E5%8A%A1%E6%B3%A8%E5%86%8C%E7%9A%84%E5%8F%98%E5%8C%96%EF%BC%8CConsul Template自动更新Nginx配置，使Nginx能将客户端HTTP请求动态路由到健康的服务实例。

核心功能和特性

• 动态路由：基于Consul服务注册状态自动更新Nginx路由配置，无需手动干预
• 服务发现：仅将标记为SERVICE_TAG的服务识别为上游服务，结合Consul健康检查确保请求路由到可用服务
• 路径映射：通过Consul键值（KV）存储定义路径-服务映射关系，精确控制API网关暴露的端点
• 灵活配置：支持通过环境变量自定义Nginx超时、请求体大小等参数，支持挂载自定义Nginx配置文件

使用场景和适用范围

适用于OpenLMIS v3微服务架构环境，作为API网关管理客户端与各微服务间的请求路由。特别适合服务动态扩展、实例频繁变更或需高可用性的部署场景，确保请求始终路由到健康可用的服务。

结构概述

!服务发现概述

路径映射

为正确配置路由，容器需通过Consul KV存储提供路径-服务映射。未包含在映射层级中的端点不会被API网关暴露。映射通过Consul KV存储中RESOURCES_PATH子目录下的键值对定义：

• 键：需暴露的相对路径
• 值：对应的服务名称（Nginx将该路径分配给服务的上游）

路径规则

• 含占位符（如ID）的路径需用{param}替换，{param}匹配未明确定义的单级路径（不匹配子目录）
• 使用<all>可保留路径下所有子目录和参数（匹配未被其他规则占用的路径）

示例

路径-服务映射：

users - referencedata  
users/{param} - referencedata  
users/manage - auth  
users/staff/validate - auth  
users/{param}/resetPassword - auth

对应路由结果：

• /users → referencedata服务
• /users/manage → auth服务
• /users/123 → referencedata服务（{param}匹配）
• /users/123/resetPassword → auth服务
• /users/staff → referencedata服务（未明确定义，由users/{param}匹配）
• /users/staff/validate → auth服务（明确定义）

配置

配置文件

镜像包含两个核心配置文件：

1. nginx.conf：标准Nginx配置文件，可通过挂载自定义文件覆盖：

   bash
   docker run -v /本地路径/nginx.conf:/etc/nginx/nginx.conf docker.xuanyuan.run/openlmis/nginx
   

2. openlmis.conf：Consul Template生成的动态配置文件，被nginx.conf引用（覆盖nginx.conf时需确保包含此文件）

日志

• Nginx日志：默认存储于/var/log/nginx，可通过NGINX_LOG_DIR环境变量自定义路径
• Consul Template日志：默认存储于/var/log/consul-template，可通过CONSUL_TEMPLATE_LOG_DIR环境变量自定义路径
  两个目录均标记为卷，支持外部容器挂载获取日志。

Nginx访问日志格式

日志包含标准访问信息及扩展性能指标（顺序如下）：

1. 请求时间：从接收请求到发送响应的总耗时
2. 上游连接时间：与上游服务建立连接的耗时
3. 上游头部时间：建立连接到接收响应头的耗时
4. 上游响应时间：建立连接到接收完整响应的耗时
5. 管道标记：请求是否通过管道传输

可配置环境变量

卷

提供两个日志卷用于外部访问：

• /var/log/nginx：Nginx日志存储路径
• /var/log/consul-template：Consul Template日志存储路径

卷使用示例

bash
# 创建命名日志卷
docker volume create --name=nginx-log

# 运行容器并挂载日志卷
docker run -d -v nginx-log:/var/log/nginx -e VIRTUAL_HOST=openlmis.example.com --name nginx docker.xuanyuan.run/openlmis/nginx

# 验证日志卷（通过临时容器查看日志目录）
docker run --rm -v nginx-log:/nginx-log docker.xuanyuan.run/openlmis/dev ls /nginx-log

上述示例中，命名卷nginx-log存储Nginx日志，可通过临时容器查看或集成到外部日志服务（如Scalyr）。