Star53
32
代码
代码
Issues
Pull Requests2
项目讨论
Wiki
分析
Star53
32
已合并
优化文档结构与排版 #54
printSSS创建于 7 天前
优化文档结构与排版 #54
已合并
printSSS创建于 7 天前
从printSSS/OMSDKmaster合入到Ascend/OMSDKmaster
共 2 个文件变更+128-173
MREADME.md+68-168
@@ -1,137 +1,48 @@
1# OM SDK1# OM SDK
2 2 
3-- [最新消息](#最新消息)3+[![Ascend](https://img.shields.io/badge/Community-Ascend-blue.svg)](https://www.hiascend.com/) [![License](https://badgen.net/badge/License/MulanPSL-2.0/blue)](LICENSE.md) [![MindEdge](https://img.shields.io/badge/Community-MindEdge-blue.svg)](https://www.hiascend.com/cn/developer/software/mindedge);
4-- [简介](#简介)
5-- [目录结构](#目录结构)
6-- [版本说明](#版本说明)
7-- [兼容性信息](#兼容性信息)
8-- [环境部署](#环境部署)
9-- [编译流程](#编译流程)
10-- [快速入门](#快速入门)
11-- [功能介绍](#功能介绍)
12-- [API参考](#api参考)
13-- [安全声明](#安全声明)
14-- [分支维护策略](#分支维护策略)
15-- [版本维护策略](#版本维护策略)
16-- [免责声明](#免责声明)
17-- [License](#license)
18-- [贡献声明](#贡献声明)
19-- [建议与交流](#建议与交流)
20 4 
21-## 最新消息5+## ✨ 最新消息
22 6 
23-- [2025.12.30]：🚀 OM SDK开源发布7+🔹 **[2026.04.25]**：🚀 [OM SDK 26.0.0 Release 版本发布](https://gitcode.com/Ascend/OMSDK/releases/v26.0.0)<br>
8+🔹 **[2025.12.30]**：🚀 OM SDK 开源发布
24 9 
25-## 简介10+## ℹ️ 简介
26 11 
27-OM SDK作为开发态组件，使能第三方合作伙伴基于昇腾AI处理器快速搭建智能边缘硬件管理平台，自定义构建设备运维系统，简化设备运维部署。12+OM SDK 作为开发态组件，使能第三方合作伙伴基于昇腾 AI 处理器快速搭建智能边缘硬件管理平台，自定义构建设备运维系统，简化设备运维部署。
28 13 
29-<div align="center">14+## 📂 目录结构
30- 
31-[![Zread](https://img.shields.io/badge/Zread-Ask_AI-_.svg?style=flat&color=0052D9&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/Ascend/OMSDK)&nbsp;&nbsp;&nbsp;&nbsp;
32-[![DeepWiki](https://img.shields.io/badge/DeepWiki-Ask_AI-_.svg?style=flat&color=0052D9&labelColor=000000&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/Ascend/OMSDK)
33- 
34-</div>
35- 
36-## 目录结构
37 15 
38关键目录如下，详细目录介绍参见[项目目录](docs/zh/dir_structure.md)。16关键目录如下，详细目录介绍参见[项目目录](docs/zh/dir_structure.md)。
39 17 
40- om-sdk # 项目根目录18+```text
41- ├── build # 构建相关目录19+om-sdk # 项目根目录
42- ├── docs # 文档目录20+├── build # 构建相关目录
43- │ └── zh # 中文文档目录21+├── docs # 文档目录
44- └── src # 源码目录22+│ └── zh # 中文文档目录
45- ├── om # OM SDK 组件代码23+└── src # 源码目录
46- └── om-web # OM Web 前端组件代码24+ ├── om # OM SDK 组件代码
47- 25+ └── om-web # OM Web 前端组件代码
48-## 版本说明
49- 
50-OM SDK版本配套详情请参考：[版本配套说明](docs/zh/release_notes_OMSDK.md#版本配套说明)。
51- 
52-## 兼容性信息
53- 
54-表3 OM SDK支持的产品和产品所支持的操作系统
55-<table>
56- <tr>
57- <th>产品名称</th>
58- <th>操作系统</th>
59- </tr>
60- <tr>
61- <td>Atlas 200I A2 加速模块（RC模式）</td>
62- <td rowspan="2">OpenEuler 22.03<br>Ubuntu 22.04</td>
63- </tr>
64- <tr>
65- <td>Atlas 200I DK A2 开发者套件</td>
66- </tr>
67-</table>
68- 
69-## 环境部署
70- 
71-在安装和使用前，用户需要了解安装须知、环境准备，具体内容请参考"[安装部署](docs/zh/user_guide/installation_guide.md#安装部署)"章节文档。
72- 
73-- [获取软件包](./docs/zh/user_guide/installation_guide.md#获取软件包)
74-- [准备安装环境](./docs/zh/user_guide/installation_guide.md#准备安装环境)
75-- [通过命令行安装](./docs/zh/user_guide/installation_guide.md#通过命令行安装)
76- 
77-## 编译流程
78- 
79-### 依赖准备
80- 
81-OM SDK构建仅支持ARM64 CPU。
82- 
83-本节以ubuntu22.04系统为例，介绍如何通过源码编译生成OM软件包。
84- 
85-执行OM SDK编译前，请保证环境上安装了必要编译工具和依赖库，参考安装命令如下：
86- 
87-```shell
88-apt-get update && apt-get upgrade -y
89-apt-get install -y python3 python3-pip build-essential zip unzip dos2unix git cmake autoconf automake libtool curl
90- 
91-# 由于ubuntu 22.04默认的node.js版本过低，需要手动下载安装
92-# 使用国内镜像下载node.js
93-NODE_MIRROR_URL=https://mirrors.huaweicloud.com/nodejs
94-# 编译OM SDK要求node.js版本最低为16.0
95-NODE_VERSION=v16.20.2
96-NODE_INSTALL_DIR=/usr/local/lib/nodejs
97-mkdir -p $NODE_INSTALL_DIR
98-curl -sSL $NODE_MIRROR_URL/$NODE_VERSION/node-$NODE_VERSION-linux-arm64.tar.gz | tar -zxvf - -C $NODE_INSTALL_DIR
99-find $NODE_INSTALL_DIR/node-$NODE_VERSION-linux-arm64/bin -mindepth 1 -exec sh -c 'ln -s {} /usr/bin/$(basename {})' \;
100```26```
101 27 
102-### 编译28+## ⚙️ 功能介绍
103 29 
104-1. 拉取OM SDK整体源码，例如放在/home目录下。30+边缘管理系统支持对边缘设备进行初始化配置、硬件监测、软件安装、系统运维等功能；同时还支持与 SmartKit 软件、华为 FusionDirector 管理软件对接，实现集中式运维管理。具体内容请参考 [Web功能介绍](docs/zh/user_guide/usage.md#web功能介绍) 章节文档。
105-2. 进入/home/OMSDK/build目录
106 31 
107- ```shell32+| 功能类型 | 详细功能介绍 |
108- cd /home/OMSDK/build33+|:------|:----------------------------------------------------------------------------------------------------------------------------------|
109- ```34+| 硬件管理 | <ul><li>硬件信息查询</li><li>硬件故障检测</li></ul> |
35+| 软件管理 | <ul><li>系统 OS、驱动固件升级</li><li>软件信息查询</li><li>一键式开局和免软调上线</li><li>OM SDK 的安装和升级</li></ul> |
36+| 时间管理 | <ul><li>系统时区、系统时间配置</li><li>支持 NTP 从服务器同步时间</li></ul> |
37+| 网络管理 | <ul><li>支持 ETH、WiFi、LTE 等多种网络设备配置</li><li>支持手动配置系统网口的 IP、端口、VLAN、网关、DNS</li><li>支持 DHCP 从 Server 端获取系统 IP</li></ul> |
38+| 存储管理 | <ul><li>支持查询和配置本地存储</li><li>查询系统分区、存储容量和分区健康状态</li><li>支持配置、查询 NFS 存储系统，如 NFS 挂载，容量显示，连接健康状态</li></ul> |
39+| 用户管理 | <ul><li>支持密码有效期，登录规则、弱口令设置、查询，支持用户密码修改</li><li>支持用户可定制化的安全策略，支持客户可信根导入</li><li>支持 Web 证书导入、查询和有效期检查</li></ul> |
40+| 系统监测 | <ul><li>支持告警上报，告警屏蔽、历史告警查询、支持当前告警显示</li><li>支持客户增量设备、关键进程的告警集成显示、管理</li><li>系统支持安全日志、操作日志、运行日志、黑匣子记录，支持日志收集、查询、远程 syslog</li></ul> |
41+| 北向接口 | <ul><li>系统功能支持 FusionDirector 集中纳管协议，支持 RESTful 开放接口，RESTful 满足服务器北向接口标准</li></ul> |
110 42 
111-3. 修改组件版本配置文件service_config.ini中om-sdk-version字段值为所需编译版本，默认值如下：43+## 🚀 快速入门
112 44 
113- ```text45+安装 OM SDK 后，可登录边缘管理系统进行基础操作、系统管理和数据配置。具体内容请参考 [新手入门](docs/zh/user_guide/usage.md#新手入门) 章节文档。
114- om-sdk-version=7.3.0
115- ```
116- 
117-4. (可选)通过环境变量NPM_REGISTRY_MIRROR设置npm镜像地址，用户可以根据自身场景修改为其它的npm镜像地址。默认值如下：
118- 
119- ```shell
120- export NPM_REGISTRY_MIRROR=https://repo.huaweicloud.com/repository/npm
121- ```
122- 
123-5. 执行以下命令，执行构建脚本：
124- 
125- ```shell
126- dos2unix *.sh && chmod +x *.sh
127- ./build_all.sh
128- ```
129- 
130-6. 执行完成后，可在/home/OMSDK/output目录下获取编译完成的软件包。
131- 
132-## 快速入门
133- 
134-安装OM SDK后，可登录边缘管理系统进行基础操作、系统管理和数据配置。具体内容请参考"[新手入门](docs/zh/user_guide/usage.md#新手入门)"章节文档。
135 46 
136- 用户登录47- 用户登录
137- 基础操作48- 基础操作
@@ -139,28 +50,23 @@ find $NODE_INSTALL_DIR/node-$NODE_VERSION-linux-arm64/bin -mindepth 1 -exec sh -
139- 管理50- 管理
140- 设置51- 设置
141 52 
142-## 功能介绍53+## 📦 安装指南
143 54 
144-边缘管理系统支持对边缘设备进行初始化配置、硬件监测、软件安装、系统运维等功能；同时还支持与SmartKit软件、华为FusionDirector管理软件对接，实现集中式运维管理。具体内容请参考"[Web功能介绍](docs/zh/user_guide/usage.md#web功能介绍)"章节文档。55+在安装和使用前，用户需要了解安装须知、环境准备，具体内容请参考 [安装部署](docs/zh/user_guide/installation_guide.md#安装部署) 章节文档。
145 56 
146-表4 边缘管理系统功能介绍57+- [获取软件包](./docs/zh/user_guide/installation_guide.md#获取软件包)
58+- [准备安装环境](./docs/zh/user_guide/installation_guide.md#准备安装环境)
59+- [通过命令行安装](./docs/zh/user_guide/installation_guide.md#通过命令行安装)
147 60 
148-| 功能类型 | 详细功能介绍 |61+## API 参考
149-|:-----|:----------------------------------------------------------------------------------------------------------------------------------|
150-| 硬件管理 | <ul><li>硬件信息查询</li><li>硬件故障检测</li></ul>|
151-| 软件管理 | <ul><li>系统OS、驱动固件升级</li><li>软件信息查询</li><li>一键式开局和免软调上线</li><li>OM SDK的安装和升级</li></ul>|
152-| 时间管理 | <ul><li>系统时区、系统时间配置</li><li>支持NTP从服务器同步时间</li></ul>|
153-| 网络管理 | <ul><li>支持ETH、WiFi、LTE等多种网络设备配置</li><li>支持手动配置系统网口的IP、端口、VLAN、网关、DNS</li><li>支持DHCP从Server端获取系统IP</li></ul>|
154-| 存储管理 | <ul><li>支持查询和配置本地存储</li><li>查询系统分区、存储容量和分区健康状态</li><li>支持配置、查询NFS存储系统，如NFS挂载，容量显示，连接健康状态</li></ul>|
155-| 用户管理 | <ul><li>支持密码有效期，登录规则、弱口令设置、查询，支持用户密码修改</li><li>支持用户可定制化的安全策略，支持客户可信根导入</li><li>支持Web证书导入、查询和有效期检查</li></ul>|
156-| 系统监测 | <ul><li>支持告警上报，告警屏蔽、历史告警查询、支持当前告警显示</li><li>支持客户增量设备、关键进程的告警集成显示、管理</li><li>系统支持安全日志、操作日志、运行日志、黑匣子记录，支持日志收集、查询、远程syslog</li></ul>|
157-| 北向接口 |<ul><li>系统功能支持FusionDirector集中纳管协议，支持RESTful开放接口，RESTful满足服务器北向接口标准</li></ul>|
158 62 
159-## API参考63+API 请参考 [RESTful 接口](docs/zh/secondary_development/api/RESTful_api.md) 和 [云边协同接口](docs/zh/secondary_development/api/collaboration_api.md)。
160 64 
161-API请参考"[RESTful接口](docs/zh/secondary_development/api/RESTful_api.md)"和"[云边协同接口](docs/zh/secondary_development/api/collaboration_api.md)"。65+## 🗺️ Roadmap
162 66 
163-## 安全声明67+[Roadmap](https://gitcode.com/Ascend/OMSDK/issues)
68+ 
69+## 🔒 安全声明
164 70 
165- 请参考[安全配置和加固](docs/zh/user_guide/security_hardening.md#安全配置和加固)对系统进行安全加固。71- 请参考[安全配置和加固](docs/zh/user_guide/security_hardening.md#安全配置和加固)对系统进行安全加固。
166- 安全加固建议中的安全加固措施为基本的加固建议项。用户应根据自身业务，重新审视整个系统的网络安全加固措施。72- 安全加固建议中的安全加固措施为基本的加固建议项。用户应根据自身业务，重新审视整个系统的网络安全加固措施。
@@ -168,51 +74,45 @@ API请参考"[RESTful接口](docs/zh/secondary_development/api/RESTful_api.md)"
168- 公网地址详见：[公网地址](docs/zh/user_guide/appendix.md#公网地址)74- 公网地址详见：[公网地址](docs/zh/user_guide/appendix.md#公网地址)
169- 用户信息列表详见：[用户信息列表](docs/zh/user_guide/appendix.md#用户信息列表)75- 用户信息列表详见：[用户信息列表](docs/zh/user_guide/appendix.md#用户信息列表)
170 76 
171-## 分支维护策略77+## 🔀 版本维护策略
172 78 
173-版本分支的维护阶段如下：79+| 版本 | 维护策略 | 当前状态 | 发布日期 | 后续状态 | EOL 日期 |
80+|------|---------|---------|---------|---------|---------|
81+| master | 长期支持 | 开发 | 在研分支，不发布 | - | - |
174 82 
175-| 状态 | 时间 | 说明 |83+## 🛠️ 贡献指南
176-|-------------|--------|---------------------------------------------------------|
177-| 计划 | 1-3个月 | 计划特性 |
178-| 开发 | 3个月 | 开发新特性并修复问题，定期发布新版本 |
179-| 维护 | 3-12个月 | 常规分支维护3个月，长期支持分支维护12个月。对重大BUG进行修复，不合入新特性，并视BUG的影响发布补丁版本 |
180-| 生命周期终止（EOL） | N/A | 分支不再接受任何修改 |
181 84 
182-## 版本维护策略85+欢迎参与项目贡献，贡献流程和规范请参见 [贡献指南](CONTRIBUTING.md)。
183 86 
184-| 版本 | 维护策略 | 当前状态 | 发布日期 | 后续状态 | EOL日期 |87+## ⚖️ 相关说明
185-|----------|------|------|------------|------|------------|88+ 
186-| master | 长期支持 | 开发 | 在研分支，不发布 | - | - |89+- 《[版本说明](docs/zh/release_notes_OMSDK.md)》
90+- 《[安全加固](docs/zh/user_guide/security_hardening.md)》
91+- 《[许可证声明](LICENSE.md)》
92+- 《[文档许可证声明](./docs/LICENSE.md)》
93+- 《[免责声明](#免责声明)》
187 94 
188## 免责声明95## 免责声明
189 96 
190-- 本代码仓库中包含多个开发分支，这些分支可能包含未完成、实验性或未测试的功能。在正式发布之前，这些分支不应被用于任何生产环境或依赖关键业务的项目中。请务必仅使用我们的正式发行版本，以确保代码的稳定性和安全性。97+- 本代码仓库中包含多个开发分支，这些分支可能包含未完成、实验性或未测试的功能。在正式发布之前，这些分支不应被用于任何生产环境或依赖关键业务的项目中。请务必仅使用我们的正式发行版本，以确保代码的稳定性和安全性。使用开发分支所导致的任何问题、损失或数据损坏，本项目及其贡献者概不负责。
191- 使用开发分支所导致的任何问题、损失或数据损坏，本项目及其贡献者概不负责。98+- 正式版本请参考正式 release 版本：<https://gitcode.com/Ascend/OMSDK/releases>
192-- 正式版本请参考正式release版本: <https://gitcode.com/Ascend/OMSDK/releases>
193 99 
194## License100## License
195 101 
196-OM SDK以Mulan PSL v2许可证许可，对应许可证文本可查阅[LICENSE](LICENSE.md)。102+OM SDK 以 Mulan PSL v2 许可证许可，对应许可证文本可查阅 [LICENSE](LICENSE.md)。OM SDK 目录下的文档使用 CC-BY 4.0 许可证，具体请参见 [LICENSE](./docs/LICENSE.md) 文件。
197-介绍OM SDK目录下的文档使用CC-BY4.0许可证，具体请参加[LICENSE](./docs/LICENSE.md)文件。
198 103 
199-## 贡献声明104+## 兼容性信息
200 105 
201-1. 提交错误报告：如果您在OM SDK中发现了一个不存在安全问题的漏洞，请在OM SDK仓库中的Issues中搜索，以防该漏洞被重复提交，如果找不到漏洞可以创建一个新的Issues。如果发现了一个安全问题请不要将其公开，请参阅安全问题处理方式。提交错误报告时应该包含完整信息。106+| 产品名称 | 操作系统 |
202-2. 安全问题处理：本项目中对安全问题处理的形式，请通过邮箱通知项目核心人员确认编辑。107+|---------|---------|
203-3. 解决现有问题：通过查看仓库的Issues列表可以发现需要处理的问题信息, 可以尝试解决其中的某个问题。108+| Atlas 200I A2 加速模块（RC 模式） | OpenEuler 22.03<br>Ubuntu 22.04 |
204-4. 如何提出新功能：请使用Issues的Feature标签进行标记，我们会定期处理和确认开发。109+| Atlas 200I DK A2 开发者套件 | OpenEuler 22.03<br>Ubuntu 22.04 |
205-5. 开始贡献：
206- - Fork本项目的仓库
207- - Clone到本地
208- - 创建开发分支
209- - 本地自测，提交前请通过所有的单元测试，包括为您要解决的问题新增的单元测试
210- - 提交代码
211- - 新建Pull Request
212- - 代码检视，您需要根据评审意见修改代码，并重新提交更新。此流程可能涉及多轮迭代
213- - 当您的PR获得足够数量的检视者批准后，Committer会进行最终审核
214- - 审核和测试通过后，CI会将您的PR合并入到项目的主干分支
215 110 
216-## 建议与交流111+## 🤝 建议与交流
217 112 
218-欢迎大家为社区做贡献。如果有任何疑问或建议，请提交[issues](https://gitcode.com/Ascend/OMSDK/issues)，我们会尽快回复。感谢您的支持。113+欢迎大家通过以下方式提出问题、交流讨论。
114+ 
115+| 资源 | 说明 |
116+|------|------|
117+| [创建 Issue](https://gitcode.com/Ascend/OMSDK/issues) | 提交 Bug、需求或建议 |
118+| [社区任务](https://gitcode.com/Ascend/OMSDK/issues) | 查看和认领社区任务 |
Mdocs/zh/user_guide/installation_guide.md+60-5
@@ -82,11 +82,66 @@ OM SDK提供安装脚本，通过install.sh命令安装软件包。
82 Install MindXOM success, MindXOM service is ready.82 Install MindXOM success, MindXOM service is ready.
83 ```83 ```
84 84 
85- > [!NOTE] 85+ > [!NOTE]
86 >- 第一次登录成功后，需要修改admin账号。86 >- 第一次登录成功后，需要修改admin账号。
87 >- 安装操作的运行日志可以通过**tail -f /var/plog/upgrade.log**查看。87 >- 安装操作的运行日志可以通过**tail -f /var/plog/upgrade.log**查看。
88 >- install.sh命令说明请参见[install.sh命令](./appendix.md#installsh命令)。88 >- install.sh命令说明请参见[install.sh命令](./appendix.md#installsh命令)。
89 89 
90+# 源码编译<a name="ZH-CN_TOPIC_0000001634859226"></a>
91+ 
92+## 编译依赖<a name="ZH-CN_TOPIC_0000001634738586"></a>
93+ 
94+OM SDK 构建仅支持 ARM64 CPU。
95+ 
96+本节以 ubuntu22.04 系统为例，介绍如何通过源码编译生成 OM 软件包。
97+ 
98+执行 OM SDK 编译前，请保证环境上安装了必要编译工具和依赖库，参考安装命令如下：
99+ 
100+```shell
101+apt-get update && apt-get upgrade -y
102+apt-get install -y python3 python3-pip build-essential zip unzip dos2unix git cmake autoconf automake libtool curl
103+ 
104+# 由于 ubuntu 22.04 默认的 node.js 版本过低，需要手动下载安装
105+# 使用国内镜像下载 node.js
106+NODE_MIRROR_URL=https://mirrors.huaweicloud.com/nodejs
107+# 编译 OM SDK 要求 node.js 版本最低为 16.0
108+NODE_VERSION=v16.20.2
109+NODE_INSTALL_DIR=/usr/local/lib/nodejs
110+mkdir -p $NODE_INSTALL_DIR
111+curl -sSL $NODE_MIRROR_URL/$NODE_VERSION/node-$NODE_VERSION-linux-arm64.tar.gz | tar -zxvf - -C $NODE_INSTALL_DIR
112+find $NODE_INSTALL_DIR/node-$NODE_VERSION-linux-arm64/bin -mindepth 1 -exec sh -c 'ln -s {} /usr/bin/$(basename {})' \;
113+```
114+ 
115+## 编译步骤<a name="ZH-CN_TOPIC_0000001584637369"></a>
116+ 
117+1. 拉取 OM SDK 整体源码，例如放在 `/home` 目录下。
118+2. 进入 `/home/OMSDK/build` 目录。
119+ 
120+ ```shell
121+ cd /home/OMSDK/build
122+ ```
123+ 
124+3. 修改组件版本配置文件 `service_config.ini` 中 `om-sdk-version` 字段值为所需编译版本，默认值如下：
125+ 
126+ ```text
127+ om-sdk-version=7.3.0
128+ ```
129+ 
130+4. （可选）通过环境变量 `NPM_REGISTRY_MIRROR` 设置 npm 镜像地址，用户可以根据自身场景修改为其它 npm 镜像地址。默认值如下：
131+ 
132+ ```shell
133+ export NPM_REGISTRY_MIRROR=https://repo.huaweicloud.com/repository/npm
134+ ```
135+ 
136+5. 执行以下命令，执行构建脚本：
137+ 
138+ ```shell
139+ dos2unix *.sh && chmod +x *.sh
140+ ./build_all.sh
141+ ```
142+ 
143+6. 执行完成后，可在 `/home/OMSDK/output` 目录下获取编译完成的软件包。
144+ 
90# 升级<a name="ZH-CN_TOPIC_0000001634859225"></a>145# 升级<a name="ZH-CN_TOPIC_0000001634859225"></a>
91 146 
92## 升级前必读<a name="ZH-CN_TOPIC_0000001634738585"></a>147## 升级前必读<a name="ZH-CN_TOPIC_0000001634738585"></a>
@@ -107,7 +162,7 @@ OM SDK提供安装脚本，通过install.sh命令安装软件包。
107 162 
1081. 获取软件包。1631. 获取软件包。
109 164 
110- > [!NOTE] 165+ > [!NOTE]
111 > 若用户想要升级Atlas 200I A2 加速模块的驱动，可以参见《[Atlas 200I A2 加速模块 驱动开发指南](https://support.huawei.com/enterprise/zh/doc/EDOC1100541055/426cffd9?idPath=23710424|251366513|22892968|252309141|254411267)》的“升级驱动”章节进行操作。166 > 若用户想要升级Atlas 200I A2 加速模块的驱动，可以参见《[Atlas 200I A2 加速模块 驱动开发指南](https://support.huawei.com/enterprise/zh/doc/EDOC1100541055/426cffd9?idPath=23710424|251366513|22892968|252309141|254411267)》的“升级驱动”章节进行操作。
112 167 
1132. 升级固件。支持通过边缘管理系统的Web界面升级或者通过FusionDirector实现升级操作。1682. 升级固件。支持通过边缘管理系统的Web界面升级或者通过FusionDirector实现升级操作。
@@ -153,7 +208,7 @@ OM SDK提供安装脚本，通过install.sh命令安装软件包。
153 208 
154整体升级的操作指导请参见《[FusionDirector 操作指南](https://support.huawei.com/enterprise/zh/doc/EDOC1100317179/426cffd9?idPath=23710424|251364417|251364851|252309137|23015464)》中的“升级管理 \> 固件/驱动升级”章节。209整体升级的操作指导请参见《[FusionDirector 操作指南](https://support.huawei.com/enterprise/zh/doc/EDOC1100317179/426cffd9?idPath=23710424|251364417|251364851|252309137|23015464)》中的“升级管理 \> 固件/驱动升级”章节。
155 210 
156-> [!NOTE] 211+> [!NOTE]
157> 通过FusionDirector升级固件的流程中包含固件包的下载。固件包的下载支持断点续传功能，即下载过程中如果出现网络中断或异常，会导致下载失败。如果用户再次执行升级操作，则固件包会从上次下载失败的位置继续下载，无需重新完整的下载，节省下载时间。212> 通过FusionDirector升级固件的流程中包含固件包的下载。固件包的下载支持断点续传功能，即下载过程中如果出现网络中断或异常，会导致下载失败。如果用户再次执行升级操作，则固件包会从上次下载失败的位置继续下载，无需重新完整的下载，节省下载时间。
158 213 
159**升级后检查<a name="section1092321532713"></a>**214**升级后检查<a name="section1092321532713"></a>**
@@ -188,6 +243,6 @@ OM SDK提供安装脚本，通过install.sh命令安装软件包。
188 Uninstall MindXOM success.243 Uninstall MindXOM success.
189 ```244 ```
190 245 
191- > [!NOTE] 246+ > [!NOTE]
192- > 卸载运行日志可以通过**tail -f /var/plog/upgrade.log**查看。 247+ > 卸载运行日志可以通过**tail -f /var/plog/upgrade.log**查看。
193 > uninstall.sh命令说明请参见[uninstall.sh命令](./appendix.md#uninstallsh命令)。248 > uninstall.sh命令说明请参见[uninstall.sh命令](./appendix.md#uninstallsh命令)。