groundworkdevelopment/tcg

Transit Connector Generator Docker镜像文档

镜像概述

Transit Connector Generator是一款轻量级Docker镜像，专注于简化交通系统数据连接器的生成与配置过程。该镜像集成标准化工具集，支持多种交通数据源（如公交GPS系统、地铁运营数据、交通监控平台等）的快速集成，能够自动生成连接器配置文件，减少手动配置工作量，提升交通数据平台搭建和数据传输的效率。

核心功能与特性

• 多数据源兼容：支持REST API、MQTT、WebSocket等主流协议，覆盖公交GPS、地铁运营、道路监控等多种交通数据类型。
• 配置自动化：通过参数输入自动生成完整连接器配置，支持JSON、YAML等格式输出，减少手动配置错误。
• 容器化部署：基于Docker封装，无需复杂环境依赖，一键启动即可使用，支持跨平台部署。
• 可定制配置：允许自定义数据源参数、数据转换规则和认证方式，满足特定业务场景需求。
• 轻量级设计：基于Alpine Linux构建，镜像体积小（<100MB），资源占用低，适合边缘计算环境。

使用场景与适用范围

• 智慧交通平台搭建：快速集成多源交通数据，构建统一数据接入层，支撑交通监控、调度系统建设。
• 交通数据API对接：为交通管理部门、出行服务企业提供标准化API连接器配置，简化第三方数据源对接流程。
• 数据传输自动化：在交通数据实时监控场景中，自动生成数据传输通道配置，保障数据从采集端到平台端的稳定传输。
• 开发测试环境：供开发人员本地快速生成测试用连接器配置，加速交通数据相关应用的开发迭代。

使用方法与配置说明

基础部署命令

bash
# 拉取镜像（假设镜像名称为transit-connector-generator）
docker pull transit-connector-generator:latest

# 启动容器（默认配置）
docker run -d \
  --name transit-connector \
  -p 8080:8080 \
  transit-connector-generator:latest

核心配置参数

通过环境变量或命令行参数进行配置，主要参数说明如下：

典型场景示例

示例1：生成公交GPS数据源连接器（API Key认证）

bash
docker run -d \
  --name bus-gps-connector \
  -e DATA_SOURCE=bus_gps \
  -e API_ENDPOINT=https://api.city-bus.com/gps/v1 \
  -e AUTH_METHOD=api_key \
  -e API_KEY=your_bus_api_key_123 \
  -e OUTPUT_FORMAT=yaml \
  -v $(pwd)/connector-config:/app/output \  # 挂载宿主机目录持久化配置
  transit-connector-generator:latest

执行后，配置文件将生成至宿主机./connector-config目录下，文件名为connector_config.yaml。

示例2：生成地铁运营数据连接器（OAuth2认证）

bash
docker run -d \
  --name metro-connector \
  -e DATA_SOURCE=metro_ops \
  -e API_ENDPOINT=https://api.metro-system.com/operations \
  -e AUTH_METHOD=oauth2 \
  -e OAUTH2_CLIENT_ID=metro_client_456 \
  -e OAUTH2_CLIENT_SECRET=metro_secret_789 \
  -e OAUTH2_TOKEN_URL=https://auth.metro-system.com/token \
  transit-connector-generator:latest

配置文件使用

生成的配置文件可直接用于交通数据平台的数据接入模块，通过加载配置文件即可建立与目标数据源的连接。配置文件示例（YAML格式）：

yaml
# connector_config.yaml
data_source: bus_gps
api_endpoint: https://api.city-bus.com/gps/v1
auth_method: api_key
api_key: your_bus_api_key_123
connection_pool: 5
retry_interval: 30s
output_fields: [vehicle_id, longitude, latitude, timestamp]

可视化管理界面

容器启动后，可通过访问http://localhost:8080打开Web管理界面，支持：

• 图形化配置数据源参数
• 在线预览/下载配置文件
• 测试连接器连通性
• 查看生成历史记录

注意事项

1. 数据源权限：确保API_ENDPOINT地址可访问，且AUTH_METHOD及相关认证参数配置正确。
2. 持久化存储：生产环境建议通过-v参数挂载宿主机目录，避免容器重启后配置文件丢失。
3. 端口映射：若需外部访问Web界面，需映射容器8080端口至宿主机（如-p 8080:8080）。
4. 版本选择：生产环境建议使用特定版本标签（如:v1.2.0）而非latest，确保部署稳定性。