shorelinesoftware/agent

Shoreline Software Agent Image 文档

概述

Shoreline Software Agent Image是Shoreline Software提供的官方Docker镜像，用于部署轻量级代理程序，实现对云基础设施、容器化应用及系统资源的实时监控、管理与自动化运维。该镜像设计轻量高效，可无缝集成到现有容器编排环境（如Kubernetes、Docker Swarm）中，支持多平台部署，为运维团队提供统一的监控与操作界面。

核心功能与特性

核心功能

• 实时数据采集：监控系统资源（CPU、内存、磁盘I/O、网络）、应用性能指标及容器运行状态
• 自动化运维操作：基于预设规则触发自动化响应（如服务重启、资源扩容），支持自定义脚本执行
• 多平台集成：兼容主流云平台（AWS、Azure、GCP）及监控工具（Prometheus、Grafana）
• 安全合规：采用TLS 1.3加密传输，支持RBAC权限控制与操作审计日志

主要特性

• 轻量级设计：镜像体积<50MB，内存占用<100MB，启动时间<10秒
• 跨平台支持：兼容x86_64、ARM架构，支持Linux操作系统
• 灵活部署：支持Docker、Kubernetes、Docker Swarm等容器环境
• 低侵入性：通过只读挂载获取主机资源数据，不修改系统配置

使用场景

• 云基础设施监控：部署在云服务器实例中，监控虚拟机与容器集群资源使用情况
• 容器化应用管理：在Kubernetes集群中以DaemonSet形式部署，监控Pod与Node状态
• 运维自动化：自动响应系统异常（如高CPU使用率、磁盘空间不足），减少人工干预
• 混合云统一管理：在多云环境中实现跨平台资源监控与操作一致性
• 故障排查：实时采集日志与指标，结合诊断工具快速定位问题根源

使用方法

前提条件

• Docker Engine 19.03+ 或兼容容器运行时
• 网络连通性：允许访问Shoreline控制平面（默认端口443）
• 授权凭证：从Shoreline平台获取的API密钥

快速启动（Docker Run）

bash
docker run -d \
  --name shoreline-agent \
  --restart always \
  --net=host \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /proc:/host/proc:ro \
  -v /sys:/host/sys:ro \
  -e SHORELINE_API_KEY="your-api-key" \
  -e SHORELINE_CONTROL_PLANE="https://console.shoreline.io:443" \
  -e AGENT_LOG_LEVEL="info" \
  shoreline/agent:latest

参数说明

卷挂载

环境变量

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  shoreline-agent:
    image: shoreline/agent:latest
    container_name: shoreline-agent
    restart: always
    network_mode: host
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /proc:/host/proc:ro
      - /sys:/host/sys:ro
    environment:
      - SHORELINE_API_KEY=your-api-key
      - SHORELINE_CONTROL_PLANE=https://console.shoreline.io:443
      - AGENT_LOG_LEVEL=info
      - COLLECTION_INTERVAL=15

启动服务：

bash
docker-compose up -d

Kubernetes部署

推荐通过Helm Chart部署（官方Chart地址），或使用DaemonSet清单：

yaml
apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: shoreline-agent
  namespace: shoreline
spec:
  selector:
    matchLabels:
      app: shoreline-agent
  template:
    metadata:
      labels:
        app: shoreline-agent
    spec:
      hostNetwork: true
      volumes:
        - name: docker-sock
          hostPath: {path: /var/run/docker.sock}
        - name: host-proc
          hostPath: {path: /proc, readOnly: true}
        - name: host-sys
          hostPath: {path: /sys, readOnly: true}
      containers:
        - name: shoreline-agent
          image: shoreline/agent:latest
          volumeMounts:
            - name: docker-sock
              mountPath: /var/run/docker.sock
            - name: host-proc
              mountPath: /host/proc
              readOnly: true
            - name: host-sys
              mountPath: /host/sys
              readOnly: true
          env:
            - name: SHORELINE_API_KEY
              valueFrom: {secretKeyRef: {name: shoreline-secrets, key: api-key}}
            - name: SHORELINE_CONTROL_PLANE
              value: "https://console.shoreline.io:443"

验证与故障排查

基本检查

• 查看容器状态：docker ps | grep shoreline-agent
• 查看日志：docker logs shoreline-agent
• 验证连接：日志中出现Successfully connected to control plane表示连接正常

常见问题

• 认证失败：检查API密钥有效性，确认密钥未过期
• 资源采集异常：验证卷挂载路径是否正确，容器是否具备主机访问权限
• 网络问题：检查防火墙规则，确保允许出站连接到控制平面443端口

维护与更新

• 镜像标签：latest（最新稳定版）、vX.Y.Z（特定版本）
• 更新命令：

  bash
  docker pull shoreline/agent:latest
  docker restart shoreline-agent
  

• 资源需求：CPU≥0.1核，内存≥64MB，磁盘空间≥100MB

安全注意事项

• 以非root用户运行：docker run --user 1000:1000 ...
• 敏感信息管理：通过环境变量或密钥管理系统注入API密钥，避免硬编码
• 镜像验证：启用Docker Content Trust验证镜像签名

  bash
  export DOCKER_CONTENT_TRUST=1
  docker pull shoreline/agent:latest
  

支持与资源

• 官方文档：[***]
• 支持***：***
• GitHub仓库：https://github.com/shorelinesoftware/agent