kai/k8s-inventory 镜像文档

1. 镜像概述

kai/k8s-inventory 是一款针对 Kubernetes 集群的资源清单管理工具镜像，旨在帮助用户自动发现、跟踪和管理集群中的各类资源（如 Pod、Deployment、Service 等）、配置信息及资源间依赖关系。通过该镜像，用户可快速实现 K8s 集群资源的可视化与集中化管理，提升集群维护效率。

2. 核心功能与特性

• 自动资源发现：支持接入 Kubernetes 集群 API，自动扫描并发现集群内所有命名空间下的资源对象。
• 资源全生命周期跟踪：记录资源创建、更新、删除等操作历史，生成变更日志。
• 依赖关系可视化：解析资源间关联（如 Deployment 与 Pod、Service 与 Endpoint 的绑定关系），生成依赖图谱。
• 配置信息集中管理：聚合资源配置详情（如环境变量、挂载卷、标签注解等），支持导出为 JSON/YAML 格式。
• 多集群支持：可同时接入多个 K8s 集群，统一管理跨集群资源清单。

3. 使用场景与适用范围

• K8s 集群日常管理：适用于集群管理员日常巡检、资源清点与状态监控。
• 资源审计与合规检查：用于审计集群资源配置是否符合规范，追踪非授权变更。
• 故障排查辅助：通过依赖关系图谱快速定位资源异常关联，辅助故障根因分析。
• 多集群资源统筹：企业级多集群环境下，实现跨集群资源的统一可视化与管理。

4. 使用方法与配置说明

4.1 前置条件

• 已安装 Docker 环境（版本 ≥ 20.10）。
• 目标 K8s 集群已开启 API 访问权限，且宿主机可通过 kubeconfig 文件或集群内 ServiceAccount 访问集群 API。

4.2 快速启动（docker run）

4.2.1 通过 kubeconfig 接入集群

docker run -d \
  --name k8s-inventory \
  -v /path/to/your/kubeconfig:/app/config/kubeconfig \  # 挂载本地 kubeconfig 文件
  -e CLUSTER_NAME="my-k8s-cluster" \  # 集群名称（自定义）
  -e SCAN_INTERVAL=300 \  # 资源扫描间隔（秒，默认 300）
  -p 8080:8080 \  # 暴露 Web 界面端口
  kai/k8s-inventory:latest

4.2.2 集群内部署（通过 ServiceAccount 认证）

在 K8s 集群内通过 Deployment 部署时，可使用集群内 ServiceAccount 自动获取 API 访问权限：

# k8s-inventory-deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: k8s-inventory
  namespace: kube-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: k8s-inventory
  template:
    metadata:
      labels:
        app: k8s-inventory
    spec:
      serviceAccountName: k8s-inventory-sa  # 需提前创建具备集群资源查看权限的 ServiceAccount
      containers:
      - name: k8s-inventory
        image: kai/k8s-inventory:latest
        env:
        - name: CLUSTER_NAME
          value: "local-cluster"
        - name: SCAN_INTERVAL
          value: "300"
        ports:
        - containerPort: 8080

4.3 环境变量配置

4.4 访问与使用

启动容器后，通过 http://<宿主机IP>:8080 访问 Web 管理界面，可查看：

• 集群资源概览（资源类型、数量统计）；
• 资源详情页（单个资源的配置、状态、关联关系）；
• 变更历史记录（资源修改时间、修改内容对比）；
• 依赖关系图谱（可视化展示资源间绑定关系）。

5. 注意事项

• 确保宿主机或集群内 ServiceAccount 具备足够的权限（至少包含 get、list、watch 集群资源的权限）；
• 对于大规模集群（资源数量 > 1000），建议适当增大 SCAN_INTERVAL 以减少 API 服务器压力；
• 容器内默认不持久化数据，如需保留历史记录，可挂载外部存储卷至 /app/data 目录。