This guide describes how to onboard an edge node to your ZEDEDA Cloud enterprise.
To onboard an edge node, you must create an edge node object in your enterprise. These objects serve as configurations for your physical edge nodes.
When an edge node first boots, it will try to connect to ZEDEDA Cloud. Once connected, the physical node will associate itself with its edge node object and download its configuration.
It’s OK if you install EVE-OS onto your physical node before you create its object in your enterprise. It’s also OK to create the node’s object in your enterprise first.
Your node will continually try to connect to your enterprise until it finds its object.
Before proceeding, you may want to read our edge node overview.
- You must have an edge node running EVE-OS.
- Ensure that a network object is available in your ZEDEDA Cloud enterprise for your edge node.
- You must have either the SysManager or SysAdmin role in your ZEDEDA Cloud enterprise.
- Your enterprise must have an existing project to assign your edge node to.
- Your edge node’s hardware model must be uploaded to your enterprise. (For testing, it's okay to use any hardware model available in your enterprise.)
- You must have an onboarding key. The default onboarding key is 5d0767ee-0547-4569-b530-387e526f8cb9. Note that your ZEDEDA Cloud administrator may have a unique onboarding key for you.
- You must have your edge node’s soft serial number.
- For installed EVE-OS.
- For live-booting EVE-OS.
Some customers work with ZEDEDA and hardware vendors to use hardware serial numbers.
If you’re not sure whether to use your hardware or soft serial number, use the soft serial.
Create an edge node object using the ZEDEDA Cloud GUI
To create an edge node object in your ZEDEDA Cloud enterprise, follow these steps.
- Log in to the ZEDEDA Cloud GUI.
- Click Edge Nodes in the left side nav.
- Click the plus sign (+) in the upper-right corner.
-
Name your edge node.
Name valuesUniquely identifies an edge node object in ZEDEDA Cloud across an entire enterprise.
- Select the Project that will own your edge node.
- Select Onboarding Key for the Identity Type.
Details
- For Single-Use installers.
- For other types, contact support.
- Enter the Onboarding Key, gathered in the prerequisites.
- Enter the Serial Number, gathered in the prerequisites.
- Select the Brand of your edge node hardware (e.g., HP). For testing purposes, you can pick any brand and model.
- Select the Model of your edge node hardware.
Port Mappings
Configure your edge node’s Port Mappings. Alternatively, you can leave the automatically populated fields as they are.
-
Interface Usage - Select one of the following:
- Unused: Interface unspecified.
- Management: Interface can be used by EVE as well as other Edge applications.
- App Direct: Interface is directly used by one edge application.
- App Shared: Interface can be shared by different network instances.
- Disabled: Interface disabled.
- Cost - Set a preferred interface based on lower cost, whether it’s based on price, bandwidth, etc. A higher number indicates lesser preference.
- Network - Select a network.
- Tag - Name/value pairs that enable you to categorize resources. Tag names are case insensitive with a maximum length of 512 and a minimum length of 3. Tag values are case sensitive with a maximum length of 256 and a minimum length of 3.
Your enterprise will now be able to send this configuration to your edge node. Ensure that your edge node is connected to the Internet and power it on. Then, monitor your node’s status to ensure everything is working.
Adapter Labels
An adapter label is a free-form string that you can assign to one or more network ports. You can designate multiple ports into a group by assigning them the same label. You can also assign multiple labels to a port, so it can belong to multiple groups. For example, you could assign “internet” or “internet-access” or similar to every port with Internet access. You can use adapter labels for scenarios such as grouping management ports, grouping port forwarding ports, grouping internet ports, and more. See Network Instances: a use case for an example of using adapter labels to configure a Local Network Instance for multi-path routing with failover and port-forwarding restrictions.
- Use Adapter Labels on your network ports if you want to designate multiple ports into a group.
- Use multiple adapter labels on a port if you want to put the port in multiple groups.
- See next steps for where else you can use these adapter labels.
Monitor your edge node’s status
To verify that your edge node object was successfully created or that your edge node is online, follow these steps.
- Navigate to the Edge Nodes page in ZEDEDA Cloud.
- Click Filter.
- Search for your edge node by name, or any other attribute option that you prefer.
- Hover on the color-coded status indicator, displayed next to your edge node’s name. Your node’s status will appear in a tooltip. Nodes will appear as “Provisioned” until they first connect to ZEDEDA Cloud and download their configuration. They will appear as “Online” when successfully onboarded.
Next steps
You are now ready to deploy an application on to your edge node!
- See our guide to deploying edge applications.
- See Network Instances to use your adapter labels to select a group of ports instead of a predefined label or only one port.
- See How to add a container as an Edge App Type to use adapter labels for your inbound rules.
- See Network Instances: a use case for an example of using adapter labels to implement multi-path routing with failover and port-forwarding restrictions.