Data Product Batch - GitHub Action Deployment

In the previous step we have generated a JSON output similar to the following, which will be required in the next steps:

{
  "clientId": "<GUID>",
  "clientSecret": "<GUID>",
  "subscriptionId": "<GUID>",
  "tenantId": "<GUID>",
  (...)
}

Adding Secrets to GitHub repository

If you want to use GitHub Actions for deploying the resources, add the JSON output as a repository secret with the name AZURE_CREDENTIALS in your GitHub repository:

To do so, execute the following steps:

1. On GitHub, navigate to the main page of the repository.
2. Under your repository name, click on the Settings tab.
3. In the left sidebar, click Secrets.
4. Click New repository secret.
5. Type the name AZURE_CREDENTIALS for your secret in the Name input box.
6. Enter the JSON output from above as value for your secret.
7. Click Add secret.

Update Parameters

In order to deploy the Infrastructure as Code (IaC) templates to the desired Azure subscription, you will need to modify some parameters in the forked repository. Therefore, this step should not be skipped for neither Azure DevOps/GitHub options. There are two files that require updates:

• .github/workflows/dataProductDeployment.yml and
• infra/params.dev.json.

Update these files in a separate branch and then merge via Pull Request to trigger the initial deployment.

Configure dataProductDeployment.yml

To begin, please open .github/workflows/dataProductDeployment.yml. In this file you need to update the environment variables section. Just click on .github/workflows/dataProductDeployment.yml and edit the following section:

env:
  AZURE_SUBSCRIPTION_ID: "2150d511-458f-43b9-8691-6819ba2e6c7b" # Update to '{dataLandingZoneSubscriptionId}'
  AZURE_RESOURCE_GROUP_NAME: "dlz01-dev-di002"                  # Update to '{dataLandingZoneName}-rg'
  AZURE_LOCATION: "northeurope"                                 # Update to '{regionName}'

The following table explains each of the parameters:

Parameter	Description	Sample value
AZURE_SUBSCRIPTION_ID	Specifies the subscription ID of the Data Management Landing Zone where all the resources will be deployed	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
AZURE_LOCATION	Specifies the region where you want the resources to be deployed. Please check Supported Regions	northeurope
AZURE_RESOURCE_GROUP_NAME	Specifies the name of an existing resource group in your data landing zone, where the resources will be deployed.	my-rg-name

Configure params.dev.json

To begin, please open the infra/params.dev.json. In this file you need to update the variable values. Just click on infra/params.dev.json and edit the values. An explanation of the values is given in the table below:

Parameter	Description	Sample value
location	Specifies the location for all resources.	northeurope
environment	Specifies the environment of the deployment.	dev, tst or prd
prefix	Specifies the prefix for all resources created in this deployment.	prefi
tags	Specifies the tags that you want to apply to all resources.	{key: value}
administratorPassword	Specifies the administrator password of the sql servers. Will be automatically set in the workflow. Leave this value as is.	<your-secure-password>
synapseDefaultStorageAccountFileSystemId	Specifies the Resource ID of the default storage account file system for synapse.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storage-name}/blobServices/default/containers/{container-name}
enableSqlPool	Specifies whether an Azure SQL Pool should be deployed inside your Synapse workspace as part of the template. If you selected dataFactory as processingService, leave this value as is.	true or false
enableDataExplorerPool	Specifies whether an Azure Data Explorer Pool should be deployed inside your Synapse workspace as part of the template. If you selected dataFactory as processingService, leave this value as is.	true or false
enableSqlServer	Specifies whether Azure SQL Server should be deployed as part of the template.	true or false
enableCosmos	Specifies whether Azure Cosmos DB should be deployed as part of the template.	true or false
enableStreamAnalytics	Specifies whether Azure Stream Analytics Cluster and Job should be deployed as part of the template.	true or false
enableMonitoring	Specifies whether key monitoring components like Azure Dashboard, metrics and alerts are enabled.	true or false
dataProductTeamEmail	Email ID of the group to receive monitoring alerts.	email@domian.com
streamanalyticsDefaultStorageAccountFileSystemId	Specifies the resource ID of the default Storage Account file system for Stream Analytics.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storage-name}/blobServices/default/containers/{container-name}
subnetId	Specifies the Resource ID of the subnet to which all services will connect.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/virtualNetworks/{vnet-name}/subnets/{subnet-name}
purviewId	Specifies the Resource ID of the central Purview instance.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Purview/accounts/{purview-name}
enableRoleAssignments	Specifies whether role assignments should be enabled. Leave this value as is.	true or false
privateDnsZoneIdKeyVault	Specifies the Resource ID of the private DNS zone for KeyVault.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.vaultcore.azure.net
privateDnsZoneIdSynapseDev	Specifies the Resource ID of the private DNS zone for Synapse Dev.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.dev.azuresynapse.net
privateDnsZoneIdSynapseSql	Specifies the Resource ID of the private DNS zone for Synapse Sql.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.sql.azuresynapse.net
privateDnsZoneIdEventhubNamespace	Specifies the Resource ID of the private DNS zone for EventHub Namespace.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.servicebus.windows.net
privateDnsZoneIdCosmosdbSql	Specifies the Resource ID of the private DNS zone for Cosmos Sql.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.documents.azure.com
privateDnsZoneIdSqlServer	Specifies the Resource ID of the private DNS zone for Sql Server.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.database.windows.net
privateDnsZoneIdIothub	Specifies the Resource ID of the private DNS zone for IoT Hub.	/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.azure-devices.net

Merge these changes back to the main branch of your repository

After following the instructions and updating the parameters and variables in your repository in a separate branch and opening the pull request, you can merge the pull request back into the main branch of your repository by clicking on Merge pull request. Finally, you can click on Delete branch to clean up your repository. By doing this, you trigger the deployment workflow.

Follow the workflow deployment

Congratulations! You have successfully executed all steps to deploy the template into your environment through GitHub Actions.

Now, you can navigate to the Actions tab of the main page of the repository, where you will see a workflow with the name Data Product Deployment running. Click on it to see how it deploys the environment. If you run into any issues, please check the Known Issues first and open an issue if you come across a potential bug in the repository.

Previous Next