Intel® Edge Software Manager

Intel® Edge Software Manager 

Intel® Edge Software Manager is a software tool that enables you to configure and optimize* Edge Software Hub Packages and custom applications, creating and managing Containers and Virtual Machines for edge computing with the same flexibility you would have in cloud computing operations.

Edge Software Manager is downloaded and installed with Edge Software Packages available through Intel® Edge Software Hub and provides a simple graphic user interface for:

  • Configuration and Management of Edge Software Packages, including updates to installed software.
  • Configuration and management of Containers and Container Stacks.
  • Configuration and management of Virtual Machines.
  • *Feature preview* Visualization of System and Application Performance data.
  • *Feature preview* Recommendations for workload optimization.
  • *Coming soon* Creation of profiles based on best configurations.
  • *Coming soon* Onboarding and deploying saved profiles to multiple edge devices.
  • *Coming soon* Monitoring the performance of multiple edge devices.

 

The tool works seamlessly with Edge Software Hub products, including the edgesoftware CLI, allowing developers to perform tasks in their interface of choice, being able to switch between CLI and GUI when needed.

How it Works 

Overview 

Edge Software Manager provides a graphic user interface for configuring and optimizing workloads running on the host machine, enabling easy container and virtual machine creation and management, as well as performance statistics visualization*. Selected configuration profiles can then be deployed to multiple edge nodes, with onboarding of devices and monitoring of workloads through the tool’s graphic interface.**

Edge Software Manager features are organized to match the development journey. In Configure and Optimize*, you iterate on configurations for the workloads running on the host machine until optimal performance is achieved. The next step is deploying the selected configuration to multiple machines, or edge nodes, to test and monitor workload performance at greater scale. Monitoring edge nodes performance over time, you can fine tune configurations, iterating as much as needed.


Edge Software Manager Architecture

Edge Software Manager has a modular architecture that relies on components developed by Intel as well as widely adopted Open Source components.

  • Package management of Edge Software Packages is done through a container that allows you to install, update and delete packages using the Edge Software Manager graphic user interface. 
  • Container management is enabled using the open source version of Portainer*. Portainer* comes with a Server and an Edge Agent that allow you to manage all Docker* resources (Containers, Images, Stacks, etc). The communication between the Agent and Server is done through the creation of a reverse tunnel. 
  • Virtual Machines management is enabled by a Virtual Machine Server and Virtual Machine Agent, which allow you to create, delete and perform other virtual machine operations. All communications between the Agent and the Server are done through a secure SSH tunnel using PostgreSQL* to handle the public and private keys. 
  • The telemetry information is gathered using collectd*, which collects performance data, real-time data from devices and sends it to the InfluxDB* database. collectd* is also deployed with Virtual Machines to enable monitoring workloads.  The visualization of the data is done through Grafana

 

Architecture Diagram

Get Started Guide 

Follow this Get Started Guide for step-by-step instructions for installing and launching Edge Software Manager.

Go through the Introduction to the Edge Software Manager User Interface for a tour of the graphic user interface.

Step 1. Requirements and Installation 

Edge Software Manager is downloaded and installed with Edge Insights for Vision, available through Intel® Edge Software Hub.

Follow Edge Insights for Vision Get Started Guide for requirements and installation procedure.

Once the installation is complete, follow the steps below to launch Edge Software Manager.

Virtual Machine management has specific system requirements. If you plan on using Virtual Machines, make sure you have the correct settings before proceeding: 

  • Internet connection using ethernet (Wired LAN) network for public Linux bridge network creation. 
    • 8GB minimum memory on the Host Machine. 
    • 2GB allocated for Edge Software Provisioner. 
  • At least 2GB allocated for each Virtual Machine. 
  • 40GB minimum hard disk available on the Host Machine. 
    • 20GB hard disk allocated for Edge Software Provisioner. 
    • At least 20GB of hard disk available for each Virtual Machine. 
  • KVM hypervisor enabled for virtualization environment of the Virtual Machine. 
  • VT-x enabled in BIOS settings. 

 

