×
Find plugins

Azure IoT Edge
2.0.0Minimum Jenkins requirement: 1.651.3ID: azure-iot-edge


Azure IoT Edge Plugin makes it easy to setup a CI/CD pipeline for developing an IoT Edge solution on Jenkins, by providing following functionalities:

  • Continuous integration(build and push docker image)
  • Continuous deployment(create Edge deployment on Azure)

Feedback

  • If you encounter any bugs with this plugin please leave comment in Wiki page or file an issue in Jenkins JIRA under component azure-iot-edge-plugin.

  • You can also contact this Email group for issues Azure IoT Tooling Support.

Overview

This is the work flow for Azure IoT Edge solution CI/CD pipeline.

 Structure

How to Install

Prerequisites

Install following tools on Jenkins host.

Install extension

You can install/update this plugin in Jenkins update center (Manage Jenkins -> Manage Plugins, search Azure IoT Edge Plugin).

You can also manually install the plugin if you want to try the latest feature before it's officially released. To manually install the plugin:

  1. Clone the repo and build. (The integration test need about 30 minutes to run, you can skip by following command):
    mvn package -Dmaven.test.skip=true
    
  2. Open your Jenkins dashboard, go to Manage Jenkins -> Manage Plugins.
  3. Go to Advanced tab, under Upload Plugin section, click Choose File.
  4. Select azure-iot-edge.hpi in target folder of your repo, click Upload.
  5. Restart your Jenkins instance after install is completed.

Before using extension

To use this plugin to build and deploy Azure IoT Edge solution, first you need to have an Azure Service Principal in your Jenkins instance.

  1. Create an Azure Service Principal through Azure CLI or Azure portal. Make sure in order to use Service Principal for CI/CD, you need to create the role at least Contributor. Otherwise it doesn't have enough permission to create deployment on IoT Hub.
  2. Open Jenkins dashboard, go to Credentials, add a new Microsoft Azure Service Principal with the credential information you just created.
  3. If you use common docker registry credential(like docker hub), you may also add a new Username with passwordcredential.
  4. Existing Azure IoT Hub and docker registry are needed in CI/CD.

Create a project

In Jenkins, there are two types of project.

  • Freestyle project: Config through UI
  • Pipeline project: Config through code

Create a Freestyle project

Build task

Build task could help build Azure IoT Edge Solution into container images.

Build

  1. In Build section, click Add build step, then choose Azure IoT Edge Build.
  2. Set Deployment Manifest File Path, this file defines the modules and routes in Azure IoT Edge solution.
  3. Set Default Platform. In your *.template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.

Push task

Push task could help push Azure IoT Edge Modules into Docker Registry.

Push

  1. In Build section, click Add build step, then choose Azure IoT Edge Push.
  2. Set Deployment Manifest File Path, this file defines the modules and routes in Azure IoT Edge solution.
  3. Set Default Platform. In your *.template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
  4. Set Bypass modules, it is the list of modules to bypass when building, use comma delimited list of modules. Example "ModuleA,ModuleB". You can leave this field empty to build all modules.
  5. Choose docker registry in Docker Credential Configuration.
  • For Azure Container Registry, you need to use the Azure Service Principal created above to authenticate.
  • For other types of registry (Docker Hub), you need to specify Docker registry URL and then a credential with type Username with password.

Generate Deployment Manifest task

Generate Deployment Manifest task could help generate the final Deployment File from *.template.json file.

GenConfig

  1. In Build section, click Add build step, then choose Azure IoT Edge Generate Deployment Manifest.
  2. Set Deployment Manifest File Path, this file defines the modules and routes in Azure IoT Edge solution.
  3. Set Default Platform. In your *.template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
  4. Set Output Deployment File Path, this file is generated from *.template.json and used for deployment.

Deploy task

Deploy task could help deploy the Azure IoT Edge Solution to the devices.

Deploy

  1. In Build section, click Add build step, then choose Azure IoT Edge Deploy.
  2. Set Deployment File Path, this file is generated from *.template.json and used for deployment.
  3. Choose Azure IoT Hub.
  4. Set deployment configurations. You can click help button after the input box to get detailed explanation of the item.

Create a Pipeline project

You can also use this plugin in pipeline (Jenkinsfile). Here are some samples to use the plugin in pipeline script, there is also an example for pipeline project.

Project config on Jenkins

pipeline

Customize pipeline: Build task

azureIoTEdgeBuild defaultPlatform: 'amd64', deploymentManifestFilePath: 'deployment.template.json'

Customize pipeline: Push task

Use Azure Container Registry
azureIoTEdgePush dockerRegistryType: 'acr', acrName: '<acr_name>', bypassModules: '', azureCredentialsId: '<azure_credential_id>', resourceGroup: '<resource_group_name>', defaultPlatform: 'amd64', deploymentManifestFilePath: 'deployment.template.json'
Use common Container Registry
azureIoTEdgePush dockerRegistryType: 'common', dockerRegistryEndpoint: [credentialsId: '<credential_id>', url: '<url>'], bypassModules: '', resourceGroup: '<resource_group_name>', defaultPlatform: 'amd64', deploymentManifestFilePath: 'deployment.template.json'

Customize pipeline: Generate Deployment Manifest task

azureIoTEdgeGenConfig defaultPlatform: 'amd64', deploymentFilePath: 'config/deployment.json', deploymentManifestFilePath: 'deployment.template.json'

Customize pipeline: Deploy task

For single device
azureIoTEdgeDeploy azureCredentialsId: '<azure_credential_id>', deploymentId: '<deployment_id>', deploymentType: 'single', deviceId: '<device_id>', iothubName: '<iothub_name>', priority: '<priority>', resourceGroup: '<resource_group_name>', targetCondition: '', deploymentFilePath: 'config/deployment.json'
For multiple devices using target condition
azureIoTEdgeDeploy azureCredentialsId: '<azure_credential_id>', deploymentId: '<deployment_id>', deploymentType: 'multiple', targetCondition: '<target_condition>', iothubName: '<iothub_name>', priority: '<priority>', resourceGroup: '<resource_group_name>', targetCondition: '', deploymentFilePath: 'config/deployment.json'

For advanced options, you can use Jenkins Pipeline Syntax tool to generate a sample script.

FAQ

Does ARM platform supported?

If you would like to build ARM platform image, you'll need to setup an ARM build agent. And for the Prerequisites, they also need to be setup on build agent.

Data/Telemetry

Azure IoT Edge Plugin for Jenkins collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more.
You can turn off usage data collection in Manage Jenkins -> Configure System -> Azure -> Help make Azure Jenkins plugins better by sending anonymous usage statistics to Azure Application Insights.

Changelog

Version 2.0.0

  • Separate to Build, Push, GenConfig, Deploy tasks

Version 1.0.0

  • Initial release


A bulk of the documentation for this plugin is in the GitHub

ArchivesGet past versions
Links
Labels
This plugin has no labels