Documentation

Software Installation

  1. Log in to the device where MEF Edge is to be installed as the root user.
  2. Upload the obtained software package to any directory on the device. However, the owner of the directory must be root, and the owner group and other users cannot write the directory.
  3. Decompress the software package.
    1. Run the following command to decompress the software package:
      unzip Ascend-mindxedge-mefedgesdk_{version}_linux-aarch64.zip
      Table 1 Decompressed files

      File

      Description

      Ascend-mindxedge-mefedgesdk_{version}_linux-aarch64.tar.gz

      Installation package

      Ascend-mindxedge-mefedgesdk_{version}_linux-aarch64.tar.gz.cms

      CMS signature file

      Ascend-mindxedge-mefedgesdk_{version}_linux-aarch64.tar.gz.crl

      CRL

      Replace Ascend-mindxedge-mefedgesdk_{version}_linux-aarch64.zip with the actual package name. The CMS file and CRL are used to verify the inner signature of the software package.

    2. Decompress the tar.gz package again.
      tar -zxvf Ascend-mindxedge-mefedgesdk_{version}_linux-aarch64.tar.gz
    Table 2 Decompressed files/directories

    File or Directory

    Description

    config/

    Configuration directory

    software/

    Software directory

    install.sh

    Installation script file

    version.xml

    Software version file
  4. Install MEF Edge.
    1. You can install MEF Edge in the default installation mode (recommended) or by specifying a path. For details about the default installation path, see Table 3.
      • Installation in default mode:
        ./install.sh
      • Installation by specifying a path: 
        ./install.sh --install_dir=Installation_path --log_dir=Log_path --log_backup_dir=Log_dump_path
        Table 3 install.sh description

        Parameter

        Mandatory/Optional

        Description

        install_dir

        Optional

        Specifies the location of the installation directory. If this parameter is not specified, the default installation path /usr/local/mindx is used.

        log_dir

        Optional

        Specifies the location of the log directory. If this parameter is not specified, the default installation is performed. The default log path is /var/alog.

        log_backup_dir

        Optional

        Specifies the location of the log dump directory. If this parameter is not specified, the default installation is performed. The default log dump path is /home/log.

        allow_tmpfs

        Optional

        Allows the installation path and log dump path to be stored in the temporary file system. If this parameter is not specified, the installation path and log dump path cannot be stored in the temporary file system.

        Values:

        • true: allows the installation path and log dump path to be stored in the temporary file system.
        • false (default): does not allow the installation path and log dump path to be stored in the temporary file system.
          NOTICE:

          If the value is set to true, logs and software may be lost. Ensure the security and availability of related functions.

          NOTE:

          If the specified path is in the temporary file system and allow_tmpfs is set to false, the software fails to be installed.
        Description of install.sh:
        • If the parameters that are inconsistent with the predefined installation parameters are input in the ./install.sh -xxx or ./install.sh --xxx format, the installation program ends due to parameter errors.
        • Parameters in the ./install.sh xxx format will be ignored. The installation program continues, and the default installation path is used.
        • When the installation path, log path, and log dump path are specified for installation, specify existing paths on the current device and those paths must be absolute paths.
        • The length of the installation, log, and log dump paths must be less than 4096 characters. The number of directory levels must be less than 99. The owner must be root, and the owner group and other users do not have the write permission. Soft links cannot be included.
        • -version/--version: queries the software version.
        • -h/--h/-help/--help: prints help information.
    2. The installation is successful if the following information is displayed:
      install MEFEdge success

      After the installation is successful, the software is deployed in the Installation path/MEFEdge directory. The logs are stored in the Log path/MEFEdge_log directory. The dump logs are stored in the Log dump path/MEFEdge_logbackup directory. For details about the log paths and permission information, see Viewing Log Information.

  5. Optional: After MEF Edge is installed, you can set resource limits, such as the CPU and memory usage, for services related to the MEF Edge processes by referring to Restricting System Service Resources so that the service resource usage does not exceed the limits continuously.
  6. Start MEF Edge.
    1. Run the following command to switch to the directory where run.sh is located:
      cd Installation_directory/MEFEdge/software/
    2. Run the following command to start MEF Edge:
      ./run.sh start

    If the following information is displayed, the startup command is successfully executed:

    Execute [start] command success!
    The run.sh command requires the root permission. Table 4 lists some sub-commands of run.sh.
    Table 4 run.sh description

    Command

    Sub-command

    Description

    netconfig

    netconfig parameters

    Configures the NMS to interconnect with MEF Edge and MEF Center.

    getnetconfig

    None
    Obtains the current NMS configuration mode.
    • MEF: MEF Center and MEF Edge cloud-edge authentication. The exit code is 2. (Currently, only this mode is supported.)
    • FD: The exit code is 0. (This code is displayed by default when the NMS is not configured after the installation and is unavailable currently.)
    NOTE:

    The reserved value of the exit code is 1, and the exit code for the failure to obtain the NMS configuration mode information is 255.

    domainconfig

    domainconfig parameters

    Configures mapping between local domain names.

    alarmconfig

    alarmconfig parameters

    Configures alarms. Currently, only the MEF Edge root certificate expiration alarm is supported. For details, see Configuring and Querying the MEF Edge Certificate Expiration Alarm.

    getalarmconfig

    None

    Obtains alarm configurations. Currently, only the MEF Edge root certificate expiration alarm is supported. For details, see Configuring and Querying the MEF Edge Certificate Expiration Alarm.

    effect

    None

    Makes MEF Edge take effect after the upgrade.

    start

    None

    Starts MEF Edge.

    restart

    None

    Restarts MEF Edge.

    stop

    None

    Stops MEF Edge.

    uninstall

    None

    Uninstalls MEF Edge.

    upgrade

    upgrade parameters

    Upgrades MEF Edge.

    updatekmc

    None

    Updates the KMC encryption key.

    getcertinfo

    getcertinfo parameters

    Queries the MEF Edge root certificate. For details, see Querying the MEF Center Root Certificate.

    importcrl

    importcrl parameters

    Imports the MEF Edge CRL.

    updatecrl

    updatecrl parameters

    Updates the MEF Edge CRL.

    collectlog

    collectlog parameters

    Collects MEF Edge logs.

    getunusedcert

    getunusedcert parameters

    Queries the backup information about the MEF Edge root certificate for cloud-edge interconnection.

    deletecert

    deletecert parameters

    Deletes the unused MEF Edge root certificate for cloud-edge interconnection.

    restorecert

    restorecert parameters

    Restores the backup MEF Edge root certificate for cloud-edge interconnection.

    -version/--version

    None

    Displays the version information. For details, see Querying the MEF Edge Version.

    -h/--h/-help/--help

    None

    Displays help information.