Installing MindCluster ToolBox

  • If MindCluster ToolBox has been installed, skip this section.
  • If the Atlas 500 A2 edge station has a preset system, Ascend DMI has also been preconfigured and installed in /usr/local/Ascend/toolbox.
  • This section describes how to install MindCluster ToolBox using commands. For details about how to harden system security, see Security Hardening.
  • Operations on the Atlas 500 A2 edge station, Atlas 200I A2 accelerator module, and Atlas 200I DK A2 developer kit can be performed only by the root user.

Downloading the Software Package

Refer to this section to obtain the required software package and corresponding digital signature file. Once you download this software, you agree to the terms and conditions of Huawei Enterprise End User License Agreement (EULA).

Table 1 Software package

Type

Software Package

Description

How to Obtain

MindCluster ToolBox

Ascend-mindx-toolbox_{version}_linux-{arch}.run

It contains Ascend DMI, log collection tool, and Ascend Cert.

Link

You can obtain the software package in *.deb format from the provided link. For details about how to install it, see Installing or Uninstalling the MindCluster ToolBox Package (.deb). You can also obtain the compressed package in *.zip format. The following table describes the content of the compressed package.

Table 2 Files in the package

File Name

Description

Ascend-mindx-toolbox_{version}_linux-{arch}.zip

MindCluster ToolBox, which contains the following files:

  • Ascend-mindx-toolbox_{version}_linux-{arch}.run: executable runfile of ToolBox.
  • Ascend-mindx-toolbox_{version}_linux-{arch}.sh: ToolBox script. The acceptable parameters are show_info, uninstall, and a custom directory, which are used to query information about installation and uninstallation operations, installation log storage, and operation results (installation or upgrade). Note that this script is designed to adapt to FusionDirector or iBMA. You are not advised to use it directly.
  • toolbox.sh: ToolBox script, which supports the parameters show_info and uninstall to query the installation information and uninstall ToolBox. Note that this script is designed to adapt to FusionDirector or iBMA. You are not advised to use it directly.
  • version.xml: software description, including the version number.

Ascend-mindx-toolbox_{version}_linux-{arch}.zip.cms

Signature for the Ascend-mindx-toolbox_{version}_linux-{arch}.zip package.

When upgrading MindCluster ToolBox, you can use Ascend Cert to check file integrity.

Ascend-mindx-toolbox_{version}_linux-{arch}.zip.crl

Certificate revocation list (CRL) of the Ascend-mindx-toolbox_{version}_linux-{arch}.zip package.

When upgrading MindCluster ToolBox, you can use Ascend Cert to check file integrity.

version.xml

Software description file.

version.xml.cms

Signature of the software description file.

version.xml.crl

CRL of the software description file.

sp_install.sh

Script for deploying the SmartProvisioning plugin dependency. The script supports the [-i, --install] and [-u, --uninstall] to install and uninstall the SmartProvisioning plugin dependency package, respectively. Note that this script is designed to adapt to SmartProvisioning. Do not use it directly.

sp_extension.json

SmartProvisioning plugin configuration file. Note that this file is designed to adapt to SmartProvisioning. Do not use it directly.

adapter.py, tasks, util, etc.

SmartProvisioning plugin execution scripts. Note that these scripts are designed to adapt to SmartProvisioning. Do not use them directly.

{version} indicates the software version, and {arch} indicates the CPU architecture.

Verifying the Digital Signatures of Software Packages

To prevent a software package from being maliciously tampered with during transfer or storage, download also the corresponding digital signature file for integrity verification while downloading the software package.

After the software package is downloaded from the Support website, verify its PGP digital signature by referring to the OpenPGP Signature Verification Guide. If the verification fails, do not use the software package, and contact Huawei technical support engineers.

Before using software for installation or upgrade, verify the digital signature to ensure that the software has not been tampered with.

For carriers: http://support.huawei.com/carrier/digitalSignatureAction.

