1. Introduction
An 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 App Image to ZedControl.
1.1. List View
After you log in to ZedControl:
- Step 1 > Click on the 'Library' (
) icon from the left navigation.
- Step 2 > Select 'App Images' from the top navigation bar.
- Step 3 > Click on the expand (
) icon to view the summary panel.
Summary Panel shows the total number of application images as 'App Image Status Distribution', 'App Image Architecture Distribution', and '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 of the App Images in the list view to show the detailed view of the same.
- Step 2 > A temporary tab (
) is created navigating you to the detailed view of the selected App Image.
The detail view has tertiary navigation with the Basic info tab.
2. Operations Using ZedUI
The following are the App Images operations:
2.1. Create
The create operation can be performed in the App Images list view only. After you log in to ZedControl, create an 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 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 > Populate the input field values for "Zededa-AWS-Image" as Data Store.
- Step 4 > Click on the 'Add' button.
Details section
| Input Field | Value |
| 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(*) | To pull image with version and digest, syntax is <image_name>@<digest value>. For example, docker pull nginx:1.21@sha256:2275af0f20d71b293916f1958f8497f987b8d8fd8113df54635f2a5915002bf1 |
| Image Size(*) | Image size in Bytes, KB (Kilobytes), MB (Megabytes), GB (Gigabytes), or TB (Terabytes). |
- Step 5 > When you click on the 'Add' button, a toast message appears as shown below:
Image: test has been added.
- Step 6 > You can see that the new App Image by name 'test' is added in the App Images list view, as shown below.
The App image is created successfully!
2.2. Read
The read operation can be performed in the App Images detail view only. After you log in to ZedControl, click on the 'Library' menu from the left navigation and select 'App Images' to go to the list of already available App Images. Click on any of the App Images in the list view to show the detailed view of the same.
The read view shows only the 'Basic Info' section.
Basic Info
a) Identity
For information on the field values and their 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 be performed in the App Images detail view only. After you log in to ZedControl, click on the 'Library' menu from the left navigation and select 'App Images' to go to the list of already available App Images. Click on any of the App Images in the list view to show the detailed view of the same.
Basic Info
Update/edit an App Image using the following steps:
- Step 1 > Click on the Edit (
) icon.
The 'Basic Info' section allows you to update/edit most of the fields. For information on the editable field values and their descriptions, refer to the tables under the create operation.
- Step 2 > Update the editable fields of the 'Identity' section. For information on the editable field values and their descriptions, refer to the tables under the create operation.
- Step 3 > Click on 'Submit' button.
- Step 4 > When you click on the 'Submit' button, a toast message, announcing the successful submission of the App Image, appears below:
Image: test has been updated.
The Application Image is updated successfully!
2.4. Delete
The delete operation can be performed in both the App Images list view and detail view. After you log in to ZedControl, if you no longer require the App Image, you could delete it using the following steps:
Note: You can perform the delete operation on a single application image or multiple application images on either the list view or detail view screen. For simplicity, we will follow the multiple application images workflow, which you can carry out from the list view.
- Step 1 > Click on the check boxes of the application images list on which the required operation needs to be performed.
- Step 2 > Click on the More (
) icon on the top right corner.
- Step 3 > From the dropdown, select 'Delete'.
- Step 4 > Click the 'Confirm' button on the modal dialogue which appears as below:
Deleting these 2 Image(s) will permanently remove the data about these images(s) from management platform.
Note: There is no way to reclaim the data, after the delete operation is performed.
- Step 5 > When you click on the 'Confirm' button, a toast message, announcing the successful submission of the delete request of the App Image appears.
2 images were successfully deleted.
The selected App images are deleted successfully!
3. Operations Using zCLI
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-raghu vyos-1.2.1-raghu 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!