Azure IoT Hub Integration

1. Introduction

A Project in ZedControl is the organization/grouping of various assets under an Enterprise. You can create different projects based on your business segmentation, functional or geographical segmentation, or any of your business logic.
 
Azure projects are specially built with Azure-specific features that facilitate the integration of ZEDEDA edge nodes into the Azure IoT Hub. After doing this, it becomes easy to manage your edge devices added to Azure IoT Hub.
 
Customers have to perform several steps to deploy the Azure module on the Edge Node. To simplify this effort (one click), ZEDEDA has integrated Azure with ZedControl.
 
A quick highlight of what is explained in this document is represented below as a workflow.
 
AZI_3_Infographic_1.png
 

1.1. List View

After you log in to ZedControl:
  • Step 1 > Click on the Administration (Administration_icon.png) icon.
  • Step 2 > Click on 'Projects'.
 
AZI_3_Screen_1.png
 
  • Step 3 > Click on the expand (Expand_Panel_icon.png) icon to view the summary panel.
 
AZI_3_Screen_2.png
 
Summary Panel shows the total number of projects based on the 'Project Status' donut view. You can hover around this donut to get the status of each Project present in your Enterprise.
 

1.2. Detail View

  • Step 1 > Click on one of the projects in the list view to show the detailed view of the same.
 
AZI_3_Screen_3.png
 
  • Step 2 > A temporary tab is created, navigating you to the detailed view of the selected Project.
 
AZI_3_Screen_4.png
 

2. Policies

Some policies govern the behavior of an Azure project.
 

2.1. Azure Cloud Policy

These are the common attributes of your Azure subscription, which can be used across the Edge Nodes and Edge Application deployments. For example, Cloud Policy–Includes client details, service details, and custom variables.
 

2.2. Azure Module Policy

A module policy manifest is a JSON document that describes the modules to be configured on the targeted Edge Nodes. It contains the configuration metadata for all the modules, including the required system modules. This helps to configure modules for a large number of Edge Nodes manage and configure applications on a large number of Edge Nodes. Once you create a module, you want to deploy it to your Edge Node(s). If you have multiple modules that work together to collect and process data, you can deploy them all simultaneously and declare the routing rules that connect them. Once you add the new Edge Node in this Project, the modules defined in the policy will automatically be deployed on it.
 
Starting with ZedControl Release 5.18.0, multiple Azure module policies are supported in ZedUI along with newly introduced editable module tag, priority, and twin details. As long as tags are separate or priorities are set correctly, the matching number of deployments will happen through an Azure-managed deployment manifest.
 
Multiple Azure module policies mean you can now run the same modules on more than one edge node with different twin settings. The module policy with higher priority will get applied.
 

3. Operations Using ZedUI

3.1. Create an Azure Project

The create operation can be performed in the Projects list view only. After you log in to ZedControl, create a Project using the following steps:
  • Step 1 > Click on the Add (Add_icon.png) icon
 
AZI_3_Screen_5.png
 
  • Step 2 > Under 'Profile', select 'Azure' from the dropdown. Populate the input field values for the 'Details' section, as instructed in the table.
  • Step 3 > Under 'Enrollment Type', you can either select 'Symmetric Key' or 'TPM'. Skip step 4 if you have selected 'TPM' as the enrollment type.
 
AZI_3_Screen_6.png
 

Details section

Define the basic identification details of the Project.
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 Project is used for. Not mandatory.
Profile
You will need to select 'Cloud Profile' using the dropdown menu.
  • Select 'Regular' if you want the Project to be regular.
  • Select 'Azure' if you want to make this an Azure Project. (If you are already using Azure to manage the data on the cloud, we have a simple Azure integration option that starts with selecting the 'Profile' as Azure).
 
Azure Client Details–Common for almost all Azure services. You are registering your application to be able to be recognized by Azure from the Active Directory (AD) tenant that is taking care of your subscription. For more details, click here.
Input Field Value
App id(*) The Application ID is assigned to your app when registering it with Azure AD. You can find this in the Azure Portal.
App Password(*) The application password to sign in.
Tenant id(*) An ID is used to control who can sign into the application.
 
  • Step 4 > Select 'Symmetric Key' and fill in the other 'Azure Service Details' as instructed in the table. Skip step 5 if you have selected 'Symmetric Key.'
 
