Merge branch 'main' of https://github.com/starsliao/ConsulManager into main

2022-06-16 02:06:02 +08:00 · 2022-06-16 02:06:02 +08:00 · 45b52a56a0
parent 609feb2770 0f21e1eebd
commit 45b52a56a0
4 changed files with 72 additions and 84 deletions
--- a/README.md
+++ b/README.md
@ -1,130 +1,76 @@
 # 🚀概述
- **ConsulManager**是一个使用Flask+Vue开发的Consul WEB管理工具，弥补了官方UI对Services管理的不足，可以方便的对Consul Services进行增删改查，支持批量操作；并优化了对Tags、Meta、健康检查的配置管理与查询展示。
- 本工具基于Prometheus自动发现Consul，实现了两个监控管理维护的应用：
-  1. 基于云厂商ECS的自动同步到Consul，并接入Prometheus监控。（设计了一个关联的Grafana看板）
+- **ConsulManager**是一个使用Flask+Vue开发的Consul WEB运维助手，弥补了官方UI对Services管理的不足，优化了Consul对Services的配置管理与查询展示。
+- 本工具基于Prometheus自动发现Consul，还实现了几个监控管理的功能：
+  1. 支持云厂商ECS与分组自动同步到Consul，并接入Prometheus监控。（设计了一个关联的Grafana看板）
  2. 基于Blackbox实现站点与接口监控接入Consul，通过Web界面方便管理。（设计了一个关联的Grafana看板）
- 本工具支持使用docker-compose快速部署。
+  3. 高危漏洞采集与实时告警通知。

 ## 💎实现功能
 ### 🏆Consul 管理
- 比官方自带的WEB UI实现了更多的功能。
- 包含Consul服务器的状态信息。
 - 支持Consul Services的增删改查，可以批量删除Service。
 - 直观的查看每个Services实例的信息，及整体Services的健康状态。
- 可以方便的对每个Services实例的Tags、Meta、健康检查进行配置。
+- 可以便捷的对Services实例的Tags、Meta、健康检查配置管理与查询展示。

 ### 🏆Node 主机监控
 - 基于Consul实现Prometheus监控目标的自动发现。
- 支持同步阿里云，腾讯云，华为云的ECS主机信息到Consul。
- 支持同步各云厂商的分组信息到Consul，用于关联ECS分组。
+- 支持同步阿里云、腾讯云、华为云的ECS主机与分组信息到Consul。
 - 支持自建主机接入监控管理，并提供脚本批量导入主机到Consul。
 - 提供了可查询分组与ECS信息的页面，指标中加入了ECS到期日等信息，可直接监控。
- 提供了按需的Prometheus配置生成功能。
+- 提供了按需生成Prometheus配置与告警规则的功能。
 - 提供了一个匹配ECS Manager各字段的node_exporter Grafana展示看板。

 ### 🏆Blackbox 站点监控
 - 基于Prometheus + Blackbox_Exporter实现站点与接口监控。
 - 基于Consul实现Prometheus监控目标的自动发现。
 - 使用Web操作即可简单的对监控目标增删改查，支持批量删除，以及方便的分类维护管理。
+- 提供脚本可批量导入监控目标到Consul。
 - 提供了Blackbox的配置，Prometheus的配置以及Prometheus站点监控的告警规则。
 - 提供了一个匹配Blackbox Manager各字段的Blackbox Exporter Grafana展示看板。
- 提供脚本可批量导入监控目标到Consul。

-### 🏆高危漏洞采集与通知
- 增加了高危风险漏洞采集与告警通知功能。
+### 🏆高危漏洞采集与实时告警
+- 增加了高危风险漏洞采集与实时告警通知功能。
 - 功能开启即可采集最新30个漏洞列表。
 - 每小时采集一次，发现新漏洞立即推送到群机器人。
- 支持企业微信与钉钉群机器人通知。
+- 支持企微、钉钉、飞书群机器人通知。

 ## [更新记录](https://github.com/starsliao/ConsulManager/releases)

 ## 🎨部分截图（[点击查看完整截图](https://github.com/starsliao/ConsulManager/tree/main/screenshot#%E6%88%AA%E5%9B%BE)）
 ### Consul Web Manager 界面
