install参数说明

用户根据实际需要选择对应参数完成安装。

命令格式：

方式一：通过下载ZIP包解压使用bash install.sh [options]
方式二：通过pip命令安装MindCluster Ascend Deployer使用ascend-deployer [options]

参数说明请参见表1。表中各参数的可选参数范围可通过执行bash install.sh --help查看。

表1 参数说明
参数	说明
--help, -h	查询帮助信息。
--check	检查环境，支持检查与待安装设备的连通性，待安装设备对工具、待安装软件包的兼容性。该参数需配合“--install=<package_name>”、“--install-scene=<scene_name>”、“--upgrade=<package_name>”一起使用。使用--check时，不可使用--skip_check参数。
--check_mode	选择检查模式，支持快速全量检查，统一展示报错数据，生成检查结果文件。具体请见检查结果文件。可选参数：fast（快速检查，遇到异常即退出）、full（全量检查）。默认为full。该参数需配合“--install=<package_name>”、“--install-scene=<scene_name>”、“--upgrade=<package_name>”、--check一起使用。使用--check_mode时，不可使用--skip_check参数。
--skip_check	用于决定是否执行安装检查。检查项主要为用户、配置、依赖、兼容性、卡的健康状态等。该参数可以配合“--install=<package_name>”、“--install-scene=<scene_name>”、“--upgrade=<package_name>”一起使用。使用--skip_check时，不可使用--check和--check_mode参数。
--clean	清理待安装设备用户家目录下的resources目录和resources_{arch}.tar。
--nocopy	在批量安装时不进行资源拷贝。该参数需要配合“--install=<package_name>”或“--install-scene=<scene_name>”、“--upgrade=<package_name>”一起使用。使用示例：bash install.sh --install=python --nocopy
--only_copy	在批量安装时进行资源拷贝。仅对要安装的软件进行资源拷贝，但不执行具体的安装，与--nocopy互斥。该参数需要配合“--install=<package_name>”或“--install-scene=<scene_name>”、“--upgrade=<package_name>”一起使用。使用示例：bash install.sh --install=python --only_copy
--force_upgrade_npu	当不是所有卡异常时，可强制升级NPU。
--verbose	对每个任务的安装状态进行详细打印。该参数需要配合install或install-scene使用。使用示例：bash install.sh --install=python --verbose（打印python安装的详细信息）。
--stdout_callback=<callback_name>	设置命令执行的输出格式，可用的参数通过"ansible-doc -t callback -l"命令查看。
--install=<package_name>	指定软件安装。安装的软件包请参见支持安装及升级的软件包。
--upgrade=<package_name>	指定软件升级。可选参数：npu(driver、firmware)、mcu、nnae、nnrt、toolkit、kernels、toolbox、fault-diag、ascend-device-plugin、ascend-docker-runtime、noded、npu-exporter、volcano、ascend-operator、resilience-controller、clusterd
--install-scene=<scene_name>	指定场景安装。安装场景请参见支持安装及升级场景。
--patch=<package_name>	指定软件打补丁。可选参数：nnae、nnrt、tfplugin、toolkit
--patch-rollback=<package_name>	指定软件的补丁回退。可选参数：nnae、nnrt、tfplugin、toolkit
--test=<target>	检查指定组件的版本及能否正常工作。可选参数：all、driver、firmware、mcu、mindspore、nnae、nnrt、pytorch、tensorflow、tfplugin、toolbox、toolkit、 ascend-device-plugin、ascend-docker-runtime、hccl-controller、noded、npu-exporter、volcano、ascend-operator、resilience-controller、clusterd、mindie_image。
--hccn	配置HCCN网络。
--hccn --check	对HCCN网络进行检测。

检查结果文件示例

使用--check_mode参数，在~/.ascend_deployer/deploy_info/路径下，将生成check_res_output.json检查报告，准确提示错误信息。结果示例如下显示：

{
  "CheckList": [
    {
      "check_item": "check_card",
      "desc_en": "Check NPU card compatibility",
      "desc_zh": "检查NPU卡兼容性",
      "tip_en": "",
      "tip_zh": ""
    },
  "check_k8s_version": {
        "check_item": "check_k8s_version",
        "desc_en": "Judgment: 1. kubelet, kubectl, and kubeadm all exist"
                   "2. kubelet --version == kubeadm version == kubectl version "
                   "3.kubelet version < 1.29 "
                   "4. kubelet version >=1.19.16.",
        "desc_zh": "判断：1、kubelet，kubectl，kubeadm都存在"
                   "2、kubelet --version == kubeadm version == kubectl version "
                   "3、kubelet version < 1.29 "
                   "4、kubelet version >=1.19.16。",
        "tip_en": "Execute the version query command to confirm whether the component has been installed, "
                  "whether the version number is the same, and whether the version is within the supported range.",
        "tip_zh": "执行版本查询命令确认组件是否已安装，版本号是否相同，版本是否在支持范围。",
        "help_url": ""
    }
  ],
  "HostCheckResList": {
    "xx.xx.xx.x1": [
      {
        "check_item": "check_card",
        "status": "failed",
        "error_msg": "Check card failed: [ASCEND] A300i-pro has no support for MTOS_22.03LTS-SP4_aarch64 on this device"
      }
    ]
  }
}

表2 检查结果文件参数说明
参数	描述
check_item	检查项。
desc_en	检查结果（英文）。
desc_zh	检查结果（中文）。
tip_en	解决提示（英文）。
tip_zh	解决提示（中文）。
help_url	相关帮助文档参考链接。
error_msg	错误信息。
status	检查结果状态。 success：成功 failed：失败

父主题： 安装及升级参考