1. Introduction
1.1. List View
- Step 1 > Click on the 'Edge App Instances' (
) icon from the left navigation.
- Step 2 > Click on the expand (
) icon to view the summary panel.

1.2. Detail View
- Step 1 > Click on one of the edge application instances in the list view to show the detailed view of the same.

- Step 2 > A temporary tab (
) is created, navigating you to the detailed view of the selected edge application instance.

2. Create (Deploy) Edge Application on Edge Node/s using ZedUI
Option A: Home View

Option B: Edge Application Instances List View


Option C: Marketplace Card View


Option D: Marketplace Edge Application Detail View

3. Steps to Create (Deploy) Single Instance of an Edge Application
- Step 1 > Select the Edge App and select one Edge Node to deploy the Edge Application. Populate the input field values for the 'Edge App & Edge Nodes' section, as instructed in the table.

Input Field | Value |
Edge App(*) |
Select the Edge App you want to deploy. |
Project(*) |
Select the Project from the dropdown. The Edge Nodes will be filtered to the selected Project in the table below. |
Number of Deployments(*) |
Select 'Single' from the dropdown. |
Please select an edge node from selected Project (*) |
Select the appropriate Edge Node from the table below by clicking the radio button. |
- Step 2 > Select the Edge App Instance name and title. Populate the input field values for the 'Edge App Instance Identity' section, as instructed in the table.

Input Field |
Value |
Name(*) |
A unique Name across the Enterprise and cannot be changed. |
Title(*) |
is user-defined and can be changed. |
Description |
The detailed explanation of what the Edge App Instance is all about, its purpose, etc. |
Enable Logs Access |
Check the box to enable logs access. |
Staggered Start Delay |
You can introduce a delay between the time EVE-OS is ready to process application instance configurations and the time the application is actually started. |
Tags |
Enter the key and value as required. |
- Step 3a > Select the 'Network Instance' from the dropdown list.

- Step 3b > Select the 'IO Adapter Bundle' from the dropdown list. Populate the input field values for the 'Adapters and Networks' section, as instructed in the table.

Input Field |
Value |
Network Instance(*) |
Select the Network Instance you want to use for this App Instance. On selection, the details of the selected network instance are shown below. |
IO Adapter Bundle(*) |
Select the IO Adapter bundle from the dropdown |
- Step 4a > Add custom configuration, if required. The fields for custom configuration appear if the application allows any custom configuration. Click on the 'Next' button to proceed.

- Step 4b > Add custom configuration by filling in the details of the respective fields as seen. Click on the 'Next' button to proceed.

Input Field |
Value |
scope_id(*) |
Assigned to a Device Provisioning Service when created by the user and used to uniquely identify the specific provisioning service the device will register through. The service generated the ID scope and is immutable, which guarantees uniqueness. |
registration_id(*) |
Used to uniquely identify a device registration with the Device Provisioning Service |
symmetric_key(*) |
It can be used to identify a device based on unique information like the MAC address or a serial number. |
- Step 4c > Add custom configuration by filling in the details of the respective fields as seen. Click on the 'Next' button to proceed.

- Step 5 > Review all the selected options and click the 'Deploy' button.

- Step 6 > When you click on the 'Deploy' button, the Edge Application is deployed on the selected Edge Node. A notification showing the status of deployment appears in a Toast message, as follows:

Legends |
Description |
|
The Edge Application Instance is working fine. |
|
The Edge Application Instance is stopped. |
|
EVE has received the configuration details of the Edge Application Instance and the process is in progress. |
|
If the ZedControl does not hear from the Edge Application Instance or EVE for 3 minutes, it puts the instance in this state. |
|
ZedControl shows this state in the following two cases: 1) when ZedControl creates metadata of the instance. 2) when EVE reports an invalid state. |
|
Could be any reason other than the ones described in this table. |

4. Steps to Create (Deploy) Multiple Instances of an Edge Application
- Step 1 > Select the Edge App and select one Edge Node to deploy the Edge Application. Populate the input field values for the 'Edge App & Edge Nodes' section, as instructed in the table.

