omegavveapon/kopf-k8s-sidecar
omegavveapon
kopf-k8s-sidecar是使用Python的kopf框架实现的k8s-sidecar工具，用于监视Kubernetes中的ConfigMap和/或Secret，根据指定标签筛选资源，并将其数据字段内容写入指定目录，解决了原k8s-sidecar存在的资源监视挂起问题。
下载次数: 0状态：社区镜像维护者：omegavveapon仓库类型：镜像最近更新：4 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
kopf-k8s-sidecar
镜像概述
kopf-k8s-sidecar是基于Python的kopf框架实现的https://github.com/kiwigrid/k8s-sidecar%E6%9B%BF%E4%BB%A3%E6%96%B9%E6%A1%88%E3%80%82%E5%AE%83%E7%94%A8%E4%BA%8E%E7%9B%91%E8%A7%86Kubernetes%E9%9B%86%E7%BE%A4%E4%B8%AD%E7%9A%84ConfigMap%E5%92%8C/%E6%88%96Secret%E8%B5%84%E6%BA%90%EF%BC%8C%E6%A0%B9%E6%8D%AE%E6%8C%87%E5%AE%9A%E6%A0%87%E7%AD%BE%E7%AD%9B%E9%80%89%E8%B5%84%E6%BA%90%EF%BC%8C%E5%B9%B6%E5%B0%86%E8%BF%99%E4%BA%9B%E8%B5%84%E6%BA%90%E7%9A%84%60data%60%E5%AD%97%E6%AE%B5%E5%86%85%E5%AE%B9%E5%86%99%E5%85%A5%E5%88%B0%E6%8C%87%E5%AE%9A%E7%9B%AE%E5%BD%95%E4%B8%AD%E3%80%82%E8%AF%A5%E5%AE%9E%E7%8E%B0%E6%97%A8%E5%9C%A8%E8%A7%A3%E5%86%B3%E5%8E%9Fk8s-sidecar%E5%AD%98%E5%9C%A8%E7%9A%84%E8%B5%84%E6%BA%90%E7%9B%91%E8%A7%86%E6%8C%82%E8%B5%B7%E9%97%AE%E9%A2%98%EF%BC%8C%E5%B9%B6%E9%80%9A%E8%BF%87%E4%BD%BF%E7%94%A8operator%E6%A1%86%E6%9E%B6%E7%AE%80%E5%8C%96%E4%BA%86%E6%A0%B8%E5%BF%83%E9%80%BB%E8%BE%91%E3%80%82
核心功能与特性
- 资源监视：支持监视ConfigMap、Secret或同时监视两者
- 标签筛选：通过指定标签（LABEL）及其可选值（LABEL_VALUE）筛选资源
- 动态文件生成：将资源的
data字段内容写入指定目录 - 目录覆盖：支持通过资源注解（FOLDER_ANNOTATION）覆盖文件目标目录
- 多命名空间支持：可监视单个、多个或所有命名空间的资源
- 运行模式：支持持续监视（WATCH）和一次性列表（LIST）两种运行模式
- 健康检查：提供健康检查端点，可用于容器存活探针配置
- 调试支持：可通过环境变量启用调试日志
- 文件权限控制：支持设置默认文件系统权限
- 唯一文件名：可配置生成唯一文件名，避免数据键冲突
使用场景与适用范围
- 需要动态获取Kubernetes ConfigMap/Secret配置数据的应用
- 替代原k8s-sidecar以解决资源监视挂起问题的场景
- Grafana等需要通过sidecar加载配置的应用（兼容Grafana Helm Chart）
- 需要集中管理和分发配置文件的Kubernetes集群环境
使用方法与配置说明
快速开始
- 将项目
/examples目录下的资源部署到Kubernetes集群 - 查看sidecar容器日志，观察创建、删除或更新ConfigMap/Secret时的事件
- 查看bash容器日志，确认ConfigMap/Secret定义的文件已正确生成
Docker镜像获取
所有镜像标签均自动构建并推送到https://hub.docker.com/r/omegavveapon/kopf-k8s-sidecar
Grafana Helm Chart用户配置
若要将此镜像与https://github.com/grafana/helm-charts/tree/main/charts/grafana%E9%85%8D%E5%90%88%E4%BD%BF%E7%94%A8%EF%BC%9A
- 设置
.Values.sidecar.image.repository为omegavveapon/kopf-k8s-sidecar - 设置
.Values.sidecar.image.tag为https://github.com/OmegaVVeapon/kopf-k8s-sidecar/releases%E4%B8%AD%E7%9A%84%E6%9C%80%E6%96%B0%E6%A0%87%E7%AD%BE
健康检查配置
sidecar提供简单的健康检查端点，适用于存活探针（不建议用于就绪探针）：
yamllivenessProbe: httpGet: path: /healthz port: 8181
若端口冲突，可通过HEALTHCHECK_PORT环境变量修改端口。
配置环境变量
| 变量 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|
| LABEL | 是 | None | 用于筛选资源的标签 |
| FOLDER | 是 | None | 文件存放目录 |
| FOLDER_ANNOTATION | 否 | k8s-sidecar-target-directory | 用于覆盖文件目标目录的资源注解 |
| LABEL_VALUE | 否 | None | 标签筛选值，不设置则匹配任何值 |
| NAMESPACE | 否 | ALL | 监视的命名空间，多命名空间用逗号分隔（如"default,test"），设为ALL则监视所有命名空间 |
| RESOURCE | 否 | configmap | 监视的资源类型，可选值：configmap、secret或both |
| METHOD | 否 | WATCH | 运行模式：WATCH（持续监视）或LIST（收集当前资源后退出） |
| DEFAULT_FILE_MODE | 否 | None | 默认文件权限，使用三位数字（如'500'、'440'） |
| DEBUG | 否 | False | 设置为true启用kopf调试日志 |
| WATCH_CLIENT_TIMEOUT | 否 | 660 | 客户端侧监视会话超时时间（秒），包括连接建立和事件流 |
| WATCH_SERVER_TIMEOUT | 否 | 600 | 服务器侧监视会话超时时间（秒），通过查询字符串传递给服务器 |
| UNIQUE_FILENAMES | 否（但建议启用） | False | 设置为true生成唯一文件名，避免ConfigMap/Secret间数据键冲突 |
| HEALTHCHECK_PORT | 否 | 8181 | /healthz端点监听端口 |
注意事项
命名空间处理
与原k8s-sidecar不同，本镜像默认监视所有命名空间（如环境变量NAMESPACE所述）。若只需监视sidecar所在命名空间，需显式指定该命名空间。
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 kopf-k8s-sidecar 镜像标签
docker pull docker.xuanyuan.run/omegavveapon/kopf-k8s-sidecar:<标签>
DockerHub 原生拉取命令
docker pull omegavveapon/kopf-k8s-sidecar:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"