Operations on Edge Application

Updated December 28, 2022 04:47

1. Introduction

Just like any other application, software, or operating system, you can edit, clone, or delete the Edge Application for better compatibility, increased security, and availability of the latest features with different devices or applications enhanced features resulting in enhanced user experience.

Let's now see how to perform different operations on the Edge Applications.

2. Operations Using ZedUI

Once you have onboarded (created) the Edge Application, the following are the life cycle operations you can perform through ZedUI.

2.1. Edit

Steps to edit an Edge Application:

Step 1 > Click on the 'Marketplace' () icon from the left navigation to go to the list of Edge Applications available in your Enterprise.

Step 2 > Click on the particular Edge Application card, where you want to edit the fields.

Step 3 > Click on the Edit () icon to display the fields which are editable. You can go ahead and edit most of the fields in the Edge Application detail view.

Note: If you edit the Edge Application Type as 'Container', click here to view the field parameters and update them, if required. If you edit the Edge Application Type as 'Virtual Machine', click here to view the field parameters and update them if required.

Step 4 > Click on the 'Submit' button after you complete editing the fields accordingly if any.

Step 5 > A toast message, announcing the successful submission of the Edge Application edits, appears as below:

Edge App details for aws-greengrass submitted successfully!

You can now see the Edge Application reflect the updated fields, which were updated as a part of this operation.

2.2. Clone

Instead of creating the same application from scratch, you can clone the already created application. Clone the application using the following steps:

Step 1 > Click on the More () icon on the top right corner.

Step 2 > From the dropdown, select 'Clone'.

Step 3 > The screen with all the parameters populated appears. Make sure to check if the parameters are appropriate or need to be changed accordingly.

Note: The 'Name' of the application has to be changed, as it is unique across the Enterprise.

2.3. Delete

If you no longer require the particular Edge Application, you could delete using the following steps:

Step 1 > Click on the More () icon on the top right corner.

Step 2 > From the dropdown, select 'Delete'.

Step 3 > Click the 'Confirm' button on the modal dialogue which appears as below:

Deleting these 1 edge app(s) will permanently remove the data about these edge app(s) from management platform.

Note: There is no way to reclaim the data, after the delete operation is performed.

Step 4 > A toast message, announcing the successful removal of the Edge Application, appears as below:

Edge App: aws-greengrass has been removed.

Deleting the Edge Application results in the removal of this particular application from the 'Edge Apps added in enterprise' in the above screen.

3. Operations Using zCLI

To login to ZedControl through zCLI, see here.

3.1. Edit (Update)

You can update the Edge Application using the following command:

zcli> zcli edge-app update <name> [--title=<title>] [--description=<description>] [--manifest=<manifest>]
Options–

<name> Edge Application name
--title=<title> Edge Application title
--description=<description> Description of the Edge Application
--manifest=<manifest> Edge Application manifest file

3.2. Delete

You can delete the Edge Application using the following command:

zcli> zcli edge-app delete <name> [-f]

Note: -f is to forcefully make the delete request to the ZedControl, without prompting the user.