Data Landing Zone - Azure DevOps Deployment

May 16, 2023 · View on GitHub

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>",
  (...)
}

Create Service Connection

First, you need to create an Azure Resource Manager service connection. To do so, execute the following steps:

First, you need to create an Azure DevOps Project. Instructions can be found here.
In Azure DevOps, open the Project settings.
Now, select the Service connections page from the project settings page.
Choose New service connection and select Azure Resource Manager.
On the next page select Service principal (manual).
Select the appropriate environment to which you would like to deploy the templates. Only the default option Azure Cloud is currently supported.
For the Scope Level, select Subscription and enter your subscription Id and name.
Enter the details of the service principal that we have generated in step 3. (Service Principal ID = clientId, Service Principal Key = clientSecret, Tenant ID = tenantId) and click on Verify to make sure that the connection works.
Enter a user-friendly Connection name to use when referring to this service connection. Take note of the name because this will be required in the parameter update process.
Optionally, enter a Description.
Click on Verify and save.

More information can be found here.

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:

.ado/workflows/dataLandingZoneDeployment.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 `dataLandingZoneDeployment.yml`

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

variables:
  AZURE_RESOURCE_MANAGER_CONNECTION_NAME: "data-landing-zone-001-service-connection" # Update to '{resourceManagerConnectionName}'
  AZURE_SUBSCRIPTION_ID: "2150d511-458f-43b9-8691-6819ba2e6c7b"                      # Update to '{dataLandingZoneSubscriptionId}'
  AZURE_LOCATION: "North Europe"                                                     # 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 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_MANAGER _CONNECTION_NAME	Specifies the resource manager connection name in Azure DevOps. More details on how to create the resource manager service connection in Azure DevOps was described in the previous paragraph or here.	`my-connection-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 for the deployment.	`dev`, `tst` or `prd`
`prefix`	Specifies the prefix for all resources created in this deployment.	`prefi`
`vnetAddressPrefix`	Specifies the address space of the vnet of the data landing zone.	`10.1.0.0/16`
`servicesSubnetAddressPrefix`	Specifies the address space of the subnet that is used for general services of the data landing zone.	`10.1.0.0/24`
`databricksIntegrationPublicSubnetAddressPrefix`	Specifies the address space of the public subnet that is used for the shared integration Databricks workspace.	`10.1.1.0/24`
`databricksIntegrationPrivateSubnetAddressPrefix`	Specifies the address space of the private subnet that is used for the shared integration Databricks workspace.	`10.1.2.0/24`
`databricksProductPublicSubnetAddressPrefix`	Specifies the address space of the public subnet that is used for the shared product Databricks workspace.	`10.1.3.0/24`
`databricksProductPrivateSubnetAddressPrefix`	Specifies the address space of the private subnet that is used for the shared product Databricks workspace.	`10.1.4.0/24`
`powerBiGatewaySubnetAddressPrefix`	Specifies the address space of the subnet that is used for the Power BI Gateway.	`10.1.5.0/24`
`dataIntegration001SubnetAddressPrefix`	Specifies the address space of the subnet that is used for data integration 001.	`10.1.6.0/24`
`dataIntegration002SubnetAddressPrefix`	Specifies the address space of the subnet that is used for data integration 002.	`10.1.7.0/24`
`dataProduct001SubnetAddressPrefix`	Specifies the address space of the subnet that is used for data product 001.	`10.1.8.0/24`
`dataProduct002SubnetAddressPrefix`	Specifies the address space of the subnet that is used for data product 002.	`10.1.9.0/24`
`dataManagementZoneVnetId`	Specifies the Resource ID of the VNet in the data management landing zone.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/virtualNetworks/{vnet-name}`
`firewallPrivateIp`	Specifies the private IP address of the central firewall.	`10.0.0.4`
`dnsServerAdresses`	Specifies the private IP addresses of the DNS servers.	`[ 10.0.0.4 ]`
`administratorPassword`	Specifies the administrator password of the sql servers. Will be automatically set in the workflow. Leave this value as is.	`<your-secure-password>`
`purviewId`	Specifies the Resource ID of the central Purview instance.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Purview/accounts/{purview-name}`
`purviewManagedStorageId`	Specifies the Resource ID of the managed storage of the central Purview instance.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storage-account-name}`
`purviewManagedEventHubId`	Specifies the Resource ID of the managed event hub of the central Purview instance.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.EventHub/namespaces/{eventhub-namespace-name}`
`purviewSelfHostedIntegrationRuntimeAuthKey`	Specifies the Auth Key for the Self-hosted integration runtime of Purview.	`<your-purview-shir-auth-key>`
`deploySelfHostedIntegrationRuntimes`	Specifies whether the self-hosted integration runtimes should be installed. This only works, if the pwsh script was uploded and is available.	`true` or `false`
`dataLandingZoneSubscriptionIds`	Specifies the subscription IDs of the other Data Landing Zones.	`[ '{subscriptionId1}', '{subscriptionId2}' ]`
`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`
`privateDnsZoneIdDataFactory`	Specifies the Resource ID of the private DNS zone for Data Factory.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.datafactory.azure.net`
`privateDnsZoneIdDataFactoryPortal`	Specifies the Resource ID of the private DNS zone for Data Factory Portal.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.adf.azure.com`
`privateDnsZoneIdBlob`	Specifies the Resource ID of the private DNS zone for Blob Storage.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net`
`privateDnsZoneIdDfs`	Specifies the Resource ID of the private DNS zone for Datalake Storage.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.dfs.core.windows.net`
`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`
`privateDnsZoneIdMySqlServer`	Specifies the Resource ID of the private DNS zone for MySql Server.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.mysql.database.azure.com`
`privateDnsZoneIdEventhubNamespace`	Specifies the Resource ID of the private DNS zone for EventHub Namespaces.	`/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.dev.azuresynapse.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`

Install Azure DevOps Pipelines GitHub Application

First you need to add and install the Azure Pipelines GitHub App to your GitHub account. To do so, execute the following steps:

Click on Marketplace in the top navigation bar on GitHub.
In the Marketplace, search for Azure Pipelines. The Azure Pipelines offering is free for anyone to use for public repositories and free for a single build queue if you're using a private repository.
Select it and click on Install it for free.
If you are part of multiple GitHub organizations, you may need to use the Switch billing account dropdown to select the one into which you forked this repository.
You may be prompted to confirm your GitHub password to continue.
You may be prompted to log in to your Microsoft account. Make sure you log in with the one that is associated with your Azure DevOps account.

Configuring the Azure Pipelines project

As a last step, you need to create an Azure DevOps pipeline in your project based on the pipeline definition YAML file that is stored in your GitHub repository. To do so, execute the following steps:

Select the Azure DevOps project where you have setup your Resource Manager Connection.
Select Pipelines and then New Pipeline in order to create a new pipeline.
Choose GitHub YAML and search for your repository (e.g. "GitHubUserName/RepositoryName").
Select your repository.
Click on Existing Azure Pipelines in YAML file
Select main as branch and /.ado/workflows/dataHubDeployment.yml as path.
Click on Continue and then on Run.

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 Azure DevOps.

Now, you can navigate to the pipeline that you have created as part of step 5 and monitor it as each service is deployed. 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