1. ZEDEDA Help Center
  2. Edge Management
  3. EVE-OS

Get EVE-OS

Updated

Before you start

This guide describes how to get an EVE-OS image or installer file, the first step to installing, upgrading, or live-booting EVE-OS on an edge node.

Before proceeding, you may want to read our EVE-OS image overview. anchor

Prerequisites

Software requirements

You must have Docker installed and running.

ZEDEDA Cloud requirements

ZEDEDA hosts many controller clusters. For installer and live images, you must know your cluster’s hostname. You don’t need to create a cluster configuration for rootfs images.

Example:

zedcloud.gmwtus.zededa.net
Configure an EVE-OS image’s cluster

Upon first boot, a device running EVE-OS will try to connect to a ZEDEDA Cloud cluster to get its initial configuration.

Edge nodes will try to connect to the following cluster endpoint by default:

zedcloud.zededa.net

If your enterprise is on a different cluster, you’ll need to create a .txt configuration file named "server" with a single line containing your cluster hostname. Then, when you create your EVE-OS image file, you’ll inject your server file into your EVE-OS image.

This procedure uses the following endpoint as an example (replace this with your cluster endpoint):

zedcloud.gmwtus.zededa.net

Follow these steps to create a server configuration for your EVE-OS image.

macOS or Linux
  1. Open your terminal.
  2. Navigate to a directory of your choice. This example uses the your home directory, represented by the $HOME system variable. 
    cd $HOME
  3. Create a directory called eve-overrides. 
    mkdir eve-overrides
  4. Create a file called “server” within this directory and write the hostname of your cluster into it. 
    echo zedcloud.gmwtus.zededa.net > $HOME/eve-overrides/server
Windows
  1. Open Powershell.
  2. Navigate to a directory of your choice. This example uses your home directory, represented by the $HOME system variable. 
    cd $HOME
  3. Create a directory called eve-overrides. 
    mkdir eve-overrides
  4. Create a file called “server” within this directory and write the hostname of your cluster into it. 
    echo zedcloud.gmwtus.zededa.net > $HOME\eve-overrides\server

Raspberry Pi compatibility

EVE-OS is currently not compatible with Pi5 devices.

If you plan to install EVE-OS onto a Raspberry Pi (ARM) device, ensure that it meets the following hardware requirement.

  • Raspberry Pi 4 Model B with at least 4GB RAM
  • MicroSD card (16GB or larger recommended)

Get an EVE-OS image

The procedures in this section each describe how to run a Docker container that will download EVE-OS resources from Docker Hub and generate a usable EVE-OS image.

Latest LTS version of EVE-OS:

12.0.3-lts
Optional: Choose an alternate EVE-OS image version

This section will help you determine the name of the EVE-OS image that you need so you can find it in Docker Hub and download it.

Most use cases require the latest LTS version. Be sure that you understand your reason for using a different version.

Complete these subsections in order.

Find your EVE-OS version

This subsection is optional because examples in the following procedures all assume that you need the latest LTS version of EVE-OS. Use these resources here to find an alternate version:

Determine your EVE-OS image’s name

This subsection describes how to determine the name of the EVE-OS image that you need so you can find the image in Docker Hub.

Ensure you are familiar with the EVE-OS naming conventions before proceeding.

To determine the name of your EVE-OS image, follow these steps.

  1. Recall the EVE-OS version number you need. This is the first component of your image name. For example: 
    12.0.3-lts
  2. Determine the system architecture (AMD64 or ARM64) of your edge node hardware. This is the second component of your image name. For example: 
    12.0.3-lts-amd64

The following procedures in this guide will use 12.0.3-lts-kvm-amd64 as an example image name.

Search Docker Hub

You can verify that the image you need is available to download, search for it in Docker Hub.

  1. Go to Docker Hub.
  2. Click on the Tags tab.
  3. Enter your image name into the Filter Tags search field.
  4. Check the results for your image.

Choose a procedure

Download procedures differ depending on the image's intended use.

These procedures specify the latest LTS in their examples. To substitute another version, replace "12.0.3-lts".

Open the terminal (macOS and Linux users) or Powershell (Windows users) and choose one of the following procedures.

Get an EVE-OS installer image (to install using USB or PXE)
Ensure that you have completed the prerequisites. 

 

