appdynamics/cluster-agent

Cluster Agent for Kubernetes Docker镜像文档

一、镜像概述和主要用途

Cluster Agent for Kubernetes 是一款专为 Kubernetes 集群设计的监控与管理代理程序，通过 Docker 镜像形式分发。该 Agent 深度集成 Kubernetes API，旨在提供集群级别的全面观测能力，包括节点与工作负载状态监控、资源使用率采集、事件日志聚合、健康检查及告警等核心功能，帮助用户实现对 Kubernetes 集群的可视化管理、故障排查与资源优化。

二、核心功能和特性

2.1 集群监控

• 节点级监控：实时采集各节点（Node）的运行状态（就绪/未就绪）、网络连接、磁盘健康。
• 工作负载监控：跟踪 Pod、Deployment、StatefulSet、Service 等 Kubernetes 资源的状态（运行/暂停/失败）、副本数、重启次数。

2.2 资源与性能数据采集

• 收集集群节点及 Pod 的 CPU、内存、磁盘 I/O、网络吞吐量等资源使用率指标。
• 支持自定义指标采集（通过 Prometheus 格式暴露，可集成 Grafana 等可视化工具）。

2.3 事件与日志管理

• 采集 Kubernetes 集群事件（如 Pod 调度、节点故障、资源不足告警）并持久化存储。
• 支持容器日志聚合（标准输出/文件日志），支持日志过滤与结构化处理。

2.4 健康检查与告警

• 内置节点与工作负载健康检查规则，支持自定义阈值（如 CPU 使用率 > 80% 触发告警）。
• 支持多种告警渠道（Webhook、Slack、Email、Prometheus Alertmanager）。

2.5 与 Kubernetes 生态集成

• 原生支持 Kubernetes API Server，动态发现集群资源。
• 兼容 ServiceAccount 认证，无需手动配置集群凭证。

2.6 可扩展性

• 支持插件机制，可扩展功能（如安全扫描、合规检查、成本分析）。
• 提供 REST API 与 gRPC 接口，便于集成第三方平台（如监控系统、CI/CD 工具）。

三、使用场景和适用范围

3.1 使用场景

• 生产环境集群监控：实时观测大规模 Kubernetes 集群的运行状态，保障服务稳定性。
• 多集群统一管理：在混合云或多云环境中，通过 Agent 实现跨集群数据聚合与统一观测。
• 资源优化与容量规划：基于历史资源使用率数据，优化 Pod 调度策略，避免资源浪费。
• 故障排查与根因分析：通过事件与日志关联分析，快速定位集群故障原因（如节点磁盘满导致 Pod 驱逐）。
• 合规审计：记录集群配置变更、资源操作日志，满足行业合规要求（如 GDPR、SOC 2）。

3.2 适用范围

• Kubernetes 版本：1.21 及以上（支持 CRD、CSI、CNI 主流插件）。
• 集群类型：云厂商托管集群（EKS、GKE、AKS）、自管理集群（kubeadm、kops）、边缘集群（K3s、MicroK8s）。
• 部署环境：Linux 节点（x86_64/ARM64 架构），支持容器运行时（Docker、containerd、CRI-O）。

四、详细的使用方法和配置说明

4.1 前提条件

• 运行中的 Kubernetes 集群（1.21+），且已配置 kubectl 访问权限。
• 节点已安装 Docker 引擎（用于拉取镜像）或容器运行时（containerd 等）。
• 集群网络允许 Pod 访问 Kubernetes API Server（默认端口 443）及外部告警服务（如需）。

4.2 镜像拉取

从 Docker Registry 拉取最新版本镜像：

bash
docker pull example/cluster-agent:latest  # 示例镜像地址，实际请替换为官方地址

4.3 部署方式

4.3.1 通过 Kubernetes DaemonSet 部署（推荐生产环境）

Agent 需在每个节点运行以采集完整数据，推荐使用 DaemonSet 部署：

yaml
# cluster-agent-daemonset.yaml
apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: cluster-agent
  namespace: monitoring  # 建议部署在独立命名空间
spec:
  selector:
    matchLabels:
      app: cluster-agent
  template:
    metadata:
      labels:
        app: cluster-agent
    spec:
      hostNetwork: true  # 需访问节点网络信息
      containers:
      - name: cluster-agent
        image: example/cluster-agent:latest
        resources:
          limits:
            cpu: 500m
            memory: 512Mi
          requests:
            cpu: 200m
            memory: 256Mi
        env:
        - name: CLUSTER_NAME
          value: "prod-cluster-01"  # 集群名称，用于多集群区分
        - name: METRICS_INTERVAL
          value: "30s"  # 指标采集间隔
        - name: LOG_LEVEL
          value: "info"  # 日志级别：debug/info/warn/error
        volumeMounts:
        - name: var-log
          mountPath: /var/log  # 挂载节点日志目录（可选，用于日志采集）
        - name: var-lib-kubelet
          mountPath: /var/lib/kubelet  # 挂载 kubelet 目录（可选，用于节点状态采集）
      volumes:
      - name: var-log
        hostPath:
          path: /var/log
      - name: var-lib-kubelet
        hostPath:
          path: /var/lib/kubelet

