update user guide for deployment

Documentation/UserGuide/A-Tune用户指南.md

@@ -296,8 +296,9 @@ A-Tune配置文件/etc/atuned/atuned.cnf的配置项说明如下：
 
     可根据需要进行修改。
 
-    -   address：系统grpc服务的侦听地址，默认为127.0.0.1，若为分布式部署，需进行修改。
-    -   port：系统grpc服务的侦听端口，范围为0\~65535未使用的端口。
+    -   protocol：系统grpc服务使用的协议，unix或tcp，unix为本地socket通信方式，tcp为socket监听端口方式。默认为unix。
+    -   address：系统grpc服务的侦听地址，默认为unix socket，若为分布式部署，需修改为侦听的ip地址。
+    -   port：系统grpc服务的侦听端口，范围为0\~65535未使用的端口。如果protocol配置是unix，则不需要配置。
     -   rest\_port：系统restservice的侦听端口, 范围为0\~65535未使用的端口。
     -   sample\_num：系统执行analysis流程时采集样本的数量。
 
@@ -333,12 +334,18 @@ A-Tune配置文件/etc/atuned/atuned.cnf的配置项说明如下：
 #################################### server ###############################
 # atuned config
 [server]
-# the address that the grpc server to bind to, default is 127.0.0.1
-address = 127.0.0.1
+# the protocol grpc server running on
+# ranges: unix or tcp
+protocol = unix
 
-# the atuned grpc listening port, default is 60001
+# the address that the grpc server to bind to
+# default is unix socket /var/run/atuned/atuned.sock
+# ranges: /var/run/atuned/atuned.sock or ip address
+address = /var/run/atuned/atuned.sock
+
+# the atuned grpc listening port
 # the port can be set between 0 to 65535 which not be used
-port = 60001
+# port = 60001
 
 # the rest service listening port, default is 8383
 # the port can be set between 0 to 65535 which not be used
@@ -358,6 +365,7 @@ sample_num = 20
 # tlshttpcacertfile = /etc/atuned/http/cacert.pem
 
 #################################### log ###############################
+[log]
 # either "debug", "info", "warn", "error", "critical", default is "info"
 level = info
 

Documentation/UserGuide/UserGuide.md

@@ -302,8 +302,9 @@ The configuration items in the A-Tune configuration file  **/etc/atuned/atuned.c
 
     You can modify the parameter value as required.
 
-    -   **address**: Listening IP address of the gRPC server. The default value is  **127.0.0.1**. Modify the value for distributed deployment.
-    -   **port**: Listening port of the gRPC server. The value ranges from 0 to 65535. The port is not in use.
+    -   **protocol**: Protocol of the gRPC server. The value can take **unix** or **tcp**. **unix** is local socket communication and **tcp** is listening port communication. The default value is **unix**.
+    -   **address**: Listening IP address of the gRPC server. The default value is  unix socket **/var/run/atuned/atuned.sock**. Modify the value as ip for distributed deployment.
+    -   **port**: Listening port of the gRPC server. The value ranges from 0 to 65535. The port is not in use. If **protocol** value is set to unix, the port need not be configured.
     -   **rest\_port**: Listening port of the system REST service. The value ranges from 0 to 65535. The port is not in use.
     -   **sample\_num**: Number of samples collected when the system executes the analysis process.
 
@@ -339,12 +340,18 @@ The configuration items in the A-Tune configuration file  **/etc/atuned/atuned.c
 #################################### server ###############################
 # atuned config
 [server]
-# the address that the grpc server to bind to, default is 127.0.0.1
-address = 127.0.0.1
+# the protocol grpc server running on
+# ranges: unix or tcp
+protocol = unix
 
-# the atuned grpc listening port, default is 60001
+# the address that the grpc server to bind to
+# default is unix socket /var/run/atuned/atuned.sock
+# ranges: /var/run/atuned/atuned.sock or ip address
+address = /var/run/atuned/atuned.sock
+
+# the atuned grpc listening port
 # the port can be set between 0 to 65535 which not be used
-port = 60001
+# port = 60001
 
 # the rest service listening port, default is 8383
 # the port can be set between 0 to 65535 which not be used
@@ -364,6 +371,7 @@ sample_num = 20
 # tlshttpcacertfile = /etc/atuned/http/cacert.pem
 
 #################################### log ###############################
+[log]
 # either "debug", "info", "warn", "error", "critical", default is "info"
 level = info
 

README-zh.md

-<img src="misc/A-Tune-logo.png" style="zoom: 30%;" div align=left />
+<img src="misc/A-Tune-logo.png" width=50% div align=left />
 
 [English](./README.md) | 简体中文
 

README.md

-<img src="misc/A-Tune-logo.png" style="zoom: 30%;" div align=left />
+<img src="misc/A-Tune-logo.png" width=50% div align=left />
 
 English | [简体中文](./README-zh.md)