checkpoint/cp-nano-k8s-discovery

镜像概述

该镜像是一个轻量级代理容器，主要用途是提供Kubernetes（K8s）集群结构的发现能力。通过部署该代理，可以自动探测并收集K8s集群中的核心组件信息（如节点、Pod、Service、Deployment等）及其拓扑关系，为集群监控、管理和运维提供基础数据支持。

核心功能与特性

1. 集群结构发现

自动探测K8s集群中的核心资源对象（节点、命名空间、Pod、Service、Deployment、StatefulSet等），并梳理其层级关系与依赖拓扑。

2. 轻量级设计

采用精简架构，资源占用低（CPU/内存消耗极小），适合部署在资源受限的K8s环境或边缘节点。

3. 实时数据同步

支持与K8s API Server实时交互，动态获取集群最新状态，确保数据时效性。

4. 标准化数据输出

提供结构化数据格式（如JSON），便于与监控平台、管理工具或自动化系统集成。

使用场景

• K8s集群监控工具集成：作为数据采集代理，为监控平台（如Prometheus、Grafana）提供集群结构数据，辅助构建拓扑视图。
• 集群管理系统：支持管理工具快速获取集群架构信息，优化资源调度与故障排查。
• 自动化运维流程：为自动化运维脚本或平台提供集群结构数据，支撑动态扩缩容、服务发现等场景。
• 开发测试环境：在开发或测试K8s集群中快速获取结构信息，辅助调试与环境验证。

使用方法与配置说明

基本使用（Docker Run）

通过docker run命令直接部署代理容器，需配置K8s API访问信息：

docker
docker run -d \
  --name nano-k8s-discovery-agent \
  -e K8S_API_URL="https://kubernetes.default.svc:443" \  # K8s API Server地址（必填）
  -e NAMESPACE="default" \  # 目标命名空间（留空则发现所有命名空间）
  -e LOG_LEVEL="info" \  # 日志级别（debug/info/warn/error）
  -e POLL_INTERVAL="30" \  # 数据轮询间隔（秒，默认30）
  --restart always \
  [镜像名称]:[标签]

Docker Compose配置示例

yaml
version: '3'
services:
  k8s-discovery-agent:
    image: docker.xuanyuan.run/[镜像名称]:[标签]
    container_name: nano-k8s-discovery-agent
    environment:
      - K8S_API_URL=https://kubernetes.default.svc:443  # K8s API Server地址（必填）
      - NAMESPACE=monitoring  # 仅发现monitoring命名空间资源
      - LOG_LEVEL=debug  # 开启调试日志
      - POLL_INTERVAL=60  # 每60秒轮询一次
    restart: always

环境变量配置说明

注意事项

• K8s API访问权限：需确保容器有权限访问K8s API Server（建议通过K8s内部署时挂载ServiceAccount令牌，或外部部署时配置K8S_TOKEN与K8S_CA_CERT）。
• 网络连通性：容器需与K8s API Server网络互通，建议在K8s集群内通过Pod部署（可直接使用kubernetes.default.svc内部域名）。
• 资源限制：根据集群规模调整资源限制（如--memory=128m --cpus=0.1），默认配置下资源消耗极低。