Get an EVE-OS image

Updated November 03, 2023 11:22

Before you can use your edge device with ZEDEDA Cloud, it must be running the EVE Virtualization Engine operating system (EVE-OS). To install EVE-OS onto your edge device, you'll need to complete three procedures: get an EVE-OS image, flash your EVE-OS image onto a portable drive, and finally install EVE-OS onto your device. This document explains how to get an EVE-OS image.

You can get an EVE-OS image in one of two ways: you can download a default image, or you can create a custom image.

EVE-OS images are available for the following system architectures.

Prerequisites

You'll need Docker installed.
If you plan to install EVE-OS onto a Raspberry Pi (ARM) device, ensure that it meets the following hardware requirement:
- At least Raspberry Pi 4 Model B with 4G
- MicroSD card (16GB or larger recommended)

Download an EVE-OS image

EVE-OS is served from Docker Hub. EVE-OS images follow the "Ifedge/eve: version" convention. Specify version numbers as x.y.z, 6.3.0 for example, or "latest".

x86 devices

Follow these steps to create your EVE-OS image, the installer.raw file.

Open your terminal.

Pull and generate the latest EVE-OS image.

docker run lfedge/eve:latest -f raw installer_raw > installer.raw

Raspberry Pi (ARM) devices

Follow these steps to create your EVE-OS image, the live.img file.

Open your terminal.

Pull and generate the latest EVE-OS image.

docker run lfedge/eve:latest-arm64 live > live.img

Copy and save the serial number string that was output in the previous step. It will look something like this.
- ```
681cc64f-6633-49f3-988c-b0afde4a25fc
```
- You'll need to enter the serial number into the Serial Number field when you onboard your device to ZEDEDA Cloud.

Create a custom EVE-OS image

Instead of downloading a default EVE-OS image, you can create your own. When you do this, you have the option to configure the EVE-OS image to point to a particular ZEDEDA Cloud server. The following procedures show how to do so using the URL for ZEDEDA's demo server: zedcloud.gmwtus.zededa.net

In the procedures below, replace zedcloud.gmwtus.zededa.net with the URL of the server you want to use.

Choose one of the following procedures according to your local operating system.

MacOS and Linux

Open your terminal.
Ensure you are in your preferred directory for this operation. This procedure assumes HOME.
```
cd $HOME
```
Make an eve-overrides directory, which will contain your server endpoint configuration.
```
mkdir eve-overrides
```
Set your server endpoint by writing its URL to a text file named "server".
```
echo zedcloud.gmwtus.zededa.net > $HOME/eve-overrides/server
```

For x86 devices:

docker run -v $HOME/eve-overrides:/in --rm lfedge/eve:latest \
installer_raw > installer.raw

For RPi (ARM) devices:
- ```
docker run -v $HOME/eve-overrides:/in --rm lfedge/eve:latest-arm64 \
live > live.img
```
- Copy and save the serial number string that is output when you run this command. You'll need to enter the serial number into the Serial Number field when you onboard your device to ZEDEDA Cloud. It will look something like this.
  - ```
  681cc64f-6633-49f3-988c-b0afde4a25fc
```

Windows OS

Open your terminal.
Ensure you are in your preferred directory for this operation. This procedure assumes HOMEPATH.
```
cd %HOMEDRIVE%\%HOMEPATH
```
Make an eve-overrides directory, which will contain your server endpoint configuration.
```
mkdir eve-overrides
```

Set your server endpoint by writing its URL to a text file named "server".

echo zedcloud.gmwtus.zededa.net > %HOMEDRIVE%\%HOMEPATH%\eve-override\server

For x86 devices:

docker run -v %HOMEDRIVE%\%HOMEPATH%\eve-overrides:/in \
--rm lfedge/eve:latest installer_raw > installer.raw

For RPi (ARM) devices:
- ```
docker run -v %HOMEDRIVE%\%HOMEPATH%\eve-overrides:/in \
--rm lfedge/eve:latest-arm64 live > live.img
```
- Copy and save the serial number string that is output when you run this command. You'll need to enter the serial number into the Serial Number field when you onboard your device to ZEDEDA Cloud. It will look something like this.
  - ```
  681cc64f-6633-49f3-988c-b0afde4a25fc
```

Next steps

You are ready to flash your EVE-OS image to a bootable drive. To do so, see our guide to flashing an EVE-OS image.