文档更新

README.md

@@ -37,9 +37,9 @@
 
 ## 相关文档
 
-- [kafka-manager安装手册](./docs/install_cn_guide.md)
-- [kafka-manager接入集群](./docs/manual_kafka_op/add_cluster.md)
-- [kafka-manager使用手册-待更新](./docs/user_cn_guide.md)
+- [kafka-manager 安装手册](docs/install_guide/install_guide_cn.md)
+- [kafka-manager 接入集群](docs/user_guide/add_cluster/add_cluster.md)
+- [kafka-manager 用户使用手册](docs/user_guide/user_guide_cn.md)
 
 
 ## 钉钉交流群

docs/create_mysql_table.sql → docs/install_guide/create_mysql_table.sql

@@ -204,6 +204,11 @@ CREATE TABLE `gateway_config` (
   PRIMARY KEY (`id`),
   UNIQUE KEY `uniq_type_name` (`type`,`name`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='gateway配置';
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_QUEUE_SIZE', 'SERVICE_DISCOVERY_QUEUE_SIZE', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_APPID_RATE', 'SERVICE_DISCOVERY_APPID_RATE', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_IP_RATE', 'SERVICE_DISCOVERY_IP_RATE', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_SP_RATE', 'app_01234567', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_SP_RATE', '192.168.0.1', 100000000, 1);
 
 --
 -- Table structure for table `heartbeat`

docs/install_cn_guide.md → docs/install_guide/install_guide_cn.md

 
 ---
 
-![kafka-manager-logo](./assets/images/common/logo_name.png)
+![kafka-manager-logo](../assets/images/common/logo_name.png)
 
 **一站式`Apache Kafka`集群指标监控与运维管控平台**
 
@@ -12,16 +12,16 @@
 
 ## 环境依赖
 
-- `Maven 3.2+`(后端打包依赖)
+- `Maven 3.5+`(后端打包依赖)
 - `node 10+`(前端打包依赖)
 - `Java 8+`(运行环境需要)
-- `MySQL`(数据存储)
+- `MySQL 5.7`(数据存储)
 
 ---
 
 ## 环境初始化
 
-执行[create_mysql_table.sql](./create_mysql_table.sql)中的SQL命令，从而创建所需的MySQL库及表，默认创建的库名是`kafka_manager`。
+执行[create_mysql_table.sql](create_mysql_table.sql)中的SQL命令，从而创建所需的MySQL库及表，默认创建的库名是`kafka_manager`。
 
 ```
 # 示例：
@@ -47,12 +47,12 @@ mvn install
 ```
 # application.yml 是配置文件
 
-cp web/src/main/resources/application.yml web/target/
-cd web/target/
+cp kafka-manager-web/src/main/resources/application.yml kafka-manager-web/target/
+cd kafka-manager-web/target/
 nohup java -jar kafka-manager-web-2.0.0-SNAPSHOT.jar --spring.config.location=./application.yml > /dev/null 2>&1 &
 ```
 
 ## 使用
 
-本地启动的话，访问`http://localhost:8080`，输入帐号及密码进行登录。更多参考：[kafka-manager使用手册](./user_cn_guide.md)
+本地启动的话，访问`http://localhost:8080`，输入帐号及密码(默认`admin/admin`)进行登录。更多参考：[kafka-manager 用户使用手册](../user_guide/user_guide_cn.md)
 

docs/user_cn_guide.md

-
----
-
-![kafka-manger-logo](./assets/images/common/logo_name.png)
-
-**一站式`Apache Kafka`集群指标监控与运维管控平台**
-
---- 
-
-# kafka-manager 使用手册
-
-管控平台主要有两种用户视角，分别为：
-
-- 普通用户：站在使用Kafka的角度使用kafka-manager；
-- 管理员：站在使用与管理Kafka的角度在使用kafka-manager；
-
-下面我们将从这两个用户的维度说明平台的功能及使用。
-
----
-
-## 1. 普通用户篇
-
-### 1.1 帐号获取及登录
-
-- 询问管理员让其提供普通用户的帐号；
-- 输入帐号及密码，登录kafka-manager；
-
----
-
-### 1.2 Topic申请
-- 步骤一：点击"Topic申请"按钮申请Topic；
-- 步骤二：填写申请信息；
-- 步骤三：等待运维人员或管理员审批；
-
-**Topic申请完成：**
-![my_order_list](./assets/images/kafka_manager_cn_guide/my_order_list.jpg)
-
---- 
-
-### 1.3 Topic信息查看
-
-普通用户可查看的信息包括：
-
-- 集群Topic列表及我收藏的Topic列表；
-- Topic基本信息(Topic创建及修改时间、Topic数据保存时间、Topic负责人等)；
-- Topic分区信息；
-- Topic消费组信息及消费组消费详情；
-- Topic实时&历史流量信息；
-- Topic数据采样；
-
-**Topic详情信息界面：**
-![normal_topic_detail](./assets/images/kafka_manager_cn_guide/normal_topic_detail.jpg)
-
----
-
-### 1.4 Topic运维
-
-普通用户可进行的Topic运维的操作包括：
-- 申请Topic扩容
-- 重置消费偏移；
-
-**Topic重置消费偏移界面：**
-![normal_reset_consume_offset](./assets/images/kafka_manager_cn_guide/normal_reset_consume_offset.jpg)
-
----
-
-### 1.5 告警配置
-
-kafka-manager告警配置中，仅支持Lag／BytesIn/BytesOut这三类告警，同时告警被触发后，告警消息会被发往指定的Topic(具体哪一个请联系管理员获取)。需要用户主动消费该告警Topic的数据或者统一由管理员将该数据接入外部通知系统，比如接入短信通知或电话通知等。
-
-**告警规则配置界面：**
-![normal_create_alarm_rule](./assets/images/kafka_manager_cn_guide/normal_create_alarm_rule.jpg)
-
----
-
-### 1.6 密码修改
-
-**密码修改界面：**
-![normal_modify_password](./assets/images/kafka_manager_cn_guide/normal_modify_password.jpg)
-
----
-
-## 2. 管理员篇
-
-
-### 2.1 帐号获取及登录
-
-- 默认的管理员帐号密码为`admin/admin`(详见数据库account表)；
-
----
-
-### 2.2 添加集群
-
-登录之后，就需要将我们搭建的Kafka集群添加到kafka-manager中。
-
-**添加Kafka集群界面：**
-![admin_add_cluster](./assets/images/kafka_manager_cn_guide/admin_add_cluster.jpg)
-
---- 
-
-### 2.3 监控指标
-
-#### 2.3.1 集群维度指标
-
-- 集群的基本信息；
-- 集群历史及实时流量信息；
-- 集群Topic信息；
-- 集群Broker信息；
-- 集群ConsumerGroup信息；
-- 集群Region信息；
-- 集群当前Controller及变更历史；
-
-**集群维度监控指标界面：**
-![admin_cluster_details](./assets/images/kafka_manager_cn_guide/admin_cluster_details.jpg)
-
----
-
-#### 2.3.2 Broker维度指标
-
-- Broker基本信息；
-- Broker历史与实时流量信息；
-- Broker内Topic信息；
-- Broker内分区信息；
-- Broker关键指标(日志刷盘时间等)；
-- Topic分析(Topic流量占比等)；
-
-**`Broker`维度监控指标界面：**
-![admin_cluster_broker_detail](./assets/images/kafka_manager_cn_guide/admin_cluster_broker_detail.jpg)
-
----
-
-#### 2.3.3 Topic维度指标
-
-- 在普通用户的基础上，增加展示Topic的Broker信息；
-
-图略
-
----
-
-#### 2.3.4 其他维度指标
-
-- 消费组消费哪些具体的Topic；
-
-图略
-
----
-
-### 2.4 集群运维管控
-
-- Topic申请及扩容工单审批；
-- Topic创建、删除、扩容及属性修改；
-- Broker维度优先副本选举；
-- 分区粒度迁移；
-- 逻辑Region管理；
-
-**资源审批界面：**
-![admin_order](./assets/images/kafka_manager_cn_guide/admin_order.jpg)
-
----
-
-### 2.5 用户管理
-
-- 对用户进行增删改查；
-
-**用户管理界面：**
-![admin_manager_account](./assets/images/kafka_manager_cn_guide/admin_manager_account.jpg)

docs/manual_kafka_op/add_cluster.md → docs/user_guide/add_cluster/add_cluster.md

 
 ---
 
-![kafka-manager-logo](../assets/images/common/logo_name.png)
+![kafka-manager-logo](../../assets/images/common/logo_name.png)
 
 **一站式`Apache Kafka`集群指标监控与运维管控平台**
 
@@ -19,13 +19,13 @@
 
 ## 1、接入物理集群
 
-![op_add_cluster](./imgs/op_add_cluster.jpg)
+![op_add_cluster](assets/op_add_cluster.jpg)
 
 如上图所示，填写集群信息，然后点击确定，即可完成集群的接入。因为考虑到分布式部署，添加集群之后，需要稍等**`1分钟`**才可以在界面上看到集群的详细信息。
 
 ## 2、创建Region
 
-![op_add_region](./imgs/op_add_region.jpg)
+![op_add_region](assets/op_add_region.jpg)
 
 如上图所示，填写Region信息，然后点击确定，即可完成Region的创建。
 
@@ -33,7 +33,7 @@
 
 ## 3、创建逻辑集群
 
-![op_add_logical_cluster](./imgs/op_add_logical_cluster.jpg)
+![op_add_logical_cluster](assets/op_add_logical_cluster.jpg)
 
 
 如上图所示，填写逻辑集群信息，然后点击确定，即可完成逻辑集群的创建。
\ No newline at end of file