Edge Software Manager reserves the following ports in the Host Machine: 

  • 8200: Virtual Machine Server SSH tunnel port. 
  • 8888: Edge Software Provisioner for OS installation on Virtual Machines. 
  • 4444 – 4455: Telnet port for Virtual Machine management. Automatically assigned based on the availability. 
  • 5900 – 5920: VNC port for remote display. Automatically assigned based on the availability. 
  • 3002 – Edge Software Manager User Interface. 
  • 5000 – Edge Software Manager Docker* Registry. 
  • 8000 – Portainer* service tunnel port. 
  • 25826/udp – Used for telemetry data transfer. 

 

Step 2. Launch Edge Software Manager 

NOTE: Edge Software Manager works best with Google Chrome.

Follow the steps below to launch the application.

  1. Open a new window in Google Chrome and use https://127.0.0.1:3002/ to launch Edge Software Manager.
    Google Chrome will show a warning, letting you know a certificate for Edge Software Manager was not found.  
     
  2. Click on Advanced
    Edge Software Manager runs locally on the Host Machine. It is safe to proceed. 
     
  3. Click on Proceed to 127.0.0.1
  4. Login using the username and password for the system where Edge Software Manager was installed. 

Step 3. Introduction to Edge Software Manager User Interface 

After logging in to Edge Software Manager, you will get to the Edge Software Manager Home screen. This first screen provides an overview of the software configuration and system performance for the development machine, as well as shortcuts to relevant actions, and access to all tool features through the menu.

 

Edge Software Manager Tool Navigation

Use the top navigation to open a dropdown menu and access items under the following headers: Configure, Optimize, Deploy, and Monitor. In any screen, select Edge Software Manager to go back to the Edge Software Manager Home.

In the top right corner, you will find the Help menu with links to this document and to the Support Forum, and a Logout button that ends a user session. 

 

Home Dashboard

Edge Software Manager Home dashboard displays cards with information about the development machine: The Edge Software Package installed, Containers and Virtual Machines running, System Details, and System Performance.

The cards can be collapsed and reordered to show the information that is most relevant at each stage of the development journey.

 

Each card also includes shortcuts to actions, such as configuring the Edge Software Package, and adding Containers and Virtual Machines.

The System Performance card shows key performance indicators for the development machine in real time. In the screenn below, you can see CPU Performance.   

Click on Memory button to view the memory utilization. Similarly, you can click on respective buttons to view their details.  

 

System Performance Troubleshooting  

The System Details card shows OS and hardware details such as OS type, kernel version, processor type, memory etc. 

Containers and Virtual Machines cards also show statistics for all Containers and Virtual Machines running or powered-on. If you’d like to see statistics for a given Container or Virtual Machine, select its name on the list. To go back to seeing all of them, select the same item again.

When there are no Containers or Virtual Machines in the development machine, the cards will display a message and shortcut to Add Container or Add Virtual Machine.

Now that you are familiar with Edge Software Manager user interface, continue to Edge Software Manager Basics for a series of short tutorials that cover the main functionalities for Edge Software Manager. 

Troubleshooting

System Performance data not loading in Home screen

If the system performance data is not getting displayed on the ESM UI, restart the esm-collectd container by giving the command below on the target device.

sudo docker restart esm-collectd 

 

Edge Software Manager Basics 

In this section, you will find instructions for common tasks that can be performed using Edge Software Manager.  

These step-by-step guides walk you through the basic functionality of the tool, with self-contained tasks and examples that can be followed in or out of order and as much as needed. 

Uninstall and Install Modules from Edge Software Packages 

Edge Software Manager 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 Manager, you are able to: 

  • 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. 

 

This guide will walk you through uninstalling and installing one module. It assumes that you downloaded and installed the Recommended Configuration for Edge Insights for Vision. The instructions are applicable to any configuration, with the only difference being the information displayed on screen for modules listed as Downloaded and 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

 

