yieldr/vulcand

Vulcand 镜像文档

镜像概述

Vulcand 是一个专为HTTP API管理和微服务设计的反向代理，其设计灵感来源于Hystrix。它采用Etcd作为配置后端，支持配置的动态更新，无需重启服务即可使更改生效，非常适合需要灵活调整和实时响应的API服务场景。

核心功能与特性

• 反向代理能力：提供稳定的HTTP流量路由和转发功能，支持微服务架构中的服务间通信
• API管理：专为HTTP API设计，可有效管理API请求的路由、负载均衡和流量控制
• 动态配置：使用Etcd作为配置存储后端，配置更改实时生效，无需重启服务
• 微服务支持：适用于微服务架构，可作为服务网关协调多个微服务间的通信

使用场景与适用范围

• HTTP API服务管理：需要集中管理和路由多个API服务的场景
• 微服务架构：作为微服务架构中的反向代理或服务网关，处理服务间的请求转发
• 动态配置环境：需要频繁调整服务配置且要求配置变更即时生效的场景
• 高可用服务部署：需要避免因配置更新导致服务中断的生产环境

使用方法与配置说明

前提条件

• 已部署Etcd服务，Vulcand需要连接Etcd以获取配置
• Docker环境已安装并运行

基本运行命令

通过以下命令启动Vulcand容器，需指定Etcd服务地址：

bash
docker run -d \
  --name vulcand \
  -p 8080:8080 \  # 代理服务端口
  -p 8181:8181 \  # 管理API端口
  -e ETCD_ENDPOINTS=http://etcd-host:2379 \  # Etcd服务地址
  mailgun/vulcand

配置说明

Vulcand的所有配置通过Etcd进行管理，主要配置项包括：

• 后端服务(Backends)：定义需要代理的目标服务
• 前端路由(Frontends)：定义路由规则，将请求映射到后端服务
• 中间件(Middlewares)：配置请求处理的中间件，如认证、限流等

配置示例（通过etcdctl设置）：

bash
# 添加后端服务
etcdctl put /vulcand/backends/my-backend '{"Type":"http","Settings":{"KeepAlive": true}}'

# 添加后端服务实例
etcdctl put /vulcand/backends/my-backend/servers/server1 '{"URL": "http://192.168.1.100:8080"}'

# 添加前端路由
etcdctl put /vulcand/frontends/my-frontend '{"Backend": "my-backend","Route": {"Path": "/api/*"}}'

管理API

Vulcand提供HTTP管理API（默认端口8181），可通过API进行配置管理，例如：

bash
# 获取当前配置
curl http://localhost:8181/v1/backends

# 添加新后端
curl -X POST http://localhost:8181/v1/backends -d '{"Id":"new-backend","Type":"http","Settings":{"KeepAlive":true}}'