banzaicloud/k8s-sidecar

k8s-sidecar 镜像文档

镜像概述和主要用途

k8s-sidecar是一个运行在Kubernetes集群中的Docker容器，旨在收集带有指定标签的ConfigMap，并将其中包含的文件存储到本地文件夹。它还能在ConfigMap发生变化后向指定URL发送HTTP请求。主要用途是作为sidecar容器与应用部署在同一Pod中，为应用提供来自集群的动态配置信息。容器内置的Python脚本兼容Kubernetes API 1.10。

核心功能和特性

• 提取ConfigMap文件：从指定ConfigMap中提取文件并保存到本地目录
• 基于标签过滤：仅处理带有特定标签的ConfigMap
• 动态更新/删除：当ConfigMap发生变更时，自动更新或删除本地文件
• HTTP请求通知：支持在配置更新后向指定URL发送HTTP请求，通知应用配置变化

使用场景和适用范围

适用于需要从Kubernetes ConfigMap动态获取和更新配置文件的应用场景，特别是：

• 需要在运行时加载外部配置的服务
• 配置频繁变更且需实时生效的应用
• 多实例共享同一套配置的集群环境

使用方法和配置说明

部署前提

需在Kubernetes集群中运行，建议与应用部署在同一Pod中，并共享存储卷以实现配置文件的共享访问。根据集群设置，可能需要先授予适当权限，例如：

bash
kubectl create clusterrolebinding cluster-admin-binding \
  --clusterrole cluster-admin \
  --user $(gcloud config get-value account)

配置环境变量

部署示例

以下是Kubernetes Deployment中使用sidecar的示例片段：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  replicas: 1
  template:
    spec:
      containers:
      - name: main-app
        image: docker.xuanyuan.run/my-app-image
        volumeMounts:
        - name: config-volume
          mountPath: /etc/config
      - name: k8s-sidecar
        image: docker.xuanyuan.run/kiwigrid/k8s-sidecar
        env:
        - name: LABEL
          value: "my-app-config=true"
        - name: FOLDER
          value: "/etc/config"
        - name: NAMESPACE
          value: "default"
        - name: REQ_URL
          value: "http://localhost:8080/config-reloaded"
        volumeMounts:
        - name: config-volume
          mountPath: /etc/config
      volumes:
      - name: config-volume
        emptyDir: {}

在上述示例中，sidecar容器与主应用共享config-volume卷，当带有my-app-config=true标签的ConfigMap发生变化时，sidecar会更新/etc/config目录下的文件，并向http://localhost:8080/config-reloaded发送GET请求通知主应用。