Onboarding Edge Nodes

Onboarding an edge node, or device, is the process of enrolling it into a project in your enterprise. After you install EVE-OS onto your edge node, it will not yet be in the ZEDEDA system. To remotely manage your applications using ZEDEDA, you need to complete the onboarding process.

Prerequisites

Before proceeding, you should be familiar with the content in our Edge Node Overview. Additionally, you should have installed EVE-OS onto your edge node.

 

Onboard a device using the ZEDEDA GUI

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

Option A: Dashboard

The 'Home' screen has multiple widgets. The 'Quick Links' widget has a quick access link to the 'Add Edge Node.' Click to trigger the new 'Add Edge Node' flow.
 
image_25.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 icon at the top right corner to trigger the new 'Add Edge Node' flow.
 
image_24.png
A or B options will land you on the 'Add Edge Node' screen.
 

Create

  • Step 1 > Populate the input field values for the 'Identity' section, as instructed in the table.
image_23.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 learn more about managing a project.
Description A detailed explanation of what the Edge Node is used for.
Local Operator Console Check the box if you want to enable this feature
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.
image_22.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 the following:
  1. Retrieve Onboarding details later–Choose this option if you want to register the Edge Node with ZEDEDA 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 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 ZEDEDA.
  3. Onboarding Key–Choose this option if you have access to the 'Onboarding Key' and the 'Serial Number' combination to identify the Edge Node uniquely. These details are generally available in the physical package in which the Edge Node's manufacturer ships the hardware to you.
  4. Generate Single-Use EVE-OS Installer
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.
 
image_21.png
Port Mappings (Networking)
This section selects the network ports like the Ethernet ports (which 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. Unused–Available for use.
  2. Management–Interface is shared with management and other Edge Applications. At least one is required per Edge Node.
  3. App Direct–Interface is dedicated to one Edge Application.
  4. App Shared–Interface is shared with multiple Edge Applications, but not with management.
  5. 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 > The 'Activate Edge Node' checkbox is checked in the bottom left corner by default. If you wish to activate them later, you can uncheck the 'Activate Edge Node' checkbox while onboarding. Also, the 'Activate Default App Network' box is 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 the 'Add' button to add the Edge Node.
image_20.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:
image_19.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 ZEDEDA platform, 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 ZEDEDA platform 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.
 

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

Status

This tab shows sections like 'Information,' 'Attestation,' 'Utilization,' 'EVE-OS Images,' 'Edge App Instances,' 'Volume Instances,' 'Network Instances,' and 'Edge View Session Details' sub-sections for a selected Edge Node.
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 ZEDEDA 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-OS for the cloud to cascade and are now in the UI.
b) Attestation
This subsection shows attestation details along with the 'Attestation State' and 'Last Updated At' fields.
 
image_18.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-OS Images
This subsection shows the EVE-OS status and EVE-OS version details.
 
image_17.png
 
e) Edge App Instances
This section shows details of the application instance type and 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.
h) Edge View Session Details
 
image_16.png
 

Basic Info

This tab shows sections like 'Identity,' 'Edge View Configuration,' '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.
 
image_15.png
b) Edge View Configuration
c) Resource
This section shows the hardware model's details, architecture, CPU, memory, and storage.
d) Hardware Info
This section shows the hardware UUID, its version, and BIOS information with security information.
 
image_14.png

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.
 
image_13.png
The GPS option selected while creating a Network fetches the GPS coordinates, as shown on the screen below.
Two configuration knobs can be used to configure the interval GPS data exported from the device
timer.location.cloud.interval
timer.location.app.interval
Note: timer.location.cloud.interval default interval is 1 hour. The minimum value is 5 minutes. Any value less than 5 minutes is ignored.
 

Storage

This tab shows the physical storage details.

image_12.png

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.
 
image_11.png

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 icon.
  • Step 2 > Update the editable fields of the 'Identity' section. Refer to the tables under the create operation for information on the editable field values and their descriptions.
image_10.png
  • Step 3 > Once done editing, click the 'Save' button.
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 icon.
  • Step 2 > Click on the expand icon to view the adapter details.
image_7.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.
  • Step 4 > Once you are done editing, click the 'Save' button.
 

Delete

You can delete the Edge Node(s) using the following steps:
  • Step 1 > From the dropdown, select 'Delete.'
image_3.png
  • Step 2 > Click the 'Delete' button on the modal dialogue.
  • Step 3 > A toast message appears when you click on the 'Delete' button.

Note: Ensure no edge application instance is attached to the Edge Node. Else, a toast message, as shown below, appears.

The 'Delete' operation removes the Edge Node(s) from the list view.
 

Onboard device using the ZEDEDA CLI

To log in to the ZEDEDA platform through CLI, see here.
 

Fields

To onboard an Edge Node to the ZEDEDA platform, 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
 

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:management:defaultIPv4-net
 
Note: Edge Nodes having Ethernet ports labeled is specific to hardware platforms. Also, the labeling can start with either a 0 or 1. However, ZEDEDA reports it from 0 (for example, eth0, eth1, and so on). You must co-relate hardware ports (on Edge Node) with the software interface outputs.
 
You can now activate your Edge Node by executing the following command.
zcli> zcli edge-node activate test-dev1

 

Add an edge device's hardware specs to ZEDEDA Cloud

During the onboarding process, if you're using the ZEDEDA GUI, you'll be prompted to choose an available hardware model. If your hardware model isn't available, you can import its specifications. After you import a model, it will appear in the Models added in enterprise section. See ZEDEDA's Import Models document for further details.

Onboard an edge node during a trial period

For your trial, ZEDEDA will email you an onboarding key. You’ll need to enter this key during on your onboarding process. If you are currently attempting to onboard your edge node during your trial period, but you don’t have an onboarding key, contact ZEDEDA support.

Was this article helpful?
5 out of 5 found this helpful