tsuru/client

tsuru-client

镜像概述和主要用途

tsuru-client 是 https://github.com/tsuru/tsuru 平台的官方命令行客户端工具，专为应用开发者设计，用于与 tsuru 平台进行交互，实现应用全生命周期的管理。其核心用途是简化开发者在 tsuru 平台上的日常操作，包括应用创建、部署、扩展、配置管理及监控等。

核心功能和特性

核心功能

• 应用生命周期管理：支持创建、删除、部署、启动、停止应用等基础操作。
• 环境配置：管理应用环境变量、构建配置及运行时参数。
• 日志与监控：实时查看应用日志、监控应用运行状态。
• 资源扩展：调整应用实例数量（水平扩展）或资源配额（垂直扩展）。
• 平台交互：与 tsuru 平台服务（如数据库、缓存等）绑定和解绑。
• 认证与授权：支持用户认证、权限管理及多账户切换。

特性

• 轻量便携：基于 Docker 镜像分发，无需复杂依赖，可快速部署。
• 跨平台兼容：支持 Linux、macOS、Windows 等主流操作系统（通过 Docker 容器化运行）。
• 命令行自动化：支持脚本集成，便于 CI/CD 流程自动化。
• 配置持久化：支持通过环境变量或配置文件保存服务器连接信息及认证令牌。

使用场景和适用范围

适用范围

• 使用 tsuru 平台进行应用开发、部署和运维的开发者。
• 需要通过命令行工具自动化管理 tsuru 应用的团队。
• 集成 tsuru 平台到 CI/CD 流水线的场景。

典型使用场景

• 日常开发管理：本地开发环境中通过命令行创建、部署和测试应用。
• 多环境部署：在开发、测试、生产环境间切换，统一管理应用配置。
• 自动化运维：编写脚本实现应用版本回滚、定时扩缩容等操作。
• 团队协作：通过标准化命令行工具确保团队操作一致性。

详细使用方法和配置说明

前提条件

• 已安装 Docker 或 Docker Compose。
• 已获取 tsuru 平台服务器地址（如 https://tsuru.example.com）及有效认证令牌（Token）。

Docker 部署方案

docker run 命令示例

通过 Docker 容器运行 tsuru-client，直接执行命令：

bash
# 基础命令（查看版本）
docker run --rm tsuru/tsuru-client:latest tsuru version

# 带环境变量配置（指定 tsuru 服务器和认证令牌）
docker run --rm \
  -e TSURU_TARGET=https://tsuru.example.com \
  -e TSURU_TOKEN=your_auth_token \
  tsuru/tsuru-client:latest \
  tsuru app list

# 挂载本地配置文件（持久化配置）
docker run --rm \
  -v $HOME/.tsuru:/root/.tsuru \
  tsuru/tsuru-client:latest \
  tsuru app info -a my-app

docker-compose 配置示例

创建 docker-compose.yml 集成到项目中：

yaml
version: '3'
services:
  tsuru-client:
    image: tsuru/tsuru-client:latest
    environment:
      - TSURU_TARGET=https://tsuru.example.com
      - TSURU_TOKEN=${TSURU_TOKEN}  # 从宿主机环境变量读取令牌
    volumes:
      - ${HOME}/.tsuru:/root/.tsuru  # 挂载本地配置目录
    command: tsuru app list  # 默认执行的命令

启动容器：

bash
# 执行默认命令（app list）
docker-compose up

# 覆盖默认命令，执行自定义操作
docker-compose run --rm tsuru-client tsuru app deploy -a my-app ./dist

配置参数说明

环境变量

配置文件

配置文件为 JSON 格式，默认路径 ~/.tsuru/config，内容示例：

json
{
  "target": "https://tsuru.example.com",
  "token": "your_auth_token",
  "ssl-verify": true
}

通过 Docker 挂载本地配置文件可持久化配置，避免重复输入环境变量。

常用命令示例

以下为 tsuru-client 核心命令示例（需先配置 TSURU_TARGET 和 TSURU_TOKEN）：

bash
# 登录 tsuru 平台（若未设置 TSURU_TOKEN，可通过此命令获取）
docker run --rm -e TSURU_TARGET=https://tsuru.example.com tsuru/tsuru-client:latest tsuru login

# 创建应用
docker run --rm -v $HOME/.tsuru:/root/.tsuru tsuru/tsuru-client:latest tsuru app create my-app python

# 部署应用（从当前目录部署）
docker run --rm -v $HOME/.tsuru:/root/.tsuru -v $(pwd):/app tsuru/tsuru-client:latest tsuru app deploy -a my-app /app

# 查看应用日志
docker run --rm -v $HOME/.tsuru:/root/.tsuru tsuru/tsuru-client:latest tsuru app logs -a my-app

# 扩展应用实例数量
docker run --rm -v $HOME/.tsuru:/root/.tsuru tsuru-client:latest tsuru app scale -a my-app 3

# 删除应用
docker run --rm -v $HOME/.tsuru:/root/.tsuru tsuru-client:latest tsuru app delete -a my-app -y

问题反馈

若使用中遇到问题，请通过 https://github.com/tsuru/tsuru-client/issues 提交 issue。

相关链接

• tsuru 官方文档
• https://github.com/tsuru/tsuru
• https://hub.docker.com/r/tsuru/tsuru-client