Merge pull request #607 from haoqi123/dev

[单机部署手册.md]docker-compose部署方式添加注释描述

docs/install_guide/单机部署手册.md

@@ -90,11 +90,52 @@ helm pull knowstreaming/knowstreaming-manager
  
 
 #### 2.1.3.2、Docker Compose
-```yml
+**环境依赖**
-version: "3"
 
+- [Docker](https://docs.docker.com/engine/install/) 
+- [Docker Compose](https://docs.docker.com/compose/install/) 
+
+
+**安装命令**
+```bash
+# `v3.0.0-beta.2`版本开始，默认账号密码为`admin` / `admin`；
+# https://hub.docker.com/u/knowstreaming 在此处寻找最新镜像版本
+# mysql与es可以使用自己搭建的服务,调整对应配置即可
+
+# 复制docker-compose.yml到指定位置后执行下方命令即可启动
+docker-compose up -d
+```
+
+**验证安装**
+```shell
+docker-compose ps
+# 验证启动 - 状态为 UP 则表示成功 
+        Name                       Command                       State                  Ports
+----------------------------------------------------------------------------------------------------
+elasticsearch-single    /usr/local/bin/docker-entr ...   Up                      9200/tcp, 9300/tcp
+knowstreaming-init      /bin/bash /es_template_cre ...   Up
+knowstreaming-manager   /bin/sh /ks-start.sh             Up                      80/tcp
+knowstreaming-mysql     /entrypoint.sh mysqld            Up (health: starting)   3306/tcp, 33060/tcp
+knowstreaming-ui        /docker-entrypoint.sh ngin ...   Up                      0.0.0.0:80->80/tcp
+
+# 稍等一分钟左右 knowstreaming-init 会退出，表示es初始化完成，可以访问页面
+        Name                       Command                  State              Ports
+-------------------------------------------------------------------------------------------
+knowstreaming-init      /bin/bash /es_template_cre ...   Exit 0
+knowstreaming-mysql     /entrypoint.sh mysqld            Up (healthy)   3306/tcp, 33060/tcp
+```
+
+**访问**
+```http request
+http://127.0.0.1:80/
+```
+
+
+**docker-compose.yml**
+```yml
+version: "2"
 services:
-  
+  # *不要调整knowstreaming-manager服务名称，ui中会用到
   knowstreaming-manager:
     image: knowstreaming/knowstreaming-manager:0.2.0-test
     container_name: knowstreaming-manager
@@ -110,18 +151,22 @@ services:
       - /ks-start.sh
     environment:
       TZ: Asia/Shanghai
-
+      # mysql服务地址
       SERVER_MYSQL_ADDRESS: knowstreaming-mysql:3306
+      # mysql数据库名
       SERVER_MYSQL_DB: know_streaming
+      # mysql用户名
       SERVER_MYSQL_USER: root
+      # mysql用户密码
       SERVER_MYSQL_PASSWORD: admin2022_
-
+      # es服务地址
       SERVER_ES_ADDRESS: elasticsearch-single:9200
-
+      # 服务JVM参数
       JAVA_OPTS: -Xmx1g -Xms1g
-
+      # 对于kafka中ADVERTISED_LISTENERS填写的hostname可以通过该方式完成
 #    extra_hosts:
 #      - "hostname:x.x.x.x"
+      # 服务日志路径
 #    volumes:
 #      - /ks/manage/log:/logs
   knowstreaming-ui:
@@ -129,14 +174,13 @@ services:
     container_name: knowstreaming-ui
     restart: always
     ports:
-      - '18092:80'
+      - '80:80'
     environment:
       TZ: Asia/Shanghai
     depends_on:
       - knowstreaming-manager
 #    extra_hosts:
 #      - "hostname:x.x.x.x"
-
   elasticsearch-single:
     image: docker.io/library/elasticsearch:7.6.2
     container_name: elasticsearch-single
@@ -149,14 +193,19 @@ services:
 #      - '9300:9300'
     environment:
       TZ: Asia/Shanghai
+      # es的JVM参数
       ES_JAVA_OPTS: -Xms512m -Xmx512m
+      # 单节点配置，多节点集群参考 https://www.elastic.co/guide/en/elasticsearch/reference/7.6/docker.html#docker-compose-file
       discovery.type: single-node
+      # 数据持久化路径
 #    volumes:
 #      - /ks/es/data:/usr/share/elasticsearch/data
 
+  # es初始化服务，与manager使用同一镜像
+  # 首次启动es需初始化模版和索引,后续会自动创建
   knowstreaming-init:
     image: knowstreaming/knowstreaming-manager:0.2.0-test
-    container_name: knowstreaming_init
+    container_name: knowstreaming-init
     depends_on:
       - elasticsearch-single
     command:
@@ -164,22 +213,26 @@ services:
       - /es_template_create.sh
     environment:
       TZ: Asia/Shanghai
+      # es服务地址
       SERVER_ES_ADDRESS: elasticsearch-single:9200
 
-
   knowstreaming-mysql:
     image: knowstreaming/knowstreaming-mysql:0.2.0-test
     container_name: knowstreaming-mysql
     restart: always
     environment:
       TZ: Asia/Shanghai
+      # root 用户密码
       MYSQL_ROOT_PASSWORD: admin2022_
+      # 初始化时创建的数据库名称
       MYSQL_DATABASE: know_streaming
+      # 通配所有host,可以访问远程
       MYSQL_ROOT_HOST: '%'
     expose:
       - 3306
 #    ports:
 #      - '3306:3306'
+      # 数据持久化路径
 #    volumes:
 #      - /ks/mysql/data:/data/mysql
 ```