Onboard (Create) Edge Node

 
 

1. Introduction

As the next step to Download and Install EVE-OS, let's see how to onboard the Edge Node to ZedControl to manage your applications remotely.
A quick overview of How to Add an Edge Node to ZedControl.
 

1.1. Edge Nodes List View

After you log in to ZedControl:
  • Step 1 > Click on the 'Edge Nodes' (Edge_Nodes_icon.png) icon from the left navigation.
  • Step 2 > Click on the expand (Expand_Panel_icon.png) icon to view the summary panel.
Summary Panel shows the 'Run State Distribution,' 'Edge App Instances Load,' and 'EVE Distribution of Edge Nodes' widgets. You can hover around these donut charts to get the number in each distribution.
Below the summary panel list view of all the Edge nodes is displayed in a tabular format.
 
ENM_3_Screen_1.png
 

1.2. Edge Nodes Detail View

  • Step 1 > Click on one of the Edge Nodes in the list view to show the detailed view of the same.
ENM_3_Screen_2.png
 
  • Step 2 > A temporary tab (temp_Edge_node_icon.png) shows the detailed view of the selected Edge Node.
 
ENM_3_Screen_3.png
The detail view has tertiary navigation with the Status, Basic info, Adapters, and Events tabs.
 

2. Onboard Edge Node using ZedUI

After you log in to ZedControl, the Edge Node onboarding process can be triggered either from the 'Home' screen or the 'Edge Node' list view screen.
 

Option A: Home Screen

The 'Home' screen has multiple widgets. The 'Recommended Actions' widget has a quick access link to 'Add Edge Node.' Click to trigger the new 'Add Edge Node' flow.
 
ENM_3_Screen_4.png

Option B: Edge Node List View

Click on Edge Nodes from the left navigation to go to the already available Edge Nodes list. Click the add (Add_icon.png) icon at the top right corner to trigger the new 'Add Edge Node' flow.
 
ENM_3_Screen_5.png
Either A or B options will land you on the 'Add Edge Node' screen.
 

2.1. Create

  • Step 1 > Populate the input field values for the 'Identity' section, as instructed in the table.
 
ENM_3_Screen_6.png
Identity Section
Input Field
Value
Name(*) This is unique across the enterprise and cannot be changed.
Title(*) This is user-defined and can be changed.
Project(*) This logical construct allows you to manage a group of Edge Nodes as one logical entity. Click here to know more about managing a project.
Description A detailed explanation of what the Edge Node is used for.
Tags Enter the appropriate key-value pairs.
  • Step 2 > Populate the input field values for the 'Details' section, as instructed in the table.
  • Step 3 > Select the device Brand from the list.
  • Step 4 > Select the appropriate Model.
ENM_3_Screen_7.png
 
Details Section
Input Field Value
Asset ID Unique identifier in your inventory.
Asset Location Free text string to put the location of the Edge Node.
Identity Type(*)
You can choose one of:
  1. Retrieve Onboarding details later–Choose this option if you would like to register the Edge Node with ZedControl first and activate it later (requires physical access). The generated Edge Node details will include an Onboarding certificate and private key for you to copy over into the Edge Node.
  2. Upload Edge Node Certificate–Choose this option if you already have the certificates accessible from the Edge Node's EVE-OS installation and wish to use the same to register the Edge Node with ZedControl.
  3. Onboarding Key–Choose this option if you have access to the 'Onboarding Key' and the 'Serial Number' combination to uniquely identify the Edge Node. These details are generally available in the physical package in which the Edge Node's manufacturer ships the hardware to you.
Onboarding Key(*) UUID number. This is mandatory if you choose Identity Type as Onboarding Key.
Serial number (*)
A unique ID that is either provided by the Edge Node manufacturer or a soft-serial key.
Steps to obtain the soft serial key from the USB:
  • Step 1 > Plug in the USB to your Mac/Linux system.
  • Step 2 > Navigate to the INVENTORY partition to locate the soft serial key directory.
  • Step 3 > The soft serial key directory contains hardwaremodel.txt and hwfp.json files.
  • Step 4 > Copy the directory name and use it as a soft serial key.
This input field is mandatory if you choose Identity Type as Onboarding Key.
Edge Node Certificate(*) Upload Edge Node certificate. This is mandatory if you choose Identity Type as Upload Edge Node Certificate.
Brand(*) Select the device Brand from the list.
Model(*) Select the appropriate Model.
Step 5 > After selecting the Model, all ports of that Model are displayed in the Port Mappings section. You can now populate the input field values for 'Port Mappings' as instructed in the table.
 
ENM_3_Screen_8.png
Port Mappings (Networking)
This section selects the network ports like the Ethernet ports (serve the basic purpose of connecting devices to networks such as the internet), USB Type-A ports, COM ports, and Audio ports.
Input Field Value
Interface Usage(*)
You can choose one of:
  1. Management–Interface is shared with management and other Edge Applications.
  2. App Direct–Interface is dedicated to one Edge Application.
  3. App Shared–Interface is shared with multiple Edge Applications, but not with management.
  4. Disabled–The interface is NOT used by applications or management.
