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 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 want your project or application added to the LF Edge global marketplace, you can find more information here.
Prerequisites
For a successful Sandbox experience, you will need the following:
- A Linux Foundation ID (LF ID) - You can 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
Creating an account
You can create a free LF Edge Sandbox account by visiting this URL.
...
- Refer to the LF Edge Sandbox hardware documentation to verify your device is on the list of supported devices.
- COMING SOON - If your device is not supported, reserve hardware resources on the <Community_Lab_link>from the LF Edge Community Lab.
Step 2: Install EVE-OS
To Install EVE-OS, you will need to build an EVE-OS Image, flash that image it to a portable drive, and then install it onto your edge node.
...
Complete the following procedure that 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
1. Open your terminal. Ensure you are in your preferred directory for this operation. This procedure assumes HOME.
| Code Block | ||||
|---|---|---|---|---|
| ||||
cd $HOME |
2. Make an eve-overrides directory , which will contain containing your server endpoint configuration.<code>mkdir
| Code Block | ||
|---|---|---|
| ||
mkdir eve-overrides |
...
3. Set the LF Edge Sandbox cluster endpoint by writing its URL to a text file named "server".<code>echo
| Code Block | ||
|---|---|---|
| ||
echo https://sandboxcloud.lfedge. |
...
org > $HOME/eve-overrides/ |
...
server |
4. Create your installer.raw file
For x86 edge nodes, run the following command.
...
| Code Block | ||
|---|---|---|
| ||
docker run -v $HOME/eve-overrides:/in --rm lfedge/eve:latest \ |
...
installer_raw > installer.raw |
...
For ARM and RPi edge nodes, run the following command.
...
| Code Block | ||
|---|---|---|
| ||
docker run -v $HOME/eve-overrides:/in --rm lfedge/eve:latest-arm64 \ |
...
live > live. |
...
img |
Windows OS
1. Open your terminal. Ensure you are in your preferred directory for this operation. This procedure assumes HOMEPATH.<code>cd
| Code Block | ||
|---|---|---|
| ||
cd %HOMEDRIVE%\ |
...
%HOMEPATH |
2. Make an eve-overrides directory, which will contain your server endpoint configuration.<code>mkdir
| Code Block | ||
|---|---|---|
| ||
mkdir eve- |
...
overrides |
3. Set the LF Edge Sandbox cluster endpoint by writing its URL to a text file named "server".<code>echo
| Code Block | ||
|---|---|---|
| ||
echo https://sandboxcloud.lfedge.org > %HOMEDRIVE%\%HOMEPATH%\eve-overrides\ |
...
server |
4. Create your installer.raw file
For x86 edge nodes, run the following command.
| Code Block | ||
|---|---|---|
|
...
docker run -v %HOMEDRIVE%\%HOMEPATH%\eve-overrides:/in \ |
...
--rm ledge/eve:latest installer_raw > installer. |
...
raw |
For ARM and RPi edge nodes, run the following command.
...
| Code Block | ||
|---|---|---|
| ||
docker run -v %HOMEDRIVE%\%HOMEPATH%\eve-overrides:/in \ |
...
--rm lfedge/eve:latest-arm64 live > live. |
...
img |
2: Flash an EVE-OS image
Flash the image you created to a blank bootable drive (USB, for example). You can find the detailed instructions for flashing the image on the ZEDEDA help website.
...
Step 3: Onboard Your Edge Node
To onboard your edge node, you will need to You will use the LF Edge Sandbox GUI to onboard your edge node. You will also need the Onboarding Key and the edge device soft serial number.
...
The onboarding key is available on an LF Edge wiki page. Please note you need an LF ID to access this page and copy the onboarding key. You can find the The onboarding key instructions are here <need to link to onboarding key doc>.
2: Get your soft serial number for your edge device
You will need to input the your edge node's unique soft serial number of your edge node (created automatically during EVE-OS installation). The soft serial number gets written to the USB stick during installation, or you can `cat soft_serial` from inside the EVE-OS /config directory. If you plug the USB stick into your laptop after installation, you'll find the serial number as the directory name in the INVENTORY partition. On MacOSmacOS, it should look something like this:
<NEED TO INSERT AN IMAGE>
3: Use the GUI to onboard your edge node.
Navigate Login to your LF Edge Sandbox and navigate to the Edge Nodes page and click . Click the "+" symbol in the upper right-hand corner to add a new Edge node.
...
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 to learn more about Sandbox applications.
Add (Create) your own Edge Application: You can create a new application using a containerized or VM image that is ready to be deployed on EVE-OS. TheOnboard an Edge Application add an edge application documentation will walk you through the steps to create a new edge application.
...
Step 6: Monitor the status of your edge nodes and applications
You can click on Click 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.
Need Help?
Please see our support page for helpful resources.
About the LF Edge Sandbox
...
The LF Edge Sandbox controlling organization is the LF Edge TAC.
Contact Information
For more information, please visit our community slack channel [#lf-edge-sandbox] or post to our email distribution list.
...