seeq13/datalab-kubectl-proxy

Seeq 边车容器技术文档

镜像概述

Seeq边车容器（Sidecar Container）是Seeq官方提供的辅助容器，专为Kubernetes环境设计，用于配合主应用容器实现对Pod的控制与管理。作为边车模式的实现，该容器与主应用容器共享Pod生命周期，提供Pod级别的管理能力，增强主应用的稳定性与可运维性。

核心功能与特性

1. Pod生命周期管理

• 协助主应用容器完成Pod的启动初始化、健康检查及优雅关闭
• 支持自定义Pod生命周期钩子（Hook），如预启动配置加载、停止前资源清理

2. 资源控制与优化

• 监控Pod内资源使用情况（CPU、内存、网络）
• 根据预设策略动态调整资源分配，避免资源溢出或浪费

3. 配置与状态同步

• 与主应用容器保持配置文件同步，支持动态配置更新
• 实时收集并向主应用或外部系统上报Pod运行状态

4. 故障处理与恢复

• 检测主应用容器异常状态，触发预设恢复机制（如重启、隔离）
• 记录故障日志并支持故障自愈流程

使用场景与适用范围

• Seeq应用Kubernetes部署：在Kubernetes集群中部署Seeq主应用时，作为必选辅助组件运行
• 复杂Pod管理需求：当主应用需要精细化控制Pod生命周期或资源时使用
• 分布式系统协同：在多容器Pod中协调各组件间的通信与依赖关系

使用方法与配置说明

前置要求

• Kubernetes集群版本 ≥ 1.18
• 主应用容器镜像与边车容器版本匹配（建议使用相同版本标签）
• Pod服务账户需具备基础的Pod管理权限（如get、update Pod资源）

Kubernetes Pod配置示例

yaml
apiVersion: v1
kind: Pod
metadata:
  name: seeq-main-pod
  namespace: seeq-system
spec:
  containers:
  # 主应用容器
  - name: main-app
    image: docker.xuanyuan.run/seeq/main:latest
    ports:
    - containerPort: 8080
    resources:
      requests:
        cpu: "1"
        memory: "1Gi"
  
  # Seeq边车容器
  - name: seeq-sidecar
    image: docker.xuanyuan.run/seeq/sidecar:latest
    env:
    # 必要环境变量（通过fieldRef自动注入）
    - name: POD_NAME
      valueFrom:
        fieldRef:
          fieldPath: metadata.name
    - name: NAMESPACE
      valueFrom:
        fieldRef:
          fieldPath: metadata.namespace
    - name: POD_UID
      valueFrom:
        fieldRef:
          fieldPath: metadata.uid
    # 可选配置环境变量
    - name: CONTROL_INTERVAL
      value: "30"  # 控制检查间隔（秒），默认30
    - name: LOG_LEVEL
      value: "info"  # 日志级别：debug|info|warn|error，默认info
    - name: RESTART_THRESHOLD
      value: "3"  # 最大重启次数阈值，默认3
    volumeMounts:
    - name: config-volume
      mountPath: /etc/seeq/sidecar
  volumes:
  - name: config-volume
    configMap:
      name: seeq-sidecar-config  # 边车容器配置文件ConfigMap

环境变量配置说明

配置文件格式

边车容器支持通过ConfigMap挂载配置文件（默认路径/etc/seeq/sidecar/config.yaml），示例配置：

yaml
# 资源监控配置
resourceMonitor:
  enabled: true
  cpuThreshold: 80    # CPU使用率阈值（%）
  memoryThreshold: 85 # 内存使用率阈值（%）

# 生命周期钩子配置
lifecycleHooks:
  preStart:
    command: ["/scripts/pre-start.sh"]
  preStop:
    command: ["/scripts/pre-stop.sh"]

# 日志配置
logging:
  maxSize: "100Mi"  # 单日志文件大小
  maxBackups: 5     # 日志文件保留数量

运行验证

部署后可通过以下命令检查边车容器状态：

bash
# 查看Pod内容器状态
kubectl -n seeq-system describe pod seeq-main-pod

# 查看边车容器日志
kubectl -n seeq-system logs seeq-main-pod -c seeq-sidecar

注意事项

1. 版本兼容性：边车容器版本必须与主应用容器版本匹配，避免API不兼容问题
2. 权限控制：服务账户需限制最小权限，建议仅授予对当前Pod的管理权限
3. 资源预留：为边车容器预留至少100m CPU和128Mi内存资源，避免资源竞争
4. 配置更新：修改ConfigMap后需重启Pod或通过kubectl rollout restart使配置生效