Cost
Every network interface has a running cost associated. This property is associated with every network Adapter of an Edge Node. The cost field takes any input from 1 to 256, 1 being the lowest cost, and 256 being the highest cost. Administrators can define the interface's relative cost by choosing any appropriate number.
 
Example 01: A scale of 1 to 5 from lowest to highest network interfacing cost.
Example 02: A scale of 10 to 100 with an interval of 10 where 10 is the lowest cost, 20, 30, 40, 50, 60, 70, 80, 90 being the intermediate cost slabs, and 100 being the costliest interface.
 
The flexible input system allows the users to define a preferred scale range with which the interface cost is estimated and monitored.
Network Choose from one of the available networks. This is mandatory if you choose Interface Usage as Management.
Tag Add appropriate key-value pairs for the tags you want to add to the port. This is an optional field. but Tags can be used later for selecting the appropriate interface port for an appropriate purpose.
  • Step 6 > By default, the 'Activate Edge Node' checkbox is checked in the bottom left corner. In case you wish to activate them later, you can uncheck the 'Activate Edge Node' checkbox while onboarding. Also by default, the 'Activate Default App Network' box is also checked by default.
 
Note: If you do not check the 'Activate Edge Node' checkbox and click on the 'Add' button, the admin state of the onboarded Edge Node will be unregistered until you activate the Edge Node from the Edge Node detailed view screen.
 
  • Step 7 > Click on the 'Add' button to add the Edge Node.
 
ENM_3_Screen_9.png
  • Step 8 > After adding an Edge Node, the Edge Nodes list view screen should have the Edge Node listed. The colored dot indicates the Run State to the left of the Edge Node name. The colored dots with the state is as represented in the table:
ENM_3_Screen_10.png
 
Legends Description
Green-Online-legend.png The Edge Node is working fine.
Red-Error-legend.png The Edge Node is stopped.
Magenta-Provisionaed-legend.png Once the Edge Node is registered with the ZedControl, this state is reached.
Purple-unprovi-legend.png Once the Edge Node(s) is Deactivated, this Run state is shown.
Yellow-Suspect-legend.png If the ZedControl does not hear from the Edge Node or EVE-OS for 3 minutes, it puts the instance in this state.
Grey-Other-legend_.png Could be any reason other than the ones described in this table.
 
The newly added Edge Node appears in the list view. The Edge Nodes are sorted by their names.
 

2.2. Read

The newly added Edge Node shows the status information along with hardware, networking, and health reports of the hardware. When you click on this newly added Edge Node (or any other Edge Node) in the list view, you are taken to a detailed view. The detailed view shows four main tabs: ' Status,' 'Basic Info,' 'Adapters,' and 'Events.'
 

2.2.1. Status

This tab shows sections like 'Information', 'Attestation', 'Utilization', 'EVE Images', 'Edge App Instances', 'Volume Instances' and 'Network Instances' sub-sections for a selected Edge Node.
 
ENM_3_Screen_11__1_.png
a) Information
This subsection shows an overview of the selected Edge Node such as the 'Admin Status', 'Run State', 'Hardware Security Module', and many more.
 
Virtualization Capabilities: Starting with ZedControl Release 6.6.0, the 'Virtualization Capabilities' field is added to the edge node's detailed view. The capabilities include if the virtualization is VT-x or VT-d enabled. These capabilities were added in EVE for the cloud to cascade are now shown in the ZedUI.
 
b) Attestation
This subsection shows attestation details along with the 'Attestation State' and 'Last Updated At' fields.
 
ENM_3_Screen_12.png
c) Utilization
This subsection shows statistics about the 'CPU Utilization,' 'Network Rates,' 'Available Memory for Apps (MB),' and 'Available Storage for Apps (GB).'
 
d) EVE Images
This subsection shows the EVE status and EVE version details.
 
ENM_3_Screen_13.png
e) Edge App Instances
This section shows details of the application instance type the current state along with CPU, memory, and storage.
 
f) Volume Instances
This section shows details of the volume instance type and the current state.
 
g) Network Instances
This section shows details of the network instance kind and the current state and address.
 

2.2.2. Basic Info

This tab shows sections like 'Identity,' 'Resource,' and 'Hardware Info' for a selected Edge Node. These sections comprise editable and non-editable fields.
 
a) Identity
This section shows the identity details of the particular Edge Node.
 
ENM_3_Screen_14.png
b) Resource
This section shows the hardware model's details, architecture, CPU, memory, and storage.
 
c) Hardware Info
This section shows the hardware UUID, its version, and BIOS information with security information.
 
ENM_3_Screen_15.png

2.2.3. Adapters

This tab shows the sections like 'Network Adapters' and 'I/O Adapters' for a selected Edge Node. These sections comprise editable and non-editable fields.
 
a) Network Adapters
This section shows details of the interface along with its type, usage, network, and run-state.
 
b) IO Adapters
This subsection shows details of different ports along with their type and usage.
 
ENM_3_Screen_16.png

2.2.4. Events

This tab shows the table of events.
 
