Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
项目特性
- 通过nginx + lua 实现动态切换upstream
- 灰度用户路由到灰度的服务列表
- 服务健康检查
- 对外发布RESTful接口动态修改配置（通过WSSE进行认证）
使用说明
- 安装nginx + lua环境，这里直接选择openrestry
- 将源码lualib下的文件拷贝到/usr/local/openresty/lualib/firstep目录。（/usr/local/openresty为openrestry的默认安装路径）
- 把conf、lua、config.json等文件及目录放置到nginx的conf目录下（如：/usr/local/openresty/nginx/conf），修改config.json权限为666
- 修改/usr/local/openresty/nginx/conf/nginx.conf，如：
worker_processes 4; #nginx worker 数量
error_log logs/error.log debug; #指定错误日志文件路径，及日志级别
events {
worker_connections 1024;
}
http {
#STEP.1.在http模块引入conf/http_block.conf
include conf/http_block.conf;
#STEP.2.需要健康检查还得引入以下语句
#include conf/http_block_healthcheck.conf;
server {
listen 80;
location / {
default_type text/plain;
content_by_lua 'ngx.say("hello world!")';
}
location /ups1 {
#STEP.3.设置当前location代理所对应的upstream，用ups变量设置
set $ups 'ups1';
proxy_pass http://dynamic_backend;
}
location /ups2 {
set $ups 'ups2';
proxy_pass http://dynamic_backend;
}
}
}API说明
Servers
list server
curl http://ip:9527/servers
//返回格式:
{
"normal": {
"upstream1": [
[
"192.168.56.101", //服务ip
8081, //服务端口
true, //服务是否健康
0 //服务负载权重
],
...
],
...
},
"gray": {
//和normal格式一样
}
}add server
curl -X POST -d "{\"gray\": true, \"upstream\":\"ups1\", \"servers\":[[\"10.10.1.1\", 8080]]}" http://ip:9527/serversdel server
curl -X DELETE -d "{\"gray\": true, \"upstream\":\"ups1\", \"servers\":[[\"10.10.1.1\", 8080]]}" http://ip:9527/serversswitch server
curl -X POST -d "{\"gray\": true, \"upstream\":\"ups1\", \"servers\":[[\"10.10.1.1\", 8080]]}" http://ip:9527/servers/switchUsers
list users
curl http://ip:9527/usersadd users
curl -X POST -d "[\"username1\", \"username2\"]" http://ip:9527/serversdel server
curl -X DELETE -d "[\"username1\", \"username2\"]" http://ip:9527/servers认证
WS-SE认证：APK KEY认证方式，校验请求消息头中“Appkey+AppSecret”进行鉴权。鉴权通过后，处理此条请求消息,否则返回鉴权失败原因
请求头
| 消息头字段 | 说明 |
|---|---|
| Authorization | 取值为： WSSE realm="CLIENT1",profile="UsernameToken",type="Appkey"。 |
| X-WSSE |
取值为： UsernameToken Username="App Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 PasswordDigest：根据公式PasswordDigest = Base64 (SHA256 (Nonce + Created + Password))生成。其中，Password即App Secret的值。 Nonce：App发送请求时生成的一个不超过36位的随机数，允许是数字或字母。例如，QWERTYUIOPASDFGHJKLZXCVBNM1234567890。 Created：随机数生成时间。采用标准UTC格式，为yyyy-MM-dd'T'HH:mm:ss 'Z'。例如，2017-07-09T13:07:06Z。 其中，Appkey为DIC分配的应用接入密钥。App Secret为DIC分配的应用接入密钥密码。 |
| Body-Sign |
取值为：sign_type="HMAC-SHA256", signature= "加密后的值"； sign_type：加密方式，默认为"HMAC-SHA256" signature：根据公式base64_encode(HMAC_SHA256(http body, key)生成；请求消息中key=appKey&appSecret&Nonce，响应消息中key=appKey&appSecret。Key中包含”&” |
请求头样例
Authorization: WSSE realm="CLIENT1", profile="UsernameToken", type="Appkey"
X-WSSE: UsernameToken Username="", PasswordDigest="", Nonce="", Created=""
Body-Sign: sign_type="HMAC-SHA256",signature="qwertyuiopasdfghjklZxcvbnnnnnnnnnnnm12234"
注意
GET请求只校验appkey和appsecret。 非GET请求必须校验body-sign。
后续
- 可视化后台
- 自定义灰度路由规则
- 流量限制
- 请求数据聚合展示