The Edge Software Packages and Modules screen displays collapsible cards for each Edge Software Package installed in the host machine. In each Edge Software Package card, you will see a list of modules downloaded to the left, with installation status and available actions, as Uninstall and View Logs; modules compatible and available for download are listed in the column to the right. 

Install and Uninstall actions take care of all dependencies; for some modules, because of dependencies, Uninstall is not available. 

 

Step 2. 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 Manager.  

This guide uses the Amazon Web Services Greengrass Prerequisites module as an example. 

  1. Find Amazon Web Services Greengrass Prerequisites in the Modules Downloaded 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 list and can be installed again whenever needed. 

 

Step 3. Install an Available Module 

All modules in the Modules Available list are compatible and were validated to work with modules in the installed Edge Software Package.  

Follow the instructions below to install Amazon Web Services Greengrass Prerequisites as an example. 

  1. Find Amazon Web Services Greengrass Prerequisites in the Modules Available list. 
     
  2. Select the checkbox for Amazon Web Services Greengrass Prerequisites and select Install at the top of the Modules Available list. 
  3. Enter the Product Key for the Edge Software Package. The Product Key is contained in the email you received from Intel confirming your download and it’s used to verify the license. 
     
  4. Select Install

 

In the Modules Downloaded list you will see the module selected and the installation progress. 

 

When installation is complete, the status for the module will be displayed – Installed or Failed – as well as available actions – Uninstall or Retry and View Logs

 

Troubleshooting 

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 /opt/esm/proxy.conf file. 

 

Create a New Container 

Containers package application code, dependencies, and configurations in a standard unit of software that can run isolated from the environment. At the Edge as in the Cloud, containers enable portability, reusability, and efficiency for workload management. 

Edge Software Manager provides a graphic user interface for container management, allowing the integration of custom software for edge deployments. Containers can be created in the host machine with images from Docker* Hub or Docker* Registry, local images already built, and building a new image from a custom file. 

This guide offers step-by-step instructions for you to create your first containers using Edge Software Manager by pulling an existing image from Docker* Hub or Docker* Registry and by building a new image with a custom file

 

Create a New Container with an Image from Docker* Hub or Docker* Registry 

Step 1. Go to Configure > Containers and Container Stacks 
  1. Select Configure in the top menu and select Containers and Container Stacks

 

In the Containers and Container Stacks screen you will see a list of existing containers, their state and available actions. Hovering over icons and buttons shows more about each option. You can also search, filter and order the container list, as well as select multiple containers to apply bulk actions.  

If there are no containers in the host machine, the Containers and Container Stacks screen displays a message and shortcut for adding containers. 

 

Step 2. Add a Container Using an Existing Docker* Hub or Docker* Registry Image 
  1. In the Containers and Container Stacks screen, click on Add Container. 
  2. Name the container. Don’t use spaces or special characters. In the  screen below, it is named as nginx_hello_world.   
  3. “Select an Image from Docker* Hub or Registry” is the option selected by default. Fill in the field with the image name: nginx:latest 
  4. Click on Next
    The next step is defining container settings. All configurations are optional. The instructions below will walk through defining port configuration and adding variables for a container with Hostname nginx-test, on port 8080, in Privileged Mode. 
     
  5. In Port Configuration, click on Publish a New Manual Network Port. 
     
  6. In Host Port, enter 8080. In Mapped Container Port, enter 80. Select TCP in Protocol
  7. In Additional Variables, click on Add Additional Variables
     
  8. In Name, select Hostname. Enter nginx-test as Value. 
     
  9. Click on Add Additional Variables
     
  10. In Name, select Privileged. Enter true in Value. 
  11. Click on Next
    You can review configurations and go back to edit details if any modifications are needed.  
     
  12. Click on Deploy
    You should see a message confirming that the container is being deployed. Once deployment is complete, the new container will show on the Containers list in the Containers and Container Stacks screen. 

 