For enterprises, visit https://support.huawei.com/enterprise/en/tool/pgp-verify-TL1000000054.

Preparing Installation and Running Users

You can install MindCluster ToolBox as the root user or a non-root user.

  • If you install the tool as the root user, install it in the /usr/local/Ascend directory. After the installation, all users can run the tool. Otherwise, other users cannot use its functions properly after the installation.
  • Installation as a non-root user: The installation and running users must be the same.

    To create a non-root user, run the following commands as the root user.

    1. Create a non-root user.
      groupadd usergroup     
      useradd -g usergroup -d /home/username -m username -s /bin/bash
    2. Set the password for the non-root user.
      passwd username
  • The password must meet the password complexity requirements. The password validity period is advised to be set to 90 days. You can change the validity period in the /etc/login.defs file or using the chage command. For details, see Setting User Account Validity Period.
  • If --install-for-all is not specified during driver installation, add the non-root user to the HwHiAiUser group. For example:
    useradd -g HwHiAiUser -d /home/username -m username -s /bin/bash

Procedure

  1. Log in to the installation environment as the installation user of the software package.

    For security purposes, ensure that the following directories and files meet security requirements before installing and using the software:

    1. Installation directories: /usr/local/Ascend/toolbox (for the root user); ~/Ascend/toolbox (for a common user).
    2. Configuration directories and files, such as /etc/ascend_install.info and /etc/Ascend/.
    3. Log directories and files, such as /var/log/ascend_seclog/ and /var/log/ascend-dmi.
  2. Upload MindCluster ToolBox to a path (for example, /home) that meets the security requirements of your organization in the installation environment.
  3. Go to the directory where the software package is stored.
  4. Grant the execute permission on the software package.
    chmod u+x Ascend-mindx-toolbox_{version}_linux-{arch}.run
  5. Run the following command to check the consistency and integrity of the software package installation file:
    ./Ascend-mindx-toolbox_{version}_linux-{arch}.run --check

    If the system does not have the shasum or sha256sum tool, the verification fails.

    If the following information is displayed, the software package meets the consistency and integrity requirements:

    Verifying archive integrity...  100%   SHA256 checksums are OK. All good.  
  6. Run the following commands to install the software. (The following commands support parameters such as --install-path=<path>. For details about the parameters, see Parameter Description.)
    ./Ascend-mindx-toolbox_{version}_linux-{arch}.run --install
    • If you want to install the software package on the premise that Huawei Enterprise End User License Agreement (EULA) is signed by default, add --quiet to the installation command. For example, if you add this parameter to the end of ./Software_package_name.run --install, step 7 will be skipped.
    • If the installation is performed by the root user, do not specify the installation path in the directory of a non-root user. Otherwise, files owned by the root user file may be replaced by files owned a non-root user for privilege escalation. For security purposes, use the tool installed by the current user when running services.
    • If you specify a path for installation, ensure that the path meets the security requirements of your organization.
    • If you do not specify an installation path, the software is installed in the default path. The default installation paths are as follows:
      • root user: /usr/local/Ascend
      • Non-root user: ${HOME}/Ascend ${HOME} indicates the directory of the current user.
  7. Sign Huawei Enterprise End User License Agreement (EULA) to proceed to the installation process. Enter y or Y to confirm the agreement, and enter any other character to reject the agreement. After you accept the agreement, the installation starts.
    If the current language environment does not meet the requirements, run the following command to configure the default language environment:
    # Set the language to Chinese (simplified).
    export LANG=zh_CN.UTF-8
    # Set the language to English.
    export LANG=en_US.UTF-8
    If the following information is displayed, the software is successfully installed:
    [INFO] xxx install success

    xxx indicates the name of the software package to be installed.

    • The operation of MindCluster ToolBox depends on the driver and CANN. For details about how to configure the account, see the CANN Software Installation Guide.
    • The source code of MindCluster ToolBox involves the open source software at gcc.gnu.org. For details about email addresses and websites, see Public Network Addresses.