Skip to content

Commit f2b64dd

Browse files
YuaningaMandssS
authored andcommitted
feat: add introduce agent
Signed-off-by: Yuaninga <1846225041@qq.com>
1 parent ccadd4b commit f2b64dd

2 files changed

Lines changed: 100 additions & 0 deletions

File tree

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Chaosblade-box-agnet: Chaos Experiment Agent
2+
![license](https://img.shields.io/github/license/chaosblade-io/chaosblade.svg)
3+
4+
中文版 [README](README_CN.md)
5+
6+
## Introduction
7+
The Agent are mainly used for platform-side establishment, command delivery channels, and data collection functions. Therefore, if you need to perform drills on target clusters or hosts, you need to install probes on the target clusters or hosts on the end-side to organize the platform. The drill is converted into commands and sent to the target machine
8+
9+
## How to use
10+
This project can be compiled and used separately, but it is more recommended to use [chaosblade-box-agent](https://github.com/chaosblade-io/chaosblade-box-agent) tool to use. For detailed English documentation, please refer to: https://chaosblade.io/en/docs/getting-started/installation-and-deployment/agent-install/
11+
12+
## Compile
13+
This project is written in golang, so you need to install the latest golang version first. The minimum supported version is 1.11. After the Clone project, enter the project directory and execute the following command to compile:
14+
```shell script
15+
make
16+
```
17+
If on a mac system, compile the current system version, execute:
18+
```shell script
19+
make build_darwin
20+
```
21+
If you want to compile linux system version on mac system, execute:
22+
```shell script
23+
make build_linux
24+
```
25+
You can also only clone [chaosblade-box-agent](https://github.com/chaosblade-io/chaosblade-box-agent) project, execute `make` or` make build_linux` in the project directory to compile it uniformly.
26+
27+
Steps to install agent:
28+
```bash
29+
./chaosctl.sh install -k 015667e5361b4b0c9d42e1c10afe1d61 -p [app-name] -g [app-group-name] -P [agent-port] -t [chaosblade-box ip]
30+
```
31+
32+
Installation example:
33+
```bash
34+
./chaosctl.sh install -k 015667e5361b4b0c9d42e1c10afe1d61 -p chaos-default-app -g chaos-default-app-group -P 19527 -t 127.0.0.1
35+
```
36+
37+
## Bugs and Feedback
38+
For bug report, questions and discussions please submit [GitHub Issues](https://github.com/chaosblade-io/chaosblade/issues).
39+
40+
You can also contact us via:
41+
* Dingding group (recommended for chinese): 23177705
42+
* Gitter room: [chaosblade community] (https://gitter.im/chaosblade-io/community)
43+
* Email: chaosblade.io.01@gmail.com
44+
* Twitter: [chaosblade.io] (https://twitter.com/ChaosbladeI)
45+
46+
## Contributing
47+
We welcome every contribution, even if it is just punctuation. See details of [CONTRIBUTING](CONTRIBUTING.md)
48+
49+
## License
50+
The chaosblade-exec-os is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.
51+

README_CN.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Chaosblade-exec-os: 基础资源混沌实验场景执行器
2+
![license](https://img.shields.io/github/license/chaosblade-io/chaosblade.svg)
3+
4+
## 介绍
5+
探针(Agent)主要作为平台端建联、命令下发通道和数据收集等功能,所以如果需要对目标集群或主机进行演练,需要在端侧的目标集群或主机上安装探针,以便将平台编排好的演练转化成命令,下发到目标机器上
6+
7+
## 使用
8+
此项目可以单独编译后使用,但更建议通过 [chaosblade-box-agent](https://github.com/chaosblade-io/chaosblade-box-agent) 安装使用。详细的中文使用文档请参考:https://chaosblade.io/docs/getting-started/installation-and-deployment/agent-install
9+
10+
## 编译
11+
此项目采用 golang 语言编写,所以需要先安装最新的 golang 版本,最低支持的版本是 1.11。Clone 工程后进入项目目录执行以下命令进行编译:
12+
```shell script
13+
make
14+
```
15+
如果在 mac 系统上,编译当前系统的版本,请执行:
16+
```shell script
17+
make build_darwin
18+
```
19+
如果想在 mac 系统上,编译 linux 系统版本,请执行:
20+
```shell script
21+
make build_linux
22+
```
23+
你也可以只 clone [chaosblade-box-agent](https://github.com/chaosblade-io/chaosblade-box-agent) 项目,在项目目录下执行 `make``make build_linux` 来统一编译。
24+
25+
安装agent的步骤:
26+
```bash
27+
./chaosctl.sh install -k 015667e5361b4b0c9d42e1c10afe1d61 -p [应用名] -g [应用分组] -P [agent端口号] -t [chaosblade-box ip:port]
28+
```
29+
30+
安装示例:
31+
```bash
32+
./chaosctl.sh install -k 0813d72a71ba41ed986e507e2e0ead1b -p chaos-default-app -g chaos-default-app-group -P 19527 -t 127.0.0.1
33+
```
34+
35+
## 缺陷&建议
36+
欢迎提交缺陷、问题、建议和新功能,所有项目(包含其他项目)的问题都可以提交到[Github Issues](https://github.com/chaosblade-io/chaosblade/issues)
37+
38+
你也可以通过以下方式联系我们:
39+
* 钉钉群(推荐):23177705
40+
* Gitter room: [chaosblade community](https://gitter.im/chaosblade-io/community)
41+
* 邮箱:chaosblade.io.01@gmail.com
42+
* Twitter: [chaosblade.io](https://twitter.com/ChaosbladeI)
43+
44+
## 参与贡献
45+
我们非常欢迎每个 Issue 和 PR,即使一个标点符号,如何参加贡献请阅读 [CONTRIBUTING](CONTRIBUTING.md) 文档,或者通过上述的方式联系我们。
46+
47+
## 开源许可证
48+
Chaosblade-exec-os 遵循 Apache 2.0 许可证,详细内容请阅读 [LICENSE](LICENSE)
49+

0 commit comments

Comments
 (0)