From ea49b241680318ee559120c5a79445daba905f3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8F=B2=E9=B8=BF=E5=AE=87?= Date: Tue, 22 Oct 2024 09:45:27 +0800 Subject: [PATCH 1/2] =?UTF-8?q?=E9=83=A8=E7=BD=B2=E6=89=8B=E5=86=8C?= =?UTF-8?q?=EF=BC=9A=E6=95=B4=E7=90=86=E6=96=87=E4=BB=B6=EF=BC=8C=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 史鸿宇 --- docs/user-guide/README.md | 12 +- .../flows/get_all_docker_images_flow.yaml" | 28 +- .../flows/pull_images_flow.yaml" | 28 +- .../flows/run_images_flow.yaml" | 26 +- .../Compatibility-AI-Infra/openapi.yaml" | 378 +++++++++--------- .../Compatibility-AI-Infra/plugin.json" | 0 ...50\347\275\262\346\214\207\345\215\227.md" | 35 ++ .../euler-copilot-rca/flows/demarcation.yaml" | 0 .../euler-copilot-rca/flows/detection.yaml" | 0 .../euler-copilot-rca/flows/inspection.yaml" | 0 .../flows/show_profiling.yaml" | 0 .../euler-copilot-rca/openapi.yaml" | 0 .../euler-copilot-rca/plugin.json" | 0 ...50\347\275\262\346\214\207\345\215\227.md" | 17 +- .../flows/data_collection.yaml" | 28 +- .../flows/performance_analysis.yaml" | 28 +- .../flows/performance_tuning.yaml" | 24 +- .../euler-copilot-tune/openapi.yaml" | 292 +++++++------- .../euler-copilot-tune/plugin.json" | 10 +- ...50\347\275\262\346\214\207\345\215\227.md" | 55 +++ ...50\347\275\262\346\214\207\345\215\227.md" | 36 -- ...50\347\275\262\346\214\207\345\215\227.md" | 60 --- ...50\347\275\262\346\214\207\345\215\227.md" | 0 23 files changed, 526 insertions(+), 531 deletions(-) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" (97%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" (96%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" (96%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" (96%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/plugin.json" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/plugin.json" (100%) create mode 100644 "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/demarcation.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/demarcation.yaml" (100%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/detection.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/detection.yaml" (100%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/inspection.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/inspection.yaml" (100%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/show_profiling.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/show_profiling.yaml" (100%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/openapi.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/openapi.yaml" (100%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/plugin.json" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/plugin.json" (100%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" (67%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" (96%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" (95%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" (96%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" (96%) rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" (97%) create mode 100644 "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" delete mode 100644 "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" delete mode 100644 "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" rename "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203\342\200\224AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" => "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203/AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" (100%) diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md index 9609216e..c27a5c93 100644 --- a/docs/user-guide/README.md +++ b/docs/user-guide/README.md @@ -17,16 +17,24 @@ openEuler Copilot System 智能问答平台目前支持 Web 和智能 Shell 两 ### 部署手册 -- [部署指南](./部署指南/网络环境下部署指南.md) - - [离线部署指南](./部署指南/无网络环境下部署指南.md) +- [部署指南](./部署指南) + - [网络环境下部署指南](./部署指南/网络环境下部署指南.md) + - [无网络环境下部署指南](./部署指南/无网络环境下部署指南.md) + - [鉴权：启用 AuthHub](./部署指南/鉴权/AuthHub部署指南.md) - [本地资产库构建指南](./部署指南/本地资产库构建指南.md) +- [插件部署指南](./部署指南/插件) + - [智能调优](./部署指南/插件/智能调优/插件—智能调优部署指南.md) + - [智能诊断](./部署指南/插件/智能诊断/插件—智能诊断部署指南.md) + - [AI容器栈](./部署指南/插件/AI容器栈/插件—AI容器栈部署指南.md) + ### 使用手册 - [Web 端 (Gitee AI) 使用手册](./使用指南/线上服务/前言.md) - [注册与登录](./使用指南/线上服务/注册与登录.md) - [智能问答](./使用指南/线上服务/智能问答使用指南.md) - [智能插件](./使用指南/线上服务/智能插件简介.md) + - [智能 Shell 使用手册](./使用指南/命令行客户端/命令行助手使用指南.md) - [准备工作：获取 API Key](./使用指南/命令行客户端/获取%20API%20Key.md) - [智能插件](./使用指南/命令行客户端/命令行助手使用指南.md#智能插件) diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" similarity index 97% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" index 7da843c0..d1c43322 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/get_all_docker_images_flow.yaml" @@ -1,15 +1,15 @@ -name: get_all_supported_AI_docker_images -description: "获取所有支持的docker容器镜像,输入为空，输出为支持的AI容器镜像列表，包括名字、tag、registry、repository" -steps: - - name: start - call_type: api - params: - endpoint: GET /docker/images - next: list2markdown - - name: list2markdown - call_type: llm - params: - user_prompt: | - 当前已有的docker容器及tag为：{data}。请将这份内容输出为markdown表格，表头为registry、repository、image_name、tag,请注意如果一个容器镜像有多个tag版本，请分多行展示。 -next_flow: +name: get_all_supported_AI_docker_images +description: "获取所有支持的docker容器镜像,输入为空，输出为支持的AI容器镜像列表，包括名字、tag、registry、repository" +steps: + - name: start + call_type: api + params: + endpoint: GET /docker/images + next: list2markdown + - name: list2markdown + call_type: llm + params: + user_prompt: | + 当前已有的docker容器及tag为：{data}。请将这份内容输出为markdown表格，表头为registry、repository、image_name、tag,请注意如果一个容器镜像有多个tag版本，请分多行展示。 +next_flow: - docker_pull_specified_AI_docker_images \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" similarity index 96% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" index 81a91bce..27767792 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/pull_images_flow.yaml" @@ -1,15 +1,15 @@ -name: docker_pull_specified_AI_docker_images -description: "从dockerhub拉取指定的docker容器镜像，输入为容器镜像的名字和tag" -steps: - - name: start - call_type: api - params: - endpoint: POST /docker/pull - next: extract_key - - name: extract_key - call_type: extract - params: - keys: - - data.shell -next_flow: +name: docker_pull_specified_AI_docker_images +description: "从dockerhub拉取指定的docker容器镜像，输入为容器镜像的名字和tag" +steps: + - name: start + call_type: api + params: + endpoint: POST /docker/pull + next: extract_key + - name: extract_key + call_type: extract + params: + keys: + - data.shell +next_flow: - docker_run_specified_AI_docker_images \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" similarity index 96% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" index 93a3527c..54fe3ca3 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/flows/run_images_flow.yaml" @@ -1,13 +1,13 @@ -name: docker_run_specified_AI_docker_images -description: "运行指定的容器镜像，输入为容器镜像的名字和tag" -steps: - - name: start - call_type: api - params: - endpoint: POST /docker/run - next: extract_key - - name: extract_key - call_type: extract - params: - keys: - - data.shell +name: docker_run_specified_AI_docker_images +description: "运行指定的容器镜像，输入为容器镜像的名字和tag" +steps: + - name: start + call_type: api + params: + endpoint: POST /docker/run + next: extract_key + - name: extract_key + call_type: extract + params: + keys: + - data.shell diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" similarity index 96% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" index 08585e29..b46bf07f 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/openapi.yaml" @@ -1,190 +1,190 @@ -openapi: 3.0.2 -info: - title: compatibility-ai-infra - version: 0.1.0 -servers: - - url: http://ai-infra-service.compatibility-ai-infra.svc.cluster.local:8101 -paths: - /docker/images: - get: - description: 获取所有支持的AI容器信息，返回容器名字和tag - responses: - '200': - description: Successful Response - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseData' - /docker/pull: - post: - description: 输入容器镜像名字和容器镜像tag，返回拉取该容器的shell命令 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PullDockerImages' - required: true - responses: - '200': - description: Successful Response - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseData' - '422': - description: Validation Error - content: - application/json: - schema: - $ref: '#/components/schemas/HTTPValidationError' - /docker/run: - post: - description: 输入容器名字和tag，返回运行该容器的shell命令 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RunDockerImages' - required: true - responses: - '200': - description: Successful Response - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseData' - '422': - description: Validation Error - content: - application/json: - schema: - $ref: '#/components/schemas/HTTPValidationError' -components: - schemas: - HTTPValidationError: - description: HTTP校验错误 - type: object - properties: - detail: - title: Detail - type: array - items: - $ref: '#/components/schemas/ValidationError' - PullDockerImages: - description: 生成容器拉取命令的接口的入参 - required: - - image_name - - image_tag - type: object - properties: - image_name: - description: 容器镜像的名字,不要包含转义符 - type: string - enum: - - cann - - oneapi-runtime - - oneapi-basekit - - llm-server - - mlflow - - llm - - tensorflow - - pytorch - - cuda - image_tag: - description: 容器镜像的tag，不要包含转义符 - type: string - enum: - - "8.0.RC1-oe2203sp4" - - "cann7.0.RC1.alpha002-oe2203sp2" - - "2024.2.0-oe2403lts" - - "1.0.0-oe2203sp3" - - "2.11.1-oe2203sp3" - - "2.13.1-oe2203sp3" - - "chatglm2_6b-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" - - "llama2-7b-q8_0-oe2203sp2" - - "chatglm2-6b-q8_0-oe2203sp2" - - "fastchat-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" - - "tensorflow2.15.0-oe2203sp2" - - "tensorflow2.15.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" - - "pytorch2.1.0-oe2203sp2" - - "pytorch2.1.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" - - "pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" - - "cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" - ResponseData: - description: 接口返回值的固定格式 - required: - - code - - message - - data - type: object - properties: - code: - description: 状态码 - type: integer - message: - description: 状态信息 - type: string - data: - description: 返回数据 - type: any - RunDockerImages: - description: 生成容器运行命令的接口的入参 - required: - - image_name - - image_tag - type: object - properties: - image_name: - description: 容器镜像的名字，不要包含转义符 - type: string - enum: - - cann - - oneapi-runtime - - oneapi-basekit - - llm-server - - mlflow - - llm - - tensorflow - - pytorch - - cuda - image_tag: - description: 容器镜像的tag，不要包含转义符 - type: string - enum: - - "8.0.RC1-oe2203sp4" - - "cann7.0.RC1.alpha002-oe2203sp2" - - "2024.2.0-oe2403lts" - - "1.0.0-oe2203sp3" - - "2.11.1-oe2203sp3" - - "2.13.1-oe2203sp3" - - "chatglm2_6b-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" - - "llama2-7b-q8_0-oe2203sp2" - - "chatglm2-6b-q8_0-oe2203sp2" - - "fastchat-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" - - "tensorflow2.15.0-oe2203sp2" - - "tensorflow2.15.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" - - "pytorch2.1.0-oe2203sp2" - - "pytorch2.1.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" - - "pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" - - "cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" - ValidationError: - description: 接口的入参校验错误时返回的内容格式 - required: - - loc - - msg - - type - type: object - properties: - loc: - title: Location - type: array - items: - anyOf: - - type: string - - type: integer - msg: - title: Message - type: string - type: - title: Error Type +openapi: 3.0.2 +info: + title: compatibility-ai-infra + version: 0.1.0 +servers: + - url: http://ai-infra-service.compatibility-ai-infra.svc.cluster.local:8101 +paths: + /docker/images: + get: + description: 获取所有支持的AI容器信息，返回容器名字和tag + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseData' + /docker/pull: + post: + description: 输入容器镜像名字和容器镜像tag，返回拉取该容器的shell命令 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PullDockerImages' + required: true + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseData' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /docker/run: + post: + description: 输入容器名字和tag，返回运行该容器的shell命令 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RunDockerImages' + required: true + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseData' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' +components: + schemas: + HTTPValidationError: + description: HTTP校验错误 + type: object + properties: + detail: + title: Detail + type: array + items: + $ref: '#/components/schemas/ValidationError' + PullDockerImages: + description: 生成容器拉取命令的接口的入参 + required: + - image_name + - image_tag + type: object + properties: + image_name: + description: 容器镜像的名字,不要包含转义符 + type: string + enum: + - cann + - oneapi-runtime + - oneapi-basekit + - llm-server + - mlflow + - llm + - tensorflow + - pytorch + - cuda + image_tag: + description: 容器镜像的tag，不要包含转义符 + type: string + enum: + - "8.0.RC1-oe2203sp4" + - "cann7.0.RC1.alpha002-oe2203sp2" + - "2024.2.0-oe2403lts" + - "1.0.0-oe2203sp3" + - "2.11.1-oe2203sp3" + - "2.13.1-oe2203sp3" + - "chatglm2_6b-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" + - "llama2-7b-q8_0-oe2203sp2" + - "chatglm2-6b-q8_0-oe2203sp2" + - "fastchat-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" + - "tensorflow2.15.0-oe2203sp2" + - "tensorflow2.15.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" + - "pytorch2.1.0-oe2203sp2" + - "pytorch2.1.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" + - "pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" + - "cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" + ResponseData: + description: 接口返回值的固定格式 + required: + - code + - message + - data + type: object + properties: + code: + description: 状态码 + type: integer + message: + description: 状态信息 + type: string + data: + description: 返回数据 + type: any + RunDockerImages: + description: 生成容器运行命令的接口的入参 + required: + - image_name + - image_tag + type: object + properties: + image_name: + description: 容器镜像的名字，不要包含转义符 + type: string + enum: + - cann + - oneapi-runtime + - oneapi-basekit + - llm-server + - mlflow + - llm + - tensorflow + - pytorch + - cuda + image_tag: + description: 容器镜像的tag，不要包含转义符 + type: string + enum: + - "8.0.RC1-oe2203sp4" + - "cann7.0.RC1.alpha002-oe2203sp2" + - "2024.2.0-oe2403lts" + - "1.0.0-oe2203sp3" + - "2.11.1-oe2203sp3" + - "2.13.1-oe2203sp3" + - "chatglm2_6b-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" + - "llama2-7b-q8_0-oe2203sp2" + - "chatglm2-6b-q8_0-oe2203sp2" + - "fastchat-pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" + - "tensorflow2.15.0-oe2203sp2" + - "tensorflow2.15.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" + - "pytorch2.1.0-oe2203sp2" + - "pytorch2.1.0-cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" + - "pytorch2.1.0.a1-cann7.0.RC1.alpha002-oe2203sp2" + - "cuda12.2.0-devel-cudnn8.9.5.30-oe2203sp2" + ValidationError: + description: 接口的入参校验错误时返回的内容格式 + required: + - loc + - msg + - type + type: object + properties: + loc: + title: Location + type: array + items: + anyOf: + - type: string + - type: integer + msg: + title: Message + type: string + type: + title: Error Type type: string \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/plugin.json" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/plugin.json" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/plugin.json" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/Compatibility-AI-Infra/plugin.json" diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" new file mode 100644 index 00000000..3d894369 --- /dev/null +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" @@ -0,0 +1,35 @@ +# AI容器栈部署指南 + +## 准备工作 + ++ 提前安装 [openEuler Copilot System 命令行（智能 Shell）客户端](../../../使用指南/命令行客户端/命令行助手使用指南.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` 插件文件夹的路径，该变量位于 euler-copilot-helm/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/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/demarcation.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/demarcation.yaml" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/demarcation.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/demarcation.yaml" diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/detection.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/detection.yaml" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/detection.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/detection.yaml" diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/inspection.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/inspection.yaml" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/inspection.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/inspection.yaml" diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/show_profiling.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/show_profiling.yaml" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/show_profiling.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/flows/show_profiling.yaml" diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/openapi.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/openapi.yaml" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/openapi.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/openapi.yaml" diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/plugin.json" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/plugin.json" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/plugin.json" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/euler-copilot-rca/plugin.json" diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" similarity index 67% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" index 39736d97..21823608 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" @@ -2,19 +2,12 @@ ## 准备工作 -+ 在对应需要诊断的机器上安装gala-gopher ++ 在对应需要诊断的机器上安装 gala-gopher -``` -hub.oepkgs.net/a-ops/gala-gopher-profiling-x86_64:930eulercopilot -``` -+ 启动gala-gopher +`hub.oepkgs.net/a-ops/gala-gopher-profiling-x86_64:930eulercopilot` -``` ++ 启动 gala-gopher + +```bash 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 -e GOPHER_HOST_PATH=/host gala-gopher-profiling-x86_64:930eulercopilot ``` - - - - - - diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" similarity index 96% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" index d042505b..d2718f0d 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/data_collection.yaml" @@ -1,15 +1,15 @@ -name: data_collection -description: 采集某一指定ip主机的系统性能指标 -steps: - - name: start - call_type: api - params: - endpoint: POST /performance_metric - next: show_data - - name: show_data - call_type: llm - params: - user_prompt: | - 当前采集到系统性能指标为：{data}, 输出内容请符合markdown规范。 -next_flow: +name: data_collection +description: 采集某一指定ip主机的系统性能指标 +steps: + - name: start + call_type: api + params: + endpoint: POST /performance_metric + next: show_data + - name: show_data + call_type: llm + params: + user_prompt: | + 当前采集到系统性能指标为：{data}, 输出内容请符合markdown规范。 +next_flow: - performance_analysis \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" similarity index 95% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" index 8da64d91..07e2a2ad 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_analysis.yaml" @@ -1,15 +1,15 @@ -name: performance_analysis -description: 分析性能指标并生成性能分析报告 -steps: - - name: start - call_type: api - params: - endpoint: POST /performance_report - next: extract_key - - name: extract_key - call_type: extract - params: - keys: - - data.output -next_flow: +name: performance_analysis +description: 分析性能指标并生成性能分析报告 +steps: + - name: start + call_type: api + params: + endpoint: POST /performance_report + next: extract_key + - name: extract_key + call_type: extract + params: + keys: + - data.output +next_flow: - performance_tuning \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" similarity index 96% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" index 841ad038..e938a0bf 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/flows/performance_tuning.yaml" @@ -1,13 +1,13 @@ -name: performance_tuning -description: 基于性能能分析报告，生成操作系统和Mysql应用的性能优化建议,结果以shell脚本的形式返回 -steps: - - name: start - call_type: api - params: - endpoint: POST /optimization_suggestion - next: extract_key - - name: extract_key - call_type: extract - params: - keys: +name: performance_tuning +description: 基于性能能分析报告，生成操作系统和Mysql应用的性能优化建议,结果以shell脚本的形式返回 +steps: + - name: start + call_type: api + params: + endpoint: POST /optimization_suggestion + next: extract_key + - name: extract_key + call_type: extract + params: + keys: - data.script \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" similarity index 96% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" index 257a7eb3..18ede5a9 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/openapi.yaml" @@ -1,147 +1,147 @@ -openapi: 3.0.2 -info: - title: 智能诊断 - version: 1.0.0 -servers: - - url: http://euler-copilot-tune.euler-copilot.svc.cluster.local:8100 -paths: - /performance_metric: - post: - description: 对指定机器进行性能指标采集，返回指标值 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PerformanceMetricRequestData' - required: true - responses: - '200': - description: Successful Response - content: - application/json: - schema: {} - '422': - description: Validation Error - content: - application/json: - schema: - $ref: '#/components/schemas/HTTPValidationError' - /performance_report: - post: - description: 基于采集到的指标，对指定机器进行性能诊断，生成性能分析报告 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PerformanceReportRequestData' - required: true - responses: - '200': - description: Successful Response - content: - application/json: - schema: {} - '422': - description: Validation Error - content: - application/json: - schema: - $ref: '#/components/schemas/HTTPValidationError' - /optimization_suggestion: - post: - description: 根据性能分析报告，以及指定的机器应用信息，生成调优建议 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OptimizationSuggestionRequestData' - required: true - responses: - '200': - description: Successful Response - content: - application/json: - schema: {} - '422': - description: Validation Error - content: - application/json: - schema: - $ref: '#/components/schemas/HTTPValidationError' -components: - schemas: - HTTPValidationError: - type: object - description: HTTP 校验错误 - properties: - detail: - type: array - items: - $ref: '#/components/schemas/ValidationError' - OptimizationSuggestionRequestData: - type: object - description: 生成优化建议的接口的入参 - required: - - app - - ip - properties: - app: - type: string - description: 应用名称 - default: mysql - enum: - - mysql - - none - ip: - type: string - description: 点分十进制的ipv4地址, 例如192.168.10.43 - example: "192.168.10.43" - PerformanceMetricRequestData: - type: object - description: 性能指标采集的接口的入参 - required: - - app - - ip - properties: - ip: - type: string - description: 点分十进制的ipv4地址, 例如192.168.10.43 - example: "192.168.10.43" - app: - type: string - description: App - default: none - enum: - - mysql - - none - PerformanceReportRequestData: - type: object - description: 生成性能报告接口的入参 - required: - - ip - properties: - ip: - type: string - description: 点分十进制的ipv4地址, 例如192.168.10.43 - example: "192.168.10.43" - ValidationError: - type: object - required: - - loc - - msg - - type - title: ValidationError - properties: - loc: - type: array - items: - anyOf: - - type: string - - type: integer - title: Location - msg: - type: string - title: Message - type: - type: string +openapi: 3.0.2 +info: + title: 智能诊断 + version: 1.0.0 +servers: + - url: http://euler-copilot-tune.euler-copilot.svc.cluster.local:8100 +paths: + /performance_metric: + post: + description: 对指定机器进行性能指标采集，返回指标值 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerformanceMetricRequestData' + required: true + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /performance_report: + post: + description: 基于采集到的指标，对指定机器进行性能诊断，生成性能分析报告 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerformanceReportRequestData' + required: true + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /optimization_suggestion: + post: + description: 根据性能分析报告，以及指定的机器应用信息，生成调优建议 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OptimizationSuggestionRequestData' + required: true + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' +components: + schemas: + HTTPValidationError: + type: object + description: HTTP 校验错误 + properties: + detail: + type: array + items: + $ref: '#/components/schemas/ValidationError' + OptimizationSuggestionRequestData: + type: object + description: 生成优化建议的接口的入参 + required: + - app + - ip + properties: + app: + type: string + description: 应用名称 + default: mysql + enum: + - mysql + - none + ip: + type: string + description: 点分十进制的ipv4地址, 例如192.168.10.43 + example: "192.168.10.43" + PerformanceMetricRequestData: + type: object + description: 性能指标采集的接口的入参 + required: + - app + - ip + properties: + ip: + type: string + description: 点分十进制的ipv4地址, 例如192.168.10.43 + example: "192.168.10.43" + app: + type: string + description: App + default: none + enum: + - mysql + - none + PerformanceReportRequestData: + type: object + description: 生成性能报告接口的入参 + required: + - ip + properties: + ip: + type: string + description: 点分十进制的ipv4地址, 例如192.168.10.43 + example: "192.168.10.43" + ValidationError: + type: object + required: + - loc + - msg + - type + title: ValidationError + properties: + loc: + type: array + items: + anyOf: + - type: string + - type: integer + title: Location + msg: + type: string + title: Message + type: + type: string title: Error Type \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" similarity index 97% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" index 909e58cd..c4b95f57 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/euler-copilot-tune/plugin.json" @@ -1,6 +1,6 @@ -{ - "id": "tune", - "name": "智能性能优化", - "description": "该插件具备以下功能：采集系统性能指标，分析系统性能，推荐系统性能优化建议", - "automatic_flow": false +{ + "id": "tune", + "name": "智能性能优化", + "description": "该插件具备以下功能：采集系统性能指标，分析系统性能，推荐系统性能优化建议", + "automatic_flow": false } \ No newline at end of file diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" new file mode 100644 index 00000000..161f0bbb --- /dev/null +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266/\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" @@ -0,0 +1,55 @@ +# 智能调优部署指南 + +## 准备工作 + ++ 提前安装 [openEuler Copilot System 命令行（智能 Shell）客户端](../../../使用指南/命令行客户端/命令行助手使用指南.md) + ++ 被调优机器需要为 openEuler 2203 LTS-SP3 + ++ 在需要被调优的机器上安装依赖 + +```bash +yum install -y sysstat perf +``` + ++ 被调优机器需要开启SSH 22端口 + ++ 修改 /xxxx/xxxx/values.yaml 文件的 `euler-copilot-tune` 部分，配置需要调优的机器，以及对应机器上的 mysql 的账号名以及密码 + +```yaml +ip：xxxxx +password：xxxx +mysql： + user：xxx + password：xxxx +``` + ++ 修改 /xxxx/xxxx/values.yaml 文件的 `euler-copilot-tune` 部分，将 `enable` 字段改为 `True` + +```bash +enable: True +``` + ++ 更新环境 + +```bash +helm upgrade euler-copilot . +``` + ++ 检查 euler-copilot-tune 目录下的 openapi.yaml 中 `servers.url` 字段，确保调优服务的启动地址被正确设置 + ++ 获取 `$plugin_dir` 插件文件夹的路径，该变量位于 euler-copilot-helm/chart/euler_copilot/values.yaml 中的 `framework`模块 + ++ 如果插件目录不存在，需新建该目录 + ++ 将该目录下的 euler-copilot-tune 文件夹放到 `$plugin_dir` 中 + +```bash +cp -r ./euler-copilot-tune $plugin_dir +``` + ++ 重建 framework pod，重载插件配置 + +```bash +kubectl delete pod framework-xxxx -n 命名空间 +``` diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" deleted file mode 100644 index 25e8340e..00000000 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ /dev/null @@ -1,36 +0,0 @@ -# AI容器栈部署指南 - -## 准备工作 - -+ 提前部署euler-copilot-shell 客户端 - -+ 修改 /xxxx/xxxx/values.yaml 文件的 euler-copilot-tune 部分，将enable字段改为True - -```bash -enable: True -``` - -+ 更新环境 - -```bash -helm upgrade euler-copilot . -``` - -+ 检查Compatibility-AI-Infra目录下的openapi.yaml 中 servers.url 字段，确保AI容器服务的启动地址被正确设置 - -+ 获取 $plugin_dir 插件文件夹的路径，该变量位于 euler-copilot-helm/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/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" deleted file mode 100644 index 9da4736b..00000000 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ /dev/null @@ -1,60 +0,0 @@ -# 插件—智能调优部署指南 - -## 准备工作 - -+ 提前部署euler-copilot-shell 客户端 - -+ 被调优机器需要为 openEuler 2203 LTS-SP3 - -+ 在需要被调优的机器上安装依赖 - -```bash -yum install -y sysstat perf -``` - -+ 被调优机器需要开启SSH 22端口 - - -+ 修改 /xxxx/xxxx/values.yaml 文件的 euler-copilot-tune 部分，配置需要调优的机器，以及对应机器上的mysql的账号名以及密码 - -```bash -ip：xxxxx -password：xxxx -mysql： - user：xxx - password：xxxx -``` - -+ 修改 /xxxx/xxxx/values.yaml 文件的 euler-copilot-tune 部分，将enable字段改为True - -```bash -enable: True -``` - -+ 更新环境 - -```bash -helm upgrade euler-copilot . -``` - -+ 检查euler-copilot-tune目录下的openapi.yaml 中 servers.url 字段，确保调优服务的启动地址被正确设置 - -+ 获取 $plugin_dir 插件文件夹的路径，该变量位于 euler-copilot-helm/chart/euler_copilot/values.yaml 中的framework模块 - -+ 如果插件目录不存在，需新建该目录 - -+ 将该目录下的euler-copilot-tune文件夹放到 $plugin_dir 中 - -```bash -cp -r ./euler-copilot-tune $plugin_dir -``` - -+ 重建 framework pod，重载插件配置 -```bash -kubectl delete pod framework-xxxx -n 命名空间 -``` - - - - - diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203\342\200\224AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203/AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" similarity index 100% rename from "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203\342\200\224AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" rename to "docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203/AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" -- Gitee From c2616b81a86a44968207684206871b2fc8ddd771 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8F=B2=E9=B8=BF=E5=AE=87?= Date: Tue, 22 Oct 2024 09:49:39 +0800 Subject: [PATCH 2/2] =?UTF-8?q?=E4=BF=AE=E5=A4=8D=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 史鸿宇 --- ...Hub\351\203\250\347\275\262\346\214\207\345\215\227.md" | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203/AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203/AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" index c8f46548..2cd8e0d9 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203/AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\351\211\264\346\235\203/AuthHub\351\203\250\347\275\262\346\214\207\345\215\227.md" @@ -2,15 +2,14 @@ ## 准备工作 -+ 将 values.yaml 中的 authHub-web，authHub 的 enable 字段改为True ++ 将 values.yaml 中的 `authHub-web`、`authHub` 的 `enable` 字段改为 `True` -```bash +```yaml enable: True ``` -+ 更新环境 ++ 更新环境 ```bash helm upgrade euler-copilot . ``` - -- Gitee