├── macros ├── .gitkeep ├── generate_schema_name.sql └── grant_select_on_tables.sql ├── packages.yml ├── dbt_project.yml ├── README.md └── LICENSE /macros/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /packages.yml: -------------------------------------------------------------------------------- 1 | packages: 2 | - package: fishtown-analytics/dbt_external_tables 3 | version: 0.6.2 4 | - package: fishtown-analytics/dbt_utils 5 | version: 0.6.4 6 | - package: dbt-msft/tsql_utils 7 | version: 0.6.5 -------------------------------------------------------------------------------- /macros/generate_schema_name.sql: -------------------------------------------------------------------------------- 1 | {% macro generate_schema_name( 2 | custom_schema_name, 3 | node 4 | ) -%} 5 | {%- set default_schema = target.schema -%} 6 | {%- if custom_schema_name is none -%} 7 | {{ default_schema }} 8 | 9 | {%- elif default_schema == "prd" -%} 10 | {{ custom_schema_name | trim }} 11 | {%- else -%} 12 | {{ default_schema }}_{{ custom_schema_name | trim }} 13 | {%- endif -%} 14 | {%- endmacro %} 15 | 16 | -------------------------------------------------------------------------------- /macros/grant_select_on_tables.sql: -------------------------------------------------------------------------------- 1 | -- macros/grant_select_on_tables.sql 2 | 3 | {% macro grant_select_on_tables(webgroups, table) %} 4 | {% if target.schema == 'prd' %} 5 | {% for webgroup in webgroups %} 6 | IF NOT EXISTS ( 7 | SELECT [name] 8 | FROM sys.database_principals 9 | WHERE [name] = '{{ webgroup }}' 10 | ) 11 | CREATE USER [{{ webgroup }}] FROM EXTERNAL PROVIDER 12 | GRANT SELECT 13 | ON {{ table.include(database=false) }} TO [{{ webgroup }}] 14 | {% endfor %} 15 | {% else %} 16 | select 1; -- hooks will error if they don't have valid SQL in them, this handles that! 17 | {% endif %} 18 | {% endmacro %} 19 | -------------------------------------------------------------------------------- /dbt_project.yml: -------------------------------------------------------------------------------- 1 | 2 | # Name your project! Project names should contain only lowercase characters 3 | # and underscores. A good package name should reflect your organization's 4 | # name or the intended use of these models 5 | name: 'jaffle_shop' 6 | version: '1.0.0' 7 | config-version: 2 8 | 9 | vars: 10 | prod_users: ["example_AAD_distribution_list"] 11 | 12 | # This setting configures which "profile" dbt uses for this project. 13 | profile: 'jaffle_shop' 14 | 15 | # These configurations specify where dbt should look for different types of files. 16 | # The `source-paths` config, for example, states that models in this project can be 17 | # found in the "models/" directory. You probably won't need to change these! 18 | source-paths: ["models"] 19 | analysis-paths: ["analysis"] 20 | test-paths: ["tests"] 21 | data-paths: ["data"] 22 | macro-paths: ["macros"] 23 | snapshot-paths: ["snapshots"] 24 | 25 | target-path: "target" # directory which will store compiled SQL files 26 | clean-targets: # directories to be removed by `dbt clean` 27 | - "target" 28 | - "dbt_modules" 29 | 30 | 31 | # Configuring models 32 | # Full documentation: https://docs.getdbt.com/docs/configuring-models 33 | 34 | # In this example config, we tell dbt to build all models in the example/ directory 35 | # as tables. These settings can be overridden in the individual model files 36 | # using the `{{ config(...) }}` macro. 37 | models: 38 | +post-hook: "{{ grant_select_on_tables(var('prod_users'), this) }}" -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ado_pipelines_example 2 | example pipelines for deploying dbt via Azure DevOps pipelines 3 | 4 | ## Overview 5 | 6 | ### Azure CLI task 7 | Check out the `.yml` files in the [`build/` dir](build/) for our pipelines. 8 | 9 | Once you have an ADO ARM Service Connection that has owner permission on the db, the work is done. With the `AzureCLI` task and the `azureSubscription` param, you never have to call `az login`, it will do that for you automatically. 10 | 11 | To make the secret pipeline variables available to the task, you have to map them with the `env` dict shown below. 12 | 13 | ```yaml 14 | - task: AzureCLI@2 15 | displayName: 'dbt run' 16 | inputs: 17 | azureSubscription: ITSDETEAM 18 | ScriptType: bash 19 | scriptLocation: inlineScript 20 | inlineScript: | 21 | dbt run --profiles-dir $(location) 22 | env: 23 | HOST: $(host) 24 | DB: $(db) 25 | ``` 26 | 27 | ### profile tweaks 28 | 29 | To avoid uploading a secure file containing our [`build/profiles.yml`](build/profiles.yml), we just added three environment variable references to the only target. This allows us to just set the server and db within the Azure Pipeline itself. 30 | 31 | 32 | ```yaml 33 | jaffle_shop: 34 | target: default 35 | outputs: 36 | default: 37 | type: sqlserver # or synapse or whatever you want 38 | driver: "ODBC Driver 17 for SQL Server" 39 | schema: "{{ env_var('SCHEMA') }}" 40 | host: "{{ env_var('HOST') }}" 41 | database: "{{ env_var('DB') }}" 42 | authentication: CLI 43 | port: 1433 44 | ``` 45 | 46 | ## Steps to Set Up 47 | 48 | 1. Commit the build directory here to your dbt project repo. 49 | 1. Create an Azure Active Directory App Registration (aka Service Principal aka AAD App) 50 | 2. Set the Azure Active Directory Admin on the Azure SQL/Synapse db to be either you or a DL that contains you. 51 | 3. Log into db with AAD admin creds and add the App Registration as an owner on your dev and prod db's 52 | ```sql 53 | CREATE USER [my_service_connection] FROM EXTERNAL PROVIDER 54 | exec sp_addrolemember 'db_owner', 'my_service_connection' 55 | ``` 56 | 4. Create an Azure Resource Manager Service Connection in Azure DevOps for the AAD App (Ours is called `ITSDETEAM`) 57 | 5. Follow the normal workflow to create a new Azure pipeline based on an existing YAML file in the repo. For the following pipelines, you'll need to make add some [secret pipeline variables](https://i.stack.imgur.com/3WBDC.png) : 58 | 1. `gatekeeper.yml` (i.e. CI): `$(DEV_SERVER)` and `$(DEV_DB)` 59 | 2. `prod.yml` (i.e. CD) `$(PROD_SERVER)` and `$(PROD_DB)` 60 | 6. make a branch policy for your `dev` or `UAT` branch so that all PRs require that the gatekeeper passes 61 | 7. change the trigger and schedules to fit your needs. -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------