Step 3. Verify that the container image is running 

The container was configured to expose a network port, mapping the container port 80 to port 8080 in the host machine. This means that by accessing localhost:8080, you will be accessing the container ip:80.  

Follow the instructions below to verify that the container is running. 

  1. On a new browser window, go to localhost:8080. 
    If the container is running properly, you will see the index.html for nginx web server. 

 

Create a New Container by Building an Image with a Custom File 

Step 1. Go to Configure > Containers and Container Stacks 
  1. Click on Configure in the top menu and select Containers and Container Stacks

 

In the Containers and Container Stacks screen you will see a list of existing containers, their state and available actions. Hovering over icons and buttons shows more about each option. You can also search, filter and order the container list, as well as select multiple containers to apply bulk actions.  

If there are no containers in the host machine, the Containers and Container Stacks screen displays a message and shortcut for adding containers. 

 

Step 2. Build a Container Image with a Custom File 
  1. In the Containers and Container Stacks screen, click on Add Container
  2. Name the container. Don’t use spaces or special characters. In the  screen below, it is named nginx_hello_world_build.  
  3. Choose Select an Image from the Host Machine
    If there are container images in the host machine, you will see a list. You can search by name to find a specific image and can also delete images listed in this screen.  
     
  4. Click on Build a New Image
     
  5. Assign a name and tag to the image using the format name:tag. If you don’t specify a tag, the default tag (latest) will be assigned. 
    In Build Method, you can use the Web editor to create a Docker* Compose file or paste Docker* Compose commands.  
     
  6. Paste the example Docker* Compose commands below in the Web Editor under Build Method
    FROM nginx:mainline-alpine 
    
    RUN curl https://raw.githubusercontent.com/jmandip/nginx-helloworld/main/index.html -o /usr/share/nginx/html/index.html 

    NOTE: If behind a proxy, add proxy environment information to the Docker* Compose file. 

  7. Click on Build

Once the image is built, it will be listed under Select an Image from the Host Machine.  

 

Step 3. Create a Container Using the Image Built with the Custom File 
  1. Find and select the image built in the previous step. 
     
  2. Click on Next
    The next step is defining container settings. All configurations are optional. The instructions below will walk through defining port configuration for a container on port 8081. 
     
  3. In Port Configuration, click on Publish a New Manual Network Port. 
     
  4. In Host Port, enter 8081. In Mapped Container Port, enter 80. Select TCP in Protocol 
  5. Click on Next
    You can review configurations and go back to edit details if any modifications are needed.  
     
  6. Click on Deploy



You should see a message confirming that the container is being deployed. Once deployment is complete, the new container will show on the Containers list in the Containers and Container Stacks screen

Step 4. Verify that the container image is running 

The container was configured to expose a network port, mapping the container port 80 to port 8081 in the host machine. This means that by accessing localhost:8081, you will be accessing the container ip:80.  

Follow the instructions below to verify that the container is running. 

  1. On a new browser window, go to localhost:8081.

Troubleshooting 

No Containers displayed. 

If the list of Containers is not displayed, check the logs for “esm_portainer_edge_agent” Docker service for more information using the following command on a terminal: 

docker service logs esm_portainer_edge_agent 

 

Create and Manage Container Stacks 

A Container Stack (or Docker* Stack) is a group of services that make up a complete distributed application. Using a Container Stack, you are able to define and manage multiple services with a single configuration file. 

Edge Software Manager provides a graphic interface that enables the creation and management of Container Stacks. Follow the instructions below to create and manage your first Container Stack 

Step 1. Go to Configure > Containers and Container Stacks 

  1. Select Configure in the top menu and select Containers and Container Stacks

  1. On the Containers and Container Stacks screen, click on the Container Stacks tab. 
    If there are container stacks in the host machine, they will be listed in this tab. When there are no container stacks available, you will only see the button Add Container Stacks

