From f37e3eff346968a4adf31bb861f3f4ed72ca9dc2 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 11:16:29 +0800 Subject: [PATCH 01/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E4=BD=8E=E9=94=99?= =?UTF-8?q?=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/embedded/uniproton/uniproton_apis.md | 36 +++++++++---------- .../embedded/uniproton/uniproton_functions.md | 8 ++--- .../configuring_the_web_server.md | 2 +- docs/zh/server/development/gcc/_toc.yaml | 4 ++- .../development/gcc}/pin_user_guide.md | 0 ...ible_container_management_plane_offload.md | 8 ++--- ...n_aggregation_environment_establishment.md | 17 +++++---- .../dpu_offload/offload_deployment_guide.md | 4 +-- .../installation/installation_guide.md | 14 ++++---- .../installation/installation_modes.md | 2 +- .../installation/installation_preparations.md | 4 +-- .../installation/risc_v_pioneer1.3.md | 10 +++--- ...ng_kickstart_for_automatic_installation.md | 6 ++-- .../installation_upgrade/upgrade/_toc.yaml | 2 +- .../quickstart/quickstart/quick_start.md | 1 + .../releasenotes/releasenotes/contribution.md | 4 +-- docs/zh/tools/community_tools/pin/_toc.yaml | 6 ---- 17 files changed, 64 insertions(+), 64 deletions(-) rename docs/zh/{tools/community_tools/pin => server/development/gcc}/pin_user_guide.md (100%) delete mode 100644 docs/zh/tools/community_tools/pin/_toc.yaml diff --git a/docs/zh/embedded/uniproton/uniproton_apis.md b/docs/zh/embedded/uniproton/uniproton_apis.md index 07cea125d..f4f94452f 100644 --- a/docs/zh/embedded/uniproton/uniproton_apis.md +++ b/docs/zh/embedded/uniproton/uniproton_apis.md @@ -176,7 +176,7 @@ ### 查询任务基本信息 -获取任务基本信息，包括任务切换时的PC，SP、任务状态、优先级、任务栈大小、栈顶值，任务名等。 +获取任务基本信息，包括任务切换时的PC、SP、任务状态、优先级、任务栈大小、栈顶值和任务名等。 **输入**：任务PID，用于存放任务基本信息查询结果的缓冲区 @@ -274,7 +274,7 @@ 创建一个队列，创建时可以设定队列长度和队列结点大小。 -**输入**： 队列节点个数、每个队列节点大小、队列ID指针。 +**输入**：队列节点个数、每个队列节点大小、队列ID指针。 **处理**： @@ -503,7 +503,7 @@ **处理**：清除所有的中断请求位或指定的中断请求位。 -**输出**：所有的中断请求位或指定的中断请求位被清除 +**输出**：所有的中断请求位或指定的中断请求位被清除。 ## 定时器 @@ -527,7 +527,7 @@ 删除指定的定时器。 -**输入**： 定时器句柄 +**输入**： 定时器句柄。 **处理**：根据传入的定时器句柄，找到定时器控制块，将其内容清空并将控制块挂接到相应的空闲链表中。 @@ -540,7 +540,7 @@ 指定的定时器开始计时。 -**输入**： 定时器句柄 +**输入**： 定时器句柄。 **处理**：对于软件定时器，根据当前Tick计数以及定时器周期，计算结束时间，将此定时器控制块挂入定时器SortLink。 @@ -566,7 +566,7 @@ 指定的定时器重新开始计时。 -**输入**：定时器句柄 +**输入**：定时器句柄。 **处理**：对于软件定时器，根据当前Tick计数以及定时器周期，计算结束时间，将此定时器控制块挂入定时器SortLink。 @@ -623,7 +623,7 @@ 申请指定的信号量，若其计数值大于0，则直接将计数值减1返回，否则发生任务阻塞，等待时间可通过入参设定。 -**输入**：信号量句柄、等待时间 +**输入**：信号量句柄、等待时间。 **处理**： @@ -659,14 +659,14 @@ **输出**： -- 成功：指定信号量的计数值被修改； +- 成功：指定信号量的计数值被修改。 - 失败：返回错误码。 ### 信号量计数值获取 获取指定信号量计数值。 -**输入**： 信号量句柄 +**输入**： 信号量句柄。 **处理**：根据输入的信号量句柄，找到相应的信号量控制块，将控制块中记录的信号量计数值返回。 @@ -747,7 +747,7 @@ **输入**：告警阈值、恢复阈值。 -**处理**：设置 CPUP 告警阈值和恢复阈值 +**处理**：设置 CPUP 告警阈值和恢复阈值。 **输出**： @@ -778,7 +778,7 @@ **输出**： - 成功：注册成功。 -- 失败：错误码 +- 失败：错误码。 ## OS启动 @@ -791,7 +791,7 @@ **输出**： - 成功：返回OK。 -- 失败：错误码 +- 失败：错误码。 ### 用户业务入口 @@ -802,7 +802,7 @@ PRT_AppInit 用户业务函数入口，在 main 函数后调用，在此函数 **输出**： - 成功：返回OK。 -- 失败：错误码 +- 失败：错误码。 ### 硬件驱动初始化入口 @@ -813,7 +813,7 @@ PRT_HardDrvInit 硬件驱动初始化函数入口，在 main 函数后调用， **输出**： - 成功：返回OK。 -- 失败：错误码 +- 失败：错误码。 ### 硬件启动流程入口 @@ -841,7 +841,7 @@ PRT_HardBootInit 在 OS 启动时调用，在main函数前被调用，可以用 ### 消息接收函数 -接收消息，并触发SGI中断 +接收消息，并触发SGI中断。 **输入**： @@ -3047,7 +3047,7 @@ errno： **参数**： 1. timespec结构体指针ts。 -2. 时基base +2. 时基base。 **输出**： @@ -3060,11 +3060,11 @@ errno： #### wcsftime -暂不支持 +暂不支持。 #### wcsftime_l -暂不支持 +暂不支持。 ### 内存管理 diff --git a/docs/zh/embedded/uniproton/uniproton_functions.md b/docs/zh/embedded/uniproton/uniproton_functions.md index d3c5480cf..09a287c5d 100644 --- a/docs/zh/embedded/uniproton/uniproton_functions.md +++ b/docs/zh/embedded/uniproton/uniproton_functions.md @@ -10,9 +10,9 @@ UniProton任务管理模块提供任务创建、任务删除、任务挂起、 ## 支持事件管理 -事件机制可以实现线程之间的通讯。事件通讯只能是事件类型的通讯，无数据传输。 +事件机制可以实现线程之间的通讯。事件通讯只能是事件类型的通讯，无数据传输。 -UniProton事件作为任务的扩展，实现任务之间的通讯。每个任务支持32种类型事件（32个 bit位，每bit代表一种事件类型）。 +UniProton事件作为任务的扩展，实现任务之间的通讯。每个任务支持32种类型事件（32个 bit位，每bit代表一种事件类型）。 UniProton提供读取本任务事件和写指定任务事件的功能。读事件时可以同时读取多种事件，也可以只读取一种事件，写事件时也可以同时写一种或多种类型事件。 @@ -139,11 +139,11 @@ OpenAMP是一个开源软件框架，旨在通过非对称多处理器的开源 ## 支持POSIX标准接口 -[UniProton支持posix标准接口](./uniproton_apis.md) +《[UniProton支持posix标准接口](./uniproton_apis.md)》 ## 支持设备驱动 -UniProton的驱动结构、风格与linux类似，将驱动设备文件化，即VFS系统，通过驱动注册接口，将驱动注册到文件系统中，应用层只需要通过标准系统调用，即可调用底层驱动。整个驱动框架代码适配自开源RTOS系统Nuttx的驱动模块，因此接口调用也与Nuttx基本一致。struct file_operations结构体保存设备文件操作的方法，定义在fs.h头文件中，通过register_driver接口将驱动设备挂到对应的struct inode节点中，struct inode描述了每个设备节点的位置和数据。当系统调用操作设备文件时，根据对应文件的inode就能索引到对应的函数。接口详细信息可以查看[UniProton接口说明](./uniproton_apis.md)。 +UniProton的驱动结构、风格与linux类似，将驱动设备文件化，即VFS系统，通过驱动注册接口，将驱动注册到文件系统中，应用层只需要通过标准系统调用，即可调用底层驱动。整个驱动框架代码适配自开源RTOS系统Nuttx的驱动模块，因此接口调用也与Nuttx基本一致。struct file_operations结构体保存设备文件操作的方法，定义在fs.h头文件中，通过register_driver接口将驱动设备挂到对应的struct inode节点中，struct inode描述了每个设备节点的位置和数据。当系统调用操作设备文件时，根据对应文件的inode就能索引到对应的函数。接口详细信息可以查看《[UniProton接口说明](./uniproton_apis.md)》。 ## 支持Shell命令行 diff --git a/docs/zh/server/administration/administrator/configuring_the_web_server.md b/docs/zh/server/administration/administrator/configuring_the_web_server.md index db694de7f..4f6ebf9f0 100644 --- a/docs/zh/server/administration/administrator/configuring_the_web_server.md +++ b/docs/zh/server/administration/administrator/configuring_the_web_server.md @@ -89,7 +89,7 @@ openEuler系统中的web服务器版本是Apache HTTP服务器2.4版本，即htt #### 验证服务状态 -验证httpd服务是否正在运行 +验证httpd服务是否正在运行。 ```shell # systemctl is-active httpd diff --git a/docs/zh/server/development/gcc/_toc.yaml b/docs/zh/server/development/gcc/_toc.yaml index 45aaeacbc..a3bf8a8c0 100644 --- a/docs/zh/server/development/gcc/_toc.yaml +++ b/docs/zh/server/development/gcc/_toc.yaml @@ -8,4 +8,6 @@ sections: - label: 内核反馈优化特性 href: ./kernel_fdo_user_guide.md - label: 全场景链接时二进制库内联优化 - href: ./link_time_binary_library_inlining_optimization.md \ No newline at end of file + href: ./link_time_binary_library_inlining_optimization.md + - label: GCC插件框架特性用户指南 + href: ./pin_user_guide.md \ No newline at end of file diff --git a/docs/zh/tools/community_tools/pin/pin_user_guide.md b/docs/zh/server/development/gcc/pin_user_guide.md similarity index 100% rename from docs/zh/tools/community_tools/pin/pin_user_guide.md rename to docs/zh/server/development/gcc/pin_user_guide.md diff --git a/docs/zh/server/diversified_computing/dpu_offload/imperceptible_container_management_plane_offload.md b/docs/zh/server/diversified_computing/dpu_offload/imperceptible_container_management_plane_offload.md index 695aad726..faad9b537 100644 --- a/docs/zh/server/diversified_computing/dpu_offload/imperceptible_container_management_plane_offload.md +++ b/docs/zh/server/diversified_computing/dpu_offload/imperceptible_container_management_plane_offload.md @@ -10,7 +10,7 @@ DPU的出现就是为了将这部分算力资源从主机CPU上解放出来， ## 架构介绍 -#### 容器管理面DPU无感卸载架构 +### 容器管理面DPU无感卸载架构 **图1**容器管理面DPU无感卸载架构 @@ -20,12 +20,12 @@ DPU的出现就是为了将这部分算力资源从主机CPU上解放出来， * 通信层：DPU和主机之间可能通过PCIe或网络进行通信，需要基于底层物理连接提供通信接口层，为上层业务提供通信接口。 -* 内核共享文件系统qtfs：容器管理面组件kubelet、dockerd与容器进程之间的主要交互通过文件系统进行；管理面工具需要为容器进程准备rootfs、volume等数据面路径；还需要在运行时通过proc文件系统、cgroup文件系统等控制和监控容器进程的资源及状态。共享文件系统的详细介绍参考[共享文件系统介绍](qtfs_architecture_and_usage.md) +* 内核共享文件系统qtfs：容器管理面组件kubelet、dockerd与容器进程之间的主要交互通过文件系统进行；管理面工具需要为容器进程准备rootfs、volume等数据面路径；还需要在运行时通过proc文件系统、cgroup文件系统等控制和监控容器进程的资源及状态。共享文件系统的详细介绍参考《[共享文件系统介绍](qtfs_architecture_and_usage.md)》。 * 用户态卸载环境：用户态需要使用qtfs为容器管理面准备卸载后的运行时环境，将主机的容器管理及运行时相关目录远程挂载到DPU；另外由于需要挂载proc、sys、cgroup等系统管理文件系统，为防止对DPU原生系统功能的破坏，上述挂载动作都在chroot环境内完成。另外管理面（运行于DPU）和容器进程（运行于主机）之间仍存在调用关系，需要通过远程二进制执行工具（rexec）提供对应功能。 -容器管理面无感卸载的操作步骤可参考[部署指导文档](./offload_deployment_guide.md) +容器管理面无感卸载的操作步骤可参考《[部署指导文档](./offload_deployment_guide.md)》。 > ![](./public_sys-resources/icon-note.gif)**说明**： > -> 上述操作指导涉及对容器管理面组件的少量改动和rexec工具修改，这些修改基于指定版本，其他版本可基于实际执行环境做适配修改。文档中提供的patch仅供验证指导使用，不具备实际商用的条件 \ No newline at end of file +> 上述操作指导涉及对容器管理面组件的少量改动和rexec工具修改，这些修改基于指定版本，其他版本可基于实际执行环境做适配修改。文档中提供的patch仅供验证指导使用，不具备实际商用的条件。 diff --git a/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md b/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md index 5b0171991..70ba011dd 100644 --- a/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md +++ b/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md @@ -23,7 +23,7 @@ ## **3.1** QTFS文件系统部署 -可参考qtfs主页：https://gitee.com/openeuler/dpu-utilities/tree/master/qtfs +可参考qtfs主页： QTFS建联需要关闭防火墙。 @@ -97,7 +97,7 @@ nohup /usr/bin/udsproxyd 1 192.168.10.11 12121 192.168.10.10 12121 2>&1 & a） 通过配置工具qtcfg加载，进入qtfs/qtinfo目录编译工具： -在qtfs的client端执行 +在qtfs的client端执行： ```bash @@ -105,7 +105,7 @@ make role=client make install ``` -在qtfs的server端执行 +在qtfs的server端执行： ```bash @@ -121,6 +121,7 @@ make install qtcfg -x /var/lib/libvirt/ ``` + 查询白名单为： ```bash @@ -128,6 +129,7 @@ qtcfg -x /var/lib/libvirt/ qtcfg -z ``` + 删除白名单为: ```bash @@ -135,6 +137,7 @@ qtcfg -z qtcfg -y 0 ``` + 删除白名单时，参数为查询白名单时列出来的index序号。 b） 通过配置文件增加，这需要在qtfs或qtfs_server内核模块加载前配置，通过内核模块初始化时读取该文件进行白名单配置。 @@ -207,7 +210,7 @@ systemctl start rexec - 方式2: -手动后台拉起 +手动后台拉起： ```bash @@ -233,7 +236,7 @@ HOST需要放置虚拟机镜像，后面通过qtfs挂载到client端共享给lib #### 3.4.2.1 创建chroot环境 -a） 从openEuler官网下载qcow镜像，例如23.09版本https://repo.openeuler.org/openEuler-23.09/virtual_machine_img/。 +a） 从openEuler官网下载qcow镜像，例如23.09版本。 b） 将qcow2挂载出来： @@ -291,7 +294,7 @@ c）下载libvirt-x.x.x。源码包：https://libvirt.org/sources/libvirt-x.x.x. d） 获取直连聚合libvirt patch： -https://gitee.com/openeuler/dpu-utilities/tree/master/usecases/transparent-offload/patches/libvirt + e）将源码包解压到chroot环境下的目录，如/home。将patch打上。 @@ -303,7 +306,7 @@ meson build --prefix=/usr -Ddriver_remote=enabled -Ddriver_network=enabled -Ddri ``` -g） 安装成功 +g） 安装成功。 ```bash diff --git a/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md b/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md index 8363931a6..851e5ed5a 100644 --- a/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md +++ b/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md @@ -55,7 +55,7 @@ kubelet暂不需要功能性改动，可能会遇到容器QoS管理器首次设 创建容器管理面所需要的文件夹，然后插入qtfs_server.ko，并拉起engine进程。 -此外在服务器端，还需要创建rexec脚本/usr/bin/dockerd. +此外在服务器端，还需要创建rexec脚本/usr/bin/dockerd。 ``` shell #!/bin/bash @@ -138,7 +138,7 @@ CMD_NET_ADDR=tcp://<服务端ip>: /usr/bin/rexec /usr/bin/kill $ CMD_NET_ADDR=tcp://<服务端ip>: /usr/bin/rexec /usr/sbin/modprobe $* ``` -在chroot到dockerd和containerd运行所需的rootfs后，用如下的命令拉起dockerd和containerd +在chroot到dockerd和containerd运行所需的rootfs后，用如下的命令拉起dockerd和containerd。 * containerd diff --git a/docs/zh/server/installation_upgrade/installation/installation_guide.md b/docs/zh/server/installation_upgrade/installation/installation_guide.md index 77bc9ddbd..a9611e7b7 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_guide.md +++ b/docs/zh/server/installation_upgrade/installation/installation_guide.md @@ -58,7 +58,7 @@ 可以通过键盘操作图形化安装程序。 -- “Tab”、“shift Tab”：界面控件（按钮、区域框、复选框等）间的移动。 +- “Tab”、“Shift Tab”：界面控件（按钮、区域框、复选框等）间的移动。 - “↑”、“↓”方向键：列表里的移动。 - “←”、“→”方向键：水平工具条和表条间移动。 - “空格”、“Enter”：选择或删除高亮显示的选项、展开或折叠下拉菜单。 @@ -199,7 +199,7 @@ >![](./public_sys-resources/icon-note.gif) **说明：** > >- 在进行分区时，出于系统性能和安全的考虑，建议您划分如下单独分区：/boot、/var、/var/log、/var/log/audit、/home、/tmp。 分区建议如[表1](#table1)所示。 ->- 系统如果配置了swap分区，当系统的物理内存不够用时，会使用swap分区。虽然 swap分区可以增大物理内存大小的限制，但是如果由于内存不足使用到swap分区，会增加系统的响应时间，性能变差。因此在物理内存充足或者性能敏感的系统中，不建议配置swap分区。 +>- 系统如果配置了swap分区，当系统的物理内存不够用时，会使用swap分区。虽然swap分区可以增大物理内存大小的限制，但是如果由于内存不足使用到swap分区，会增加系统的响应时间，性能变差。因此在物理内存充足或者性能敏感的系统中，不建议配置swap分区。 >- 如果需要拆分逻辑卷组则需要选择“自定义”进行手动分区，并在“手动分区”界面单击“卷组”区域中的“修改”按钮重新配置卷组。 **表1** 磁盘分区建议 @@ -229,7 +229,7 @@ 在“手动分区”界面可以通过如下两种方式进行分区，分区完成后如[图13](#fig1277151815248)所示。 -- 自动创建：在界面单击“点击这里自动创建它们”，系统会根据可用的存储空间，自动分出5个挂载点：/boot、/、/home、/boot/efi、swap。 +- 自动创建：在界面单击“点击这里自动创建它们”，系统会根据可用的存储空间，自动分出5个挂载点：/boot、/、/home、/boot/efi、/swap。 - 手动创建：单击“![](./figures/zh-cn_image_0229291243.png)”添加新挂载点，建议每个挂载点的期望容量不超过可用空间。 @@ -264,20 +264,20 @@ ## 设置Root帐户 -在“安装概览”页面中选择“Root帐户”，弹出设置“ROOT帐户”界面，如[图16](#zh-cn_topic_0186390266_zh-cn_topic_0122145909_fig1323165793018)所示，根据[密码复杂度](#密码复杂度)输入密码并再次输入密码进行确认。 +在“安装概览”页面中选择“Root帐户”，弹出设置“Root帐户”界面，如[图16](#zh-cn_topic_0186390266_zh-cn_topic_0122145909_fig1323165793018)所示，根据[密码复杂度](#密码复杂度)输入密码并再次输入密码进行确认。 >![](./public_sys-resources/icon-note.gif) **说明：** > ->- root帐户是用来执行关键系统管理任务，不建议您在日常工作及系统访问时使用root帐户。 +>- Root帐户是用来执行关键系统管理任务，不建议您在日常工作及系统访问时使用root帐户。 > ->- 在“ROOT帐户”界面若选择“禁用root帐户”则root帐户将禁用。 +>- 在“Root帐户”界面若选择“禁用Root帐户”则Root帐户将禁用。 **图 16** root帐户 ![](./figures/root_password.png) ### 密码复杂度 -用户设置的root用户密码或新创建用户的密码均需要满足密码复杂度要求，否则会导致密码设置或用户创建失败。设置密码的复杂度的要求如下： +用户设置的Root用户密码或新创建用户的密码均需要满足密码复杂度要求，否则会导致密码设置或用户创建失败。设置密码的复杂度的要求如下： 1. 口令长度至少8个字符。 2. 口令至少包含大写字母、小写字母、数字和特殊字符中的任意3种。 diff --git a/docs/zh/server/installation_upgrade/installation/installation_modes.md b/docs/zh/server/installation_upgrade/installation/installation_modes.md index e9ebf0890..70e888ed2 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_modes.md +++ b/docs/zh/server/installation_upgrade/installation/installation_modes.md @@ -86,7 +86,7 @@ # dd if=/home/testuser/Downloads/openEuler-{version}-aarch64-dvd.iso of=/dev/sdb bs=512k ``` >![](./public_sys-resources/icon-note.gif) **说明：** ->如isolinux描述，由mkisofs命令创建的ISO 9660 文件系统会通过BIOS固件启动，但只能从CD、DVD和BD等介质启动。所以在使用dd命令制作x86的启动U盘前需要使用 isohybrid -u your.iso 对iso进行处理，然后正常使用dd命令将iso写入u盘即可（该问题仅影响X86）。 +>如isolinux描述，由mkisofs命令创建的ISO 9660 文件系统会通过BIOS固件启动，但只能从CD、DVD和BD等介质启动。所以在使用dd命令制作x86的启动U盘前需要使用 isohybrid -u your.iso 对iso进行处理，然后正常使用dd命令将iso写入u盘即可（该问题仅影响x86）。 5. 等待镜像写入完成，拔掉USB盘。 diff --git a/docs/zh/server/installation_upgrade/installation/installation_preparations.md b/docs/zh/server/installation_upgrade/installation/installation_preparations.md index 004989c11..c3aea4eec 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_preparations.md +++ b/docs/zh/server/installation_upgrade/installation/installation_preparations.md @@ -24,7 +24,7 @@ >![](./public_sys-resources/icon-note.gif) **说明：** > -> - 网络安装方式的 ISO 发布包较小，在有网络的安装环境可以选择网络安装方式。 +> - 网络安装方式的 iso 发布包较小，在有网络的安装环境可以选择网络安装方式。 > - AArch64架构的发布包支持UEFI模式，x86_64架构的发布包支持UEFI模式和Legacy模式。 ## 发布包完整性校验 @@ -44,7 +44,7 @@ - iso文件：openEuler-24.03-LTS-SP1-aarch64-dvd.iso。 -- 校验文件：ISO对应完整性校验值，复制保存对应的ISO值。 +- 校验文件：iso对应完整性校验值，复制保存对应的iso值。 ### 操作指导 diff --git a/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md b/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md index e265cd02a..74b3e5ebd 100644 --- a/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md +++ b/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md @@ -34,7 +34,7 @@ > 推荐使用设备板载 `RJ45` 网口而非厂家附送的 `PCIe` 电口网卡。 > -> 设备出厂未附送 `WiFi` 网卡，不具备 `WiFi` 或蓝牙连接能力。如有需要请自备对应设备。 +> 设备出厂未附送 `Wi-Fi` 网卡，不具备 `Wi-Fi` 或蓝牙连接能力。如有需要请自备对应设备。 ## 镜像种类 @@ -55,13 +55,13 @@ > `Image` 镜像支持 `Legacy` 方式启动，对应下文的**非 UEFI 版**固件 -从官网下载页面获取内含镜像 `Image` 的 `Zip` 压缩包（如 `openEuler-24.03-LTS-SP1-riscv64-sg2042.img.zip`），并将其直接烧录至 **SDCARD** 或 **固态硬盘** 中即可。 +从官网下载页面获取内含镜像 `Image` 的 `ZIP` 压缩包（如 `openEuler-24.03-LTS-SP1-riscv64-sg2042.img.zip`），并将其直接烧录至 **SD Card** 或 **固态硬盘** 中即可。 ## 设备固件 > 因设备出厂固件目前并未支持 `UEFI`，`ISO` 版本使用者需先手动替换固件为基于 `EDK2` 的 `UEFI` 版固件。 > -从官网下载页面 **嵌入式分类** 中下载设备固件压缩包：`sg2042_firmware_uefi.zip`，解压后烧录其中 `img` 文件至 **SDCARD** +从官网下载页面 **嵌入式分类** 中下载设备固件压缩包：`sg2042_firmware_uefi.zip`，解压后烧录其中 `img` 文件至 **SD Card** ```txt ~$ sudo dd if=firmware_single_sg2042-master.img of=/dev/sda bs=512K iflag=fullblock oflag=direct conv=fsync status=progress @@ -74,9 +74,9 @@ > 因设备出厂固件版本较老，Image 镜像使用者如果想要使用较新版本的固件，可以更新**非 UEFI 版**固件。 > -从官网下载页面 **嵌入式分类** 中下载设备固件压缩包：`sg2042_firmware_uboot.zip`，参考 UEFI 版固件的操作，解压后烧录其中 img 文件至 **SDCARD**。 +从官网下载页面 **嵌入式分类** 中下载设备固件压缩包：`sg2042_firmware_uboot.zip`，参考 UEFI 版固件的操作，解压后烧录其中 img 文件至 **SD Card**。 -烧录完成后，请将 **SDCARD** 插入设备的卡槽中。 +烧录完成后，请将 **SD Card** 插入设备的卡槽中。 ## 启动前检查 diff --git a/docs/zh/server/installation_upgrade/installation/using_kickstart_for_automatic_installation.md b/docs/zh/server/installation_upgrade/installation/using_kickstart_for_automatic_installation.md index 7fb632cc6..0c3bf3072 100644 --- a/docs/zh/server/installation_upgrade/installation/using_kickstart_for_automatic_installation.md +++ b/docs/zh/server/installation_upgrade/installation/using_kickstart_for_automatic_installation.md @@ -51,7 +51,7 @@ kickstart 安装提供一个安装过程自动化的方法，可以是部分自 **PXE** -PXE（Pre-boot Execution Environment，预启动执行环境），工作于Client/Server的网络模式，支持PXE的客户端在启动过程中，能够从DHCP服务器获取IP，结合TFTP（trivial file transfer protocol）等协议可以实现客户端的网络引导和安装。 +PXE（Pre-boot Execution Environment，预启动执行环境），工作于Client/Server的网络模式，支持PXE的客户端在启动过程中，能够从DHCP服务器获取IP，结合TFTP（Trivial File Transfer Protocol）等协议可以实现客户端的网络引导和安装。 **TFTP** @@ -65,7 +65,7 @@ TFTP（Trivial File Transfer Protocol，简单文件传输协议），该协议 - 物理机/虚拟机（虚拟机创建可参考对应厂商的资料）。包括使用kickstart工具进行自动化安装的计算机和被安装的计算机。 - httpd：存放kickstart文件。 -- ISO： openEuler-{version}-aarch64-dvd.iso +- ISO：openEuler-{version}-aarch64-dvd.iso。 ### 操作步骤 @@ -185,7 +185,7 @@ TFTP（Trivial File Transfer Protocol，简单文件传输协议），该协议 - 物理机/虚拟机（虚拟机创建可参考对应厂商的资料）。包括使用kickstart工具进行自动化安装的计算机和被安装的计算机。 - httpd：存放kickstart文件。 - tftp：提供vmlinuz和initrd文件。 -- dhcpd/pxe：提供DHCP服务。 +- dhcpd/PXE：提供DHCP服务。 - ISO：openEuler-{version}-aarch64-dvd.iso。 ### 操作步骤 diff --git a/docs/zh/server/installation_upgrade/upgrade/_toc.yaml b/docs/zh/server/installation_upgrade/upgrade/_toc.yaml index b88809a6c..6c60e7456 100644 --- a/docs/zh/server/installation_upgrade/upgrade/_toc.yaml +++ b/docs/zh/server/installation_upgrade/upgrade/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 升级 openEuler 操作系统 sections: - label: 升降级指导 - href: ./openeuler_22.03_lts_upgrade_and_downgrade_guide.md + href: ./openEuler_22.03_lts_upgrade_and_downgrade_guide.md diff --git a/docs/zh/server/quickstart/quickstart/quick_start.md b/docs/zh/server/quickstart/quickstart/quick_start.md index 9f6d704b0..b7cf93897 100644 --- a/docs/zh/server/quickstart/quickstart/quick_start.md +++ b/docs/zh/server/quickstart/quickstart/quick_start.md @@ -253,6 +253,7 @@ iso文件：openEuler-24.03-LTS-SP1-aarch64-dvd.iso 3. 单击“开始安装”进行系统安装，如[图13](#fig1717019357392)所示。 **图 13** 开始安装 + ![](./figures/Installation_Procedure.png) 4. 安装完成后重启系统。 diff --git a/docs/zh/server/releasenotes/releasenotes/contribution.md b/docs/zh/server/releasenotes/releasenotes/contribution.md index 24acc55ac..2ca0b88e8 100644 --- a/docs/zh/server/releasenotes/releasenotes/contribution.md +++ b/docs/zh/server/releasenotes/releasenotes/contribution.md @@ -1,10 +1,10 @@ # 参与贡献 -作为openEuler用户，你可以通过多种方式协助openEuler社区。参与社区贡献的方法请参见[贡献攻略](https://www.openeuler.org/zh/community/contribution/)，这里简单列出部分方式供参考。 +作为openEuler用户，你可以通过多种方式协助openEuler社区。参与社区贡献的方法请参见《[贡献攻略](https://www.openeuler.org/zh/community/contribution/)》，这里简单列出部分方式供参考。 ## 特别兴趣小组 -openEuler将拥有共同兴趣的人们聚在一起，组成了不同的特别兴趣小组（SIG）。当前已有的SIG请参见[SIG列表](https://www.openeuler.org/zh/sig/sig-list/)。 +openEuler将拥有共同兴趣的人们聚在一起，组成了不同的特别兴趣小组（SIG）。当前已有的SIG请参见《[SIG列表](https://www.openeuler.org/zh/sig/sig-list/)》。 我们欢迎并鼓励你加入已有的SIG或创建新的SIG，创建方法请参见《[SIG管理指南](https://gitee.com/openeuler/community/blob/master/zh/technical-committee/governance/README.md)》。 diff --git a/docs/zh/tools/community_tools/pin/_toc.yaml b/docs/zh/tools/community_tools/pin/_toc.yaml deleted file mode 100644 index 5d2b6b2bd..000000000 --- a/docs/zh/tools/community_tools/pin/_toc.yaml +++ /dev/null @@ -1,6 +0,0 @@ -label: GCC插件框架特性用户指南 -isManual: true -description: GCC插件框架特性用户指南 -sections: - - label: GCC插件框架特性用户指南 - href: ./pin_user_guide.md -- Gitee From 923dd75feca767059d9785e24441f7c8e8de60f7 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 11:31:28 +0800 Subject: [PATCH 02/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9markdowlint=E9=97=AE?= =?UTF-8?q?=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...n_aggregation_environment_establishment.md | 8 +- .../secgear/introduction_to_secgear.md | 171 ++++++++++++++++++ 2 files changed, 177 insertions(+), 2 deletions(-) create mode 100644 docs/zh/server/security/secgear/introduction_to_secgear.md diff --git a/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md b/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md index 70ba011dd..ebc598f10 100644 --- a/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md +++ b/docs/zh/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md @@ -105,6 +105,7 @@ make role=client make install ``` + 在qtfs的server端执行： ```bash @@ -162,6 +163,7 @@ rexec是一个用c语言开发的远程执行组件，分为rexec client和rexec chmod 400 /etc/rexec/whitelist ``` + 如果想仅用于测试，可以不进行白名单配置，删除此文件重启rexec_server进程后则没有白名单限制。 下载dpu-utilities代码后，进入qtfs/rexec主目录下，执行：`make && make install`即可安装rexec所需全部二进制到/usr/bin目录下，包括了：`rexec、rexec_server`两个二进制可执行文件。 @@ -280,6 +282,7 @@ yum groupinstall "Development tools" -y yum install -y vim meson qemu qemu-img strace edk2-aarch64 tar ``` + 其中edk2-aarch64是arm环境下虚拟机启动需要的。 b） 安装libvirt编译需要的依赖包： @@ -290,7 +293,7 @@ yum install -y rpcgen python3-docutils glib2-devel gnutls-devel libxml2-devel li ``` -c）下载libvirt-x.x.x。源码包：https://libvirt.org/sources/libvirt-x.x.x.tar.xz。 +c）下载libvirt-x.x.x。源码包：。 d） 获取直连聚合libvirt patch： @@ -344,7 +347,8 @@ f） 配置好chroot环境后，进入chroot环境，手动拉起libvirtd。 LD_PRELOAD=/usr/lib64/libudsproxy.so virtlogd -d LD_PRELOAD=/usr/lib64/libudsproxy.so libvirtd -d -```` +``` + 如果已配置qtfs使用udsproxyd白名单，则不需要增加LD_PRELOAD前缀： ```bash diff --git a/docs/zh/server/security/secgear/introduction_to_secgear.md b/docs/zh/server/security/secgear/introduction_to_secgear.md new file mode 100644 index 000000000..68be2f523 --- /dev/null +++ b/docs/zh/server/security/secgear/introduction_to_secgear.md @@ -0,0 +1,171 @@ +# 认识secGear + +## 概述 + +随着云计算的快速发展，越来越多的企业把计算业务部署到云上，面对第三方云基础设施，云上用户数据安全面临着巨大的挑战。机密计算是一种基于硬件可信执行环境的隐私保护技术，旨在依赖最底层硬件，构建最小信任依赖，将操作系统、Hypervisor、基础设施、系统管理员、服务提供商等都从信任实体列表中删除，视为未经授权的实体，从而减少潜在的风险，保护可信执行环境中数据的机密性、完整性。然而随着机密计算技术的兴起，业界机密计算技术种类繁多（如主流的Intel SGX、ARM Trustzone、RISC-V keystone等），各技术SDK也千差万别，给开发者带来较大的开发维护成本，长远考虑，还造成了机密计算应用生态隔离。为方便开发者快速构建保护云上数据安全的机密计算解决方案，openEuler推出机密计算统一开发框架secGear。 + +## 架构介绍 + +![](./figures/secGear_arch.png) + +secGear机密计算统一开发框架技术架构如图所示，主要包括三层，共同组成openEuler机密计算软件生态底座。 + +- Base Layer：机密计算SDK统一层，屏蔽TEE及SDK差异，实现不同架构共源码。 +- Middleware Layer：通用组件层，机密计算软件货架，无需从头造轮子，帮助用户快速构建机密计算解决方案。 +- Server Layer：机密计算服务层，提供典型场景机密计算解决方案。 + +## 关键特性 + +### 零切换 + +#### 客户痛点 + +传统应用做机密计算拆分改造后，REE侧逻辑存在频繁调用TEE侧逻辑时或REE与TEE存在频繁大块数据交互时。由于REE与TEE之间的每次调用，都需要经过REE用户态 、REE内核态、驱动、TEE内核态、TEE用户态之间的上下文切换，调用传递的大块数据也要经过多次拷贝，并且驱动底层数据块大小限制等因素，频繁的REE与TEE交互性能直线下降，严重影响机密计算应用的落地。 + +#### 解决方案 + +[零切换](https://gitee.com/openeuler/secGear#switchless%E7%89%B9%E6%80%A7)是一种通过共享内存减少REE与TEE上下文切换及数据拷贝次数，优化REE与TEE交互性能的技术。 + +#### 使用方法 + +1. 创建enclave时启用零切换 + + 零切换配置项及说明如下。 + + ```c + typedef struct { + uint32_t num_uworkers; + uint32_t num_tworkers; + uint32_t switchless_calls_pool_size; + uint32_t retries_before_fallback; + uint32_t retries_before_sleep; + uint32_t parameter_num; + uint32_t workers_policy; + uint32_t rollback_to_common; + cpu_set_t num_cores; + } cc_sl_config_t; + ``` + + | 配置项 | 说明 | + | -------------------------- | ------------------------------------------------------------ | + | num_uworkers | 非安全侧代理工作线程数，用于执行switchless OCALL，当前该字段仅在SGX平台生效，ARM平台可以配置，但是因ARM平台暂不支持OCALL，所以配置后不会生效。
规格：
ARM：最大值：512；最小值：1；缺省值：8（配置为0时）
SGX：最大值：4294967295；最小值：1 | + | num_tworkers | 安全侧代理工作线程数，用于执行switchless ECALL。
规格：
ARM：最大值：512；最小值：1；缺省值：8（配置为0时）
SGX：最大值：4294967295；最小值：1 | + | switchless_calls_pool_size | switchless调用任务池的大小，实际可容纳switchless_calls_pool_size * 64个switchless调用任务（例：switchless_calls_pool_size=1，可容纳64个switchless调用任务）。
规格：
ARM：最大值：8；最小值：1；缺省值：1（配置为0时）
SGX：最大值：8；最小值：1；缺省值：1（配置为0时） | + | retries_before_fallback | 执行retries_before_fallback次汇编pause指令后，若switchless调用仍没有被另一侧的代理工作线程执行，就回退到switch调用模式，该字段仅在SGX平台生效。
规格：SGX：最大值：4294967295；最小值：1；缺省值：20000（配置为0时） | + | retries_before_sleep | 执行retries_before_sleep次汇编pause指令后，若代理工作线程一直没有等到有任务来，则进入休眠状态，该字段仅在SGX平台生效。
规格： SGX：最大值：4294967295；最小值：1；缺省值：20000（配置为0时） | + | parameter_num | switchless函数支持的最大参数个数，该字段仅在ARM平台生效。
规格： ARM：最大值：16；最小值：0 | + | workers_policy | switchless代理线程运行模式，该字段仅在ARM平台生效。
规格： ARM： WORKERS_POLICY_BUSY：代理线程一直占用CPU资源，无论是否有任务需要处理，适用于对性能要求极高且系统软硬件资源丰富的场景； WORKERS_POLICY_WAKEUP：代理线程仅在有任务时被唤醒，处理完任务后进入休眠，等待再次被新任务唤醒 | + | rollback_to_common | 异步switchless调用失败时是否回退到普通调用，该字段仅在ARM平台生效。
规格： ARM：0：否，失败时仅返回相应错误码；其他：是，失败时回退到普通调用，此时返回普通调用的返回值 | + | num_cores | 用于设置安全侧线程绑核
规格： 最大值为当前环境CPU核数 | + +2. 定义EDL文件中接口时添加零切换标识transition_using_threads + + ```ocaml + enclave { + include "secgear_urts.h" + from "secgear_tstdc.edl" import *; + from "secgear_tswitchless.edl" import *; + trusted { + public int get_string([out, size=32]char *buf); + public int get_string_switchless([out, size=32]char *buf) transition_using_threads; + }; + }; + ``` + +### 安全通道 + +#### 客户痛点 + +数据拥有者在请求云上机密计算服务时，需要把待处理数据上传到云上TEE环境中处理，由于TEE没有网络，用户数据需要经过网络先传输到REE，REE接收到数据的明文后，再传入TEE中。用户数据的明文暴露在REE内存中，存在安全风险。 + +#### 解决方案 + +安全通道是一种结合机密计算远程证明，实现数据拥有者与云上TEE之间安全的密钥协商技术，协商出仅数据拥有者与云上TEE拥有的sessionkey，再通过sessionkey加密用户数据，网络传输的是sessionkey加密后的数据，REE接收到密文数据，再传入TEE中解密，处理。 + +#### 使用方法 + +安全通道以lib库方式提供，分为客户端、服务端host、服务端enclave三部分，分别由业务程序的客户端、服务端CA、服务端TA调用。 +| 模块 | 头文件 | 库文件 | 依赖 | +|------------|--------------------------|-----------------------|---------| +| 客户端 | secure_channel_client.h | libcsecure_channel.so | openssl | +| 服务端host | secure_channel_host.h | libusecure_channel.so | openssl | +| 服务端enclave | secure_channel_enclave.h | libtsecure_channel.so | TEE及TEE软件栈 | + +##### 接口列表 + +| 接口名 | 所属头文件、库 | 功能 | 备注 | +|----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|--------------|----| +| cc_sec_chl_client_init | secure_channel_client.h libcsecure_channel.so | 安全通道客户端初始化 | 调用前需初始化参数ctx中网络连接和消息发送钩子函数 | +| cc_sec_chl_client_fini | secure_channel_client.h libcsecure_channel.so | 安全通道客户端销毁 | 通知服务端销毁本客户端的信息，销毁本地安全通道信息 | +| cc_sec_chl_client_callback | secure_channel_client.h libcsecure_channel.so | 安全通道协商消息处理函数 | 处理安全通道协商过程中，服务端发送给客户端的消息。在客户端消息接收处调用 | +| cc_sec_chl_client_encrypt | secure_channel_client.h libcsecure_channel.so | 安全通道客户端的加密接口 | 无 | +| cc_sec_chl_client_decrypt | secure_channel_client.h libcsecure_channel.so | 安全通道客户端的解密接口 | 无 | +| int (*cc_conn_opt_funcptr_t)(void *conn, void *buf, size_t count); | secure_channel.h | 消息发送钩子函数原型 | 由用户客户端和服务端实现，实现中指定安全通道协商消息类型，负责发送安全通道协商消息到对端 | +| cc_sec_chl_svr_init | secure_channel_host.h libusecure_channel.so | 安全通道服务端初始化 | 调用前需初始化ctx中enclave_ctx | +| cc_sec_chl_svr_fini | secure_channel_host.h libusecure_channel.so | 安全通道服务端销毁 | 销毁安全通道服务端以及所有客户端信息 | +| cc_sec_chl_svr_callback | secure_channel_host.h libusecure_channel.so | 安全通道协商消息处理函数 | 处理安全通道协商过程中，客户端发送给服务端的消息。在服务端消息接收处调用，调用前需初始化与客户端的网络连接和发送消息函数，详见[样例](https://gitee.com/openeuler/secGear/blob/master/examples/secure_channel/host/server.c#:~:text=conn_ctx.conn_kit.send)。 | +| cc_sec_chl_enclave_encrypt | secure_channel_enclave.h libtsecure_channel.so | 安全通道enclave中的加密接口 | 无 | +| cc_sec_chl_enclave_decrypt | secure_channel_enclave.h libtsecure_channel.so | 安全通道enclave中的解密接口 | 无 | + +##### 注意事项 + +安全通道仅封装密钥协商过程、加解密接口，不建立网络连接，协商过程复用业务的网络连接。其中客户端和服务端的网络连接由业务建立和维护，在安全通道客户端和服务端初始化时传入消息发送钩子函数和网络连接指针。 +详见[安全通道样例](https://gitee.com/openeuler/secGear/tree/master/examples/secure_channel)。 + +### 远程证明 + +#### 客户痛点 + +随着机密计算技术的发展，逐渐形成几大主流技术（如Arm Trustzone/CCA、Intel SGX/TDX、擎天Enclave、海光CSV等），产品解决方案中可能存在多种机密计算硬件，甚至不同TEE之间的协同，其中远程证明是任何一种机密计算技术信任链的重要一环，每种技术的远程证明报告格式及验证流程各有差异，用户对接不同的TEE，需要集成不同TEE证明报告的验证流程，增加了用户的集成负担，并且不利于扩展新的TEE类型。 + +#### 解决方案 + +secGear远程证明统一框架是机密计算远程证明相关的关键组件，屏蔽不同TEE远程证明差异，提供Attestation Agent和Attestation Service两个组件，Agent供用户集成获取证明报告，对接证明服务；Service可独立部署，支持iTrustee、virtCCA远程证明报告的验证。 + +#### 功能描述 + +远程证明统一框架聚焦机密计算相关功能，部署服务时需要的服务运维等相关能力由服务部署第三方提供。远程证明统一框架的关键技术如下： + +- 报告校验插件框架：支持运行时兼容iTrustee、vritCCA、CCA等不同TEE平台证明报告检验，支持扩展新的TEE报告检验插件。 +- 证书基线管理：支持对不同TEE类型的TCB/TA基线值管理及公钥证书管理，集中部署到服务端，对用户透明。 +- 策略管理：提供默认策略（易用）、用户定制策略（灵活）。 +- 身份令牌：支持对不同TEE签发身份令牌，由第三方信任背书，实现不同TEE类型相互认证。 +- 证明代理：支持对接证明服务/点对点互证，兼容TEE报告获取，身份令牌验证等，易集成，使用户聚焦业务。 + +根据使用场景，支持点对点验证和证明服务验证两种模式。 + +证明服务验证流程如下： + +1.用户（普通节点或TEE）对TEE平台发起挑战。 + +2.TEE平台通过证明代理获取TEE证明报告，并返回给用户。 + +3.用户端证明代理将报告转发到远程证明服务。 + +4.远程证明服务完成报告校验，返回由第三方信任背书的统一格式身份令牌。 + +5.证明代理验证身份令牌，并解析得到证明报告校验结果。 + +6.得到通过的校验结果后，建立安全连接。 + +点对点验证流程(无证明服务)如下： + +1.用户向TEE平台发起挑战，TEE平台返回证明报告给用户。 + +2.用户使用本地点对点TEE校验插件完成报告验证。 + +> ![](./public_sys-resources/icon-note.gif) **说明：** +> +> 点对点验证和远程证明服务验证时的证明代理不同，在编译时可通过编译选项，决定编译有证明服务和点对点模式的证明代理。 + +#### 应用场景 + +在金融、AI等场景下，基于机密计算保护运行中的隐私数据安全时，远程证明是校验机密计算环境及应用合法性的技术手段，远程证明统一框架提供了易集成、易部署的组件，帮助用户快速使能机密计算远程证明能力。 + +## 缩略语 + +| 缩略语 | 英文全名 | 中文解释 | +| ------ | ----------------------------- | ---------------- | +| REE | Rich Execution Environment | 富执行环境 | +| TEE | Trusted Execution Environment | 可信执行环境 | +| EDL | Enclave Description Language | 安全应用描述语言 | -- Gitee From 8f5e984fb33181895e9067d23017025e43d2d225 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 14:31:02 +0800 Subject: [PATCH 03/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E8=99=9A=E6=8B=9F?= =?UTF-8?q?=E5=8C=96=E7=9A=84=E9=93=BE=E6=8E=A5=E5=A4=B1=E6=95=88=E9=97=AE?= =?UTF-8?q?=E9=A2=98=EF=BC=8C=E5=88=A0=E9=99=A4=E5=8D=87=E7=BA=A7=E6=8C=87?= =?UTF-8?q?=E5=AF=BC=E4=B9=A6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../openeuler_22.03_lts_upgrade_and_downgrade_guide.md | 0 .../installation_upgrade/installation/installation_modes.md | 2 +- docs/zh/tools/community_tools/_toc.yaml | 3 --- 3 files changed, 1 insertion(+), 4 deletions(-) rename {docs/zh/server/installation_upgrade/upgrade => archive}/openeuler_22.03_lts_upgrade_and_downgrade_guide.md (100%) diff --git a/docs/zh/server/installation_upgrade/upgrade/openeuler_22.03_lts_upgrade_and_downgrade_guide.md b/archive/openeuler_22.03_lts_upgrade_and_downgrade_guide.md similarity index 100% rename from docs/zh/server/installation_upgrade/upgrade/openeuler_22.03_lts_upgrade_and_downgrade_guide.md rename to archive/openeuler_22.03_lts_upgrade_and_downgrade_guide.md diff --git a/docs/zh/server/installation_upgrade/installation/installation_modes.md b/docs/zh/server/installation_upgrade/installation/installation_modes.md index 70e888ed2..7d493501c 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_modes.md +++ b/docs/zh/server/installation_upgrade/installation/installation_modes.md @@ -164,7 +164,7 @@ 5. 创建虚拟机。 6. 启动虚拟机。 -各步骤详细的操作请参考《[虚拟化用户指南](../../../../zh/virtualization/virtualization_platform/virtualization/introduction_to_virtualization.md)》。 +各步骤详细的操作请参考《[虚拟化用户指南]()》。 ## 通过私有镜像安装 diff --git a/docs/zh/tools/community_tools/_toc.yaml b/docs/zh/tools/community_tools/_toc.yaml index bf08865cc..44feffbde 100644 --- a/docs/zh/tools/community_tools/_toc.yaml +++ b/docs/zh/tools/community_tools/_toc.yaml @@ -13,6 +13,3 @@ sections: - label: epkg软件包 sections: - href: ./epkg_use/_toc.yaml - - label: 编译 - sections: - - href: ./pin/_toc.yaml -- Gitee From 6b460fc1c418dafe8af91936dc71c009c455bc8a Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 14:48:06 +0800 Subject: [PATCH 04/13] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E5=8D=87=E7=BA=A7?= =?UTF-8?q?=E6=8C=87=E5=AF=BC=E4=B9=A6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../installation/installation_modes.md | 23 ++++++++++--------- ...r_22.03_lts_upgrade_and_downgrade_guide.md | 0 2 files changed, 12 insertions(+), 11 deletions(-) rename archive/openeuler_22.03_lts_upgrade_and_downgrade_guide.md => docs/zh/server/installation_upgrade/upgrade/openEuler_22.03_lts_upgrade_and_downgrade_guide.md (100%) diff --git a/docs/zh/server/installation_upgrade/installation/installation_modes.md b/docs/zh/server/installation_upgrade/installation/installation_modes.md index 7d493501c..eedba2878 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_modes.md +++ b/docs/zh/server/installation_upgrade/installation/installation_modes.md @@ -74,19 +74,20 @@ 4. 使用dd命令将ISO安装镜像直接写入USB盘： - ```sh - # dd if=/path/to/image.iso of=/dev/device bs=blocksize - ``` + ```sh + # dd if=/path/to/image.iso of=/dev/device bs=blocksize + ``` -使用您下载的ISO镜像文件的完整路径替换 /path/to/image.iso，使用之前由 dmesg 命令给出的设备名称替换device，同时设置合理的块大小（例如：512k）替换 blocksize，这样可以加快写入进度。 + 使用您下载的ISO镜像文件的完整路径替换 /path/to/image.iso，使用之前由 dmesg 命令给出的设备名称替换device，同时设置合理的块大小（例如：512k）替换 blocksize，这样可以加快写入进度。 -例如：如果该ISO镜像文件位于 /home/testuser/Downloads/openEuler-{version}-aarch64-dvd.iso，同时探测到的设备名称为sdb，则该命令如下： + 例如：如果该ISO镜像文件位于 /home/testuser/Downloads/openEuler-{version}-aarch64-dvd.iso，同时探测到的设备名称为sdb，则该命令如下： - ```sh - # dd if=/home/testuser/Downloads/openEuler-{version}-aarch64-dvd.iso of=/dev/sdb bs=512k - ``` ->![](./public_sys-resources/icon-note.gif) **说明：** ->如isolinux描述，由mkisofs命令创建的ISO 9660 文件系统会通过BIOS固件启动，但只能从CD、DVD和BD等介质启动。所以在使用dd命令制作x86的启动U盘前需要使用 isohybrid -u your.iso 对iso进行处理，然后正常使用dd命令将iso写入u盘即可（该问题仅影响x86）。 + ```sh + # dd if=/home/testuser/Downloads/openEuler-{version}-aarch64-dvd.iso of=/dev/sdb bs=512k + ``` + + >![](./public_sys-resources/icon-note.gif) **说明：** + >如isolinux描述，由mkisofs命令创建的ISO 9660 文件系统会通过BIOS固件启动，但只能从CD、DVD和BD等介质启动。所以在使用dd命令制作x86的启动U盘前需要使用 isohybrid -u your.iso 对iso进行处理，然后正常使用dd命令将iso写入u盘即可（该问题仅影响x86）。 5. 等待镜像写入完成，拔掉USB盘。 @@ -164,7 +165,7 @@ 5. 创建虚拟机。 6. 启动虚拟机。 -各步骤详细的操作请参考《[虚拟化用户指南]()》。 +各步骤详细的操作请参考《[虚拟化用户指南](https://gitee.com/openeuler/Virt-docs/blob/openEuler-24.03-LTS-SP2/docs/zh/virtualization_platform/virtualization/introduction_to_virtualization.md)》。 ## 通过私有镜像安装 diff --git a/archive/openeuler_22.03_lts_upgrade_and_downgrade_guide.md b/docs/zh/server/installation_upgrade/upgrade/openEuler_22.03_lts_upgrade_and_downgrade_guide.md similarity index 100% rename from archive/openeuler_22.03_lts_upgrade_and_downgrade_guide.md rename to docs/zh/server/installation_upgrade/upgrade/openEuler_22.03_lts_upgrade_and_downgrade_guide.md -- Gitee From 989debffb6120153ae0e9de48ee767b34c388aaf Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 14:53:01 +0800 Subject: [PATCH 05/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9markdowlint=E9=97=AE?= =?UTF-8?q?=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../installation_upgrade/installation/installation_modes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/server/installation_upgrade/installation/installation_modes.md b/docs/zh/server/installation_upgrade/installation/installation_modes.md index eedba2878..88e932ca3 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_modes.md +++ b/docs/zh/server/installation_upgrade/installation/installation_modes.md @@ -85,7 +85,7 @@ ```sh # dd if=/home/testuser/Downloads/openEuler-{version}-aarch64-dvd.iso of=/dev/sdb bs=512k ``` - + >![](./public_sys-resources/icon-note.gif) **说明：** >如isolinux描述，由mkisofs命令创建的ISO 9660 文件系统会通过BIOS固件启动，但只能从CD、DVD和BD等介质启动。所以在使用dd命令制作x86的启动U盘前需要使用 isohybrid -u your.iso 对iso进行处理，然后正常使用dd命令将iso写入u盘即可（该问题仅影响x86）。 -- Gitee From 901062041c2fcbcc6af027454e3e9388b85a217a Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 15:06:12 +0800 Subject: [PATCH 06/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9markdowlint=E9=97=AE?= =?UTF-8?q?=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../installation_upgrade/installation/installation_modes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/server/installation_upgrade/installation/installation_modes.md b/docs/zh/server/installation_upgrade/installation/installation_modes.md index 88e932ca3..6b1260041 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_modes.md +++ b/docs/zh/server/installation_upgrade/installation/installation_modes.md @@ -2,7 +2,7 @@ >![](./public_sys-resources/icon-notice.gif) **须知：** > ->- 支持的服务器型号可参考“[硬件兼容支持](./安装准备.html#硬件兼容支持)”；虚拟化平台仅支持openEuler自有的虚拟化组件（HostOS为openEuler，虚拟化组件为发布包中的qemu、KVM）创建的虚拟化平台和华为公有云的x86虚拟化平台。 +>- 支持的服务器型号可参考“[硬件兼容支持](./installation_preparations.md#硬件兼容支持)”；虚拟化平台仅支持openEuler自有的虚拟化组件（HostOS为openEuler，虚拟化组件为发布包中的qemu、KVM）创建的虚拟化平台和华为公有云的x86虚拟化平台。 >- 安装方式当前仅支持光盘、USB盘安装、网络安装、qcow2镜像安装和私有镜像安装。其中仅华为公有云的x86虚拟化平台支持私有镜像安装。 ## 通过光盘安装 -- Gitee From da18099697aaf8dde70fa7f2eaddfa5ca9c2b0aa Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 16:31:20 +0800 Subject: [PATCH 07/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=B5=8B=E8=AF=95?= =?UTF-8?q?=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/edge_computing/kube_edge/_toc.yaml | 11 +-- docs/zh/edge_computing/ros/_toc.yaml | 2 - .../administration/administrator/_toc.yaml | 2 - .../development/application_dev/_toc.yaml | 2 - docs/zh/server/development/fangtian/_toc.yaml | 10 +- docs/zh/server/development/gcc/_toc.yaml | 15 ++- .../dpu_offload/offload_deployment_guide.md | 2 +- docs/zh/server/high_availability/ha/_toc.yaml | 11 +-- .../installation/_toc.yaml | 10 +- .../installation/installation_guide.md | 22 ++--- .../installation/installation_modes_1.md | 2 +- .../installation/installation_preparations.md | 6 +- .../installation/risc_v_pioneer1.3.md | 4 +- docs/zh/server/maintenance/aops/_toc.yaml | 6 +- .../maintenance/kernel_live_upgrade/_toc.yaml | 7 +- docs/zh/server/maintenance/syscare/_toc.yaml | 21 ++--- .../memory_storage/{ => memory}/_toc.yaml | 0 .../memory_storage/{ => memory}/overview.md | 0 .../cpu_optimization/sysboost/_toc.yaml | 15 ++- .../tools/cloud/pilotgo/usage_instructions.md | 2 +- docs/zh/tools/community_tools/_toc.yaml | 3 + .../image_tailor/imagetailor_userguide.md | 4 +- .../virtualization/euler_launcher/overall.md | 8 +- docs/zh/tools/desktop/dde/dde_userguide.md | 2 +- docs/zh/tools/desktop/gnome/_toc.yaml | 2 - .../tools/desktop/gnome/gnome_installation.md | 14 +-- docs/zh/tools/desktop/kiran/_toc.yaml | 2 - .../zh/tools/desktop/kiran/kiran_userguide.md | 3 + docs/zh/tools/desktop/ukui/_toc.yaml | 2 - docs/zh/tools/devops/eulermaker/_toc.yaml | 8 +- .../eulermaker/eulermaker_user_guide.md | 86 +++++++++--------- .../images/{regist.png => register.png} | Bin .../tools/devops/eulermaker/merge_configs.md | 18 ++-- docs/zh/tools/devops/eulerpipeline/_toc.yaml | 6 +- .../eulerpipeline/eulerpipeline_user_guide.md | 2 +- .../devops/patch_tracking/patch_tracking.md | 6 +- docs/zh/tools/devops/pkgship/pkgship.md | 10 +- 37 files changed, 151 insertions(+), 175 deletions(-) rename docs/zh/server/memory_storage/{ => memory}/_toc.yaml (100%) rename docs/zh/server/memory_storage/{ => memory}/overview.md (100%) rename docs/zh/tools/devops/eulermaker/images/{regist.png => register.png} (100%) diff --git a/docs/zh/edge_computing/kube_edge/_toc.yaml b/docs/zh/edge_computing/kube_edge/_toc.yaml index 627964514..1406dabe0 100644 --- a/docs/zh/edge_computing/kube_edge/_toc.yaml +++ b/docs/zh/edge_computing/kube_edge/_toc.yaml @@ -2,10 +2,7 @@ label: KubeEdge 边缘计算平台用户指南 isManual: true description: 主要介绍了边缘计算平台 KubeEdge 的部署与使用。 sections: - - label: KubeEdge 边缘计算平台用户指南 - href: ./overview.md - sections: - - label: KubeEdge 使用文档 - href: ./kube_edge_user_document.md - - label: KubeEdge 部署指南 - href: ./kube_edge_deployment_guide.md + - label: KubeEdge 使用文档 + href: ./kube_edge_user_document.md + - label: KubeEdge 部署指南 + href: ./kube_edge_deployment_guide.md diff --git a/docs/zh/edge_computing/ros/_toc.yaml b/docs/zh/edge_computing/ros/_toc.yaml index a2895f5ca..9763d7ab5 100644 --- a/docs/zh/edge_computing/ros/_toc.yaml +++ b/docs/zh/edge_computing/ros/_toc.yaml @@ -10,7 +10,5 @@ sections: href: ./installation_and_deployment.md - label: 使用方法 href: ./usage_guide.md - - label: 常见问题与解决方法 - href: ./faqs_and_solutions.md - label: 附录 href: ./appendix.md diff --git a/docs/zh/server/administration/administrator/_toc.yaml b/docs/zh/server/administration/administrator/_toc.yaml index 13714a61f..22ba99e1b 100644 --- a/docs/zh/server/administration/administrator/_toc.yaml +++ b/docs/zh/server/administration/administrator/_toc.yaml @@ -25,6 +25,4 @@ sections: href: ./configuring_the_web_server.md - label: 搭建数据库服务器 href: ./setting_up_the_database_server.md - - label: 常见问题与解决方法 - href: ./faqs_and_solutions.md \ No newline at end of file diff --git a/docs/zh/server/development/application_dev/_toc.yaml b/docs/zh/server/development/application_dev/_toc.yaml index 8a6ef7397..20a2eb8d2 100644 --- a/docs/zh/server/development/application_dev/_toc.yaml +++ b/docs/zh/server/development/application_dev/_toc.yaml @@ -16,5 +16,3 @@ sections: href: ./using_jdk_for_compilation.md - label: 构建RPM包 href: ./building_an_rpm_package.md - - label: 常见问题与解决方法 - href: ./faqs_and_solutions.md diff --git a/docs/zh/server/development/fangtian/_toc.yaml b/docs/zh/server/development/fangtian/_toc.yaml index cc3b9d8cf..2e1a0f478 100644 --- a/docs/zh/server/development/fangtian/_toc.yaml +++ b/docs/zh/server/development/fangtian/_toc.yaml @@ -4,7 +4,15 @@ description: FangTian视窗引擎的安装及开发使用指南。 sections: - label: FangTian视窗引擎 href: ./overview.md +<<<<<<< HEAD - label: FangTian环境配置 href: ./fangtian_environment_configuration.md - label: FangTian支持Wayland应用及鸿蒙应用 - href: ./fangtian_for_linux_waylan_and_openharmony_applications.md \ No newline at end of file + href: ./fangtian_for_linux_waylan_and_openharmony_applications.md +======= + sections: + - label: FangTian环境配置 + href: ./fangtian_environment_configuration.md + - label: FangTian支持Wayland应用及鸿蒙应用 + href: ./fangtian_for_linux_waylan_and_openharmony_applications.md +>>>>>>> ab1009ca1 (修改测试问题) diff --git a/docs/zh/server/development/gcc/_toc.yaml b/docs/zh/server/development/gcc/_toc.yaml index a3bf8a8c0..b7afc7113 100644 --- a/docs/zh/server/development/gcc/_toc.yaml +++ b/docs/zh/server/development/gcc/_toc.yaml @@ -2,12 +2,9 @@ label: GCC用户指南 isManual: true description: GCC for openEuler 编译器基于开源 GCC 开发，聚焦于C、C++、Fortran语言的优化 sections: - - label: GCC用户指南 - href: ./overview.md - sections: - - label: 内核反馈优化特性 - href: ./kernel_fdo_user_guide.md - - label: 全场景链接时二进制库内联优化 - href: ./link_time_binary_library_inlining_optimization.md - - label: GCC插件框架特性用户指南 - href: ./pin_user_guide.md \ No newline at end of file + - label: 内核反馈优化特性 + href: ./kernel_fdo_user_guide.md + - label: 全场景链接时二进制库内联优化 + href: ./link_time_binary_library_inlining_optimization.md + - label: GCC插件框架特性用户指南 + href: ./pin_user_guide.md \ No newline at end of file diff --git a/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md b/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md index 851e5ed5a..3d943885d 100644 --- a/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md +++ b/docs/zh/server/diversified_computing/dpu_offload/offload_deployment_guide.md @@ -3,7 +3,7 @@ > ![](./public_sys-resources/icon-note.gif)**说明**： > > 本指导涉及对容器管理面组件的少量改动和rexec工具修改，这些修改基于指定版本，其他版本可基于实际执行环境做适配修改。文档中提供的patch仅供验证指导使用，不具备实际商用的条件。 -> ![](./public_sys-resources/icon-note.gif)**说明**： +> > > 当前共享文件系统之间通信通过网络完成，可通过网络互连的两台物理机器或VM模拟验证。 > diff --git a/docs/zh/server/high_availability/ha/_toc.yaml b/docs/zh/server/high_availability/ha/_toc.yaml index 16a9cc680..9bd87d05b 100644 --- a/docs/zh/server/high_availability/ha/_toc.yaml +++ b/docs/zh/server/high_availability/ha/_toc.yaml @@ -2,10 +2,7 @@ label: HA用户指南 isManual: true description: 安装和使用 HA 高可用集群 sections: - - label: - href: ./ha.md - sections: - - label: HA 安装与部署 - href: ./ha_installation_and_deployment.md - - label: HA 使用实例 - href: ./ha_usecase_examples.md + - label: HA 安装与部署 + href: ./ha_installation_and_deployment.md + - label: HA 使用实例 + href: ./ha_usecase_examples.md diff --git a/docs/zh/server/installation_upgrade/installation/_toc.yaml b/docs/zh/server/installation_upgrade/installation/_toc.yaml index a5a56fb59..dae98f65c 100644 --- a/docs/zh/server/installation_upgrade/installation/_toc.yaml +++ b/docs/zh/server/installation_upgrade/installation/_toc.yaml @@ -12,9 +12,7 @@ sections: - label: 安装指导 href: ./installation_guide.md - label: 使用kickstart自动化安装 - href: ./using_kickstart_for_automatic_installation.md - - label: 常见问题与解决方法 - href: ./common_questions_and_solutions.md + href: ./using_kickstart_for_automatic_installation.md - label: 安装在树莓派 href: ./install_pi.md sections: @@ -24,12 +22,8 @@ sections: href: ./installation_modes_1.md - label: 安装指导 href: ./installation_guide_1.md - - label: 使用kickstart自动化安装 - href: ./using_kickstart_for_automatic_installation.md - label: 更多资源 - href: ./more_resources.md - - label: 常见问题与解决方法 - href: ./common_questions_and_solutions_1.md + href: ./more_resources.md - label: 安装在RISC-V href: ./risc_v.md sections: diff --git a/docs/zh/server/installation_upgrade/installation/installation_guide.md b/docs/zh/server/installation_upgrade/installation/installation_guide.md index a9611e7b7..c20335b45 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_guide.md +++ b/docs/zh/server/installation_upgrade/installation/installation_guide.md @@ -137,31 +137,31 @@ **图 10** 安装源 ![](./figures/Installation_source.png) -- 当使用网络源进行安装的时候，需设置网络源的 URL。 +- 当使用网络源进行安装的时候，需设置网络源的URL。 - - http 或 https 方式 + - http或https方式 - http 或 https 方式的安装源如下图所示。输入框内容以实际版本发布的安装源地址为准，如`https://repo.openeuler.org/openEuler-{version}/OS/$basearch/`，其中 version 为版本号，$basearch 为CPU 架构，可根据实际情况输入。 + http或https方式的安装源如下图所示。输入框内容以实际版本发布的安装源地址为准，如`https://repo.openeuler.org/openEuler-{version}/OS/$basearch/`，其中 version 为版本号，$basearch为CPU架构，可根据实际情况输入。 ![](./figures/installsource.png) - 如果https服务器使用的是私有证书，则需要在安装引导界面按“e”进入已选选项的参数编辑界面，在参数中增加 inst.noverifyssl 参数。 + 如果https服务器使用的是私有证书，则需要在安装引导界面按“e”进入已选选项的参数编辑界面，在参数中增加inst.noverifyssl参数。 - - ftp 方式 + - ftp方式 - ftp 方式的安装源如下图所示，输入框内容根据的 ftp 地址输入。 + ftp方式的安装源如下图所示，输入框内容根据的ftp地址输入。 ![](./figures/sourceftp.png) - ftp服务器需要用户自己搭建，将iso镜像进行挂载，挂载出的文件拷贝到ftp的共享目录中。其中x86_64为CPU 架构，可根据实际情况使用镜像。 + ftp服务器需要用户自己搭建，将iso镜像进行挂载，挂载出的文件拷贝到ftp的共享目录中。其中x86_64为CPU架构，可根据实际情况使用镜像。 - - nfs 方式 + - nfs方式 - nfs 方式的安装源如下图所示，输入框内容根据的 nfs 地址输入。 + nfs方式的安装源如下图所示，输入框内容根据的nfs地址输入。 ![](./figures/sourcenfs.png) - nfs服务器需要用户自己搭建，将iso镜像进行挂载，挂载出的文件拷贝到nfs的共享目录中。其中x86_64为CPU 架构，可根据实际情况使用镜像。 + nfs服务器需要用户自己搭建，将iso镜像进行挂载，挂载出的文件拷贝到nfs的共享目录中。其中x86_64为CPU架构，可根据实际情况使用镜像。 安装过程中，如果“设置安装源”有疑问，可参考“《[选择安装源出现异常](https://docs.openeuler.openatom.cn/zh/docs/common/faq/server/installation_faq1.html#%E9%97%AE%E9%A2%984-%E9%80%89%E6%8B%A9%E5%AE%89%E8%A3%85%E6%BA%90%E5%87%BA%E7%8E%B0%E5%BC%82%E5%B8%B8)》”。 @@ -240,7 +240,7 @@ ![](./figures/Manual_partitioning.png) >![](./public_sys-resources/icon-note.gif) **说明：** -> 如果选择非 UEFI 引导，则不需要 /boot/efi 分区。若选择 UEFI 引导，则必须有 /boot/efi 分区。 +> 如果选择非UEFI引导，则不需要/boot/efi分区。若选择UEFI引导，则必须有/boot/efi分区。 设置完成后，请单击左上角”完成“按钮，弹出“更改摘要”对话框，提示更改产生的变更信息。 diff --git a/docs/zh/server/installation_upgrade/installation/installation_modes_1.md b/docs/zh/server/installation_upgrade/installation/installation_modes_1.md index f549bcbc5..31b5c7e5d 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_modes_1.md +++ b/docs/zh/server/installation_upgrade/installation/installation_modes_1.md @@ -41,7 +41,7 @@ ## Linux 下刷写镜像 -本节介绍如何在 Linux 环境下将镜像刷写到SD卡。 +本节介绍如何在 Linux 环境下将镜像刷写到 SD 卡。 ### 查看磁盘分区信息 diff --git a/docs/zh/server/installation_upgrade/installation/installation_preparations.md b/docs/zh/server/installation_upgrade/installation/installation_preparations.md index c3aea4eec..4af04c5fb 100644 --- a/docs/zh/server/installation_upgrade/installation/installation_preparations.md +++ b/docs/zh/server/installation_upgrade/installation/installation_preparations.md @@ -16,10 +16,10 @@ 1. 若为AArch64架构。 1. 单击“aarch64”。 2. 若选择本地安装，选择“Offline Standard ISO”或者“Offline Everything ISO”对应的“立即下载”将发布包“openEuler-24.03-LTS-SP1-aarch64-dvd.iso”下载到本地。 - 3. 若选择网络安装，选择“Network Install ISO”将发布包 “openEuler-24.03-LTS-SP1-netinst-aarch64-dvd.iso”下载到本地。 + 3. 若选择网络安装，选择“Network Install ISO”将发布包“openEuler-24.03-LTS-SP1-netinst-aarch64-dvd.iso”下载到本地。 2. 若为x86_64架构。 1. 单击“x86_64”。 - 2. 若选择本地安装，选择“Offline Standard ISO”或者“Offline Everything ISO”对应的“立即下载”将发布包 “openEuler-24.03-LTS-SP1-x86_64-dvd.iso”下载到本地。 + 2. 若选择本地安装，选择“Offline Standard ISO”或者“Offline Everything ISO”对应的“立即下载”将发布包“openEuler-24.03-LTS-SP1-x86_64-dvd.iso”下载到本地。 3. 若选择网络安装，选择“Network Install ISO”将发布包“openEuler-24.03-LTS-SP1-netinst-x86_64-dvd.iso”下载到本地。 >![](./public_sys-resources/icon-note.gif) **说明：** @@ -30,7 +30,7 @@ ## 发布包完整性校验 >![](./public_sys-resources/icon-note.gif) **说明：** ->本章节以AArch64架构的发布包完整性校验为例，x86\_64架构的发布包完整性校验的操作方法相同。 +>本章节以AArch64架构的发布包完整性校验为例，x86_64架构的发布包完整性校验的操作方法相同。 ### 简介 diff --git a/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md b/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md index 74b3e5ebd..c2004f61b 100644 --- a/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md +++ b/docs/zh/server/installation_upgrade/installation/risc_v_pioneer1.3.md @@ -65,11 +65,11 @@ ```txt ~$ sudo dd if=firmware_single_sg2042-master.img of=/dev/sda bs=512K iflag=fullblock oflag=direct conv=fsync status=progress -261619712 字节 (262 MB, 250 MiB) 已复制，20 s，13.1 MB/s 268435456 字节 (268 MB, 256 MiB) 已复制，20.561 s，13.1 MB/s +261619712 字节 (262 MB，250 MiB) 已复制，20 s，13.1 MB/s 268435456 字节 (268 MB，256 MiB) 已复制，20.561 s，13.1 MB/s 输入了 512+0 块记录 输出了 512+0 块记录 -268435456 字节 (268 MB, 256 MiB) 已复制，20.5611 s，13.1 MB/s +268435456 字节 (268 MB，256 MiB) 已复制，20.5611 s，13.1 MB/s ``` > 因设备出厂固件版本较老，Image 镜像使用者如果想要使用较新版本的固件，可以更新**非 UEFI 版**固件。 diff --git a/docs/zh/server/maintenance/aops/_toc.yaml b/docs/zh/server/maintenance/aops/_toc.yaml index 92756ad5e..76327c859 100644 --- a/docs/zh/server/maintenance/aops/_toc.yaml +++ b/docs/zh/server/maintenance/aops/_toc.yaml @@ -6,7 +6,7 @@ sections: href: ./deploying_aops.md - label: 使用A-Ops智能定位框架 href: ./aops_intelligent_positioning_framework_user_manual.md - - label: aops漏洞管理模块使用手册 + - label: A-Ops漏洞管理模块使用手册 href: ./aops_vulnerability_management_module_user_manual.md - label: 使用热补丁dnf插件 href: ./dnf_command_usage.md @@ -14,9 +14,7 @@ sections: href: ./configuration_tracing_service_user_manual.md - label: 社区热补丁制作发布流程 href: ./community_hotpatch_creation_and_release_process.md - - label: AOps资产管理使用手册 + - label: A-Ops资产管理使用手册 href: ./aops_asset_management_user_manual.md - label: 一键化部署介绍 href: ./quick_deployment_of_aops.md - - label: gala-ragdoll的使用指导 - href: ./configuration_tracing_service_user_manual.md \ No newline at end of file diff --git a/docs/zh/server/maintenance/kernel_live_upgrade/_toc.yaml b/docs/zh/server/maintenance/kernel_live_upgrade/_toc.yaml index ee30c49c6..cdfbd08fb 100644 --- a/docs/zh/server/maintenance/kernel_live_upgrade/_toc.yaml +++ b/docs/zh/server/maintenance/kernel_live_upgrade/_toc.yaml @@ -1,13 +1,12 @@ label: 内核热升级指南 isManual: true description: 使用用户态自动化工具快速重启内核和程序热迁移实现内核热替换特性 -sections:sections: +sections: - label: 内核热升级指南 href: ./kernel_live_upgrade.md - sections:sections: + sections: - label: 安装与部署 href: ./installation_and_deployment.md - label: 使用方法 href: ./usage_guide.md - - label: 常见问题与解决方法 - href: ./faqs_and_solutions.md + diff --git a/docs/zh/server/maintenance/syscare/_toc.yaml b/docs/zh/server/maintenance/syscare/_toc.yaml index 2451b9135..e98293e75 100644 --- a/docs/zh/server/maintenance/syscare/_toc.yaml +++ b/docs/zh/server/maintenance/syscare/_toc.yaml @@ -2,16 +2,11 @@ label: SysCare用户指南 isManual: true description: 提供在线的热补丁修复能力 sections: - - label: syscare用户使用手册 - href: ./syscare_user_guide.md - sections: - - label: 认识SysCare - href: ./syscare_introduction.md - - label: 安装SysCare - href: ./installing_syscare.md - - label: 使用SysCare - href: ./using_syscare.md - - label: 约束限制 - href: ./constraints.md - - label: 常见问题与解决方法 - href: ./faqs_and_solutions.md + - label: 认识SysCare + href: ./syscare_introduction.md + - label: 安装SysCare + href: ./installing_syscare.md + - label: 使用SysCare + href: ./using_syscare.md + - label: 约束限制 + href: ./constraints.md diff --git a/docs/zh/server/memory_storage/_toc.yaml b/docs/zh/server/memory_storage/memory/_toc.yaml similarity index 100% rename from docs/zh/server/memory_storage/_toc.yaml rename to docs/zh/server/memory_storage/memory/_toc.yaml diff --git a/docs/zh/server/memory_storage/overview.md b/docs/zh/server/memory_storage/memory/overview.md similarity index 100% rename from docs/zh/server/memory_storage/overview.md rename to docs/zh/server/memory_storage/memory/overview.md diff --git a/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml b/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml index 185f0e874..c870a2509 100644 --- a/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml +++ b/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml @@ -2,12 +2,9 @@ label: sysBoost用户指南 isManual: true description: 优化代码与运行环境的 CPU 微架构的适应性，提升程序性能 sections: - - label: sysBoost用户指南 - href: ./sysboost.md - sections: - - label: 认识sysBoost - href: ./getting_to_know_sysBoost.md - - label: 安装与部署 - href: ./installation_and_deployment.md - - label: 使用方法 - href: ./usage_instructions.md + - label: 认识sysBoost + href: ./getting_to_know_sysBoost.md + - label: 安装与部署 + href: ./installation_and_deployment.md + - label: 使用方法 + href: ./usage_instructions.md diff --git a/docs/zh/tools/cloud/pilotgo/usage_instructions.md b/docs/zh/tools/cloud/pilotgo/usage_instructions.md index 3c65c351f..64bfe6e02 100644 --- a/docs/zh/tools/cloud/pilotgo/usage_instructions.md +++ b/docs/zh/tools/cloud/pilotgo/usage_instructions.md @@ -9,7 +9,7 @@ PilotGo可以单机部署也可以采用集群式部署。安装之前先关闭 ### 1.1 PilotGo-server 安装与配置 安装mysql； -安装redis，设置redis密码（修改）,运行命令： +安装redis，设置redis密码（修改），运行命令： `dnf install redis6` diff --git a/docs/zh/tools/community_tools/_toc.yaml b/docs/zh/tools/community_tools/_toc.yaml index 44feffbde..e2155c737 100644 --- a/docs/zh/tools/community_tools/_toc.yaml +++ b/docs/zh/tools/community_tools/_toc.yaml @@ -13,3 +13,6 @@ sections: - label: epkg软件包 sections: - href: ./epkg_use/_toc.yaml + - label: 性能优化 + sections: + - href: ../../server/performace/tuning_framework/oeaware/_toc.yaml diff --git a/docs/zh/tools/community_tools/image_tailor/imagetailor_userguide.md b/docs/zh/tools/community_tools/image_tailor/imagetailor_userguide.md index a8a3974e7..2114e0e0d 100644 --- a/docs/zh/tools/community_tools/image_tailor/imagetailor_userguide.md +++ b/docs/zh/tools/community_tools/image_tailor/imagetailor_userguide.md @@ -442,7 +442,7 @@ openEuler 提供的默认配置如下，用户可以根据需要进行修改： - null/NULL：表示不配置。如果裁剪系统（sys_cut=“yes”），则/usr/lib/gconv 和 /usr/lib64/gconv 会被删除。 - all/ALL：不裁剪 /usr/lib/gconv 和 /usr/lib64/gconv 。 - - xxx,xxx: 保留 /usr/lib/gconv 和 /usr/lib64/gconv 目录下对应的文件。若需要保留多个文件，可用 "," 分隔。 + - xxx,xxx：保留 /usr/lib/gconv 和 /usr/lib64/gconv 目录下对应的文件。若需要保留多个文件，可用 "," 分隔。 - sys_man_cut @@ -643,7 +643,7 @@ hd0 /home max logical ext4 - 【分区类型】 分区有以下三种类型： - - 主分区： primary + - 主分区：primary - 扩展分区：extended（该分区只需配置 hd 磁盘号即可） - 逻辑分区：logical diff --git a/docs/zh/tools/community_tools/virtualization/euler_launcher/overall.md b/docs/zh/tools/community_tools/virtualization/euler_launcher/overall.md index f5a55ab28..1250b724e 100644 --- a/docs/zh/tools/community_tools/virtualization/euler_launcher/overall.md +++ b/docs/zh/tools/community_tools/virtualization/euler_launcher/overall.md @@ -10,9 +10,9 @@ ## 快速开始 -**EulerLauncher** MacOS用户请参考[MacOS用户指导文档][1] +**EulerLauncher** MacOS用户请参考[《MacOS用户指导文档》][1] -**EulerLauncher** Windows用户请参考[Windows用户指导文档][2] +**EulerLauncher** Windows用户请参考[《Windows用户指导文档》][2] -[1]: ./mac-user-manual.md -[2]: ./win-user-manual.md \ No newline at end of file +[1]: ./mac_user_manual.md +[2]: ./win_user_manual.md diff --git a/docs/zh/tools/desktop/dde/dde_userguide.md b/docs/zh/tools/desktop/dde/dde_userguide.md index bfd3f5a98..666ddcd84 100644 --- a/docs/zh/tools/desktop/dde/dde_userguide.md +++ b/docs/zh/tools/desktop/dde/dde_userguide.md @@ -404,7 +404,7 @@ DDE桌面操作系统通过控制中心来管理系统的基本设置，包括 1. 在控制中心首页，单击 ![display_normal](./figures/icon72-o.svg)。 2. 单击 **多屏显示模式**。 3. 选择一种显示模式。 - - **复制**将主屏的显示内容复制到其他屏幕。 + - **复制** 将主屏的显示内容复制到其他屏幕。 - **扩展** 将主屏的显示内容扩展到其他屏幕，扩大桌面区域。 - **自定义** 设置显示模式，主屏、分辨率、刷新率和屏幕旋转方向。 diff --git a/docs/zh/tools/desktop/gnome/_toc.yaml b/docs/zh/tools/desktop/gnome/_toc.yaml index e9d3724f6..efdb46b5e 100644 --- a/docs/zh/tools/desktop/gnome/_toc.yaml +++ b/docs/zh/tools/desktop/gnome/_toc.yaml @@ -2,8 +2,6 @@ label: Gnome用户指南 isManual: true description: 安装并使用 Gnome 桌面环境 sections: - - label: Gnome - href: ./gnome.md - label: 安装 Gnome href: ./gnome_installation.md - label: 使用 Gnome diff --git a/docs/zh/tools/desktop/gnome/gnome_installation.md b/docs/zh/tools/desktop/gnome/gnome_installation.md index c9b091f79..3b8347446 100644 --- a/docs/zh/tools/desktop/gnome/gnome_installation.md +++ b/docs/zh/tools/desktop/gnome/gnome_installation.md @@ -84,39 +84,39 @@ sudo systemctl set-default graphical.target sudo reboot ``` -7.当gdm不能工作 +7.当gdm不能工作。 -如果默认安装了gdm，则停用gdm +如果默认安装了gdm，则停用gdm。 ```shell sudo systemctl disable gdm ``` -安装lightdm显示管理器替代 +安装lightdm显示管理器替代。 ```shell sudo dnf install lightdm lightdm-gtk ``` -设置默认桌面为GNOME，通过root权限用户设置 +设置默认桌面为GNOME，通过root权限用户设置。 ```shell echo 'user-session=gnome' >> /etc/lightdm/lightdm.conf.d/60-lightdm-gtk-greeter.conf ``` -启动lightdm显示管理器 +启动lightdm显示管理器。 ```shell sudo systemctl enable lightdm ``` -设置系统默认以图形界面登录 +设置系统默认以图形界面登录。 ```shell sudo systemctl set-default graphical.target ``` -重启验证 +重启验证。 ```shell sudo reboot diff --git a/docs/zh/tools/desktop/kiran/_toc.yaml b/docs/zh/tools/desktop/kiran/_toc.yaml index f81b6a492..4ee827a95 100644 --- a/docs/zh/tools/desktop/kiran/_toc.yaml +++ b/docs/zh/tools/desktop/kiran/_toc.yaml @@ -2,8 +2,6 @@ label: Kiran用户指南 isManual: true description: 安装并使用 Kiran 桌面环境 sections: - - label: Kiran - href: ./kiran.md - label: 安装 Kiran href: ./kiran_installation.md - label: 使用 Kiran diff --git a/docs/zh/tools/desktop/kiran/kiran_userguide.md b/docs/zh/tools/desktop/kiran/kiran_userguide.md index 65697fc0c..51bb6f02d 100644 --- a/docs/zh/tools/desktop/kiran/kiran_userguide.md +++ b/docs/zh/tools/desktop/kiran/kiran_userguide.md @@ -109,6 +109,7 @@ Kiran桌面是一款以用户和市场需求为主导的稳定、高效、易用 2)修改用户属性； 3)显示用户属性； 4)删除用户； + 用户属性包括：账号、口令(密码)、登录 shell，用户组属性指在该组包含哪些用户。 #### 4.5.1.启动账户管理工具 @@ -118,6 +119,7 @@ Kiran桌面是一款以用户和市场需求为主导的稳定、高效、易用 ![图20-账户管理工具](figures/kiran-20.png) 在这个界面中您可以看到有左侧菜用户栏和右侧详细信息栏两个部分。目前在列出的是系统中的所有用户（除root用户除外）。点击左侧某个用户，详细信息栏将显示用户的基本信息（用户ID、用户类型等）。 + 点击“创建用户”，在右侧出现页面，如下图所示，按照要求填写您要添加的用户名、用户类型、设置密码、头像。填写完毕后，单击“创建”即完成添加。 ![图21-创建账户](figures/kiran-21.png) @@ -172,6 +174,7 @@ e.指针； #### 4.6.2.背景 用户可以对桌面背景进行设置，可以修改颜色、样式。 + 1)背景图片设置 如下图所示，点击壁纸文件浏览对话框中的壁纸，即可将桌面设置为此壁纸。 diff --git a/docs/zh/tools/desktop/ukui/_toc.yaml b/docs/zh/tools/desktop/ukui/_toc.yaml index d18776361..253f465b0 100644 --- a/docs/zh/tools/desktop/ukui/_toc.yaml +++ b/docs/zh/tools/desktop/ukui/_toc.yaml @@ -2,8 +2,6 @@ label: UKUI用户指南 isManual: true description: 安装并使用 UKUI 桌面环境 sections: - - label: UKUI - href: ./ukui.md - label: 安装 UKUI href: ./ukui_installation.md - label: 使用 UKUI diff --git a/docs/zh/tools/devops/eulermaker/_toc.yaml b/docs/zh/tools/devops/eulermaker/_toc.yaml index d3fea3174..862a946ce 100644 --- a/docs/zh/tools/devops/eulermaker/_toc.yaml +++ b/docs/zh/tools/devops/eulermaker/_toc.yaml @@ -1,8 +1,8 @@ -label: eulermaker +label: EulerMaker isManual: true -description: eulermaker +description: 统一构建平台实现从源码到二进制软件包与软件仓库的平台服务 sections: - - label: eulermaker 快速入门 + - label: EulerMaker 快速入门 href: ./eulermaker_user_guide.md - - label: eulermaker 使用 + - label: EulerMaker 使用 href: ./merge_configs.md diff --git a/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md b/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md index 06f316169..5d60534bc 100644 --- a/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md +++ b/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md @@ -19,7 +19,7 @@ - 已绑定：页面返回首页 ![image](images/home.png) - 未绑定：页面跳转至帐号注册页面，填写用户信息，完成注册。 - ![image](images/regist.png) + ![image](images/register.png) ### 创建工程 @@ -138,7 +138,7 @@ ![image](images/custom_package.png) 3. 填写产品名称，填写安装镜像时的所展示的产品名称。 4. 配置内核参数，为了系统能够更稳定高效地运行，用户可以根据需要修改内核命令行参数，多个参数使用空格分隔。 -
例如："net.ifnames=0 biosdevname=0 crashkernel=512M oops=panic softlockup_panic=1 reserve_kbox_mem=16M crash_kexec_post_notifiers panic=3 console=tty0" +
例如："net.ifnames=0 biosdevname=0 crashkernel=512M oops=panic softlockup_panic=1 reserve_kbox_mem=16M crash_kexec_post_notifiers panic=3 console=tty0" 5. 添加repo源，输入需要添加rpm包的repo源的正确url地址。 6. 添加rpm包：配置好正确的repo源后，点击添加按钮，弹出添加rpm包弹窗，勾选需要的rpm包，也可以通过弹窗右上角搜索需要的rpm包，点击确认即可保存。若要删除已添加的rpm包，点击rpm包表格操作列的移除或者勾选需要删除的rpm包，点击批量移除按钮即可。 ![image](images/add_rpms.png) @@ -146,36 +146,36 @@ 8. 添加命令：填写系统命令，多个以空格分隔，可选填。 9. 添加库文件：填写库文件名称，多个以空格分隔，可选填。 10. 删除其他文件：填写需要删除的文件路径及文件名，多个以空格分隔，可选填。 -11.配置分区：点击加号图标，新增一条配置分区，根据需要填写以下配置。 +11. 配置分区：点击加号图标，新增一条配置分区，根据需要填写以下配置。 ![image](images/config_partition.png) -- 磁盘索引：磁盘的编号，请按照hdx的格式填写，x指第x块盘。 -- 挂载目录：指定分区挂载的路径。用户既可以配置业务分区，也可以对默认配置中的系统分区进行调整。 -- 分区大小：分区大小的取值有四种，可通过点击单位按钮来更换，最大上限为16T。其中MAX为指定将硬盘上剩余的空间全部用来创建一个分区，只能在最后一个分区配置该值。 -- 分区类型：分区有三种，主分区：primary；扩展分区：extended（该分区只需配置hd磁盘号即可）；逻辑分区：logical。 -- 分区文件系统类型：目前支持的文件系统类型有：ext4、vfat。 -- 是否二次格式化：表示二次安装时是否格式化，选择是或否。 + - 磁盘索引：磁盘的编号，请按照hdx的格式填写，x指第x块盘。 + - 挂载目录：指定分区挂载的路径。用户既可以配置业务分区，也可以对默认配置中的系统分区进行调整。 + - 分区大小：分区大小的取值有四种，可通过点击单位按钮来更换，最大上限为16T。其中MAX为指定将硬盘上剩余的空间全部用来创建一个分区，只能在最后一个分区配置该值。 + - 分区类型：分区有三种，主分区：primary；扩展分区：extended（该分区只需配置hd磁盘号即可）；逻辑分区：logical。 + - 分区文件系统类型：目前支持的文件系统类型有：ext4、vfat。 + - 是否二次格式化：表示二次安装时是否格式化，选择是或否。 -12.配置网络：点击加号图标，新增一条配置网络，根据需要填写以下配置。
-![image](images/config_net.png) +12. 配置网络：点击加号图标，新增一条配置网络，根据需要填写以下配置。
+ ![image](images/config_net.png) -- BOOTPROTO：none：引导时不使用协议，不配地址；static：静态分配地址；dhcp：使用DHCP协议动态获取地址。
-- DEVICE：网卡名称，如eth0。 -- IPADDR：IP地址。当BOOTPROTO参数为static时，该参数必配，如：192.168.11.100；其他情况下，该参数不用配置。
-- NETMASK：子网掩码。当BOOTPROTO参数为static时，该参数必配，如：255.255.255.0；其他情况下，该参数不用配置。
-- STARTMODE：启用网卡的方法。manual：用户在终端执行ifup命令启用网卡。auto\hotplug\ifplugd\nfsroot：当OS识别到该网卡时，便启用该网卡。off：任何情况下，网卡都无法被启用。 + - BOOTPROTO：none：引导时不使用协议，不配地址；static：静态分配地址；dhcp：使用DHCP协议动态获取地址。
+ - DEVICE：网卡名称，如eth0。 + - IPADDR：IP地址。当BOOTPROTO参数为static时，该参数必配，如：192.168.11.100；其他情况下，该参数不用配置。
+ - NETMASK：子网掩码。当BOOTPROTO参数为static时，该参数必配，如：255.255.255.0；其他情况下，该参数不用配置。
+ - STARTMODE：启用网卡的方法。manual：用户在终端执行ifup命令启用网卡。auto\hotplug\ifplugd\nfsroot：当OS识别到该网卡时，便启用该网卡。off：任何情况下，网卡都无法被启用。 -13.添加用户自定义文件：点击加号图标，弹出文件管理器弹窗，选择需要上传的文件，点击打开按钮即可上传，上传成功后状态变为成功，并且需要填写目标存放路径。若要删除文件，点击操作列的删除字段即可。 +13. 添加用户自定义文件：点击加号图标，弹出文件管理器弹窗，选择需要上传的文件，点击打开按钮即可上传，上传成功后状态变为成功，并且需要填写目标存放路径。若要删除文件，点击操作列的删除字段即可。 > 注：用户自定义文件上传大小不得超过16M -14.添加hook脚本：点击加号图标，弹出文件管理器弹窗，选择需要上传的hook脚本文件，文件名称需符合“S+数字（至少两位，个位数以0开头）”开头，数字代表hook脚本的执行顺序（脚本名称示例：S01xxx.sh），点击打开按钮即可上传，上传成功后状态变为成功，并且需要选择hook脚本存放的子目录。若要删除文件，点击操作列的删除字段即可。 +14. 添加hook脚本：点击加号图标，弹出文件管理器弹窗，选择需要上传的hook脚本文件，文件名称需符合“S+数字（至少两位，个位数以0开头）”开头，数字代表hook脚本的执行顺序（脚本名称示例：S01xxx.sh），点击打开按钮即可上传，上传成功后状态变为成功，并且需要选择hook脚本存放的子目录。若要删除文件，点击操作列的删除字段即可。 > 注：hook脚本上传文件大小不得超过16M ![image](images/add_file.png) -15.填好各项配置后，点击右上角保存按钮。 +15. 填好各项配置后，点击右上角保存按钮。 ##### docker/mini_docker/mini_cpio/iso_normal/qcow2格式 @@ -263,7 +263,7 @@ EulerMaker将[lkp-tests](https://gitee.com/openeuler-customization/lkp-tests.git - #{ENV['HOME']}/.config/cli/defaults/*.yaml 优先 -``` +```yaml GATEWAY_IP: xxx GATEWAY_PORT: xxx SRV_HTTP_REPOSITORIES_HOST: xxx @@ -285,7 +285,7 @@ EulerMaker将[lkp-tests](https://gitee.com/openeuler-customization/lkp-tests.git 配置完成后可执行以下命令，查看是否可以正常使用ccb命令。 -``` +```shell ccb -h/--help ``` @@ -293,7 +293,7 @@ ccb -h/--help ## 命令总览 -``` +```txt # CRUD # Elasticsearch 7.x文档基本操作（CRUD） https://www.cnblogs.com/liugp/p/11848408.html @@ -318,7 +318,7 @@ ccb build-single os_project= packages= k=v|--json JS **查询所有的projects全部信息** -``` +```shell ccb select projects ``` @@ -326,39 +326,39 @@ ccb select projects rpms和rpm_repos，这两个表由于数据量过大，无法通过`ccb select 表名`命令直接查询该表的全部信息， 查询rpms表必须使用-f指定过滤字段或者使用key=value指定明确的过滤条件。 -``` +```shell ccb select rpms -f repo_id ccb select rpms repo_id=openEuler-24.03-LTS:baseos-openEuler:24.03-LTS-x86_64-313 ``` 查询rpm_repos表必须使用key=value指定明确的过滤条件，如果不知道value的值，可以先查询其他表获取，然后再使用key=value查询rpm_repos表。 -``` +```shell ccb select builds -f repo_id # 先查询builds获得repo_id值 ccb select rpm_repos repo_id=openEuler-24.03-LTS:baseos-openEuler:24.03-LTS-x86_64-313 # 使用上个命令获得的repo_id值查询rpm_repos表 ``` **查询符合要求的projects的全部信息** -``` +```shell ccb select projects os_project=openEuler:Mainline owner=xxx ``` **查询符合要求的projects的部分信息** -``` +```shell ccb select projects os_project=openEuler:Mainline --field os_project，users ``` **查询符合要求的projects的部分信息并排序** -``` +```shell ccb select projects os_project=openEuler:Mainline --field os_project，users --sort create_time:desc，os_project:asc ``` **列出指定project的所有snapshot** -``` +```shell ccb select snapshots os_project=openEuler:Mainline ``` @@ -368,7 +368,7 @@ ccb select snapshots os_project=openEuler:Mainline **创建project** -``` +```json ccb create projects test-project --json config.json config.json: { @@ -407,7 +407,7 @@ config.json: **project添加package** -``` +```json ccb update projects $os_project --json update.json update.json: { @@ -424,7 +424,7 @@ update.json: **project增删user** -``` +```json ccb update projects $os_project --json update.json update.json: { @@ -438,13 +438,13 @@ update.json: **锁定某个package** -``` +```shell ccb update projects test-project package_overrides.$package.lock=true ``` **解锁某个package** -``` +```shell ccb update projects test-project package_overrides.$package.lock=false ``` @@ -452,7 +452,7 @@ ccb update projects test-project package_overrides.$package.lock=false build_targets可以不传，可以有1或多个，如果不传，采用os_project默认配置的build_targets。 -``` +```json ccb build-single os_project=test-project packages=gcc --json build_targets.json build_targets.json: { @@ -475,7 +475,7 @@ build_targets.json: build_targets参数与单包构建中的build_targets一样，可以不传，可以有1或多个，如果不传，采用os_project默认配置的build_targets； 如果指定snapshot_id，则os_project可不传，表示基于某个历史快照创建全量/增量构建。 -``` +```json ccb build os_project=test-project build_type=full --json build_targets.json # 全量构建 ccb build snapshot_id=xxx build_type=incremental --json build_targets.json # 增量构建 build_targets.json: @@ -500,28 +500,28 @@ dest表示指定软件包下载后存放的路径，可不传，默认使用当 #### 基本用法 -``` +```shell ccb download os_project=test-project packages=python-flask architecture=aarch64 dest=/tmp/rpm ccb download snapshot_id=123456 packages=python-flask architecture=aarch64 dest=/tmp/rpm ``` #### -s的用法 -``` +```shell # 使用-s 表示下载该packages的源码包。示例如下所示： ccb download os_project=test-project packages=python-flask architecture=aarch64 -s ``` #### -d的用法 -``` +```shell # 使用-d 表示下载该packages的debug（debuginfo和debugsource）包。示例如下所示： ccb download os_project=test-project packages=python-flask architecture=aarch64 -d ``` #### -b的用法 -``` +```shell # 使用-b all 表示下载该packages的所有子包。示例如下所示： ccb download os_project=test-project packages=python-flask architecture=aarch64 -b all @@ -532,7 +532,7 @@ ccb download os_project=test-project packages=python-flask architecture=aarch64 #### -s -d -b 组合使用 -``` +```shell # 使用-b all -s -d 表示下载该packages的debug包，源码包和所有子包。示例如下所示： ccb download os_project=test-project packages=python-flask architecture=aarch64 -b all -s -d @@ -543,14 +543,14 @@ ccb download os_project=test-project packages=python-flask architecture=aarch64 ### 7. cancel 取消构建任务 -``` +```shell ccb cancel $build_id ``` ### 8. 查看job日志 -``` +```shell ccb log ``` diff --git a/docs/zh/tools/devops/eulermaker/images/regist.png b/docs/zh/tools/devops/eulermaker/images/register.png similarity index 100% rename from docs/zh/tools/devops/eulermaker/images/regist.png rename to docs/zh/tools/devops/eulermaker/images/register.png diff --git a/docs/zh/tools/devops/eulermaker/merge_configs.md b/docs/zh/tools/devops/eulermaker/merge_configs.md index 2e719ac31..eab880f27 100644 --- a/docs/zh/tools/devops/eulermaker/merge_configs.md +++ b/docs/zh/tools/devops/eulermaker/merge_configs.md @@ -4,17 +4,17 @@ # 安装与卸载 -#### 安装 +## 安装 pip install merge_configs-0.0.6-py3-none-any.whl -#### 卸载 +## 卸载 pip uninstall merge-configs # 使用方法 -#### 命令行 +## 命令行 merge-configs --help -p PACKAGES, --packages PACKAGES: 设置需要merge的软件包，多个软件包用空格隔开。 @@ -33,11 +33,11 @@ ![](./figures/1686189862936_image.png) -#### 软件包定制 +## 软件包定制 软件包编译信息经过的分层的架构分开保存，分成yaml主要配置、files.yaml文件配置、编译执行脚本、运行时执行脚本和changelog。其各个文件中定制的内容经由merge-configs工具解析转换，会在编译中生效。 -##### 参数定制 +### 参数定制 1. 参数名定制： 参数名可以根据定制需求修改，通常只修改source,patch的编号，随意修改可能导致spec语法不支持。 @@ -53,7 +53,7 @@ ![](./figures/1686190839529_image.png) -##### 条件定制 +### 条件定制 条件定制的方式是在yaml配置层的key中添加when条件。 @@ -75,7 +75,7 @@ ``` 2. 标签定制： -defineFlags字段将会转换为bcond_with/bcond_without。 + defineFlags字段将会转换为bcond_with/bcond_without。 ```sh defineFlags: @@ -85,7 +85,7 @@ defineFlags字段将会转换为bcond_with/bcond_without。 ``` 3. 宏定制： -%%{rpmGlobal.}表示在包信息中定义的宏，%%%{rpmGlobal.}表示在rpm系统中定义的宏。 + %%{rpmGlobal.}表示在包信息中定义的宏，%%%{rpmGlobal.}表示在rpm系统中定义的宏。 ```sh rpmGloal: @@ -104,6 +104,6 @@ defineFlags字段将会转换为bcond_with/bcond_without。 ![](./figures/1686194008501_image.png) -#### 转换 +## 转换 目前eulermaker仅支持yaml->spec的转换，仅支持rpmbuild编译rpm包的编译方式。 diff --git a/docs/zh/tools/devops/eulerpipeline/_toc.yaml b/docs/zh/tools/devops/eulerpipeline/_toc.yaml index 334826b73..9d9560571 100644 --- a/docs/zh/tools/devops/eulerpipeline/_toc.yaml +++ b/docs/zh/tools/devops/eulerpipeline/_toc.yaml @@ -1,8 +1,8 @@ -label: eulerpipeline +label: EulerPipeline isManual: true -description: eulerpipeline +description: 聚焦于web页面的维度进行EulerPipeline原生开发服务的功能介绍 sections: - - label: eulerpipeline 用户指南 + - label: EulerPipeline 用户指南 href: ./eulerpipeline_user_guide.md - label: v1.0 语法说明文档 href: ./v1.0_grammar.md diff --git a/docs/zh/tools/devops/eulerpipeline/eulerpipeline_user_guide.md b/docs/zh/tools/devops/eulerpipeline/eulerpipeline_user_guide.md index 1a153637f..ed2615d90 100644 --- a/docs/zh/tools/devops/eulerpipeline/eulerpipeline_user_guide.md +++ b/docs/zh/tools/devops/eulerpipeline/eulerpipeline_user_guide.md @@ -82,7 +82,7 @@ EulerPipeline原生开发服务支持基于lkp-tests仓库中的流水线yaml模 - 通过YAML编排需要熟悉流水线支持的语法，流水线支持多版本语法解析，语法版本通过“version”关键字声明，目前仅支持v1.0版本语法。 - - v1.0语法请参考文档：[EulerPipeline原生开发服务流水线语法v1.0](v1.0_grammar.md) + - v1.0语法请参考文档：[EulerPipeline原生开发服务流水线语法v1.0](./v1.0_grammar.md) ![yaml](./image/YAML编排.jpg) diff --git a/docs/zh/tools/devops/patch_tracking/patch_tracking.md b/docs/zh/tools/devops/patch_tracking/patch_tracking.md index ae981b2bf..51c72abea 100644 --- a/docs/zh/tools/devops/patch_tracking/patch_tracking.md +++ b/docs/zh/tools/devops/patch_tracking/patch_tracking.md @@ -64,15 +64,15 @@ b. Maintainer对提交的补丁处理流程 ### 软件下载 -Repo 源地址：[https://repo.openeuler.org/](https://repo.openeuler.org/) +Repo 源地址：[https://repo.openeuler.org](https://repo.openeuler.org) -rpm 包获取地址：[https://repo.openeuler.org/](https://repo.openeuler.org/)，依次选择正确的版本号、everything、正确的架构、Packages，找到需要的rpm包，点击即可下载。 +rpm 包获取地址：[https://repo.openeuler.org](https://repo.openeuler.org)，依次选择正确的版本号、everything、正确的架构、Packages，找到需要的rpm包，点击即可下载。 ### 安装工具 方法1：从repo源安装 -1. 使用 dnf 挂载 repo源（具体方法参考[应用开发指南](../../../server/development/application_dev/preparations_for_development_environment.md)。 +1. 使用 dnf 挂载 repo源（具体方法参考《[应用开发指南](../../../server/development/application_dev/preparations_for_development_environment.md)》。 2. 执行以下命令安装`patch-tracking`及其依赖。 diff --git a/docs/zh/tools/devops/pkgship/pkgship.md b/docs/zh/tools/devops/pkgship/pkgship.md index 43120ee9a..c08375b53 100644 --- a/docs/zh/tools/devops/pkgship/pkgship.md +++ b/docs/zh/tools/devops/pkgship/pkgship.md @@ -4,7 +4,7 @@ pkgship是一款管理OS软件包依赖关系，提供依赖和被依赖关系完整图谱的查询工具，pkgship提供软件包依赖查询、生命周期管理等功能。 -1. 软件包基本信息查询：方便社区人员快速获取软件包的名称，版本，描述等基本信息。 +1. 软件包基本信息查询：方便社区人员快速获取软件包的名称、版本，描述等基本信息。 2. 软件包依赖查询：方便社区人员在软件包引入、更新和删除的时候了解软件的影响范围。 ## 架构 @@ -15,13 +15,13 @@ pkgship是一款管理OS软件包依赖关系，提供依赖和被依赖关系 ## 在线使用 -pkgship提供了公网地址 +pkgship提供了公网地址，若无定制化需求，可直接使用在线查询。 若需要定制查询数据源，可按照文档进行本地安装、配置、使用。 ## 软件下载 -- Repo源挂载正式发布地址： +- Repo源挂载正式发布地址： - 源码获取地址： - RPM包版本获取地址： @@ -54,7 +54,7 @@ pkgship提供了公网地址 Date: Fri, 13 Jun 2025 16:54:07 +0800 Subject: [PATCH 08/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=B5=8B=E8=AF=95?= =?UTF-8?q?=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/server/_toc.yaml | 2 +- .../tools/cloud/pilotgo/usage_instructions.md | 40 +++++++++++-------- docs/zh/tools/community_tools/_toc.yaml | 2 +- .../eulermaker/eulermaker_user_guide.md | 22 +++++----- 4 files changed, 36 insertions(+), 30 deletions(-) diff --git a/docs/zh/server/_toc.yaml b/docs/zh/server/_toc.yaml index 908b69c45..af3220972 100644 --- a/docs/zh/server/_toc.yaml +++ b/docs/zh/server/_toc.yaml @@ -44,7 +44,7 @@ sections: - href: ./memory_storage/etmem/_toc.yaml - href: ./memory_storage/gmem/_toc.yaml - href: ./memory_storage/hsak/_toc.yaml - - href: ./memory_storage/_toc.yaml + - href: ./memory_storage/memory/_toc.yaml - label: 网络 sections: - href: ./network/network_config/_toc.yaml diff --git a/docs/zh/tools/cloud/pilotgo/usage_instructions.md b/docs/zh/tools/cloud/pilotgo/usage_instructions.md index 64bfe6e02..e6b822a3b 100644 --- a/docs/zh/tools/cloud/pilotgo/usage_instructions.md +++ b/docs/zh/tools/cloud/pilotgo/usage_instructions.md @@ -70,7 +70,7 @@ PilotGo可以单机部署也可以采用集群式部署。安装之前先关闭 1. 具有创建用户权限的用户成功登录之后点击左侧导航栏中的用户管理； 2. 击页面的批量导入按钮，选择文件点击打开按钮；![本地路径](./figures/用户导入1.png) 3. 显示用户信息则完成用户导入。![本地路径](./figures/用户导入2.png)![本地路径](./figures/用户导入3.png) - + #### 2.2.2 修改用户信息及密码 ##### 2.2.2.1 修改用户信息 @@ -255,17 +255,19 @@ PilotGo可以单机部署也可以采用集群式部署。安装之前先关闭 1. 在任意一台服务器上执行dnf install PilotGo-plugin-grafana grafana； 2. 将/opt/PilotGo/plugin/grafana/config.yaml文件中ip地址修改为本机真实ip，修改/etc/grafana/grafana.ini文件一下信息： -`root_url = http://真实ip:9999/plugin/grafana` + `root_url = http://真实ip:9999/plugin/grafana` + + `serve_from_sub_path = true` -`serve_from_sub_path = true` + `allow_embedding = true` -`allow_embedding = true` 3. 重启两个服务，执行以下命令： -`systemctl restart grafana-server` + `systemctl restart grafana-server` + + `systemctl start PilotGo-plugin-grafana` -`systemctl start PilotGo-plugin-grafana` -4. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，机器地址例子：http://真实ip:9999/plugin/grafana，并点击确定；![本地路径](./figures/G插件1.png) +4. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，机器地址例子：，并点击确定；![本地路径](./figures/G插件1.png) 5. 页面增加一条插件管理数据，导航栏增加一个插件按钮。![本地路径](./figures/G插件2.png)![本地路径](./figures/G插件3.png) ### 3.2 PilotGo-plugin-prometheus插件使用说明 @@ -273,9 +275,10 @@ PilotGo可以单机部署也可以采用集群式部署。安装之前先关闭 1. 在任意一台服务器上执行dnf install PilotGo-plugin-prometheus； 2. 将/opt/PilotGo/plugin/prometheus/server/config.yml文件中ip地址修改为本机真实ip和mysql服务地址； 3. 重启服务，执行以下命令： - -`systemctl start PilotGo-plugin-prometheus` -4. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，机器地址例子：http://真实ip:8090/plugin/prometheus，并点击确定；![本地路径](./figures/P插件1.png) + + `systemctl start PilotGo-plugin-prometheus` + +4. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，机器地址例子：，并点击确定；![本地路径](./figures/P插件1.png) 5. 页面增加一条插件管理数据，导航栏增加一个插件按钮。![本地路径](./figures/P插件2.png)![本地路径](./figures/P插件3.png) 6. 在页面选择机器ip和监控时间，展示机器数据面板。![本地路径](./figures/P插件4.png) @@ -284,9 +287,10 @@ PilotGo可以单机部署也可以采用集群式部署。安装之前先关闭 1. 在需要调优的机器上安装PilotGo-agent、atune，并执行dnf install PilotGo-plugin-a-tune; 2. 将/opt/PilotGo/plugin/a-tune/config.yml文件中ip地址修改为真实ip； 3. 重启服务，执行以下命令： - -`systemctl start PilotGo-plugin-a-tune` -4. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，机器地址例子：http://真实ip:8099，并点击确定；![本地路径](./figures/A插件1.png) + + `systemctl start PilotGo-plugin-a-tune` + +4. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，机器地址例子：，并点击确定；![本地路径](./figures/A插件1.png) 5. 页面增加一条插件管理数据，导航栏增加一个插件按钮。![本地路径](./figures/A插件2.png) #### 3.3.1 调优模板 @@ -340,14 +344,16 @@ PilotGo可以单机部署也可以采用集群式部署。安装之前先关闭 1. 在任意一台服务器上执行dnf install PilotGo-plugin-topology-server; 2. 将/opt/PilotGo/plugin/topology/server/config.yml文件中ip地址修改为真实ip，并配置java、neo4j、mysq、redis数据库等信息； 3. 重启服务，执行以下命令： - -`systemctl start PilotGo-plugin-topology-server` + + `systemctl start PilotGo-plugin-topology-server` + 4. 在需要topo展示的服务器上执行dnf install PilotGo-plugin-topology-agent; 5. 将/opt/PilotGo/plugin/topology/agent/config.yml文件中ip地址修改为真实ip； 6. 重启服务，执行以下命令： -`systemctl start PilotGo-plugin-topology-agent` -7. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，http://真实ip:9991，并点击确定；![本地路径](./figures/T插件1.png) + `systemctl start PilotGo-plugin-topology-agent` + +7. 成功登录pilotgo平台，点击左侧导航栏中的插件管理，点击添加插件按钮，填写插件名称和服务地址，，并点击确定；![本地路径](./figures/T插件1.png) 8. 页面增加一条插件管理数据，导航栏增加一个插件按钮。![本地路径](./figures/T插件2.png) #### 3.4.1 添加自定义拓扑配置 diff --git a/docs/zh/tools/community_tools/_toc.yaml b/docs/zh/tools/community_tools/_toc.yaml index e2155c737..e60b19568 100644 --- a/docs/zh/tools/community_tools/_toc.yaml +++ b/docs/zh/tools/community_tools/_toc.yaml @@ -15,4 +15,4 @@ sections: - href: ./epkg_use/_toc.yaml - label: 性能优化 sections: - - href: ../../server/performace/tuning_framework/oeaware/_toc.yaml + - href: ../../server/performance/tuning_framework/oeaware/_toc.yaml diff --git a/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md b/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md index 5d60534bc..332403868 100644 --- a/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md +++ b/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md @@ -149,21 +149,21 @@ 11. 配置分区：点击加号图标，新增一条配置分区，根据需要填写以下配置。 ![image](images/config_partition.png) - - 磁盘索引：磁盘的编号，请按照hdx的格式填写，x指第x块盘。 - - 挂载目录：指定分区挂载的路径。用户既可以配置业务分区，也可以对默认配置中的系统分区进行调整。 - - 分区大小：分区大小的取值有四种，可通过点击单位按钮来更换，最大上限为16T。其中MAX为指定将硬盘上剩余的空间全部用来创建一个分区，只能在最后一个分区配置该值。 - - 分区类型：分区有三种，主分区：primary；扩展分区：extended（该分区只需配置hd磁盘号即可）；逻辑分区：logical。 - - 分区文件系统类型：目前支持的文件系统类型有：ext4、vfat。 - - 是否二次格式化：表示二次安装时是否格式化，选择是或否。 + - 磁盘索引：磁盘的编号，请按照hdx的格式填写，x指第x块盘。 + - 挂载目录：指定分区挂载的路径。用户既可以配置业务分区，也可以对默认配置中的系统分区进行调整。 + - 分区大小：分区大小的取值有四种，可通过点击单位按钮来更换，最大上限为16T。其中MAX为指定将硬盘上剩余的空间全部用来创建一个分区，只能在最后一个分区配置该值。 + - 分区类型：分区有三种，主分区：primary；扩展分区：extended（该分区只需配置hd磁盘号即可）；逻辑分区：logical。 + - 分区文件系统类型：目前支持的文件系统类型有：ext4、vfat。 + - 是否二次格式化：表示二次安装时是否格式化，选择是或否。 12. 配置网络：点击加号图标，新增一条配置网络，根据需要填写以下配置。
![image](images/config_net.png) - - BOOTPROTO：none：引导时不使用协议，不配地址；static：静态分配地址；dhcp：使用DHCP协议动态获取地址。
- - DEVICE：网卡名称，如eth0。 - - IPADDR：IP地址。当BOOTPROTO参数为static时，该参数必配，如：192.168.11.100；其他情况下，该参数不用配置。
- - NETMASK：子网掩码。当BOOTPROTO参数为static时，该参数必配，如：255.255.255.0；其他情况下，该参数不用配置。
- - STARTMODE：启用网卡的方法。manual：用户在终端执行ifup命令启用网卡。auto\hotplug\ifplugd\nfsroot：当OS识别到该网卡时，便启用该网卡。off：任何情况下，网卡都无法被启用。 + - BOOTPROTO：none：引导时不使用协议，不配地址；static：静态分配地址；dhcp：使用DHCP协议动态获取地址。
+ - DEVICE：网卡名称，如eth0。 + - IPADDR：IP地址。当BOOTPROTO参数为static时，该参数必配，如：192.168.11.100；其他情况下，该参数不用配置。
+ - NETMASK：子网掩码。当BOOTPROTO参数为static时，该参数必配，如：255.255.255.0；其他情况下，该参数不用配置。
+ - STARTMODE：启用网卡的方法。manual：用户在终端执行ifup命令启用网卡。auto\hotplug\ifplugd\nfsroot：当OS识别到该网卡时，便启用该网卡。off：任何情况下，网卡都无法被启用。 13. 添加用户自定义文件：点击加号图标，弹出文件管理器弹窗，选择需要上传的文件，点击打开按钮即可上传，上传成功后状态变为成功，并且需要填写目标存放路径。若要删除文件，点击操作列的删除字段即可。 -- Gitee From 42d6bc676762e03b3767e4b388930ea07b1f0491 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Fri, 13 Jun 2025 17:24:40 +0800 Subject: [PATCH 09/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=B5=8B=E8=AF=95?= =?UTF-8?q?=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md b/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md index 332403868..86f6a003b 100644 --- a/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md +++ b/docs/zh/tools/devops/eulermaker/eulermaker_user_guide.md @@ -42,7 +42,7 @@ 1. 点击"config"tab栏， 跳转至project config页面。 2. 此页面可编辑build targets、flags、publish、config等工程配置信息。config支持yaml格式输入，配置使能开关。 ![image](images/config.png) - + ### 继承工程 1. 工程继承 @@ -99,11 +99,11 @@ **创建流水线** - 1. 首页点击“镜像定制”的查看按钮，跳转页面到流水线列表总体页面。 +1. 首页点击“镜像定制”的查看按钮，跳转页面到流水线列表总体页面。 ![image](images/pipeline_list.png) - 2. 点击“添加流水线”功能按钮，填写流水线工程页面基本信息，流水线类型可选择版本镜像及镜像定制两种类型，点击确认按钮完成创建。 +2. 点击“添加流水线”功能按钮，填写流水线工程页面基本信息，流水线类型可选择版本镜像及镜像定制两种类型，点击确认按钮完成创建。 ![image](images/pipeline_add.png) -- Gitee From 96236013ee39c4b80c4c4bf60d3ff695bc884362 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Wed, 18 Jun 2025 16:41:54 +0800 Subject: [PATCH 10/13] =?UTF-8?q?=E4=BF=AE=E6=94=B9toc=E6=96=87=E4=BB=B6?= =?UTF-8?q?=E8=A7=A3=E6=9E=90=E9=94=99=E8=AF=AF=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/server/development/fangtian/_toc.yaml | 8 -------- docs/zh/tools/community_tools/_toc.yaml | 3 --- 2 files changed, 11 deletions(-) diff --git a/docs/zh/server/development/fangtian/_toc.yaml b/docs/zh/server/development/fangtian/_toc.yaml index 2e1a0f478..398bb734b 100644 --- a/docs/zh/server/development/fangtian/_toc.yaml +++ b/docs/zh/server/development/fangtian/_toc.yaml @@ -4,15 +4,7 @@ description: FangTian视窗引擎的安装及开发使用指南。 sections: - label: FangTian视窗引擎 href: ./overview.md -<<<<<<< HEAD - label: FangTian环境配置 href: ./fangtian_environment_configuration.md - label: FangTian支持Wayland应用及鸿蒙应用 href: ./fangtian_for_linux_waylan_and_openharmony_applications.md -======= - sections: - - label: FangTian环境配置 - href: ./fangtian_environment_configuration.md - - label: FangTian支持Wayland应用及鸿蒙应用 - href: ./fangtian_for_linux_waylan_and_openharmony_applications.md ->>>>>>> ab1009ca1 (修改测试问题) diff --git a/docs/zh/tools/community_tools/_toc.yaml b/docs/zh/tools/community_tools/_toc.yaml index e60b19568..44feffbde 100644 --- a/docs/zh/tools/community_tools/_toc.yaml +++ b/docs/zh/tools/community_tools/_toc.yaml @@ -13,6 +13,3 @@ sections: - label: epkg软件包 sections: - href: ./epkg_use/_toc.yaml - - label: 性能优化 - sections: - - href: ../../server/performance/tuning_framework/oeaware/_toc.yaml -- Gitee From 5784922b1d98aebdc6d1075a4501eb4cda02f7e4 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Wed, 18 Jun 2025 16:49:44 +0800 Subject: [PATCH 11/13] =?UTF-8?q?=E5=88=A0=E9=99=A4secgear=E7=9B=AE?= =?UTF-8?q?=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../secgear/introduction_to_secgear.md | 171 ------------------ 1 file changed, 171 deletions(-) delete mode 100644 docs/zh/server/security/secgear/introduction_to_secgear.md diff --git a/docs/zh/server/security/secgear/introduction_to_secgear.md b/docs/zh/server/security/secgear/introduction_to_secgear.md deleted file mode 100644 index 68be2f523..000000000 --- a/docs/zh/server/security/secgear/introduction_to_secgear.md +++ /dev/null @@ -1,171 +0,0 @@ -# 认识secGear - -## 概述 - -随着云计算的快速发展，越来越多的企业把计算业务部署到云上，面对第三方云基础设施，云上用户数据安全面临着巨大的挑战。机密计算是一种基于硬件可信执行环境的隐私保护技术，旨在依赖最底层硬件，构建最小信任依赖，将操作系统、Hypervisor、基础设施、系统管理员、服务提供商等都从信任实体列表中删除，视为未经授权的实体，从而减少潜在的风险，保护可信执行环境中数据的机密性、完整性。然而随着机密计算技术的兴起，业界机密计算技术种类繁多（如主流的Intel SGX、ARM Trustzone、RISC-V keystone等），各技术SDK也千差万别，给开发者带来较大的开发维护成本，长远考虑，还造成了机密计算应用生态隔离。为方便开发者快速构建保护云上数据安全的机密计算解决方案，openEuler推出机密计算统一开发框架secGear。 - -## 架构介绍 - -![](./figures/secGear_arch.png) - -secGear机密计算统一开发框架技术架构如图所示，主要包括三层，共同组成openEuler机密计算软件生态底座。 - -- Base Layer：机密计算SDK统一层，屏蔽TEE及SDK差异，实现不同架构共源码。 -- Middleware Layer：通用组件层，机密计算软件货架，无需从头造轮子，帮助用户快速构建机密计算解决方案。 -- Server Layer：机密计算服务层，提供典型场景机密计算解决方案。 - -## 关键特性 - -### 零切换 - -#### 客户痛点 - -传统应用做机密计算拆分改造后，REE侧逻辑存在频繁调用TEE侧逻辑时或REE与TEE存在频繁大块数据交互时。由于REE与TEE之间的每次调用，都需要经过REE用户态 、REE内核态、驱动、TEE内核态、TEE用户态之间的上下文切换，调用传递的大块数据也要经过多次拷贝，并且驱动底层数据块大小限制等因素，频繁的REE与TEE交互性能直线下降，严重影响机密计算应用的落地。 - -#### 解决方案 - -[零切换](https://gitee.com/openeuler/secGear#switchless%E7%89%B9%E6%80%A7)是一种通过共享内存减少REE与TEE上下文切换及数据拷贝次数，优化REE与TEE交互性能的技术。 - -#### 使用方法 - -1. 创建enclave时启用零切换 - - 零切换配置项及说明如下。 - - ```c - typedef struct { - uint32_t num_uworkers; - uint32_t num_tworkers; - uint32_t switchless_calls_pool_size; - uint32_t retries_before_fallback; - uint32_t retries_before_sleep; - uint32_t parameter_num; - uint32_t workers_policy; - uint32_t rollback_to_common; - cpu_set_t num_cores; - } cc_sl_config_t; - ``` - - | 配置项 | 说明 | - | -------------------------- | ------------------------------------------------------------ | - | num_uworkers | 非安全侧代理工作线程数，用于执行switchless OCALL，当前该字段仅在SGX平台生效，ARM平台可以配置，但是因ARM平台暂不支持OCALL，所以配置后不会生效。
规格：
ARM：最大值：512；最小值：1；缺省值：8（配置为0时）
SGX：最大值：4294967295；最小值：1 | - | num_tworkers | 安全侧代理工作线程数，用于执行switchless ECALL。
规格：
ARM：最大值：512；最小值：1；缺省值：8（配置为0时）
SGX：最大值：4294967295；最小值：1 | - | switchless_calls_pool_size | switchless调用任务池的大小，实际可容纳switchless_calls_pool_size * 64个switchless调用任务（例：switchless_calls_pool_size=1，可容纳64个switchless调用任务）。
规格：
ARM：最大值：8；最小值：1；缺省值：1（配置为0时）
SGX：最大值：8；最小值：1；缺省值：1（配置为0时） | - | retries_before_fallback | 执行retries_before_fallback次汇编pause指令后，若switchless调用仍没有被另一侧的代理工作线程执行，就回退到switch调用模式，该字段仅在SGX平台生效。
规格：SGX：最大值：4294967295；最小值：1；缺省值：20000（配置为0时） | - | retries_before_sleep | 执行retries_before_sleep次汇编pause指令后，若代理工作线程一直没有等到有任务来，则进入休眠状态，该字段仅在SGX平台生效。
规格： SGX：最大值：4294967295；最小值：1；缺省值：20000（配置为0时） | - | parameter_num | switchless函数支持的最大参数个数，该字段仅在ARM平台生效。
规格： ARM：最大值：16；最小值：0 | - | workers_policy | switchless代理线程运行模式，该字段仅在ARM平台生效。
规格： ARM： WORKERS_POLICY_BUSY：代理线程一直占用CPU资源，无论是否有任务需要处理，适用于对性能要求极高且系统软硬件资源丰富的场景； WORKERS_POLICY_WAKEUP：代理线程仅在有任务时被唤醒，处理完任务后进入休眠，等待再次被新任务唤醒 | - | rollback_to_common | 异步switchless调用失败时是否回退到普通调用，该字段仅在ARM平台生效。
规格： ARM：0：否，失败时仅返回相应错误码；其他：是，失败时回退到普通调用，此时返回普通调用的返回值 | - | num_cores | 用于设置安全侧线程绑核
规格： 最大值为当前环境CPU核数 | - -2. 定义EDL文件中接口时添加零切换标识transition_using_threads - - ```ocaml - enclave { - include "secgear_urts.h" - from "secgear_tstdc.edl" import *; - from "secgear_tswitchless.edl" import *; - trusted { - public int get_string([out, size=32]char *buf); - public int get_string_switchless([out, size=32]char *buf) transition_using_threads; - }; - }; - ``` - -### 安全通道 - -#### 客户痛点 - -数据拥有者在请求云上机密计算服务时，需要把待处理数据上传到云上TEE环境中处理，由于TEE没有网络，用户数据需要经过网络先传输到REE，REE接收到数据的明文后，再传入TEE中。用户数据的明文暴露在REE内存中，存在安全风险。 - -#### 解决方案 - -安全通道是一种结合机密计算远程证明，实现数据拥有者与云上TEE之间安全的密钥协商技术，协商出仅数据拥有者与云上TEE拥有的sessionkey，再通过sessionkey加密用户数据，网络传输的是sessionkey加密后的数据，REE接收到密文数据，再传入TEE中解密，处理。 - -#### 使用方法 - -安全通道以lib库方式提供，分为客户端、服务端host、服务端enclave三部分，分别由业务程序的客户端、服务端CA、服务端TA调用。 -| 模块 | 头文件 | 库文件 | 依赖 | -|------------|--------------------------|-----------------------|---------| -| 客户端 | secure_channel_client.h | libcsecure_channel.so | openssl | -| 服务端host | secure_channel_host.h | libusecure_channel.so | openssl | -| 服务端enclave | secure_channel_enclave.h | libtsecure_channel.so | TEE及TEE软件栈 | - -##### 接口列表 - -| 接口名 | 所属头文件、库 | 功能 | 备注 | -|----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|--------------|----| -| cc_sec_chl_client_init | secure_channel_client.h libcsecure_channel.so | 安全通道客户端初始化 | 调用前需初始化参数ctx中网络连接和消息发送钩子函数 | -| cc_sec_chl_client_fini | secure_channel_client.h libcsecure_channel.so | 安全通道客户端销毁 | 通知服务端销毁本客户端的信息，销毁本地安全通道信息 | -| cc_sec_chl_client_callback | secure_channel_client.h libcsecure_channel.so | 安全通道协商消息处理函数 | 处理安全通道协商过程中，服务端发送给客户端的消息。在客户端消息接收处调用 | -| cc_sec_chl_client_encrypt | secure_channel_client.h libcsecure_channel.so | 安全通道客户端的加密接口 | 无 | -| cc_sec_chl_client_decrypt | secure_channel_client.h libcsecure_channel.so | 安全通道客户端的解密接口 | 无 | -| int (*cc_conn_opt_funcptr_t)(void *conn, void *buf, size_t count); | secure_channel.h | 消息发送钩子函数原型 | 由用户客户端和服务端实现，实现中指定安全通道协商消息类型，负责发送安全通道协商消息到对端 | -| cc_sec_chl_svr_init | secure_channel_host.h libusecure_channel.so | 安全通道服务端初始化 | 调用前需初始化ctx中enclave_ctx | -| cc_sec_chl_svr_fini | secure_channel_host.h libusecure_channel.so | 安全通道服务端销毁 | 销毁安全通道服务端以及所有客户端信息 | -| cc_sec_chl_svr_callback | secure_channel_host.h libusecure_channel.so | 安全通道协商消息处理函数 | 处理安全通道协商过程中，客户端发送给服务端的消息。在服务端消息接收处调用，调用前需初始化与客户端的网络连接和发送消息函数，详见[样例](https://gitee.com/openeuler/secGear/blob/master/examples/secure_channel/host/server.c#:~:text=conn_ctx.conn_kit.send)。 | -| cc_sec_chl_enclave_encrypt | secure_channel_enclave.h libtsecure_channel.so | 安全通道enclave中的加密接口 | 无 | -| cc_sec_chl_enclave_decrypt | secure_channel_enclave.h libtsecure_channel.so | 安全通道enclave中的解密接口 | 无 | - -##### 注意事项 - -安全通道仅封装密钥协商过程、加解密接口，不建立网络连接，协商过程复用业务的网络连接。其中客户端和服务端的网络连接由业务建立和维护，在安全通道客户端和服务端初始化时传入消息发送钩子函数和网络连接指针。 -详见[安全通道样例](https://gitee.com/openeuler/secGear/tree/master/examples/secure_channel)。 - -### 远程证明 - -#### 客户痛点 - -随着机密计算技术的发展，逐渐形成几大主流技术（如Arm Trustzone/CCA、Intel SGX/TDX、擎天Enclave、海光CSV等），产品解决方案中可能存在多种机密计算硬件，甚至不同TEE之间的协同，其中远程证明是任何一种机密计算技术信任链的重要一环，每种技术的远程证明报告格式及验证流程各有差异，用户对接不同的TEE，需要集成不同TEE证明报告的验证流程，增加了用户的集成负担，并且不利于扩展新的TEE类型。 - -#### 解决方案 - -secGear远程证明统一框架是机密计算远程证明相关的关键组件，屏蔽不同TEE远程证明差异，提供Attestation Agent和Attestation Service两个组件，Agent供用户集成获取证明报告，对接证明服务；Service可独立部署，支持iTrustee、virtCCA远程证明报告的验证。 - -#### 功能描述 - -远程证明统一框架聚焦机密计算相关功能，部署服务时需要的服务运维等相关能力由服务部署第三方提供。远程证明统一框架的关键技术如下： - -- 报告校验插件框架：支持运行时兼容iTrustee、vritCCA、CCA等不同TEE平台证明报告检验，支持扩展新的TEE报告检验插件。 -- 证书基线管理：支持对不同TEE类型的TCB/TA基线值管理及公钥证书管理，集中部署到服务端，对用户透明。 -- 策略管理：提供默认策略（易用）、用户定制策略（灵活）。 -- 身份令牌：支持对不同TEE签发身份令牌，由第三方信任背书，实现不同TEE类型相互认证。 -- 证明代理：支持对接证明服务/点对点互证，兼容TEE报告获取，身份令牌验证等，易集成，使用户聚焦业务。 - -根据使用场景，支持点对点验证和证明服务验证两种模式。 - -证明服务验证流程如下： - -1.用户（普通节点或TEE）对TEE平台发起挑战。 - -2.TEE平台通过证明代理获取TEE证明报告，并返回给用户。 - -3.用户端证明代理将报告转发到远程证明服务。 - -4.远程证明服务完成报告校验，返回由第三方信任背书的统一格式身份令牌。 - -5.证明代理验证身份令牌，并解析得到证明报告校验结果。 - -6.得到通过的校验结果后，建立安全连接。 - -点对点验证流程(无证明服务)如下： - -1.用户向TEE平台发起挑战，TEE平台返回证明报告给用户。 - -2.用户使用本地点对点TEE校验插件完成报告验证。 - -> ![](./public_sys-resources/icon-note.gif) **说明：** -> -> 点对点验证和远程证明服务验证时的证明代理不同，在编译时可通过编译选项，决定编译有证明服务和点对点模式的证明代理。 - -#### 应用场景 - -在金融、AI等场景下，基于机密计算保护运行中的隐私数据安全时，远程证明是校验机密计算环境及应用合法性的技术手段，远程证明统一框架提供了易集成、易部署的组件，帮助用户快速使能机密计算远程证明能力。 - -## 缩略语 - -| 缩略语 | 英文全名 | 中文解释 | -| ------ | ----------------------------- | ---------------- | -| REE | Rich Execution Environment | 富执行环境 | -| TEE | Trusted Execution Environment | 可信执行环境 | -| EDL | Enclave Description Language | 安全应用描述语言 | -- Gitee From 1d7f695bf53405feec624b62e77973004c676341 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Wed, 18 Jun 2025 16:52:29 +0800 Subject: [PATCH 12/13] =?UTF-8?q?=E5=88=A0=E9=99=A4sysBoost=E7=9B=AE?= =?UTF-8?q?=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../sysboost => archive}/getting_to_know_sysBoost.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {docs/zh/server/performance/cpu_optimization/sysboost => archive}/getting_to_know_sysBoost.md (100%) diff --git a/docs/zh/server/performance/cpu_optimization/sysboost/getting_to_know_sysBoost.md b/archive/getting_to_know_sysBoost.md similarity index 100% rename from docs/zh/server/performance/cpu_optimization/sysboost/getting_to_know_sysBoost.md rename to archive/getting_to_know_sysBoost.md -- Gitee From 2210571fadb42868c6160cd8216ead4394eaae61 Mon Sep 17 00:00:00 2001 From: hemiao11 Date: Wed, 18 Jun 2025 16:53:20 +0800 Subject: [PATCH 13/13] =?UTF-8?q?=E6=B7=BB=E5=8A=A0sysBoost=E7=9B=AE?= =?UTF-8?q?=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml | 2 +- .../cpu_optimization/sysboost/getting_to_know_sysboost.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename archive/getting_to_know_sysBoost.md => docs/zh/server/performance/cpu_optimization/sysboost/getting_to_know_sysboost.md (100%) diff --git a/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml b/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml index c870a2509..ca19c8348 100644 --- a/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml +++ b/docs/zh/server/performance/cpu_optimization/sysboost/_toc.yaml @@ -3,7 +3,7 @@ isManual: true description: 优化代码与运行环境的 CPU 微架构的适应性，提升程序性能 sections: - label: 认识sysBoost - href: ./getting_to_know_sysBoost.md + href: ./getting_to_know_sysboost.md - label: 安装与部署 href: ./installation_and_deployment.md - label: 使用方法 diff --git a/archive/getting_to_know_sysBoost.md b/docs/zh/server/performance/cpu_optimization/sysboost/getting_to_know_sysboost.md similarity index 100% rename from archive/getting_to_know_sysBoost.md rename to docs/zh/server/performance/cpu_optimization/sysboost/getting_to_know_sysboost.md -- Gitee