1. Introduction
An Edge Application Image is binary data stored in one of the Data Stores along with its meta-data such as size, format, architecture, etc.
A quick overview of How to Add an Edge App Image to the ZEDEDA platform.
1.1. List View
After you log in to the ZEDEDA GUI, hover on the Library menu. Once the list navigation list appears, click on the 'Edge App Images.'
Click the expand icon to view the summary panel.
The summary Panel shows the total number of application images as 'Edge App Image Status Distribution,' 'Edge App Image Architecture Distribution,' and 'Edge App Image Format Distribution' widgets in the donut and horizontal bar charts. You can hover around these donuts to get the number in each distribution.
1.2. Detail View
- Step 1 > Click on any Edge App Images in the list view to show the detailed view.
- Step 2 > The detailed view of the selected Edge App Image can be seen below.
2. Operations using ZEDEDA GUI
The following are the Edge App Images operations:
2.1. Create
The create operation can only be performed in the Edge App Images list view. After you log in to the ZEDEDA GUI, create an Edge Application Image using the following steps:
- Step 1 > Click on the Add icon
- Step 2 > Populate the input field values for the 'Identity' section, as instructed in the table.
Identity section
Define the basic identification details of the Edge App Image.
| Input Field | Value |
| Name(*) |
This is unique across the enterprise and cannot be changed.
|
| Title(*) | This is user-defined and can be changed. |
| Description | A detailed explanation of what the application image is used for. Not mandatory. |
| Image Format(*) |
Select the appropriate Image Format from the dropdown list.
|
| Image Architecture(*) |
Select the appropriate Image Architecture from the dropdown list.
|
- Step 3 > After choosing the Image format and architecture, either i) click on the 'Upload.' option to get the page below or ii) click the 'Uplink' option, as needed.
The upload/uplink related fields are detailed in the table below.
| Input Field | Value |
| Image Path |
Give the image path from where the image needs to be uploaded.
|
| Data Store(*) |
Select the appropriate Data Store from the dropdown list.
|
| Scope: Projects | Select the appropriate project from the dropdown list. |
| Add Image Via (*) | Choose either 'Uplink' or 'Upload.' The 'Upload' option is currently supported in AWS only. A path must be provided for uploading the image. The 'Uplink' option provides the next set of fields to be populated. |
| Image SHA256(*) | The syntax is <image_name>@<digest value> to pull an image with version and digest. For example, docker pull nginx:1.21@sha256:2275af0f20d71b293916f1958f8497f987b8d8fd8113df54635f2a5915002bf1 |
| Image Size(*) | Image size in Bytes, KB (Kilobytes), MB (Megabytes), GB (Gigabytes), or TB (Terabytes). |
| Image Relative URL (*) | Provide the relative URL. |
- Step 4 > The following toast messages appear when you click the 'Add' button.
- Step 5 > You can see that the new App Image by name 'test' is added in the App Images list view, as shown below.
The Edge App image is created successfully!
2.2. Read
The read operation can only be performed in the Edge App Images detail view. After you log in to the ZEDEDA GUI, hover on the 'Library' menu and click on 'Edge App Images' to go to the list of already available Images. Click on any Edge App Images in the list view to show the detailed view.
The read view shows only the 'Basic Info' section.
Basic Info
a) Identity
For information on the field values and descriptions, refer to the tables under the create operation.
b) Details
For information on the field values and their descriptions, refer to the tables under the create operation.
2.3. Update (Edit)
The update/edit operation can only be performed in the Edge App Images detail view. After you log in to the ZEDEDA GUI, hover on the 'Library' menu and click 'Edge App Images' to go to the list of already available Images. Click on any App Images in the list view to show the detailed view.
Basic Info
Update/edit an App Image using the following steps:
- Step 1 > Click on the Edit icon.
The 'Basic Info' section lets you update/edit most fields. Refer to the tables under the create operation for information on the editable field values and their descriptions.
- Step 2 > Update the editable 'Identity' and 'Details' section fields. For information on the editable field values and their descriptions, refer to the tables under the create operation.
- Step 3 > Click on the 'Save' button.
- Step 4 > A toast message announcing the successful submission appears below when you click the 'Save' button.
The Edge App Image is updated successfully!
2.4. Delete
The delete operation can be performed in the App Images list view and the detail view. After you log in to the ZEDEDA GUI, if you no longer require the App Image, you can delete it using the following steps:
Note: You can delete single or multiple application images on either the list view or detail view screen. For simplicity, we will follow the single application image workflow, which you can carry out from the list view.
- Step 1 > Select the Edge Application Image that needs to be deleted.
- Step 2 > Click on the More icon in the top right corner.
- Step 3 > From the dropdown, select 'Delete.'
- Step 4 > Click the 'Delete' button on the modal dialogue, which appears as below:
- Step 5 > A toast message announcing the successful submission appears when you click the 'Confirm' button.
The selected App images are deleted successfully!
3. Operations Using ZEDEDA CLI
3.1. Create
You can create an App Image using the following command:
zcli> zcli image create <name> --datastore-name=<datastore> --arch=[AMD64|ARM64] --image-format=[raw|qcow|qcow2|vhd|vmdk|ova|vhdx|container] [--image-url=<rel_url>] [--title=<title>] [--type=[Eve|Application|EvePrivate]]
You can either 'Upload' the image binary from the local drive or 'Uplink' it from any cloud using the following commands:
zcli> zcli image upload <name> --path=<path> [--chunked]
zcli> zcli image uplink <name> [--datastore-name=<datastore>] [--image-sha=<Sha256> --image-size=<size>] [--image-url=<rel_url>]
3.2. Read (Show)
You can use the following command to see the created App Images details:
zcli> zcli image show [[[<name> | --uuid=<uuid> | --latest=[AMD64|ARM64]] [--detail]] | [--type=[Eve|Application|EvePrivate] --arch=[AMD64|ARM64] --status=<status> --datastore-name=<datastore> --summary --name-pattern=<name-pattern>]]
For example, the show command for an App Image displays the following output:
zcli> zcli image show
Image Title Type Format Size Status
------------------------ ---------------- ---- -------- -------- ----------
vyos-1.2.1. vyos-1.2.1. IMAGE_TYPE_APPLICATION QCOW2 416.6 MB IMAGE_STATUS_READY
vyos-image vyos-image IMAGE_TYPE_APPLICATION QCOW2 243.6 MB IMAGE_STATUS_READY
Total 4 Active Apps 2 Active Base Images 2 Total Apps 2 Total Base Images 2
zcli>
3.3. Update (Edit)
You can update an App Image using the following command:
zcli> zcli image update <name> [--title=<title>] [--arch=[AMD64|ARM64]]
3.4. Delete
You can delete an App Image using the following command:
zcli> zcli image delete <name> [-f]
Note: -f is to forcefully make the delete request to the ZedControl, without prompting the user.
App Image operations are successfully executed!