bohunn/cp-k8s-secret

Kubernetes Secret Watcher

镜像概述和主要用途

Kubernetes Secret Watcher 是一个基于Go语言开发的程序，用于监控Kubernetes集群中的Secrets资源，并根据事件类型（创建、更新、删除）执行跨命名空间的Secret同步操作。其核心功能是在源命名空间与应用运行的目标命名空间之间保持Secrets的一致性。

核心功能和特性

• Secret创建同步：当源命名空间新增Secret时，自动在目标命名空间创建同名Secret；若目标命名空间已存在同名Secret，则执行更新操作
• Secret更新同步：当源命名空间的Secret被修改时，自动更新目标命名空间中对应的Secret
• Secret删除同步：支持基于配置策略的删除同步，可配置为DELETE（同步删除目标Secret）或ORPHAN（保留目标Secret）
• 灵活的删除策略：通过配置文件控制删除事件的处理行为，满足不同场景下的同步需求

使用场景和适用范围

适用于Kubernetes集群中需要跨命名空间共享配置密钥的场景，例如：

• 多环境（开发/测试/生产）间的配置同步
• 跨命名空间应用的密钥统一管理
• 需要保持密钥一致性的微服务架构

前提条件

使用该程序需满足以下环境要求：

• 已安装Go语言环境（用于本地构建）
• 可访问的Kubernetes集群环境

使用方法和配置说明

配置文件

程序通过YAML格式的配置文件进行参数设置，需包含以下字段：

• secret_name：需监控的Secret名称列表（逗号分隔）
• namespace：源命名空间（待监控的Secret所在命名空间）
• deletion_policy：删除策略，可选值为ORPHAN（保留目标Secret）或DELETE（同步删除目标Secret）

配置文件示例：

yaml
secret_name: secret1,secret2
namespace: default
deletion_policy: DELETE

部署配置

1. 镜像获取：可通过两种方式获取镜像

   • 本地构建：基于Dockerfile构建镜像
   • 直接使用Docker Hub镜像：bohunn/cp-k8s-secret

2. 配置文件挂载：在Kubernetes Deployment中，需将配置文件挂载至容器内路径/config.cfg

3. 部署资源：完整的Kubernetes部署示例（如Deployment、ServiceAccount等YAML文件）可在项目仓库的deploy/目录中获取

事件处理逻辑

创建Secret事件

当源命名空间新增Secret时：

• 若目标命名空间不存在同名Secret，自动创建该Secret
• 若目标命名空间已存在同名Secret，自动更新该Secret的内容

更新Secret事件

当源命名空间的Secret被修改时：

• 自动同步更新目标命名空间中对应的Secret，确保内容一致性

删除Secret事件

当源命名空间的Secret被删除时：

• 若配置deletion_policy: DELETE，则同步删除目标命名空间中的对应Secret
• 若配置deletion_policy: ORPHAN，则不执行任何操作，保留目标命名空间中的Secret

许可证

Kubernetes Secret Watcher 基于MIT许可证开源。

https://img.shields.io/badge/License-MIT-yellow.svg](https://opensource.org/licenses/MIT)