ZEDControl Overview

ZEDEDA provides a simple and scalable cloud-based orchestration solution for distributed edge computing, eliminating the complexities of today's solutions through an open and purpose-built orchestration framework. It breaks down silos and delivers the agility customers need to evolve their connected operations with a multi-cloud strategy. Customers can now easily dropship (meaning direct delivery from the manufacturer to the customer) hardware without onsite expertise for installation, add intelligence on-demand to any edge compute at scale, and instantly unlock the value of edge data to make real-time decisions, maximize operational efficiency and drive new business outcomes.
 
ZEDEDA delivers visibility, control, and security for the distributed edge. ZEDEDA leverages Edge Virtualization Engine (EVE-OS), an open edge computing engine (part of LF Edge), to simplify the orchestration of containers and clusters (Docker and Kubernetes) and virtual machines (VMs) for cloud-native and legacy applications on any hardware (ARM, x86 or GPU). ZEDEDA also allows customers to connect to any cloud or on-premises system. By enabling freedom of hardware, application, and cloud at distributed edge scale, ZEDEDA provides a flexible foundation for customers to avoid vendor lock-in and consolidate workloads while future-proofing edge deployments.
 
Developers can deploy hardware enabled with the open-source EVE-OS and orchestrate edge nodes and applications with a multi-tenant "cloud-native" environment for IoT applications. Developers can provision resources, monitor application performance security, and perform large-scale software lifecycle management on globally distributed systems via ZedControl, all while focusing resources on app development instead of operating edge computing complexities.
 

2. ZedControl

ZedControl is a central control center that binds the elements of the distributed Edge Nodes and Edge applications running on these Edge Nodes and remotely orchestrates them for targeted business solutions. ZedControl manages and monitors all Edge Nodes, Edge Applications, Edge Networks, and more.
 
Starting with ZedControl Release 6.14.0 once logged into ZedControl, the user can switch to multiple enterprises. This means, that after login into ZedControl, the user who has access to multiple enterprises lands on the secondary login page. And thus gets a choice of login into the intended enterprise from the dropdown.
 
ZC3_Screen_1a.png
 
To get your ZedControl account details, send an email to support@zededa.com.
 

3. User Agents

The User-Agents are the interfaces users could use to access ZedControl to manage, monitor, and orchestrate the Edge Infrastructure. We offer two interfaces for ZedControl:
  • ZedUI–The Graphical User Interface to interact with the web-based ZedControl.
  • zCLI–The command-line interface is python based.
  • Terraform–Terraform with Terraform Provider ZEDCloud can manage the configuration of the objects in ZEDCloud.
 
 

4. API Token for ZedControl

API token to be used with zCLI, Terraform, or a Custom ZedControl client can be generated using the following steps. Log in to ZedControl to see the home screen, as shown below.
  • Step 1 > Click the Profile (Profile_icon.png) icon on the top navigation bar.
  • Step 2 > Click on the username from the list.
 
image__1_.png
 
Clicking on the username will take you to the User Details screen, where you can copy the session token as shown.
  • Step 3 > Click 'Copy' to copy the session token to the clipboard. You will also get a toast message announcing as shown below:
Session Token has been copied to clipboard
 
image__2_.png
 

5. ZedUI Overview

ZedUI is the web-based Graphical User Interface to interact with ZedControl.
 

5.1. Log in to ZedControl

The user can log in using one of the two login modes:
 
  • Local authentication: with username and password.
  • Single Sign-On authentication.
 
Here, you can see the local authentication used as an example to log in.
 
ZC_3_screen_1.png
 
Once you enter the user credentials and log in to ZedControl, you can see the home screen below. The first-time login will show mostly 'empty widgets' because no Edge Node would have been onboarded yet. The screenshot below is an example of an enterprise having many Edge Nodes and Edge App instances deployed.
 
ZC_3_screen_2.png
 

5.2. Top Navigation Bar (Top NAV)

The Top Navigation Bar can be broadly be divided into three main sections.
 
(a) The left section, which displays the ZedControl logo, as well as the name of your enterprise.
 
(b) The middle section displays 'All Projects' with a dropdown. You could either select All Projects or any particular 'Project' in your enterprise using the dropdown options. When a particular project is selected, all the objects related to the chosen project get filtered.
 
(c) The right section has four icons, namely, Notifications (Notifications_icon.png) (coming soon), Administration (Administration_icon.png) (this is where all the Administrative functions can be accessed, like management of Enterprise parameters, Projects, users, roles, and permissions, etc. The administration section will show the assets you have access to based on the roles and permissions you have). Help (Help_icon.png) (a place where you can find documentation links, how-to videos, and other help-related documents, We keep on updating this section), and Profile (Profile_icon.png) (this is where you could see and edit your user profile).
 
ZC_3_screen_3.png
 

5.3. Left Navigation Bar (left NAV)

You will see a main navigation bar for the UI on the left-hand side. The first icon on the top is used for expanding or collapsing the menu bar. The collapsed menu bar gives additional space for the main content.
 
ZC_3_screen_4.png
 
