diff --git "a/docs/zh/docs/A-Tune/\345\256\211\350\243\205\344\270\216\351\203\250\347\275\262.md" "b/docs/zh/docs/A-Tune/\345\256\211\350\243\205\344\270\216\351\203\250\347\275\262.md" index c75826b982c5041faabdfd109152e1fa8b049b55..ab9f99d6956a5b3d7bc737fc8111954d7a62b2a1 100644 --- "a/docs/zh/docs/A-Tune/\345\256\211\350\243\205\344\270\216\351\203\250\347\275\262.md" +++ "b/docs/zh/docs/A-Tune/\345\256\211\350\243\205\344\270\216\351\203\250\347\275\262.md" @@ -1,4 +1,5 @@ # 安装与部署 + 本章介绍如何安装和部署A-Tune。 @@ -19,34 +20,34 @@ ### 硬件要求 -- 鲲鹏920处理器 +- 鲲鹏920处理器 ### 软件要求 -- 操作系统：openEuler 22.03 LTS SP3 +- 操作系统：openEuler 22.03 LTS SP3 ## 环境准备 -- 安装openEuler系统，安装方法参考 [openEuler 22.03 LTS SP3安装指南](https://docs.openeuler.org/zh/docs/22.03_LTS_SP3/docs/Installation/installation.html)。 +- 安装openEuler系统，安装方法参考 [openEuler 22.03 LTS SP3安装指南](https://docs.openeuler.org/zh/docs/22.03_LTS_SP3/docs/Installation/installation.html)。 -- 安装A-Tune需要使用root权限。 +- 安装A-Tune需要使用root权限。 ## 安装A-Tune 本节介绍A-Tune的安装模式和安装方法。 + ### 安装模式介绍 A-Tune支持单机模式和分布式模式安装： -- 单机模式 +- 单机模式 client和server安装到同一台机器上。 -- 分布式模式 +- 分布式模式 client和server分别安装在不同的机器上。 - 两种安装模式的简单图示如下： ![](./figures/zh-cn_image_0231122163.png) @@ -55,21 +56,21 @@ A-Tune支持单机模式和分布式模式安装： 安装A-Tune的操作步骤如下： -1. 挂载openEuler的iso文件。 +1. 挂载openEuler的iso文件。 - ``` + ```bash # mount openEuler-22.03-LTS-SP3-aarch64-dvd.iso /mnt ``` -2. 配置本地yum源。 +2. 配置本地yum源。 - ``` + ```bash # vim /etc/yum.repos.d/local.repo ``` 配置内容如下所示： - ``` + ```bash [local] name=local baseurl=file:///mnt @@ -77,32 +78,31 @@ A-Tune支持单机模式和分布式模式安装： enabled=1 ``` -3. 将RPM数字签名的GPG公钥导入系统。 +3. 将RPM数字签名的GPG公钥导入系统。 - ``` + ```bash # rpm --import /mnt/RPM-GPG-KEY-openEuler ``` - 4. 安装A-Tune服务端。 >![](./public_sys-resources/icon-note.gif) **说明：** >本步骤会同时安装服务端和客户端软件包，对于单机部署模式，请跳过**步骤5**。 - ``` + ```bash # yum install atune -y # yum install atune-engine -y ``` -5. 若为分布式部署，请安装A-Tune客户端。 +5. 若为分布式部署，请安装A-Tune客户端。 - ``` + ```bash # yum install atune-client -y ``` -6. 验证是否安装成功。命令和回显如下表示安装成功。 +6. 验证是否安装成功。命令和回显如下表示安装成功。 - ``` + ```bash # rpm -qa | grep atune atune-client-xxx atune-db-xxx @@ -110,10 +110,10 @@ A-Tune支持单机模式和分布式模式安装： atune-engine-xxx ``` - ## 部署A-Tune 本节介绍A-Tune的配置部署。 + ### 配置介绍 A-Tune配置文件/etc/atuned/atuned.cnf的配置项说明如下： @@ -122,62 +122,61 @@ A-Tune配置文件/etc/atuned/atuned.cnf的配置项说明如下： 可根据需要进行修改。 - - protocol：系统gRPC服务使用的协议，unix或tcp，unix为本地socket通信方式，tcp为socket监听端口方式。默认为unix。 - - address：系统gRPC服务的侦听地址，默认为unix socket，若为分布式部署，需修改为侦听的ip地址。 - - port：系统gRPC服务的侦听端口，范围为0\~65535未使用的端口。如果protocol配置是unix，则不需要配置。 - - connect：若为集群部署时，A-Tune所在节点的ip列表，ip地址以逗号分隔。 - - rest_host：系统rest service的侦听地址，默认为localhost。 - - rest_port：系统rest service的侦听端口，范围为0~65535未使用的端口，默认为8383。 - - engine_host：与系统atune engine service链接的地址。 - - engine_port：与系统atune engine service链接的端口。 - - sample_num：系统执行analysis流程时采集样本的数量，默认为20。 - - interval：系统执行analysis流程时采集样本的间隔时间，默认为5s。 - - grpc_tls：系统gRPC的SSL/TLS证书校验开关，默认不开启。开启grpc_tls后，atune-adm命令在使用前需要设置以下环境变量方可与服务端进行通讯： - - export ATUNE_TLS=yes - - export ATUNED_CACERT=<客户端CA证书路径> - - export ATUNED_CLIENTCERT=<客户端证书路径> - - export ATUNED_CLIENTKEY=<客户端密钥路径> - - export ATUNED_SERVERCN=server - - tlsservercafile：gRPC服务端CA证书路径。 - - tlsservercertfile：gRPC服务端证书路径。 - - tlsserverkeyfile：gRPC服务端密钥路径。 - - rest_tls：系统rest service的SSL/TLS证书校验开关，默认开启。 - - tlsrestcacertfile：系统rest service的服务端CA证书路径。 - - tlsrestservercertfile：系统rest service的服务端证书路径 - - tlsrestserverkeyfile：系统rest service的服务端密钥路径。 - - engine_tls：系统atune engine service的SSL/TLS证书校验开关，默认开启。 - - tlsenginecacertfile：系统atune engine service的客户端CA证书路径。 - - tlsengineclientcertfile：系统atune engine service的客户端证书路径 - - tlsengineclientkeyfile：系统atune engine service的客户端密钥路径。 - -- system信息 + - protocol：系统gRPC服务使用的协议，unix或tcp，unix为本地socket通信方式，tcp为socket监听端口方式。默认为unix。 + - address：系统gRPC服务的侦听地址，默认为unix socket，若为分布式部署，需修改为侦听的ip地址。 + - port：系统gRPC服务的侦听端口，范围为0\~65535未使用的端口。如果protocol配置是unix，则不需要配置。 + - connect：若为集群部署时，A-Tune所在节点的ip列表，ip地址以逗号分隔。 + - rest_host：系统rest service的侦听地址，默认为localhost。 + - rest_port：系统rest service的侦听端口，范围为0~65535未使用的端口，默认为8383。 + - engine_host：与系统atune engine service链接的地址。 + - engine_port：与系统atune engine service链接的端口。 + - sample_num：系统执行analysis流程时采集样本的数量，默认为20。 + - interval：系统执行analysis流程时采集样本的间隔时间，默认为5s。 + - grpc_tls：系统gRPC的SSL/TLS证书校验开关，默认不开启。开启grpc_tls后，atune-adm命令在使用前需要设置以下环境变量方可与服务端进行通讯： + - export ATUNE_TLS=yes + - export ATUNED_CACERT=<客户端CA证书路径> + - export ATUNED_CLIENTCERT=<客户端证书路径> + - export ATUNED_CLIENTKEY=<客户端密钥路径> + - export ATUNED_SERVERCN=server + - tlsservercafile：gRPC服务端CA证书路径。 + - tlsservercertfile：gRPC服务端证书路径。 + - tlsserverkeyfile：gRPC服务端密钥路径。 + - rest_tls：系统rest service的SSL/TLS证书校验开关，默认开启。 + - tlsrestcacertfile：系统rest service的服务端CA证书路径。 + - tlsrestservercertfile：系统rest service的服务端证书路径 + - tlsrestserverkeyfile：系统rest service的服务端密钥路径。 + - engine_tls：系统atune engine service的SSL/TLS证书校验开关，默认开启。 + - tlsenginecacertfile：系统atune engine service的客户端CA证书路径。 + - tlsengineclientcertfile：系统atune engine service的客户端证书路径 + - tlsengineclientkeyfile：系统atune engine service的客户端密钥路径。 + +- system信息 system为系统执行相关的优化需要用到的参数信息，必须根据系统实际情况进行修改。 - - disk：执行analysis流程时需要采集的对应磁盘的信息或执行磁盘相关优化时需要指定的磁盘。 - - network：执行analysis时需要采集的对应的网卡的信息或执行网卡相关优化时需要指定的网卡。 + - disk：执行analysis流程时需要采集的对应磁盘的信息或执行磁盘相关优化时需要指定的磁盘。 + - network：执行analysis时需要采集的对应的网卡的信息或执行网卡相关优化时需要指定的网卡。 - - user：执行ulimit相关优化时用到的用户名。目前只支持root用户。 + - user：执行ulimit相关优化时用到的用户名。目前只支持root用户。 -- 日志信息 +- 日志信息 根据情况修改日志的级别，默认为info级别，日志信息打印在/var/log/messages中。 -- monitor信息 +- monitor信息 为系统启动时默认采集的系统硬件信息。 -- tuning信息 +- tuning信息 tuning为系统进行离线调优时需要用到的参数信息。 - - noise：高斯噪声的评估值。 - - sel_feature：控制离线调优参数重要性排名输出的开关，默认关闭。 - + - noise：高斯噪声的评估值。 + - sel_feature：控制离线调优参数重要性排名输出的开关，默认关闭。 ### 配置示例 -``` +```YAML #################################### server ############################### # atuned config [server] @@ -275,12 +274,12 @@ A-Tune engine配置文件/etc/atuned/engine.cnf的配置项说明如下： 可根据需要进行修改。 - - engine_host：系统atune engine service的监听地址，默认为localhost。 - - engine_port：系统atune engine service的监听端口，范围为0~65535未使用的端口，默认为3838。 - - engine_tls：系统atune engine service的SSL/TLS证书校验开关，默认开启。 - - tlsenginecacertfile：系统atune engine service的服务端CA证书路径。 - - tlsengineservercertfile：系统atune engine service的服务端证书路径 - - tlsengineserverkeyfile：系统atune engine service的服务端密钥路径。 + - engine_host：系统atune engine service的监听地址，默认为localhost。 + - engine_port：系统atune engine service的监听端口，范围为0~65535未使用的端口，默认为3838。 + - engine_tls：系统atune engine service的SSL/TLS证书校验开关，默认开启。 + - tlsenginecacertfile：系统atune engine service的服务端CA证书路径。 + - tlsengineservercertfile：系统atune engine service的服务端证书路径 + - tlsengineserverkeyfile：系统atune engine service的服务端密钥路径。 - 日志信息 @@ -288,7 +287,7 @@ A-Tune engine配置文件/etc/atuned/engine.cnf的配置项说明如下： ### 配置示例 -``` +```YAML #################################### engine ############################### [server] # the tuning optimizer host and port, start by engine.service @@ -314,16 +313,15 @@ A-Tune engine配置文件/etc/atuned/engine.cnf的配置项说明如下： A-Tune安装完成后，需要启动A-Tune服务才能使用。 -- 启动atuned服务： +- 启动atuned服务： - ``` + ```bash # systemctl start atuned ``` +- 查询atuned服务状态： -- 查询atuned服务状态： - - ``` + ```bash # systemctl status atuned ``` @@ -337,14 +335,13 @@ A-Tune安装完成后，需要启动A-Tune服务才能使用。 - 启动atune-engine服务： - ``` + ```bash # systemctl start atune-engine ``` - - 查询atune-engine服务状态： - ``` + ```bash # systemctl status atune-engine ```