azure-iot-operations

Overview

This repo contains the deployment definition of Azure IoT Operations (AIO) and allows for AIO to be deployed to an Arc-enabled K8s cluster. This repository does not encourage pull requests, as the repo is meant for publicly sharing the releases of AIO and not shared development of AIO.

Please see the Azure IoT Operations documentation for more information. To learn how to deploy AIO using GitOps, see the Deploy to cluster documentation.

Forking the Repo

If you want to fork this repo and try deployment of AIO through GitOps, there are some additional steps you will need to take to set up the fork.

1. Set the AZURE_CREDENTIALS repository secret.

   1. Create a Service Principal resource for the repository to use when performing GitHub actions.

      # If you haven't upgraded your Azure CLI lately, run the following.
      az upgrade
      
      # Create a Service Principal to perform operations on the provided subscription.
      az ad sp create-for-rbac --name $SP_NAME --role owner --scopes /subscriptions/$SUBSCRIPTION_ID --json-auth

   2. Copy the JSON output from the Service Principal creation command and paste into a repository secret named AZURE_CREDENTIALS in your fork. Repository secrets can be found under Settings > Secrets and variables > Actions. To learn more, see creating secrets for a repository.

2. Enable GitHub actions on the fork.

   1. On the forked repo, select Actions and select I understand my workflows, go ahead and enable them.

Available Parameters

Various parameters can be specified when deploying AIO. The below table describes these parameters. For an example parameter file, see environments/example.parameters.json.

Parameter	Requirement	Type	Description
clusterName	[Required]	string	The Arc-enabled cluster resource in Azure.
clusterLocation	[Optional]	string	If the cluster resource's location is different than its resource group's location, the cluster location will need to be specified. Otherwise, this parameter will default to the location of the resource group.
location	[Optional]	string	If the resource group's location is not a supported AIO region, this parameter can be used to override the location of the AIO resources.
simulatePLC	[Optional]	boolean	Flag to enable a simulated PLC. The default is false.
deployResourceSyncRules	[Optional]	boolean	Flag to deploy the default resource sync rules for the AIO arc extensions. The default is true.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

Terms of Use

Please see Supplemental Terms of Use for Microsoft Azure Previews.

Contributing

Please see Contributing.

Reporting Security Issues

Please see Security.