This document outlines the steps for creating an LF Edge Sandbox account, installing EVE on a hardware device, and selecting and deploying edge applications. It’s designed to enable developers to quickly deploy LF Edge projects for experimentation quickly. By the end of this Getting Started procedure, you will have a fully functional edge node, which will be onboarded to the LF Edge sandbox. You will also have deployed your first edge application to your new edge node. For any help along the way, please see the LF Edge Sandbox support page.
If you are looking to have want your project or application added to the LF Edge global marketplace, you can find more information here [/sandbox/global-marketplace].
Prerequisites
For a successful Sandbox experience, you will need the following:
- A Linux Foundation ID (LF ID) - You can create a new learn about creating an LF ID here
- A free account on the LF Edge Sandbox SaaS platform - You can create an account here
- One or more edge nodes capable of running EVE-OS - Learn more here [/sandbox/hardware]
Creating an account
You can create a free account by visiting the following this URL.<NEED LF EDGE URL FOR ZEDEDA HUBSPOT LANDING PAGE>
Getting Started
Read and complete the following sections sequentially. Note that some steps will link to documentation in the ZEDEDA Help Center. These steps are more extensive than the others and merit dedicated documentation.
Once you have created an account, it’s time to get started. In general, you can think of the workflow as follows:
1: Select your edge hardware
Before you install EVE, you must verify that your device is supported. If you don’t have a supported device, you can use the hardware resources offered by the LF Edge Community Lab. After you have installed EVE onto your device, it is considered an edge node. The rest of this procedure will refer to it as an edge node.
- Refer to the LF Edge Sandbox hardware documentation to verify your device is on the list of supported devices.
- If your device is not supported, reserve hardware resources on the <Community_Lab_link>.
2: Install EVE-OS
To Install EVE-OS, you will need to build an EVE-OS Image, flash that image to a portable drive, and then install it onto your edge node.
Follow the ZEDEDA Help Center documentation to install EVE-OS. Note, however, that this document also includes instructions to download EVE-OS. These instructions only apply to users who are using the ZEDEDA Cloud production clusters. Instead, you must create an EVE-OS image that will point to the LF Edge Sandbox cluster. To do so, follow the instructions in ZEDEDA’s servers document. The instructions in the server document explain how you’ll need to substitute the LF Edge Sandbox URL: sandboxcloud.lfedge.org for the GMWTUS URL: zedcloud.gmwtus.zededa.net.
After you have created your custom EVE-OS image, begin following the installation instructions as the Flash EVE-OS step.
Build your EVE-OS image
Complete wichever of the following procedures is appropriate for your operating system. When you finish, you will have an installer.raw file, which you will use to install EVE-OS.
MacOS and Linux
Open your terminal. Ensure you are in your preferred directory for this operation. This procedure assumes HOME.
<code>cd $HOME</code>
Make an eve-overrides directory, which will contain your server endpoint configuration.
<code>mkdir eve-overrides</code>
Set the LF Edge Sandbox cluster endpoint by writing its URL to a text file named "server".
<code>echo https://sandboxcloud.lfedge.org > $HOME/eve-overrides/server</code>
Create your installer.raw file
For x86 edge nodes, run the following command.
<code>docker run -v $HOME/eve-overrides:/in --rm lfedge/eve:latest \
installer_raw > installer.raw</code>
For ARM and RPi edge nodes, run the following command.
<code>docker run -v $HOME/eve-overrides:/in --rm lfedge/eve:latest-arm64 \
live > live.img</code>
Copy and save the serial number stringoutput when you run this command. When you onboard your device to the LF Edge Sandbox, you must enter the serial number into the Serial Number field.
Windows OS
Open your terminal. Ensure you are in your preferred directory for this operation. This procedure assumes HOMEPATH.
<code>cd %HOMEDRIVE%\%HOMEPATH</code>
Make an eve-overrides directory, which will contain your server endpoint configuration.
<code>mkdir eve-overrides</code>
Set the LF Edge Sandbox cluster endpoint by writing its URL to a text file named "server".
<code>echo https://sandboxcloud.lfedge.org > %HOMEDRIVE%\%HOMEPATH%\eve-overrides\server</code>
Create your installer.raw file
For x86 edge nodes, run the following command.
<code>docker run -v %HOMEDRIVE%\%HOMEPATH%\eve-overrides:/in \
--rm ledge/eve:latest installer_raw > installer.raw</code>
For ARM and RPi edge nodes, run the following command.
<code>docker run -v %HOMEDRIVE%\%HOMEPATH%\eve-overrides:/in \
--rm lfedge/eve:latest-arm64 live > live.img</code>
Copy and save the serial number stringoutput when you run this command. When you onboard your device to the LF Edge Sandbox, you must enter the serial number into the Serial Number field.
Install EVE-OS
Now that you have your custom EVE-OS image (the installer.raw file you created), you need to flash it to a portable drive and then install it onto your edge node. To do so, follow ZEDEDA’s EVE-OS Installation guide, beginning at the Flash EVE-OS image section.
After you finish your installation, proceed to the next step of this procedure.
- Gather requirements
- Project Scope: Projects are a logical grouping of edge nodes. You will need to decide which LF Edge and third-party applications you wish to test.
- Networks and Connectivity: Decide how you want the edge nodes to connect with external resources, public clouds, or databases for storing the application data.
- Select edge hardware
- Hardware Models: You will need to decide which Hardware model suits the requirement for your Edge Infrastructure. These Edge Computing devices are called 'Edge Nodes'. Click here [/sandbox/hardware] to learn more about supported hardware.
- LF Edge Community Lab: Hardware resources can be reserved for Sandbox testing. Please visit this page [page?] to learn more.
- Install EVE-OS
- Download and install EVE-OS and follow the step-by-step process of installing EVE-OS on your edge computing device.
- Onboard Edge Node to Sandbox SaaS
- See the steps to onboard a new Edge Node.
- Onboard the EVE-OS installed Edge computing device on the LF Edge Sandbox
.See the steps to onboard a new Edge Node - .
- Once onboarded, the device will appear in the list view of Edge Nodes in the LF Edge Sandbox UI.
- Select appropriate applications and projects from the Marketplace.
- Select an LF Edge Sandbox Application: You can click on the Marketplace icon to see the LF Edge Projects as applications in the marketplace. See the Import Edge Applications article to follow the steps to import edge applications to your Sandbox tenant. Click here [/sandbox/applications] to learn more about Sandbox applications.
- Add (Create) your own Edge Application: You can create a new application using an a containerized or VM image that is ready to be deployed on EVE-OS.. The Onboard an Edge Application will walk you through the steps to create a new edge application.
- Deploy edge application(s) on the edge node(s)
- Once you have finalized which edge applications to deploy on your edge nodes, follow these steps to deploy the desired edge application on one or multiple Edge Nodes in your Sandbox.
- Monitor the status and health of edge nodes and applications.
- You can click on the Edge node icon on the left navigation to see a list of individual Edge Nodes in a table view. Click on an Edge Node to see details like 'Status,' 'Basic information,' and 'Events' in separate tabs. See Lifecycle Operations on Edge Nodes to learn more.
Similarly, you can see deployed edge application instance details by clicking on the edge application name in the list view. See Lifecycle Operations on Edge Applications to learn more about managing edge applications. These details help you monitor the health parameters of assets in your edge infrastructure.
...