a) Events Table View
The table shows the events on the Edge Node with details such as date and time, severity, source, and summary.
 
b) Expanded Events Details
When you click on the expand arrow icon, more details about a selected event, along with the debug information, if any will be shown in the expanded row.
 
ENM_3_Screen_17.png

2.3. Update

The update/edit operation can only be performed in the Edge Nodes detail view. Click on any of the Edge Nodes in the list view to show the detailed view of the same.
The update/edit icon will be visible only in the 'Basic Info' and 'Adapters' tabs.
 
a) Basic Info
Update/edit an Edge Node using the following steps:
  • Step 1 > Click on the Edit (Edit_icon.png) icon.
  • Step 2 > Update the editable fields of 'Identity' section. Refer to the tables under the create operation for information on the editable field values and their descriptions.
 
ENM_3_Screen_18.png
  • Step 3 > Once you are done editing, click on the 'Submit' button.
 
ENM_3_Screen_19.png
  • Step 4 > When you click on the 'Submit' button, a toast message announcing the successful submission of the Edge Node update request appears as below:
Edge Node: naiming-supermicro-e50 has been updated.
 
ENM_3_Screen_20.png
The selected Edge Node basic info has been updated successfully!
 
b) Adapters
Update/edit Adapters of the Edge Node using the following steps:
 
  • Step 1 > Click on the Edit (Edit_icon.png) icon.
  • Step 2 > Click on the expand (Expand_Panel_icon.png) icon to view the adapter details.
 
ENM_3_Screen_21.png
  • Step 3 > Update the editable fields of the 'Network Adapters' section. Refer to the tables under the create operation for information on the editable field values and their descriptions.
 
ENM_3_Screen_22.png
  • Step 4 > Once you are done editing, click on the 'Submit' button.
 
ENM_3_Screen_23.png
  • Step 5 > When you click on the 'Submit' button, a toast message announcing the successful submission of the Edge Node update request appears below:
Edge Node: naiming-supermicro-e50 has been updated.
 
ENM_3_Screen_24.png
 

2.4. Delete

You can delete the Edge Node(s) using the following steps:
  • Step 1 > From the dropdown, select 'Delete'.
 
ENM_3_Screen_25.png
  • Step 2 > Click the 'Confirm' button on the modal dialogue, which appears as below:
You are about to Delete 5 Edge Node(s). This will permanently remove these Edge Node(s) and associated state from the management platform. 3 default Network instance(s) associated with respective Edge Node(s) will be deleted as well.
Note: After the delete operation is performed, there is no way to reclaim the saved state of the deleted Edge Nodes using ZedControl.
 
ENM_3_Screen_26.png
  • Step 3 > When you click on the 'Confirm' button, a toast message appears as shown below:
Delete request to 5 Edge Nodes was successfully submitted.
 
ENM_3_Screen_27.png
The 'Delete' operation removes the Edge Node(s) from the list view, as seen above.
 

3. Onboard Edge Node using zCLI

To login to ZedControl through zCLI, see here.
 

3.1. Fields

To onboard an Edge Node to the ZedControl, the following fields are required:
  • Name
  • Project
  • Model
  • Title
  • Identity Type
  • Network
 

Name

This is unique across the enterprise and cannot be changed.
 

Project

By default, there is a project under your enterprise. You can use the following command to get the details:
zcli> zcli project show
Project Title Description State
------------ ----------------- ----------------- --------
default-project default-project Default Project Active
Total 1 Active 1
zcli>
 
Using the following command, you can use the default project to onboard your Edge Node(s) or create your project under the enterprise.
zcli> zcli project create test-project2
zcli>
 
Note: If the command gets successfully executed, you will not see any error message.
 

Model

ZEDEDA has a list of supported hardware models. You can get the supported model list by executing the following command.
zcli> zcli model show
 

Title

This is user-defined and can be changed.
 

Identity type

You can use one of the below options:
  • edge-node-certificate=<certificate>
  • onboarding-certificate=<certificate>
  • onboarding-key=<key> --serial=<serial-number>
 
In this document, we will use_onboarding-certificate=<certificate>_identity type will require 'onboarding-certificate' and 'serial number.' These details are generally available in the physical package in which the Edge Node's manufacturer ships the hardware to you.
 

Network

You can use the following command to find out the default network.
zcli> zcli network show
 

3.2. Onboard and Activate

You can now use details from each of the fields mentioned above to onboard Edge Node using the following command:
zcli> zcli edge-node create test-dev1 --project=test-project --model=SYS-5018D-FN8T --onboarding-key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --serial=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --network=eth0:deafultIPv4-net
 
Note: Edge Nodes having Ethernet ports labeled is specific to hardware platforms. Also, the labeling can either start with a 0 or 1. However, ZedControl reports it from 0 (for example, eth0, eth1, and so on). You must co-relate hardware ports (on Edge Node) with the software interface (ZedControl) outputs.
 
You can now activate your Edge Node by executing the following command.
zcli> zcli edge-node activate test-dev1
Was this article helpful?
1 out of 1 found this helpful

Articles in this section