Welcome to the ZEDEDA Developer Program!
The main purpose of this guide is to help you install EVE-OS onto your edge hardware and onboard the device to your ZEDCloud enterprise. The onboarding process requires a secure exchange of secrets between the device and ZEDCloud in order to properly register the device. It’s a little tricky to do the first time, but after that it gets easy. Note also that there are some changes compared to the standard documentation that only apply to the Developer Program.
CREATING EVE-OS USB INSTALLER WITH MODIFIED ZEDCLOUD SERVER
There is one subtle but important distinction between ZEDCloud production enterprises and Developer Program enterprises – the ZEDCloud and ZEDControl URLs. Therefore, when you create a USB installer image for EVE-OS, you will need to override the default ZEDCloud URL (the “server”) with this value: zedcloud.gmwtus.zededa.net
The following commands show how to override the ZEDCloud server value of the EVE-OS image when you run Docker to create the image.
On MacOS or Linux:
% cd $HOME
% mkdir eve-overrides
% echo zedcloud.gmwtus.zededa.net > $HOME/eve-overrides/server
% docker run -v $HOME/eve-overrides:/in --rm lfedge/eve:latest installer_raw > installer.raw
On Microsoft Windows OS:
% cd %HOMEDRIVE%\%HOMEPATH%
% mkdir eve-overrides
% echo zedcloud.gmwtus.zededa.net > %HOMEDRIVE%\%HOMEPATH%\eve-overrides\server
% docker run -v %HOMEDRIVE%\%HOMEPATH%\eve-overrides:/in --rm lfedge/eve:latest installer_raw > installer.raw
Now you are ready to follow the remainder of the EVE-OS installation process. Use the linked document but skip directly to Step 3 “Flash EVE-OS Image”.
ONBOARDING YOUR EDGE NODE TO ZEDCLOUD
After EVE-OS is installed, you can onboard the device to ZEDCloud using the ZEDControl UI page “Add Edge Node”. Note that before you can submit the page, you must first import a valid “hardware model” to match your device. The page should look something like the screenshot below, where an available model from the top has been “imported” to show in the lower section “Models added in enterprise”. You can import multiple models. See the “Import Models” document for further details.
If your hardware is not one of the models available for import, send a zip file of the INVENTORY partition (or minimally send the “controller-model.json” file) from the USB stick to email@example.com. Also provide a pointer to a product page or datasheet online that corresponds to your edge hardware.
Once the hardware model is visible, open the “Add Edge Node” page. For the purpose of this trial, you will be emailed an “onboarding key” to use for your edge nodes. You'll also need to input the unique “serial number” of your edge node (that is created during the install process). The serial number gets written to the USB stick (during installation), or you can "cat soft_serial" from inside the EVE-OS /config folder. If you plug the USB stick into your laptop after installation is complete, you'll find the serial number as the folder name in the INVENTORY partition. On a Mac, it should look something like this:
Insert the “Onboarding Key” sent to your email and then copy and paste the value of your device's unique serial number into the “Serial Number” field. Next select the imported Brand and Model of your device, configure any other required elements, and finally click the “Add” button to submit the page.
Alternatively you can onboard an EVE-OS edge node by uploading the device.cert.pem file that is also found on the USB stick after installation.
For this approach, select “Edge Node Certificate” in the “Identity Type” field and then upload the certificate.
Refer to the Help Center for additional information.
Happy EVE-OS installation and onboarding!