Skip to content

Latest commit

 

History

History
102 lines (66 loc) · 4.04 KB

deploy_sa.md

File metadata and controls

102 lines (66 loc) · 4.04 KB
Raw

Deployment of the Purview Custom Connector Solution Accelerator Base Services

Services Installed

deployed services / changes

Deployment Steps

Create an application identity and corresponding secret

This will be the identity used for access to the Purview workspace from the Custom Type Tool application and from the synapse connector services. See Create a service principal

Clone the repository into Azure cloud shell

  • Start the cloud CLI in bash mode
  • cd to the cloud storage directory (clouddrive)
  • clone this repository into the clouddrive directory
git clone https://github.com/microsoft/Purview-Custom-Connector-Solution-Accelerator.git

Configure application settings file

  • Download the settings.sh.rename file from the Purview-Custom-Connector-Solution-Accelerator/purview_connector_services/deploy directory
  • Modify the file as indicated to include a setup location, App name, client id, and secret
  • Rename the file to settings.sh

Upload the application settings

  • Upload the settings.sh file (created above) to the deploy directory using the Upload/Download files tool

    upload files

  • Choose the "Manage file share" option, navigate to the Purview-Custom-Connector-Solution-Accelerator/purview_connector_services/deploy directory and copy the settings.sh file into this directory

    cloud console directory

    upload file dialog

Run the deployment script

  • Navigate to the Purview-Custom-Connector-Solution-Accelerator/purview_connector_services/deploy directory
  • Run the deploy_sa.sh script
./deploy_sa.sh

For details about the scripts functionality, see Reference - script actions

Configure your Purview catalog to trust the service principal

  • Open Purview Studio and select the Data Map icon in the left bar

    purview_root_collection.png

  • Choose the "View Details" link on the root collection

    purview_root_collection_detail.png

  • Click on the 'Role assignments' tab in the root collection pane

    purview_root_collection_role_assignments.png

  • Click on the icon next to the role name and add the application identity you created above to the following roles:

    • Data curators
    • Data readers

Install the Purview Custom Types Tool

  • Follow the instructions in the project readme file
  • You will need the app identity and secret you created above as well as information from the installed Purview service
  • Note: If you are installing Node, be sure to install the LTS branch (v 14) NOT the latest (v 16)

Reference - script actions

  • Create resource group
  • Deploy KeyVault
    • Save client secret
    • Save secret URL
  • Deploy Purview
    • Add app sp to purview roles
  • Deploy Synapse
    • Add Synapse to storage roles
    • Add Synapse to retrieve KeyVault secrets
    • Create linked service to storage
    • Create spark pool
    • Add package dependencies (PyApacheAtlas)
    • Import notebooks
    • Import pipelines
    • Import trigger
  • Deploy Storage Account
    • Create folder structure
    • Save storage account key to KeyVault secret
  • Write output name variables to file for use in other deployments

Privacy

To opt out of information collection as described in privacy.md, remove the GUID section from all templates in the Purview-Custom-Connector-Solution-Accelerator/purview_connector_services/deploy/arm directory