Skip to content

Latest commit

 

History

History
118 lines (90 loc) · 8.42 KB

README.md

File metadata and controls

118 lines (90 loc) · 8.42 KB
Raw

WARNING

This repository contains multiple pipelines. Use the 'brownfield pipeline' for Azure environments that already contain custom policies, initiatives, and assignments. This will suppress the deletion of dangling policies, initiatives, and assignments that already exist.

Overview

This repository contains a mature solution to manage and deploy Azure Policy at enterprise scale.

Azure Security Modernization

This repo has been developed in partnership with the Azure Security Modernization (ASM) offering within Microsoft's Industry Solutions (Consulting Services)

ASM improves your new or existing security posture in Azure by securing platforms, services, and workloads at any scale. ASM revolves around a continuous security improvement model (Measure, Plan, Develop & Deliver) giving visibility into security vulnerabilities.

Components

Component What is it used for? Where can it be found?
Pipeline Files Configure the deployment pipeline for Azure DevOps Pipeline folder.
Service Connections Service connections give the pipeline the proper permissions to deploy at desired Azure scopes Create in project settings: https://docs.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?view=azure-devops&tabs=yaml
Definition Files Define custom policies, initiatives and assignments. This repo contains a sample for each. You will adjust them as needed, especialy the assignments Definitions folder.
Deployment Scripts Scripts are used to deploy your Policies, Initiatives, and Assignments to Azure. They do not need to be modified. If you have improvements, please offer to contribute them. Scripts/Deploy folder
Operational Scripts Scripts used to during operations (e.g., creating remedaition tasks). Scripts/Operations folder
Configuration Scripts Scripts are used to define the environment for Test and Operational scripts. You mst modify any environment specific values, such as Management Groups and Subscriptions. Scripts/Config folder
Helper and Utility Scripts These Scripts are used by other scripts. Scripts/Helpers and
Scripts/Utils folders
Test Scripts Scripts used by this solution's developers to execute other scripts without needing to type all the parameters each time. Scripts/Test folder


Back to top

Prerequisites


Back to top

Quick Start

  1. Create an Azure DevOps project dedicated to Policy as Code (PaC). You may also create a dedicated PaC repo within an existing Azure DevOps project.

  2. Import this repository into the newly created PaC repository:
    https://docs.microsoft.com/en-us/azure/devops/repos/git/import-git-repository?view=azure-devops

  3. Create a cusom role to be used by the planing stages' service connections. Policy Reader role should contain:

    • Microsoft.Authorization/policyAssignments/read
    • Microsoft.Authorization/policyDefinitions/read
    • Microsoft.Authorization/policySetDefinitions/read

  4. Create the Service Connections in Azure DevOps with the required permissions. You need 2 + 3 x number of tenants service connections.

    • Grant the required permissions to the SPNs in Azure. Note: depending on your scenario, these permissions may be very high.
      • If you're planning to use DeployIfNotExists (DINE) policies, the SPN has to have owner or user admin rights at the assignments' scope, so that it can grant access to the generated system assigned identity at deployment time. In other words, you may need owner or user admin permission on Tenant Root group level to fully unlock all the capabilities of Azure Policies deployed through this solution.
      • Some SPNs will also need Azure Active Directory reader role. This is required both for the permission plan creation and for assigning permissions (for DeployIfNotExists policies) as the role assignment PowerShell commandlet requires this permission.
    • Register the SPN in ADO as a Service Connection. The number of service connections is equal to 2 plus the number of tenants
    • https://docs.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?view=azure-devops&tabs=yaml#sep-azure-resource-manager

  5. Configure the deployment pipeline

    • Register the pipeline (pipeline.yml Pipeline folder of the repository).
    • Modify the pipeline to include the service connections and desired scope for your policy deployments (See the pipeline documentation file for more details on this)
    • The pipeline is triggered in various ways depending on the scope you are ready to deploy to. See the pipeline documentation to find a more detailed explanation on how each stage of the pipeline is triggered.

  6. Create environments in Azure DevOps. Environments must be created to isolate deployment controls and set approval gates.

    • Create the following environments (case sensitive):
    • PAC-ROLES
    • PAC-PROD
    • PAC-TEST
    • PAC-DEV
    • If you would like to modify the names of these environments, you must also modify the pipeline environments for each stage in the pipeline file.

  7. Create policies, initiatives, and assignments as needed

    • Follow the included file structures

    • NOTE: if you are NOT creating a greenfield environment, you may add the suppress delete operator to the pipeline file to keep previous policies, initiatives, and assignments. Add the -suppressDeletes switch parameter to every instance of script Build-AzPoliciesInitiativesAssignmentsPlan.ps1.

      scriptPath: "Scripts/Deploy/Build-AzPoliciesInitiativesAssignmentsPlan.ps1"
arguments: -TenantId $(tenantId) `
  -AssignmentSelector $(devAssignmentSelector) `
  -RootScope $(devRootScope) `
  -PlanFile $(devPlanFile) `
  -InformationAction Continue `
  -suppressDeletes

  8. Trigger the pipeline to deploy to each envrionment with these actionss:

    • DEV - Commit to feature branch or manually trigger
    • TEST - Pull request is approved
    • PROD - Azure DevOps approval gate is completed
    • ROLES - Azure DevOps role approval gate is completed (optional segregation of duty)


Back to top

Next steps

Pipeline Details
Policy and Initiative Definitions
Policy Assignments
Deploy, Test and Operational Scripts

Back to top

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.


Back to top

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.


Back to top