To get an EVE-OS installer image, follow these steps.

  1. Navigate to a directory of your choice. 
    cd $HOME
  2. Create a directory for your EVE-OS image and navigate into it. 
    mkdir eve-images && cd eve-images
  3. Download and generate your EVE-OS installer image. Choose the command for your edge node’s hardware architecture. If your controller cluster is zedcloud.zededa.net, the following commands don't need
    -v $HOME/eve-overrides:/in

    Windows
    AMD64 
    docker run -v $HOME/eve-iso:/out lfedge/eve:12.0.3-lts-amd64 -f raw installer_iso
    ARM64 
    docker run -v $HOME/eve-iso:/out lfedge/eve:12.0.3-lts-arm64 -f raw installer_iso
    macOS and Linux
    AMD64 
    docker run -v $HOME/eve-overrides:/in lfedge/eve:12.0.3-lts-amd64 -f raw installer_raw > installer.raw
    ARM64 
    docker run -v $HOME/eve-overrides:/in lfedge/eve:12.0.3-lts-arm64 -f raw installer_raw > installer.raw
  4. Print the contents of your current directory to verify that the file installer.raw was created. 
    ls
  5. Proceed to flashing an EVE-OS image.
Get an EVE-OS live image (to live-boot from USB or SD)
Ensure that you have completed the prerequisites. 

 

To get an EVE-OS image that you can live-boot on an edge node without onboard storage, follow these steps.

  1. Navigate to a directory of your choice. 
    cd $HOME
  2. Create a directory for your EVE-OS image and navigate into it. 
    mkdir eve-images && cd eve-images
  3. Download and generate your EVE-OS live image. Choose the command for your edge node’s hardware architecture. If your controller cluster is zedcloud.zededa.net, the following commands don't need
    -v $HOME/eve-overrides:/in

    Windows
    AMD64 
    docker run -v $HOME/eve-iso:/out lfedge/eve:12.0.3-lts-amd64 live
    ARM64 
    docker run -v $HOME/eve-iso:/out lfedge/eve:12.0.3-lts-arm64 live
    macOS and Linux
    AMD64 
    docker run -v $HOME/eve-overrides:/in lfedge/eve:12.0.3-lts-amd64 -f live  live.img
    ARM64 
    docker run -v $HOME/eve-overrides:/in lfedge/eve:12.0.3-lts-arm64 -f live  live.img
  4. Copy and save the serial number string (in UUID format) that was printed by the previous command in the last line of output. You'll need it when you onboard your edge node. Example: 
    681cc64f-6633-49f3-988c-b0afde4a25fc
  5. Print the contents of your current directory to verify that the file installer.raw was created. 
    ls
  6. Proceed to flashing an EVE-OS image.
Get a rootfs EVE-OS image (to update existing EVE-OS installations and live images)

Ensure that you have completed the prerequisites. You don’t need to provide a server configuration for rootfs images.

Rootfs EVE-OS images are used to upgrade existing installations of EVE-OS by uploading them to ZEDEDA Cloud and deploying them from there.

To get an EVE-OS rootfs image, follow these steps.

  1. Navigate to a directory of your choice. 
    cd $HOME
  2. Create a directory for your EVE-OS image and navigate into it. 
    mkdir eve-images && cd eve-images
  3. Download and generate your rootfs EVE-OS image. Choose the command for your edge node’s hardware architecture.

    Windows
    AMD64 
    docker run -v $HOME/eve-iso:/out lfedge/eve:12.0.3-lts-amd64 rootfs
    ARM64 
    docker run -v $HOME/eve-iso:/out lfedge/eve:12.0.3-lts-arm64 rootfs
    macOS and Linux
    AMD64 
    docker run --rm lfedge/eve:12.0.3-lts-arm64 rootfs  12.0.3-lts-arm64-rootfs.img
    ARM64 
    docker run --rm lfedge/eve:12.0.3-lts-arm64 rootfs  12.0.3-lts-arm64-rootfs.img
  4. Print the contents of your current directory. 
    ls
  5. Verify that you have your rootfs image: 12.0.3-lts-ARM64_OR_AMD64-rootfs.img
  6. Proceed to adding an EVE-OS image to ZEDEDA Cloud.

Next steps

If you generated an installer or a live EVE-OS image, you're ready to flash your EVE-OS image to a bootable drive. To do so, see our guide to flashing an EVE-OS image.

If you generated a rootfs image, proceed to our guide to adding an EVE-OS rootfs image to ZEDEDA cloud.

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more