envoyproxy/ai-gateway-cli

Envoy AI Gateway CLI 镜像文档

镜像概述和主要用途

该镜像提供Envoy AI网关的官方命令行界面（CLI）工具，旨在为开发和运维人员提供便捷的命令行操作方式，用于管理、配置、监控和维护Envoy AI网关服务。通过容器化部署，确保工具运行环境一致性，简化安装和使用流程。

核心功能和特性

• 配置管理：支持创建、查询、修改和删除Envoy AI网关的服务配置
• 状态监控：实时查看网关服务运行状态、性能指标及连接数等关键数据
• 日志管理：获取、过滤和导出网关服务日志，支持按时间范围、级别筛选
• 版本控制：管理网关服务版本，支持版本切换和升级操作
• 命令自动补全：提供命令行自动补全功能，提升操作效率
• 跨平台兼容：通过Docker容器化，支持Linux、macOS和Windows等主流操作系统

使用场景和适用范围

• 开发环境：开发人员本地调试Envoy AI网关配置，验证功能正确性
• 生产环境：运维人员监控网关运行状态，调整配置参数以优化性能
• 自动化集成：与CI/CD管道结合，实现网关配置的自动化部署和更新
• 教学研究：快速上手Envoy AI网关功能，学习网关配置和管理方法

使用方法和配置说明

基本使用示例

通过Docker运行CLI工具的基本命令格式：

bash
docker run --rm docker.xuanyuan.run/envoyai/gateway-cli:latest [command] [options]

常用命令示例

• 查看网关状态：

  bash
  docker run --rm docker.xuanyuan.run/envoyai/gateway-cli:latest status
  

• 列出所有配置：

  bash
  docker run --rm docker.xuanyuan.run/envoyai/gateway-cli:latest config list
  

• 获取指定配置详情：

  bash
  docker run --rm docker.xuanyuan.run/envoyai/gateway-cli:latest config get gateway-default
  

• 查看最近100行日志：

  bash
  docker run --rm docker.xuanyuan.run/envoyai/gateway-cli:latest logs --tail=100
  

环境变量配置

通过环境变量自定义工具行为，常用变量如下：

持久化配置示例

挂载本地目录保存配置文件，实现配置持久化：

bash
docker run --rm \
  -v $(pwd)/gateway-config:/app/config \
  -e GATEWAY_ENDPOINT="http://prod-gateway:8080" \
  -e AUTH_TOKEN="your-secure-token" \
  docker.xuanyuan.run/envoyai/gateway-cli:latest config set gateway-default max_connections=1000

命令行参数说明

与网关服务联动

若网关服务也通过Docker部署，可通过容器网络实现CLI与网关的通信：

bash
# 创建专用网络
docker network create envoy-gateway-net

# 启动网关服务（示例）
docker run -d --name envoy-gateway --network envoy-gateway-net docker.xuanyuan.run/envoyai/gateway:latest

# 通过CLI连接网关
docker run --rm --network envoy-gateway-net \
  -e GATEWAY_ENDPOINT="[***]" \
  envoyai/gateway-cli:latest status