Documentation

  • 4.0
  • 10/25/2021
  • Public Content

Add Edge Software Packages

The
Intel® Edge Software Configurator
tool enables the configuration of Edge Software Packages available in the Edge Software Hub. The tool provides a graphic user interface for package management, and it works seamlessly with the edgesoftware CLI, mirroring its features.
With Edge Software Configurator, you are able to:
  • Add and configure the packages downloaded from the Edge Software Hub. For the current list of packages supported by ESC, see Table 1.
  • View which Edge Software Packages are installed in the host machine.
  • View modules downloaded and installed with the Edge Software Package, verify their installation status and log files, and uninstall modules.
  • View compatible modules available for download and installation, and install modules.

Add Edge Software Packages

This section will walk you through adding a software package. The instructions are applicable to any configuration, with the only difference being the information displayed on screen for modules listed as
Modules Installed
and
Modules Available for Install
.

Step 1: Go to Configure > Edge Software Packages and Modules

Select
Configure
in the top menu and select
Edge Software Packages and Modules
.
The Edge Software Packages and Modules screen displays the screen below.
By default, there will be no packages and modules added under
Packages & Modules
on the Home page. We can add them by following the steps below.

Step 2: Install the Packages for the first time

  1. Click on
    Add Package.
  2. Click on
    Browse Files
    for the required Edge Software Package downloaded from Edge Software Hub. This example uses the Edge Insights for Vision package.
    Do not refresh the page and do not navigate to other screens while the package is being uploaded.
  3. You can stop the package addition during the process by clicking on the
    Stop
    button.
    You will be prompted to confirm the action. To proceed, click
    Stop
    .
  4. Once the package is uploaded successfully, it will fetch the corresponding Edge Software package name and modules.
  5. In this example, the Vision package is loaded successfully. Now you can install the package providing the product key.
  6. Enter the Product Key for the Edge Software Package and click on
    Install Package
    . The Product Key is contained in the email you received from Intel confirming your download and it's used to verify the license.
  7. After the product key is validated, a pop-up will display on the screen showing installation of the package in progress.
  8. Click on the
    Close
    button to continue the installation in the background. This example uses the Edge Insights for Vision package downloaded from Edge Software Hub.
    You are only prompted to enter the product key the first time that you install the package.
  9. Once the package is installed successfully, you can proceed to configure the installed software package by selecting the
    Configure
    option under the
    Actions
    column.
  10. Click on the
    Configure
    option under
    Actions
    column of software package under
    Currently installed package
    block.
  11. You will see a list of modules installed on the left, with installation status and available actions, such as
    Uninstall
    and
    View Logs
    . Modules that are available for install are listed in the column on the right.

Step 3: Install an Additional Package

  1. If you want to add a different package when a software package is already added and installed, click on
    Add package
    in the top right corner.
  2. You will be prompted to confirm the action. To add a package, click on
    Proceed
    .
  3. Now you can continue to add the software package by following the steps described in Step 2: Install the Packages for the first time.
    Once the second package installation is successful, you will find the first package under the
    Previously imported packages
    block.

Step 4: Install a Previously Imported Software Package

  1. You can install a previously uploaded package by selecting the
    Install
    option of the respective software package under the
    Actions
    column as shown.
  2. You will be prompted to confirm the action. To continue the installation, click on
    Proceed
    .
  3. You will see the selected package under the
    Currently installed package
    block.
  4. You will see the screen below once the package installation is successful.
  5. You can view the module details of any software package by clicking on the respective package name.
  6. Now you can proceed to configure the installed software package by selecting the
    Configure
    option under the
    Actions
    column as shown.

Install and Uninstall Modules from Edge Software Packages

This section will walk you through installing and uninstalling one module. The instructions are applicable to any configuration, with the only difference being the information displayed on screen for modules listed as
Modules Installed
and
Modules Available for Install
.
Follow the instructions below to install/uninstall Amazon Web Services Greengrass* Prerequisites as an example.
Install
and
Uninstall
actions take care of all dependencies. For some modules, because of dependencies,
Uninstall
is not available.

Step 1: Go to Configure > Edge Software Packages and Modules

  1. Select
    Configure
    in the top menu and select
    Edge Software Packages and Modules
    .
If no software packages are installed, then follow the steps in Add Edge Software Packages to browse and add the edge software package.

Step 2: Install a Module

  1. Click on the
    Configure
    option under the
    Actions
    column of software package under the
    Currently installed package
    block, then you will see a list of modules installed on the left, with installation status and available actions, such as
    Uninstall
    and
    View Logs
    . Modules that are available for install are listed in the column on the right.
    For example, find
    Amazon Web Services Greengrass Prerequisites
    in the
    Modules Available for Install
    list. Select the checkbox for Amazon Web Services Greengrass Prerequisites and select
    Install Modules
    at the top of the Modules Available.
  2. Select
    Install
    .
    In the
    Modules available for Install
    list, you will see the module selected and the installation progress.
Once the installation is completed successfully, you will see the module under the
Modules Installed
list. If the module fails, then the module remains on the right with status as
Failed
. In this case, you must follow the same steps to install that module again.
You can view the logs of installed modules or installation failed modules by selecting the
View logs
option.
Here you have options such as
Copy Log
to copy it,
Copy Selected line
to copy the selected lines from the log, and
Unselect
.
Click on
Close
to exit
View logs
.

Step 3: Uninstall a Module

Any Edge Software Package module that was successfully installed and is not a dependency to other modules installed, can be uninstalled using Edge Software Configurator.
This guide uses the Amazon Web Services Greengrass Prerequisites module as an example.
  1. Find
    Amazon Web Services Greengrass Prerequisites
    in the
    Modules Installed
    list.
  2. Select
    Uninstall.
  3. You will be prompted to confirm the action. To proceed, select
    Uninstall
    .
When the process is complete, the module will be displayed in the
Modules Available for Install
list and can be installed again whenever needed.

Troubleshooting

The Edge Software Configurator package was previously named
edge_software_manager
. Some screenshots, commands, and file paths in this guide still use
esm
or
edge_software_manager
at this time.
No modules displayed in the Edge Software Package details card.
If the host machine where the Edge Software Package was installed is behind a proxy, and the modules for the Edge Software Packages are not listed, verify the proxy details in the
/opt/esm/proxy.conf
file.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.