Skip to content

Latest commit

 

History

History
146 lines (101 loc) · 12.5 KB

DataManagementAnalytics-AzureDevOpsDeployment.md

File metadata and controls

146 lines (101 loc) · 12.5 KB
Raw

Data Management Landing Zone - Azure DevOps 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>",
  (...)
}

Create Service Connection

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

  1. First, you need to create an Azure DevOps Project. Instructions can be found here.

  2. In Azure DevOps, open the Project settings.

  3. Now, select the Service connections page from the project settings page.

  4. Choose New service connection and select Azure Resource Manager.

    ARM Connection

  5. On the next page select Service principal (manual).

  6. Select the appropriate environment to which you would like to deploy the templates. Only the default option Azure Cloud is currently supported.

  7. For the Scope Level, select Subscription and enter your subscription Id and name.

  8. 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.

  9. 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.

  10. Optionally, enter a Description.

  11. Click on Verify and save.

    Connection DevOps

More information can be found here.

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:

  • .ado/workflows/dataManagementZoneDeployment.yml and
  • infra/params.dev.json.

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

Configure dataManagementZoneDeployment.yml

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

variables:
  AZURE_RESOURCE_MANAGER_CONNECTION_NAME: "data-management-zone-service-connection" # Update to '{yourResourceManagerConnectionName}'
  AZURE_SUBSCRIPTION_ID: "17588eb2-2943-461a-ab3f-00a3ceac3112"                     # Update to '{yourDataManagementZoneSubscriptionId}'
  AZURE_LOCATION: "North Europe"                                                    # Update to '{yourRegionName}'

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_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 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}
purviewRootCollectionAdminObjectIds Specifies the list of user object IDs that are assigned as collection admin to the root collection in Purview. To get the object ID for a user use the following Azure CLI command: az ad user list --display-name "{user name}" --query "[].objectId". [{object-id-1}, {object-id-2}]
vnetAddressPrefix Specifies the address space of the vnet. 10.0.0.0/16
azureFirewallSubnetAddressPrefix Specifies the address space of the subnet that is use for Azure Firewall. Optional if enableDnsAndFirewallDeployment is set to true. 10.0.0.0/24
servicesSubnetAddressPrefix Specifies the address space of the subnet that is used for the services. 10.0.1.0/24
enableDnsAndFirewallDeployment Specifies whether firewall and private DNS Zones should be deployed. true
firewallPrivateIp Specifies the private IP address of the central firewall. Optional if enableDnsAndFirewallDeployment is set to true. 10.0.0.4
dnsServerAdresses Specifies the private IP addresses of the dns servers. Optional if enableDnsAndFirewallDeployment is set to true. [ 10.0.0.4 ]
firewallPolicyId Specifies the resource ID of the Azure Firewall Policy. Optional parameter allows you to deploy Firewall rules to an existing Firewall Policy if enableDnsAndFirewallDeployment is set to false. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/firewallPolicies/{firewallpolicy-name}
privateDnsZoneIdContainerRegistry Specifies the resource ID of the private DNS zone for Container Registry. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.azurecr.io
privateDnsZoneIdKeyVault Specifies the resource ID of the private DNS zone for Key Vault. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.vaultcore.azure.net
privateDnsZoneIdNamespace Specifies the resource ID of the private DNS zone for EventHub namespaces. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.servicebus.windows.net
privateDnsZoneIdPurview Specifies the resource ID of the private DNS zone for Purview. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.purview.azure.com
privateDnsZoneIdPurviewPortal Specifies the resource ID of the private DNS zone for Purview Portal. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.purviewstudio.azure.com
privateDnsZoneIdBlob Specifies the resource ID of the private DNS zone for Blob storage. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net
privateDnsZoneIdQueue Specifies the resource ID of the private DNS zone for Queue storage. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.queue.core.windows.net
privateDnsZoneIdSynapse Specifies the resource ID of the private DNS zone for Synapse. Optional if enableDnsAndFirewallDeployment is set to true. /subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Network/privateDnsZones/privatelink.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:

  1. Click on Marketplace in the top navigation bar on GitHub.

  2. 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.

    Install Azure Pipelines on GitHub

  3. Select it and click on Install it for free.

    GitHub Template repository

  4. 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.

  5. You may be prompted to confirm your GitHub password to continue.

  6. 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:

  1. Select the Azure DevOps project where you have setup your Resource Manager Connection.

  2. Select Pipelines and then New Pipeline in order to create a new pipeline.

    Create Pipeline in DevOps

  3. Choose GitHub YAML and search for your repository (e.g. "GitHubUserName/RepositoryName").

    Choose code source in DevOps Pipeline

  4. Select your repository.

  5. Click on Existing Azure Pipelines in YAML file

  6. Select main as branch and /.ado/workflows/dataHubDeployment.yml as path.

    Configure Pipeline in DevOps

  7. 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 accross a potential bug in the repository.

Add Root Collection Administrator role to Purview account

Since the Purview account is being deployed using a Service Principal, at this point, the only identity that has access to the Purview data plane, is the Service Principal. Use the instructions in this guide to assign additional user accounts to the Purview Root Collection as Collection Admin.

Previous Next