-![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/screenshot/consul1.PNG)
 ![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/screenshot/consul3.PNG)
 ### ECS Manager 界面
 ![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/screenshot/ecs1.PNG)
-### Blackbox Manager 界面
-![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/screenshot/blackbox1.PNG)
-### 高危漏洞采集与通知 界面
-![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/screenshot/bug.png)
-##### 通知界面
-![图片](https://user-images.githubusercontent.com/3349611/173263960-4d69fff9-82fe-42a1-ba18-4c78775cf35e.png)
-
 ### Node Exporter Dashboard 截图
 ![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/vue-consul/public/node1.png)
 ![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/vue-consul/public/node2.png)
+### Blackbox Manager 界面
+![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/screenshot/blackbox1.PNG)
 ### Blackbox Exporter Dashboard 截图
 ![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/vue-consul/public/blackbox.png)
+### 高危漏洞采集与通知 界面
+![](https://raw.githubusercontent.com/starsliao/ConsulManager/main/screenshot/bug.png)
+##### 钉钉告警通知
+![图片](https://user-images.githubusercontent.com/3349611/173263960-4d69fff9-82fe-42a1-ba18-4c78775cf35e.png)

 ## 💾部署说明
-
-### 1. 部署Consul
-
-##### 安装
-
-```bash
-# 使用yum部署consul
-yum install -y yum-utils
-yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo
-yum -y install consul
-# 或者直接下RPM包安装
-wget https://rpm.releases.hashicorp.com/RHEL/7/x86_64/stable/consul-1.12.2-1.x86_64.rpm
-rpm -ivh ./consul-1.12.2-1.x86_64.rpm
-```
-
-##### 配置
-
-```bash
-vi /etc/consul.d/consul.hcl
-advertise_addr = "192.168.x.x" #可以先不加这行，如果启动有问题再加上，一般有多网卡需要配置这行，填写你的网卡IP
-data_dir = "/opt/consul"
-client_addr = "0.0.0.0"
-ui_config{
-  enabled = true
-}
-server = true
-bootstrap = true
-acl = {
-  enabled = true
-  default_policy = "deny"
-  enable_token_persistence = true
-}
-```
-
-##### 启动与鉴权配置
-
-```bash
-chown -R consul:consul /opt/consul  #注意下数据目录的权限。
-systemctl enable consul.service
-systemctl start consul.service
-# 获取登录密码
-consul acl bootstrap
-
-# 记录 SecretID，即为Consul登录的Token
-```
-
-### 2. 部署Consul Manager
-
-##### 使用docker-compose来部署
+##### Consul Manager需要依赖`Consul`，请先完成Consul的部署。（[Consul部署文档](docs/Consul部署说明.md)）
+##### 使用`docker-compose`来部署Consul Manager
 - 下载：`wget https://raw.githubusercontent.com/starsliao/ConsulManager/main/docker-compose.yml`
 - 国内下载：`wget https://starsl.cn/static/img/docker-compose.yml`
 - 编辑：`docker-compose.yml`，修改3个环境变量：
-  - consul的token：**`consul_token`**
-  - consul的URL(/v1要保留)：**`consul_url`**
-  - 登录Consul Manager的密码：**`admin_passwd`**
+  - **`consul_token`**：consul的登录token
+  - **`consul_url`**：consul的URL(http开头，/v1要保留)
+  - **`admin_passwd`**：登录Consul Manager的admin密码
 - 启动：`docker-compose pull && docker-compose up -d`
- 访问：`http://{IP}:1026`
+- 访问：`http://{IP}:1026`，使用配置的Consul Manager密码登录
 ---
-## [项目GitHub仓库](https://github.com/starsliao/ConsulManager)
+## [ConsulManager实践与FAQ](https://github.com/starsliao/ConsulManager/docs)
 ## [应用场景1：如何优雅的基于Consul自动同步ECS主机监控](https://github.com/starsliao/ConsulManager/blob/main/docs/ECS%E4%B8%BB%E6%9C%BA%E7%9B%91%E6%8E%A7.md)
 ## [应用场景2：如何优雅的使用Consul管理Blackbox站点监控](https://github.com/starsliao/ConsulManager/blob/main/docs/blackbox%E7%AB%99%E7%82%B9%E7%9B%91%E6%8E%A7.md)

-### 💯开发线路
-![图片](https://github.com/starsliao/ConsulManager/blob/main/Roadmap.png)

-# 💖特别鸣谢
-## 赞赏与关注公众号【**云原生DevOps**】加入交流群（注明consul），获取更多...
+## 💖特别鸣谢
+### 赞赏与关注公众号【**云原生DevOps**】加入交流群（注明consul），获取更多...
 ![](https://starsl.cn/static/img/thanks.png)

 ---
--- a/docs/Consul部署说明.md
+++ b/docs/Consul部署说明.md
@ -0,0 +1,42 @@
+##### 安装
+
+```bash
+# 使用yum部署consul
+yum install -y yum-utils
+yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo
+yum -y install consul
+# 或者直接下RPM包安装
+wget https://rpm.releases.hashicorp.com/RHEL/7/x86_64/stable/consul-1.12.2-1.x86_64.rpm
+rpm -ivh ./consul-1.12.2-1.x86_64.rpm
+```
+
+##### 配置
+
+```bash
+vi /etc/consul.d/consul.hcl
+advertise_addr = "192.168.x.x" #可以先不加这行，如果启动有问题再加上，一般有多网卡需要配置这行，填写你的网卡IP
+data_dir = "/opt/consul"
+client_addr = "0.0.0.0"
+ui_config{
+  enabled = true
+}
+server = true
+bootstrap = true
+acl = {
+  enabled = true
+  default_policy = "deny"
+  enable_token_persistence = true
+}
+```
+
+##### 启动与鉴权配置
+
+```bash
+chown -R consul:consul /opt/consul  #注意下数据目录的权限。
+systemctl enable consul.service
+systemctl start consul.service
+# 获取登录密码
+consul acl bootstrap
+
+# 记录 SecretID，即为Consul登录的Token
+```
--- a/docs/ECS主机监控.md
+++ b/docs/ECS主机监控.md
@ -32,11 +32,11 @@

 ### 批量导入自建主机脚本

-在units目录下`selfnode-instance.list`中写入监控目标的信息：机房/公司 租户/部门 区域/项目 分组/环境 名称 实例(ip:端口) 系统(linux/windows)，每行一个，空格分隔。
+在项目仓库根目录的`units`目录下：编辑`selfnode-instance.list`，写入监控目标的信息：机房/公司 租户/部门 区域/项目 分组/环境 名称 实例(ip:端口) 系统(linux/windows)，每行一个，空格分隔。

 **注意：前5个字段组合起来必须唯一，作为一个监控项的ID。即Consul的ServiceID**

-修改units目录下导入脚本中的consul_token和consul_url，保存后执行selfnode-input.py，即可导入所有监控目标到Consul，并符合Prometheus的自动发现配置。
+再修改导入脚本`selfnode-input.py`中的consul_token和consul_url，保存后执行`selfnode-input.py`，即可导入所有监控目标到Consul，并符合Prometheus的自动发现配置。

 ### 注意：

--- a/docs/blackbox站点监控.md
+++ b/docs/blackbox站点监控.md
@ -34,8 +34,8 @@

 #### 批量导入脚本

-在units目录下`blackbox-instance.list`中写入监控目标的信息：监控类型，公司/部门，项目，环境，名称，实例url，每行一个，空格分隔。
+在项目仓库根目录的`units`目录下：编辑`blackbox-instance.list`，写入监控目标的信息：监控类型，公司/部门，项目，环境，名称，实例url，每行一个，空格分隔。

 **注意：前5个字段组合起来必须唯一，作为一个监控项的ID。即Consul的ServiceID**

-修改units目录下导入脚本中的consul_token和consul_url，保存后执行blackbox-input.py，即可导入所有监控目标到Consul，并符合Prometheus的自动发现配置。
+再修改导入脚本`blackbox-input.py`中的consul_token和consul_url，保存后执行`blackbox-input.py`，即可导入所有监控目标到Consul，并符合Prometheus的自动发现配置。