From 23d837f07a4778508316ce60f7d2778575771850 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=BB=B4=E5=9F=BA=E9=B1=BC?= Date: Fri, 22 Nov 2024 17:58:30 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20x2=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0,?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E7=A9=BA=E6=A0=BC=E7=AD=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/docs/x2openEuler/CommonOperation.md | 24 +++++++++---------- docs/zh/docs/x2openEuler/Faq.md | 6 ++--- docs/zh/docs/x2openEuler/FeatureGuide.md | 12 +++++----- docs/zh/docs/x2openEuler/InstallationGuide.md | 3 +++ docs/zh/docs/x2openEuler/Introduce.md | 16 ++++++------- 5 files changed, 32 insertions(+), 29 deletions(-) diff --git a/docs/zh/docs/x2openEuler/CommonOperation.md b/docs/zh/docs/x2openEuler/CommonOperation.md index 81cd4be61..11d51d036 100644 --- a/docs/zh/docs/x2openEuler/CommonOperation.md +++ b/docs/zh/docs/x2openEuler/CommonOperation.md @@ -44,7 +44,7 @@ 本指南以 Chrome 105.0 为例介绍为 x2openEuler 工具导入根证书的操作步骤。 -1. 登录x2openEuler工具，在页面右上方选择“![](figures/icons/settings.png) \> web 服务端证书”，单击“下载根证书“下载根证书。 +1. 登录 x2openEuler 工具，在页面右上方选择“![](figures/icons/settings.png) \> web 服务端证书”，单击“下载根证书“下载根证书。 2. 打开浏览器，依次选择“设置 \> 隐私设置和安全性 \> 安全\>管理证书”。 3. 在弹出“证书”的对话框中，选择“受信任的根证书颁发机构”页签，单击“导入”，如 [图 2](#figure2) 所示。 @@ -90,7 +90,7 @@ 例如：10.254.206.190 x2openEuler -12. 打开本地 PC 机的浏览器，在地址栏输入**: _端口号_**（例如： +12. 打开本地 PC 机的浏览器，在地址栏输入**https://x2openEuler: _端口号_**（例如：https://x2openEuler:8084），按“Enter”。 ## SSH 配置 @@ -130,7 +130,7 @@ -3. 按“ESC”，输入“:wq”，按“Enter”保存并退出。 +3. 按 “ESC”，输入 “:wq”，按 “Enter” 保存并退出。 4. 执行以下命令重启 SSH 服务以生效配置。 ``` @@ -180,7 +180,7 @@ ``` 3. 按 “i” 进入编辑模式，将 SELINUX=enforcing 改为 SELINUX=disabled。 - 4. 按“ESC”，输入“:wq”，按“Enter”保存并退出。 + 4. 按 “ESC”，输入 “:wq”，按 “Enter” 保存并退出。 5. 执行以下命令重启服务器。 ``` @@ -827,7 +827,7 @@ Web 服务端证书用于客户端浏览器和 web 服务器之间的通讯， PubkeyAuthentication yes ``` - 修改完成后，按“ESC”，输入“:wq”，按“Enter”保存并退出。 + 修改完成后，按 “ESC”，输入 “:wq”，按 “Enter” 保存并退出。 3. 执行以下命令重启SSH服务使配置内容生效。 @@ -949,7 +949,7 @@ Web 服务端证书用于客户端浏览器和 web 服务器之间的通讯， @staticmethod def run(node: dict): # node 为记录了节点相关信息的字典，如需查看内容，可以使用 LOG.info(node) 将其记录到日志中，run()方法必须实现 LOG.info("start to get memory usage info...") - used_size, total_size = MemoryUsageStatisticsActor._get_memory_usage() #获取内存数据 + used_size, total_size = MemoryUsageStatisticsActor._get_memory_usage() # 获取内存数据 if used_size < 0 or total_size < 0 or total_size < 1024*1024: # 内存值比较 return ReturnMessage(result=BaseCheckActor.FAIL, solution="请检查 free -k 命令回显", @@ -991,7 +991,7 @@ Web 服务端证书用于客户端浏览器和 web 服务器之间的通讯， 2. 参考如下代码新增 actor。 > ![](public_sys-resources/icon-note.gif) **说明：** - > actor 是一个 python 文件，如果在本地编写完 actor 代码，需将代码上传至 x2openEuler 工具部署节点 /usr/local/x2openEuler/portal/src/taskmanager/actors/env_check_actor 路径下，工具会自动读取check_actor 下的所有 actor 文件并完成解析，并在指定的流程中执行对应代码。 + > actor 是一个 python 文件，如果在本地编写完 actor 代码，需将代码上传至 x2openEuler 工具部署节点 /usr/local/x2openEuler/portal/src/taskmanager/actors/env_check_actor 路径下，工具会自动读取 check_actor 下的所有 actor 文件并完成解析，并在指定的流程中执行对应代码。 > 该 actor 无需远程连接，可直接执行。 ```sh @@ -1008,7 +1008,7 @@ Web 服务端证书用于客户端浏览器和 web 服务器之间的通讯， description = "get memory usage statistics" # 用例描述，会显示在前端 level = "Low" # 用例 level，预留字段，当前未使用 sort = "100" # 优先级，支持小数，数字越低，优先级越高，不能低于 10 - priority = "unnecessary" # 用例等级，分必选和可选，必选失败会导致步骤失败，必选为mandatory，可选为unnecessary + priority = "unnecessary" # 用例等级，分必选和可选，必选失败会导致步骤失败，必选为 mandatory，可选为 unnecessary task_type = (BaseCheckActor.task_type.PRE_SYSTEM_UPGRADE,) # 用例 type，只有用例于对应 type 匹配上，才会在对应类型的任务下执行，PRE_SYSTEM_UPGRADE 为环境巡检字段 @staticmethod @@ -1064,7 +1064,7 @@ Web 服务端证书用于客户端浏览器和 web 服务器之间的通讯， 2. 参考如下代码新增 actor 以自定义升级前检查，以下代码展示了可用内存是否大于 1G 的检查项编写。 > ![](public_sys-resources/icon-note.gif) **说明：** - > actor 是一个 python 文件，如果在本地编写完 actor 代码，需将代码上传至部署 x2openEuler-upgrade 的待升级环境 /usr/lib/x2openEuler-upgrade/src/env_check/check_actor/ 路径下，工具会自动读取 check_actor 下的所有 actor 文件并完成解析，并在指定的流程中执行对应代码 + > actor 是一个 python 文件，如果在本地编写完 actor 代码，需将代码上传至部署 x2openEuler-upgrade 的待升级环境 /usr/lib/x2openEuler-upgrade/src/env_check/check_actor/ 路径下，工具会自动读取 check_actor 下的所有 actor 文件并完成解析，并在指定的流程中执行对应代码。 > 该 actor 无需远程连接，可直接执行。 ```sh @@ -1081,8 +1081,8 @@ Web 服务端证书用于客户端浏览器和 web 服务器之间的通讯， description = "get memory usage statistics" # 用例描述，会显示在前端 level = "Low" # 用例 level，预留字段，当前未使用 sort = "100" # 优先级，支持小数，数字越低，优先级越高，不能低于 10 - priority = "unnecessary" # 用例等级，分必选和可选，必选失败会导致步骤失败，必选为mandatory，可选为unnecessary - task_type = (BaseCheckActor.task_type.PRE_SYSTEM_UPGRADE,) # 用例 type，只有用例于对应 type 匹配上，才会在对应类型的任务下执行，PRE_SYSTEM_UPGRADE为环境巡检字段 + priority = "unnecessary" # 用例等级，分必选和可选，必选失败会导致步骤失败，必选为 mandatory，可选为 unnecessary + task_type = (BaseCheckActor.task_type.PRE_SYSTEM_UPGRADE,) # 用例 type，只有用例于对应 type 匹配上，才会在对应类型的任务下执行，PRE_SYSTEM_UPGRADE 为环境巡检字段 @staticmethod def run(node: dict): # node 为记录了节点相关信息的字典，如需查看内容，可以使用 LOG.info(node) 将其记录到日志中，run()方法必须实现 @@ -1144,7 +1144,7 @@ Web 服务端证书用于客户端浏览器和 web 服务器之间的通讯， ``` > ![](public_sys-resources/icon-note.gif) **说明：** - > 其中，x.x.x.x 为待升级节点 ip 地址，22为 待升级节点 ssh 端口。 + > 其中，x.x.x.x 为待升级节点 ip 地址，22 为待升级节点 ssh 端口。 ## 强制修改数据库密码 diff --git a/docs/zh/docs/x2openEuler/Faq.md b/docs/zh/docs/x2openEuler/Faq.md index b5736b62c..3b166e0e4 100644 --- a/docs/zh/docs/x2openEuler/Faq.md +++ b/docs/zh/docs/x2openEuler/Faq.md @@ -229,8 +229,8 @@ x2openEuler 工具不能通过 mysql.sock连 接到 MariaDB。 kill -9 PID ``` -2. 注释 /etc/my.cnf 中socket参数。 - 1. 执行以下命令编辑my.cnf文件，按下 “i” 进入编辑模式。 +2. 注释 /etc/my.cnf 中 socket 参数。 + 1. 执行以下命令编辑 my.cnf 文件，按下 “i” 进入编辑模式。 ``` vi /etc/my.cnf ``` @@ -238,7 +238,7 @@ x2openEuler 工具不能通过 mysql.sock连 接到 MariaDB。 ``` # socket=/var/lib/mysql/mysql.sock ``` - 3. 按“ESC”，输入“:wq”，按“Enter”保存并退出。 + 3. 按 “ESC”，输入 “:wq”，按 “Enter” 保存并退出。 3. 执行以下命令重启 MariaDB 服务。 ``` diff --git a/docs/zh/docs/x2openEuler/FeatureGuide.md b/docs/zh/docs/x2openEuler/FeatureGuide.md index 4737828af..ad1f59c7b 100644 --- a/docs/zh/docs/x2openEuler/FeatureGuide.md +++ b/docs/zh/docs/x2openEuler/FeatureGuide.md @@ -160,7 +160,7 @@ swap软件包配置 - 部分软件包无法被升级，需要手动替换，如想将A包在升级后替换成B包，则需填写A->B。 + 部分软件包无法被升级，需要手动替换，如想将 A 包在升级后替换成B包，则需填写 A->B。 文件迁移配置 @@ -350,12 +350,12 @@

表示扫描 Jar 包中调用的 jdk 接口在待迁移的系统上对应满足运行条件的最小 jdk 上发生的变更。

    -
  • openEuler jdk：openEuler上满足Jar包运行环境的最小 jdk 版本。
    • -
  • 对象构建 jdk：扫描 jar 包对应构建的jdk版本。
    • +
  • openEuler jdk：openEuler 上满足 Jar包 运行环境的最小 jdk 版本。
    • +
  • 对象构建 jdk：扫描 jar 包对应构建的 jdk 版本。
  • jar 包名：扫描的 jar 包名称。
  • 方法名：存在接口差异的方法名。
  • 函数调用签名：存在接口差异的方法函数签名。
    • -
  • 包名：存在接口差异的方法所在的包（packageName+className）。
    • +
  • 包名：存在接口差异的方法所在的包（packageName + className）。
  • 差异项：接口差异选项。
@@ -363,9 +363,9 @@ 接口兼容性（Java） -

Jar 接口差异主要描述了当前jar包接口在待迁移的系统上发生的变更。

+

Jar 接口差异主要描述了当前 jar 包接口在待迁移的系统上发生的变更。

    -
  • 调用的 ja r包：表示当前被调用的 jar 包名称。
    • +
  • 调用的 jar 包：表示当前被调用的 jar 包名称。
  • 所属的 rpm 包：表示当前的 jar 包所属的 rpm 包。
  • 展开的详细信息中：
      diff --git a/docs/zh/docs/x2openEuler/InstallationGuide.md b/docs/zh/docs/x2openEuler/InstallationGuide.md index 5e0ec8831..536ea8740 100644 --- a/docs/zh/docs/x2openEuler/InstallationGuide.md +++ b/docs/zh/docs/x2openEuler/InstallationGuide.md @@ -175,6 +175,7 @@ >- 建议对数据库 x2openEuler 用户密码定期进行修改，确保业务安全运行。 >- 如本地已存在 MariaDB 数据库，建议更新 MariaDB 到最新版本，并禁止远程访问数据库。 + **手动安装** ``` cd /usr/local/x2openEuler/portal/service bash service_init.sh @@ -313,6 +314,8 @@ Web console is now running, go to: https://x.x.x.x:18082/x2openEuler/#/login ``` + **静默安装** + 工具也支持一键式地启动服务，采用默认配置。在执行静默安装前，需要先修改配置文件 `/usr/local/x2openEuler/portal/service/silent_installation.conf`, 配置文件的内容如下： ``` diff --git a/docs/zh/docs/x2openEuler/Introduce.md b/docs/zh/docs/x2openEuler/Introduce.md index 3286fbad2..0ef324986 100644 --- a/docs/zh/docs/x2openEuler/Introduce.md +++ b/docs/zh/docs/x2openEuler/Introduce.md @@ -69,7 +69,7 @@ [ ] - 表示用“[ ]”括起来的部分在命令配置时是可选的。 + 表示用 “[ ]” 括起来的部分在命令配置时是可选的。 { x | y | ... } @@ -91,12 +91,12 @@ &<1-n> - 表示符号“&”前面的参数可以重复 1～n 次。 + 表示符号 “&” 前面的参数可以重复 1～n 次。 # - 表示由“#”开始的行为注释行。 + 表示由 “#” 开始的行为注释行。 @@ -129,7 +129,7 @@ 2022-12-30 第四次正式发布
    • 新增特性-系统信息收集评估、系统配置迁移
      • -
    • 新增常用操作和FAQ章节
      • +
    • 新增常用操作和 FAQ 章节
      • @@ -187,7 +187,7 @@ x2openEuler 工具提供 web 界面方式进行操作，以供使用者能够在 ### 访问和使用 -x2openEuler 工具提供命令行或者web使用方式，用户在安装完成后选择使用方式。工具的使用方法请参考章节 [特性指南](FeatureGuide.md)。 +x2openEuler 工具提供命令行或者 web 使用方式，用户在安装完成后选择使用方式。工具的使用方法请参考章节 [特性指南](FeatureGuide.md)。 ### 界面说明 @@ -362,7 +362,7 @@ x2openEuler 工具中出现的图标/按钮及其说明如 [表 2](#sheet2) 所 >![](public_sys-resources/icon-notice.gif) **须知：** > >- 默认连续 5 次登录失败，系统将对此用户进行锁定，锁定 3 分钟后可以重新登录。 ->- 默认情况下，系统超时时间为 30 分钟，即在 30 分钟内，如果您未在webUI界面执行任何操作，系统将自动登出，此时需输入用户名和密码重新登录 webUI 界面。管理员可在 x2openEuler 工具首页中的![](figures/icons/settings.png)选项中选择“系统配置”，手动配置会话超时时间，可配置范围为 10\~240 分钟。 +>- 默认情况下，系统超时时间为 30 分钟，即在 30 分钟内，如果您未在 webUI 界面执行任何操作，系统将自动登出，此时需输入用户名和密码重新登录 webUI 界面。管理员可在 x2openEuler 工具首页中的![](figures/icons/settings.png)选项中选择“系统配置”，手动配置会话超时时间，可配置范围为 10\~240 分钟。 >- 为保证系统的安全性，初次登录时，请及时修改初始密码，并定期更新。 >- 默认允许 10 个普通用户同时登录使用，管理员用户不受此限制。管理员用户可在x2openEuler工具首页中的![](figures/icons/settings.png)菜单选项中选择“系统配置”，手动配置“最大在线普通用户数”，可配置范围为 1\~20。 >- 单个用户只允许 1 个活跃会话，如果当前用户已经在登录使用，重复登录会挤掉前面的登录。 @@ -394,7 +394,7 @@ x2openEuler 工具中出现的图标/按钮及其说明如 [表 2](#sheet2) 所 用户名 - 登录x2openEuler工具的用户
      说明：
      系统的默认管理员为 x2openEulerAdmin，工具安装完成后首次登录需要设置管理员密码 + 登录 x2openEuler 工具的用户
      说明：
      系统的默认管理员为 x2openEulerAdmin，工具安装完成后首次登录需要设置管理员密码 密码 @@ -494,7 +494,7 @@ x2openEuler 工具中出现的图标/按钮及其说明如 [表 2](#sheet2) 所
      • 用户名必须以英文字母开头
      • 默认长度范围为：6~32
        • -
      • 可以包含字母、数字、“-”和“_”
        • +
      • 可以包含字母、数字、“-” 和 “_”
      -- Gitee