rhemsjapan/hosts-creator

hosts-creator Docker镜像文档

镜像概述

hosts-creator是一个用于自动管理和更新/etc/hosts文件的Docker镜像。它通过定期解析指定的域名列表，并可选择获取AWS RDS和Redis服务的端点信息，动态生成并更新/etc/hosts文件，确保依赖域名解析的服务能够持续获取最新的IP地址。

核心功能与特性

• 定期自动更新：按配置的时间间隔（TTL）自动执行hosts文件更新
• 自定义域名解析：支持通过挂载文件指定需要解析的域名列表
• 云服务端点集成：可自动获取AWS RDS和Redis服务的端点信息
• 灵活配置：通过配置文件或环境变量自定义更新频率、服务开关等参数
• 多服务共享：与同一主机或共享/etc/hosts的其他服务（如Nginx）实时同步更新

工作流程

1. 初始化配置：

   • 挂载配置文件（/etc/create_hosts/config）和域名列表（/etc/create_hosts/hosts_list）
   • 将初始/etc/hosts复制为base_hosts作为编辑基础
   • 若启用RDS/Redis端点获取，通过配置的凭证枚举对应服务端点

2. 循环执行（按TTL间隔）：

   • 从base_hosts复制生成临时编辑文件
   • 解析hosts_list中的域名，将成功解析的结果追加到临时文件
   • 若启用RDS/Redis端点获取，解析对应服务列表并追加结果
   • 将临时文件覆盖更新至/etc/hosts，实现与其他服务的同步
   • 验证hosts文件有效性

使用场景

• 需要动态解析外部域名的服务环境
• 依赖AWS RDS/Redis等云服务且端点可能变化的应用
• 多容器共享hosts配置的Docker部署环境
• 需要定期更新域名解析记录的服务

使用方法与配置

运行前准备

1. 创建配置文件目录（如./config），包含：

   • setting.ini：主配置文件
   • hosts_list：需要解析的域名列表文件（每行一个域名）
   • （可选）rds_hosts_list：RDS服务列表文件
   • （可选）redis_hosts_list：Redis服务列表文件

2. 确保目标服务（如Nginx）与hosts-creator容器共享/etc/hosts文件

Docker Run示例

bash
docker run -d \
  --name hosts-creator \
  -v /path/to/your/config:/etc/create_hosts/config \
  -v /path/to/your/hosts_list:/etc/create_hosts/hosts_list \
  -e CREATE_HOST_TTL=30 \
  --volume /etc/hosts:/etc/hosts \
  rhemsjapan/hosts-creator

Docker Compose示例

yaml
version: '3'
services:
  hosts-creator:
    image: rhemsjapan/hosts-creator
    volumes:
      - ./config:/etc/create_hosts/config
      - ./hosts_list:/etc/create_hosts/hosts_list
      - /etc/hosts:/etc/hosts
    environment:
      - CREATE_HOST_TTL=30
    restart: always

  nginx:
    image: nginx
    volumes:
      - /etc/hosts:/etc/hosts
    depends_on:
      - hosts-creator

配置参数详解

setting.ini配置示例

ini
[DEFAULT]
TTL = 10
GET_RDS_ENDPOINT = True
GET_REDIS_ENDPOINT = True

[RDS]
CLOUD_ENV = aws
SELECT_TAG_KEY = 
SELECT_TAG_VALUE = 

[REDIS]
CLOUD_ENV = aws
SELECT_TAG_KEY = 
SELECT_TAG_VALUE = 

参数说明

[DEFAULT]部分

[RDS]部分

[REDIS]部分

IAM权限配置（AWS环境）

若使用RDS/Redis端点获取功能，需为容器配置以下IAM权限：

json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "rds:DescribeDBInstances",
                "elasticache:DescribeCacheClusters",
                "elasticache:ListTagsForResource"
            ],
            "Resource": "*"
        }
    ]
}