The icons in the left NAV are as follows:
  • Home Icon (Home_icon.png): This is the link to the default landing page for all users, the landing page will display a default set of customizable dashboard widgets.
  • Edge Nodes (Edge_Nodes_icon.png): This icon links the page that displays the edge node list. This is where you will see all the edge nodes in your enterprise, browse them by projects and states, etc.,
  • Edge App Instances (Edge_App_Instances_icon.png): This icon links to the page that displays a list of all the 'Edge App Instances in your enterprise. It also can be filtered based on your needs.
  • Cluster Instances (Cluster_instance.png): This icon links to the page that displays a list of all the Cluster Instances in your enterprise.
  • Library (Library_icon.png): Library icon takes you to a page that shows your enterprise's other asset's list view. Assets like Networks (Networks_icon.png), Network instances (Network_Instances_icon.png), Data Stores (Datastores_icon.png), EVE-OS Images (Images_icon.png), App Images (Images_icon__1_.png), Volume Instances (Volume_Instances_icon.png), etc. The primary tabs show individual links to all of the above lists.
  • Reports (Reports_icon.png): Reports link shows an interactive way to filter and view different statistics about the ZedControl assets. Could find Events, Utilization reports, and Network data flow here.
  • Jobs (Jobs_icon.png): This link shows all the Jobs that are generated while performing any function on ZedControl, like Installation or Updation of EVE-OS and many more such events. The bulk tasks like Bulk App deployment, or Bulk EVE-OS update, create a single Job that consists of multiple 'Tasks.' The jobs are always sorted based on the 'latest on the top' principle.
  • Marketplace (Marketplace_icon.png): This link takes you to Marketplace, this is where you will be able to see all supported Edge Apps (Edge_App_icon.png) and Models (Models_icon.png) in your enterprise.
 
Whenever you click on any asset, like an Edge Node, or an Edge App Instance, the asset opens in a new (1) temporary link below all the fixed menu items in the left NAV. The temporary Links could be closed using the (2) Close (assets_-M-8YZpNfHyoMqstV5LL_-MPCs4p3XJ4SKzOqtv7t_-MPCtD85Rrih1gYxTa0r_Temp-tab-close-icon.png)icon that appears upon hovering over the link. The chronology of these temporary links will be based on the 'latest on the top principle' The maximum number of temporary links that could open depends on the screen resolution and the available space in the left NAV.
 
ZC_3_screen_5.png
 

5.4. Content Area

This is the main content area (grey background) that displays' Panels.' The content always comes on these white panels. For example, the Home page has a dashboard (which is customizable) widgets each in a panel.
 
ZC_3_screen_6.png
 
The list views have two panels, the top panel is a summary widgets panel (which is collapsed by default), and the bottom content panel shows the table of the list of 'assets' and so on.
 
ZC_3_screen_7.png
 
Page-level actions are icons that appear at the right top corner of the content area. These are the actions that can perform on the content of the page. For example, in most of the list views, you see three icons, Add (Add_icon.png) to add an asset to the list, Magnifier (Magnifier_icon.png) to filter the assets, and More (More_icon.png) icon to see the other actions that can perform on the content page.
 

Secondary Horizontal Navigation

The secondary navigation bar shows the Links in the grey background. You could click on an element to see the details in the content area. For example–the Library page shows primary navigation, which shows navigation links to objects like Networks, Network Instances, Data Stores, EVE-OS Images, App Images, and Volume Instances.
 
ZC_3_screen_8.png
 

Tertiary Horizontal Navigation

The tertiary horizontal navigation bar renders with buttons style white background. An example of this is: Any detailed object view shows this tertiary navigation, where the different tabs show different sections. For example, the Edge Nodes detail view shows tabs like 'Status,' 'Basic Info,' 'Adapters,' 'Events' related to a particular Edge Node.
 
ZC_3_screen_9.png
 
The most common UI components used across ZedUI are discussed in this document. Other UI components are explained in the subsequent sections.
 

6. zCLI Overview

zCLI is a python based command-line interface used to interact with ZedControl.
 

6.1. Requirements

  • You will have to first download Docker before running the zCLI.
  • Once Docker is installed, head to the terminal and run the commands mentioned in the next section:

 

6.2. Commands usage

Run the Docker using the command: docker run -it zededa/zcli:latest
$ docker run -it zededa/zcli:latest
zcli>
Warning: Docker will download quite a few files over the internet on the first-ever attempt.

 

6.3. Options to Login into zCLI

 

Option A

Login into zCLI using the credentials provided by ZEDEDA. Point zCLI to the cloud by executing the zcli configure command.
 
zcli> zcli configure
Server [zedcontrol.zededa.net]:
Username [admin@enterprise.com]:
Password [**********]:
Output format [text]:
zcli>
 

Option B

Login into zCLI using a token generated in the ZedUI screen.
 
Once you enter the user credentials and log in to ZedControl, you can see the home screen below.
 
  • Step 1 > Click the Profile (Profile_icon.png) icon on the top navigation bar.
  • Step 2 > Click on the username from the list.
 
 
