paskalmaksim/envoy-sidecar-helper

envoy-sidecar-helper 镜像文档

概述

envoy-sidecar-helper 是一个专为简化 Envoy 代理作为 sidecar 容器部署而设计的辅助工具。该镜像旨在解决在服务网格环境中配置和管理 Envoy 代理的复杂性，提供动态配置更新、服务发现集成和健康检查等功能，帮助开发人员和运维团队更轻松地将 Envoy 集成到微服务架构中。

核心功能和特性

• 动态配置管理：支持从多种来源获取和更新 Envoy 配置
• 服务发现集成：与主流服务发现机制（如 Kubernetes、Consul 等）无缝集成
• 健康检查：提供内置的健康检查功能，确保 Envoy 代理正常运行
• 配置验证：在应用配置前验证 Envoy 配置的有效性
• 指标收集：集成指标收集功能，便于监控 Envoy 性能
• 轻量级设计：资源占用低，适合作为 sidecar 容器运行

使用场景和适用范围

• 微服务架构：在微服务环境中作为 sidecar 代理部署
• 服务网格：作为 Istio 或其他服务网格解决方案的辅助工具
• Kubernetes 环境：在 Kubernetes 集群中简化 Envoy 配置管理
• API 网关：辅助管理 Envoy 作为 API 网关的配置
• 多服务部署：需要为多个服务实例提供统一代理配置的场景

使用方法和配置说明

基本用法

bash
docker run -d --name envoy-helper \
  -v /path/to/envoy/config:/etc/envoy \
  maksim-paskal/envoy-sidecar-helper

Docker Compose 示例

yaml
version: '3'
services:
  app:
    image: your-app-image
    ports:
      - "8080:8080"
    
  envoy:
    image: envoyproxy/envoy:v1.21-latest
    ports:
      - "80:80"
    volumes:
      - ./envoy-config:/etc/envoy
    depends_on:
      - app
      - envoy-helper
      
  envoy-helper:
    image: maksim-paskal/envoy-sidecar-helper
    volumes:
      - ./envoy-config:/etc/envoy
    environment:
      - ENVOY_CONFIG_PATH=/etc/envoy/envoy.yaml
      - LOG_LEVEL=info
      - UPDATE_INTERVAL=30s

Kubernetes 部署示例

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: example-app
spec:
  replicas: 3
  template:
    spec:
      containers:
      - name: app
        image: your-app-image
        
      - name: envoy
        image: envoyproxy/envoy:v1.21-latest
        volumeMounts:
        - name: envoy-config
          mountPath: /etc/envoy
          
      - name: envoy-helper
        image: maksim-paskal/envoy-sidecar-helper
        volumeMounts:
        - name: envoy-config
          mountPath: /etc/envoy
        env:
        - name: ENVOY_CONFIG_PATH
          value: /etc/envoy/envoy.yaml
        - name: UPDATE_INTERVAL
          value: "30s"
         
        
      volumes:
      - name: envoy-config
        emptyDir: {}

配置参数和环境变量

环境变量

命令行参数

Usage: envoy-sidecar-helper [OPTIONS]

Options:
  --config PATH       Path to Envoy configuration file
  --log-level LEVEL   Set log level (debug, info, warn, error)
  --interval DURATION Config update interval (e.g. 30s, 5m)
  --health-port PORT  Health check port
  --no-validate       Disable configuration validation
  --help              Show this help message
  --version           Show version information

注意事项

• 确保 Envoy 容器能够访问 envoy-sidecar-helper 生成的配置文件
• 在生产环境中建议使用持久化存储来保存配置文件
• 根据实际需求调整配置更新间隔，平衡实时性和资源消耗
• 首次使用时建议启用 debug 日志级别以便排查问题

相关资源

• Envoy 官方文档
• https://github.com/maksim-paskal/envoy-sidecar-helper
• https://hub.docker.com/r/maksim-paskal/envoy-sidecar-helper