inmoment/kibana-sidecar

Kibana Sidecar 镜像文档

镜像概述

该Docker镜像旨在在Kubernetes集群中运行，用于收集带有指定标签的ConfigMaps，并将其值作为Saved Objects通过Kibana API上传到Kibana。其核心用途是实现Kibana搜索、可视化、索引模式和仪表板的自动化部署，无需手动操作Kibana界面。

核心功能和特性

• Kubernetes ConfigMaps集成：能够识别并收集带有指定标签的Kubernetes ConfigMaps
• Kibana Saved Objects支持：将ConfigMaps中的配置值转换为Kibana的Saved Objects（包括搜索、可视化、索引模式、仪表板等）
• API兼容性：内置Python脚本兼容Kubernetes API 1.10及更高版本，以及Kibana API 6.4.x及更高版本
• 自动化部署流程：简化Kibana对象的部署和更新过程，提高配置管理效率

使用场景和适用范围

• Kubernetes环境中的Kibana配置管理：适用于在Kubernetes集群中集中管理Kibana对象
• CI/CD流水线集成：可融入持续集成/持续部署流程，实现Kibana配置的自动化更新
• 多环境配置同步：在开发、测试、生产等不同环境中保持Kibana对象配置的一致性
• 大规模Kibana部署：适合需要管理大量Kibana对象的企业级应用场景

使用方法和配置说明

前提条件

• 运行环境：Kubernetes集群（1.10+版本）
• Kibana实例（6.4.x+版本），且需能从Kubernetes集群内部访问
• 适当的RBAC权限：容器需要具备访问Kubernetes ConfigMaps的权限

配置参数

容器通过环境变量进行配置，主要参数如下：

部署示例

Kubernetes Deployment配置

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kibana-sidecar
spec:
  replicas: 1
  selector:
    matchLabels:
      app: kibana-sidecar
  template:
    metadata:
      labels:
        app: kibana-sidecar
    spec:
      containers:
      - name: kibana-sidecar
        image: docker.xuanyuan.run/[镜像名称]  # 替换为实际镜像名称
        env:
        - name: KIBANA_URL
          value: "http://kibana:5601"
        - name: KUBERNETES_LABEL
          value: "kibana-object=true"
        - name: KIBANA_USER
          valueFrom:
            secretKeyRef:
              name: kibana-credentials
              key: username
        - name: KIBANA_PASSWORD
          valueFrom:
            secretKeyRef:
              name: kibana-credentials
              key: password

工作流程

1. 容器启动后，通过Kubernetes API监控带有指定标签（由KUBERNETES_LABEL定义）的ConfigMaps
2. 检测到新的或更新的ConfigMaps时，读取其内容
3. 将ConfigMaps中的值转换为Kibana Saved Objects格式
4. 通过Kibana API将Saved Objects上传到Kibana实例

代码仓库

更多详细信息和源代码，请访问：https://github.com/InMoment/kibana-sidecar