Step 2. Create a Container Stack 

  1. On the Container Stacks tab, click on Add Container Stack
  2. Name the container stack. Don’t use spaces and special characters. In the screen below, it is named Hello_World_StackYou can use the Web Editor to type in or paste commands of the Docker* Compose file for the stack. The Docker* Compose versions supported are 3.0 and 3.7. 
  3. Copy the example commands below and paste in the Web Editor. 
    version: '3' 
    services: 
      roach1: 
        image: cockroachdb/cockroach:latest 
        command: "start --insecure" 
        deploy: 
          replicas: 1 
        ports: 
          - 8080 
      roachN: 
        image: cockroachdb/cockroach:latest 
        command: "start --insecure --join=roach1,roachN" 
        deploy: 
          mode: global 

     

  4. Click on Deploy Container Stack

In the bottom right of the screen, Edge Software Manager will show that it is processing your request to deploy the stack. 

Once the container stack is deployed, you will see a success notification, and the new stack will be displayed in the Container Stacks screen. 

Step 3. Manage Container Stacks 

  1. On the Container Stacks tab, click on the container stack you created in the previous step. 
    In the Container Stack Services screen, you will see the list of services in the stack, as well as information about their images, configurations and date of last update. 
     
  2. Click on Edit Container Stack
    In the Edit Container Stack screen, all fields can be modified.  
     
  3. On the Web Editor, change the number of replicas in line 8: replicas: 2 
  4. Click on Update Container Stack

In the bottom right of the screen, Edge Software Manager will show that is processing your request to update the stack. 

Once the update is complete, you will see a notification. 

You can update and delete individual services in the stack as well. 

 

Troubleshooting 

No Container Stacks displayed. 

If the list of Container Stacks is not displayed, check the logs for “esm_portainer_edge_agent” Docker service for more information, using the following command on a terminal: 

docker service logs esm_portainer_edge_agent 

 

Create Virtual Machines 

Virtual Machines are virtual environments that work as computer systems, with dedicated CPU, memory, storage, and network interface. Multiple Virtual Machines can be created on a single physical compute device, each isolated from the system and running their own Operating System. 

Edge Software Manager provides a graphic user interface for creating and managing Virtual Machines with ready-to-use templates, making it easier to dedicate resources and isolate workloads running on the same device. 

The following instructions walk you through creating a Virtual Machine using an existing template or create a new template

 

Create a Virtual Machine with an Existing Template 

Step 1. Go to Configure > Virtual Machines 
  1. Click on Configure in the top menu and select Virtual Machines

In the Virtual Machines screen you will see a list of existing virtual machines, their status, OS type and version, resources, and available actions. Hovering over icons and buttons shows more about each option. You can also search for a specific virtual machine.  

If there are no virtual machines in the host machine, the Virtual Machines screen displays a message and shortcut for adding Virtual Machines. 

 

Step 2. Add Virtual Machine 
  1. In the Virtual Machines screen, click on Add Virtual Machine
  2. Name the virtual machine. Don’t use spaces and special characters.  
  3. Choose one of the existing Virtual Machine Templates. In this example, we’re selecting Ubuntu Desktop
  4. Click on Next
  5.  If your VM needs dedicated PCI and USB devices, you can choose one from the existing list. In this example, we’re selecting PCI device I211 Gigabit Network Connection
  6. Click on Next.
  7. Create a Username and Password for the virtual machine. 
  8. Click on Next
    In this screen, you can review details for the virtual machine that is being created and go back to make changes if needed. 
     
  9. Click on Install
  10. Click on Continue for the installation to proceed on the background. 
    You will see a notification letting you know a new virtual machine was configured. The installation will continue on the background and you will be able to see the progress in the Virtual Machines screen. 
    Once installation is complete, the virtual machine will be powered on automatically. Use the Actions shortcuts to manage the virtual machine and access its console. 

Create a Virtual Machine with New Template 

