zededa/zcli

ZEDEDA Command Line Interface 镜像文档

镜像概述

ZEDEDA Command Line Interface (CLI) 镜像提供了与ZEDEDA边缘计算平台交互的命令行工具，旨在简化边缘设备管理、应用部署、资源监控和配置管理等操作。通过该镜像，用户可在命令行环境中高效管理边缘计算资源，无需图形界面即可完成复杂操作。

核心功能与特性

• 设备全生命周期管理：支持边缘设备注册、激活、状态查询、远程控制及固件更新
• 应用部署与管理：提供应用打包、部署至指定边缘设备、版本控制及卸载功能
• 实时监控与日志：获取设备性能指标（CPU/内存/网络）、应用运行状态及系统日志
• 配置管理：支持设备和应用配置文件的创建、更新、备份与恢复
• 安全认证集成：与ZEDEDA平台认证机制无缝对接，支持API令牌和OAuth2.0认证

使用场景

• 边缘运维人员：日常管理边缘设备集群，执行设备状态巡检、故障排查及批量操作
• 开发人员：测试边缘应用部署流程，验证应用在边缘环境中的运行效果
• 自动化流程集成：嵌入Shell/Python脚本，实现边缘资源管理的自动化（如定时备份配置、异常设备自动告警）

使用方法

前提条件

• 已注册ZEDEDA平台账号并获取API访问凭证（令牌或用户名/密码）
• 本地环境已安装Docker Engine（20.10+版本）

获取镜像

bash
docker pull docker.xuanyuan.run/zededa/cli:latest

初始化配置

首次使用需配置ZEDEDA平台连接信息，配置文件将保存在本地目录（建议持久化存储）：

bash
# 挂载本地目录存储配置文件，避免重复配置
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli configure

根据交互提示输入以下信息：

• ZEDEDA API端点URL（默认：[***]）
• 认证方式（API令牌或用户名/密码）
• 可选：设置默认设备组、输出格式（json/table）

常用命令示例

1. 设备管理

bash
# 列出所有边缘设备
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli device list

# 查看指定设备详情
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli device get <device-id>

# 远程重启设备
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli device reboot <device-id>

2. 应用部署

bash
# 部署应用至指定设备
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli app deploy \
  --device <device-id> \
  --app-name edge-iot-demo \
  --version 1.2.0 \
  --image registry.zededa.com/iot-demo:1.2.0

# 查看设备上运行的应用
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli app list --device <device-id>

3. 监控与日志

bash
# 获取设备CPU/内存使用率
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli metrics get <device-id> --metrics cpu,memory

# 查看应用运行日志（最近100行）
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli logs get <device-id> --app <app-name> --tail 100

环境变量配置

通过环境变量覆盖默认配置，适用于非交互式场景：

示例：使用环境变量直接执行命令（无需预配置）

bash
docker run --rm \
  -e ZEDEDA_API_URL=https://api.zededa.com \
  -e ZEDEDA_TOKEN=your-auth-token \
  -e OUTPUT_FORMAT=json \
  docker.xuanyuan.run/zededa/cli device list

持久化配置

为避免每次运行容器重新配置，建议通过挂载本地目录持久化配置文件：

bash
# 创建本地配置目录
mkdir -p ~/.zededa

# 后续所有命令均挂载该目录
docker run --rm -v ~/.zededa:/root/.zededa docker.xuanyuan.run/zededa/cli <command>