consul-dataplane Docker镜像文档

镜像概述和主要用途

consul-dataplane 是一款轻量级数据平面组件，用于将应用程序无缝连接到 Consul 服务网格（Service Mesh）。它作为应用与 Consul 控制平面之间的桥梁，简化了服务注册、流量管理、安全通信等服务网格核心能力的集成过程，帮助用户快速实现微服务架构下的服务治理。

核心功能和特性

• 服务注册与发现：自动将应用服务注册到 Consul 控制平面，并支持从服务网格中发现其他服务实例。
• 流量代理与管理：内置轻量级代理，支持 HTTP/gRPC 等协议的流量转发，可配置路由规则、负载均衡策略。
• 安全通信：集成 Consul Connect 功能，自动生成和轮换 TLS 证书，确保服务间通信加密。
• 健康检查：支持配置服务健康检查规则，向 Consul 上报服务状态，实现故障自动隔离。
• 配置同步：实时同步 Consul 控制平面的服务配置（如路由规则、访问策略），动态更新数据平面行为。

使用场景和适用范围

典型场景

• 微服务架构中的服务通信：在多服务协同的微服务架构中，统一管理服务间的流量路由、负载均衡和安全通信。
• 服务网格部署简化：无需手动部署复杂的 sidecar 代理，通过轻量级数据平面快速接入 Consul 服务网格。
• 多环境服务集成：适用于开发、测试、生产等不同环境，统一服务治理策略，减少环境差异导致的问题。

适用范围

• 开发/运维团队：需要快速将应用接入服务网格的技术团队。
• 微服务应用：基于 HTTP/gRPC 等协议的微服务应用。
• Consul 生态用户：已部署 Consul 控制平面，需扩展数据平面能力的用户。

使用方法和配置说明

前提条件

• 已安装 Docker 环境（Docker 19.03+）。
• 已部署 Consul 控制平面（Consul Server 1.11+），且网络可访问。

快速启动（docker run）

通过 docker run 命令快速启动 consul-dataplane，连接到 Consul 服务网格并代理目标应用流量：

bash
docker run -d \
  --name=consul-dataplane \
  --network=host \  # 推荐使用 host 网络减少网络开销，或自定义桥接网络
  -e CONSUL_HTTP_ADDR=[***] \  # Consul 控制平面地址
  -e SERVICE_NAME=my-app \  # 注册到服务网格的服务名称
  -e SERVICE_PORT=8080 \    # 应用监听端口
  -e SERVICE_REGISTER=true \  # 启用自动服务注册
  hashicorp/consul-dataplane:latest

说明：--network=host 模式下，容器直接使用主机网络，需确保主机端口未被占用；若使用自定义网络，需配置端口映射（如 -p 20000:20000，20000 为 dataplane 代理端口）。

Docker Compose 配置示例

通过 docker-compose.yml 定义应用与 consul-dataplane 的协同部署：

yaml
version: '3.8'

services:
  my-app:
    image: my-app:latest  # 目标应用镜像
    ports:
      - "8080:8080"
    environment:
      - APP_PORT=8080
    depends_on:
      - consul-dataplane

  consul-dataplane:
    image: hashicorp/consul-dataplane:latest
    network_mode: "service:my-app"  # 共享应用网络命名空间，直接代理应用流量
    environment:
      - CONSUL_HTTP_ADDR=[***]  # Consul 控制平面地址
      - SERVICE_NAME=my-app                          # 服务名称（需与应用一致）
      - SERVICE_PORT=8080                            # 应用端口（需与应用监听端口一致）
      - CONSUL_TOKEN=my-consul-token                 # 访问 Consul 的 ACL Token（若启用 ACL）
      - TLS_ENABLE=true                              # 启用 TLS 加密通信
      - LOG_LEVEL=info                               # 日志级别：debug/info/warn/error

说明：network_mode: "service:my-app" 使 dataplane 与应用共享网络命名空间，避免端口映射冲突，简化流量代理配置。

配置参数说明

consul-dataplane 支持通过环境变量或配置文件（-config-file）进行配置，常用环境变量如下：

注：完整配置参数可参考 ***文档。