Step 1. Go to Configure > Virtual Machines 
  1. Click on Configure in the top menu and select Virtual Machines
    In the Virtual Machines screen you will see a list of existing virtual machines, their status, OS type and version, resources, and available actions. Hovering over icons and buttons shows more about each option. You can also search for a specific virtual machine.  

    If there are no virtual machines in the host machine, the Virtual Machines screen displays a message and shortcut for adding Virtual Machines. 

 

Step 2. Add Virtual Machine 
  1. In the Virtual Machines screen, click on Add Virtual Machine
  2. Name the virtual machine. Don’t use spaces and special characters.  
  3. Click on Add Virtual Machine Template.
  4. Name the new template. 
  5. Choose the OS version and version. You can opt to include the Edge Software Package to be deployed with the template. If you do, you will need to enter the Product Key for the package. 
     
  6. Fill in resource allocation. The minimum values are: 
    1. CPU: 2 Cores
    2. Memory: 2048 MB
    3. Storage: 20GB
  7.  You can opt to enable v-GPU with the template. 
  8. Click on Add
    You will see a notification indicating that the template was created and the new template will be displayed in the Add Virtual Machine screen. 
     
  9. Select the template you’ve created in the previous steps. 
     
  10. Click on Next.
  11. Choose dedicated PCI and USB devices from the existing list if needed for your VM. In this example, we’re selecting  PCI device I211 Gigabit Network Connection​.  
  12. Click on Next.
  13. Create a Username and Password for the virtual machine. 
  14. Click on Next
    In this screen, you can review details for the virtual machine that is being created and go back to make changes if needed. 
     
  15. Click on Install
  16. Click on Continue for the installation to proceed on the background. 
    You will see a notification letting you know a new virtual machine was configured. The installation will continue on the background and you will be able to see the progress in the Virtual Machines screen. 
    Once installation is complete, the virtual machine will be powered on automatically. Use the Actions shortcuts to manage the virtual machine and access its console. 
     

    To check on the allocated I/O devices, you can login to console and give the commands below.

  • lspci – to check allocated PCI device 

  • lsusb – to check allocated USB device 

 

Troubleshooting 

Failed to Install or Start VM. 
  • Click on the Information icon to see details about the error. 
 
Failed to install VM: Connection to Edge Software Provisioner failed.  
  • If the system is behind a proxy, ensure that proxy configuration in /etc/environment file is correct. 
  • Verify that no other applications are currently using port 8888 as it is reserved for Edge Software Provisioner.  
  • Reinstall Edge Software Manager after making the changes above. 
 
Installation timeout error at 0%. 
  • Edge Software Manager requires wired Internet connection for virtual machine operations. Make sure your system is not connected through WiFi.  
  • Verify Edge Software Provisioner is accessible over the IP address, i.e., http://<ip_address>:8888/tftp  
 
Installation failed at #%.  
  • Delete the Virtual Machine for which installation failed and create a new one. This is usually due to interruptions caused by the system. 
 
KVM disabled.  
  • Enable VT-x in the BIOS. 
 
#MB memory is not available in the host.  
  • Ensure there is enough available memory on the host system before adding new VM. Select VM template with smaller memory allocation (2048 MB minimum). 
 
Cannot set up guest memory ‘pc.ram’: Out of memory. 
  • Ensure there is enough available memory on the host system or edit the virtual machine to reduce its memory allocation before powering on the VM. 

Create and Manage Edge Nodes  

Edge Software Manager provides the capability to add Edge Nodes and manage them through the UI. Edge Node can be a Bare metal server or a Virtual Machine. 
After adding an Edge Node as an endpoint, the workload configured on host machine can be deployed to Edge Nodes using the Deploy Feature. Deploy Feature will replicate the workload from primary node to the other selected edge nodes. 

  • Deploy > Onboard an Edge Node 

    • Add and Onboard an Edge Node 

  • Deploy > Deploy Edge Nodes 

    • Select profiles for deployment to Edge Nodes  

 

