nicholasjackson/consul-envoy

Consul和Envoy集成Docker镜像

镜像概述和主要用途

本Docker镜像集成了Consul和Envoy，支持在启动时自动注册服务和中心配置。可用于服务注册、配置管理场景，或作为Envoy sidecar代理部署。

核心功能和特性

• 集成Consul和Envoy，提供服务发现与代理能力
• 支持服务自动注册与退出时注销
• 支持中心配置文件的自动注册
• 可作为Envoy sidecar与服务协同工作

使用场景和适用范围

• 服务网格环境中的服务注册与发现
• 集中式配置管理与分发
• 需要Envoy作为sidecar代理的微服务架构
• Kubernetes环境中的配置初始化任务

使用方法和配置说明

基本使用示例

bash
docker run --rm \
  -e "CONSUL_HTTP_ADDR=10.5.0.2:8500" \
  -e "CONSUL_GRPC_ADDR=10.5.0.2:8502" \
  -e "SERVICE_CONFIG=/config/web.json" \
  -v $(pwd)/service_config:/config \
  nicholasjackson/consul-envoy:v1.6.0-v0.10.0 \
  bash -c "consul connect envoy -sidecar-for web-v1"

环境变量配置

CONSUL_HTTP_ADDR

• 描述：Consul agent的HTTP地址
• 格式：host:port
• 示例：10.5.0.2:8500

CONSUL_GRPC_ADDR

• 描述：Consul agent的GRPC API地址，供Envoy使用
• 格式：host:port
• 示例：10.5.0.2:8502

SERVICE_CONFIG

• 描述：Consul服务配置文件路径
• 功能：容器启动时会将指定的服务配置注册到Consul，容器退出时自动注销该服务
• 示例：/config/web.json

CENTRAL_CONFIG

• 描述：以分号分隔的中心配置文件列表
• 功能：容器启动时自动注册指定的中心配置，容器退出时不会移除配置
• 示例：/config/config1.hcl;/config/config2.hcl

CENTRAL_CONFIG_DIR

• 描述：包含中心配置文件的目录路径
• 功能：容器启动时自动注册目录中所有中心配置文件，容器退出时不会移除配置
• 示例：/config

Kubernetes部署示例

使用Terraform部署中心配置

hcl
resource "kubernetes_config_map" "central_config" {
  metadata {
    name = "central-config"
  }

  data = {
    "pong-aks-defaults.hcl" = file("${path.module}/consul_config/pong-aks-defaults.hcl")
    "pong-vms-defaults.hcl" = file("${path.module}/consul_config/pong-vms-defaults.hcl")
    "pong-aks-resolver.hcl" = file("${path.module}/consul_config/pong-aks-resolver.hcl")
    "pong-vms-resolver.hcl" = file("${path.module}/consul_config/pong-vms-resolver.hcl")
  }
}

resource "kubernetes_job" "central_config" {
  depends_on = [helm_release.consul]

  metadata {
    name = "central-config"
  }

  spec {
    template {
      metadata {
        labels = {
          version = "v0.0.1"
        }
      }
      spec{
        volume {
          name = kubernetes_config_map.central_config.metadata[0].name
        
          config_map {
            name = kubernetes_config_map.central_config.metadata[0].name
          }
        }

        container {
          image = "nicholasjackson/consul-envoy:v1.6.0-v0.10.0"
      		name = "central-config"

          env {
            name  = "CONSUL_HTTP_ADDR"
            value = "consul-consul-server:8500"
          }

          env {
            name  = "CONSUL_GRPC_ADDR"
            value = "consul-consul-server:8502"
          }

          env {
            name  = "CENTRAL_CONFIG_DIR"
            value = "/config"
          }
          
      		volume_mount {
          	read_only = true  
            mount_path = "/config"
            name = kubernetes_config_map.central_config.metadata[0].name
      		}
        }
      }
    }
  }
}

使用YAML部署中心配置

yaml
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: central-config-split
data:
  1_web_defaults.yml: |
    kind = "service-defaults"
    name = "web"
    protocol = "http"
  2_api_defaults.yml: |
    kind = "service-defaults"
    name = "api"
    protocol = "http"
  3_api_resolver.yml: |
    kind = "service-resolver"
    name = "api"

    # [***]
    # 展示Node.Meta演示，用于测试新实例类型的性能
    default_subset = "v1"

    subsets = {
      v1 = {
        filter = "Service.Meta.version == 1"
      }
      v2 = {
        filter = "Service.Meta.version == 2"
      }
    }

---
apiVersion: batch/v1
kind: Job
metadata:
  name: central-config-split
  labels:
    app: central-config-split
spec:
  template:
    spec:
      restartPolicy: Never
      volumes:
      - name: central-config
        configMap:
          name: central-config-split
      containers:
      - name: central-config-split
        image: "nicholasjackson/consul-envoy:v1.6.0-v0.10.0"
        env:
        - name: "CONSUL_HTTP_ADDR"
          value: "consul-consul-server:8500"
        - name: "CONSUL_GRPC_ADDR"
          value: "consul-consul-server:8502"
        - name: "CENTRAL_CONFIG_DIR"
          value: "/config"
        volumeMounts:
        - name: "central-config"
          readOnly: true
          mountPath: "/config"