presslabs/zinc

Zinc：Route 53区域管理器

镜像概述和主要用途

Zinc是一个Route 53区域管理工具，旨在提供低成本的DNS策略记录管理方案。与AWS原生的Policy Records（每记录50***）相比，Zinc能显著降低成本，同时支持加权路由、延迟路由等高级流量分配策略，并通过健康检查确保IP可用性，是管理AWS Route 53 DNS记录的高效工具。

核心功能和特性

IP管理

• 支持IP启用/禁用状态管理，可通过管理界面或自定义Django应用操作
• IP变更时需调用ip.mark_policy_records_dirty方法，确保协调循环能检测到变更

健康检查

• 为每个IP自动创建Route 53健康检查
• 当IP被Route 53判定为不可用时，自动停止流量路由
• 健康检查默认使用node.presslabs.net作为目标FQDN，可通过ZINC_HEALTH_CHECK_FQDN环境变量自定义

策略类型

Zinc支持两种策略类型，IP可同时属于多个策略：

加权策略（Weighted）

• 基于权重值分配流量，权重越高的IP接收越多流量

延迟策略（Latency）

• 需为每个IP指定AWS区域
• 优先将流量路由到延迟最低的区域，区域内再按权重分配流量
• 实现类似AWS复杂故障转移配置的流量管理

策略记录（Policy Records）

• 作为期望的DNS记录，在Route 53中表现为指向策略（加权/延迟）的别名记录

协调循环与单一数据源

• 非策略记录：AWS为单一数据源，Zinc不本地存储
• 区域、健康检查和策略记录：Zinc数据库为单一数据源
• 协调循环定期将AWS状态同步为Zinc数据库中的期望状态，仅处理标记为"脏"的对象以减少AWS限流

使用场景和适用范围

• 需要管理AWS Route 53 DNS记录的组织
• 需实现基于权重或延迟的流量分配策略
• 希望降低AWS Policy Records使用成本的用户
• 需要自动化DNS健康检查和故障转移的场景

使用方法和配置说明

安装与运行

推荐通过Docker Compose部署：

bash
cd contrib/
docker-compose up

配置参数

通过环境变量配置Zinc，使用提供的docker-compose.yml时，可在./zinc.env中设置环境变量。

必需参数

可选参数

API使用

安装django-rest-swagger后，可通过http://localhost:8000/swagger探索API。

策略（Policies）

• 只读，需在管理界面定义
• 列出策略：GET /policies
• 获取策略详情：GET /policies/{id}

示例响应：

json
{
  "id": "344b7bee-da33-4234-b645-805cc26adab0",
  "name": "policy-one",
  "members": [
    {
      "id": "6bcb4e77-04dc-45f7-bebb-a2fcfadd7669",
      "region": "us-east-1",
      "ip": "192.0.2.11",
      "weight": 10,
      "enabled": true
    },
    {
      "id": "4f83d47f-af0c-4fa7-80c8-710cb32e4928",
      "region": "us-west-1",
      "ip": "192.0.2.11",
      "weight": 10,
      "enabled": true
    }
  ],
  "url": "https://zinc.stage.presslabs.net/policies/344b7bee-da33-4234-b645-805cc26adab0"
}

区域（Zones）

• 列出区域：GET /zones/
• 创建区域：POST /zones/，参数：root（必需，域名，可选尾随点）
• 删除区域：DELETE /zones/{zone_id}/
• 获取区域详情：GET /zones/{zone_id}

记录（Records）

• 列出区域记录：GET /zones/{zone_id}/records
• 创建记录：POST /zones/{zone_id}/records，参数：
  • name（必需，不带区域根的域名）
  • type（必需，记录类型，可为POLICY_ROUTED或其他有效类型）
  • values（必需，值列表，A记录为IP，POLICY_ROUTED为策略ID等）
  • ttl（可选，默认300）
• 删除记录：DELETE /zones/{zone_id}/records/{record_id}
• 获取记录详情：GET /zones/{zone_id}/records/{record_id}
• 更新记录：PATCH /zones/{zone_id}/records/{record_id}，不可修改类型和名称，支持更新values和ttl

开发注意事项

• 开发/测试时不要使用生产AWS凭证
• 安装依赖：pip install -r requirements.dev.txt && python setup.py develop
• 配置：复制local_settings.py.example为local_settings.py并设置AWS凭证
• 运行测试：py.test .（跳过AWS相关测试：py.test -k 'not with_aws' .）