AZI_3_Screen_7.png
 
Azure Service Details–The IoT Hub Device Provisioning Service (DPS) is a helper service for IoT Hub that enables zero-touch, just-in-time provisioning to the right IoT hub without requiring human intervention. For more details, click here.
Input Field Value
Enrollment Type
Select either of the following:
  • Symmetric Key
  • TPM
Subscription id(*) You will get this while creating the Azure account.
Resource Group Name(*) Select the resource group name depending upon which DPS and IoT hub you are chosen.
DPS Service Name(*) Select a Device Provisioning Service name. This is used for registering the runtime with Azure.
DPS Group Name(*) Select a Device Provisioning Service group name. There are multiple types of enrollments. A Symmetric key group name is used.
IoT Hub Name(*) Enter a name for your hub. This name must be globally unique.
 
  • Step 5 > Select 'TPM' and fill in the other 'Azure Service Details' as instructed in the above table.
 
Note: To deploy the Azure IoT application using TPM as 'Enrollment Type', follow the steps mentioned here.
 
Starting with ZedControl Release 5.20.0, you can upload a root or intermediate certificate at the project level. ZedControl will then generate the device CA certificate and pack it through the cloud-init mechanism so that the Azure IoT Edge runtime can start using it.
  • Step 6 > Click 'Yes' to attach the certificate.
 
AZI_3_Screen_8.png
 
  • Step 7 > Provide the required private key.
 
AZI_3_Screen_9.png
 
  • Step 8 > Click 'Yes' to enforce the edge node attestation.
  • Step 9 > Click 'Yes' to provide the network instance details. For more information on network instances, click here.
 
AZI_3_Screen_10.png
 
  • Step 10 > Click 'Yes' to provide the 'Edge App Policy' details. You have to select the 'Edge App' and 'Edge App Instance Naming Scheme' for the other sections (such as 'Drives,' 'Resources,' and 'Network Adapters') to appear.
 
AZI_3_Screen_11.png
 

Policies section

The status of projects depends upon the status of the attached policies.
Input Field Value
Edge App(*) Select appropriate edge applications for this Project.
Edge App Instance Naming Scheme(*) Select the appropriate edge application naming scheme.
Project Identifier The user has an option to specify the identifier if required. Else the project name will be taken by default.
Edge App Identifier The user has an option to specify the identifier if required. Else the edge application name will be taken by default.
 

Drives

Define dependencies on all the App Images that the Edge App needs to function. This includes choosing an App Image already uploaded or linked through ZedControl. The table below explains the fields in a bit more detail.
 

Resources

Define the hardware resource requirements of the Edge App, such as the CPU and Memory required to function correctly.
 

Network Adapters

Define the network adapters and the assignment method and tags, if any.
  • Step 11 > Click on the 'Add Modules Policy' section to configure any modules.
  • Step 12 > Click on the 'Add' button.
 
AZI_3_Screen_12.png
Input Field Value
Module Policy Name(*) Name of the module policy. The same policy name and the version (for example, policyname_policyversion) will be used while creating IoT edge deployments on Azure.
Deployment Priority If two or more policies are targeted for the same set of devices, then the module policy with the highest priority will be applied.
Deploy of Matching Tags Tags provided in this field are matched with the device tags. If there is a match, the module policy gets applied to the set of devices.
 
  • Step 13 > When you click on the 'Add' button, a toast message appears as shown below:
Project: AzureAppProject has been added.
  • Step 14 > You can see that the new Project is added in the Projects list view below.
 
AZI_3_Screen_13.png
 
The colored dot indicates the status to the left of the Project name. The colored dots with the status is as represented in the table:
Legends Description
light_purple.pngActive The Project is ready to use.
Yellow.pngInactive The Project is not ready to use.
Grey.pngArchived Status not used currently.
Light_grey.pngUnknown The project status is not known.
Dark_Blue.pngInitialized The project status shows this status until the policy is created.
Red.pngError Status not used currently.
 
The Project is created successfully!
 

3.2. Read View of Azure Project

The read operation can be performed in the Project detail view only. After you log in to ZedControl, click on the Administration (Administration_icon.png) icon and select 'Projects' to go to the list of already available projects. Click on any of the projects in the list view to show the detailed view of the same.
The read view shows the 'Info' and 'Events' sections.
 

