diff --git a/docs/zh/x_diagnosis/_toc.yaml b/archive/x_diagnosis/_toc.yaml similarity index 100% rename from docs/zh/x_diagnosis/_toc.yaml rename to archive/x_diagnosis/_toc.yaml diff --git a/docs/zh/x_diagnosis/x_diagnosis.md b/archive/x_diagnosis/x_diagnosis.md similarity index 100% rename from docs/zh/x_diagnosis/x_diagnosis.md rename to archive/x_diagnosis/x_diagnosis.md diff --git a/docs/zh/cloud/container_runtime/kuasar/kuasar_install_config.md b/docs/zh/cloud/container_runtime/kuasar/kuasar_install_config.md index 316232d7f7e6e9939d38c5ad70b9085b38b13b02..6f48935b33fd879330a7959c8de63b2af6d6c1e8 100644 --- a/docs/zh/cloud/container_runtime/kuasar/kuasar_install_config.md +++ b/docs/zh/cloud/container_runtime/kuasar/kuasar_install_config.md @@ -7,7 +7,7 @@ - 为了获取更好的性能体验，kuasar需要运行在裸金属服务器上，**暂不支持kuasar运行在虚拟机内**。 - kuasar运行依赖以下openEuler组件，请确保环境上已安装所需版本的依赖组件。 - iSulad（请参考iSula容器引擎的[安装与配置](../../container_engine/isula_container_engine/installation_configuration.md)章节安装iSulad） - - StratoVirt（请参考StratoVirt的[安装](../../../virtulization/virtulization_platform/stratovirt/install_stratovirt.md)章节安装StratoVirt） + - StratoVirt（请参考StratoVirt的[安装](../../../virtualization/virtualization_platform/stratovirt/install_stratovirt.md)章节安装StratoVirt） ### 安装操作 diff --git a/docs/zh/cloud/kmesh/kmesh/installation_and_deployment.md b/docs/zh/cloud/kmesh/kmesh/installation_and_deployment.md index f0ecb5cd4003ebf976840b814ac966697b434535..0b7cd86cccea4c4c3fb33b47510f97f0cd62116a 100644 --- a/docs/zh/cloud/kmesh/kmesh/installation_and_deployment.md +++ b/docs/zh/cloud/kmesh/kmesh/installation_and_deployment.md @@ -10,7 +10,7 @@ ## 环境准备 -* 安装openEuler系统，安装方法参考 《[安装指南](../../../server/installation_upgrade/installation/installation-on-servers.md)》。 +* 安装openEuler系统，安装方法参考 《[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 * 安装Kmesh需要使用root权限。 ## 安装Kmesh diff --git a/docs/zh/cloud/kubeos/kubeos/installation_and_deployment.md b/docs/zh/cloud/kubeos/kubeos/installation_and_deployment.md index 7af41ffb920f7fd2122c4896aee985007f381f19..029f71a6f3fb9d270a6b6559425e60b1b65e29e6 100644 --- a/docs/zh/cloud/kubeos/kubeos/installation_and_deployment.md +++ b/docs/zh/cloud/kubeos/kubeos/installation_and_deployment.md @@ -14,7 +14,7 @@ ### 环境准备 -* 安装 openEuler 系统，安装方法参考《[安装指南](../../../server/installation_upgrade/installation/installation-on-servers.md)》 +* 安装 openEuler 系统，安装方法参考《[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》 * 安装 qemu-img，bc，parted，tar，yum，docker，dosfstools ## 安装容器OS升级工具 @@ -157,7 +157,7 @@ * 请先部署 Kubernetes 集群，部署方法参考[《openEuler 24.03-LTS-SP1 Kubernetes 集群部署指南》](../../cluster_deployment/kubernetes/overview.md)。 -* 集群中准备进行升级的 Worker 节点的 OS 需要为使用上一节方式制作出来的容器 OS，如不是，请用 system.qcow2重新部署虚拟机，虚拟机部署请见[《openEuler 24.03-LTS-SP1 虚拟化用户指南》](../../../virtulization/virtulization_platform/virtulization/introduction_to_virtualization.md)，Master节点目前不支持容器 OS 升级，请用openEuler 24.03-LTS-SP1部署Master节点。 +* 集群中准备进行升级的 Worker 节点的 OS 需要为使用上一节方式制作出来的容器 OS，如不是，请用 system.qcow2重新部署虚拟机，虚拟机部署请见[《openEuler 24.03-LTS-SP1 虚拟化用户指南》](../../../virtualization/virtualization_platform/virtualization/introduction_to_virtualization.md)，Master节点目前不支持容器 OS 升级，请用openEuler 24.03-LTS-SP1部署Master节点。 * 部署 OS 的 CRD（CustomResourceDefinition），os-operator，os-proxy 以及 RBAC (Role-based access control) 机制的 YAML 需要用户自行编写。 * operator 和 proxy 部署在 kubernetes 集群中，operator 应部署为 deployment，proxy 应部署为daemonset。 * 尽量部署好 kubernetes 的安全措施，如 rbac 机制，pod 的 service account 和 security policy 配置等。 diff --git a/docs/zh/cloud/kubeos/kubeos/kubeos_image_creation.md b/docs/zh/cloud/kubeos/kubeos/kubeos_image_creation.md index 419abb5c5450116cfa1d69d6167f3f3f9d1920f8..cb684eabd31cce09f8d71b2b08042f61a17d1d1b 100644 --- a/docs/zh/cloud/kubeos/kubeos/kubeos_image_creation.md +++ b/docs/zh/cloud/kubeos/kubeos/kubeos_image_creation.md @@ -272,7 +272,7 @@ version = "v1" #### 注意事项 * 制作出来的容器 OS 物理安装所需的镜像目前只能用于 CPU 架构为 x86 和 AArch64 的物理机安装。 -* `pxe_config`配置中指定的ip为安装时使用的临时ip,请在系统安装启动后请参考[《openEuler 24.03-LTS-SP1 管理员指南-配置网络》](../../../server/network/network_config/network-configuration.md)进行网络配置。 +* `pxe_config`配置中指定的ip为安装时使用的临时ip,请在系统安装启动后请参考[《openEuler 24.03-LTS-SP1 管理员指南-配置网络》](../../../server/network/network_config/network_configuration.md)进行网络配置。 * 不支持多个磁盘都安装KubeOS，可能会造成启动失败或挂载紊乱。 * 容器OS 目前不支持 x86 架构的物理机使用 legacy 启动模式启动。 * 使用默认rpmlist进行镜像制作时所需磁盘空间至少为5G，如自已定义 rpmlist 可能会超过5G。 diff --git a/docs/zh/devstation/oedeploy/oedeploy_userguide.md b/docs/zh/devstation/oedeploy/oedeploy_userguide.md deleted file mode 100644 index 261d8a4087771742fcbc9bcb2adb65d4262e829e..0000000000000000000000000000000000000000 --- a/docs/zh/devstation/oedeploy/oedeploy_userguide.md +++ /dev/null @@ -1,243 +0,0 @@ -# oeDeploy 用户指南 - -## 1 工具介绍 - -### 1.1 oeDeploy简介 - -oeDeploy（简称oedp）作为应用快速安装部署平台，将提供如下能力： - -1. 插件库：实现应用快速安装的基础，应用提供部署的基本能力就可按照基本规范进行oedp 插件化改造，oedp本身对插件的能力进行解析和调度执行 -2. 应用碎片化部署能力自动ansible化改造：针对不具备自动化安装的应用，指定安装步骤进行配置，oedp工具解析，自动转换成ansible playbook配置 -3. 应用一键安装能力集成：支持具备一键脚本安装部署/ansible自动化安装部署的快速插件集成 -4. 分发能力：oedp支持应用部署在对应host上的的一键分发 -5. ansible集成： 目前oedp的一些基础能力基于ansible进行改造 - -### 1.2 工具组成 - -oedp工具由以下三部分组成： - -+ oedp Web UI：**(待实现)** Web UI 旨在简化用户操作流程，降低用户（尤其是初学者）的学习成本，快速、高效地使用 oedp 工具。Web UI 基于命令行工具，通过将用户的配置转化为对应的命令行来完成部署任务。 -+ oedp 命令行工具：命令行工具本身不直接提供实际部署功能，而是作为一个集成、分发的平台，调起插件的部署功能，并向用户或UI进行反馈。对于高阶使用者，可以使用命令行工具来直接完成部署任务，相较于使用 Web UI，能够实现更加定制化的操作。 -+ oedp 插件：插件用于提供原子化的自动化部署能力，并提供操作接口，分别实现不同的部署操作，例如安装、卸载、环境清理等。 - -### 1.3 获取与安装 - -用户可以自主获取 oedp 工具，支持x86_64和aarch64架构。 - -获取 oedp 工具后，使用 yum/dnf 进行安装：`yum install -y oedp-xxx.rpm`。 - -### 1.4 命令列表 - -+ `oedp init `：初始化一个插件 - + `-p|--project `：必须，指定初始化路径 - + `-l|--local `：可选，指定一个路径为本地源 - + `-f|--force`：可选，强制覆盖路径，如果路径存在，会先删除其中的所有文件再初始化 -+ `oedp list`：列举有哪些可用的插件 - + `-l|--local `：可选，指定一个路径为本地源 -+ `oedp info`：查看一个项目的详细信息 - + `-p|--project `：可选，指定一个项目，如果没有指定就使用当前路径 -+ `oedp run `：执行一个项目的方法 - + ``：插件可使用的方法名称，可通过`oedp info`命令查询获得 - + `-p|--project `：可选，指定一个项目，如果没有指定就使用当前路径 -+ `oedp check`：**(待实现)** 检查一个项目 - + `-p|--project `：可选，指定一个项目，如果没有指定就使用当前路径 - -### 1.5 工具文件路径 - -+ `/var/oedp/log/`：日志文件路径 -+ `/var/oedp/plugin/`：插件缓存路径 -+ `/usr/lib/oedp/src/`：源码路径 -+ `/etc/oedp/config`：配置文件路径 - -## 2 用户部署指南 - -下面以自动化部署kubernetes-1.31.1为例，讲解部署流程： - -### 2.1 获取部署插件 - -**以下功能暂未实现：** - -~~执行`install`命令以获取插件并初始化一个项目到家目录：~~ - -```shell -oedp init kubernetes-1.31.1 -p . -``` - -**当前暂时采用以下方案：** - -手动获取插件包`kubernetes-1.31.1.tar.gz`。 - -将获取的插件包解压在当前目录下，确保当前目录下出现了目录`kubernetes-1.31.1/`。 - -### 2.2 查看插件详细信息 - -执行`info`命令以查看插件详细信息： - -```shell -oedp info -p kubernetes-1.31.1 -``` - -### 2.3 配置节点信息 - -修改项目配置文件，根据实际情况配置节点信息： - -```shell -vim kubernetes-1.31.1/config.yaml -``` - -注意： - -+ 主机ssh配置支持密码登录和密钥登录两种方式，如果使用密钥登录，则不需要配置密码。 -+ 无论使用哪种方式进行ssh连接，都需要确保控制节点可用ssh访问目标主机，并确保所有目标主机都加入了控制节点的`known_hosts`中（可以通过手动ssh连接一次每一台目标主机来实现）。 - -### 2.4 执行部署 - -执行以下命令以开始自动化部署： - -```shell -oedp run install -p kubernetes-1.31.1 -``` - -执行以下命令以卸载k8s： - -```shell -oedp run delete -p kubernetes-1.31.1 -``` - -## 3 插件开发指南 - -### 3.1 oedp 插件介绍 - -oedp 插件（plugin）是 oedp 工具中提供自动化部署能力的组件，通过将复杂的部署流程 ansible 化来实现自动化部署。插件中可能会集成多种部署操作（action），例如安装、卸载、环境清理等，每一个部署操作都会对应一个 ansible playbook。插件的所有可配置项都应当集中配置，以降低使用者的学习成本和开发者的维护成本。 - -### 3.2 目录结构 - -插件开发者在开发插件时应当遵循以下目录结构： - -```yaml -{plugin_name} -|-- main.yaml -|-- config.yaml -`-- workspace/ -``` - -| 文件或者目录名 | 介绍 | -|-------------|------------------------------------------------------| -| config.yaml | 包含主机相关的配置，如ip、密码、密钥、端口号等，还包含了应用的一些部署相关的配置，支持jinja2语言 | -| main.yaml | oedp识别应用部署流程的主配置文件 | -| workspace | 应用的部署能力库 | - -其中，`plugin_name`有以下约束： - -+ 该插件部署的软件名称为`name`，版本为`version`。 -+ `plugin_name`必须是以下两种之一： - + `{name}-{version}` - + `{name}-{version}-xxx` -+ 例如，一个插件用于部署kubernetes软件，版本为1.31.1，那么该插件的名称可以是：`kubernetes-1.31.1`，`kubernetes-1.31.1-20240101`，`kubernetes-1.31.1-offline-20240101`等。 - -下面以kubernetes-1.31.1部署插件为例，简单介绍yaml文件的内容： - -#### 3.2.1 main.yaml - -`main.yaml`主要用于记录插件的关键信息，包括：名称（name）、版本（version）、介绍（description）、操作（action）等，当用户执行`oedp info`命令时，oedp工具会读取并解析该文件，然后向用户展示其详细信息。 - -在`action`项中，应当是一个字典（key-value map），每一个 key 将作为操作的名称，对应的 value 中记录了该操作的详情。 - -操作详情是一个字典，其中的`description`项是该操作的说明，用于在执行`oedp info`命令时向用户展示，而`tasks`项中则记录该操作的具体步骤，为一个列表，执行该操作时，将按顺序执行每一项步骤。 - -在步骤中，开发者应当指定该步骤需要执行的`playbook`的路径，如果有需要，也可以在`vars`中指定变量文件的路径。所有路径都是相对`workspace`的相对路径。此外，可以指定`scope`，即该步骤需要执行的主机组，默认为`all`。 - -```yaml -name: kubernetes -version: 1.31.1 -description: install kubernetes 1.31.1 -action: - install: - description: install kubernetes - tasks: - - name: install kubernetes - playbook: init-k8s.yml - vars: variables.yml - scope: all - delete: - description: delete kubernetes - tasks: - - name: delete kubernetes - playbook: delete-k8s.yml - vars: variables.yml - scope: all - clean: - description: clean cache files - tasks: - - name: clean cache files - playbook: clean-k8s.yml - scope: all -``` - -上述插件中，`workspace/`中的目录结构为： - -```yaml -workspace -|-- roles -| `-- ... -|-- init-k8s.yml -|-- delete-k8s.yml -|-- clean-k8s.yml -|-- variables.yml -`-- ... -``` - -#### 3.2.2 config.yaml - -`config.yaml`是插件中的用户配置文件，主要包含对主机组的配置和一些其他的全局配置，遵循 ansible 的 inventory 文件配置规则，在执行 ansible playbook 时可直接作为 inventory 传入。 - -插件开发者在开发插件时应注意，要将所有的配置项集中在该文件中进行配置。 - -```yaml -all: - children: - masters: - hosts: - Master1: - ansible_host: 192.168.10.1 - ansible_port: 22 - ansible_user: root - ansible_password: password - architecture: amd64 - oeversion: 24.03-LTS - workers: - hosts: - Worker1: - ansible_host: 192.168.10.2 - ansible_port: 22 - ansible_user: root - architecture: arm64 - oeversion: 22.03-LTS - Worker2: - ansible_host: 192.168.10.3 - ansible_port: 22 - ansible_user: root - architecture: amd64 - oeversion: 22.03-LTS - vars: - init_cluster_force: "true" - kubernetes_version: 1.31.1 - service_cidr: 10.96.0.0/16 - pod_cidr: 10.244.0.0/16 - pause_image: registry.k8s.io/pause:3.10 - calico_version: 3.28.2 - certs_expired: 3650 - has_deployed_containerd: "false" -``` - -### 3.3 插件打包 - -如果要发布插件供用户使用，需要将插件打包成`{plugin_name}.tar.gz`的格式，压缩包的名称和包内目录的名称要对应，且解压后应当仅生成一个目录，例如： - -```yaml -kubernetes-1.31.1.tar.gz -`-- kubernetes-1.31.1 - |-- main.yaml - |-- config.yaml - `-- workspace/ -``` diff --git a/docs/zh/edge_computing/_toc.yaml b/docs/zh/edge_computing/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..3a1bc0ae89fe47b293c9e2519fcaf96e987489bd --- /dev/null +++ b/docs/zh/edge_computing/_toc.yaml @@ -0,0 +1,5 @@ +label: 边缘计算 +sections: + - href: ./kube_edge/_toc.yaml + - href: ./k3s/_toc.yaml + - href: ./ros/_toc.yaml \ No newline at end of file diff --git a/docs/zh/edge_computing/kubeedge/_toc.yaml b/docs/zh/edge_computing/kube_edge/_toc.yaml similarity index 100% rename from docs/zh/edge_computing/kubeedge/_toc.yaml rename to docs/zh/edge_computing/kube_edge/_toc.yaml diff --git a/docs/zh/edge_computing/kubeedge/kubeedge_deployment_guide.md b/docs/zh/edge_computing/kube_edge/kube_edge_deployment_guide.md similarity index 99% rename from docs/zh/edge_computing/kubeedge/kubeedge_deployment_guide.md rename to docs/zh/edge_computing/kube_edge/kube_edge_deployment_guide.md index 08804ac73447d11d8e0b26486a3fab38d0bd2f05..9738604a11a2f085db6af7982406a95ef9eec9b1 100644 --- a/docs/zh/edge_computing/kubeedge/kubeedge_deployment_guide.md +++ b/docs/zh/edge_computing/kube_edge/kube_edge_deployment_guide.md @@ -6,13 +6,13 @@ KubeEdge 是一个致力于解决边缘场景问题的开源系统，它将容器化应用程序编排和设备管理的能力扩展到边缘设备。基于 Kubernetes，KubeEdge 为网络、应用程序部署以及云侧与边缘侧之间的元数据同步提供核心基础设施支持。KubeEdge 支持 MQTT，并允许开发人员编写自定义逻辑，在边缘上启用资源受限的设备通信。KubeEdge 由云部分和边缘部分组成，目前均已开源。 -> https://kubeedge.io/ +> ### iSulad iSulad 是一个轻量级容器 runtime 守护程序，专为 IOT 和 Cloud 基础设施而设计，具有轻便、快速且不受硬件规格和体系结构限制的特性，可以被更广泛地应用在云、IoT、边缘计算等多个场景。 -> https://gitee.com/openeuler/iSulad +> ## 集群概览 @@ -63,7 +63,6 @@ $ ./setup-cloud.sh k8s 的安装部署使用 openEuler 22.03 SP2 的版本 - #### 安装云侧容器网络 目前有丰富的 cni 软件可以为 k8s 节点提供容器网络功能，比如 [flannel](https://github.com/flannel-io/flannel)、[calico](https://github.com/projectcalico/calico)、[cilium](https://github.com/cilium/cilium) 等，如果你暂时不明确选用哪款 cni 软件，可以使用下方命令安装云侧容器网络： diff --git a/docs/zh/edge_computing/kubeedge/kubeedge_user_document.md b/docs/zh/edge_computing/kube_edge/kube_edge_user_document.md similarity index 100% rename from docs/zh/edge_computing/kubeedge/kubeedge_user_document.md rename to docs/zh/edge_computing/kube_edge/kube_edge_user_document.md diff --git a/docs/zh/edge_computing/kubeedge/overview.md b/docs/zh/edge_computing/kube_edge/overview.md similarity index 86% rename from docs/zh/edge_computing/kubeedge/overview.md rename to docs/zh/edge_computing/kube_edge/overview.md index c4ef29a92390e6540b6fb2b446bf4e90e3d11d91..35ea2e30875b9b41cffb7e4e42f0a7531fd131f3 100644 --- a/docs/zh/edge_computing/kubeedge/overview.md +++ b/docs/zh/edge_computing/kube_edge/overview.md @@ -1,3 +1,3 @@ # KubeEdge 边缘计算平台用户指南 -本文档主要介绍了边缘计算平台 KubeEdge 的部署与使用，让用户了解 KubeEdge，并指导用户和管理员安装和使用 KubeEdge。 \ No newline at end of file +本文档主要介绍了边缘计算平台 KubeEdge 的部署与使用，让用户了解 KubeEdge，并指导用户和管理员安装和使用 KubeEdge。 diff --git a/docs/zh/edge_computing/ros/_toc.yaml b/docs/zh/edge_computing/ros/_toc.yaml index 9a1c4c0590733ac852b9e6f0fba00a5d14a8eb63..a2895f5cacbaf7a797f000f447e42e0f0e7d08b0 100644 --- a/docs/zh/edge_computing/ros/_toc.yaml +++ b/docs/zh/edge_computing/ros/_toc.yaml @@ -1,6 +1,6 @@ label: ROS 用户指南 isManual: true -description: 主要介绍了 openEuler 系统上 ROS 的安装0部署与使用方法。 +description: 主要介绍了 openEuler 系统上 ROS 的安装部署与使用方法。 sections: - label: ROS 用户指南 href: ./ros_user_guide.md diff --git a/docs/zh/edge_computing/ros/installation_and_deployment.md b/docs/zh/edge_computing/ros/installation_and_deployment.md index eec4f8500572b66318453b99c25575aa84dacca9..4fbe1ef85ebfd69412d0c275cc10957b17652edd 100644 --- a/docs/zh/edge_computing/ros/installation_and_deployment.md +++ b/docs/zh/edge_computing/ros/installation_and_deployment.md @@ -6,7 +6,7 @@ ## 环境准备 -* 安装 openEuler 系统，安装方法参考 《[安装指南](../../server/installation_upgrade/installation/installation-on-servers.md)》。 +* 安装 openEuler 系统，安装方法参考 《[安装指南](../../server/installation_upgrade/installation/installation_on_servers.md)》。 ## 1. ROS2 @@ -16,34 +16,33 @@ 1. 安装ros-humble 软件包 -```shell -[root@openEuler ~]# yum install openeuler-ros -[root@openEuler ~]# yum install ros-noetic-* -``` + ```shell + [root@openEuler ~]# yum install openeuler-ros + [root@openEuler ~]# yum install ros-noetic-* + ``` 2. 执行如下命令，查看安装是否成功。如果回显有对应软件包，表示安装成功。 -```shell -[root@openEuler ~]# rpm -q ros-humble -``` + ```shell + [root@openEuler ~]# rpm -q ros-humble + ``` ### 2. ros-noetic #### 2. 安装ros-noetic - 1. 安装ros-noetic 软件包 -```shell -[root@openEuler ~]# yum install openeuler-ros -[root@openEuler ~]# yum install ros-noetic-* -``` + ```shell + [root@openEuler ~]# yum install openeuler-ros + [root@openEuler ~]# yum install ros-noetic-* + ``` 2. 执行如下命令，查看安装是否成功。如果回显有对应软件包，表示安装成功。 -```shell -[root@openEuler ~]# rpm -q ros-noetic -``` + ```shell + [root@openEuler ~]# rpm -q ros-noetic + ``` #### 2. 测试 ros-humble @@ -51,18 +50,18 @@ 1. 启动小乌龟 -```shell -[root@openEuler ~]# source /opt/ros/humble/setup.bash -[root@openEuler ~]# ros2 run turtlesim turtlesim_node -``` + ```shell + [root@openEuler ~]# source /opt/ros/humble/setup.bash + [root@openEuler ~]# ros2 run turtlesim turtlesim_node + ``` 2. 打开小乌龟控制终端 -```shell -[root@openEuler ~]# source /opt/ros/humble/setup.bash -[root@openEuler ~]# ros2 run turtlesim turtle_teleop_key -``` + ```shell + [root@openEuler ~]# source /opt/ros/humble/setup.bash + [root@openEuler ~]# ros2 run turtlesim turtle_teleop_key + ``` 3. 在乌龟控制终端中使用方向键控制乌龟运动 -![ros-humble](./figures/ros-humble.png) + ![ros-humble](./figures/ros-humble.png) diff --git a/docs/zh/memory_fabric/images/.keep b/docs/zh/memory_fabric/images/.keep deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000 diff --git a/docs/zh/memory_fabric/images/IntegratedDeployment.png b/docs/zh/memory_fabric/images/IntegratedDeployment.png deleted file mode 100644 index 0fc7d1b0a3d3cf31a2da0bff64bf03f576234771..0000000000000000000000000000000000000000 Binary files a/docs/zh/memory_fabric/images/IntegratedDeployment.png and /dev/null differ diff --git a/docs/zh/memory_fabric/memory_fabric_deployment_guide.md b/docs/zh/memory_fabric/memory_fabric_deployment_guide.md deleted file mode 100644 index 71945d53012aedf602ac4844613afe56a7840dee..0000000000000000000000000000000000000000 --- a/docs/zh/memory_fabric/memory_fabric_deployment_guide.md +++ /dev/null @@ -1,96 +0,0 @@ -# Memory Fabric用户文档 - -- [简介](简介.md) -- [部署](部署.md) -- [启动](启动.md) -- [接口](接口.md) - -# 简介 - -内存池套件是基于内存型介质和新型网络技术，构建高性能的分布式内存资源池，并通过BigMemory、MemPlog、MemKV等语义对应用提供服务。 - -内存池套件使用和管理的资源来自计算节点或者单独资源节点提供的可共享的DRAM/Persistent Memory/内存盘等（不支持普通disk直接互联池化），结合新型互联协议（RDMA，CXL，UBUS）us级传输时延，期望内存池套件通过极低的软件时延和节点CPU开销带来整体性能提升。 - -# 部署 - -Memory Fabric需要根据节点类型、资源分布情况和应用需求做到多场景应用集成部署，具体描述如下： - -- 计算和MF资源共节点时支持client和server同节点部署，如[图1](#fig17349154610267)node1、node2所示。 -- 资源独立提供时也支持client、server分离节点部署，如[图1](#fig17349154610267)node3、node4所示。 -- 支持同节点部署和分离节点部署两种场景混合部署。 -- 节点内支持多client，也支持多server模式部署，如[图1](#fig17349154610267)node2所示。 -- client与同节点的server通信使用IPC，配置支持连接远端server时使用RPC通信。 -- server端接入集群管理服务中，用于统一的节点编号和资源信息广播。 - -**图 1** 集成部署 -![](images/IntegratedDeployment.png) - -# 启动 - -Memory Fabric启动分为server和client两个部分。在节点上优先启动server端，完成集群注册、监控流程，然后启动本地资源注册\(总容量通过配置文件获取\)和通信建链流程，初始化完成后支持本地多client与server建立连接，可对外启动业务服务。 - -# 接口 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

接口

-

说明

-

