ngx_http_consul_backend_module 项目启动与配置教程

1. 项目目录结构及介绍

ngx_http_consul_backend_module 项目是一个用于动态选择后端的 Nginx 模块扩展，通过与 HashiCorp Consul 的 API 进行通信。以下是项目的目录结构及其介绍：

• src：存放 Go 语言编写的源代码，这部分代码负责与 Consul 进行通信，并选择健康的服务后端。
• config：可能包含一些配置文件模板或示例。
• Makefile：构建项目所需的 Makefile 文件。
• README.md：项目说明文件，包含项目介绍、使用方法和安装步骤。
• LICENSE：项目使用的许可证文件，本项目采用 MPL-2.0 许可证。

2. 项目的启动文件介绍

项目的启动主要是编译 Nginx 并将模块编译为动态库文件。以下是一些主要的启动步骤和文件：

• 在 /tmp 目录下下载并解压 Nginx 源码和 Nginx 开发工具包（ngx_devel_kit）。
• 克隆本项目到 /go/src/github.com/hashicorp/ngx_http_consul_backend_module。
• 使用 go build 命令编译 Go 代码为共享 C 库，该库将在运行时被 Nginx 动态加载。

cd /tmp/ngx_http_consul_backend_module/src
mkdir -p /usr/local/nginx/ext
CGO_CFLAGS="-I /tmp/ngx_devel_kit-0.3.0/src" \
go build -buildmode=c-shared -o /usr/local/nginx/ext/ngx_http_consul_backend_module.so src/ngx_http_consul_backend_module.go

3. 项目的配置文件介绍

项目的配置主要通过 Nginx 的配置文件来实现。以下是一个基本的配置文件示例：

http {
    server {
        listen 80;
        server_name example.com;

        location /my-service {
            consul $backend service-name;
            proxy_pass http://$backend;
        }
    }
}

在这个配置中：

• consul $backend service-name;：这是自定义的 Nginx 指令，用于从 Consul 服务中选择一个健康的后端，并将其 IP:PORT 设置到变量 $backend。
• proxy_pass http://$backend;：将请求代理到变量 $backend 指定的后端。

这个配置允许 Nginx 根据 Consul 的服务注册信息动态选择后端，实现负载均衡并自动从 unhealthy 的后端中剔除。