diff --git a/README.en.md b/README.en.md index 11ae681c250976a5522994312f753a3ccb694531..f63977a6fbf1df1ef3b37c04e52037d51fff622b 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,104 @@ # PilotGo -#### Description -PilotGo is a plugable operation platform written in go. +#### introduce -#### Software Architecture -Software architecture description +PilotGo is an O&M management platform natively incubated by the openEuler community, which adopts a plug-in architecture design, lightweight combination of functional modules, independent iterative evolution, and ensures the stability of core functions. At the same time, plug-ins are used to enhance the platform functions and break down the barriers between different O&M components, so as to achieve global state awareness and automated processes. -#### Installation +#### Feature description -1. xxxx -2. xxxx -3. xxxx +The core functional modules of PilotGo include: -#### Instructions +- User management: support group management according to the organizational structure, support the import of existing platform accounts, and facilitate migration; +- Permission management: Supports RBAC-based permission management, which is flexible and reliable. +- Host management: status front-end visualization, direct execution of software package management, service management, kernel parameter tuning, simple and easy operation; +- Batch management: supports concurrent execution of O&M operations, which is stable and efficient. +- Log audit: Track and record the change operations of users and plug-ins, which is convenient for problem tracing and security audit. +- Alarm management: real-time perception of platform abnormalities; +- Plug-in function: support to expand platform functions, plug-in linkage, multiply automation capabilities, and reduce manual intervention. -1. xxxx -2. xxxx -3. xxxx +![Alt text](https://gitee.com/c2x9/PilotGo/raw/master/docs/images/functional%20modules.png) -#### Contribution +The current OS release also integrates the following plugins: -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request +- Prometheus: Hosts the Prometheus monitoring component, automatically delivers and configures node-exporter monitoring data collection, and interconnects with the platform alarm function. ![Alt text](https://gitee.com/c2x9/PilotGo/raw/master/docs/images/prometheus%20plugin.png) +- Grafana: Integrates with the Grafana visualization platform to provide beautiful and easy-to-use metric monitoring panels. ![Alt text](https://gitee.com/c2x9/PilotGo/raw/master/docs/images/grafana%20plugin.png) +#### Application scenarios -#### Gitee Feature +PilotGo can be used in typical server cluster management scenarios, supporting basic management and monitoring of large batches of server clusters. By integrating the corresponding business function plug-ins, you can also realize the unified platform management of business clusters, such as MySQL database clusters, Redis data cache clusters, and nginx gateway clusters. -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +#### Installation and startup tutorials + +PilotGo can be deployed as a stand-alone machine or as a cluster. Turn off the firewall before installation. + +1. Install MySQL and Redis, and set a password. +2. Install PilotGo-server and modify the configuration file: + +> dnf install -y PilotGo-server + +> vim /opt/PilotGo/server/config_server.yaml + +http_server: addr is the address where PilotGo-server is installed; + +socket_server: addr is the address where PilotGo-server is installed; + +mysql: host_name is the address where mysql is installed. user_name is a logged-in user of the DB. password is the DB access password. + +Redis: redis_conn is the address where Redis is installed. redis_pwd is a Redis password; + +Start the service + +> systemctl start PilotGo-server + +Discontinuation of service + +> ystemctl stop PilotGo-server + +Service status + +> systemctl status PilotGo-server + +3. Install PilotGo-agent: + +> dnf install -y PilotGo-agent + +> vim /opt/PilotGo/agent/config_agent.yaml + +server:addr is the address where the PilotGo-server is installed. + +Start the service + +> systemctl start PilotGo-agent + +Discontinuation of service + +> systemctl stop PilotGo-agent + +Service status + +> systemctl status PilotGo-agent + +4. Plugin installation: PilotGo-plugin-grafana plugin installation + PilotGo-plugin-prometheus PilotGo-plugin-a-tune PilotGo-plugin-topology Plugin Installation + +#### Supplemental Links + +1. [PilotGo User Manual](https://gitee.com/openeuler/docs/tree/master/docs/zh/docs/PilotGo/使用手册.md) +2. PilotGo package repository +3. The PliotGo community develops WeChat groups + +#### Get involved + +1. Fork this repository +2. Create a new Feat_xxx branch +3. Submit the code +4. Create a new pull request + +#### stunt + +1. Use Readme_XXX.md to support different languages, such as Readme_en.md, Readme_zh.md +2. Gitee Official Blog blog.gitee.com +3. You can https://gitee.com/explore this address to learn about the best open source projects on Gitee +4. GVP stands for Gitee's Most Valuable Open Source Project, and it is an excellent open source project that has been comprehensively evaluated +5. The official Gitee user manual https://gitee.com/help +6. The Gitee Cover Character is a section that showcases Gitee members https://gitee.com/gitee-stars/