应用部署：

bash
kubectl apply -f cluster-agent-daemonset.yaml

4.3.2 通过 Docker run 本地测试

本地测试时，可通过 Docker 直接运行（需挂载 kubeconfig 以访问集群）：

bash
docker run -d \
  --name cluster-agent-test \
  -v $HOME/.kube/config:/root/.kube/config:ro \  # 挂载本地 kubeconfig
  -e CLUSTER_NAME="local-test-cluster" \
  -e METRICS_INTERVAL="10s" \
  -e LOG_LEVEL="debug" \
  example/cluster-agent:latest

4.3.3 通过 docker-compose 本地开发

本地开发调试时，使用 docker-compose 管理配置：

yaml
# docker-compose.yml
version: "3"
services:
  cluster-agent:
    image: example/cluster-agent:latest
    volumes:
      - $HOME/.kube/config:/root/.kube/config:ro
    environment:
      - CLUSTER_NAME=local-dev-cluster
      - METRICS_INTERVAL=5s
      - LOG_LEVEL=debug
      - ALERT_WEBHOOK_URL=http://host.docker.internal:8080/alert  # 本地告警接收服务
    network_mode: host  # 共享主机网络，便于访问本地 Kubernetes 集群

启动服务：

bash
docker-compose up -d

4.4 配置参数说明

4.4.1 环境变量（核心配置）

4.4.2 命令行参数

支持通过命令行参数覆盖环境变量配置，格式：--参数名=值。例如：

bash
docker run example/cluster-agent:latest --log-level=debug --metrics-interval=5s

4.4.3 配置文件挂载

复杂配置可通过挂载配置文件（如 config.yaml）实现，挂载路径需通过 CONFIG_FILE 环境变量指定：

yaml
# config.yaml 示例
cluster_name: "prod-cluster-01"
metrics:
  interval: "30s"
  include: ["pods", "nodes", "services"]  # 仅采集指定资源类型指标
alert:
  thresholds:
    cpu: 80
    memory: 85
  webhooks:
    - url: "https://alert-manager.example.com/webhook"
      timeout: "5s"
plugins:
  enabled: ["metrics", "events", "cost-analyzer"]

挂载配置文件运行：

bash
docker run -d \
  -v $(pwd)/config.yaml:/etc/cluster-agent/config.yaml \
  -e CONFIG_FILE=/etc/cluster-agent/config.yaml \
  example/cluster-agent:latest

五、验证与运维

5.1 验证部署状态

• Kubernetes 环境：

  bash
  kubectl get pods -n monitoring -l app=cluster-agent  # 检查 Pod 运行状态
  kubectl logs -n monitoring <pod-name>  # 查看日志
  

• Docker 环境：

  bash
  docker ps | grep cluster-agent  # 检查容器状态
  docker logs <container-id>  # 查看日志
  

5.2 升级与回滚

• 升级镜像版本：修改 DaemonSet 的 image 字段后重新应用 YAML，或使用 kubectl set image：

  bash
  kubectl set image daemonset/cluster-agent cluster-agent=example/cluster-agent:v1.2.0 -n monitoring
  

• 回滚：通过 kubectl rollout undo 回滚到上一版本：

  bash
  kubectl rollout undo daemonset/cluster-agent -n monitoring
  

5.3 资源调整

根据集群规模调整资源限制（如 100 节点集群建议 CPU 500m/内存 1Gi）：

bash
kubectl edit daemonset/cluster-agent -n monitoring  # 修改 resources.limits/requests

六、常见问题

Q1：Agent 无法采集节点磁盘使用率？

A：确保 DaemonSet 挂载了节点磁盘目录（如 /var/lib/kubelet 或 /proc/mounts），并检查容器是否有足够权限（可添加 securityContext: privileged: true，生产环境谨慎使用）。

Q2：多集群数据如何区分？

A：通过 CLUSTER_NAME 环境变量为每个集群设置唯一名称，后端存储（如 Prometheus）可基于该标签聚合数据。

Q3：如何禁用不必要的插件？

A：修改 PLUGINS_ENABLED 环境变量，仅保留所需插件（如 PLUGINS_ENABLED=metrics,events）。