From c798437c645ae112df0d1512aa2efb1c007888bd Mon Sep 17 00:00:00 2001 From: Gzx1999 Date: Thu, 23 Feb 2023 23:18:11 +0800 Subject: [PATCH] update readme --- README.md | 26 ++++++++++++-------------- grafana/README.md | 1 + nginx/README.md | 1 + prometheus/README.md | 1 + sdk/README.md | 2 ++ 5 files changed, 17 insertions(+), 14 deletions(-) create mode 100644 grafana/README.md create mode 100644 nginx/README.md create mode 100644 prometheus/README.md create mode 100644 sdk/README.md diff --git a/README.md b/README.md index d1918c7f..90c018a6 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,25 @@ # PilotGo-plugins #### 介绍 -PilotGo-plugins contains plugins for PilotGo. +PilotGo-plugins包含一组PilotGo运维管理平台项目的插件组件。 -#### 软件架构 -软件架构说明 +#### 插件架构 +PilotGo插件系统为微服务架构，插件组件通过http接口与PilotGo主服务进行对接。 -#### 安装教程 - -1. 执行npm run build对前端进行打包 -2. 执行go build -o redisMonitor生成redisMonitor -3. 将redisMonitor移动到PilotGo的plugins插件目录下 +#### 参与贡献 -#### 使用说明 +环境要求： -1. xxxx -2. xxxx -3. xxxx + - golang >= 1.18 + - nodejs >= 18 -#### 参与贡献 +项目说明： -golang >= 1.18 + - grafana：为PilotGo提供grafana可视化系统的支持 + - nginx：为PilotGo提供nginx集群配置及管理功能的支持 + - prometheus：为PilotGo提供prometheus监控基础组件的支持 + - sdk：提供插件开发的golang sdk #### 特技 diff --git a/grafana/README.md b/grafana/README.md new file mode 100644 index 00000000..c363d7f8 --- /dev/null +++ b/grafana/README.md @@ -0,0 +1 @@ +# PilotGo grafana 插件 \ No newline at end of file diff --git a/nginx/README.md b/nginx/README.md new file mode 100644 index 00000000..7581a56d --- /dev/null +++ b/nginx/README.md @@ -0,0 +1 @@ +# PilotGo nginx 插件 \ No newline at end of file diff --git a/prometheus/README.md b/prometheus/README.md new file mode 100644 index 00000000..7b8cba78 --- /dev/null +++ b/prometheus/README.md @@ -0,0 +1 @@ +# PilotGo prometheus 插件 \ No newline at end of file diff --git a/sdk/README.md b/sdk/README.md new file mode 100644 index 00000000..c742bcf3 --- /dev/null +++ b/sdk/README.md @@ -0,0 +1,2 @@ +# PilotGo Plugin SDK + -- Gitee