Skip to main content

Introduction

Adding an EVE-OS rootfs image to your enterprise makes that image version available for deploying to nodes. There are two methods: uploading, which copies an image from your local machine into a ZEDEDA-managed datastore, and uplinking, which registers an image that is already stored in a datastore by pointing Edge Infrastructure Services to its location and metadata. Both methods use ZCLI. GUI-based uploads are not currently supported. Uploading is supported only for ZEDEDA-managed datastores and is provided as a convenience for onboarding. Do not use ZEDEDA-managed datastores in production environments. Uplinking works with any datastore. Use this method for production environments.

Prerequisites

  • ZCLI running. See Get Started With ZCLI for authentication steps.
  • Docker installed on your local machine.
  • A datastore in your enterprise (ZEDEDA-managed or your own). See Create a Datastore for setup instructions.

Get a rootfs EVE-OS Image

You must use a rootfs image (not an installer image) for uploading and uplinking. Use docker to pull and generate the image.
  1. Choose the EVE-OS version you want to add. For a list of current LTS versions, see the LTS Policy.
  2. Navigate to your preferred working directory. The rootfs image file is saved here.
  3. Get the full version name to confirm the exact version string.
For example:
The output looks like:
  1. Pull and generate the rootfs image. Replace EVE_VERSION with your target version string and IMAGE_FILE_NAME with your preferred filename.
For example:

Upload a rootfs EVE-OS Image

Use this method to copy an image from your local machine to a ZEDEDA-managed datastore.
  1. Log in to ZCLI. See Get Started With ZCLI for authentication steps.
  2. Create an EVE-OS image entry in your enterprise. The IMAGE_NAME value must exactly match the version string you specified when generating the image (for example, 11.0.5-lts-kvm-amd64). The image format for rootfs images must be RAW.
For example:
  1. Upload the rootfs image.
For example:
  1. Verify the image entry. Look for Status: Ready in the output.
For example:
Use this method to register an image that is already stored in a datastore by associating its metadata with your enterprise.
  1. Log in to ZCLI. See Get Started With ZCLI for authentication steps.
  2. Create an EVE-OS image entry in your enterprise. The image format must be RAW.
For example:
  1. Get the SHA-256 hash and size of your image file. Run the following commands in the directory where the image is stored.
On macOS/Linux:
  1. Uplink the image using the SHA-256 hash and size values from the previous step.
For example:
  1. Verify the image entry. Look for Status: Ready in the output.

Next Steps

Manage Default EVE-OS Images

Set the new image as the default for your enterprise.

Delete an EVE-OS Image

Remove an image when it is no longer needed.

EVE-OS Management Overview

Overview of all EVE-OS image management operations.