trondbrande/azure-synapse-analytics-poc-accelerator

Template to deploy Synapse Analytics using best practices to deliver a proof of concept.

Azure Synapse Analytics PoC Accelerator

Description

Create a Synapse Analytics environment based on best practices to achieve a successful proof of concept. While settings can be adjusted, the major deployment differences are based on whether or not you used Private Endpoints for connectivity. If you do not already use Private Endpoints for other Azure deployments, it's discouraged to use them for a proof of concept as they have many other networking dependancies than what can be configured here.

How to Run

"Easy Button" Deployment

The following commands should be executed from the Azure Cloud Shell at https://shell.azure.com using bash:

git clone https://github.com/MSUSSolutionAccelerators/Azure-Synapse-Analytics-PoC
cd Azure-Synapse-Analytics-PoC
bash deploySynapse.sh 

Advanced Deployment: Bicep

You can manually configure the Bicep parameters and update default settings such as the Azure region, database name, credentials, and private endpoint integration. The following commands should be executed from the Azure Cloud Shell at https://shell.azure.com using bash:

git clone https://github.com/MSUSSolutionAccelerators/Azure-Synapse-Analytics-PoC
cd Azure-Synapse-Analytics-PoC
code Bicep/main.parameters.json
az deployment sub create --template-file Bicep/main.bicep --parameters Bicep/main.parameters.json --name Azure-Synapse-Analytics-PoC --location eastus
bash deploySynapse.sh 

Advanced Deployment: Terraform

You can manually configure the Terraform parameters and update default settings such as the Azure region, database name, credentials, and private endpoint integration. The following commands should be executed from the Azure Cloud Shell at https://shell.azure.com using bash:

git clone https://github.com/MSUSSolutionAccelerators/Azure-Synapse-Analytics-PoC
cd Azure-Synapse-Analytics-PoC
code Terraform/terraform.tfvars
terraform -chdir=Terraform init
terraform -chdir=Terraform plan
terraform -chdir=Terraform apply
bash deploySynapse.sh 

What's Deployed

Azure Synapse Analytics Workspace

• DW1000 Dedicated SQL Pool
• Example scripts for configuring and using:
  • Row Level Security
  • Column Level Security
  • Dynamic Data Masking
  • Materialized Views
  • JSON data parsing
• Example notebooks for testing:
  • Spark and Serverless Metastore integration
  • Spark Delta Lake integration

Azure Data Lake Storage Gen2

• config container for Azure Synapse Analytics Workspace
• data container for queried/ingested data

Azure Log Analytics

• Logging and telemetry for Azure Synapse Analytics
• Logging and telemetry for Azure Data Lake Storage Gen2

What's Configured

• Enable Result Set Caching
• Create a pipeline to auto pause/resume the Dedicated SQL Pool
• Feature flag to enable/disable Private Endpoints
• Serverless SQL Demo Data Database
• Proper service and user permissions for Azure Synapse Analytics Workspace and Azure Data Lake Storage Gen2
• Parquet Auto Ingestion pipeline to optimize data ingestion using best practices
• Lake Database Auto DDL creation (views) for all files used by Ingestion pipeline

Other Files

• You can find a Synapse_Dedicated_SQL_Pool_Test_Plan.jmx JMeter file under the artifacts folder that is configured to work with your recently deployed Synapse Environment.

To Do

• Synapse Data Explorer Pool deployment
• Purview Deployment and Configuration
• Azure ML Services Deployment and Configuration
• Cognitive Services Deployment and Configuration

License

Copyright (c) Microsoft Corporation

All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

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.