int BM_Init(char *ockPath, int flags);

-

int BM_InitWithExtAttr(char*ockPath, int flags, void *attr); int BM_Exit(void);

-

初始化

-

带属性的初始化

-

退出

-

int BM_CreateNSSec(const char*poolName, const char *ns, int attribute, const char*secId);

-

int BM_DestroyNSSec(const char *poolName, const char*ns, const char *secId);

-

int BM_QueryNSCache(QueryNsCache*buff, size_t buffLen);

-

Namespace创建和销毁、查询

-

int BM_AllocSec(BmInfo *bminfo, size_t size, int flags, BmAffinity* affinity);

-

int BM_FreeSec(BmInfo *bminfo, int flags);

-

int BM_BatchFreeSec(char*bmIdArray[], int num, int flags, const char *ns, const char*secId);

-

Bigmemory对象申请和释放

-

int BM_ExpandSec(BmInfo *bminfo, size_t size, int flags);

-

bigMemory扩容

-

int BM_MapSec(BmInfo*bminfo, int prot, int flags, void **ptr);

-

int BM_Unmap(char *bmId, void*ptr);

-

bigMemory到连续虚拟空间map和unmap

-

int BM_CopySec(BmInfo *srcBM, size_t srcOffset, BmInfo*dstBM, size_t dstOffset, size_t length, int flags);

-

bigMemory对象间拷贝

-

int BM_SpecificObjSwapInSec(DiskFileDesc *file, BmInfo*bminfo, int flags, size_t offset, size_t length);

-

文件内容换入bigmemory对象

-

int BM_ReadSec(BmInfo *bminfo, size_t offset, size_t length, void*buffer, int flags);

-

int BM_WriteSec(BmInfo *bminfo, size_t offset, size_t length, const void*buffer, int flags);

-

Bigmemory读写

-

int BM_GatherSec(intptr_t *inputInfo, BmOperatorCode operatorCode, int flags, BmInfo*bminfo, size_t *bmLen);

-

聚合操作接口

