1. Introduction
Just like any other managed hardware device, you can activate, deactivate, reboot, or delete the edge nodes along with updating EVE-OS for better compatibility, increased security, and availability of the latest features with different devices resulting in an enhanced user experience.
Let's now see how to perform different operations on edge applications.
2. Operations Using UI
After you log in to the ZEDEDA platform, you can perform the following life cycle operations on the edge nodesThe life cycle operations for edge nodes are:
- Activate
- Deactivate
- Delete
- Off-board
- Prepare Power Off
- Reboot
- Update EVE-OS image
You can initiate the operations from 3 different screens.
Option A: Dashboard
From the dashboard, you can initiate 'Update EVE-OS' life cycle operations from the 'Quick Links' widget:
Option B: Edge Node List View
After you log in to the ZEDEDA platform, click on the 'Edge Nodes' link on the left panel, which will take you to the Edge Nodes list view screen. The top panel shows (collapsed by default) dashboard summary widgets and the bottom panel shows a table of the list of the edge nodes.
- Step 1 > Click on the checkboxes to select the edge node(s) from the list on which the required operation needs to be performed. You can perform all operations either on single or multiple Edge Nodes.
- Step 2 > Click on More (
) icon on the top right corner to view the following life cycle operations: (B.1) Activate, (B.2) Deactivate, (B.3) Delete, (B.4) Off-board, (B.5) Prepare Power Off, (B.6) Reboot, and (B.7) Update EVE-OS Image.
You can perform all operations mentioned above from the 'edge nodes list view' and 'edge node detail view' screens. We will go through all the operations from the 'edge nodes list view' screen for simplicity.
Let's go through the dropdown list operations:
B.1. Activate
You can activate the edge node(s) using the following steps:
- Step 1 > From the dropdown, select 'Activate'. This activates all the selected edge nodes.
- Step 2 > A toast message announcing the activate request appears, as shown below:
Activate request to 3 Edge Nodes was successfully submitted.
Activating the edge node(s) shows Admin Status as 'Registered' and eventually turns the Run state to 'Online.'
B.2. Deactivate
You can deactivate the edge node(s) using the following steps:
- Step 1 > From the dropdown, select 'Deactivate'.
- Step 2 > Click the 'Confirm' button on the modal dialogue, which appears as below:
You are about to deactivate 3 Edge Node(s) after which you will no longer have access to them. To access again, manual restart of the Edge Node(s) will be required.
Note: Deactivating will cause the applications running on these assets to be offline as well.
- Step 3 > When you click on the 'Confirm' button, a toast message appears as shown below:
Deactivate request to 3 Edge Nodes was successfully submitted.
Deactivating the edge node(s) shows Admin Status as 'Inactive' and Run state as 'Unprovisioned.'
B.3. Delete
You can delete the edge node(s) using the following steps:
- Step 1 > From the dropdown, select 'Delete'.
- Step 2 > Click the 'Confirm' button on the modal dialogue, which appears as below:
You are about to Delete 3 Edge Node(s). This will permanently remove these Edge Node(s) and associated state from the management platform. If the selected Edge Node(s) have a default Network Instance, the delete operation will cascade to the Network Instances as well.
Note: After the delete operation is performed, there is no way to reclaim the saved state of the deleted Edge Nodes using the cloud controller.
- Step 3 > When you click on the 'Confirm' button, a toast message appears as shown below:
Delete request to 3 Edge Nodes was successfully submitted.
The 'Delete' operation removes the edge node(s) from the list view, as seen in the above screen.
B.4. Off-board
The off-board feature enables the users to migrate the edge nodes across the enterprise retaining the volume instance(s) intact.
Note: Other than the edge node default network instance and the user-created volume instance(s), everything else (edge application instances, manually created network instance(s), etc.) needs to be deleted before offboarding.
For example, if the edge node has to be shipped to the low bandwidth customer location, there will be a delay in downloading the required software (volume instances) and onboarding the edge node into the ZEDEDA platform. In such an instance, all the required software is downloaded to the edge node and onboarded to a particular enterprise (for example, a manufacturing facility), where the bandwidth connectivity is not an issue. This edge node is offboarded from the manufacturing facility enterprise and re-onboarded to either the same manufacturing enterprise or another enterprise (with low bandwidth issues).
Note: The re-onboarding workflow is the same as the initial onboarding. The device serial number of the edge node must match while re-onboarding. This is the recommended method.
The user can also use the soft serial key to re-onboard. However, this method has its own limitations in that the USB stick with the soft serial key may not be available for the users easily.
You can off-board the edge node(s) using the following steps:
- Step 1 > From the dropdown, select 'Off-board'.
- Step 2 > Click the 'Confirm' button on the modal dialogue, which appears as below:
- Step 3 > When you click on the 'Confirm' button, a toast message appears as shown below:
B.5. Prepare Power Off
This feature is useful when you need to gracefully shut down the set of applications running on EVE-OS.
You can prepare for the power off of an edge node(s) using the following steps:
- Step 1 > From the dropdown, select 'Prepare Power Off'.
- Step 2 > Click the 'Confirm' button on the modal dialogue, which appears as below:
- Step 3 > When you click on the 'Confirm' button, a toast message appears as shown below:
B.6. Reboot
You can reboot the edge node(s) using the following steps:
- Step 1 > From the dropdown, select 'Reboot'.
- Step 2 > Click the 'Confirm' button on the modal dialogue, which appears as below:
- Step 3 > When you click on the 'Confirm' button, a toast message appears as shown below:
Rebooting the edge node(s) must show Admin Status as 'Active' and the Run state will eventually become 'Online.'
B.7. Update EVE-OS Image
Option C: Edge Node Detail View
To go to the edge node detail view, click on the 'Edge Nodes' link on the left panel, which will take you to the edge nodes list view screen. Click on one of the edge nodes to take you to the edge node detail view of that particular edge node.
Click on the More () icon on the top right corner, to display the dropdown list showing the same operations as seen in the edge nodes list view screen. You can follow the same steps mentioned in the option B sub-sections.
) icon on the top right corner, to display the dropdown list showing the same operations as seen in the edge nodes list view screen. You can follow the same steps mentioned in the option B sub-sections.
3. Operations Using CLI
3.1. Activate
You can activate the edge node using the following command:
zcli> zcli edge-node activate <name>
3.2. Deactivate
You can deactivate the edge node using the following command:
zcli> zcli edge-node deactivate <name>
3.3. Delete
You can delete the edge node using the following command:
zcli> zcli edge-node delete <name> [-f]
Note: -f in Reboot and Delete operations are used to forcefully make the delete request to the ZEDEDA, without prompting the user.
3.4. Off-board
You can off-board the edge node using the following command:
zcli> zcli edge-node offboard [-f] <name>
3.5. Reboot
You can reboot the edge node using the following command:
zcli> zcli edge-node reboot [-f] <name>
3.6 Prepare Power Off
You can prepare the power off of an edge node using the following command:
zcli edge-node prepare-poweroff <name> [-f]
3.7. Update
You can update the edge node using the following command:
zcli> zcli edge-node update <name> [--title=<title>] [--description=<description>] [--tags=<key:value>...] [--project=<project>] [--clear-onboarding-certs] [--config=<key:value>...] [--network=<network>...] [--network-tag=<key:value>...]
3.8. Update EVE-OS image
You can update the EVE-OS image of the edge node using the following command:
zcli> zcli edge-node eveimage-update <name> --image=<image> [--activate]
3.9. Remove the EVE-OS image
You can remove the EVE-OS image of the edge node using the following command:
zcli> zcli edge-node eveimage-remove <name> --image=<image>
3.10. Get-config
You can get the configuration of the edge node using one of the following commands:
zcli> zcli edge-node get-config <name> [--offline] [--summary] [--next]
zcli> zcli edge-node gen-config <name>
3.11. Get-PCR Values
You can get the PCR values from the edge node using the following command:
zcli> zcli edge-node get-pcr <name>