hashicorppreview/consul-dataplane

consul-dataplane Docker镜像文档

镜像概述和主要用途

consul-dataplane 是HashiCorp提供的Docker镜像，用于将应用程序连接到Consul服务网格（service mesh）。作为数据平面组件，它负责处理应用间的网络通信，实现服务网格的核心功能（如流量转发、服务发现、通信安全等），使应用无需直接集成Consul SDK即可接入服务网格。

注意：当前仓库中的镜像为开发版（dev images），生产环境应使用官方稳定版镜像，地址为：https://hub.docker.com/r/hashicorp/consul-dataplane%E3%80%82

核心功能和特性

• 服务网格接入：作为应用与Consul服务网格的桥梁，实现应用程序与服务网格的无缝集成。
• 流量转发与代理：处理应用间的网络流量转发，支持服务间请求路由。
• 服务发现集成：通过Consul控制平面获取服务注册信息，实现动态服务发现。
• 轻量级部署：以Docker容器形式部署，适合容器化或云原生环境。
• 控制平面协同：与Consul服务器（控制平面）通信，接收配置并上报运行状态。

使用场景和适用范围

• 微服务架构：在微服务环境中，需管理服务间通信、实现服务发现和流量控制的场景。
• 容器化应用：Docker或Kubernetes环境中部署的应用，需接入Consul服务网格进行统一流量管理。
• 开发与测试环境：可使用开发版镜像验证服务网格功能及应用集成；生产环境必须切换至官方稳定版镜像。
• 无侵入式集成：应用无需修改代码，通过部署consul-dataplane容器即可接入服务网格。

使用方法和配置说明

获取镜像

开发环境（仅用于测试）

bash
docker pull <当前仓库地址>/consul-dataplane  # 注：当前仓库为开发版镜像

生产环境（推荐）

bash
docker pull hashicorp/consul-dataplane:latest

基本使用方法

1. 单容器启动（docker run）

通过命令行参数指定核心配置，快速启动容器：

bash
docker run -d \
  --name consul-dataplane \
  --network=host  # 或指定自定义网络，确保与应用及Consul控制平面互通
  -e CONSUL_HTTP_ADDR=consul-server:8500 \  # Consul控制平面地址（必填）
  -e SERVICE_NAME=my-app \                  # 接入服务网格的应用名称（必填）
  -e SERVICE_PORT=8080 \                    # 应用监听端口（必填）
  hashicorp/consul-dataplane:latest \
  consul-dataplane run  # 启动命令

2. Docker Compose配置示例

通过docker-compose.yml集成应用与consul-dataplane：

yaml
version: '3.8'
services:
  # 应用服务
  app:
    image: your-app-image:latest  # 替换为实际应用镜像
    ports:
      - "8080:8080"
    environment:
      # 应用通过dataplane代理流量（示例：HTTP_PROXY指向dataplane）
      - HTTP_PROXY=http://consul-dataplane:15001
    depends_on:
      - consul-dataplane

  # consul-dataplane服务
  consul-dataplane:
    image: hashicorp/consul-dataplane:latest
    environment:
      - CONSUL_HTTP_ADDR=consul-server:8500  # Consul控制平面地址（需提前部署Consul服务器）
      - CONSUL_HTTP_TOKEN=your-acl-token     # 若Consul启用ACL，需提供访问令牌
      - SERVICE_NAME=my-app                  # 与应用服务名称一致
      - SERVICE_PORT=8080                    # 应用监听端口
      - LOG_LEVEL=info                       # 日志级别（可选，默认info）
    volumes:
      - ./dataplane-config:/etc/consul-dataplane  # 挂载自定义配置文件（可选）

核心配置参数

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

详细配置与高级用法

完整的配置说明、命令行参数及高级功能（如TLS配置、流量策略），请参考官方文档：
https://github.com/hashicorp/consul-dataplane/blob/main/README.md