Skip to content

Commit

Permalink
Minor updates (#327)
Browse files Browse the repository at this point in the history
  • Loading branch information
anwather authored Aug 23, 2023
1 parent 73c24d0 commit 18f5436
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Docs/policy-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Policy Definition Files

Policy definition files are managed within the the folder `policyDefintions` under `Definitions`. The Policy definition files are structured based on the official [Azure Policy definition structure](https://docs.microsoft.com/en-us/azure/governance/policy/concepts/definition-structure) published by Microsoft. There are numerous definition samples available on Microsoft's [GitHub repository for azure-policy](https://github.com/Azure/azure-policy).
Policy definition files are managed within the the folder `policyDefinitions` under `Definitions`. The Policy definition files are structured based on the official [Azure Policy definition structure](https://docs.microsoft.com/en-us/azure/governance/policy/concepts/definition-structure) published by Microsoft. There are numerous definition samples available on Microsoft's [GitHub repository for azure-policy](https://github.com/Azure/azure-policy).

!!! note
When authoring Policy and Policy definitions, check out the [Maximum count of Azure Policy objects](https://docs.microsoft.com/en-us/azure/governance/policy/overview#maximum-count-of-azure-policy-objects)
Expand Down
9 changes: 5 additions & 4 deletions Docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,19 @@ For this example all you need is ```Reader``` permission in your Azure environme
Install-Module Az -Scope CurrentUser
Connect-AzAccount
```
3. Install the Enterprise Policy as Code module
3. Install the Enterprise Policy as Code module.
```ps1
Install-Module EnterprisePolicyAsCode -Scope CurrentUser
```
4. Create a new EPAC definitions folder to hold policy objects
4. Create a new EPAC definitions folder to hold policy objects.
```ps1
New-EPACDefinitionsFolder -DefinitionsRootFolder Definitions
```
5. This will create a folder called ```Definitions``` with a number of subfolder and a ```global-settings.jsonc``` file where the environment is defined.
6. Edit the ```global-settings.jsonc``` file by copying the sample below. Modify the commented sections as appropriate.
```json
{
"$schema": "https://raw.githubusercontent.com/Azure/enterprise-azure-policy-as-code/main/Schemas/global-settings-schema.json",
"pacOwnerId": "f2ce1aea-944e-4517-94fb-edada00633ae", # Generate a guid using New-Guid and place it here
"managedIdentityLocations": {
"*": "australiaeast" # Update the default location for managed identities
Expand All @@ -50,7 +51,7 @@ Export-AzPolicyResources -DefinitionsRootFolder .\Definitions -OutputFolder Outp

In the ```Output``` folder you should now find all the custom policy definitions and assignments which have been deployed in your environment. From this point you can make some choices about how to best utilize EPAC to handle Azure Policy in your environment including:-

- Copy the Output files into the appropriate files in your ```Definitions``` folder and use the ```Build-DeploymentPlans``` command to generate a plan for policy deployment. Once the plan is generated you can use the ```Deploy-PolicyPlan``` and ```Deploy-RolesPlan``` commands to start managing deployed policies with EPAC.
- Copy the Output files into the appropriate folders in your ```Definitions``` folder and use the ```Build-DeploymentPlans``` command to generate a plan for policy deployment. Once the plan is generated you can use the ```Deploy-PolicyPlan``` and ```Deploy-RolesPlan``` commands to start managing deployed policies with EPAC.
- Read up on [Desired State Strategy](desired-state-strategy.md) and plan a gradual rollout of policy using EPAC.
- Use the artifacts in the [Starter Kit](https://github.com/Azure/enterprise-azure-policy-as-code/tree/main/StarterKit) for some in-depth examples and sample pipelines for CI/CD integration.
- Review the rest of this documentation to examine some of the more complex EPAC features.
Expand All @@ -59,7 +60,7 @@ If there are any issue please raise them in the (GitHub Repository)[https://gith

## Create your environment

* [Setup DevOps Environment](operating-environment.md) for your developers (on their workstations) and your CI/CD pipeline runners/agents (on a VM or set of VMs) to facilitate correct implementations. <br/> **Operating Environment Prerequisites:** The EPAC Deployment process is designed for DevOps CI/CD. It requires the [installation of several tools] to facilitate effective development, testing, and deployment during the course of a successful implementation.
* [Setup DevOps Environment](operating-environment.md) for your developers (on their workstations) and your CI/CD pipeline runners/agents (on a VM or set of VMs) to facilitate correct implementations. <br/> **Operating Environment Prerequisites:** The EPAC Deployment process is designed for DevOps CI/CD. It requires the installation of several tools to facilitate effective development, testing, and deployment during the course of a successful implementation.
* Acquire the PowerShell scripts (options)
* [Import Azure PowerShell Module](powershell-module.md)
* [Create a source repository and import the source code](clone-github.md) from this repository.
Expand Down

0 comments on commit 18f5436

Please sign in to comment.