From e45f22a50b25207959abf66af8bcc1b593f9d2fc Mon Sep 17 00:00:00 2001
From: zhanghan2021 <zhanghan@kylinos.cn>
Date: Tue, 12 Sep 2023 17:29:45 +0800
Subject: [PATCH] add readme doc

---
 README.md | 48 ++++++++++++++++++++++++++----------------------
 1 file changed, 26 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index a68f2e9..dcf20af 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,35 @@
 # PilotGo-plugin-prometheus
 
 #### 介绍
-PilotGo prometheus plugin provides cluster monitor and alert.
-
-#### 软件架构
-软件架构说明
-
-
-#### 安装教程
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
+PilotGo prometheus 插件提供了集群监控看板和告警功能。
 
 #### 使用说明
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### 参与贡献
-
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
-
+请确保使用prometheus插件之前已经正常运行pilotgo-server应用服务，若未安装，请通过链接 https://gitee.com/src-openeuler/PilotGo ，按照使用说明进行部署。  
+1.  安装prometheus插件
+```bash
+dnf install -y PilotGo-plugin-prometheus
+```
+2.  修改配置文件 
+```bash
+vim /opt/PilotGo/plugin/prometheus/server/config.yml  
+```
+plugin_prometheus: url地址ip为插件服务启动ip  
+prometheus_server: 安装prometheus的地址  
+http_server: 插件服务启动地址   
+pilotgo_server:  PilotGo server服务地址  
+mysql: host为安装DB的主机ip；user为DB的登录用户；password为DB访问密码  
+
+3.  启动服务  systemctl start PilotGo-plugin-prometheus  
+    停止服务  systemctl stop PilotGo-plugin-prometheus  
+    服务状态  systemctl status PilotGo-plugin-prometheus  
+
+4.  将prometheus插件服务注册到PilotGo平台
+    [插件管理] -> [添加插件] -> 插件名称：prometheus；插件地址：http://ip:端口（默认8090） -> [启用插件]  
+    启用成功，即可在PilotGo平台查看prometheus插件看板；若启动失败，通过 /opt/PilotGo/plugin/prometheus/server/log 查看插件报错原因。
+
+#### 源码仓库
+https://gitee.com/openeuler/PilotGo-plugin-prometheus
 
 #### 特技
 
-- 
Gitee