Input Field |
Value |
Edge App(*) |
Select the Edge App you want to deploy. |
Project(*) |
Select the Project from the dropdown. The Edge Nodes will be filtered to the selected Project in the table below. |
Number of Deployments(*) |
Select 'Multiple' from the dropdown. |
Edge Nodes in selected Project (*) |
Select all the appropriate Edge Nodes from the table below. |
- Step 2 > Select the Edge App Instance name and title. Populate the input field values for the 'Edge App Instance Identity' section, as instructed in the table.

Input Field |
Value |
Edge App Instance Name Prefix(*) |
A unique Name across the Enterprise and cannot be changed. |
Edge App Instance Title Prefix(*) |
is user-defined and can be changed. |
Description |
The detailed explanation of what the Edge App Instance is all about, its purpose, etc. |
Enable Logs Access |
Check the box to enable logs access. |
Staggered Start Delay |
You can introduce a delay between the time EVE-OS is ready to process application instance configurations and the time the application is actually started. |
Tags |
Enter the key and value as required. |
- Step 3a > Select the 'Network Instance' from the dropdown list.

- Step 3b > Populate the input field values for the 'Adapters and Networks' section, as instructed in the table.

Input Field |
Value |
Network Instance(*) |
Select the Network Instance you want to use for this App Instance. On selection, the details of the selected network instance are shown below. |
IO Adapter Bundle(*) |
Populate the key-value pair for the type of IO adapter displayed. |
- Step 4a > Add custom configuration, if required. The fields for custom configuration appear if the application allows any custom configuration. Click on the 'Next' button to proceed.

- Step 4b > Add custom configuration by filling in the device provisioning variable fields as seen. Click on the 'Next' button to proceed.

Input Field |
Value |
scope_id(*) |
Assigned to a Device Provisioning Service when created by the user and used to uniquely identify the specific provisioning service the device will register through. The service generated the ID scope and is immutable, which guarantees uniqueness. |
registration_id(*) |
Used to uniquely identify a device registration with the Device Provisioning Service |
symmetric_key(*) |
It can identify a device based on unique information like the MAC address or a serial number. |
- Step 5 > Review all the selected options and click the 'Deploy' button.

- Step 6 > A notification showing the status of deployment appears in a Toast message, as follows:
- Step 7 > A job indicator (
) appears on the left navigation, indicating that the requested job has been started.

-
Step 8 > Click on the Jobs (
) icon on the left navigation to go to the list of jobs. The update of multiple Edge Application Instances triggers a 'Job,' which can be tracked in the 'Jobs' (
) section.
-
Step 9 > Click on the job created to see the details in the below panel. The triggered job appears on top of the list.

5. Create (Deploy) Edge Application Instance on single Edge Node using zCLI
zcli> zcli edge-app-instance create <name> --edge-app=<edge-app-name> --edge-node=<edge-node> [--title=<title>] [--network=<network>... | --network-instance=<network-instance>...] [(--adapter-name=<name> --adapter-type=<type>)...] [--custom-configuration=<cloud-config>]
- --edge-app=<edge-app-name>—(mandatory)Name of the Edge App
- --edge-node=<edge-node>—(mandatory)Name of the Edge Node
- --title=<title>—App instance title
- --network=<network>... | --network-instance=<network-instance>...—Depending on the type of app instance created, you may have to give the following details. You can attach a network instance to your app as below:
- --network=environment name:network name:IP Address
- --network-instance=environment name:network instance name:IP Address
- --adapter-name=<name> --adapter-type=<type>...—Depending on the type of app instance created, you may have to give the following details.
- --adapter-name=environment name:adaptor name
- --adapter-type=This depends on the adapter name specified in the adapter-name option.
# | Adapter name | Adapter type |
1 | Eth or ethernet | 1 |
2 | USB | 2 |
3 | COM | 3 |
4 | Audio | 4 |
5 | WLAN | 5 |
6 | WWAN | 6 |
7 | HDMI | 7 |
8 | Other | 255 |
-
--custom-configuration=<cloud-config>—It is a .JSON file which has a key-value file.