jmickey/telegraf-sidecar-operator

Telegraf Sidecar 自动注入镜像

概述

该Docker镜像提供通过Kubernetes Pod注解实现Telegraf边车容器自动注入与配置的功能，旨在简化Kubernetes环境中Telegraf监控代理的部署流程，无需手动定义和管理边车容器配置。

核心功能与特性

• 自动注入机制：通过Pod注解触发Telegraf边车容器的自动注入，减少手动配置工作量
• 注解驱动配置：支持直接通过Pod注解指定Telegraf配置参数，包括输入插件、输出目标等核心配置
• Kubernetes原生集成：与Kubernetes集群环境深度适配，利用集群资源实现监控数据的采集与转发

使用场景与适用范围

• 需为Kubernetes集群内Pod添加监控数据采集能力的场景
• 希望简化Telegraf边车容器部署流程的开发与运维团队
• 适用于各类需要通过Telegraf采集指标的应用，如数据库服务、Web应用、中间件等

使用方法与配置说明

前提条件

• Kubernetes集群（推荐版本1.16及以上，需支持MutatingWebhookConfiguration）
• 已部署该镜像提供的Webhook服务（用于处理Pod注解并执行边车注入）

配置Pod注解

在目标Pod的元数据注解中添加Telegraf相关配置，示例如下：

yaml
metadata:
  annotations:
    telegraf.influxdata.com/inject: "true"  # 启用边车注入
    telegraf.influxdata.com/config: |       # Telegraf配置内容（TOML格式）
      [[inputs.cpu]]
        percpu = true
        totalcpu = true
      [[outputs.influxdb]]
        urls = ["http://influxdb-service:8086"]
        database = "monitoring"

关键注解参数说明

• telegraf.influxdata.com/inject: 布尔值注解，设置为"true"时启用Telegraf边车容器注入
• telegraf.influxdata.com/config: 字符串注解，用于定义Telegraf的完整配置（TOML格式），包括输入插件、输出目标、处理器等

部署流程

1. 部署Webhook服务（具体部署步骤需参考镜像官方文档，通常包括创建Deployment、Service及MutatingWebhookConfiguration）
2. 在目标应用的Pod模板中添加上述注解配置
3. 应用部署后，Kubernetes将通过Webhook自动注入Telegraf边车容器，并应用注解中定义的配置
4. 验证边车容器状态：kubectl describe pod <pod-name> 查看是否包含telegraf容器

注意事项

• 确保Webhook服务具有足够的权限处理Pod创建/更新事件
• Telegraf配置需符合TOML语***范，避免配置错误导致容器启动失败
• 根据实际监控需求调整输入插件配置，避免不必要的资源消耗