flant/addon-operator Docker 镜像 - 轩辕镜像

Addon-operator 镜像文档

镜像概述与主要用途

Addon-operator通过为Helm图表添加钩子（hooks）和值（values），增强Helm的功能，将图表转换为智能模块。这些模块能够自我配置并响应集群中的变化，适用于需要动态调整Kubernetes集群配置的场景，简化运维流程并提高部署的灵活性和可靠性。

核心功能与特性

• Helm图表的值发现：参数可通过生成、计算或从集群中获取；
• 持续值发现：参数可响应集群事件动态变化；
• 受控的Helm执行：监控Helm操作以确保图表成功安装（即将支持：嵌入Helm和Tiller实现紧密集成，使用kubedog跟踪部署状态等）；
• 自定义额外操作：通过钩子机制在Helm运行前后及其他事件中执行自定义操作（详见shell-operator能力）。

此外，还提供：

• 简化Kubernetes集群维护：使用bash、kubectl、python等运维熟悉的工具构建模块和钩子；
• 模块和钩子执行队列：确保启动顺序，出错时重复执行，简化模块编程并保证操作结果可预测；
• 模块动态启用/禁用：根据检测到的参数动态控制模块状态；
• 模块激活条件关联：将模块激活条件与其他模块的激活状态绑定；
• 统一配置ConfigMap：集中管理所有设置；
• 基于参数变化的Helm执行：仅在参数变化时运行Helm，发布列表包含修改发布的构建时间；
• 全局钩子：用于确定影响多个依赖模块的参数和执行操作；
• 内置Prometheus指标：支持监控。

工作原理概述

钩子与Helm值

钩子由Kubernetes事件及其他刺激触发，是可执行文件，执行过程中可修改Kubernetes资源并设置Helm值（存储在Addon-operator内存中）。钩子是模块的一部分，模块中还包含Helm图表。当钩子修改值时，Addon-operator会启动Helm图表的重新安装。

模块

支持多模块部署。除模块外，还支持全局钩子和全局值（独立值存储）。全局钩子由事件触发，激活时可：

• 修改Kubernetes资源；
• 修改全局值存储。

当全局钩子修改全局存储中的值时，Addon-operator会启动所有Helm图表的重新安装。

安装与使用方法

镜像获取

使用Docker Hub官方镜像：flant/addon-operator，包含addon-operator二进制文件及必要工具（helm、kubectl、jq、bash等）。

安装步骤

安装过程包括：

1. 构建包含模块和钩子文件的镜像；
2. 添加必要的RBAC权限；
3. 在集群中启动镜像。

示例目录（/examples）提供预设文件和命令，可参考进行配置部署。

使用场景与适用范围

适用于需要动态调整Kubernetes集群配置的场景，如：

• 多模块依赖的集群部署；
• 需要根据集群状态自动调整参数的应用；
• 需简化Helm图表维护并增强响应能力的运维流程。

进一步参考

• 生命周期、模块和值的详细文档：LIFECYCLE、MODULES、VALUES；
• 监控指标详情：METRICS；
• 示例目录：examples。

许可证

Apache License 2.0，详见LICENSE。