kiwigrid/k8s-sidecar 镜像文档

概述

kiwigrid/k8s-sidecar 是一个通过 Kubernetes (K8s) 内部 API 收集 ConfigMaps 资源，并将其内容存储到指定文件路径的容器，旨在简化应用对分布式配置的集中获取与管理。

特性

• 与 K8s API 原生集成，集群内运行时无需额外认证配置
• 支持通过标签选择器筛选目标 ConfigMaps，避免无关资源收集
• 可自定义配置存储路径，适配不同应用的配置目录结构
• 轻量级设计，资源占用低，适合作为 Sidecar 容器部署

使用场景

• 微服务架构中集中管理多实例配置文件
• 日志/监控组件动态加载分散的 ConfigMaps 配置
• 需要统一访问多个 ConfigMaps 内容的应用部署场景

部署示例

Docker 运行示例（集群外测试用）

docker run -d \
  --name k8s-sidecar \
  -e KUBERNETES_SERVICE_HOST=192.168.1.100 \
  -e KUBERNETES_SERVICE_PORT=6443 \
  -e TOKEN=$(cat /path/to/kubeconfig-token) \
  -e FOLDER=/config \
  -e LABEL_SELECTOR=app=backend-config \
  -v /host/config:/config \
  kiwigrid/k8s-sidecar

注：集群外运行需手动配置 K8s API 地址、端口及认证 Token。

Kubernetes Sidecar 部署示例

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app-with-sidecar
spec:
  replicas: 1
  template:
    spec:
      containers:
      - name: main-app
        image: my-app:v1
        volumeMounts:
        - name: config-volume
          mountPath: /app/config
      - name: k8s-sidecar
        image: kiwigrid/k8s-sidecar:latest
        env:
        - name: FOLDER
          value: /app/config
        - name: LABEL_SELECTOR
          value: app=backend-config
        volumeMounts:
        - name: config-volume
          mountPath: /app/config
      volumes:
      - name: config-volume
        emptyDir: {}
      serviceAccountName: config-reader # 需配置 RBAC 权限

说明：通过共享卷 /app/config，主应用可直接读取 sidecar 收集的 ConfigMaps 内容。

注意事项

• 集群内部署需为容器配置具有 configmaps.get 和 configmaps.list 权限的 ServiceAccount
• 存储路径需确保容器有写入权限，生产环境建议使用持久卷或临时共享卷
• 通过环境变量 NAMESPACE 可限制 ConfigMaps 收集范围，默认监听所有命名空间