Tsuru 项目技术文档

1. 安装指南

获取 tsuru-client

请从以下链接下载与您的操作系统相匹配的最新版本：tsuru-client releases

以下是为 OS X 系统下载版本 1.1.1 的示例：

$ curl -sSL https://github.com/tsuru/tsuru-client/releases/download/1.1.1/tsuru-1.1.1-darwin_amd64.tar.gz | tar xz

安装说明

• Minikube
• GKE - Google Kubernetes Engine

2. 项目的使用说明

在 Kubernetes 集群上成功运行 tsuru 后，您可以通过调用 app list 命令来查看 tsuru 是否正常工作。此命令应返回一个名为 tsuru-dashboard 的应用。

$ tsuru app list

3. 项目API使用文档

Tsuru 提供了一个命令行工具，名为 tsuru，允许您与 Tsuru API 进行交互。在使用前，请确保已按照安装指南正确安装了 Tsuru Client。

以下是一些基本的命令示例：

• 列出应用：tsuru app list
• 登录：tsuru login [e-mail] # 密码：admin@123
• 列出集群：tsuru cluster list

4. 项目安装方式

本地开发环境

依赖项

在开始之前，请确保已安装以下工具：

• docker（或 podman）
• minikube
• go
• yq

您还需要安装 Tsuru Client 以与 Tsuru API 进行交互。如果尚未安装，请执行安装。

对于 macOS 用户：我们建议使用带有 socket_vmnet 的 qemu 驱动程序来运行 Minikube 集群。 有关安装 qemu 和 socket_vmnet 的更多信息，请参考以下链接：

• qemu
• socket_vmnet

注意：如果您使用的是 Docker 兼容的替代品，如 Podman，请在运行 make 命令时指定 DOCKER 变量与正确的二进制文件。例如：make local.run DOCKER=podman。

运行本地环境

要本地运行 Tsuru API，您需要先设置本地环境。这个设置过程非常重要，因为它会创建默认的配置文件，初始化所需的依赖项，并准备您的本地系统以托管 Tsuru API。以下命令将处理所有这些任务：

make local.setup

一旦设置完成，除非您想要重置环境，否则无需再次运行此命令。

初始设置完成后，您可以使用以下命令启动 Tsuru API 及其依赖项：

make local.run

Tsuru API 运行后，打开一个新的终端窗口并配置 Tsuru CLI，使其指向 local-dev 目标。此目标会告诉 CLI 与您的本地 Tsuru API 实例而不是远程服务器进行交互。您可以使用以下命令设置目标：

tsuru target-set local-dev

Tsuru 的目标与 Kubernetes 的 kubectl 配置上下文类似，允许您轻松地在不同环境之间切换。

要确认一切都设置正确，您可以登录并列出由您的 Tsuru API 实例管理的集群：

tsuru login [e-mail] # 密码: admin@123
tsuru cluster list

如果一切正常，您应该会看到本地 Minikube 集群被列为默认的提供程序。

清理

完成本地环境的操作后，停止服务以释放系统资源非常重要。您可以使用以下命令停止依赖项：

make local.stop

如果您想要完全重置环境，或者不再需要在您的计算机上运行 Tsuru API 及其依赖项，您可以使用以下命令删除所有相关资源：

make local.cleanup