ZC_3_screen_10.png
 
Clicking on the username will take you to the User Details screen to copy the session token as shown.
  • Step 3 > Click 'Copy' to copy the session token to the clipboard. You will also get a toast message announcing as shown below:
Session Token has been copied to clipboard
 
ZC_3_screen_11.png
 
  • Step 4 > You can paste the token in the below zCLI configure screen.
zcli> zcli configure
Server [zedcontrol.zededa.net]:
Login with token?(y/n) [n]: y
Token: <enter the copied token here>
Output format [text]:
zcli>
 
  • Step 5 > Login into the configured cloud by executing thezcli login command.
     
zcli> zcli login
User admin@enterprise.com logged in.
zcli>
 

6.4. List of zCLI Commands

Once you have logged in to the zCLI, execute the zcli command and hit the return button to display usage, options, and commands sections as shown below. You can self-read the sections with descriptions for each CLI term.
 
zcli> zcli
Zededa Command Line Utility
 
Usage:
zcli --version
zcli [--help] [--paginate] [--debug] [--format=<json|text>]
[--no-verify] <command> [<args>...]
 
options:
-v, --version Show Zedcontrol Version.
-h, --help Show this message.
-p, --paginate Paginate the output.
-d, --debug DEBUG mode.
-o, --format=<json|text> Print REST API response in given format.
-k, --no-verify Do not verify SSL certificate.

commands:
configure Configure access to Zedcontrol
login Login to Zedcontrol
logout Logout from Zedcontrol
auth-profile Manage authorization profiles
datastore Manage datastores for images
edge-app Manage application edge-app to run on your edge-nodes
edge-app-instance Manage application instance on your edge-nodes
edge-node Manage Edge Nodes
events View events from your edge-nodes
image Manage application images in your datastores
model View available models
network Manage network instances on your edge-nodes
network-instance Manage network-instances
project Manage projects
role Mange roles
user Manage user access to your edge-nodes
volume-instance Mange Volume instances
zcli>
 
Note: If the command gets executed successfully, then there is no output message displayed showing the same. However, if the command fails, an error message is displayed accordingly.
 

7. Terraform Provider ZEDCloud

See Terraform Provider ZEDCloud for more details.
 
The "We have detected that you have disabled use of cookies for this site. To continue using the portal, we request you to enable the same for Zededa.net domain. Click here to learn more about it" message means that your browser couldn't create a secure cookie, or couldn't access that cookie to authorize your login. This can be caused by ad- or script-blocking plugins and the browser itself if it's not allowed to set cookies.
 
The following steps address this issue for different browsers:
 

8.1. Chrome

 
ZC_3_screen_12.png
  • On your computer, open Chrome.
  • At the top right, click on the more icon and then click on 'Settings' from the dropdown.
  • Click on 'Privacy and Security' on the left navigation to display the various sections.
  • Under the 'Privacy and Security' section, click on 'Cookies and other site data' to view various cookie settings.
  • Scroll down and click on the 'Add' button next to the 'Sites that can always use cookies' section.
  • Enter '[*.]zededa.net' in the dialog box and click 'Add.'
  • Reload Chrome and log into the ZedControl account.
 

8.2. Firefox

ZC_3_screen_13.png

 
  • On your computer, open Firefox.
  • At the top right, click on the more icon and then click on 'Preferences' from the dropdown.
  • Click on 'Privacy and Security' on the left navigation to display the various sections.
  • Scroll down and click 'Manage Exceptions' under the 'Cookies and Site Data' section.
  • Enter 'zedcontrol.zededa.net' in the dialog box, click 'Allow,' and click on 'Save Changes.'
  • Reload Firefox and log into the ZedControl account
    .

8.3. Safari

ZC_3_screen_14.png

 
  • Click the 'Safari' menu.
  • Click the 'Preferences' menu item from the dropdown menu in the navigation bar or by typing Cmd +, (⌘,).
  • Click the 'Privacy' tab.
  • Choose your preferred Cookies and tracking settings.
    • You will see the 'Website Tracking' and 'Cookies and Website Data' checkboxes on the Privacy Preferences tab.
    • Enabling Prevent cross-site tracking blocks third-party cookies from being set as well as third-party websites from storing data on your computer. Enabling this option is a good step in helping prevent companies from tracking your activity online.
    • Enabling Block all cookies will prevent Block First-Party cookies and Third-Party cookies. Enabling this may cause websites not to work properly, and Safari will warn you about this if you choose this option.
    • The right balance of settings enables preventing cross-site tracking and disabling Block all cookies.
    • If you click the Manage Website Data button, you'll see a list of website domains stored on your computer. Search for 'zedcontrol.zededa.net' and all ZedControl-related entries.
Note: You can remove some or all of the listed website domains if you don't need them.
  • Close the Preferences window.
  • Reload Safari and log into the ZedControl account.
 
If you continue to see the same problem after doing this, please send an email to support@zededa.com
 
Was this article helpful?
1 out of 1 found this helpful

Articles in this section