azure / iotedge-vm-deploy

ARM template to deploy a VM with IoT Edge pre-installed (via cloud-init)

iotedge-vm-deploy

Detailed documentation is available on Microsoft Docs

ARM Template to deploy IoT Edge enabled VM

The following Azure Resource Templates are for IoT Edge release 1.5.

ARM template to deploy a VM with IoT Edge pre-installed (via cloud-init)

The ARM template visualized for exploration

Azure CLI command to deploy IoT Edge enabled VM

The commands below deploy a VM with IoT Edge pre-installed and provisioned with the provided connection string. To deploy a VM with IoT Edge pre-installed but not provisioned, do not include the --parameters deviceConnectionString=... portion of the command.

Using an ARM template

az deployment group create \
  --name edgeVm \
  --resource-group replace-with-rg-name \
  --template-uri "https://raw.githubusercontent.com/Azure/iotedge-vm-deploy/main/edgeDeploy.json" \
  --parameters dnsLabelPrefix='my-edge-vm1' \
  --parameters adminUsername='azureuser' \
  --parameters authenticationType='sshPublicKey' \
  --parameters adminPasswordOrKey="$(< ~/.ssh/id_rsa.pub)" \
  --parameters deviceConnectionString=$(az iot hub device-identity show-connection-string --device-id replace-with-device-name --hub-name replace-with-hub-name -o tsv)

Using a local Azure Bicep file

az deployment group create \
  --name edgeVm \
  --resource-group replace-with-rg-name \
  --template-file "./edgeDeploy.bicep" \
  --parameters dnsLabelPrefix='my-edge-vm1' \
  --parameters adminUsername='azureuser' \
  --parameters authenticationType='sshPublicKey' \
  --parameters adminPasswordOrKey="$(< ~/.ssh/id_rsa.pub)" \
  --parameters deviceConnectionString=$(az iot hub device-identity show-connection-string --device-id replace-with-device-name --hub-name replace-with-hub-name -o tsv)

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

iotedge-vm-deploy's Issues

iotedge command is not identifying by VM

After deployment the iotedge command is not identifying by VM

iotedge: command not found,

The ARM templates does not deploy the latest Edge runtime

Creating a VM using the Azure IoT Edge on Ubuntu ARM template

Observed. The iotedge version deployed is iotedge 1.0.8 (208b2204fd30e856d00b280112422130c104b9f0) on Ubuntu 16

Expected. The latest iotedge runtime, as per today it's https://github.com/Azure/azure-iotedge/releases/tag/1.1.0 targeting the latest supported Ubuntu 18

Deployment failed with validation error

following the example here: https://docs.microsoft.com/en-us/azure/iot-edge/how-to-install-iot-edge-ubuntuvm
and I am getting this error:
{"error":{"code":"InvalidTemplate","message":"Deployment template validation failed: 'Template parameter JToken type is not valid. Expected 'Boolean'. Actual 'String'. Please see https://aka.ms/resource-manager-parameter-files for usage details.'.","additionalInfo":[{"type":"TemplateViolation","info":{"lineNumber":54,"linePosition":17,"path":"parameters.allowSsh"}}]}

this used to work a month or so ago last time I checked.

The template not working on westus2 region

The VM size: Standard_DS1_v2 is not available on westus2 region.

{'code': 'InvalidTemplateDeployment', 'message': "The template deployment failed with error: 'The resource with id: '/subscriptions/48bd2a8b-17b3-4061-ac87-700480cd04b8/resourceGroups/IoTEdgeResources/providers/Microsoft.Compute/virtualMachines/vmEdgeDevice' failed validation with message: 'The requested size for resource '/subscriptions/48bd2a8b-17b3-4061-ac87-700480cd04b8/resourceGroups/IoTEdgeResources/providers/Microsoft.Compute/virtualMachines/vmEdgeDevice' is currently not available in location 'westus2' zones '' for subscription '48bd2a8b-17b3-4061-ac87-700480cd04b8'. Please try another size or deploy to a different location or zones. See https://aka.ms/azureskunotavailable for details.'.'."}

Bicep file reports linter warnings

When using the bicep deployment file https://github.com/Azure/iotedge-vm-deploy/blob/main/edgeDeploy.bicep, linter warnings are reported.

/home/pat/main.bicep(58,5) : Warning decompiler-cleanup: The name of variable 'networkSecurityGroupName_var' appears to have originated from a naming conflict during a decompilation from JSON. Consider renaming it and removing the suffix (using the editor's rename functionality). [https://aka.ms/bicep/linter/decompiler-cleanup]
/home/pat/main.bicep(131,13) : Warning use-resource-id-functions: If property "id" represents a resource ID, it must use a symbolic resource reference, be a parameter or start with one of these functions: extensionResourceId, guid, if, reference, resourceId, subscription, subscriptionResourceId, tenantResourceId. Found nonconforming expression at id -> subnet1Ref [https://aka.ms/bicep/linter/use-resource-id-functions]
/home/pat/main.bicep(151,65) : Warning simplify-json-null: Simplify json('null') to null [https://aka.ms/bicep/linter/simplify-json-null]

VM arm template for IoT Edge 1.2

Any plans to update this template to install IoT edge 1.2?

Add terraform example to deploy IoT Edge

Hi,

I received a suggestion on my azure docs issue here to add my terraform deployment sample for Azure IoT Edge to this repo in order to mention it in the Azure docs later on.

Would you be open to it, if yes, any desired folder structure?

Authenticate using X.509 certificates

The IoT Edge is currently authenticating to Azure IoT Hub using a connection string. Would it be possible to extend the deployment to allow X.509 authentication?