Metadata-Version: 2.1
Name: ascend-deployer
Version: 7.3.0
Summary: ascend offline installer
Home-page: https://gitcode.com/ascend/ascend-deployer
License: Apache
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >= 3.6
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE

# ascend-deployer
-   [最新消息](#最新消息)
-   [简介](#简介)
-   [目录结构](#目录结构)
-   [版本说明](#版本说明)
-   [兼容性信息](#兼容性信息)
-   [环境部署](#环境部署)
-   [快速入门](#快速入门)
-   [工具限制及注意事项](#工具限制及注意事项)
-   [功能介绍](#功能介绍)
-   [FAQ](#FAQ)
-   [安全声明](#安全声明)
-   [分支维护策略](#分支维护策略)
-   [版本维护策略](#版本维护策略)
-   [免责声明](#免责声明)
-   [License](#License)
-   [建议与交流](#建议与交流)

# 📢最新消息
- **2025-12-06**: 🚫 不再支持 hccl-controller 组件的安装与升级操作
- **2025-12-03**: 🚫 不再支持 tfplugin 组件的安装与升级操作
- **2025-11-25**: 🐧 新增支持在麒麟 Kylin V11 操作系统上部署软件
- **2025-11-21**: 🐧 新增支持在 VesselOS 2.0 操作系统上部署软件
- **2025-11-11**: 📥 支持下载 Ascend 社区软件包 7.2.0 版本
- **2025-09-12**: 🖧 新增昇腾超大规模集群环境的安装部署支持
- **2025-09-11**: 🐧 新增支持在 VesselOS 1.0 操作系统上部署软件
- **2025-09-06**: 🐳 支持在一体机环境部署 MindIE 镜像，并快速拉起 DeepSeek 推理服务
- **2025-09-02**: 🐧 新增支持在 Ubuntu 24.04 操作系统上部署软件
- **2025-08-22**: ☸️ 支持部署多机 PD 分离架构的 DeepSeek 推理服务

# 简介

- 昇腾软件安装部署参考设计，提供系统组件、Python第三方依赖自动下载以及一键式安装的功能，并支持驱动、固件、CANN软件包以及MindCluster的安装。更多详情请参见[ascend-deployer介绍](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0001.html)

# 目录结构

``` 
├── ascend_deployer                          # 主程序目录，包含部署相关的核心脚本和配置
│   ├── ansible_plugin                       # Ansible 插件目录，包含日志、部署信息输出等插件
│   ├── downloader                           # 下载器模块，用于下载 Ascend 相关软件包和依赖
│   │   ├── config                           # 各操作系统下的依赖配置信息
│   │   ├── python_requirements              # 各 Python 版本的依赖包配置
│   │   ├── software                         # 各软件包的下载配置信息（CANN、MindSpore等）
│   │   └── yum_metadata                     # YUM 元数据相关工具
│   ├── playbooks                            # Ansible Playbooks 脚本目录，包含安装、处理、场景等相关剧本
│   ├── tools                                # 工具脚本集合
│   ├── group_vars                           # Ansible 组变量定义目录
│   ├── patch                                # 补丁文件存放目录
│   ├── scripts                              # 部署过程中使用的辅助脚本
│   ├── yamls                                # YAML 配置文件目录
│   ├── library                              # 自定义库文件目录，包含各类安装检查功能模块
│   ├── module_utils                         # Ansible 模块工具目录
│   │   ├── check_library_utils              # 检查库工具
│   │   ├── deepseek_cntr                    # DeepSeek 控制器相关工具
│   │   └── deepseek_pd                      # DeepSeek PD 相关工具
│   ├── templates                            # 模板文件目录
│   ├── large_scale_deploy                   # 大规模部署相关文件目录
│   │   ├── common                           # 公共数据模块
│   │   ├── config_model                     # 配置模型
│   │   ├── handler                          # 库存分割处理器
│   │   ├── process                          # 远程部署任务处理
│   │   ├── tools                            # 大规模部署工具集
│   │   └── view                             # 视图展示模块
│   ├── start_deploy.py                      # 启动部署流程的主入口脚本
│   ├── install.sh                           # 安装脚本
│   ├── large_scale_install.sh               # 大规模部署安装脚本
│   ├── large_scale_deployer.py              # 大规模部署主逻辑脚本
│   ├── inventory_file                       # 默认库存文件
│   ├── ansible.cfg                          # Ansible 配置文件
│   ├── version.json                         # 版本信息文件
│   └── utils.py                             # 工具函数模块，包含版本比较、路径复制等功能
```

# 版本说明

ascend-deployer最新发行版下载链接：[ascend-deployer发行版](https://gitcode.com/Ascend/ascend-deployer/releases)

# 兼容性信息

ascend-deployer支持安装的硬件和部件兼容性请参考：[兼容性查询助手](https://www.hiascend.com/hardware/compatibility)

# 环境部署

ascend-deployer工具有多种方式获取并部署使用，可以参考[ascend-deployer获取方式](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0004.html)

# 快速入门

以下以OpenEuler_22.03LTS_aarch64系统，单台Atlas 800T A2 训练服务器为例，指导开发者快速完成sys_pkg、python、NPU、CANN、toolbox、fault-diag组件的部署。完整的资料请参考：[ascend-deployer安装部署工具](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0001.html)。

1. 以root用户登录待安装设备。
   
2. 执行 `pip3 install ascend-deployer==<version>` 安装ascend-deployer工具。<version>为ascend-deployer工具的版本号，
   建议参考[官网](https://pypi.org/project/ascend-deployer/#history)下载最新发布版本的工具包。如果提示pip3命令不存在，请用户自行安装。

3. 执行下载命令。
   ```shell
   ascend-download --os-list=OpenEuler_22.03LTS_aarch64 --download=NPU,CANN,FaultDiag
   ```
   执行以上命令后，会自动下载好OS所需依赖，CANN软件包和配套的驱动和固件包，以及docker软件等，并存放到$HOME/ascend-deployer/resources目录下。

4. 执行以下安装命令，自动安装部署对应的软件包。（MindCluster集群调度组件除外，该组件安装请参考[ascend-deployer用户指南](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0014.html))。
   ```shell
   ascend-deployer --install=sys_pkg,python,npu,toolkit,kernels,toolbox,fault-diag
   ```
5. 使用python和CANN前，需要根据实际情况配置环境变量，以下内容以配置python和nnae的环境变量为例。
   ```shell
   source /usr/local/ascendrc                   # 配置python环境变量
   source /usr/local/Ascend/toolbox/set_env.sh  # 配置toolbox的环境变量
   ```

# 工具限制及注意事项
ascend-deployer支持下载的OS依赖、软件包及使用限制请参考[支持的软件包及OS](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0068.html)，支持安装部署的组件及相关限制请参考[支持安装及升级的软件包](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0056.html)


# 功能介绍

ascend-deployer组件提供开局时批量部署python、NPU、CANN、toolbox、fault-diag和MindCluster集群调度等功能。具体特性介绍如下：

| 功能名称   | 介绍                                                                                                            | 
|--------|---------------------------------------------------------------------------------------------------------------|
| 下载软件包  | [link](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0008.html) |
| 安装部署软件 | [link](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0013.html)                                                                                                 |
| 升级软件   | [link](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0015.html)                                                                                                  |


# FAQ

相关FAQ请参考：[FAQ](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0044.html)。

# 安全声明

- ascend-deployer部署时会安装必要的一些第三方依赖，请自行对部署后的环境漏洞扫描修复和对系统安全加固。
- 配置inventory_file和large_scale_inventory.ini时，为了安全请优先配置[SSH免密](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0012.html)。
- 通信矩阵详见：[通信矩阵](https://gitcode.com/Ascend/ascend-deployer/wiki/%E9%80%9A%E4%BF%A1%E7%9F%A9%E9%98%B5.md#%E9%80%9A%E4%BF%A1%E7%9F%A9%E9%98%B5)
- 公网地址详见：[公网地址](https://www.hiascend.com/document/detail/zh/mindcluster/72rc1/deployer/deployerug/deployer_0058.html)

# 分支维护策略

版本分支的维护阶段如下：

| 状态          | 时间     | 说明                                                      |
|-------------|--------|---------------------------------------------------------|
| 计划          | 1-3个月  | 计划特性                                                    |
| 开发          | 3个月    | 开发新特性并修复问题，定期发布新版本                                      | 
| 维护          | 3-12个月 | 常规分支维护3个月，长期支持分支维护12个月。对重大BUG进行修复，不合入新特性，并视BUG的影响发布补丁版本 | 
| 生命周期终止（EOL） | N/A    | 分支不再接受任何修改                                              |

# 版本维护策略

| 版本       | 维护策略 | 当前状态 | 发布日期       | 后续状态                 | EOL日期      |
|----------|------|------|------------|----------------------|------------|
| dev      | 长期支持 | 开发   | 在研分支，不发布   | -                    | -          |
| v7.3.0   | 长期支持 | 开发   | 在研分支，未发布   | -                    | -          |
| v7.2.RC1 | 常规分支 | 开发   | 在研分支，未发布 | -                    | -          |
| v7.1.RC1 | 常规分支 | EOL   | 2025-07-24 |                      | 2025-10-24 |
| v7.0.RC1 | 常规分支 | EOL   | 2025-04-27 |                      | 2025-07-27 |
| v6.0.0   | 长期支持 | 维护   | 2024-12-31 | 预计2025-12-31起进入无维护状态 |            |
| v6.0.RC3 | 常规分支 | EOL   | 2024-11-20 |                      | 2025-02-20 |
| v6.0.RC2 | 常规分支 | EOL   | 2024-11-20 |                      | 2025-02-20 |
| v6.0.RC1 | 常规分支 | EOL   | 2024-11-20 |                      | 2025-02-20 |
| v5.0.0.3 | 长期支持 | EOL  | 2023-11-20 |                      | 2024-11-20 |


# 免责声明

- 本代码仓库中包含多个开发分支，这些分支可能包含未完成、实验性或未测试的功能。在正式发布之前，这些分支不应被用于任何生产环境或依赖关键业务的项目中。请务必仅使用我们的正式发行版本，以确保代码的稳定性和安全性。 使用开发分支所导致的任何问题、损失或数据损坏，本项目及其贡献者概不负责。本仓库提供Ansible运维示例，请勿直接用于生产环境。 
- 正式版本请参考ascend-deployer正式release版本<https://gitcode.com/Ascend/ascend-deployer/releases>

# License

ascend-deployer以Apache 2.0许可证许可，对应许可证文本可查阅[ascend-deployer根目录](https://gitcode.com/Ascend/ascend-deployer/blob/dev/LICENSE)。

# 建议与交流

欢迎大家为社区做贡献。如果有任何疑问或建议，请提交[issue](https://gitcode.com/Ascend/ascend-deployer/issues)，我们会尽快回复。感谢您的支持。
