# tone-agent

**Repository Path**: anolis/tone-agent

## Basic Information

- **Project Name**: tone-agent
- **Description**: ToneAgent 是 T-One 运行用例的物理机器代理
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 41
- **Forks**: 14
- **Created**: 2021-11-11
- **Last Updated**: 2025-04-29

## Categories & Tags

**Categories**: containers

**Tags**: None

## README

# ToneAgent

[![](https://img.shields.io/badge/made%20by-openanolis-blue.svg?style=flat-square)](https://openanolis.cn/)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

> ToneAgent 是 T-One 运行用例的物理机器代理

ToneAgent 实现了多台机器和 T-One 之间的通讯, 保证 T-One 中用例的分布式执行, 提高执行效率。

通过 ToneAgent, T-One 可以向多台物理机/虚拟机分配待执行状态的用例。当用例完成后, T-One 会将不同机器的执行结果进行汇总, 并将结果展示在 T-One 平台上。

## 安装说明

### 前置条件

[Go版本不低于1.15](https://go.dev/dl/)

### 安装

- 克隆当前仓库
```shell script
git clone git@gitee.com:anolis/tone-agent.git
```

- 编译ToneAgent二进制

```shell script
cd tone-agent
go build 
# or
go install ./...
```

> 如果你是用的是unix类的机器,可以直接执行当前目录的脚本`start.sh`

```shell script
chmod +x start.sh
./start.sh
```

## 使用说明

### 配置文件

执行 `ToneAgent` 依赖配置文件 `config.yaml`。

> `ToneAgent` 二进制会默认在 *当前目录 `.`* 和 *用户目录 `$HOME/toneagent`* 查找 配置文件 `config.yaml`

`config.yaml` 样例:

```yaml
beego:  # beego相关配置文件
  AppName: toneagent
  RunMode: dev
  StaticDir: down1
  DirectoryIndex: true
  HttpAddr: 0.0.0.0
  CopyRequestBody: true
  HttpPort: 8479

result: # ToneAgent相关结果文件目录, 默认放在当前目录下
  ResultFileDir: results
  WaitingSyncResultDir: sync_results
  TmpScriptFileDir: scripts
  LogFileDir: logs
  LogFileName: toneagent.log

mode: active # ToneAgent模式
tsn: tone20210101-001 # ToneAgent标识
proxy: https://tone-agent.openanolis.cn # T-One代理地址
```

> 可以通过 `export TONE_AGENT_PATH = $PATH` 来修改 `ToneAgent` 的结果文件地址


### 主动模式

**场景**  

> 适用于部署 `Agent` 的机器位于 `NAT` 之后,无法通过公网 `IP` 直接进行访问

通过在 `config.yaml` 中配置`T-One`的代理设置, 让部署 `ToneAgent` 的相关机器主动连接 `T-One`代理, 从而让相关机器能 `PULL` 任务、`PUSH` 任务和执行任务。

`T-One` 代理设置: `proxy: https://tone-agent.openanolis.cn`

### 被动模式

**场景**

> 适用于 `T-One` 代理位于 `NAT` 之后, 无法通过公网 `IP` 直接进行访问

`T-One`的代理端会向部署 `ToneAgent` 的相关机器推送任务, 从而让相关机器能执行任务。



## 贡献

欢迎加入。
 
创建一个[issue](https://gitee.com/anolis/tone-agent/issues)!

## License

Mulan