measurementlab/revtr-sidecar

revtr-sidecar 镜像文档

概述

revtr-sidecar是专为revtr主服务设计的Sidecar模式辅助容器镜像。作为附加容器部署于主应用容器旁，它通过解耦非业务功能（如通信代理、日志处理、动态配置等），减轻主服务负担，提升系统的可观测性、可配置性和整体可靠性。

核心功能与特性

• 代理转发：实现主服务与外部服务的流量代理，支持请求路由、负载均衡及协议转换
• 日志收集：实时捕获revtr主服务日志，支持标准输出转发或对接ELK、Promtail等日志系统
• 配置同步：定期从配置中心（如etcd、Consul）拉取配置并同步至主服务，支持动态配置更新
• 服务发现：集成主流服务注册中心，自动探测上下游服务实例，维护服务健康状态
• 轻量级设计：基于Alpine或Distroless基础镜像构建，镜像体积小（<50MB），资源占用低

使用场景与适用范围

• 微服务架构：在Kubernetes/Docker Compose环境中作为revtr服务的Sidecar容器部署
• 分布式部署：适用于多节点revtr集群，统一日志采集与配置管理
• DevOps流程：支持辅助功能独立升级与迭代，不影响主服务核心业务逻辑
• 混合云环境：解决跨网络环境下的服务通信、数据转发等问题

使用方法与配置说明

基础部署（Docker Run）

bash
docker run -d \
  --name revtr-sidecar \
  --network revtr-network \
  --link revtr-main:revtr \
  -e REVTR_MAIN_HOST=revtr \
  -e REVTR_MAIN_PORT=8080 \
  -e LOG_LEVEL=info \
  -e CONFIG_SYNC_INTERVAL=30s \
  -v ./sidecar-logs:/var/log/revtr-sidecar \
  docker.xuanyuan.run/revtr-sidecar:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  revtr-main:
    image: docker.xuanyuan.run/revtr-main:latest
    container_name: revtr-main
    ports:
      - "8080:8080"
    environment:
      - SERVICE_NAME=revtr-main
    networks:
      - revtr-network

  revtr-sidecar:
    image: docker.xuanyuan.run/revtr-sidecar:latest
    container_name: revtr-sidecar
    depends_on:
      - revtr-main
    environment:
      - REVTR_MAIN_HOST=revtr-main
      - REVTR_MAIN_PORT=8080
      - LOG_LEVEL=info
      - PROXY_ENABLED=true
      - LOG_OUTPUT_PATH=/var/log/revtr-sidecar/sidecar.log
      - CONFIG_SYNC_INTERVAL=30s
      - REGISTRY_ADDR=http://consul:8500
    volumes:
      - ./sidecar-logs:/var/log/revtr-sidecar
    networks:
      - revtr-network

networks:
  revtr-network:
    driver: bridge

Kubernetes部署示例

yaml
apiVersion: v1
kind: Pod
metadata:
  name: revtr-pod
spec:
  containers:
  - name: revtr-main
    image: docker.xuanyuan.run/revtr-main:latest
    ports:
    - containerPort: 8080
  - name: revtr-sidecar
    image: docker.xuanyuan.run/revtr-sidecar:latest
    env:
    - name: REVTR_MAIN_HOST
      value: localhost
    - name: REVTR_MAIN_PORT
      value: "8080"
    - name: LOG_LEVEL
      value: "info"
    - name: CONFIG_SYNC_INTERVAL
      value: "30s"
    volumeMounts:
    - name: sidecar-logs
      mountPath: /var/log/revtr-sidecar
  volumes:
  - name: sidecar-logs
    emptyDir: {}

环境变量配置说明

数据卷挂载说明

• /var/log/revtr-sidecar: 日志存储目录，挂载本地目录可实现日志持久化
• /etc/revtr-sidecar/config: 自定义配置文件目录（优先级高于环境变量）

注意事项

• 确保Sidecar容器与主服务容器在同一网络命名空间，可通过--link（Docker）或共享Pod（K8s）实现通信
• 生产环境建议使用具体镜像标签（如revtr-sidecar:v1.2.0）而非latest，避免版本变更风险
• 配置同步功能依赖外部配置中心时，需确保网络连通性及访问权限
• 高并发场景下建议调整资源限制（CPU/内存），避免Sidecar成为性能瓶颈