ciscocloud/nginx-consul

nginx-consul 镜像文档

镜像概述

nginx-consul是一个运行Nginx服务的Docker容器，其核心特性是将Nginx配置存储在Consul K/V（键值存储）中，能够动态从Consul获取配置并加载，实现配置更新无需重启容器的功能。

核心功能与特性

• 动态配置加载：从Consul K/V实时读取Nginx配置，配置更新后自动加载，避免服务中断
• Consul集成：原生支持与Consul服务通信，可通过Consul集中管理Nginx配置
• 完整Nginx功能：继承官方Nginx镜像的全部功能，包括反向代理、负载均衡、静态资源服务等
• 轻量级设计：基于官方Nginx基础镜像构建，保持较小镜像体积和高效运行

使用场景与适用范围

• 需频繁更新Nginx配置的业务场景，如多环境部署、快速迭代系统
• 分布式架构中需要集中化管理配置的环境
• 希望通过Consul实现配置版本控制和统一管理的用户
• 对服务可用性要求高，需避免配置更新导致服务中断的生产环境

使用方法与配置说明

前提条件

• 已部署Consul服务（单节点或集群）
• Nginx配置已预先存储在Consul K/V中
• 已安装Docker环境

基本使用（docker run）

bash
docker run -d \
  --name nginx-consul \
  -p 80:80 \
  -e CONSUL_HTTP_ADDR=consul-server:8500 \  # Consul服务地址
  -e NGINX_CONFIG_KEY=nginx/config \        # Consul K/V中配置存储键路径
  nginx-consul

环境变量配置

docker-compose配置示例

yaml
version: '3'
services:
  nginx-consul:
    image: nginx-consul
    ports:
      - "80:80"
    environment:
      - CONSUL_HTTP_ADDR=consul:8500
      - NGINX_CONFIG_KEY=services/nginx/production
    depends_on:
      - consul

  consul:
    image: consul:latest
    ports:
      - "8500:8500"
    volumes:
      - consul-data:/consul/data

volumes:
  consul-data:

Consul K/V配置方法

1. 访问Consul UI（默认地址：[***]
2. 进入"Key/Value"页面，创建配置键（如nginx/config）
3. 在值字段中输入标准Nginx配置，例如：

   nginx
   server {
       listen 80;
       server_name example.com;
       
       location / {
           proxy_pass http://backend-service;
           proxy_set_header Host $host;
       }
   }
   

4. 保存配置后，容器将在指定延迟时间后自动加载新配置