|
| 1 | +# Chaosblade-box-agnet: Chaos Experiment Agent |
| 2 | + |
| 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 | + |
0 commit comments