Info

a) Details

Refer to the tables under the create operation for information on the field values and their descriptions.
 
AZI_3_Screen_14.png
 

b) Policies

Refer to the tables under the create operation for information on the field values and their descriptions.
 
AZI_3_Screen_15.png
 

Events

a) Info

AZI_3_Screen_16.png

 
Lists all the events that occurred, sorted with date and time, in a table. You can see details based on the type of severity, the source from where a particular event is generated, the Edge Node, and related Edge Application Instances on which the event has occurred, along with descriptions, in different tabs.
 

b) Summary

The event summary can be viewed by clicking on the expand (Expand_Panel_icon.png) icon. You can see details of the change in state, the severity type, debug info, etc.
 

3.3. Update an Azure Project

The update/edit operation can only be performed in the Project detail view. After you log in to ZedControl, click on the Administration (Administration_icon.png) icon and select 'Projects' to go to the list of already available projects. Click on any of the projects in the list view to show the detailed view of the same.
The update/edit view shows only the 'Info' section.
 

Info

Update/edit a Project using the following steps:
  • Step 1 > Click on the Edit (Edit_icon.png) icon.
 
AZI_3_Screen_17.png
 
The 'Info' section allows you to 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 fields of the 'Details' section. Refer to the tables under the create operation for information on the editable field values and their descriptions.
 
AZI_3_Screen_18.png
 
  • Step 3 > Update the certificate section by removing the already present certificate with the recent certificate, if required.
  • Step 4 > Update the editable fields of the policies section, if required.
 
AZI_3_Screen_19.png
 
  • Step 5 > Update the 'Modules Policy' section, if required.
  • Step 6 > Click on 'Submit' button.
 
AZI_3_Screen_20.png
 
  • Step 7 > When you click on the 'Submit' button, a toast message announcing the successful submission of the Project appears below:
Project: azureprofile has been updated.
 
AZI_3_Screen_21.png
 
The Project is updated successfully!
 

3.4. Delete an Azure Project

The delete operation can be performed in the Project list view and detail view. After you log in to ZedControl, if you no longer require the Project, you could delete it using the following steps:
  • Step 1 > Click on the checkboxes of the Projects list on which the required operation needs to be performed.
  • Step 2 > Click on the More (More_icon.png) icon on the top right corner.
  • Step 3 > From the dropdown, select 'Delete'.
 
AZI_3_Screen_22.png
 
  • Step 4 > Click the 'Confirm' button on the modal dialogue, which appears as below:
Deleting these 1 Project(s) will permanently remove the data bout these Project (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 projects appears.
AzureAProfile was successfully deleted.
 
 
The selected Project is deleted successfully!
 

4. Operations Using zCLI

To login to ZedControl through zCLI, see here.
 

4.1. Create

You can create a Project using the following command:
zcli> zcli project create <name> [--title=<title>] [--description=<description>] [--policy-config=<policy-config>] [--policy-type=<policy-type>]
 

4.2. Read (Show)

You can use the following command to see the created Project details:
zcli> zcli project show [[[<name> | --uuid=<uuid>] [--detail]] | [--name-pattern=<name-pattern>]]
 
For example, the show command for a Project displays the following output:
zcli> zcli project show
Project Title Description State
------------ ---------------- ------------------ ---------------
test-project2 test-project2 test-project2 TAG_STATE_ACTIVE
Project_100 Project_100 Default Project TAG_STATE_ACTIVE
test-project1 test-project1 test-project1 TAG_STATE_ACTIVE
default-project default-project Default Project TAG_STATE_ACTIVE
test-project test-project test-project TAG_STATE_ACTIVE
 
Total 5 Active 5
zcli>
 

4.3. Update (Edit)

You can update a Project using the following command:
zcli> zcli project update <name> [--title=<title>] [--description=<description>] [--config=<key:value>...] [--policy-config=<policy-config>] [--policy-type=<policy-type>]
 

4.4. Delete

You can delete a Project using the following command:
zcli> zcli project delete <name> [-f]
 
Note: -f is to forcefully make the delete request to the ZedControl, without prompting the user.
 
Projects operations are successfully executed!
Was this article helpful?
0 out of 0 found this helpful

Articles in this section