Add and Onboard an Edge Node  

Step 1. Go to Deploy > Onboard an Edge Node 
  1. Click on Deploy in the top menu and select Onboard an Edge Node

    ​In the Onboard an Edge Node screen, you will see a list of onboarding pending edge nodes with its creation time and actions list, and also successfully onboarded edge nodes with details like IP address, creation time, status, CPU cores and actions. You can also search for a specific edge node. 

    If there are no edge nodes registered, the Onboard an Edge Node screen displays a message and shortcut for adding edge nodes.  

NOTE: To add and onboard an edge node you will need two devices, one with ESM installed and another device where you will add and onboard an edge node. 

 

Step 2. Add and Onboard Edge Node  
  1. In Onboard Edge Node screen, click on Add Edge Node.  

  2. Name the Edge Node. Don’t use spaces or special characters.

  3. Click on Next

  4. You will get a set of instructions you need to perform to onboard an edge node in the note section, and command for deploying an edge agent, which must be executed on the device that needs to be onboarded. 

  5. Follow the steps mentioned on the screen to install the certificates on the edge node being onboarded. 

  6. By executing the command given on the device to be onboarded, you can install edge agent on your remote docker environment. As mentioned, reboot the device after installation of agent.  

  7. Click on Back. You will see the newly added device under successfully onboarded nodes. 

 
Action an Edge Node  
  1. You can perform connect operation to the edge nodes present in the onboarding pending list by clicking on Connect button under Actions of the respective edge nodes. 

  2. Follow the steps mentioned on the screen to onboard the target node successfully. 

  3. You can delete single edge node from onboarding pending list by clicking X button under Actions of the respective edge node. 

  4. You will get a popup. Click on Remove button to remove node from network. 

  5. You can also perform delete operation on multiple edge nodes from onboarding pending list by selecting them and clicking on Remove from network option as shown. 

  6. Click on Remove button once you get popup to remove node from network. 

  7. Similarly, you can perform deletion operation on single/multiple edge node from successfully onboarded list. 

  8. To view onboarded edge node details, click on respective onboarded Edge Node Name

  9. Click on Performance tab to view Performance statistics. 

  10. Click on Close to go back. 

  11. To customize columns under Successfully Onboarded Nodes, click on Column Customization icon present in right corner. 

  12. Unselect/Select the columns and click on Apply to view changes. Click on Reset To Default to select the default columns and click on Close to exit. 

  13. To filter the edge nodes under Successfully Onboarded Nodes, click on Filter icon present in right corner. 

  14. Unselect/Select the columns values and click on Apply to view the list based on the filters applied, and click on Close to exit. 

 

Troubleshooting 

Onboarding Failure: 

While onboarding, after running the command on the target Edge Node, and failure occurs while pulling vm-agent docker image with the following error: 
Error response from daemon: Get https://<IPADDRESS>:5000/v2/: net/http: TLS handshake timeout. 

  1. If the devices are behind proxy envrionment, make sure target node is reachable from primary node. 
  2. Add the IP address of Primary node to no_proxy list in docker proxy configuration in the following files:  
    /etc/systemd/system/docker.service.d/http-proxy.conf  
    /etc/systemd/system/docker.service.d/https-proxy.conf 

 

Deploy Edge Nodes 

