使用Docker Compose在本地运行Solo.io Gloo Gateway与Consul和Vault

前言

在现代微服务架构中，API网关扮演着至关重要的角色。Solo.io的Gloo Gateway是一个功能强大且高度可扩展的API网关解决方案。虽然Gloo Gateway通常部署在Kubernetes环境中，但它同样可以在本地开发环境中通过Docker Compose运行，这对于开发测试和快速原型验证非常有用。

架构概述

在非Kubernetes环境中运行Gloo Gateway需要替代Kubernetes提供的几个关键功能：

1. 配置存储：替代Kubernetes的CRDs（自定义资源定义）
2. 凭证存储：替代Kubernetes的Secrets
3. 服务发现：替代Kubernetes的Services

本方案采用以下组件构建完整解决方案：

• Docker Compose：容器编排工具，用于部署所有服务组件
• Consul：HashiCorp的服务网格解决方案，用于配置存储
• Vault：HashiCorp的密钥管理工具，用于安全存储敏感信息
• Glooctl：Gloo Gateway的命令行管理工具

准备工作

软件需求

在开始之前，请确保您的开发环境已安装以下软件：

1. Docker：容器运行时环境
2. Docker Compose：容器编排工具
3. Glooctl：Gloo Gateway命令行工具

获取部署文件

本教程所需的部署文件位于Gloo Gateway项目中的install/docker-compose-consul目录下，主要包含：

• docker-compose.yaml：定义所有服务的容器配置
• prepare-directories.sh：准备必要的目录结构
• source_data目录：包含Envoy和Gloo的初始配置

部署流程

1. 准备运行环境

首先执行准备脚本创建必要的目录结构：

./prepare-directories.sh

这个脚本会创建data目录及其子目录，用于存储Consul和Vault的持久化数据。

2. 启动服务容器

使用Docker Compose启动所有服务：

docker-compose up

此命令将启动以下服务容器：

1. Consul：配置存储服务（端口8500）
2. Vault：密钥管理服务（端口8200）
3. Petstore：示例应用服务（端口8090）
4. Gloo组件：
   • gloo：主控制平面
   • discovery：服务发现组件
   • gateway-proxy：Envoy代理实例

3. 验证服务状态

启动完成后，可以通过以下方式验证服务状态：

• Consul UI：http://localhost:8500/ui
• Vault UI：http://localhost:8200/ui（使用token root登录）

配置Gloo Gateway

1. 配置网关代理

将网关代理配置写入Consul：

curl --request PUT \
     --data-binary @./install/docker-compose-consul/data/gateways/gloo-system/gw-proxy.yaml \
     http://127.0.0.1:8500/v1/kv/gloo/gateway.solo.io/v1/Gateway/gloo-system

2. 注册Petstore服务

获取Petstore容器IP并注册到Consul：

PETSTORE_IP=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' docker-compose-consul_petstore_1)

cat > petstore-service.json <<EOF
{
  "ID": "petstore1",
  "Name": "petstore",
  "Address": "${PETSTORE_IP}",
  "Port": 8080
}
EOF

curl -v -XPUT --data @petstore-service.json "http://127.0.0.1:8500/v1/agent/service/register"

3. 创建路由规则

使用glooctl创建从网关到Petstore的路由：

glooctl add route \
    --path-exact /all-pets \
    --dest-name petstore \
    --prefix-rewrite /api/pets \
    --use-consul

此命令会：

1. 创建一个精确匹配路径/all-pets的路由规则
2. 将请求转发到名为petstore的上游服务
3. 将路径重写为/api/pets
4. 将配置存储在Consul中

验证路由

通过curl测试路由是否生效：

curl http://localhost:8080/all-pets

预期返回Petstore应用的响应：

[{"id":1,"name":"Dog","status":"available"},{"id":2,"name":"Cat","status":"pending"}]

生产环境注意事项

本文描述的配置适用于开发环境，生产环境需要考虑以下增强措施：

1. 安全加固：为Consul和Vault配置适当的ACL策略
2. 高可用：部署Consul和Vault集群而非单节点
3. 监控：添加适当的监控和告警机制
4. 备份：定期备份Consul和Vault数据

总结

通过本教程，您已经成功在本地开发环境中：

1. 使用Docker Compose部署了Gloo Gateway及其依赖服务
2. 配置Consul作为配置存储后端
3. 设置Vault作为密钥管理服务
4. 创建了从网关到示例应用的路由规则

这种本地开发环境配置非常适合快速验证API网关功能和进行开发测试。对于更复杂的场景，您可以在此基础上扩展，例如添加更多上游服务、实现高级路由规则或集成认证授权功能。