-
diff --git a/docs/zh/server/_toc.yaml b/docs/zh/server/_toc.yaml index 2c8f20788ecd1e9b00e23080cee44ccef4a99279..680cfae4f4235c29188522b614735e83375d05be 100644 --- a/docs/zh/server/_toc.yaml +++ b/docs/zh/server/_toc.yaml @@ -28,7 +28,7 @@ sections: - href: ./security/secharden/_toc.yaml - href: ./security/trusted_computing/_toc.yaml - href: ./security/secgear/_toc.yaml - - href: ./security/cve-ease/_toc.yaml + - href: ./security/cve_ease/_toc.yaml - href: ./security/cert_signature/_toc.yaml - href: ./security/shangmi/_toc.yaml - label: 内存与存储 diff --git a/docs/zh/server/administration/administrator/configuring_the_repo_server.md b/docs/zh/server/administration/administrator/configuring_the_repo_server.md index b34ab5ccb08a7b7487c69ed321802d00b6f70e85..cc4d2bacc19ab872ac532c3de16711a586c9afba 100644 --- a/docs/zh/server/administration/administrator/configuring_the_repo_server.md +++ b/docs/zh/server/administration/administrator/configuring_the_repo_server.md @@ -2,7 +2,7 @@ >![](./public_sys-resources/icon-note.gif) **说明：** <<<<<<<< HEAD:docs/zh/server/administration/administrator/configuring-the-repo-server.md ->openEuler提供了多种repo源供用户在线使用，各repo源含义可参考[系统安装](../../releasenotes/releasenotes/os-installation.md)。若用户无法在线获取openEuler repo源，则可使用openEuler提供的ISO发布包创建为本地openEuler repo源。本章节中以openEuler-{version}-aarch64-dvd.iso发布包为例，请根据实际需要的ISO发布包进行修改。 +>openEuler提供了多种repo源供用户在线使用，各repo源含义可参考[系统安装](../../releasenotes/releasenotes/os_installation.md)。若用户无法在线获取openEuler repo源，则可使用openEuler提供的ISO发布包创建为本地openEuler repo源。本章节中以openEuler-{version}-aarch64-dvd.iso发布包为例，请根据实际需要的ISO发布包进行修改。 ======== >openEuler提供了多种repo源供用户在线使用，各repo源含义可参考[系统安装](../../..//server/releasenotes/releasenotes/os_installation.md)。若用户无法在线获取openEuler repo源，则可使用openEuler提供的ISO发布包创建为本地openEuler repo源。本章节中以openEuler-{version}-aarch64-dvd.iso发布包为例，请根据实际需要的ISO发布包进行修改。 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 3b5b962c74c9853e0344dbfd24672d784994126c..db694de7fd18bc4d6c4d4bf36b01bfbf8b61bbb5 100644 --- a/docs/zh/server/administration/administrator/configuring_the_web_server.md +++ b/docs/zh/server/administration/administrator/configuring_the_web_server.md @@ -22,11 +22,7 @@ openEuler系统中的web服务器版本是Apache HTTP服务器2.4版本，即htt # dnf install httpd ``` -<<<<<<<< HEAD:docs/zh/server/administration/administrator/configuring-the-web-server.md - 更多关于管理服务的内容，请参见[管理服务](./service-management.md)。 -======== 更多关于管理服务的内容，请参见[管理服务](./service_management.md)。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/configuring_the_web_server.md - 启动、停止和重启httpd服务，需要使用root权限。 @@ -269,11 +265,8 @@ Nginx 是一款轻量级的 Web 服务器/反向代理服务器及电子邮件 ### 安装 -<<<<<<<< HEAD:docs/zh/server/administration/administrator/configuring-the-web-server.md -1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring-the-repo-server.md)。 -======== 1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/configuring_the_web_server.md + 2. 清除缓存。 ```shell @@ -308,11 +301,7 @@ Nginx 是一款轻量级的 Web 服务器/反向代理服务器及电子邮件 - 为了能够使用nginx服务，请确保您的系统中已经安装nginx服务。若未安装，可参考[安装](#安装)进行安装。 -<<<<<<<< HEAD:docs/zh/server/administration/administrator/configuring-the-web-server.md -- 更多关于管理服务的内容，请参见[管理服务](./service-management.md)。 -======== - 更多关于管理服务的内容，请参见[管理服务](./service_management.md)。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/configuring_the_web_server.md - 启动、停止和重启nginx服务，需要使用root权限。 diff --git a/docs/zh/server/administration/administrator/setting_up_the_database_server.md b/docs/zh/server/administration/administrator/setting_up_the_database_server.md index a24d38b94a1bea19e067325200744894ec5855a4..16e2e649efde84f57abb1eb9f202f5f15f3cef1d 100644 --- a/docs/zh/server/administration/administrator/setting_up_the_database_server.md +++ b/docs/zh/server/administration/administrator/setting_up_the_database_server.md @@ -170,11 +170,8 @@ sed -i 's/SELINUX=enforcing/SELINUX=disabled/g' /etc/selinux/config #### 安装 -<<<<<<<< HEAD:docs/zh/server/administration/administrator/setting-up-the-database-server.md -1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring-the-repo-server.md)。 -======== 1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/setting_up_the_database_server.md + 2. 清除缓存。 ```shell @@ -889,12 +886,9 @@ MariaDB的架构如[图2](#fig13492418164520)所示。 >![](./public_sys-resources/icon-note.gif) **说明：** >此步骤需要安装镜像中的lvm2相关包，步骤如下： -<<<<<<<< HEAD:docs/zh/server/administration/administrator/setting-up-the-database-server.md ->1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring-the-repo-server.md)。如果已经执行，则可跳过此步。 -======== ->1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。如果已经执行，则可跳过此步。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/setting_up_the_database_server.md ->2. 在root权限下执行`yum install lvm2`命令安装lvm2。 +> +> - 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。如果已经执行，则可跳过此步。 +> - 在root权限下执行`yum install lvm2`命令安装lvm2。 1. 创建物理卷（sdb为硬盘名称，具体名字以实际为准）。 @@ -948,11 +942,8 @@ MariaDB的架构如[图2](#fig13492418164520)所示。 #### 安装 -<<<<<<<< HEAD:docs/zh/server/administration/administrator/setting-up-the-database-server.md -1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring-the-repo-server.md)。 -======== 1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/setting_up_the_database_server.md + 2. 清除缓存。 ```shell @@ -1517,12 +1508,9 @@ MySQL所使用的SQL语言是用于访问数据库的最常用标准化语言。 >![](./public_sys-resources/icon-note.gif) **说明：** >此步骤需要安装镜像中的lvm2相关包，步骤如下： -<<<<<<<< HEAD:docs/zh/server/administration/administrator/setting-up-the-database-server.md ->1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring-the-repo-server.md)。如果已经执行，则可跳过此步。 -======== ->1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。如果已经执行，则可跳过此步。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/setting_up_the_database_server.md ->2. 执行`yum install lvm2`安装lvm2。 +> +> - 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。如果已经执行，则可跳过此步。 +> - 执行`yum install lvm2`安装lvm2。 1. 创建物理卷（sdb为硬盘名称，具体名字以实际为准）。 @@ -1579,11 +1567,8 @@ MySQL所使用的SQL语言是用于访问数据库的最常用标准化语言。 #### 安装 -<<<<<<<< HEAD:docs/zh/server/administration/administrator/setting-up-the-database-server.md -1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring-the-repo-server.md)章节。 -======== 1. 配置本地yum源，详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)章节。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/setting_up_the_database_server.md + 2. 清除缓存。 ```shell diff --git a/docs/zh/server/administration/administrator/using_dnf_to_manage_software_packages.md b/docs/zh/server/administration/administrator/using_dnf_to_manage_software_packages.md index b7dc086b9871a154cb457fb8848419a9c91faaa3..f47245fe7e1276690895fe4b5d683a1d1cad8e91 100644 --- a/docs/zh/server/administration/administrator/using_dnf_to_manage_software_packages.md +++ b/docs/zh/server/administration/administrator/using_dnf_to_manage_software_packages.md @@ -135,11 +135,7 @@ repository部分允许您定义定制化的openEuler软件源仓库，各个仓 - 配置/etc/yum.repos.d目录下的.repo文件 -<<<<<<<< HEAD:docs/zh/server/administration/administrator/using-dnf-to-manage-software-packages.md - openEuler提供了多种repo源供用户在线使用，各repo源含义可参考[系统安装](../../releasenotes/releasenotes/os-installation.md)。使用root权限添加openEuler repo源，示例如下： -======== openEuler提供了多种repo源供用户在线使用，各repo源含义可参考[系统安装](../../../server/releasenotes/releasenotes/os_installation.md)。使用root权限添加openEuler repo源，示例如下： ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/administration/administrator/using_dnf_to_manage_software_packages.md ```shell # vi /etc/yum.repos.d/openEuler.repo diff --git a/docs/zh/server/development/FangTian/fangtian_environment_configuration.md b/docs/zh/server/development/FangTian/fangtian_environment_configuration.md index 7cd314ad95d550b0049e1afa59c14ff4a701bb66..85c06fa942fe42045e28d475bc65d12388027499 100644 --- a/docs/zh/server/development/FangTian/fangtian_environment_configuration.md +++ b/docs/zh/server/development/FangTian/fangtian_environment_configuration.md @@ -10,11 +10,7 @@ ### 环境准备 -<<<<<<<< HEAD:docs/zh/server/development/FangTian/fangtian-environment-configuration.md -安装 openEuler 系统，安装方法参考《[openEuler 安装指南](../../installation_upgrade/installation/installation-on-servers.md)》。 -======== 安装 openEuler 系统，安装方法参考《[openEuler 安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/development/FangTian/fangtian_environment_configuration.md ### FangTian 软件包安装 diff --git a/docs/zh/server/development/application_dev/preparations_for_development_environment.md b/docs/zh/server/development/application_dev/preparations_for_development_environment.md index a14f85f822559413bab93f0de874a48782349c68..27c0d363d78476b3d36ae5f8b612d2f0a020af1b 100644 --- a/docs/zh/server/development/application_dev/preparations_for_development_environment.md +++ b/docs/zh/server/development/application_dev/preparations_for_development_environment.md @@ -94,11 +94,7 @@ 操作系统要求为openEuler操作系统。 -<<<<<<<< HEAD:docs/zh/server/development/application_dev/preparations-for-development-environment.md -openEuler操作系统具体安装方法请参考[安装指南](../../installation_upgrade/installation/installation-on-servers.md)，其中“软件选择”页面的“已选环境的附加选项”中将“开发工具”勾选。 -======== openEuler操作系统具体安装方法请参考[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)，其中“软件选择”页面的“已选环境的附加选项”中将“开发工具”勾选。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/development/application_dev/preparations_for_development_environment.md ## 配置openEuler yum源 @@ -107,11 +103,7 @@ openEuler操作系统具体安装方法请参考[安装指南](../../../server/i ### 通过直接获取在线的openEuler repo源配置在线yum源 >![](./public_sys-resources/icon-note.gif) **说明：** -<<<<<<<< HEAD:docs/zh/server/development/application_dev/preparations-for-development-environment.md ->openEuler提供了多种repo源供用户在线使用，各repo源含义可参考[系统安装](../../releasenotes/releasenotes/os-installation.md)。本操作以AArch64架构的OS repo源为例将其配置为yum源。 -======== >openEuler提供了多种repo源供用户在线使用，各repo源含义可参考[系统安装](../../releasenotes/releasenotes/os_installation.md)。本操作以AArch64架构的OS repo源为例将其配置为yum源。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/development/application_dev/preparations_for_development_environment.md 1. 进入到yum源目录并查看目录下的.repo配置文件。 @@ -151,11 +143,7 @@ openEuler操作系统具体安装方法请参考[安装指南](../../../server/i ### 通过挂载ISO创建本地openEuler repo源配置本地yum源 >![](./public_sys-resources/icon-note.gif) **说明：** -<<<<<<<< HEAD:docs/zh/server/development/application_dev/preparations-for-development-environment.md ->openEuler提供了多种ISO发布包，各ISO发布包含义可参考[系统安装](../../releasenotes/releasenotes/os-installation.md)。本操作中忽略具体的版本号和架构，请根据实际需要的ISO发布包和校验文件进行修改。 -======== >openEuler提供了多种ISO发布包，各ISO发布包含义可参考[系统安装](../../releasenotes/releasenotes/os_installation.md)。本操作中忽略具体的版本号和架构，请根据实际需要的ISO发布包和校验文件进行修改。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/development/application_dev/preparations_for_development_environment.md 1. 下载ISO发布包。 - 通过跨平台文件传输工具下载ISO镜像。 diff --git a/docs/zh/server/high_availability/ha/_toc.yaml b/docs/zh/server/high_availability/ha/_toc.yaml index 16da9a6d1b4a343868c229a47a5fcb431f6bddcd..16a9cc680a4656b9a6d31123461bbe76426835f6 100644 --- a/docs/zh/server/high_availability/ha/_toc.yaml +++ b/docs/zh/server/high_availability/ha/_toc.yaml @@ -8,4 +8,4 @@ sections: - label: HA 安装与部署 href: ./ha_installation_and_deployment.md - label: HA 使用实例 - href: ./ha_usacase_examples.md + href: ./ha_usecase_examples.md diff --git a/docs/zh/server/high_availability/ha/ha_installation_and_deployment.md b/docs/zh/server/high_availability/ha/ha_installation_and_deployment.md index 96a42401d21273db9c079812ca3346e6b1e36416..65c0e4ecb69fea6ddfa2f516f50f25f39a78aa6a 100644 --- a/docs/zh/server/high_availability/ha/ha_installation_and_deployment.md +++ b/docs/zh/server/high_availability/ha/ha_installation_and_deployment.md @@ -6,7 +6,7 @@ ### 环境准备 -需要至少两台安装了openEuler 24.03 的物理机/虚拟机（现以两台为例），安装方法参考《[安装指南](../../installation_upgrade/installation/installation-on-servers.md)》。 +需要至少两台安装了openEuler 24.03 的物理机/虚拟机（现以两台为例），安装方法参考《[安装指南](../../installation_upgrade/installation/installation_on_servers.md)》。 ### 修改主机名称及/etc/hosts文件 @@ -198,4 +198,4 @@ nodelist { ![](./figures/HA-api.png) -想了解如何快速使用HA高可用集群，以及添加一个实例。请参考[HA的使用实例文档](./ha-usecase-examples.md)。 +想了解如何快速使用HA高可用集群，以及添加一个实例。请参考[HA的使用实例文档](./ha_usecase_examples.md)。 diff --git a/docs/zh/server/high_availability/ha/ha_usecase_examples.md b/docs/zh/server/high_availability/ha/ha_usecase_examples.md index 1644822afafd10d5e0d5b2824d22c9ca7dc30fea..8fff8af0b4e2594ae1e95ebb4052fce4491712d8 100644 --- a/docs/zh/server/high_availability/ha/ha_usecase_examples.md +++ b/docs/zh/server/high_availability/ha/ha_usecase_examples.md @@ -1,6 +1,6 @@ # HA使用实例 -本章介绍如何快速使用HA高可用集群，以及添加一个实例。若不了解怎么安装，请参考[HA的安装与部署文档](./ha-installation-and-deployment.md)。 +本章介绍如何快速使用HA高可用集群，以及添加一个实例。若不了解怎么安装，请参考[HA的安装与部署文档](./ha_installation_and_deployment.md)。 ## 快速使用指南 diff --git a/docs/zh/server/maintenance/aops/aops_intelligent_positioning_framework_user_manual.md b/docs/zh/server/maintenance/aops/aops_intelligent_positioning_framework_user_manual.md index e0a292e6b769020791a9ba4de949fd829c2412fe..f2a12fb6e6c61ddcf7d951b8c66fed98f33fe154 100644 --- a/docs/zh/server/maintenance/aops/aops_intelligent_positioning_framework_user_manual.md +++ b/docs/zh/server/maintenance/aops/aops_intelligent_positioning_framework_user_manual.md @@ -1,6 +1,6 @@ # AOps 智能定位框架使用手册 -参照[AOps部署指南](deploying_aops.md)部署AOps前后端服务，并参照[AOps资产管理使用手册](./aops_asset_management_use_manual.md)纳管了主机后，即可使用AOps智能定位框架。 +参照[AOps部署指南](deploying_aops.md)部署AOps前后端服务，并参照[AOps资产管理使用手册](./aops_asset_management_user_manual.md)纳管了主机后，即可使用AOps智能定位框架。 智能定位框架包含了**智能定位**和**配置溯源**两部分，下文会从页面的维度进行AOps智能定位框架功能的介绍。 diff --git a/docs/zh/server/maintenance/syscare/_toc.yaml b/docs/zh/server/maintenance/syscare/_toc.yaml index f08f9df281c8558ba47c4e46f5754cbcd6949ce1..2451b9135b8064d4c59429a2611632b3a1ad3bba 100644 --- a/docs/zh/server/maintenance/syscare/_toc.yaml +++ b/docs/zh/server/maintenance/syscare/_toc.yaml @@ -8,7 +8,7 @@ sections: - label: 认识SysCare href: ./syscare_introduction.md - label: 安装SysCare - href: ./installing_yscare.md + href: ./installing_syscare.md - label: 使用SysCare href: ./using_syscare.md - label: 约束限制 diff --git a/docs/zh/server/performance/system_optimzation/atune/installation_and_deployment.md b/docs/zh/server/performance/system_optimzation/atune/installation_and_deployment.md index f0e4a77222cbe7e4d2bdb135b69e08629c4a672b..b8540a54b12d848fd2d2f7399afe8dd5a776ab39 100644 --- a/docs/zh/server/performance/system_optimzation/atune/installation_and_deployment.md +++ b/docs/zh/server/performance/system_optimzation/atune/installation_and_deployment.md @@ -10,11 +10,7 @@ ## 环境准备 -<<<<<<<< HEAD:docs/zh/server/performance/system_optimzation/atune/installation-and-deployment.md -- 安装openEuler系统，安装方法参考 《[安装指南](../../../installation_upgrade/installation/installation-on-servers.md)》。 -======== - 安装openEuler系统，安装方法参考 《[安装指南](../../../../server/installation_upgrade/installation/installation_on_servers.md)》。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/server/performance/system_optimzation/atune/installation_and_deployment.md - 安装A-Tune需要使用root权限。 diff --git a/docs/zh/server/releasenotes/releasenotes/know_issues.md b/docs/zh/server/releasenotes/releasenotes/known_issues.md similarity index 96% rename from docs/zh/server/releasenotes/releasenotes/know_issues.md rename to docs/zh/server/releasenotes/releasenotes/known_issues.md index 1d79285d42fa44966dc7e06e6078d3810163f24b..d275b84efdda5e5eafe46e053eb1a8d58e8c577d 100644 --- a/docs/zh/server/releasenotes/releasenotes/know_issues.md +++ b/docs/zh/server/releasenotes/releasenotes/known_issues.md @@ -4,4 +4,4 @@ |-|-|-|-| |IBA13Y|yocto-meta-openeuler|【2403LTSSP1】raspberrypi4-64镜像测试用例oe_test_nfs-utils_test_001失败|https://gitee.com/open_euler/dashboard?issue_id=IBA13Y| |IBACHW|yocto-meta-openeuler|【2403LTSSP1】qemu-aarch64-mcs-ros镜像名称错误，并且micad启动失败|https://gitee.com/open_euler/dashboard?issue_id=IBACHW| -|IBANAZ|yocto-meta-openeuler|【2403LTSSP1】x86-64-hmi-mcs-ros-rt镜像mica启动失败|https://gitee.com/open_euler/dashboard?issue_id=IBANAZ| \ No newline at end of file +|IBANAZ|yocto-meta-openeuler|【2403LTSSP1】x86-64-hmi-mcs-ros-rt镜像mica启动失败|https://gitee.com/open_euler/dashboard?issue_id=IBANAZ| diff --git a/docs/zh/server/releasenotes/releasenotes/terms_of_uese.md b/docs/zh/server/releasenotes/releasenotes/terms_of_use.md similarity index 100% rename from docs/zh/server/releasenotes/releasenotes/terms_of_uese.md rename to docs/zh/server/releasenotes/releasenotes/terms_of_use.md diff --git a/docs/zh/server/security/_toc.yaml b/docs/zh/server/security/_toc.yaml deleted file mode 100644 index 156c3365e33c4e7102b35dcb52c8e1f4a828762c..0000000000000000000000000000000000000000 --- a/docs/zh/server/security/_toc.yaml +++ /dev/null @@ -1,16 +0,0 @@ -label: secDetector开发指南 -isManual: true -description: secDetecor 的架构、特性、安装、开发指导、落地应用场景等。帮助用户快速了解并使用secDetector。 -sections: - - label: secDetector使用指南 - href: ./secdetector.md - - label: 认识secGear - href: ./introduction_to_secdetector.md - - label: 安装与部署 - href: ./secdetector_installation.md - - label: 接口说明 - href: ./api_reference.md - - label: 开发secdetector应用程序 - href: ./developer_guide.md - - label: 使用secdetector工具 - href: ./using_secdetector_tools.md diff --git a/docs/zh/server/security/secgear/api_refernce.md b/docs/zh/server/security/secgear/api_reference.md similarity index 100% rename from docs/zh/server/security/secgear/api_refernce.md rename to docs/zh/server/security/secgear/api_reference.md diff --git a/docs/zh/tools/ai/_toc.yaml b/docs/zh/tools/ai/_toc.yaml index f0b4cf080cb7ecda1d7c90d657f62dc1cc29181f..c8e7c4550ab495aaecab005c77daefa1acdd4d64 100644 --- a/docs/zh/tools/ai/_toc.yaml +++ b/docs/zh/tools/ai/_toc.yaml @@ -1,11 +1,20 @@ label: AI sections: - - label: AI 容器镜像用户指南 + - label: openEuler Intelligence + sections: + - href: + upstream: https://gitee.com/openeuler/euler-copilot-framework/blob/master/docs/zh/openEuler_intelligence/intelligent_assistant/_toc.yaml + - href: + upstream: https://gitee.com/openeuler/euler-copilot-framework/blob/master/docs/zh/openEuler_intelligence/intelligent_vulnerability_patching/_toc.yaml + - href: + upstream: https://gitee.com/openeuler/euler-copilot-framework/blob/master/docs/zh/openEuler_intelligence/mcp_agent/_toc.yaml + - label: 智能底座 sections: - - href: ./ai_container_image_userguide/_toc.yaml - - label: 支持百川、chatglm、星火等AI大模型的容器化封装 + - href: + upstream: https://gitee.com/openeuler/euler-copilot-framework/blob/master/docs/zh/intelligent_foundation/sysHAX/_toc.yaml + - label: AI全栈 sections: - - href: ./ai_large_model_service_image_userguide/_toc.yaml - - label: openEuler Copilot System - sections: - - href: ./euler_copilot/_toc.yaml \ No newline at end of file + - href: + upstream: https://gitee.com/openeuler/euler-copilot-framework/blob/master/docs/zh/ai_full_stack/ai_container_image_userguide/_toc.yaml + - href: + upstream: https://gitee.com/openeuler/euler-copilot-framework/blob/master/docs/zh/ai_full_stack/ai_large_model_service_images_userguide/_toc.yaml diff --git a/docs/zh/tools/ai/ai_container_image_userguide/_toc.yaml b/docs/zh/tools/ai/ai_container_image_userguide/_toc.yaml deleted file mode 100644 index 6cec8dda55332335d1fe0c70bce89728f9cb1694..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/ai_container_image_userguide/_toc.yaml +++ /dev/null @@ -1,6 +0,0 @@ -label: AI容器镜像用户指南 -isManual: true -description: openEuler AI 容器镜像封装了 AI 框架等软件，提高 AI 应用开发或使用效率 -sections: - - label: AI容器镜像用户指南 - href: ./ai_container_image_user_guide.md diff --git a/docs/zh/tools/ai/ai_container_image_userguide/ai_container_image_user_guide.md b/docs/zh/tools/ai/ai_container_image_userguide/ai_container_image_user_guide.md deleted file mode 100644 index 4d4b97e7171c0453851394b69bfda7dacb6f129f..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/ai_container_image_userguide/ai_container_image_user_guide.md +++ /dev/null @@ -1,115 +0,0 @@ -# openEuler AI 容器镜像用户指南 - -## 简介 - -openEuler AI 容器镜像封装了不同硬件算力的 SDK 以及 AI 框架、大模型应用等软件，用户只需要在目标环境中加载镜像并启动容器，即可进行 AI 应用开发或使用，大大减少了应用部署和环境配置的时间，提升效率。 - -## 获取镜像 - -目前，openEuler 已发布支持 Ascend 和 NVIDIA 平台的容器镜像，获取路径如下： - -- [openeuler/cann](https://hub.docker.com/r/openeuler/cann) - -存放 SDK 类镜像，在 openEuler 基础镜像之上安装 CANN 系列软件，适用于 Ascend 环境。 - -- [openeuler/cuda](https://hub.docker.com/r/openeuler/cuda) - -存放 SDK 类镜像，在 openEuler 基础镜像之上安装 CUDA 系列软件，适用于 NVIDIA 环境。 - -- [openeuler/pytorch](https://hub.docker.com/r/openeuler/pytorch) - -存放 AI 框架类镜像，在 SDK 镜像基础之上安装 PyTorch，根据安装的 SDK 软件内容区分适用平台。 - -- [openeuler/tensorflow](https://hub.docker.com/r/openeuler/tensorflow) - -存放 AI 框架类镜像，在 SDK 镜像基础之上安装 TensorFlow，根据安装的 SDK 软件内容区分适用平台。 - -- [openeuler/llm](https://hub.docker.com/r/openeuler/tensorrt) - -存放模型应用类镜像，在 AI 框架镜像之上包含特定大模型及工具链，根据安装的 SDK 软件内容区分适用平台。 - -详细的 AI 容器镜像分类和镜像 tag 的规范说明见[oEEP-0014](https://gitee.com/openeuler/TC/blob/master/oEEP/oEEP-0014%20openEuler%20AI容器镜像软件栈规范.md)。 - -由于 AI 容器镜像的体积一般较大，推荐用户在启动容器前先通过如下命令将镜像拉取到开发环境中。 - -```sh -docker pull image:tag -``` - -其中，`image`为仓库名，如`openeuler/cann`，`tag`为目标镜像的 TAG，待镜像拉取完成后即可启动容器。注意，使用`docker pull`命令需按照下文方法安装`docker`软件。 - -## 启动容器 - -1. 在环境中安装`docker`，官方安装方法见[Install Docker Engine](https://docs.docker.com/engine/install/)，也可直接通过如下命令进行安装。 - - ```sh - yum install -y docker - ``` - - 或 - - ```sh - apt-get install -y docker - ``` - -2. NVIDIA环境安装`nvidia-container` - - 1）配置yum或apt repo - - 使用yum安装时，执行： - - ```sh - curl -s -L https://nvidia.github.io/libnvidia-container/stable/rpm/nvidia-container-toolkit.repo | \ - sudo tee /etc/yum.repos.d/nvidia-container-toolkit.repo - ``` - - - 使用apt安装时，执行： - - ```sh - curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg - ``` - - ```sh - curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | \ - sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \ - sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list - ``` - - 2）安装`nvidia-container-toolkit`,`nvidia-container-runtime`，执行： - - ```sh - # yum安装 - yum install -y nvidia-container-toolkit nvidia-container-runtime - ``` - - ```sh - # apt安装 - apt-get install -y nvidia-container-toolkit nvidia-container-runtime - ``` - - 3）配置docker - - ```sh - nvidia-ctk runtime configure --runtime=docker - systemctl restart docker - ``` - - 非NVIDIA环境不执行此步骤。 - -3. 确保环境中安装`driver`及`firmware`，用户可从[NVIDIA](https://www.nvidia.com/)或[Ascend](https://www.hiascend.com/)官网获取正确版本进行安装。安装完成后 Ascend 平台使用`npu-smi info`命令、NVIDIA 平台使用`nvidia-smi`进行测试，正确显示硬件信息则说明安装正常。 - -4. 完成上述操作后，即可使用`docker run`命令启动容器。 - -```sh -# Ascend环境启动容器 -docker run --rm --network host \ - --device /dev/davinci0:/dev/davinci0 \ - --device /dev/davinci_manager --device /dev/devmm_svm --device /dev/hisi_hdc \ - -v /usr/local/dcmi:/usr/local/dcmi -v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \ - -v /usr/local/Ascend/driver/lib64/:/usr/local/Ascend/driver/lib64/ \ - -ti image:tag -``` - -```sh -# NVIDIA环境启动容器 -docker run --gpus all -d -ti image:tag -``` diff --git a/docs/zh/tools/ai/ai_large_model_service_image_userguide/_toc.yaml b/docs/zh/tools/ai/ai_large_model_service_image_userguide/_toc.yaml deleted file mode 100644 index e4765568ccc2d1478573f457bf3fe636ff583949..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/ai_large_model_service_image_userguide/_toc.yaml +++ /dev/null @@ -1,6 +0,0 @@ -label: AI大模型服务镜像使用指南 -isManual: true -description: 支持百川、chatglm、星火等AI大模型的容器化封装 -sections: - - label: AI大模型服务镜像使用指南 - href: ./llm_service_image_user_guide.md diff --git a/docs/zh/tools/ai/ai_large_model_service_image_userguide/llm_service_image_user_guide.md b/docs/zh/tools/ai/ai_large_model_service_image_userguide/llm_service_image_user_guide.md deleted file mode 100644 index c7c492b104b74e25ac87980c2d8580885a43df0e..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/ai_large_model_service_image_userguide/llm_service_image_user_guide.md +++ /dev/null @@ -1,94 +0,0 @@ -# 支持百川、chatglm、星火等AI大模型的容器化封装 - -已配好相关依赖，分为CPU和GPU版本，降低使用门槛，开箱即用。 - -## 拉取镜像(CPU版本) - -```bash -docker pull openeuler/llm-server:1.0.0-oe2203sp3 -``` - -## 拉取镜像(GPU版本) - -```bash -docker pull icewangds/llm-server:1.0.0 -``` - -## 下载模型, 并转换为gguf格式 - -```bash -# 安装huggingface -pip install huggingface-hub - -# 下载你想要部署的模型 -export HF_ENDPOINT=https://hf-mirror.com -huggingface-cli download --resume-download baichuan-inc/Baichuan2-13B-Chat --local-dir /root/models/Baichuan2-13B-Chat --local-dir-use-symlinks False - -# gguf格式转换 -cd /root/models/ -git clone https://github.com/ggerganov/llama.cpp.git -python llama.cpp/convert-hf-to-gguf.py ./Baichuan2-13B-Chat -# 生成的gguf格式的模型路径 /root/models/Baichuan2-13B-Chat/ggml-model-f16.gguf -``` - -## 启动方式 - -需要Docker v25.0.0及以上版本。 - -若使用GPU镜像，需要OS上安装nvidia-container-toolkit，安装方式见。 - -docker-compose.yaml: - -```yaml -version: '3' -services: - model: - image: : #镜像名称与tag - restart: on-failure:5 - ports: - - 8001:8000 #监听端口号，修改“8001”以更换端口 - volumes: - - /root/models:/models # 大模型挂载目录 - environment: - - MODEL=/models/Baichuan2-13B-Chat/ggml-model-f16.gguf # 容器内的模型文件路径 - - MODEL_NAME=baichuan13b # 自定义模型名称 - - KEY=sk-12345678 # 自定义API Key - - CONTEXT=8192 # 上下文大小 - - THREADS=8 # CPU线程数，仅CPU部署时需要 - deploy: # 指定GPU资源, 仅GPU部署时需要 - resources: - reservations: - devices: - - driver: nvidia - count: all - capabilities: [gpu] -``` - -```bash -docker-compose -f docker-compose.yaml up -``` - -docker run: - -```text -cpu部署: docker run -d --restart on-failure:5 -p 8001:8000 -v /root/models:/models -e MODEL=/models/Baichuan2-13B-Chat/ggml-model-f16.gguf -e MODEL_NAME=baichuan13b -e KEY=sk-12345678 openeuler/llm-server:1.0.0-oe2203sp3 - -gpu部署: docker run -d --gpus all --restart on-failure:5 -p 8001:8000 -v /root/models:/models -e MODEL=/models/Baichuan2-13B-Chat/ggml-model-f16.gguf -e MODEL_NAME=baichuan13b -e KEY=sk-12345678 icewangds/llm-server:1.0.0 -``` - -## 调用大模型接口测试，成功返回则表示大模型服务已部署成功 - -```bash -curl -X POST http://127.0.0.1:8001/v1/chat/completions \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer sk-12345678" \ - -d '{ - "model": "baichuan13b", - "messages": [ - {"role": "system", "content": "你是一个社区助手，请回答以下问题。"}, - {"role": "user", "content": "你是谁?"} - ], - "stream": false, - "max_tokens": 1024 - }' -``` diff --git a/docs/zh/tools/ai/euler_copilot/README.md b/docs/zh/tools/ai/euler_copilot/README.md deleted file mode 100644 index 6859571a80cc40c2dba38d9308bc293129a8157d..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# openEuler Copilot System - -## 功能描述 - -openEuler Copilot System 智能问答平台目前支持 Web 和智能 Shell 两个入口。 - -- Web 入口：操作简单，可咨询操作系统相关基础知识，openEuler 动态数据、openEuler 运维问题解决方案、openEuler 项目介绍与使用指导等等。 -- 智能 Shell 入口：自然语言和 openEuler 交互，启发式的运维。 - -## 应用场景 - -- 面向 openEuler 普通用户：深入了解 openEuler 相关知识和动态数据，比如咨询如何迁移到 openEuler。 -- 面向 openEuler 开发者：熟悉 openEuler 开发贡献流程、关键特性、相关项目的开发等知识。 -- 面向 openEuler 运维人员：熟悉 openEuler 常见或疑难问题的解决思路和方案、openEuler 系统管理知识和相关命令。 - -## 用户手册目录 - -### 部署手册 - -- Web 端部署指南 - - [网络环境下部署指南](./deployment_guide/online.md) - - [无网络环境下部署指南](./deployment_guide/offline.md) - -- 插件部署指南 - - [智能调优](./deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md) - - [智能诊断](./deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md) - - [AI容器栈](./deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md) - -- [本地资产库构建指南](./deployment_guide/local_asset_library_setup_guide.md) - -### 使用手册 - -- [管理员：知识库管理](./usage_guide/knowledge_base_management/witchaind_guidance.md) - -- [Web 端使用手册](./usage_guide/oneline_services/preface.md) - - [注册与登录](./usage_guide/oneline_services/registration_and_login.md) - - [智能问答](./usage_guide/oneline_services/qa_guide.md) - - [智能插件](./usage_guide/oneline_services/intelligent_plugin.md) - -- [智能 Shell 使用手册](./usage_guide/cli_client/cli_assistant_user_guide.md) - - [准备工作：获取 API Key](./usage_guide/cli_client/obtaining_api_key.md) - - [智能插件](./usage_guide/cli_client/cli_assistant_user_guide.md#intelligent_plugin) - - [智能调优](./usage_guide/cli_client/tune.md) - - [智能诊断](./usage_guide/cli_client/diagnosis.md) diff --git a/docs/zh/tools/ai/euler_copilot/_toc.yaml b/docs/zh/tools/ai/euler_copilot/_toc.yaml deleted file mode 100644 index f83e75ef35afc0d57f4b38537d595958baa6a17a..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/_toc.yaml +++ /dev/null @@ -1,36 +0,0 @@ -label: openEuler Copilot System -isManual: true -description: openEuler Copilot System 智能问答平台目前支持 Web 和智能 Shell 两个入口。 -sections: - - label: 网络环境下部署指南 - href: ./deployment_guide/online.md - - label: 无网络环境下部署指南 - href: ./deployment_guide/offline.md - - label: 智能调优 - href: ./deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md - - label: 智能诊断 - href: ./deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md - - label: AI容器栈 - href: ./deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md - - label: 本地资产库构建指南 - href: ./deployment_guide/local_asset_library_setup_guide.md - - label: 知识库管理 - href: ./usage_guide/knowledge_base_management/witchaind_guidance.md - - label: Web 端使用手册 - href: ./usage_guide/oneline_services/preface.md - - label: 注册与登录 - href: ./usage_guide/oneline_services/registration_and_login.md - - label: 智能问答 - href: ./usage_guide/oneline_services/qa_guide.md - - label: 智能插件 - href: ./usage_guide/oneline_services/intelligent_plugin.md - - label: 智能 Shell 使用手册 - href: ./usage_guide/cli_client/cli_assistant_user_guide.md - - label: 准备工作：获取 API Key - href: ./usage_guide/cli_client/obtaining_api_key.md - - label: 智能插件 - href: ./usage_guide/cli_client/cli_assistant_user_guide.md#intelligent_plugin - - label: 智能调优 - href: ./usage_guide/cli_client/tune.md - - label: 智能诊断 - href: ./usage_guide/cli_client/diagnosis.md \ No newline at end of file diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/_toc.yaml b/docs/zh/tools/ai/euler_copilot/deployment_guide/_toc.yaml deleted file mode 100644 index 0c6e12fc8e33221946cd0bbaea82f3ea06160ba3..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/_toc.yaml +++ /dev/null @@ -1,12 +0,0 @@ -label: 部署指南 -isManual: true -description: -sections: - - label: Web 部署指南 - sections: - - label: 无网络环境下部署指南 - href: ./offline.md - - label: 网络环境下部署指南 - href: ./online.md - - label: 本地资产库构建指南 - href: ./local_asset_library_setup_guide.md diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/local_asset_library_setup_guide.md b/docs/zh/tools/ai/euler_copilot/deployment_guide/local_asset_library_setup_guide.md deleted file mode 100644 index 21873a3335df2e1ce11832ed0ae6f38dfa33093a..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/local_asset_library_setup_guide.md +++ /dev/null @@ -1,406 +0,0 @@ -# 本地资产库构建指南 - -- RAG 是一个检索增强的模块，该指南主要是为rag提供命令行的方式进行数据库管理、资产管理、资产库管理和语料资产管理； - 对于数据库管理提供了清空数据库、初始化数据库等功能； - 对于资产管理提供了资产创建、资产查询和资产删除等功能； - 对于资产库管理提供了资产库创建、资产库查询和资产库删除等功能； - 对于语料资产管理提供了语料上传、语料查询和语料删除等功能。 -- 当前指南面向管理员进行编写，对于管理员而言，可以拥有多个资产，一个资产包含多个资产库（不同资产库的使用的向量化模型可以不同），一个资产库对应一个语料资产。 -- 本地语料上传指南是用户构建项目专属语料的指导，当前支持 docx、pdf、markdown、txt 和 xlsx 文件上传，推荐使用 docx 格式上传。 - -## 准备工作 - -- RAG 中关于语料上传目录挂载的配置： - -将本地语料保存到服务器的目录，例如 /home/docs 目录，且将 /home/data 目录权限设置为755 - -```bash -# 设置本地存放文档目录权限为755 -chmod -R 755 /home/docs -``` - -将文件存放的源目录映射至 RAG 容器目标目录，源目录的配置在 中，下面是文件中具体配置映射源目录的配置方法： - -![配置映射源目录](./pictures/本地资产库构建/配置映射源目录.png) - -中间层的配置（链接源目录和目标目录的配置）在 中，下面是文件中具体映射中间层的配置方法： - -![配置映射中间层](./pictures/本地资产库构建/配置映射中间层.png) - -目标目录的配置在 中，下面是文件中具体映射目标目录的配置方法： - -![配置映射目标目录](./pictures/本地资产库构建/配置映射目标目录.png) - -- 更新 Copilot 服务： - - ```bash - root@openeuler:/home/EulerCopilot/deploy/chart# helm upgrade -n euler-copilot service . - # 请注意：service是服务名，可根据实际修改 - ``` - -- 进入到 RAG 容器： - - ```bash - root@openeuler:~# kubectl -n euler-copilot get pods - NAME READY STATUS RESTARTS AGE - framework-deploy-service-bb5b58678-jxzqr 2/2 Running 0 16d - mysql-deploy-service-c7857c7c9-wz9gn 1/1 Running 0 17d - pgsql-deploy-service-86b4dc4899-ppltc 1/1 Running 0 17d - rag-deploy-service-5b7887644c-sm58z 2/2 Running 0 110m - redis-deploy-service-f8866b56-kj9jz 1/1 Running 0 17d - vectorize-deploy-service-57f5f94ccf-sbhzp 2/2 Running 0 17d - web-deploy-service-74fbf7999f-r46rg 1/1 Running 0 2d - # 进入rag pod - root@openeuler:~# kubectl -n euler-copilot exec -it rag-deploy-service-5b7887644c-sm58z -- bash - ``` - -- 设置 PYTHONPATH - - ```bash - # 设置PYTHONPATH - export PYTHONPATH=$(pwd) - ``` - -## 上传语料 - -### 查看脚本帮助信息 - -```bash -python3 scripts/rag_kb_manager.pyc --help -usage: rag_kb_manager.pyc [-h] --method - {init_database_info,init_rag_info,init_database,clear_database,create_kb,del_kb,query_kb,create_kb_asset,del_kb_asset,query_kb_asset,up_corpus,del_corpus,query_corpus,stop_corpus_uploading_job} - [--database_url DATABASE_URL] [--vector_agent_name VECTOR_AGENT_NAME] [--parser_agent_name PARSER_AGENT_NAME] - [--rag_url RAG_URL] [--kb_name KB_NAME] [--kb_asset_name KB_ASSET_NAME] [--corpus_dir CORPUS_DIR] - [--corpus_chunk CORPUS_CHUNK] [--corpus_name CORPUS_NAME] [--up_chunk UP_CHUNK] - [--embedding_model {TEXT2VEC_BASE_CHINESE_PARAPHRASE,BGE_LARGE_ZH,BGE_MIXED_MODEL}] [--vector_dim VECTOR_DIM] - [--num_cores NUM_CORES] - -optional arguments: - -h, --help show this help message and exit - --method {init_database_info,init_rag_info,init_database,clear_database,create_kb,del_kb,query_kb,create_kb_asset,del_kb_asset,query_kb_asset,up_corpus,del_corpus,query_corpus,stop_corpus_uploading_job} - 脚本使用模式，有init_database_info(初始化数据库配置)、init_database(初始化数据库)、clear_database（清除数据库）、create_kb(创建资产)、 - del_kb(删除资产)、query_kb(查询资产)、create_kb_asset(创建资产库)、del_kb_asset(删除资产库)、query_kb_asset(查询 - 资产库)、up_corpus(上传语料,当前支持txt、html、pdf、docx和md格式)、del_corpus(删除语料)、query_corpus(查询语料)和 - stop_corpus_uploading_job(上传语料失败后，停止当前上传任务) - --database_url DATABASE_URL - 语料资产所在数据库的url - --vector_agent_name VECTOR_AGENT_NAME - 向量化插件名称 - --parser_agent_name PARSER_AGENT_NAME - 分词插件名称 - --rag_url RAG_URL rag服务的url - --kb_name KB_NAME 资产名称 - --kb_asset_name KB_ASSET_NAME - 资产库名称 - --corpus_dir CORPUS_DIR - 待上传语料所在路径 - --corpus_chunk CORPUS_CHUNK - 语料切割尺寸 - --corpus_name CORPUS_NAME - 待查询或者待删除语料名 - --up_chunk UP_CHUNK 语料单次上传个数 - --embedding_model {TEXT2VEC_BASE_CHINESE_PARAPHRASE,BGE_LARGE_ZH,BGE_MIXED_MODEL} - 初始化资产时决定使用的嵌入模型 - --vector_dim VECTOR_DIM - 向量化维度 - --num_cores NUM_CORES - 语料处理使用核数 -``` - -### 具体操作 - -以下出现的命令中带**初始化**字段需要在进行资产管理前按指南中出现的相对顺序进行执行，命令中带**可重复**执字段的在后续过程中可以反复执行，命令中带**注意**字段的需谨慎执行。 - -### 步骤1：配置数据库和 RAG 信息 - -- #### 配置数据库信息（初始化） - -```bash -python3 scripts/rag_kb_manager.pyc --method init_database_info --database_url postgresql+psycopg2://postgres:123456@{dabase_url}:{databse_port}/postgres -``` - -**注意：** - -**{dabase_url}**为 k8s 集群内访问 postgres 服务的 url，请根据具体情况修改，一般为 **{postgres_servive_name}-{{ .Release.Name }}.\.svc.cluster.local** 格式，其中 **{postgres_servive_name}** 可以从 找到： - -![k8s集群中postgres服务的名称](./pictures/本地资产库构建/k8s集群中postgres服务的名称.png) - -**{{ .Release.Name }}**和**\** 为部署服务时helm安装应用时指定的 **my-release-name** 以及 **my-namespace**，一条 helm 安装应用的命令如下所示： - -```bash -helm install my-release-name --namespace my-namespace path/to/chart -``` - -**database_port** 的信息可以在 中查看，以下为字段所在位置（一般为5432）： - -![postgres服务端口](./pictures/本地资产库构建/postgres服务端口.png) - -数据库信息配置命令执行命令完成之后会在 scripts/config 下出现 database_info.json 文件，文件内容如下： - -```bash -{"database_url": "postgresql+psycopg2://postgres:123456@{dabase_url}:{databse_port}/postgres"} -``` - -下面是命令执行成功的截图： - -![数据库配置信息成功](./pictures/本地资产库构建/数据库配置信息成功.png) - -- #### 配置rag信息（初始化） - -```bash -python3 scripts/rag_kb_manager.pyc --method init_rag_info --rag_url http://{rag_url}:{rag_port} -``` - -**{rag_url}** 为 0.0.0.0，**{rag_port}** 可以从 中获取（一般为8005）： - -![rag_port](./pictures/本地资产库构建/rag_port.png) - -数据库信息配置命令执行命令完成之后会在 scripts/config 下出现 rag_info.json 文件，文件内容如下： - -```bash -{"rag_url": "http://{rag_url}:{rag_port}"} -``` - -下面是命令执行成功的截图： - -![rag配置信息成功](./pictures/本地资产库构建/rag配置信息成功.png) - -### 步骤2：初始化数据库 - -- #### 初始化数据库表格 - -```bash -python3 scripts/rag_kb_manager.pyc --method init_database -# 注意： -# 对于特殊关系型数据库可指定插件参数'--vector_agent_name VECTOR_AGENT_NAME'和 '--parser_agent_name PARSER_AGENT_NAME'；其中VECTOR_AGENT_NAME默认为vector, PARSER_AGENT_NAME默认为zhparser -``` - -命令执行完成之后可以进入数据库容器查看表格是否创建成功，首先获取命名空间中的所有节点名称： - -```bash -# 获取命名空间中的所有pod节点 -kubectl get pods -n euler-copilot -``` - -结果如下： - -![获取数据库pod名称](./pictures/本地资产库构建/获取数据库pod名称.png) - -使用下面命令进入数据库： - -```bash -kubectl exec -it pgsql-deploy-b4cc79794-qn8zd -n euler-copilot -- bash -``` - -进入容器后使用下面命令进入数据库： - -```bash -root@pgsql-deploy-b4cc79794-qn8zd:/tmp# psql -U postgres -``` - -再使用\dt查看数据库初始化情况，出现下面内容表示数据库初始化成功： - -![数据库初始化](./pictures/本地资产库构建/数据库初始化.png) - -- #### 清空数据库（注意） - - 假设您想清空 RAG 产生的所有数据库数据，可以使用下面命令（**此命令会清空整个数据库，需谨慎操作！**）。 - -```bash -python3 scripts/rag_kb_manager.pyc --method clear_database -# 清空数据库请谨慎操作 -``` - -### 步骤3：创建资产 - - 下列指令若不指定 kb_name，则默认资产名为 default_test（ps：Copilot 不允许存在两个同名的资产）： - -- #### 创建资产（可重复） - -```bash -python3 scripts/rag_kb_manager.pyc --method create_kb --kb_name default_test -``` - -创建资产成功会有以下提示： - -![创建资产成功](./pictures/本地资产库构建/创建资产成功.png) - -创建同名资产会有以下提示： - -![重复创建资产失败](./pictures/本地资产库构建/重复创建资产失败.png) - -- #### 删除资产（可重复） - -```bash -python3 scripts/rag_kb_manager.pyc --method del_kb --kb_name default_test -``` - -删除资产成功会出现以下提示（会将资产下的所有资产库和语料资产全部删除）： - -![删除资产成功](./pictures/本地资产库构建/删除资产成功.png) - -对于不存在的资产进行删除，会出现以下提示： - -![删除不存在的资产失败](./pictures/本地资产库构建/删除不存在的资产失败.png) - -- #### 查询资产（可重复） - -```bash -python3 scripts/rag_kb_manager.pyc --method query_kb -``` - -查询资产成功会出现下面内容： - -![查询资产](./pictures/本地资产库构建/查询资产.png) - -对于无资产的情况下查询资产会出现以下内容： - -![无资产时查询资产](./pictures/本地资产库构建/无资产时查询资产.png) - -### 步骤4：创建资产库 - -下列指令若不指定资产名（kb_name）和资产库名（kb_asset_name），则默认资产名为 default_test 和资产库名 default_test_asset（ps：Copilot 同一个资产下不允许存在两个同名的资产库）： - -- #### 创建资产库（可重复） - -```bash -python3 scripts/rag_kb_manager.pyc --method create_kb_asset --kb_name default_test --kb_asset_name default_test_asset -# 创建属于default_test的资产库 -``` - -对于创建资产库成功会出现以下内容： - -![资产库创建成功](./pictures/本地资产库构建/资产库创建成功.png) - -对于指定不存在的资产库创建资产会出现以下内容： - -![指定不存在的资产创建资产库失败](./pictures/本地资产库构建/指定不存在的资产创建资产库失败.png) - -对于同一个资产下重复创建同名资产库会出现以下内容： - -![创建资产库失败由于统一资产下存在同名资产库](./pictures/本地资产库构建/创建资产库失败由于统一资产下存在同名资产库.png) - -- #### 删除资产库（可重复） - -```bash -python3 scripts/rag_kb_manager.pyc --method del_kb_asset --kb_name default_test --kb_asset_name default_test_asset -``` - -对于删除资产库成功会出现以下内容： - -![资产库删除成功](./pictures/本地资产库构建/资产库删除成功png.png) - -对于删除不存在的资产库失败会出现以下内容： - -![资产下不存在对应资产库](./pictures/本地资产库构建/删除资产库失败，资产下不存在对应资产库.png) - -对于删除不存在的资产下的资产库会出现以下内容： - -![不存在资产](./pictures/本地资产库构建/资产库删除失败，不存在资产.png) - -- #### 查询资产库（可重复） - -```bash -python3 scripts/rag_kb_manager.pyc --method query_kb_asset --kb_name default_test -# 注意：资产是最上层的，资产库属于资产，且不能重名 -``` - -对于查询资产库成功会出现以下内容： - -![资产下查询资产库成功](./pictures/本地资产库构建/资产下查询资产库成功.png) - -对于资产内无资产库的情况下查询资产库会出现以下内容： - -![资产下未查询到资产库](./pictures/本地资产库构建/资产下未查询到资产库.png) - -对于查询不存在的资产下的资产库会出现以下内容： - -![不存在资产](./pictures/本地资产库构建/资产库查询失败，不存在资产.png) - -### 步骤5：上传语料 - -下列指令若不指定资产名（kb_name）和资产库名（kb_asset_name），则默认资产名为 default_test 和资产库名 default_test_asset，对于删除语料命令需要指定完整的语料名称（语料统一为 docx 格式保存在数据库中，可以通过查询语料命令查看已上传的文档名称）；对于查询语料命令可以不指定语料名称（corpus_name），此时默认查询所有语料，可以指定部分或者完整的语料名，此时通过模糊搜索匹配数据库内相关的语料名称。 - -- 上传语料 - -```bash -python3 scripts/rag_kb_manager.pyc --method up_corpus --corpus_dir ./scripts/docs/ --kb_name default_test --kb_asset_name default_test_asset -# 注意： -# 1. RAG容器用于存储用户语料的目录路径是'./scripts/docs/'。在执行相关命令前，请确保该目录下已有本地上传的语料。 -# 2. 若语料已上传但查询未果，请检查宿主机上的待向量化语料目录（位于/home/euler-copilot/docs）的权限设置。 -# 为确保无权限问题影响，您可以通过运行chmod 755 /home/euler-copilot/docs命令来赋予该目录最大访问权限。 -``` - -对于语料上传成功会出现以下内容： - -![语料上传成功](./pictures/本地资产库构建/语料上传成功.png) - -对于语料具体的分割和上传情况可以在 logs/app.log 下查看，内容如下： - -![查看文档产生片段总数和上传成功总数](./pictures/本地资产库构建/查看文档产生片段总数和上传成功总数.png) - -- 删除语料 - -```bash -python3 scripts/rag_kb_manager.pyc --method del_corpus --corpus_name abc.docx --kb_name default_test --kb_asset_name default_test_asset -# 上传的文件统一转换为docx -``` - -对于语料删除成功会出现以下内容： - -![删除语料](./pictures/本地资产库构建/删除语料.png) - -对于删除不存在的语料会出现以下内容： - -![语料删除失败](./pictures/本地资产库构建/语料删除失败，未查询到相关语料.png) - -- 查询语料 - -```bash -# 查询指定名称的语料： -python3 scripts/rag_kb_manager.pyc --method query_corpus --corpus_name 语料名.docx -# 查询所有语料： -python3 scripts/rag_kb_manager.pyc --method query_corpus -``` - -对于查询所有语料会出现以下内容： - -![查询全部语料](./pictures/本地资产库构建/查询全部语料.png) - -- 停止上传任务 - -```bash -python3 scripts/rag_kb_manager.pyc --method stop_corpus_uploading_job -``` - -对于某些极端条件下（例如内存受限），上传语料失败，需要执行上面shell命令用于清除语料上传失败的缓存。 - -## 网页端查看语料上传进度 - -您可以灵活设置端口转发规则，通过执行如下命令将容器端口映射到主机上的指定端口，并在任何设备上通过访问 http://<主机IP>:<映射端口>（例如 ）来查看语料上传的详细情况。 - -```bash -kubectl port-forward rag-deploy-service-5b7887644c-sm58z 3000:8005 -n euler-copilot --address=0.0.0.0 -# 注意: 3000是主机上的端口，8005是rag的容器端口，可修改映射到主机上的端口 -``` - -## 验证上传后效果 - -上传语料成功之后你可以通过以下命令直接与 RAG 交互，来观察语料是否上传成功。 - -```bash -curl -k -X POST "http://{rag_url}:{rag_port}/kb/get_answer" -H "Content-Type: application/json" -d '{ \ - "question": "question", \ - "kb_sn": "kb_name", \ - "fetch_source": true, \ - "top_k": 3 \ -}' -``` - -- `question`：问题 - -- `kb_sn`：资产库名称 - -- `fetch_source`：是否返回关联片段以及片段来源，`false` 代表不返回，`true` 代表返回 - -- `top_k`：关联语料片段个数，需要大于等于3 diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/offline.md b/docs/zh/tools/ai/euler_copilot/deployment_guide/offline.md deleted file mode 100644 index 626bd3fb2a56cc03c7f203dbb56e9fba7d9e5874..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/offline.md +++ /dev/null @@ -1,741 +0,0 @@ -# 无网络环境下部署指南 - -## 介绍 - -openEuler Copilot System 是一款智能问答工具，使用 openEuler Copilot System 可以解决操作系统知识获取的便捷性，并且为OS领域模型赋能开发者及运维人员。作为获取操作系统知识，使能操作系统生产力工具 (如 A-Ops / A-Tune / x2openEuler / EulerMaker / EulerDevOps / StratoVirt / iSulad 等)，颠覆传统命令交付方式，由传统命令交付方式向自然语义进化，并结合智能体任务规划能力，降低开发、使用操作系统特性的门槛。 - -### 组件介绍 - -| 组件 | 端口 | 说明 | -| ----------------------------- | --------------- | -------------------- | -| euler-copilot-framework | 8002 (内部端口) | 智能体框架服务 | -| euler-copilot-web | 8080 | 智能体前端界面 | -| euler-copilot-rag | 8005 (内部端口) | 检索增强服务 | -| euler-copilot-vectorize-agent | 8001 (内部端口) | 文本向量化服务 | -| mysql | 3306 (内部端口) | MySQL数据库 | -| redis | 6379 (内部端口) | Redis数据库 | -| postgres | 5432 (内部端口) | 向量数据库 | -| secret_inject | 无 | 配置文件安全复制工具 | - -## 环境要求 - -### 软件要求 - -| 类型 | 版本要求 | 说明 | -|------------| -------------------------------------|--------------------------------------| -| 操作系统 | openEuler 22.03 LTS 及以上版本 | 无 | -| K3s | >= v1.30.2，带有 Traefik Ingress 工具 | K3s 提供轻量级的 Kubernetes 集群，易于部署和管理 | -| Helm | >= v3.15.3 | Helm 是一个 Kubernetes 的包管理工具，其目的是快速安装、升级、卸载 openEuler Copilot System 服务 | -| python | >=3.9.9 | python3.9.9 以上版本为模型的下载和安装提供运行环境 | - -### 硬件要求 - -| 类型 | 硬件要求 | -|----------------| -----------------------------| -| 服务器 | 1台 | -| CPU | 鲲鹏或x86_64，>= 32 cores | -| RAM | >= 64GB | -| 存储 | >= 500 GB | -| GPU | Tesla V100 16GB，4张 | -| NPU | 910ProB、910B | - -注意： - -1. 若无 GPU 或 NPU 资源，建议通过调用 OpenAI 接口的方式来实现功能。(接口样例：) -2. 调用第三方 OpenAI 接口的方式不需要安装高版本的 python (>=3.9.9) -3. 英伟达 GPU 对 Docker 的支持必需要新版本 Docker (>= v25.4.0) - -### 部署视图 - -![部署图](./pictures/部署视图.png) - -## 获取 openEuler Copilot System - -- 从 openEuler Copilot System 的官方Git仓库 [euler-copilot-framework](https://gitee.com/openeuler/euler-copilot-framework) 下载最新的部署仓库 -- 如果您正在使用 Kubernetes，则不需要安装 k3s 工具。 - - ```bash - # 下载目录以 home 为例 - cd /home - ``` - - ```bash - git clone https://gitee.com/openeuler/euler-copilot-framework.git - ``` - -## 环境准备 - -如果您的服务器、硬件、驱动等全部就绪，即可启动环境初始化流程，以下部署步骤在无公网环境执行。 - -### 1. 环境检查 - -环境检查主要是对服务器的主机名、DNS、防火墙设置、磁盘剩余空间大小、网络、检查 SELinux 的设置。 - -- 主机名设置 - 在Shell中运行如下命令： - - ```bash - cat /etc/hostname - echo "主机名" > /etc/hostname - ``` - -- 系统DNS设置：需要给当前主机设置有效的DNS -- 防火墙设置 - - ```bash - # 查看防火墙状态 - systemctl status firewalld - # 查看防火墙列表 - firewall-cmd --list-all - # 关闭防火墙 - systemctl stop firewalld - systemctl disable firewalld - ``` - -- SELinux设置 - - ```bash - # 需要关闭selinux，可以临时关闭或永久关闭 - # 永久关闭SELinux - sed -i 's/SELINUX=enforcing/SELINUX=disabled/g' /etc/selinux/config - # 临时关闭 - setenforce 0 - ``` - -### 2. 文件下载 - -- 模型文件 bge-reranker-large、bge-mixed-model 下载 [模型文件下载链接](https://repo.oepkgs.net/openEuler/rpm/openEuler-22.03-LTS/contrib/EulerCopilot/) - - ```bash - mkdir -p /home/EulerCopilot/models - cd /home/EulerCopilot/models - # 将需要下载的bge文件放置在models目录 - wget https://repo.oepkgs.net/openEuler/rpm/openEuler-22.03-LTS/contrib/EulerCopilot/bge-mixed-model.tar.gz - wget https://repo.oepkgs.net/openEuler/rpm/openEuler-22.03-LTS/contrib/EulerCopilot/bge-reranker-large.tar.gz - ``` - -- 下载分词工具 text2vec-base-chinese-paraphrase [分词工具下载链接](https://repo.oepkgs.net/openEuler/rpm/openEuler-22.03-LTS/contrib/EulerCopilot/) - - ```bash - mkdir -p /home/EulerCopilot/text2vec - cd /home/EulerCopilot/text2vec - wget https://repo.oepkgs.net/openEuler/rpm/openEuler-22.03-LTS/contrib/EulerCopilot/text2vec-base-chinese-paraphrase.tar.gz - ``` - -- 镜像包下载 - - x86或arm架构的EulerCopilot服务的各组件镜像单独提供 - -### 3. 安装部署工具 - -#### 3.1 安装 Docker - -如需要基于 GPU/NPU 部署大模型，需要检查 Docker 版本是否满足>= v25.4.0 ，如不满足，请升级 Docker 版本 - -#### 3.2 安装 K3s 并导入镜像 - -- 安装 SELinux 配置文件 - - ```bash - yum install -y container-selinux selinux-policy-base - # packages里有k3s-selinux-0.1.1-rc1.el7.noarch.rpm的离线包 - rpm -i https://rpm.rancher.io/k3s-selinux-0.1.1-rc1.el7.noarch.rpm - ``` - -- x86 架构安装 k3s - - ```bash - # 在有网络的环境上获取k3s相关包，以v1.30.3+k3s1示例 - wget https://github.com/k3s-io/k3s/releases/download/v1.30.3%2Bk3s1/k3s - wget https://github.com/k3s-io/k3s/releases/download/v1.30.3%2Bk3s1/k3s-airgap-images-amd64.tar.zst - cp k3s /usr/local/bin/ - cd /var/lib/rancher/k3s/agent - mkdir images - cp k3s-airgap-images-arm64.tar.zst /var/lib/rancher/k3s/agent/images - # packages里有k3s-install.sh的离线包 - curl -sfL https://rancher-mirror.rancher.cn/k3s/k3s-install.sh - INSTALL_K3S_SKIP_DOWNLOAD=true ./k3s-install.sh - export KUBECONFIG=/etc/rancher/k3s/k3s.yaml - ``` - -- arm 架构安装 k3s - - ```bash - # 在有网络的环境上获取k3s相关包，以v1.30.3+k3s1示例 - wget https://github.com/k3s-io/k3s/releases/download/v1.30.3%2Bk3s1/k3s-arm64 - wget https://github.com/k3s-io/k3s/releases/download/v1.30.3%2Bk3s1/k3s-airgap-images-arm64.tar.zst - cp k3s-arm64 /usr/local/bin/k3s - cd /var/lib/rancher/k3s/agent - mkdir images - cp k3s-airgap-images-arm64.tar.zst /var/lib/rancher/k3s/agent/images - # packages里有k3s-install.sh的离线包 - curl -sfL https://rancher-mirror.rancher.cn/k3s/k3s-install.sh - INSTALL_K3S_SKIP_DOWNLOAD=true ./k3s-install.sh - export KUBECONFIG=/etc/rancher/k3s/k3s.yaml - ``` - -- 导入镜像 - - ```bash - # 导入已下载的镜像文件 - k3s ctr image import $(镜像文件) - ``` - -#### 3.3 安装 Helm 工具 - -- x86_64 架构 - - ```bash - wget https://get.helm.sh/helm-v3.15.0-linux-amd64.tar.gz - tar -xzf helm-v3.15.0-linux-amd64.tar.gz - mv linux-amd64/helm /usr/sbin - rm -rf linux-amd64 - ``` - -- arm64 架构 - - ```bash - wget https://get.helm.sh/helm-v3.15.0-linux-arm64.tar.gz - tar -xzf helm-v3.15.0-linux-arm64.tar.gz - mv linux-arm64/helm /usr/sbin - rm -rf linux-arm64 - ``` - -#### 3.4 大模型准备 - -提供第三方openai接口或基于硬件本都部署大模型，本地部署大模型可参考附录部分。 - -## 安装 - -您的环境现已就绪，接下来即可启动 openEuler Copilot System 的安装流程。 - -- 下载目录以home为例，进入 openEuler Copilot System 仓库的 Helm 配置文件目录 - - ```bash - cd /home/euler-copilot-framework && ll - ``` - - ```bash - total 28 - drwxr-xr-x 3 root root 4096 Aug 28 17:45 docs/ - drwxr-xr-x 5 root root 4096 Aug 28 17:45 deploy/ - ``` - -- 查看deploy的目录 - - ```bash - tree deploy - ``` - - ```bash - deploy/chart - ├── databases - │   ├── Chart.yaml - │   ├── configs - │   ├── templates - │   └── values.yaml - ├── authhub - │   ├── Chart.yaml - │   ├── configs - │   ├── templates - │   └── values.yaml - └── euler_copilot - ├── Chart.yaml - ├── configs - ├── templates - │   ├── NOTES.txt - │   ├── rag - │   ├── vectorize - │   └── web - └── values.yaml - ``` - -### 1. 安装数据库 - -- 编辑 values.yaml - - ```bash - cd deploy/chart/databases - ``` - - 仅需修改镜像tag为对应架构，其余可不进行修改 - - ```bash - vim values.yaml - ``` - -- 创建命名空间 - - ```bash - kubectl create namespace euler-copilot - ``` - - 设置环境变量 - - ```bash - export KUBECONFIG=/etc/rancher/k3s/k3s.yaml - ``` - -- 安装数据库 - - ```bash - helm install -n euler-copilot databases . - ``` - -- 查看 pod 状态 - - ```bash - kubectl -n euler-copilot get pods - ``` - - ```bash - pgsql-deploy-databases-86b4dc4899-ppltc 1/1 Running 0 17d - redis-deploy-databases-f8866b56-kj9jz 1/1 Running 0 17d - mysql-deploy-databases-57f5f94ccf-sbhzp 2/2 Running 0 17d - ``` - -- 若服务器之前部署过 mysql，则可预先清除下 pvc，再部署 databases。 - - ```bash - # 获取pvc - kubectl -n euler-copilot get pvc - ``` - - ```bash - # 删除pvc - kubectl -n euler-copilot delete pvc mysql-pvc - ``` - -### 2. 安装鉴权平台Authhub - -- 编辑 values.yaml - - ```bash - cd deploy/chart/authhub - ``` - - 请结合 YAML 中的注释中的[必填]项进行修改 - - ```bash - vim values.yaml - ``` - - - 注意： - 1. authHub 需要域名，可预先申请域名或在 'C:\Windows\System32\drivers\etc\hosts' 下配置。 - authhub和euler-copilot必须是同一个根域名的两个子域名, 例如authhub.test.com和 - eulercopilot.test.com - 2. 修改tag为对应架构的tag; - -- 安装 AuthHub - - ```bash - helm install -n euler-copilot authhub . - ``` - - AuthHub 默认账号 `administrator`, 密码 `changeme` - -- 查看 pod 状态 - - ```bash - kubectl -n euler-copilot get pods - ``` - - ```bash - NAME READY STATUS RESTARTS AGE - authhub-backend-deploy-authhub-64896f5cdc-m497f 2/2 Running 0 16d - authhub-web-deploy-authhub-7c48695966-h8d2p 1/1 Running 0 17d - pgsql-deploy-databases-86b4dc4899-ppltc 1/1 Running 0 17d - redis-deploy-databases-f8866b56-kj9jz 1/1 Running 0 17d - mysql-deploy-databases-57f5f94ccf-sbhzp 2/2 Running 0 17d - ``` - -- 登录 AuthHub - - AuthHub 的域名以 为例，浏览器输入`https://authhub.test.com`, 登录界面如下图所示： - - ![部署图](./pictures/authhub登录界面.png) - -- 创建应用eulercopilot - - ![部署图](./pictures/创建应用界面.png) - 点击创建应用，输入应用名称、应用主页和应用回调地址（登录后回调地址），参考如下： - - 应用名称：eulercopilot - - 应用主页： - - 应用回调地址： - - 应用创建好后会生成 Client ID 和 Client Secret，将生成的 Client ID 和 Client Secret 配置到应用里，以 eulercopilot 为例，创建应用后在配置文件中添加配置 `deploy/chart/euler_copilot/values.yaml` 中添加配置 - - ![部署图](./pictures/创建应用成功界面.png) - -### 2. 安装 openEuler Copilot System - -- 编辑 values.yaml - - ```bash - cd deploy/chart/euler_copilot - ``` - - 请结合 YAML 中的注释中的[必填]项进行修改 - - ```bash - vim values.yaml - ``` - - - 注意： - 1. 查看系统架构，并修改values.yaml中的tag； - 2. 修改values.yaml中的globals的domain为EulerCopilot域名，并配置大模型的相关信息 - 3. 手动创建`docs_dir`、`plugin_dir`、`models`三个文件挂载目录 - 4. 修改values.yaml中framework章节的web_url和oidc设置 - 5. 如果部署插件，则需要配置用于Function Call的模型，此时必须有GPU环境用于部署sglang，可参考附件 - -- 安装 openEuler Copilot System - - ```bash - helm install -n euler-copilot service . - ``` - -- 查看 Pod 状态 - - ```bash - kubectl -n euler-copilot get pods - ``` - - 镜像拉取过程可能需要大约一分钟的时间，请耐心等待。部署成功后，所有 Pod 的状态应显示为 Running。 - - ```bash - NAME READY STATUS RESTARTS AGE - authhub-backend-deploy-authhub-64896f5cdc-m497f 2/2 Running 0 16d - authhub-web-deploy-authhub-7c48695966-h8d2p 1/1 Running 0 17d - pgsql-deploy-databases-86b4dc4899-ppltc 1/1 Running 0 17d - redis-deploy-databases-f8866b56-kj9jz 1/1 Running 0 17d - mysql-deploy-databases-57f5f94ccf-sbhzp 2/2 Running 0 17d - framework-deploy-service-bb5b58678-jxzqr 2/2 Running 0 16d - rag-deploy-service-5b7887644c-sm58z 2/2 Running 0 110m - vectorize-deploy-service-57f5f94ccf-sbhzp 2/2 Running 0 17d - web-deploy-service-74fbf7999f-r46rg 1/1 Running 0 2d - ``` - - 注意：如果 Pod 状态出现失败，建议按照以下步骤进行排查 -注意：如果 Pod 状态出现失败，建议按照以下步骤进行排查 - - 1. 查看 Kubernetes 集群的事件 (Events)，以获取更多关于 Pod 失败的上下文信息 - - ```bash - kubectl -n euler-copilot get events - ``` - - 2. 查看镜像拉取是否成功 - - ```bash - k3s crictl images - ``` - - 3. 检查 RAG 的 Pod 日志，以确定是否有错误信息或异常行为。 - - ```bash - kubectl logs rag-deploy-service-5b7887644c-sm58z -n euler-copilot - ``` - - 4. 验证 Kubernetes 集群的资源状态，检查服务器资源或配额是否足够，资源不足常导致 Pod 镜像服拉取失败。 - - ```bash - df -h - ``` - - 5. 如果未拉取成且镜像大小为0，请检查是否是 k3s 版本未满足要求，低于 v1.30.2 - - ```bash - k3s -v - ``` - - 6. 确认 values.yaml 中 framework 的 OIDC 设置是否正确配置，以确保身份验证和授权功能正常工作。 - - ```bash - vim /home/euler-copilot-framework/deploy/chart/euler_copilot/values.yaml - ``` - -## 验证安装 - -恭喜您，openEuler Copilot System 的部署已完成！现在，您可以开启智能问答的非凡体验之旅了。 -请在浏览器中输入 https://$(host_ip):8080 或 （其中 port 默认值为8080，若更改则需相应调整）访问 openEuler Copilot System 网页，并尝试进行智能问答体验。 - -首先请点击下方页面的“立即注册”按钮，完成账号的注册与登录。 -![Web登录界面](./pictures/WEB登录界面.png) - -![Web 界面](./pictures/WEB界面.png) - -## 安装插件 - -详细信息请参考文档 [插件部署指南](./plugin_deployment_guide) - -## 构建专有领域智能问答 - -### 1. 构建 openEuler 专业知识领域的智能问答 - - 1. 修改 values.yaml 的 pg 的镜像仓为 `pg-data` - 2. 修改 values.yaml 的 rag 部分的字段 `knowledgebaseID: openEuler_2bb3029f` - 3. 将 `vim deploy/chart/databases/templates/pgsql/pgsql-deployment.yaml` 的 volumes 相关字段注释 - 4. 进入 `cd deploy/chart/databases`，执行更新服务 `helm upgrade -n euler-copilot databases .` - 5. 进入 `cd deploy/chart/euler_copilot`，执行更新服务 `helm upgrade -n euler-copilot service .` - 6. 进入网页端进行 openEuler 专业知识领域的问答 - -### 2. 构建项目专属知识领域智能问答 - -详细信息请参考文档 [本地资产库构建指南](local_asset_library_setup_guide.md) - -## 附录 - -### 大模型准备 - -#### GPU 环境 - -参考以下方式进行部署 - -1. 下载模型文件： - - ```bash - huggingface-cli download --resume-download Qwen/Qwen1.5-14B-Chat --local-dir Qwen1.5-14B-Chat - ``` - -2. 创建终端 control - - ```bash - screen -S control - ``` - - ```bash - python3 -m fastchat.serve.controller - ``` - - - 按 Ctrl A+D 置于后台 - -3. 创建新终端 api - - ```bash - screen -S api - ``` - - ```bash - python3 -m fastchat.serve.openai_api_server --host 0.0.0.0 --port 30000 --api-keys sk-123456 - ``` - - - 按 Ctrl A+D 置于后台 - - 如果当前环境的 Python 版本是 3.12 或者 3.9 可以创建 python3.10 的 conda 虚拟环境 - - ```bash - mkdir -p /root/py310 - ``` - - ```bash - conda create --prefix=/root/py310 python==3.10.14 - ``` - - ```bash - conda activate /root/py310 - ``` - -4. 创建新终端 worker - - ```bash - screen -S worker - ``` - - ```bash - screen -r worker - ``` - - 安装 fastchat 和 vllm - - ```bash - pip install fschat vllm - ``` - - 安装依赖： - - ```bash - pip install fschat[model_worker] - ``` - - ```bash - python3 -m fastchat.serve.vllm_worker --model-path /root/models/Qwen1.5-14B-Chat/ --model-name qwen1.5 --num-gpus 8 --gpu-memory-utilization=0.7 --dtype=half - ``` - - - 按 Ctrl A+D 置于后台 - -5. 按照如下方式配置文件，并更新服务。 - - ```bash - vim deploy/chart/euler_copilot/values.yaml - ``` - - 修改如下部分 - - ```yaml - llm: - # 开源大模型，OpenAI兼容接口 - openai: - url: "http://$(IP):30000" - key: "sk-123456" - model: qwen1.5 - max_tokens: 8192 - ``` - -#### NPU 环境 - -NPU 环境部署可参考链接 [MindIE安装指南](https://www.hiascend.com/document/detail/zh/mindie/10RC2/whatismindie/mindie_what_0001.html) - -## FAQ - -### 1. huggingface 使用报错？ - -```text -File "/usr/lib/python3.9/site-packages/urllib3/connection.py", line 186, in _new_conn -raise NewConnectionError( -urllib3.exceptions.eanconectionError: : Failed to establish a new conmection: [Errno 101] Network is unreachable -``` - -- 解决办法 - -```bash -pip3 install -U huggingface_hub -``` - -```bash -export HF_ENDPOINT=https://hf-mirror.com -``` - -### 2. 如何在 RAG 容器中调用获取问答结果的接口？ - -- 请先进入到 RAG 对应 Pod - -```bash -curl -k -X POST "http://localhost:8005/kb/get_answer" -H "Content-Type: application/json" -d '{ \ - "question": "", \ - "kb_sn": "default_test", \ - "fetch_source": true }' -``` - -### 3. 执行 `helm upgrade` 报错? - -```text -Error: INSTALLATI0N FAILED: Kubernetes cluster unreachable: Get "http:/localhost:880/version": dial tcp [:1:8089: connect: connection refused -``` - -或者 - -```text -Error: UPGRADE FAILED: Kubernetes cluster unreachable: the server could not find the requested resource -``` - -- 解决办法 - -```bash -export KUBECONFIG=/etc/rancher/k3s/k3s.yaml -``` - -### 4. 无法查看 Pod 日志？ - -```text -[root@localhost euler-copilot]# kubectl logs rag-deployservice65c75c48d8-44vcp-n euler-copilotDefaulted container "rag" out of: rag.rag-copy secret (init)Error from server: Get "https://172.21.31.11:10250/containerlogs/euler copilot/rag deploy"service 65c75c48d8-44vcp/rag": Forbidden -``` - -- 解决办法 - 如果设置了代理，需要将本机的网络 IP 从代理中剔除 - -```bash -cat /etc/systemd/system/k3s.service.env -``` - -```text -http_proxy="http://172.21.60.51:3128" -https_proxy="http://172.21.60.51:3128" -no_proxy=172.21.31.10 # 代理中剔除本机IP -``` - -### 5. GPU环境部署大模型时出现无法流式回复？ - -在服务执行 curl 大模型失败，但是将 `"stream": true` 改为 `"stream": false`就可以 curl 通？ - -```bash -curl http://localhost:30000/v1/chat/completions -H "Content-Type: application/json" -H "Authorization: Bearer sk-123456" -d '{ -"model": "qwen1.5", -"messages": [ -{ -"role": "system", -"content": "你是情感分析专家，你的任务是xxxx" -}, -{ -"role": "user", -"content": "你好" -} -], -"stream": true, -"n": 1, -"max_tokens": 32768 -}' -``` - -- 解决办法： - -```bash -pip install Pydantic=1.10.13 -``` - -### 6. 如何部署 sglang？ - -```bash -# 1. 激活 Conda 环境, 并激活 Python 3.10 的 Conda 环境。假设你的环境名为 `myenv`： -conda activate myenv - -# 2. 在激活的环境中，安装 sglang[all] 和 flashinfer -pip install sglang[all]==0.3.0 -pip install flashinfer -i https://flashinfer.ai/whl/cu121/torch2.4/ - -# 3. 启动服务器 -python -m sglang.launch_server --served-model-name Qwen2.5-32B --model-path Qwen2.5-32B-Instruct-AWQ --host 0.0.0.0 --port 8001 --api-key sk-12345 --mem-fraction-static 0.5 --tp 8 -``` - -- 验证安装 - - ```bash - pip show sglang - pip show flashinfer - ``` - -- 注意： - - 1. API Key：请确保 `--api-key` 参数中的 API 密钥是正确的 - 2. 模型路径： 确保 `--model-path` 参数中的路径是正确的，并且模型文件存在于该路径下。 - 3. CUDA 版本：确保你的系统上安装了 CUDA 12.1 和 PyTorch 2.4，因为 `flashinfer` 包依赖于这些特定版本。 - 4. 线程池大小：根据你的GPU资源和预期负载调整线程池大小。如果你有 8 个 GPU，那么可以选择 --tp 8 来充分利用这些资源。 - -### 7. 如何 curl embedding? - -```bash -curl -k -X POST http://$IP:8001/embedding \ - -H "Content-Type: application/json" \ - -d '{"texts": ["sample text 1", "sample text 2"]}' -# $IP为vectorize的Embedding的内网地址 -``` - -### 8. 如何生成证书？ - -```bash -下载地址： https://github.com/FiloSottile/mkcert/releases -# 1. 下载 mkcert -# x86_64 -wget https://github.com/FiloSottile/mkcert/releases/download/v1.4.4/mkcert-v1.4.4-linux-amd64 -# arm64 -wget https://github.com/FiloSottile/mkcert/releases/download/v1.4.4/mkcert-v1.4.4-linux-arm64 - -# 2. 执行下面的命令生成秘钥 -mkcert -install -# mkcert 可直接接域名或 IP, 生成证书和秘钥 -mkcert example.com - -# 3. 将证书和秘钥拷贝到 /home/euler-copilot-framework_openeuler/deploy/chart_ssl/traefik-secret.yaml 中, 并执行下面命令使其生效。 -kubectl apply -f traefik-secret.yaml -``` - -### 8. Pod状态由runnning变为pending？ - -在Pod正常运行一段时间后，其状态从“Running”全部转变为 “Pending” 或 “Completed”， -可执行命令`df -h`，查看Pod所在宿主机的存储空间，确保可用空间不低于30%，以保证pod的正常运行。 diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/online.md b/docs/zh/tools/ai/euler_copilot/deployment_guide/online.md deleted file mode 100644 index 6be9b862cd14db3681647939898087eb19c17ae3..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/online.md +++ /dev/null @@ -1,625 +0,0 @@ -# 网络环境部署指南 - -## 介绍 - -openEuler Copilot System 是一款智能问答工具，使用 openEuler Copilot System 可以解决操作系统知识获取的便捷性，并且为OS领域模型赋能开发者及运维人员。作为获取操作系统知识，使能操作系统生产力工具 (如 A-Ops / A-Tune / x2openEuler / EulerMaker / EulerDevOps / StratoVirt / iSulad 等)，颠覆传统命令交付方式，由传统命令交付方式向自然语义进化，并结合智能体任务规划能力，降低开发、使用操作系统特性的门槛。 - -### 组件介绍 - -| 组件 | 端口 | 说明 | -| ----------------------------- | --------------- | -------------------- | -| euler-copilot-framework | 8002 (内部端口) | 智能体框架服务 | -| euler-copilot-web | 8080 | 智能体前端界面 | -| euler-copilot-rag | 8005 (内部端口) | 检索增强服务 | -| euler-copilot-vectorize-agent | 8001 (内部端口) | 文本向量化服务 | -| mysql | 3306 (内部端口) | MySQL数据库 | -| redis | 6379 (内部端口) | Redis数据库 | -| postgres | 5432 (内部端口) | 向量数据库 | -| secret_inject | 无 | 配置文件安全复制工具 | - -## 环境要求 - -### 软件要求 - -| 类型 | 版本要求 | 说明 | -|------------| -------------------------------------|--------------------------------------| -| 操作系统 | openEuler 22.03 LTS 及以上版本 | 无 | -| K3s | >= v1.30.2，带有 Traefik Ingress 工具 | K3s 提供轻量级的 Kubernetes 集群，易于部署和管理 | -| Helm | >= v3.15.3 | Helm 是一个 Kubernetes 的包管理工具，其目的是快速安装、升级、卸载 openEuler Copilot System 服务 | -| python | >=3.9.9 | python3.9.9 以上版本为模型的下载和安装提供运行环境 | - -### 硬件要求 - -| 类型 | 硬件要求 | -|----------------| -----------------------------| -| 服务器 | 1台 | -| CPU | 鲲鹏或x86_64，>= 32 cores | -| RAM | >= 64GB | -| 存储 | >= 500 GB | -| GPU | Tesla V100 16GB，4张 | -| NPU | 910ProB、910B | - -注意： - -1. 若无 GPU 或 NPU 资源，建议通过调用 OpenAI 接口的方式来实现功能。(接口样例： 参考链接：[API-KEY的获取与配置](https://help.aliyun.com/zh/dashscope/developer-reference/acquisition-and-configuration-of-api-key?spm=a2c4g.11186623.0.0.30e7694eaaxxGa)) -2. 调用第三方 OpenAI 接口的方式不需要安装高版本的 python (>=3.9.9) -3. 英伟达 GPU 对 Docker 的支持必需要新版本 Docker (>= v25.4.0) -4. 如果k8s集群环境，则不需要单独安装k3s，要求version >= 1.28 - -### 部署视图 - -![部署图](./pictures/部署视图.png) - -## 获取 openEuler Copilot System - -- 从 openEuler Copilot System 的官方Git仓库 [euler-copilot-framework](https://gitee.com/openeuler/euler-copilot-framework) 下载最新的部署仓库 -- 如果您正在使用 Kubernetes，则不需要安装 k3s 工具。 - -```bash -# 下载目录以 home 为例 -cd /home -``` - -```bash -git clone https://gitee.com/openeuler/euler-copilot-framework.git -``` - -## 环境准备 - -设备需联网并符合 openEuler Copilot System 的最低软硬件要求。确认服务器、硬件、驱动等准备就绪后，即可开始环境准备工作。为了顺利进行后续操作，请按照指引，先进入我 -们的脚本部署目录，并且按照提供的操作步骤和脚本路径依次执行，以确保初始化成功。 - -```bash -# 进入部署脚本目录 -cd /home/euler-copilot-framework/deploy/scripts && tree -``` - -```bash -. -├── check_env.sh -├── download_file.sh -├── get_log.sh -├── install_tools.sh -└── prepare_docker.sh -``` - -| 序号 | 步骤内容 | 相关指令 | 说明 | -|-------------- |----------|---------------------------------------------|------------------------------------------ | -|1| 环境检查 | `bash check_env.sh` | 主要对服务器的主机名、DNS、防火墙设置、磁盘剩余空间大小、网络、检查SELinux的设置 | -|2| 文件下载 | `bash download_file.sh` | 模型bge-reranker-large、bge-mixed-mode下载 | -|3| 安装部署工具 | `bash install_tools.sh v1.30.2+k3s1 v3.15.3 cn` | 安装helm、k3s工具。注意：cn的使用是使用镜像站，可以去掉不用 | -|4| 大模型准备 | 提供第三方 OpenAI 接口或基于硬件本都部署大模型 | 本地部署大模型可参考附录部分 | - -## 安装 - -您的环境现已就绪，接下来即可启动 openEuler Copilot System 的安装流程。 - -- 下载目录以home为例，进入 openEuler Copilot System 仓库的 Helm 配置文件目录 - - ```bash - cd /home/euler-copilot-framework && ll - ``` - - ```bash - total 28 - drwxr-xr-x 3 root root 4096 Aug 28 17:45 docs/ - drwxr-xr-x 5 root root 4096 Aug 28 17:45 deploy/ - ``` - -- 查看deploy的目录 - - ```bash - tree deploy - ``` - - ```bash - deploy/chart - ├── databases - │   ├── Chart.yaml - │   ├── configs - │   ├── templates - │   └── values.yaml - ├── authhub - │   ├── Chart.yaml - │   ├── configs - │   ├── templates - │   └── values.yaml - └── euler_copilot - ├── Chart.yaml - ├── configs - ├── templates - │   ├── NOTES.txt - │   ├── rag - │   ├── vectorize - │   └── web - └── values.yaml - ``` - -### 1. 安装数据库 - -- 编辑 values.yaml - - ```bash - cd deploy/chart/databases - ``` - - 仅需修改镜像tag为对应架构，其余可不进行修改 - - ```bash - vim values.yaml - ``` - -- 创建命名空间 - - ```bash - kubectl create namespace euler-copilot - ``` - - 设置环境变量 - - ```bash - export KUBECONFIG=/etc/rancher/k3s/k3s.yaml - ``` - -- 安装数据库 - - ```bash - helm install -n euler-copilot databases . - ``` - -- 查看 pod 状态 - - ```bash - kubectl -n euler-copilot get pods - ``` - - ```bash - pgsql-deploy-databases-86b4dc4899-ppltc 1/1 Running 0 17d - redis-deploy-databases-f8866b56-kj9jz 1/1 Running 0 17d - mysql-deploy-databases-57f5f94ccf-sbhzp 2/2 Running 0 17d - ``` - -- 若服务器之前部署过 mysql，则可预先清除下 pvc，再部署 databases。 - - ```bash - # 获取pvc - kubectl -n euler-copilot get pvc - ``` - - ```bash - # 删除pvc - kubectl -n euler-copilot delete pvc mysql-pvc - ``` - -### 2. 安装鉴权平台Authhub - -- 编辑 values.yaml - - ```bash - cd deploy/chart/authhub - ``` - - 请结合 YAML 中的注释中的[必填]项进行修改 - - ```bash - vim values.yaml - ``` - - - 注意： - 1. authHub 需要域名，可预先申请域名或在 'C:\Windows\System32\drivers\etc\hosts' 下配置。 - authhub和euler-copilot必须是同一个根域名的两个子域名, 例如authhub.test.com和 - eulercopilot.test.com - 2. 修改tag为对应架构的tag; - -- 安装 AuthHub - - ```bash - helm install -n euler-copilot authhub . - ``` - - AuthHub 默认账号 `administrator`, 密码 `changeme` - -- 查看 pod 状态 - - ```bash - kubectl -n euler-copilot get pods - ``` - - ```bash - NAME READY STATUS RESTARTS AGE - authhub-backend-deploy-authhub-64896f5cdc-m497f 2/2 Running 0 16d - authhub-web-deploy-authhub-7c48695966-h8d2p 1/1 Running 0 17d - pgsql-deploy-databases-86b4dc4899-ppltc 1/1 Running 0 17d - redis-deploy-databases-f8866b56-kj9jz 1/1 Running 0 17d - mysql-deploy-databases-57f5f94ccf-sbhzp 2/2 Running 0 17d - ``` - -- 登录 AuthHub - - AuthHub 的域名以 为例，浏览器输入`https://authhub.test.com`, 登录界面如下图所示： - - ![部署图](./pictures/authhub登录界面.png) - -- 创建应用eulercopilot - - ![部署图](./pictures/创建应用界面.png) - 点击创建应用，输入应用名称、应用主页和应用回调地址（登录后回调地址），参考如下： - - 应用名称：eulercopilot - - 应用主页： - - 应用回调地址： - - 应用创建好后会生成 Client ID 和 Client Secret，将生成的 Client ID 和 Client Secret 配置到应用里，以 eulercopilot 为例，创建应用后在配置文件中添加配置 `deploy/chart/euler_copilot/values.yaml` 中添加配置 - - ![部署图](./pictures/创建应用成功界面.png) - -### 2. 安装 openEuler Copilot System - -- 编辑 values.yaml - - ```bash - cd deploy/chart/euler_copilot - ``` - - 请结合 YAML 中的注释中的[必填]项进行修改 - - ```bash - vim values.yaml - ``` - - - 注意： - 1. 查看系统架构，并修改values.yaml中的tag； - 2. 修改values.yaml中的globals的domain为EulerCopilot域名，并配置大模型的相关信息 - 3. 手动创建`docs_dir`、`plugin_dir`、`models`三个文件挂载目录 - 4. 修改values.yaml中framework章节的web_url和oidc设置 - 5. 如果部署插件，则需要配置用于Function Call的模型，此时必须有GPU环境用于部署sglang，可参考附件 - -- 安装 openEuler Copilot System - - ```bash - helm install -n euler-copilot service . - ``` - -- 查看 Pod 状态 - - ```bash - kubectl -n euler-copilot get pods - ``` - - 镜像拉取过程可能需要大约一分钟的时间，请耐心等待。部署成功后，所有 Pod 的状态应显示为 Running。 - - ```bash - NAME READY STATUS RESTARTS AGE - authhub-backend-deploy-authhub-64896f5cdc-m497f 2/2 Running 0 16d - authhub-web-deploy-authhub-7c48695966-h8d2p 1/1 Running 0 17d - pgsql-deploy-databases-86b4dc4899-ppltc 1/1 Running 0 17d - redis-deploy-databases-f8866b56-kj9jz 1/1 Running 0 17d - mysql-deploy-databases-57f5f94ccf-sbhzp 2/2 Running 0 17d - framework-deploy-service-bb5b58678-jxzqr 2/2 Running 0 16d - rag-deploy-service-5b7887644c-sm58z 2/2 Running 0 110m - vectorize-deploy-service-57f5f94ccf-sbhzp 2/2 Running 0 17d - web-deploy-service-74fbf7999f-r46rg 1/1 Running 0 2d - ``` - - 注意：如果 Pod 状态出现失败，建议按照以下步骤进行排查 - -注意：如果 Pod 状态出现失败，建议按照以下步骤进行排查 - - 1. 查看 Kubernetes 集群的事件 (Events)，以获取更多关于 Pod 失败的上下文信息 - - ```bash - kubectl -n euler-copilot get events - ``` - - 2. 查看镜像拉取是否成功 - - ```bash - k3s crictl images - ``` - - 3. 检查 RAG 的 Pod 日志，以确定是否有错误信息或异常行为。 - - ```bash - kubectl logs rag-deploy-service-5b7887644c-sm58z -n euler-copilot - ``` - - 4. 验证 Kubernetes 集群的资源状态，检查服务器资源或配额是否足够，资源不足常导致 Pod 镜像服拉取失败。 - - ```bash - df -h - ``` - - 5. 如果未拉取成且镜像大小为0，请检查是否是 k3s 版本未满足要求，低于 v1.30.2 - - ```bash - k3s -v - ``` - - 6. 确认 values.yaml 中 framework 的 OIDC 设置是否正确配置，以确保身份验证和授权功能正常工作。 - - ```bash - vim /home/euler-copilot-framework/deploy/chart/euler_copilot/values.yaml - ``` - -## 验证安装 - -恭喜您，openEuler Copilot System 的部署已完成！现在，您可以开启智能问答的非凡体验之旅了。 -请在浏览器中输入 https://$(host_ip):8080 或 （其中 port 默认值为8080，若更改则需相应调整）访问 openEuler Copilot System 网页，并尝试进行智能问答体验。 - -首先请点击下方页面的“立即注册”按钮，完成账号的注册与登录。 -![Web登录界面](./pictures/WEB登录界面.png) -![Web 界面](./pictures/WEB界面.png) - -## 安装插件 - -详细信息请参考文档 [插件部署指南](./plugin_deployment_guide) - -## 构建专有领域智能问答 - -### 1. 构建 openEuler 专业知识领域的智能问答 - - 1. 修改 values.yaml 的 pg 的镜像仓为 `pg-data` - 2. 修改 values.yaml 的 rag 部分的字段 `knowledgebaseID: openEuler_2bb3029f` - 3. 将 `vim deploy/chart/databases/templates/pgsql/pgsql-deployment.yaml` 的 volumes 相关字段注释 - 4. 进入 `cd deploy/chart/databases`，执行更新服务 `helm upgrade -n euler-copilot databases .` - 5. 进入 `cd deploy/chart/euler_copilot`，执行更新服务 `helm upgrade -n euler-copilot service .` - 6. 进入网页端进行 openEuler 专业知识领域的问答 - -### 2. 构建项目专属知识领域智能问答 - -详细信息请参考文档 [本地资产库构建指南](local_asset_library_setup_guide.md) - -## 附录 - -### 大模型准备 - -#### GPU 环境 - -参考以下方式进行部署 - -1. 下载模型文件： - - ```bash - huggingface-cli download --resume-download Qwen/Qwen1.5-14B-Chat --local-dir Qwen1.5-14B-Chat - ``` - -2. 创建终端 control - - ```bash - screen -S control - ``` - - ```bash - python3 -m fastchat.serve.controller - ``` - - - 按 Ctrl A+D 置于后台 - -3. 创建新终端 api - - ```bash - screen -S api - ``` - - ```bash - python3 -m fastchat.serve.openai_api_server --host 0.0.0.0 --port 30000 --api-keys sk-123456 - ``` - - - 按 Ctrl A+D 置于后台 - - 如果当前环境的 Python 版本是 3.12 或者 3.9 可以创建 python3.10 的 conda 虚拟环境 - - ```bash - mkdir -p /root/py310 - ``` - - ```bash - conda create --prefix=/root/py310 python==3.10.14 - ``` - - ```bash - conda activate /root/py310 - ``` - -4. 创建新终端 worker - - ```bash - screen -S worker - ``` - - ```bash - screen -r worker - ``` - - 安装 fastchat 和 vllm - - ```bash - pip install fschat vllm - ``` - - 安装依赖： - - ```bash - pip install fschat[model_worker] - ``` - - ```bash - python3 -m fastchat.serve.vllm_worker --model-path /root/models/Qwen1.5-14B-Chat/ --model-name qwen1.5 --num-gpus 8 --gpu-memory-utilization=0.7 --dtype=half - ``` - - - 按 Ctrl A+D 置于后台 - -5. 按照如下方式配置文件，并更新服务。 - - ```bash - vim deploy/chart/euler_copilot/values.yaml - ``` - - 修改如下部分 - - ```yaml - llm: - # 开源大模型，OpenAI兼容接口 - openai: - url: "http://$(IP):30000" - key: "sk-123456" - model: qwen1.5 - max_tokens: 8192 - ``` - -#### NPU 环境 - -NPU 环境部署可参考链接 [MindIE安装指南](https://www.hiascend.com/document/detail/zh/mindie/10RC2/whatismindie/mindie_what_0001.html) - -## FAQ - -### 1. huggingface 使用报错？ - -```text -File "/usr/lib/python3.9/site-packages/urllib3/connection.py", line 186, in _new_conn -raise NewConnectionError( -urllib3.exceptions.eanconectionError: : Failed to establish a new conmection: [Errno 101] Network is unreachable -``` - -- 解决办法 - -```bash -pip3 install -U huggingface_hub -``` - -```bash -export HF_ENDPOINT=https://hf-mirror.com -``` - -### 2. 如何在 RAG 容器中调用获取问答结果的接口？ - -- 请先进入到 RAG 对应 Pod - -```bash -curl -k -X POST "http://localhost:8005/kb/get_answer" -H "Content-Type: application/json" -d '{ \ - "question": "", \ - "kb_sn": "default_test", \ - "fetch_source": true }' -``` - -### 3. 执行 `helm upgrade` 报错? - -```text -Error: INSTALLATI0N FAILED: Kubernetes cluster unreachable: Get "http:/localhost:880/version": dial tcp [:1:8089: connect: connection refused -``` - -或者 - -```text -Error: UPGRADE FAILED: Kubernetes cluster unreachable: the server could not find the requested resource -``` - -- 解决办法 - -```bash -export KUBECONFIG=/etc/rancher/k3s/k3s.yaml -``` - -### 4. 无法查看 Pod 日志？ - -```text -[root@localhost euler-copilot]# kubectl logs rag-deployservice65c75c48d8-44vcp-n euler-copilotDefaulted container "rag" out of: rag.rag-copy secret (init)Error from server: Get "https://172.21.31.11:10250/containerlogs/euler copilot/rag deploy"service 65c75c48d8-44vcp/rag": Forbidden -``` - -- 解决办法 - 如果设置了代理，需要将本机的网络 IP 从代理中剔除 - -```bash -cat /etc/systemd/system/k3s.service.env -``` - -```text -http_proxy="http://172.21.60.51:3128" -https_proxy="http://172.21.60.51:3128" -no_proxy=172.21.31.10 # 代理中剔除本机IP -``` - -### 5. GPU环境部署大模型时出现无法流式回复？ - -在服务执行 curl 大模型失败，但是将 `"stream": true` 改为 `"stream": false`就可以 curl 通？ - -```bash -curl http://localhost:30000/v1/chat/completions -H "Content-Type: application/json" -H "Authorization: Bearer sk-123456" -d '{ -"model": "qwen1.5", -"messages": [ -{ -"role": "system", -"content": "你是情感分析专家，你的任务是xxxx" -}, -{ -"role": "user", -"content": "你好" -} -], -"stream": true, -"n": 1, -"max_tokens": 32768 -}' -``` - -- 解决办法： - -```bash -pip install Pydantic=1.10.13 -``` - -### 6. 如何部署 sglang？ - -```bash -# 1. 激活 Conda 环境, 并激活 Python 3.10 的 Conda 环境。假设你的环境名为 `myenv`： -conda activate myenv - -# 2. 在激活的环境中，安装 sglang[all] 和 flashinfer -pip install sglang[all]==0.3.0 -pip install flashinfer -i https://flashinfer.ai/whl/cu121/torch2.4/ - -# 3. 启动服务器 -python -m sglang.launch_server --served-model-name Qwen2.5-32B --model-path Qwen2.5-32B-Instruct-AWQ --host 0.0.0.0 --port 8001 --api-key sk-12345 --mem-fraction-static 0.5 --tp 8 -``` - -- 验证安装 - - ```bash - pip show sglang - pip show flashinfer - ``` - -- 注意： - - 1. API Key：请确保 `--api-key` 参数中的 API 密钥是正确的 - 2. 模型路径： 确保 `--model-path` 参数中的路径是正确的，并且模型文件存在于该路径下。 - 3. CUDA 版本：确保你的系统上安装了 CUDA 12.1 和 PyTorch 2.4，因为 `flashinfer` 包依赖于这些特定版本。 - 4. 线程池大小：根据你的GPU资源和预期负载调整线程池大小。如果你有 8 个 GPU，那么可以选择 --tp 8 来充分利用这些资源。 - -### 7. 如何 curl embedding? - -```bash -curl -k -X POST http://$IP:8001/embedding \ - -H "Content-Type: application/json" \ - -d '{"texts": ["sample text 1", "sample text 2"]}' -# $IP为vectorize的Embedding的内网地址 -``` - -### 8. 如何生成证书？ - -```bash -下载地址： https://github.com/FiloSottile/mkcert/releases -# 1. 下载 mkcert -# x86_64 -wget https://github.com/FiloSottile/mkcert/releases/download/v1.4.4/mkcert-v1.4.4-linux-amd64 -# arm64 -wget https://github.com/FiloSottile/mkcert/releases/download/v1.4.4/mkcert-v1.4.4-linux-arm64 -# 2. 执行下面的命令生成秘钥 -mkcert -install -# mkcert 可直接接域名或 IP, 生成证书和秘钥 -mkcert example.com -# 3. 将证书和秘钥拷贝到 `/home/euler-copilot-framework_openeuler/deploy/chart_ssl/traefik-secret.yaml` 中, 并执行下面命令使其生效。 -kubectl apply -f traefik-secret.yaml -``` - -### 8. Pod状态由runnning变为pending？ - -在Pod正常运行一段时间后，其状态从“Running”全部转变为 “Pending” 或 “Completed”， -可执行命令`df -h`，查看Pod所在宿主机的存储空间，确保可用空间不低于30%，以保证pod的正常运行。 diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\225\214\351\235\242.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\225\214\351\235\242.png" deleted file mode 100644 index bb9be4e33ce470865fe5a07decbc056b9ee4e9bb..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\225\214\351\235\242.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\231\273\345\275\225\347\225\214\351\235\242.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\231\273\345\275\225\347\225\214\351\235\242.png" deleted file mode 100644 index fddbab4df70b940d5d5ed26fb8ec688f1592b5e8..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\231\273\345\275\225\347\225\214\351\235\242.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/authhub\347\231\273\345\275\225\347\225\214\351\235\242.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/authhub\347\231\273\345\275\225\347\225\214\351\235\242.png" deleted file mode 100644 index 341828b1b6f728888d1dd52eec755033680155da..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/authhub\347\231\273\345\275\225\347\225\214\351\235\242.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\346\210\220\345\212\237\347\225\214\351\235\242.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\346\210\220\345\212\237\347\225\214\351\235\242.png" deleted file mode 100644 index a871907f348317e43633cf05f5241cb978476fb4..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\346\210\220\345\212\237\347\225\214\351\235\242.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\347\225\214\351\235\242.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\347\225\214\351\235\242.png" deleted file mode 100644 index d82c736a94b106a30fd8d1f7b781f9e335bb441f..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\347\225\214\351\235\242.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/k8s\351\233\206\347\276\244\344\270\255postgres\346\234\215\345\212\241\347\232\204\345\220\215\347\247\260.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/k8s\351\233\206\347\276\244\344\270\255postgres\346\234\215\345\212\241\347\232\204\345\220\215\347\247\260.png" deleted file mode 100644 index 473a0006c9710c92375e226a760c3a79989312f9..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/k8s\351\233\206\347\276\244\344\270\255postgres\346\234\215\345\212\241\347\232\204\345\220\215\347\247\260.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/postgres\346\234\215\345\212\241\347\253\257\345\217\243.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/postgres\346\234\215\345\212\241\347\253\257\345\217\243.png" deleted file mode 100644 index cfee6d88da56bc939886caece540f7de8cf77bbc..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/postgres\346\234\215\345\212\241\347\253\257\345\217\243.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag_port.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag_port.png" deleted file mode 100644 index b1d93f9c9d7587aa88a27d7e0bf185586583d438..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag_port.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" deleted file mode 100644 index fec3cdaa2b260e50f5523477da3e58a9e14e2130..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\347\224\261\344\272\216\347\273\237\344\270\200\350\265\204\344\272\247\344\270\213\345\255\230\345\234\250\345\220\214\345\220\215\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\347\224\261\344\272\216\347\273\237\344\270\200\350\265\204\344\272\247\344\270\213\345\255\230\345\234\250\345\220\214\345\220\215\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index 624459821de4542b635eeffa115eeba780929a4e..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\347\224\261\344\272\216\347\273\237\344\270\200\350\265\204\344\272\247\344\270\213\345\255\230\345\234\250\345\220\214\345\220\215\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\346\210\220\345\212\237.png" deleted file mode 100644 index 3104717bfa8f6615ad6726577a24938bc29884b2..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\244\261\350\264\245.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\244\261\350\264\245.png" deleted file mode 100644 index 454b9fdfa4b7f209dc370f78677a2f4e71ea49be..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\244\261\350\264\245.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\257\255\346\226\231.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\257\255\346\226\231.png" deleted file mode 100644 index d52d25d4778f6db2d2ec076d65018c40cd1da4d3..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\257\255\346\226\231.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\357\274\214\350\265\204\344\272\247\344\270\213\344\270\215\345\255\230\345\234\250\345\257\271\345\272\224\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\357\274\214\350\265\204\344\272\247\344\270\213\344\270\215\345\255\230\345\234\250\345\257\271\345\272\224\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index 82ed79c0154bd8e406621440c4e4a7caaab7e06e..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\357\274\214\350\265\204\344\272\247\344\270\213\344\270\215\345\255\230\345\234\250\345\257\271\345\272\224\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\346\210\220\345\212\237.png" deleted file mode 100644 index 7dd2dea945f39ada1d7dd053d150a995b160f203..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\273\272\347\253\213\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\273\272\347\253\213\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index 84737b4185ce781d7b32ab42d39b8d2452138dad..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\273\272\347\253\213\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\214\207\345\256\232\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\214\207\345\256\232\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245.png" deleted file mode 100644 index be89bdfde2518bba3941eee5d475f52ad9124343..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\214\207\345\256\232\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\345\210\235\345\247\213\345\214\226.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\345\210\235\345\247\213\345\214\226.png" deleted file mode 100644 index 27530840aaa5382a226e1ed8baea883895d9d75e..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\345\210\235\345\247\213\345\214\226.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" deleted file mode 100644 index aa04e6f7f0648adfca1240c750ca5b79b88da5f9..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\227\240\350\265\204\344\272\247\346\227\266\346\237\245\350\257\242\350\265\204\344\272\247.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\227\240\350\265\204\344\272\247\346\227\266\346\237\245\350\257\242\350\265\204\344\272\247.png" deleted file mode 100644 index 74905172c0c0a0acc4c4d0e35efd2493dc421c4e..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\227\240\350\265\204\344\272\247\346\227\266\346\237\245\350\257\242\350\265\204\344\272\247.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\347\234\213\346\226\207\346\241\243\344\272\247\347\224\237\347\211\207\346\256\265\346\200\273\346\225\260\345\222\214\344\270\212\344\274\240\346\210\220\345\212\237\346\200\273\346\225\260.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\347\234\213\346\226\207\346\241\243\344\272\247\347\224\237\347\211\207\346\256\265\346\200\273\346\225\260\345\222\214\344\270\212\344\274\240\346\210\220\345\212\237\346\200\273\346\225\260.png" deleted file mode 100644 index 432fbfcd02f6d2220e7d2a8512aee893d67be24d..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\347\234\213\346\226\207\346\241\243\344\272\247\347\224\237\347\211\207\346\256\265\346\200\273\346\225\260\345\222\214\344\270\212\344\274\240\346\210\220\345\212\237\346\200\273\346\225\260.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\345\205\250\351\203\250\350\257\255\346\226\231.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\345\205\250\351\203\250\350\257\255\346\226\231.png" deleted file mode 100644 index a4f4ea8a3999a9ab659ccd9ea39b80b21ff46e84..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\345\205\250\351\203\250\350\257\255\346\226\231.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\350\265\204\344\272\247.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\350\265\204\344\272\247.png" deleted file mode 100644 index 675b40297363664007f96948fb21b1cb90d6beea..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\350\265\204\344\272\247.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\216\267\345\217\226\346\225\260\346\215\256\345\272\223pod\345\220\215\347\247\260.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\216\267\345\217\226\346\225\260\346\215\256\345\272\223pod\345\220\215\347\247\260.png" deleted file mode 100644 index 8fc0c988e8b3830c550c6be6e42b88ac13448d1a..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\216\267\345\217\226\346\225\260\346\215\256\345\272\223pod\345\220\215\347\247\260.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\344\270\212\344\274\240\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\344\270\212\344\274\240\346\210\220\345\212\237.png" deleted file mode 100644 index 5c897e9883e868bf5160d92cb106ea4e4e9bc356..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\344\270\212\344\274\240\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\346\234\252\346\237\245\350\257\242\345\210\260\347\233\270\345\205\263\350\257\255\346\226\231.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\346\234\252\346\237\245\350\257\242\345\210\260\347\233\270\345\205\263\350\257\255\346\226\231.png" deleted file mode 100644 index 407e49b929b7ff4cf14703046a4ba0bfe1bb441e..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\346\234\252\346\237\245\350\257\242\345\210\260\347\233\270\345\205\263\350\257\255\346\226\231.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\346\237\245\350\257\242\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\346\237\245\350\257\242\346\210\220\345\212\237.png" deleted file mode 100644 index a4f4ea8a3999a9ab659ccd9ea39b80b21ff46e84..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\346\237\245\350\257\242\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\234\252\346\237\245\350\257\242\345\210\260\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\234\252\346\237\245\350\257\242\345\210\260\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index 45ab521ec5f5afbd81ad54f023aae3b7a867dbf2..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\234\252\346\237\245\350\257\242\345\210\260\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\237\245\350\257\242\350\265\204\344\272\247\345\272\223\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\237\245\350\257\242\350\265\204\344\272\247\345\272\223\346\210\220\345\212\237.png" deleted file mode 100644 index 90ed5624ae93ff9784a750514c53293df4e961f0..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\237\245\350\257\242\350\265\204\344\272\247\345\272\223\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\233\345\273\272\346\210\220\345\212\237.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\233\345\273\272\346\210\220\345\212\237.png" deleted file mode 100644 index 7b2cc38a931c9c236517c14c86fa93e3eb2b6dcd..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\233\345\273\272\346\210\220\345\212\237.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" deleted file mode 100644 index 1365a8d69467dec250d3451ac63e2615a2194c18..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\346\210\220\345\212\237png.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\346\210\220\345\212\237png.png" deleted file mode 100644 index 1bd944264baa9369e6f8fbfd04cabcd12730c0e9..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\346\210\220\345\212\237png.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\346\237\245\350\257\242\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\346\237\245\350\257\242\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" deleted file mode 100644 index 58bcd320e145dd29d9e5d49cb6d86964ebb83b51..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\346\237\245\350\257\242\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\344\270\255\351\227\264\345\261\202.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\344\270\255\351\227\264\345\261\202.png" deleted file mode 100644 index 809b785b999b6663d9e9bd41fed953925093d6bd..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\344\270\255\351\227\264\345\261\202.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\346\272\220\347\233\256\345\275\225.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\346\272\220\347\233\256\345\275\225.png" deleted file mode 100644 index 62ba5f6615f18deb3d5a71fd68ee8c929638d814..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\346\272\220\347\233\256\345\275\225.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\347\233\256\346\240\207\347\233\256\345\275\225.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\347\233\256\346\240\207\347\233\256\345\275\225.png" deleted file mode 100644 index d32c672fafcb0ef665bda0bcfdce19d2df44db01..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\347\233\256\346\240\207\347\233\256\345\275\225.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\207\215\345\244\215\345\210\233\345\273\272\350\265\204\344\272\247\345\244\261\350\264\245.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\207\215\345\244\215\345\210\233\345\273\272\350\265\204\344\272\247\345\244\261\350\264\245.png" deleted file mode 100644 index a5ecd6b65abc97320e7467f00d82ff1fd9bf0e44..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\207\215\345\244\215\345\210\233\345\273\272\350\265\204\344\272\247\345\244\261\350\264\245.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\351\203\250\347\275\262\350\247\206\345\233\276.png" "b/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\351\203\250\347\275\262\350\247\206\345\233\276.png" deleted file mode 100644 index 181bf1d2ddbe15cfd296c27df27d865bdbce8d69..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/deployment_guide/pictures/\351\203\250\347\275\262\350\247\206\345\233\276.png" and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/_toc.yaml b/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/_toc.yaml deleted file mode 100644 index c26d7482b45cd01f097adc8317d3c69d1b14bc20..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/_toc.yaml +++ /dev/null @@ -1,7 +0,0 @@ -label: 部署指南 -isManual: true -description: -sections: - - label: AI容器栈部署指南 - href: ./ai_container_stack_deployment_guide.md - diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md b/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md deleted file mode 100644 index a1464bd68004ca16005ce813ddb72319276bb7b1..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md +++ /dev/null @@ -1,35 +0,0 @@ -# AI容器栈部署指南 - -## 准备工作 - -+ 提前安装 [openEuler Copilot System 命令行（智能 Shell）客户端](../../../usage_guide/cli_client/cli_assistant_user_guide.md) - -+ 修改 /xxxx/xxxx/values.yaml 文件的 `euler-copilot-tune` 部分，将 `enable` 字段改为 `True` - -```yaml -enable: True -``` - -+ 更新环境 - -```bash -helm upgrade euler-copilot . -``` - -+ 检查 Compatibility-AI-Infra 目录下的 openapi.yaml 中 `servers.url` 字段，确保AI容器服务的启动地址被正确设置 - -+ 获取 `$plugin_dir` 插件文件夹的路径，该变量位于 deploy/chart/euler_copilot/values.yaml 中的 `framework` 模块 - -+ 如果插件目录不存在，需新建该目录 - -+ 将该目录下的 Compatibility-AI-Infra 文件夹放到 `$plugin_dir` 中 - -```bash -cp -r ./Compatibility-AI-Infra $PLUGIN_DIR -``` - -+ 重建 framework pod，重载插件配置 - -```bash -kubectl delete pod framework-xxxx -n 命名空间 -``` diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/_toc.yaml b/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/_toc.yaml deleted file mode 100644 index 7348a8a25bcc005306c2855e9e590765ff76288f..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/_toc.yaml +++ /dev/null @@ -1,7 +0,0 @@ -label: 部署指南 -isManual: true -description: -sections: - - label: 智能诊断部署指南 - href: ./intelligent_diagnosis_deployment_guide.md - diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md b/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md deleted file mode 100644 index 00bf65c304861762f090a2253e793684ebd209e7..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md +++ /dev/null @@ -1,189 +0,0 @@ -# 智能诊断部署指南 - -## 准备工作 - -+ 提前安装 [openEuler Copilot System 命令行（智能 Shell）客户端](../../../usage_guide/cli_client/cli_assistant_user_guide.md) - -+ 被诊断机器不能安装 crictl 和 isula，只能有 docker 一个容器管理工具 - -+ 在需要被诊断的机器上安装 gala-gopher 和 gala-anteater - -## 部署 gala-gopher - -### 1. 准备 BTF 文件 - -**如果Linux内核支持 BTF，则不需要准备 BTF 文件。**可以通过以下命令来查看Linux内核是否已经支持 BTF： - -```bash -cat /boot/config-$(uname -r) | grep CONFIG_DEBUG_INFO_BTF -``` - -如果输出结果为`CONFIG_DEBUG_INFO_BTF=y`，则表示内核支持BTF。否则表示内核不支持BTF。 -如果内核不支持BTF，需要手动制作BTF文件。步骤如下： - -1. 获取当前Linux内核版本的 vmlinux 文件 - - vmlinux 文件存放在 `kernel-debuginfo` 包里面，存放路径为 `/usr/lib/debug/lib/modules/$(uname -r)/vmlinux`。 - - 例如，对于 `kernel-debuginfo-5.10.0-136.65.0.145.oe2203sp1.aarch64`，对应的vmlinux路径为`/usr/lib/debug/lib/modules/5.10.0-136.65.0.145.oe2203sp1.aarch64/vmlinux`。 - -2. 制作 BTF 文件 - - 基于获取到 vmlinux 文件来制作 BTF 文件。这一步可以在自己的环境里操作。首先，需要安装相关的依赖包： - - ```bash - # 说明：dwarves 包中包含 pahole 命令，llvm 包中包含 llvm-objcopy 命令 - yum install -y llvm dwarves - ``` - - 执行下面的命令行，生成 BTF 文件。 - - ```bash - kernel_version=4.19.90-2112.8.0.0131.oe1.aarch64 # 说明：这里需要替换成目标内核版本，可通过 uname -r 命令获取 - pahole -J vmlinux - llvm-objcopy --only-section=.BTF --set-section-flags .BTF=alloc,readonly --strip-all vmlinux ${kernel_version}.btf - strip -x ${kernel_version}.btf - ``` - - 生成的 BTF 文件名称为`.btf`格式，其中 ``为目标机器的内核版本，可通过 `uname -r` 命令获取。 - -### 2. 下载 gala-gopher 容器镜像 - -#### 在线下载 - -gala-gopher 容器镜像已归档到 仓库中，可通过如下命令获取。 - -```bash -# 获取 aarch64 架构的镜像 -docker pull hub.oepkgs.net/a-ops/gala-gopher-profiling-aarch64:latest -# 获取 x86_64 架构的镜像 -docker pull hub.oepkgs.net/a-ops/gala-gopher-profiling-x86_64:latest -``` - -#### 离线下载 - -若无法通过在线下载的方式下载容器镜像，可联系我（何秀军 00465007）获取压缩包。 - -拿到压缩包后，放到目标机器上，解压并加载容器镜像，命令行如下： - -```bash -tar -zxvf gala-gopher-profiling-aarch64.tar.gz -docker load < gala-gopher-profiling-aarch64.tar -``` - -### 3. 启动 gala-gopher 容器 - -容器启动命令： - -```shell -docker run -d --name gala-gopher-profiling --privileged --pid=host --network=host -v /:/host -v /etc/localtime:/etc/localtime:ro -v /sys:/sys -v /usr/lib/debug:/usr/lib/debug -v /var/lib/docker:/var/lib/docker -v /tmp/$(uname -r).btf:/opt/gala-gopher/btf/$(uname -r).btf -e GOPHER_HOST_PATH=/host gala-gopher-profiling-aarch64:latest -``` - -启动配置参数说明： - -+ `-v /tmp/$(uname -r).btf:/opt/gala-gopher/btf/$(uname -r).btf` ：如果内核支持 BTF，则删除该配置即可。如果内核不支持 BTF，则需要将前面准备好的 BTF 文件拷贝到目标机器上，并将 `/tmp/$(uname -r).btf` 替换为对应的路径。 -+ `gala-gopher-profiling-aarch64-0426` ：gala-gopher容器对应的tag，替换成实际下载的tag。 - -探针启动： - -+ `container_id` 为需要观测的容器 id -+ 分别启动 sli 和 container 探针 - -```bash -curl -X PUT http://localhost:9999/sli -d json='{"cmd":{"check_cmd":""},"snoopers":{"container_id":[""]},"params":{"report_period":5},"state":"running"}' -``` - -```bash -curl -X PUT http://localhost:9999/container -d json='{"cmd":{"check_cmd":""},"snoopers":{"container_id":[""]},"params":{"report_period":5},"state":"running"}' -``` - -探针关闭 - -```bash -curl -X PUT http://localhost:9999/sli -d json='{"state": "stopped"}' -``` - -```bash -curl -X PUT http://localhost:9999/container -d json='{"state": "stopped"}' -``` - -## 部署 gala-anteater - -源码部署： - -```bash -# 请指定分支为 930eulercopilot -git clone https://gitee.com/GS-Stephen_Curry/gala-anteater.git -``` - -安装部署请参考 -(请留意python版本导致执行setup.sh install报错) - -镜像部署： - -```bash -docker pull hub.oepkgs.net/a-ops/gala-anteater:2.0.2 -``` - -`/etc/gala-anteater/config/gala-anteater.yaml` 中 Kafka 和 Prometheus 的 `server` 和 `port` 需要按照实际部署修改，`model_topic`、`meta_topic`、`group_id` 自定义 - -```yaml -Kafka: - server: "xxxx" - port: "xxxx" - model_topic: "xxxx" # 自定义，与rca配置中保持一致 - meta_topic: "xxxx" # 自定义，与rca配置中保持一致 - group_id: "xxxx" # 自定义，与rca配置中保持一致 - # auth_type: plaintext/sasl_plaintext, please set "" for no auth - auth_type: "" - username: "" - password: "" - -Prometheus: - server: "xxxx" - port: "xxxx" - steps: "5" -``` - -gala-anteater 中模型的训练依赖于 gala-gopher 采集的数据，因此请保证 gala-gopher 探针正常运行至少24小时，在运行 gala-anteater。 - -## 部署 gala-ops - -每个中间件的大致介绍： - -kafka ： 一个数据库中间件， 分布式数据分流作用， 可以配置为当前的管理节点。 - -prometheus：性能监控， 配置需要监控的生产节点 ip list。 - -直接通过yum install安装kafka和prometheus，可参照安装脚本 - -只需要参照其中 kafka 和 prometheus 的安装即可 - -## 部署 euler-copilot-rca - -镜像拉取 - -```bash -docker pull hub.oepkgs.net/a-ops/euler-copilot-rca:0.9.1 -``` - -+ 修改 `config/config.json` 文件，配置 gala-gopher 镜像的 `container_id` 以及 `ip`，Kafka 和 Prometheus 的 `ip` 和 `port`（与上述 gala-anteater 配置保持一致） - -```yaml -"gopher_container_id": "xxxx", # gala-gopher的容器id - "remote_host": "xxxx" # gala-gopher的部署机器ip - }, - "kafka": { - "server": "xxxx", - "port": "xxxx", - "storage_topic": "usad_intermediate_results", - "anteater_result_topic": "xxxx", - "rca_result_topic": "xxxx", - "meta_topic": "xxxx" - }, - "prometheus": { - "server": "xxxx", - "port": "xxxx", - "steps": 5 - }, -``` diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/_toc.yaml b/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/_toc.yaml deleted file mode 100644 index 8b65a0aa77dcbdf0a062c6ebb64b86b822c7c58f..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/_toc.yaml +++ /dev/null @@ -1,7 +0,0 @@ -label: 部署指南 -isManual: true -description: -sections: - - label: 智能调优部署指南 - href: ./intelligent_tune_deployment_guide.md - diff --git a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md b/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md deleted file mode 100644 index 062d05da319bc60d756de7de4893341fa87935a2..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md +++ /dev/null @@ -1,131 +0,0 @@ -# 智能调优部署指南 - -## 准备工作 - -+ 提前安装 [openEuler Copilot System 命令行（智能 Shell）客户端](../../../usage_guide/cli_client/cli_assistant_user_guide.md) - -+ 被调优机器需要为 openEuler 22.03 LTS-SP3 - -+ 在需要被调优的机器上安装依赖 - -```bash -yum install -y sysstat perf -``` - -+ 被调优机器需要开启 SSH 22端口 - -## 编辑配置文件 - -修改values.yaml文件的tune部分，将 `enable` 字段改为 `True` ，并配置大模型设置、 -Embedding模型文件地址、以及需要调优的机器和对应机器上的 mysql 的账号名以及密码 - -```bash -vim /home/euler-copilot-framework/deploy/chart/agents/values.yaml -``` - -```yaml -tune: - # 【必填】是否启用智能调优Agent - enabled: true - # 镜像设置 - image: - # 镜像仓库。留空则使用全局设置。 - registry: "" - # 【必填】镜像名称 - name: euler-copilot-tune - # 【必填】镜像标签 - tag: "0.9.1" - # 拉取策略。留空则使用全局设置。 - imagePullPolicy: "" - # 【必填】容器根目录只读 - readOnly: false - # 性能限制设置 - resources: {} - # Service设置 - service: - # 【必填】Service类型，ClusterIP或NodePort - type: ClusterIP - nodePort: - # 大模型设置 - llm: - # 【必填】模型地址（需要包含v1后缀） - url: - # 【必填】模型名称 - name: "" - # 【必填】模型API Key - key: "" - # 【必填】模型最大Token数 - max_tokens: 8096 - # 【必填】Embedding模型文件地址 - embedding: "" - # 待优化机器信息 - machine: - # 【必填】IP地址 - ip: "" - # 【必填】Root用户密码 - # 注意：必需启用Root用户以密码形式SSH登录 - password: "" - # 待优化应用设置 - mysql: - # 【必填】数据库用户名 - user: "root" - # 【必填】数据库密码 - password: "" -``` - -## 安装智能调优插件 - -```bash -helm install -n euler-copilot agents . -``` - -如果之前有执行过安装，则按下面指令更新插件服务 - -```bash -helm upgrade-n euler-copilot agents . -``` - -如果 framework未重启，则需要重启framework配置 - -```bash -kubectl delete pod framework-deploy-service-bb5b58678-jxzqr -n eulercopilot -``` - -## 测试 - -+ 查看 tune 的 pod 状态 - - ```bash - NAME READY STATUS RESTARTS AGE - authhub-backend-deploy-authhub-64896f5cdc-m497f 2/2 Running 0 16d - authhub-web-deploy-authhub-7c48695966-h8d2p 1/1 Running 0 17d - pgsql-deploy-databases-86b4dc4899-ppltc 1/1 Running 0 17d - redis-deploy-databases-f8866b56-kj9jz 1/1 Running 0 17d - mysql-deploy-databases-57f5f94ccf-sbhzp 2/2 Running 0 17d - framework-deploy-service-bb5b58678-jxzqr 2/2 Running 0 16d - rag-deploy-service-5b7887644c-sm58z 2/2 Running 0 110m - vectorize-deploy-service-57f5f94ccf-sbhzp 2/2 Running 0 17d - web-deploy-service-74fbf7999f-r46rg 1/1 Running 0 2d - tune-deploy-agents-5d46bfdbd4-xph7b 1/1 Running 0 2d - ``` - -+ pod启动失败排查办法 - + 检查 euler-copilot-tune 目录下的 openapi.yaml 中 `servers.url` 字段，确保调优服务的启动地址被正确设置 - + 检查 `$plugin_dir` 插件文件夹的路径是否配置正确，该变量位于 `deploy/chart/euler_copilot/values.yaml` 中的 `framework`模块，如果插件目录不存在，需新建该目录，并需要将该目录下的 euler-copilot-tune 文件夹放到 `$plugin_dir` 中。 - + 检查sglang的地址和key填写是否正确，该变量位于 `vim /home/euler-copilot-framework/deploy/chart/euler_copilot/values.yaml` - - ```yaml - # 用于Function Call的模型 - scheduler: - # 推理框架类型 - backend: sglang - # 模型地址 - url: "" - # 模型 API Key - key: "" - # 数据库设置 - ``` - -+ 命令行客户端使用智能调优 - - 具体使用可参考 [openEuler Copilot System 命令行（智能插件：智能调优）](../../../usage_guide/cli_client/tune.md) diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/_toc.yaml b/docs/zh/tools/ai/euler_copilot/usage_guide/_toc.yaml deleted file mode 100644 index 9f63b6bc6a4ddbf9c9d96ae7a6d9585a122770c9..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/_toc.yaml +++ /dev/null @@ -1,16 +0,0 @@ -label: 使用指南 -isManual: true -description: -sections: - - label: 管理员：知识库管理 - href: ./usage_guide/knowledge_base_managenment//witchaind_guidance.md - - label: Web 端使用手册 - href: ./usage_guide/online_services/preface.md - href: ./usage_guide/online_services/registration_and_login.md - href: ./usage_guide/online_services/itelligent_plugin.md - href: ./usage_guide/online_services/qa_guide.md - - label: 智能 Shell 使用手册 - href: ./usage_guide/cli_client/cli_assiatant_user_guide.md - href: ./usage_guide/cli_client/obtaining_api_key.md - href: ./usage_guide/cli_client/tune.md - href: ./usage_guide/cli_client/diagnosis.md diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/_toc.yaml b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/_toc.yaml deleted file mode 100644 index b6acca203118cf4d38e45546b9e90b988bfd4437..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/_toc.yaml +++ /dev/null @@ -1,12 +0,0 @@ -label: 使用指南-命令行客户端 -isManual: true -description: -sections: - - label: 获取API KEY - href: ./obtaining_api_key.md - - label: 命令行助手指南 - href: ./cli_assistant_user_guide.md - - label: 智能诊断 - href: ./diagnosis.md - - label: 智能插件介绍 - href: ./tune.md diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/cli_assistant_user_guide.md b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/cli_assistant_user_guide.md deleted file mode 100644 index d965d51e293c8304710c0469f1da4b605db7b32e..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/cli_assistant_user_guide.md +++ /dev/null @@ -1,169 +0,0 @@ -# 命令行助手使用指南 - -## 简介 - -openEuler Copilot System 命令行助手是一个命令行（Shell）AI 助手，您可以通过它来快速生成 Shell 命令并执行，从而提高您的工作效率。除此之外，基于 Gitee AI 在线服务的标准版本还内置了 openEuler 的相关知识，可以助力您学习与使用 openEuler 操作系统。 - -## 环境要求 - -- 操作系统：openEuler 22.03 LTS SP3，或者 openEuler 24.03 LTS 及以上版本 -- 命令行软件： - - Linux 桌面环境：支持 GNOME、KDE、DDE 等桌面环境的内置终端 - - 远程 SSH 链接：支持兼容 xterm-256 与 UTF-8 字符集的终端 - -## 安装 - -openEuler Copilot System 命令行助手支持通过 OEPKGS 仓库进行安装。 - -### 配置 OEPKGS 仓库 - -```bash -sudo dnf config-manager --add-repo https://repo.oepkgs.net/openeuler/rpm/`sed 's/release //;s/[()]//g;s/ /-/g' /etc/openEuler-release`/extras/`uname -m` -``` - -```bash -sudo dnf clean all -``` - -```bash -sudo dnf makecache -``` - -### 安装命令行助手 - -```bash -sudo dnf install eulercopilot-cli -``` - -若遇到 `Error: GPG check FAILED` 错误，使用 `--nogpgcheck` 跳过检查。 - -```bash -sudo dnf install --nogpgcheck eulercopilot-cli -``` - -## 初始化 - -```bash -copilot --init -``` - -然后根据提示输入 API Key 完成配置。 - -![shell-init](./pictures/shell-init.png) - -初次使用前请先退出终端或重新连接 SSH 会话使配置生效。 - -- **查看助手帮助页面** - - ```bash - copilot --help - ``` - - ![shell-help](./pictures/shell-help.png) - -## 使用 - -在终端中输入问题，按下 `Ctrl + O` 提问。 - -### 快捷键 - -- 输入自然语言问题后，按下 `Ctrl + O` 可以直接向 AI 提问。 -- 直接按下 `Ctrl + O` 可以自动填充命令前缀 `copilot`，输入参数后按下 `Enter` 即可执行。 - -### 智能问答 - -命令行助手初始化完成后，默认处于智能问答模式。 -命令提示符**左上角**会显示当前模式。 -若当前模式不是“智能问答”，执行 `copilot -c` (`copilot --chat`) 切换到智能问答模式。 - -![chat-ask](./pictures/shell-chat-ask.png) - -AI 回答完毕后，会根据历史问答生成推荐问题，您可以复制、粘贴到命令行中进行追问。输入追问的问题后，按下 `Enter` 提问。 - -![chat-next](./pictures/shell-chat-continue.png) - -![chat-next-result](./pictures/shell-chat-continue-result.png) - -智能问答模式下支持连续追问，每次追问最多可以关联3条历史问答的上下文。 - -输入 `exit` 可以退出智能问答模式，回到 Linux 命令行。 - -![chat-exit](./pictures/shell-chat-exit.png) - -- 若问答过程中遇到程序错误，可以按下 `Ctrl + C` 立即退出当前问答，再尝试重新提问。 - -### Shell 命令 - -AI 会根据您的问题返回 Shell 命令，openEuler Copilot System 命令行助手可以解释、编辑或执行这些命令，并显示命令执行结果。 - -![shell-cmd](./pictures/shell-cmd.png) - -命令行助手会自动提取 AI 回答中的命令，并显示相关操作。您可以通过键盘上下键选择操作，按下 `Enter` 确认。 - -![shell-cmd-interact](./pictures/shell-cmd-interact.png) - -#### 解释 - -如果 AI 仅返回了一条命令，选择解释后会直接请求 AI 解释命令，并显示回答。 -若 AI 回答了多条命令，选择后会显示命令列表，您每次可以选择**一条**请求 AI 解释。 - -![shell-cmd-explain-select](./pictures/shell-cmd-explain-select.png) - -完成解释后，您可以继续选择其他操作。 - -![shell-cmd-explain-result](./pictures/shell-cmd-explain-result.png) - -#### 编辑 - -![shell-cmd-edit](./pictures/shell-cmd-edit.png) - -选择一条命令进行编辑，编辑完成后按下 `Enter` 确认。 - -![shell-cmd-edit-result](./pictures/shell-cmd-edit-result.png) - -完成编辑后，您可以继续编辑其他命令或选择其他操作。 - -#### 执行 - -如果 AI 仅返回了一条命令，选择执行后会直接执行命令，并显示执行结果。 -若 AI 回答了多条命令，选择后会显示命令列表，您每次可以选择**多条**命令来执行。 - -您可以通过键盘上下键移动光标，按下 `空格键` 选择命令，按下 `Enter` 执行所选命令。 -被选中的命令会显示**蓝色高亮**，如图所示。 - -![shell-cmd-exec-multi-select](./pictures/shell-cmd-exec-multi-select.png) - -若不选择任何命令，直接按下 `Enter`，则会跳过执行命令，直接进入下一轮问答。 - -按下 `Enter` 后，被选中的命令会从上到下依次执行。 - -![shell-cmd-exec-result](./pictures/shell-cmd-exec-result.png) - -若执行过程中遇到错误，命令行助手会显示错误信息，并**终止执行命令**，进入下一轮问答。 -您可以在下一轮问答中提示 AI 更正命令，或要求 AI 重新生成命令。 - -### 智能插件 - -在 Linux 命令行中执行 `copilot -p` (`copilot --plugin`) 切换到智能插件模式。 - -![shell-plugin](./pictures/shell-plugin.png) - -输入问题并按下 `Ctrl + O` 提问后，从列表中选择插件，按下 `Enter` 调用插件回答问题。 - -![shell-plugin-select](./pictures/shell-plugin-select.png) - -![shell-plugin-result](./pictures/shell-plugin-result.png) - -## 卸载 - -```bash -sudo dnf remove eulercopilot-cli -``` - -然后使用以下命令删除配置文件。 - -```bash -rm ~/.config/eulercopilot/config.json -``` - -卸载完成后请重启终端或重新连接 SSH 会话使配置还原。 diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/diagnosis.md b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/diagnosis.md deleted file mode 100644 index eb999cb5483620450b2e2aea77a818382aeca2a4..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/diagnosis.md +++ /dev/null @@ -1,50 +0,0 @@ -# 智能插件：智能诊断 - -部署智能诊断工具后，可以通过 openEuler Copilot System 智能体框架实现对本机进行诊断。 -在智能诊断模式提问，智能体框架服务可以调用本机的诊断工具诊断异常状况、分析并生成报告。 - -## 操作步骤 - -**步骤1** 切换到“智能插件”模式 - -```bash -copilot -p -``` - -![切换到智能插件模式](./pictures/shell-plugin-diagnose-switch-mode.png) - -**步骤2** 异常事件检测 - -```bash -帮我进行异常事件检测 -``` - -按下 `Ctrl + O` 键提问，然后在插件列表中选择“智能诊断”。 - -![异常事件检测](./pictures/shell-plugin-diagnose-detect.png) - -**步骤3** 查看异常事件详情 - -```bash -查看 XXX 容器的异常事件详情 -``` - -![查看异常事件详情](./pictures/shell-plugin-diagnose-detail.png) - -**步骤4** 执行异常事件分析 - -```bash -请对 XXX 容器的 XXX 指标执行 profiling 分析 -``` - -![异常事件分析](./pictures/shell-plugin-diagnose-profiling.png) - -**步骤5** 查看异常事件分析报告 - -等待 5 至 10 分钟，然后查看分析报告。 - -```bash -查看 对应的 profiling 报告 -``` - -![执行优化脚本](./pictures/shell-plugin-diagnose-report.png) diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/obtaining_api_key.md b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/obtaining_api_key.md deleted file mode 100644 index 9d69b3c6ea26eb6af3c7ccd17b572699a8f6bd86..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/obtaining_api_key.md +++ /dev/null @@ -1,28 +0,0 @@ -# 获取 API Key - -## 前言 - -openEuler Copilot System 命令行助手使用 API Key 来验证用户身份，并获取 API 访问权限。 -因此，开始使用前，您需要先获取 API Key。 - -## 注意事项 - -- 请妥善保管您的 API Key，不要泄露给他人。 -- API Key 仅用于命令行助手与 DevStation 桌面端，不用于其他用途。 -- 每位用户仅可拥有一个 API Key，重复创建 API Key 将导致旧密钥失效。 -- API Key 仅在创建时显示一次，请务必及时保存。若密钥丢失，您需要重新创建。 -- 若您在使用过程中遇到“请求过于频繁”的错误，您的 API Key 可能已被他人使用，请及时前往官网刷新或撤销 API Key。 - -## 获取方法 - -1. 登录 openEuler Copilot System 网页端。 -2. 点击右上角头像，选择“API KEY”。 -3. 点击“新建”按钮。 -4. **请立即保存 API Key，它仅在创建时显示一次，请勿泄露给他人。** - -## 管理 API Key - -1. 登录 openEuler Copilot System 网页端。 -2. 点击右上角头像，选择“API KEY”。 -3. 点击“刷新”按钮，刷新 API Key；点击“撤销”按钮，撤销 API Key。 - - 刷新 API Key 后，旧密钥失效，请立即保存新生成的 API Key。 diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-ask.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-ask.png deleted file mode 100644 index 00d5cf5ecf894dd62366ec086bf96eae532f0b5d..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-ask.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue-result.png deleted file mode 100644 index f30f9fe7a015e775742bc184b8ac75790dc482fa..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue.png deleted file mode 100644 index 7e4801504fd53fab989574416e6220c4fa3f1d38..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-exit.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-exit.png deleted file mode 100644 index 0bb81190a3039f6c5a311b365376ec230c1ad4b5..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-exit.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit-result.png deleted file mode 100644 index c5e6f8245e7d66cdbe5370f18d15a791a33a517a..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit.png deleted file mode 100644 index bb6209373a6d2a1881728bee352e7c3b46cc91d7..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-multi-select.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-multi-select.png deleted file mode 100644 index 2dda108a39af54fc15a4ff8c0dca107de38b9cf0..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-multi-select.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-result.png deleted file mode 100644 index f4fff6a62b8b4220b52fdf55b133f2ba37850569..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-result.png deleted file mode 100644 index 707dd36aa7c7eadae4f29254cf5fc18ce877f597..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-select.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-select.png deleted file mode 100644 index bf58b69e241ea11a6945f21e3fc69d22a401be2e..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-select.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-interact.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-interact.png deleted file mode 100644 index 00bb3a288fbd2fb962b08f34fbe90c733afe0343..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-interact.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd.png deleted file mode 100644 index 619172c8ed60a7b536364944a306fbf76fcbfb1f..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-help.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-help.png deleted file mode 100644 index 97d0dedd3f7b1c749bc5fded471744923d766b8b..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-help.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-init.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-init.png deleted file mode 100644 index bbb2257eb1ff2bfec36110409fc6c55a26386c9e..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-init.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detail.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detail.png deleted file mode 100644 index 7bd624e025eaae4b77c603d88bf1b9ad5e235fe7..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detail.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detect.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detect.png deleted file mode 100644 index 2b38259ff0c1c7045dbff9abf64f36a109a3377b..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detect.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-profiling.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-profiling.png deleted file mode 100644 index 0e63c01f35dbc291f805b56de749eac09e0a079d..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-profiling.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-report.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-report.png deleted file mode 100644 index c16f0184a2ad3d2468466b33d0e861d2a31bc4e2..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-report.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-switch-mode.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-switch-mode.png deleted file mode 100644 index 165c6c453353b70c3e1e2cb07d7f43d5ee3525e3..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-switch-mode.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-result.png deleted file mode 100644 index 3e3f45a974a0700d209f7d30af89eb2050a392d6..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-select.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-select.png deleted file mode 100644 index 13959203c77eaa9f41051897cf9e847ff3642a8a..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-select.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-metrics-collect.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-metrics-collect.png deleted file mode 100644 index 4d5678b7f77b05d48552fcb9656f4a4372dbbe61..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-metrics-collect.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-report.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-report.png deleted file mode 100644 index 01daaa9a84c13158a95afddffeb8a7e3303f1e76..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-report.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-exec.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-exec.png deleted file mode 100644 index 0b694c3fba6918ef39cca977b2072b2913d12b95..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-exec.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-gen.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-gen.png deleted file mode 100644 index 6e95551767e213f59669d03fd4cceba05801a983..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-gen.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-view.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-view.png deleted file mode 100644 index c82c77bf6f4e4e19f400395aaadc9f99dc8d373c..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-view.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-switch-mode.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-switch-mode.png deleted file mode 100644 index 0f06c803ea3621a0f4fb83bbbe731e2bb4bba788..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-switch-mode.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin.png b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin.png deleted file mode 100644 index 4c1afd306a6aee029f5bda38aa7b1fce57227e31..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/tune.md b/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/tune.md deleted file mode 100644 index b5c40581668ae4f6074043e62a93b2c4b240e5b3..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/cli_client/tune.md +++ /dev/null @@ -1,53 +0,0 @@ -# 智能插件：智能调优 - -部署智能调优工具后，可以通过 openEuler Copilot System 智能体框架实现对本机进行调优。 -在智能调优模式提问，智能体框架服务可以调用本机的调优工具采集性能指标，并生成性能分析报告和性能优化建议。 - -## 操作步骤 - -**步骤1** 切换到“智能调优”模式 - -```bash -copilot -t -``` - -![切换到智能调优模式](./pictures/shell-plugin-tuning-switch-mode.png) - -**步骤2** 采集性能指标 - -```bash -帮我进行性能指标采集 -``` - -![性能指标采集](./pictures/shell-plugin-tuning-metrics-collect.png) - -**步骤3** 生成性能分析报告 - -```bash -帮我生成性能分析报告 -``` - -![性能分析报告](./pictures/shell-plugin-tuning-report.png) - -**步骤4** 生成性能优化建议 - -```bash -请生成性能优化脚本 -``` - -![性能优化脚本](./pictures/shell-plugin-tuning-script-gen.png) - -**步骤5** 选择“执行命令”，运行优化脚本 - -![执行优化脚本](./pictures/shell-plugin-tuning-script-exec.png) - -- 脚本内容如图： - ![优化脚本内容](./pictures/shell-plugin-tuning-script-view.png) - -## 远程调优 - -如果需要对其他机器进行远程调优，请在上文示例的问题前面加上对应机器的 IP 地址。 - -例如：`请对 192.168.1.100 这台机器进行性能指标采集。` - -进行远程调优前请确保目标机器已部署智能调优工具，同时请确保 openEuler Copilot System 智能体框架能够访问目标机器。 diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/_toc.yaml b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/_toc.yaml deleted file mode 100644 index 4e984daadd81642f9f57e22b9ef930c8d07fff53..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/_toc.yaml +++ /dev/null @@ -1,6 +0,0 @@ -label: witChainD 使用指南——知识库管理 -isManual: true -description: -sections: - - label: witChainD 使用指南——知识库管理 - href: ./witchaind_guidance.md diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\205\245\346\226\207\346\241\243.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\205\245\346\226\207\346\241\243.png" deleted file mode 100644 index 3d6818a10a728cd8bf7bd15b6f4f1a8e7817e9c4..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\205\245\346\226\207\346\241\243.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\207\272\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\207\272\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index 73f3d3b92800e51bf00c9b71c82d76cabd5352de..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\207\272\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\220\257\347\224\250.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\220\257\347\224\250.png" deleted file mode 100644 index 3cf960c771ae2ce533f311a55584734c7853f07c..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\220\257\347\224\250.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\257\274\345\205\245\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\257\274\345\205\245\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index e08bc79f363a862e2a0f3780487c5614c6415b64..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\257\274\345\205\245\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\220\234\347\264\242\346\226\207\346\241\243.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\220\234\347\264\242\346\226\207\346\241\243.png" deleted file mode 100644 index 7f71660723fcc451152b73e12a0c630604efa390..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\220\234\347\264\242\346\226\207\346\241\243.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\234\254\345\235\227\347\273\223\346\236\234\351\242\204\350\247\210.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\234\254\345\235\227\347\273\223\346\236\234\351\242\204\350\247\210.png" deleted file mode 100644 index 05e003a48f4fb0a452448b0dc8bf74b598e6936e..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\234\254\345\235\227\347\273\223\346\236\234\351\242\204\350\247\210.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\347\256\241\347\220\206\347\225\214\351\235\242.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\347\256\241\347\220\206\347\225\214\351\235\242.png" deleted file mode 100644 index c17ea11b55489c10fa52eae2e9d8915313e3d39e..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\347\256\241\347\220\206\347\225\214\351\235\242.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\220.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\220.png" deleted file mode 100644 index 2524ce76edb826092b5dc9611d64537bed08b3ec..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\220.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\2202.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\2202.png" deleted file mode 100644 index 30dd2f5bef9b23c3dceb92b63817898076096a49..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\2202.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\260\345\242\236\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\260\345\242\236\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index d728d99741a03ff2f82e2c59bd424b848614aebe..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\260\345\242\236\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\250\241\345\236\213\351\205\215\347\275\256.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\250\241\345\236\213\351\205\215\347\275\256.png" deleted file mode 100644 index 97a489cc7637416306a88394a3faa7fa47cf9b95..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\250\241\345\236\213\351\205\215\347\275\256.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\346\226\207\346\241\243\351\205\215\347\275\256.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\346\226\207\346\241\243\351\205\215\347\275\256.png" deleted file mode 100644 index bd0ed29ba5d6a4eb4dca5851b8469bd161f70300..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\346\226\207\346\241\243\351\205\215\347\275\256.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223.png" deleted file mode 100644 index 3488720160efd58d2fd1f46046f04296f552b4d6..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\2230.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\2230.png" deleted file mode 100644 index 64d0cc3f8637592007503972267751f2bbe87b96..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\2230.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223\351\205\215\347\275\256.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223\351\205\215\347\275\256.png" deleted file mode 100644 index e91dd94c7dc0a71e3f3ddee47c3d21926c27e619..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223\351\205\215\347\275\256.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\247\243\346\236\220\345\256\214\346\210\220.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\247\243\346\236\220\345\256\214\346\210\220.png" deleted file mode 100644 index 9e9968fc2e71ace3a58ec454e19b25bcd961f0c0..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\247\243\346\236\220\345\256\214\346\210\220.png" and /dev/null differ diff --git "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\265\204\344\272\247\345\272\223\347\256\241\347\220\206\347\225\214\351\235\242.png" "b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\265\204\344\272\247\345\272\223\347\256\241\347\220\206\347\225\214\351\235\242.png" deleted file mode 100644 index 33b9a3e0852f8e5ae1e95da572dcfc13f6d59da2..0000000000000000000000000000000000000000 Binary files "a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\265\204\344\272\247\345\272\223\347\256\241\347\220\206\347\225\214\351\235\242.png" and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/witchaind_guidance.md b/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/witchaind_guidance.md deleted file mode 100644 index 4759a57baa4e35ee529e9f4da70e1d1405612e6e..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/knowledge_base_management/witchaind_guidance.md +++ /dev/null @@ -1,87 +0,0 @@ -# witChainD 使用指南——知识库管理 - -完成 witChainD 部署之后，即可使用 witChainD 进行知识库管理管理。 - -下文会从页面的维度进行 witChainD 的功能介绍。 - -## 1. 资产库管理界面 - -该页面为资产库管理界面，用户登录后将会进入该界面。 - -![资产库管理界面](./pictures/资产库管理界面.png) - -**支持操作：** - -- 配置模型：点击右上角的设置按键，可以修改模型相关的配置。 - - ![模型配置](./pictures/模型配置.png) - -- 新增资产库：点击新建资产库按钮新建，支持自定义名称、描述、语言、嵌入模型、解析方法、文件分块大小、文档类别。注意：重复名称会自动将名称修改成资产库id。 - - ![新增资产库](./pictures/新增资产库.png) - -- 编辑资产库：点击资产库的编辑按钮编辑，支持修改名称、描述、语言、解析方法、文件分块大小、文档类别。注意：不能修改成重复名称。 - - ![编辑资产库](./pictures/编辑资产库0.png) - - ![编辑资产库](./pictures/编辑资产库.png) - -- 导出资产库：点击资产库的导出按钮导出，导出完成后需要按任务列表中的下载任务下载对应资产库到本地。 - - ![导出资产库](./pictures/导出资产库.png) - -- 批量导入资产库：点击批量导入，上传本地文件后选中即可导入。 - - ![批量导入资产库](./pictures/批量导入资产库.png) - -- 搜索资产库：在搜索栏中键入文本，可以搜索得到名称包含对应文本的资产库。 - -## 2. 文档管理界面 - -在资产管理界面点击对应资产库，可以进入文档管理界面。 - -![文档管理界面](./pictures/文档管理界面.png) - -**支持操作：** - -- 导入文档：点击导入文档，从本地上传文件导入，导入后会自动以该资产库默认配置开始解析。 - - ![导入文档](./pictures/导入文档.png) - -- 解析文档：点击操作中的解析，对文档进行解析。也可以选中多个文档批量解析。 - - ![文档解析](./pictures/文档解析.png) - - ![文档解析2](./pictures/文档解析2.png) - - ![解析完成](./pictures/解析完成.png) - -- 编辑文档配置：点击编辑对文档配置进行编辑，支持编辑文档名称、解析方法、类别、文件分块大小。 - - ![编辑文档配置](./pictures/编辑文档配置.png) - -- 下载文档：点击下载即可将文档下载至本地，也可以选中多个文档批量下载。 - -- 删除文档：点击删除即可将文档从资产库中删除，也可以选中多个文档批量删除。 - -- 搜索文档：点击文档名称旁的搜索键，在弹出的搜索框中键入搜索的文本，可以搜索得到名称包含这些文本的文档。 - - ![搜索文档](./pictures/搜索文档.png) - -- 编辑资产库配置：支持编辑资产库名称、描述、语言、默认解析方法、文件分块大小、文档信息类别。 - - ![编辑资产库配置](./pictures/编辑资产库配置.png) - -## 3. 解析结果管理界面 - -点击解析完成的文档，可以进入文档的解析结果管理界面。界面中会按照顺序显示文档解析后的文本块内容预览，每个文本块会附带一个标签，表示该文本块中的信息来源于文档中的段落、列表或者是图片。右侧的开关表示该文本块是否被启用。 - -![文本块结果预览](./pictures/文本块结果预览.png) - -**支持操作**： - -- 关闭/启用文本块：点击文本块右侧的开关即可关闭/启用对应文本块，也可以选中多个文本块批量关闭/启用。 - - ![批量启用](./pictures/批量启用.png) - -- 搜索文本块：在搜索框中键入内容，可以查找包含对应内容的文本块。 diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/_toc.yaml b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/_toc.yaml deleted file mode 100644 index cd560181f695cb74418f3a87d2e3529b9c780c3c..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/_toc.yaml +++ /dev/null @@ -1,12 +0,0 @@ -label: 使用指南-网页端 -isManual: true -description: -sections: - - label: 前言 - href: ./preface.md - - label: 登录 openEuler Copilot System - href: ./registration_and_login.md - - label: 智能问题使用指南 - href: ./qa_guide.md - - label: 智能插件介绍 - href: ./intelligent_plugin.md diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/intelligent_plugin.md b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/intelligent_plugin.md deleted file mode 100644 index 0ea19a2b1d0246b07c829da85533d6e43d6f734e..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/intelligent_plugin.md +++ /dev/null @@ -1,38 +0,0 @@ -# 智能插件 - -## 基本用法 - -1. 如图所示，在输入框左上角可以选择插件，点击显示插件列表。 - - ![智能插件](./pictures/plugin-list.png) - -2. 勾选一个插件，然后提问。 - - ![智能插件](./pictures/plugin-selected.png) - -3. 等待服务响应，查看返回结果。 - - 智能插件模式下，推荐问题将置顶推荐的工作流，蓝色文字为对应插件名称，点击后可快捷追问。 - - ![智能插件](./pictures/plugin-suggestion.png) - ![智能插件](./pictures/plugin-result.png) - -## 插件工作流 - -openEuler Copilot System 支持插件工作流。插件工作流由多个步骤组成，每个步骤都会调用一次插件。每个步骤的输出将作为下一个步骤的输入。下面以使用 CVE 漏洞查询插件查看漏洞修复任务完成情况为例，介绍插件工作流的使用方法。 - -1. 查询全部 CVE 修复任务信息 - - ![插件工作流](./pictures/plugin-workflow-case-step-1.png) - -2. 根据上一步的结果查询指定 CVE 修复任务的详细信息 - - ![插件工作流](./pictures/plugin-workflow-case-step-2.png) - ![插件工作流](./pictures/plugin-workflow-case-step-2-result.png) - -### 补全参数 - -当上下文信息不足时，插件会提示用户补充缺失的参数。 - -![补全参数](./pictures/plugin-workflow-fill-in-param.png) -![执行结果](./pictures/plugin-workflow-fill-in-param-result.png) diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-login-click2signup.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-login-click2signup.png deleted file mode 100644 index 6e6f96b4a902d04c67eb2e299ad038423dcb04c7..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-login-click2signup.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-login.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-login.png deleted file mode 100644 index b5ea5a7577f2ce19fad4df5274847676134d95e0..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-login.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-signup.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-signup.png deleted file mode 100644 index c20a54d270988f56039a2b93eca6aa369d048884..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/authhub-signup.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete-confirmation.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete-confirmation.png deleted file mode 100644 index 3cc5a6a25618eff0bfa9807e1c19e4f88edc7da4..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete-confirmation.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete-multi-select.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete-multi-select.png deleted file mode 100644 index 772c51d903531cfe74245f08ecdca06d4677f935..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete-multi-select.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete.png deleted file mode 100644 index 929230cd06cc792b633ab183155225926d2c300d..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/bulk-delete.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/chat-area.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/chat-area.png deleted file mode 100644 index 966432e02f08a6c769e8cd87b0468bd25f257f5e..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/chat-area.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/context-support.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/context-support.png deleted file mode 100644 index 0bd5f091d0eff34d9b5f36eec6df63b191656daa..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/context-support.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/delete-session-confirmation.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/delete-session-confirmation.png deleted file mode 100644 index 729096bdae14895b81e8725a8065d1f4bfcdbf6c..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/delete-session-confirmation.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/delete-session.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/delete-session.png deleted file mode 100644 index 596af33f7be41d456a57e6a297820530f8485f34..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/delete-session.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback-illegal.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback-illegal.png deleted file mode 100644 index b6e84ba45977d911db960da97bdff714624ba18c..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback-illegal.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback-misinfo.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback-misinfo.png deleted file mode 100644 index cc5505226add1e6fbde7b93ff09877038e8cfdce..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback-misinfo.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback.png deleted file mode 100644 index 9fe1c27acb57d4d24a26c8dde61ee4272f954e46..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/feedback.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-ask-against-file.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-ask-against-file.png deleted file mode 100644 index 2cf2c5e50c8c02c4c2713fde63c7e11c110c8bb2..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-ask-against-file.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-btn-prompt.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-btn-prompt.png deleted file mode 100644 index 45e38672d0c46ccc2ded83669875f7c832f2c73d..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-btn-prompt.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-btn.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-btn.png deleted file mode 100644 index 2f6a7cee51e2cb02b52baf6ffa7136f5601a26e1..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-btn.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-history-tag.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-history-tag.png deleted file mode 100644 index 487a48e6f72cbe8f115d8ce2001808b9b4a74dec..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-history-tag.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-parsing.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-parsing.png deleted file mode 100644 index 812090a59ee3594b11ecfcb55cc7a8b7361ca2bb..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-parsing.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-showcase.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-showcase.png deleted file mode 100644 index 60234df165d16abb976ffdf74d0b1ad890387e57..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-showcase.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-uploading.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-uploading.png deleted file mode 100644 index 7f29ba755ce71d08098d0d5950239b69e1d7f16a..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/file-upload-uploading.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-arrow-next.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-arrow-next.png deleted file mode 100644 index 1a36c84e0965f9dbf1f90e9a3daadcd1a2560951..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-arrow-next.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-arrow-prev.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-arrow-prev.png deleted file mode 100644 index eb667e93cc6d51aa191a0ac7607e72d4d6923cbc..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-arrow-prev.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-cancel.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-cancel.png deleted file mode 100644 index 34d4454b6f92ee12db6841dafe0e94a12c3b9584..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-cancel.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-confirm.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-confirm.png deleted file mode 100644 index 1d650f8192e04fae8f7b7c08cd527227c91b833a..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-confirm.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-edit.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-edit.png deleted file mode 100644 index f7b28aa605b5e899855a261d641d27a2674703eb..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-edit.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-search.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-search.png deleted file mode 100644 index 7902923196c3394ae8eafaf5a2b6fdf7f19b1f40..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-search.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-thumb-down.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-thumb-down.png deleted file mode 100644 index cda14d196d92898da920ed64ad37fa9dd124c775..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-thumb-down.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-thumb-up.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-thumb-up.png deleted file mode 100644 index c75ce44bff456e24bc19040c18e4e644bbb77bd1..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-thumb-up.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-user.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-user.png deleted file mode 100644 index e6b06878b76d9e6d268d74070539b388129fa8c4..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/icon-user.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/login-popup.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/login-popup.png deleted file mode 100644 index 7834248e8603aca100b8b7e33a93611777cc6ede..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/login-popup.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/logout.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/logout.png deleted file mode 100644 index da51441e632cb77dfbe0f86056e333f69485c500..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/logout.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/main-page-clean-ref.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/main-page-clean-ref.png deleted file mode 100644 index 2e00878b62408e75d8f82c40b3a1f5e0f4f878f6..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/main-page-clean-ref.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/main-page-sections.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/main-page-sections.png deleted file mode 100644 index 9d8f013318c840a5b05b3010b9b08047870be822..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/main-page-sections.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/new-chat.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/new-chat.png deleted file mode 100644 index 784a0da650df405e1df147409b785a026109e239..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/new-chat.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-list.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-list.png deleted file mode 100644 index 90270b4c9d8991463e4a4129625ab0325ac09922..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-list.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-result.png deleted file mode 100644 index a810a8c123f34f51c06c2dd22c9fc1e9cb4efa06..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-selected.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-selected.png deleted file mode 100644 index fa5342091d0a023a545c3edab8c4368654df8a90..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-selected.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-suggestion.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-suggestion.png deleted file mode 100644 index bb416881550349000f61b0c1bd3dd540878bd6ad..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-suggestion.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-1.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-1.png deleted file mode 100644 index e961ddc5b9aa6b687c69e4587ea3a59f54b6ad27..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-1.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-2-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-2-result.png deleted file mode 100644 index dfc52217a1595613a934c5860704d688a2876a37..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-2-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-2.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-2.png deleted file mode 100644 index 0cb59551c2695151491aa1120163ea0c1aabb317..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-case-step-2.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-fill-in-param-result.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-fill-in-param-result.png deleted file mode 100644 index 899ee2672ba8b5eb8518fb9b80104577159d1cb4..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-fill-in-param-result.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-fill-in-param.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-fill-in-param.png deleted file mode 100644 index 4c03312d72f49c51868826d62bc59d0f2f925cc7..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/plugin-workflow-fill-in-param.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/privacy-policy-entry.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/privacy-policy-entry.png deleted file mode 100644 index d7efce3e6e8d477ef47a1bc8a9bba0d087cf8058..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/privacy-policy-entry.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/privacy-policy.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/privacy-policy.png deleted file mode 100644 index 0bc0980a7dd78e055fc920d591a77d5394b5fb84..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/privacy-policy.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/recommend-questions.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/recommend-questions.png deleted file mode 100644 index 076ec7092af7fe7987e5dc7c864a6b9f8b2b1160..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/recommend-questions.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/regenerate.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/regenerate.png deleted file mode 100644 index 655c9d5002df4a17aaf84e8780fff4a0118c6c01..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/regenerate.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/rename-session-confirmation.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/rename-session-confirmation.png deleted file mode 100644 index d64708bd57d53deafdc5ddbb70d9deaeaca0d132..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/rename-session-confirmation.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/rename-session.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/rename-session.png deleted file mode 100644 index 73e7e19c5ac8e8035df0e4b553a9b78ff5c9a051..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/rename-session.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/report-options.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/report-options.png deleted file mode 100644 index 8a54fd2598d51fc40b57052f404dd830cf621f4d..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/report-options.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/report.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/report.png deleted file mode 100644 index 471bcbe8614fc8bab4dcc1805fa1bf4574990fc8..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/report.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/search-history.png b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/search-history.png deleted file mode 100644 index 2239d14a7aa8bc13a7b8d3ec71ba9ed71b95e850..0000000000000000000000000000000000000000 Binary files a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/pictures/search-history.png and /dev/null differ diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/preface.md b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/preface.md deleted file mode 100644 index 08fc0c72504544c8800140476c101d51254f8472..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/preface.md +++ /dev/null @@ -1,67 +0,0 @@ -# 前言 - -## 概述 - -本文档介绍了 openEuler Copilot System 的使用方法，对 openEuler Copilot System 线上服务的 Web 界面的各项功能做了详细介绍，同时提供了常见的问题解答，详细请参考对应手册。 - -## 读者对象 - -本文档主要适用于 openEuler Copilot System 的使用人员。使用人员必须具备以下经验和技能： - -- 熟悉 openEuler 操作系统相关情况。 -- 有 AI 对话使用经验。 - -## 修改记录 - -| 文档版本 | 发布日期 | 修改说明 | -|--------|------------|----------------| -| 03 | 2024-09-19 | 更新新版界面。 | -| 02 | 2024-05-13 | 优化智能对话操作指引。 | -| 01 | 2024-01-28 | 第一次正式发布。 | - -## 介绍 - -### 免责声明 - -- 使用过程中涉及的非工具本身验证功能所用的用户名和密码，不作他用，且不会被保存在系统环境中。 -- 在您进行对话或操作前应当确认您为应用程序的所有者或已获得所有者的充足授权同意。 -- 对话结果中可能包含您所分析应用的内部信息和相关数据，请妥善管理。 -- 除非法律法规或双方合同另有规定，openEuler 社区对分析结果不做任何明示或暗示的声明和保证，不对分析结果的适销性、满意度、非侵权性或特定用途适用性等作出任何保证或者承诺。 -- 您根据分析记录所采取的任何行为均应符合法律法规的要求，并由您自行承担风险。 -- 未经所有者授权，任何个人或组织均不得使用应用程序及相关分析记录从事任何活动。openEuler 社区不对由此造成的一切后果负责，亦不承担任何法律责任。必要时，将追究其法律责任。 - -### openEuler Copilot System 简介 - -openEuler Copilot System 是一个基于 openEuler 操作系统的人工智能助手，可以帮助用户解决各种技术问题，提供技术支持和咨询服务。它使用了最先进的自然语言处理技术和机器学习算法，能够理解用户的问题并提供相应的解决方案。 - -### 场景内容 - -1. OS 领域通用知识：openEuler Copilot System 可以咨询 Linux 常规知识、上游信息和工具链介绍和指导。 -2. openEuler 专业知识：openEuler Copilot System 可以咨询 openEuler 社区信息、技术原理和使用指导。 -3. openEuler 扩展知识：openEuler Copilot System 可以咨询 openEuler 周边硬件特性知识和ISV、OSV相关信息。 -4. openEuler 应用案例：openEuler Copilot System 可以提供 openEuler 技术案例、行业应用案例。 -5. shell 命令生成：openEuler Copilot System 可以帮助用户生成单条 shell 命令或者复杂命令。 - -总之，openEuler Copilot System 可以应用于各种场景，帮助用户提高工作效率和了解 Linux、openEuler 等的相关知识。 - -### 访问和使用 - -openEuler Copilot System 通过网址访问 Web 网页进行使用。账号注册与登录请参考[注册与登录](./registration_and_login.md)。使用方法请参考[智能问答使用指南](./qa_guide.md)。 - -### 界面说明 - -#### 界面分区 - -openEuler Copilot System 界面主要由如图 1 所示的区域组成，各个区域的作用如表 1 所示。 - -- 图 1 openEuler Copilot System 界面 -![Copilot 界面](./pictures/main-page-sections.png) - -- 表 1 openEuler Copilot System 首页界面分区说明 - -| 区域 | 名称 | 说明 | -|-----|------------|----------------------------------------------------------------| -| 1 | 设置管理区 | 提供账号登录和退出操作入口和明亮/黑暗模式切换功能 | -| 2 | 对话管理区 | 用于用户新建对话、对话历史记录管理和对话历史记录批量删除操作 | -| 3 | 对话区 | 用于用户和 openEuler Copilot System 的对话聊天 | -| 4 | 服务协议和隐私政策区 | 提供查看服务协议和隐私政策入口 | diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/qa_guide.md b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/qa_guide.md deleted file mode 100644 index 64b4a1881e5224360463b97b09dab11e7bb2f3e6..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/qa_guide.md +++ /dev/null @@ -1,179 +0,0 @@ -# 智能问答使用指南 - -## 开始对话 - -在对话区下侧输入框即可输入对话想要提问的内容，输入 `Shift + Enter` 可进行换行，输入 `Enter` 即可发送对话提问内容，或者单击“发送”也可发送对话提问内容。 - -> **说明** -> -> 对话区位于页面的主体部分，如图 1 所示。 - -- 图 1 对话区 - ![对话区](./pictures/chat-area.png) - -### 多轮连续对话 - -openEuler Copilot System 智能问答支持多轮连续对话。只需要在同一个对话中继续追问即可使用，如图 2 所示。 - -- 图 2 多轮对话 - ![多轮对话](./pictures/context-support.png) - -### 重新生成 - -如遇到 AI 生成的内容有误或不完整的特殊情况，可以要求 AI 重新回答问题。单击对话回答左下侧的“重新生成”文字，可让 openEuler Copilot System 重新回答用户问题，重新回答后，在对话回答右下侧，会出现回答翻页的图标![向前翻页](./pictures/icon-arrow-prev.png)和![向后翻页](./pictures/icon-arrow-next.png)，单击![向前翻页](./pictures/icon-arrow-prev.png)或![向后翻页](./pictures/icon-arrow-next.png)可查看不同的回答，如图 3 所示。 - -- 图 3 重新生成 - ![重新生成](./pictures/regenerate.png) - -### 推荐问题 - -在 AI 回答的下方，会展示一些推荐的问题，单击即可进行提问，如图 4 所示。 - -- 图 4 推荐问题 - ![推荐问题](./pictures/recommend-questions.png) - -## 自定义背景知识 - -openEuler Copilot System 支持上传文件功能。上传文件后，AI 会将上传的文件内容作为背景知识，在回答问题时，会结合背景知识进行回答。上传的背景知识只会作用于当前对话，不会影响其他对话。 - -### 上传文件 - -**步骤1** 单击对话区左下角的“上传文件”按钮，如图 5 所示。 - -- 图 5 上传文件按钮 - ![上传文件](./pictures/file-upload-btn.png) - -> **说明** -> -> 鼠标悬停到“上传文件”按钮上，会显示提示允许上传文件的规格和格式，如图 6 所示。 - -- 图 6 鼠标悬停显示上传文件规格提示 - ![上传文件提示](./pictures/file-upload-btn-prompt.png) - -**步骤2** 在弹出的文件选择框中，选择需要上传的文件，单击“打开”，即可上传文件。最多上传10个文件，总大小限制为64MB。接受 PDF、docx、doc、txt、md、xlsx。 - -开始上传后，对话区下方会显示上传进度，如图 7 所示。 - -- 图 7 同时上传的所有文件排列在问答输入框下方 - ![上传文件](./pictures/file-upload-uploading.png) - -文件上传完成后会自动解析，如图 8 所示，解析完成后，对话区下方会显示每个文件的大小信息。 - -- 图 8 文件上传至服务器后将显示“正在解析” - ![文件解析](./pictures/file-upload-parsing.png) - -文件上传成功后，左侧历史记录区会显示上传的文件数量，如图 9 所示。 - -- 图 9 对话历史记录标签上会展示上传文件数量 - ![历史记录标记](./pictures/file-upload-history-tag.png) - -### 针对文件提问 - -文件上传完成后，即可针对文件进行提问，提问方式同普通对话模式，如图 10 所示。 -回答结果如图 11 所示。 - -- 图 10 询问与上传的文件相关的问题 - ![针对文件提问](./pictures/file-upload-ask-against-file.png) - -- 图 11 AI 以上传的为背景知识进行回答 - ![根据自定义背景知识回答](./pictures/file-upload-showcase.png) - -## 管理对话 - -> **说明** -> -> 对话管理区在页面左侧。 - -### 新建对话 - -单击“新建对话”按钮即可新建对话，如图 12 所示。 - -- 图 12 “新建对话”按钮在页面左上方 - ![新建对话](./pictures/new-chat.png) - -### 对话历史记录搜索 - -在页面左侧历史记录搜索输入框输入关键词，然后单击![搜索](./pictures/icon-search.png)即可进行对话历史记录搜索如图 13 所示。 - -- 图 13 对话历史记录搜索框 - ![对话历史记录搜索](./pictures/search-history.png) - -### 对话历史记录单条管理 - -历史记录的列表位于历史记录搜索栏的下方，在每条对话历史记录的右侧，单击![编辑](./pictures/icon-edit.png)即可编辑对话历史记录的名字，如图 14 所示。 - -- 图 14 点击“编辑”图标重命名历史记录 - ![重命名历史记录](./pictures/rename-session.png) - -在对话历史记录名字重新书写完成后，单击右侧![确认](./pictures/icon-confirm.png)即可完成重命名，或者单击右侧![取消](./pictures/icon-cancel.png)放弃本次重命名，如图 15 所示。 - -- 图 15 完成/取消重命名历史记录 - ![完成/取消重命名历史记录](./pictures/rename-session-confirmation.png) - -另外，单击对话历史记录右侧的删除图标，如图 16 所示，即可对删除单条对话历史记录进行二次确认，在二次确认弹出框，如图 17 所示，单击“确认”，可确认删除单条对话历史记录，或者单击“取消”，取消本次删除。 - -- 图 16 点击“垃圾箱”图标删除单条历史记录 - ![删除单条历史记录](./pictures/delete-session.png) - -- 图 17 二次确认后删除历史记录 - ![删除单条历史记录二次确认](./pictures/delete-session-confirmation.png) - -### 对话历史记录批量删除 - -首先单击“批量删除”，如图 18 所示。 - -- 图 18 批量删除功能在历史记录搜索框右上方 - ![批量删除](./pictures/bulk-delete.png) - -然后可对历史记录进行选择删除，如图 19 所示。单击“全选”，即对所有历史记录选中，单击单条历史记录或历史记录左侧的选择框，可对单条历史记录进行选中。 - -- 图 19 在左侧勾选要批量删除历史记录 - ![批量删除历史记录选择](./pictures/bulk-delete-multi-select.png) - -最后需要对批量删除历史记录进行二次确认，如图 20 所示，单击“确认”，即删除，单击“取消”，即取消本次删除。 - -- 图 20 二次确认后删除所选的历史记录 - ![批量删除二次确认](./pictures/bulk-delete-confirmation.png) - -## 反馈与举报 - -在对话记录区，对话回答的右下侧，可进行对话回答反馈，如图 21 所示，单击![满意](./pictures/icon-thumb-up.png)，可给对话回答点赞；单击![不满意](./pictures/icon-thumb-down.png)，可以给对话回答反馈不满意的原因。 - -- 图 21 点赞和不满意反馈 - ![点赞和不满意反馈](./pictures/feedback.png) - -对于反馈不满意原因，如图 22 所示，在单击![不满意](./pictures/icon-thumb-down.png)之后，对话机器人会展示反馈内容填写的对话框，可选择相关的不满意原因的选项。 - -- 图 22 回答不满意反馈 - ![回答不满意反馈](./pictures/feedback-illegal.png) - -其中单击选择“存在错误信息”，需要填写参考答案链接和描述，如图 23 所示。 - -- 图 23 回答不满意反馈——存在错误信息 - ![回答不满意反馈——存在错误信息](./pictures/feedback-misinfo.png) - -### 举报 - -如果发现 AI 返回的内容中有违规信息，可以点击右下角按钮举报，如图 24 所示。点击举报后选择举报类型并提交，若没有合适的选项，请选择“其他”并输入原因，如图 25 所示。 - -- 图 24 举报按钮在对话块的右下角 - ![举报1](./pictures/report.png) - -- 图 25 点击后可选择举报类型 - ![举报2](./pictures/report-options.png) - -## 查看服务协议和隐私政策 - -单击文字“服务协议”，即可查看服务协议，单击文字“隐私政策”，即可查看隐私政策，如图 26、图 27 所示。 - -- 图 26 服务协议和隐私政策入口在页面底部信息栏 - ![服务协议和隐私政策入口](./pictures/privacy-policy-entry.png) - -- 图 27 点击后显示服务协议或隐私政策弹窗 - ![服务协议和隐私政策](./pictures/privacy-policy.png) - -## 附录 - -### 用户信息导出说明 - -openEuler Copilot System 后台存在用户信息导出功能，如用户需要，需主动通过 邮箱联系我们，运维会将导出的用户信息通过邮箱回送给用户。 diff --git a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/registration_and_login.md b/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/registration_and_login.md deleted file mode 100644 index 14c30c32be2ccf22c5bec73d9892936cd214cc49..0000000000000000000000000000000000000000 --- a/docs/zh/tools/ai/euler_copilot/usage_guide/online_services/registration_and_login.md +++ /dev/null @@ -1,55 +0,0 @@ -# 登录 openEuler Copilot System - -本章节介绍登录通过 *[openEuler Copilot System 部署指南](../../deployment_guide)* 部署的 openEuler Copilot System 网页端的操作步骤。 - -## 浏览器要求 - -浏览器要求如表 1 所示。 - -- 表 1 浏览器要求 - -| 浏览器类型 | 最低版本 | 推荐版本 | -| ----- | ----- | ----- | -| Google Chrome | 72 | 121 或更高版本 | -| Mozilla Firefox | 89 | 122 或更高版本 | -| Apple Safari | 11.0 | 16.3 或更高版本 | - -## 操作步骤 - -**步骤1** 打开本地 PC 机的浏览器，在地址栏输入 *[部署指南](../../部署指南/网络环境下部署指南.md#2-安装-openeuler-copilot-system)* 中配置好的域名，按下 `Enter`。在未登录状态，进入 openEuler Copilot System，会出现登录提示弹出框，如图 1 所示。 - -- 图 1 未登录 -![未登录](./pictures/login-popup.png) - -**步骤2** 登录 openEuler Copilot System（已注册账号）。 - -打开登录界面，如图 2 所示。 - -- 图 2 登录 openEuler Copilot System -![登录 openEuler Copilot System](./pictures/authhub-login.png) - -## 注册 openEuler Copilot System 账号 - -**步骤1** 在登录信息输入框右下角单击“立即注册”，如图 3 所示。 - -- 图 3 立即注册 -![立即注册](./pictures/authhub-login-click2signup.png) - -**步骤2** 进入账号注册页，根据页面提示填写相关内容，如图 4 所示。 - -- 图 4 账号注册 -![账号注册](./pictures/authhub-signup.png) - -**步骤3** 按页面要求填写账号信息后，单击“注册”，即可注册成功。注册后即可返回登录。 - -## 退出登录 - -**步骤1** 单击![退出登录](./pictures/icon-user.png)后，会出现“退出登录”下拉框，如图 5 所示。 - -> **说明** -> 账号管理区位于页面的右上角部分，如图 5 所示。 - -- 图 5 账号管理区 -![账号管理区](./pictures/logout.png) - -**步骤2** 单击“退出登录”即可退出登录，如图 5 所示。 diff --git a/docs/zh/tools/cloud/ctinspector/installation_and_deployment.md b/docs/zh/tools/cloud/ctinspector/installation_and_deployment.md index ac0d235f585e9cd251f4246b77549279790e2e0f..e57624c1302e5c57c0ba9d5dbed1dc7b8d508868 100644 --- a/docs/zh/tools/cloud/ctinspector/installation_and_deployment.md +++ b/docs/zh/tools/cloud/ctinspector/installation_and_deployment.md @@ -6,11 +6,7 @@ ## 环境准备 -<<<<<<< HEAD:docs/zh/tools/cloud/ctinspector/installation_and_deployment.md -* 安装openEuler系统，安装方法参考 《[安装指南](../../../server/installation_upgrade/installation/installation-on-servers.md)》。 -======= * 安装openEuler系统，安装方法参考 《[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 ->>>>>>> 6b124a04c (文档整改):docs/zh/docs/tools/cloud/ctinspector/installation_and_deployment.md * 安装CTinspector需要使用root权限。 diff --git a/docs/zh/tools/community_tools/_toc.yaml b/docs/zh/tools/community_tools/_toc.yaml index 784a20fb78a38c119a884257c32b2658005a6678..bf08865cc27dcf1b7514b5e37385cd4a9a8cce92 100644 --- a/docs/zh/tools/community_tools/_toc.yaml +++ b/docs/zh/tools/community_tools/_toc.yaml @@ -13,7 +13,6 @@ sections: - label: epkg软件包 sections: - href: ./epkg_use/_toc.yaml - - href: ./autopkg/_toc.yaml - label: 编译 sections: - href: ./pin/_toc.yaml diff --git a/docs/zh/tools/community_tools/pin/pin_user_guide.md b/docs/zh/tools/community_tools/pin/pin_user_guide.md index 0bb198d57631f7d5a4a7831cafa9b41e3aa4c696..b27d6a0e73626a60a14c686afadb56b9e8f55303 100644 --- a/docs/zh/tools/community_tools/pin/pin_user_guide.md +++ b/docs/zh/tools/community_tools/pin/pin_user_guide.md @@ -1,17 +1,22 @@ # 安装与部署 + ## 软件要求 + * 操作系统：openEuler 24.03 + ## 硬件要求 + * x86_64架构 * ARM架构 + ## 环境准备 -<<<<<<<< HEAD:archive/Pin/插件框架特性用户指南.md -* 安装openEuler系统，安装方法参考 《[安装指南](../../../../server/installation_upgrade/installation/installation_on_servers.md)》。 -======== -* 安装openEuler系统，安装方法参考 《[安装指南](../../../../server/installation_upgrade/installation/installation_on_servers.md)》。 ->>>>>>>> 6b124a04c (文档整改):docs/zh/docs/tools/community_tools/pin/pin_user_guide.md + +* 安装openEuler系统，安装方法参考 《[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 + ### 安装依赖软件 + #### 安装插件框架GCC客户端依赖软件 + ```shell yum install -y grpc yum install -y grpc-devel @@ -24,7 +29,9 @@ yum install -y llvm-mlir yum install -y llvm-mlir-devel yum install -y llvm-devel ``` + #### 安装插件框架服务端依赖软件 + ```shell yum install -y grpc yum install -y grpc-devel @@ -36,9 +43,13 @@ yum install -y llvm-mlir yum install -y llvm-mlir-devel yum install -y llvm-devel ``` + ## 安装Pin + ### rpm构建 + #### 构建插件框架GCC客户端 + ```shell git clone https://gitee.com/src-openeuler/pin-gcc-client.git cd pin-gcc-client @@ -48,7 +59,9 @@ rpmbuild -ba pin-gcc-client.spec cd ~/rpmbuild/RPMS rpm -ivh pin-gcc-client.rpm ``` + #### 构建插件框架服务端 + ```shell git clone https://gitee.com/src-openeuler/pin-server.git cd pin-server @@ -58,8 +71,11 @@ rpmbuild -ba pin-server.spec cd ~/rpmbuild/RPMS rpm -ivh pin-server.rpm ``` + ### 编译构建 + #### 构建插件框架GCC客户端 + ```shell git clone https://gitee.com/openeuler/pin-gcc-client.git cd pin-gcc-client @@ -68,7 +84,9 @@ cd build cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} make ``` + #### 构建插件框架服务端 + ```shell git clone https://gitee.com/openeuler/pin-server.git cd pin-server @@ -78,9 +96,11 @@ cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} make ``` -# 使用方法 +## 使用方法 + 用户可以通过`-fplugin`和`-fplugin-arg-libpin_xxx`使能插件工具。 命令如下： + ```shell $(TARGET): $(OBJS) $(CXX) -fplugin=${CLIENT_PATH}/build/libpin_gcc_client.so \ @@ -107,6 +127,8 @@ $(TARGET): $(OBJS) `-fplugin-arg-libpin_gcc_client-argN`：用户可以根据插件工具要求，指定其他参数。argN代指插件工具要求的参数字段。 -# 兼容性说明 +## 兼容性说明 + 此节主要列出当前一些特殊场景下的兼容性问题。本项目持续迭代中，会尽快进行修复，也欢迎广大开发者加入。 + * 插件框架在`-flto`阶段使能时，不支持使用`make -j`多进程编译。建议改用`make -j1`进行编译。 diff --git a/docs/zh/tools/desktop/dde/_toc.yaml b/docs/zh/tools/desktop/dde/_toc.yaml index 7e4add2629d56f6a1025f023b0042cc1a54fb2dd..f59a438adcbe01006407ac1f2e30790eaebac08f 100644 --- a/docs/zh/tools/desktop/dde/_toc.yaml +++ b/docs/zh/tools/desktop/dde/_toc.yaml @@ -2,8 +2,6 @@ label: DDE用户指南 isManual: true description: 安装并使用 DDE 桌面环境 sections: - - label: DDE概述 - href: ./dde_installation1.md - label: 安装 DDE href: ./dde_installation.md - label: 使用 DDE diff --git a/docs/zh/tools/devops/patch_tracking/patch_tracking.md b/docs/zh/tools/devops/patch_tracking/patch_tracking.md index 64dfa7bcb4519b53950c9129d5d6cde41956fbb2..ae981b2bf93432679d205c9146cf3bbca878d52e 100644 --- a/docs/zh/tools/devops/patch_tracking/patch_tracking.md +++ b/docs/zh/tools/devops/patch_tracking/patch_tracking.md @@ -72,11 +72,8 @@ rpm 包获取地址：[https://repo.openeuler.org/](https://repo.openeuler.org/) 方法1：从repo源安装 -<<<<<<< HEAD:docs/zh/tools/devops/patch_tracking/patch_tracking.md -1. 使用 dnf 挂载 repo源（具体方法参考[应用开发指南](../../../server/development/application_dev/preparations-for-development-environment.md))。 -======= 1. 使用 dnf 挂载 repo源（具体方法参考[应用开发指南](../../../server/development/application_dev/preparations_for_development_environment.md)。 ->>>>>>> 6b124a04c (文档整改):docs/zh/docs/tools/devops/patch_tracking/patch_tracking.md + 2. 执行以下命令安装`patch-tracking`及其依赖。 ```shell