Step 1. Go to Deploy > Deploy Edge Nodes 
  1. Click on Deploy in the top menu and select Deploy Edge Nodes

  2. In the Deploy Edge Nodes screen, you will see a list of ongoing deployment edge nodes with details like status, deployment starting time and actions, and completed deployment edge nodes with details like IP address, deployed time, deployment status and actions. You can also search for a specific edge node. 

  3. If there are no edge nodes deployed, the Deploy Edge Node screen displays a message and shortcut to deploy edge node in the ongoing deployment as shown. 

  4. To deploy an edge node, click on Deploy button, 

  5. You will see a list of host configuration that will be deployed on selected edge nodes. 

  6. On clicking the View Details button, you can see the complete details of host configuration like modules installed, containers and stacks running. 

  7. Choose a host configuration from list by clicking the respective Select option as shown. 

  8. Click on Next.

  9. Select one or more edge nodes for deploying the configuration by clicking on the respective edge nodes check box as shown. 

  10. Click on Next

  11. In the next screen you need to create VM login credentials by giving appropriate username and password, which will be used to login into deployed virtual machines. 

  12. Click on Next

  13. Enter the product key

  14. Click on Continue

  15. In this screen, you can review details for the configuration that is being deployed and go back to make changes if needed.  

  16. Click on Deploy

  17. Click on Continue for the deployment to proceed on the background. The deployment will continue on the background and you will be able to see the progress under Ongoing Deployment

  18. During the deployment, you can view the ongoing deployment edge nodes Details by clicking the respective Edge Node Name

  19. Click on Performance tab to view Performance statistics. 

  20. Click on Close to exit. 

  21. On clicking View Summary button under Actions, you can view the installation summary status. 

  22. Click on Close to exit from popup screen. 

  23. Once deployment is completed, you can see the edge node on the Completed Deployment block and its status as “Successful”, “Partially Done” and “Failed.” 

 

Action on Deployed Node  

  1. You can view the deployment summary of any deployed edge node by clicking on View Summary under Actions.  

  2. Click on Close to exit from popup. 

  3. You can view complete Details of deployed edge node by clicking on the respective Edge Node Name

  4. Click on Performance tab to view Performance statistics. 

  5. Click on Close to exit from popup. 

  6. Similar to onboarded edge nodes, you can perform Delete Workload and Remove From Network operations on single edge node or on multiple edge nodes by selecting them from Complete Deployment list with respective icons. 
    Similarly, you can also Customize Column and Filter the edge node list from Completed Deployment block with respective icons present on right corner.  

 
Access or manage VM on target nodes: 

To launch remote-viewer, you need connect to target node either by using VNC or MobeXterm

  1. Install remote-viewer on target nodes: sudo apt install virt-viewer 

  2. List all VM on target nodes: sudo docker ps -a | grep esm-vm-agent 

  3. Access vm using spice port (5XXX) number displayed on container name: remote-viewer spice://127.0.0.1:<vm_remote_port_number> 

  • Example in the case: remote-viewer spice://127.0.0.1:5838 
Manage VM using docker CLI: 
  • To powered on: sudo docker start 

  • To powered off: sudo docker stop 

  • To restart: sudo docker restart 

 

Monitor the Deployed Edge Nodes  

Once the Edge Nodes are configured and deployed with the workload, the next step is to monitor the performance of the workload on these devices. Monitor feature in Edge Software Manager provides the functionality to monitor the performance by providing the real-time system performance metrics like CPU Utilization, Storage and Network Usage, etc. It also provides other details like deployment status, docker container and virtual machine metrics. 

  • Monitor > Deployed Edge Nodes 

    • View status and performance for devices deployed 

 

Monitor Edge Nodes 

Step 1. Go to Monitor > Deployed Edge Nodes 

Click on Monitor in the top menu and select Deployed Edge Nodes
In the Deployed Edge Node screen, you will see a list of edge nodes being deployed with details like deployment status, IP Address, Node Up-time, CPU, Memory, etc.  
​If there are no edge nodes deployed, then Deployed Edge Node screen display an empty page with shortcut links to onboard and deploy edge node. 

 

  1. To view the details of CPU/Memory/Storage of any node, keep the cursor on respective icons of that node as shown. 

  2. To view the Details of any edge node, click on respective Edge Node name. 

  3. Click on Performance tab to view Performance statistics. 

  4. Click on Close to exit. 

  5. Similar to onboard and deployment, you can customize columns and filter edge node under deployed edge nodes on monitor page with respective icons present on right corner.  

Product and Performance Information

1

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