fix: minor updates (#56)

Azure · Sep 29, 2024 · 35f5d01 · 35f5d01
1 parent 24ce686
commit 35f5d01
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 26 deletions.
diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml
@@ -57,7 +57,7 @@ jobs:
           go-version: 'stable'
 
       - name: Install alzlibtool
-        run: go install github.com/Azure/alzlib/cmd/alzlibtool@v0.18.0
+        run: go install github.com/Azure/alzlib/cmd/alzlibtool@v0.20.0
 
       - name: Azure login
         uses: azure/login@6c251865b4e6290e7b78be643ea2d005bc51f69a # v2.1.1
@@ -66,9 +66,25 @@ jobs:
           tenant-id: ${{ vars.AZURE_TENANT_ID }}
           allow-no-subscriptions: true
 
+      - name: Check README
+        run: |
+          alzlibtool document library . > README.md
+          if [ -z "$(git status -suno)" ]; then
+            echo "README.md is up to date"
+          else
+            echo "README.md is out of date"
+            git --no-pager diff
+            exit 1
+          fi
+        shell: bash
+        working-directory: platform/${{ matrix.lib }}
+        env:
+          LIBRARY_PATH: platform/${{ matrix.lib }}
+
       - name: Check lib
         run: |
-          alzlibtool check library "platform/${{ matrix.lib }}"
+          alzlibtool check library .
         shell: bash
+        working-directory: platform/${{ matrix.lib }}
         env:
           LIBRARY_PATH: platform/${{ matrix.lib }}
diff --git a/docs/content/assets/archetype-overrides.md b/docs/content/assets/archetype-overrides.md
@@ -21,7 +21,7 @@ They should not be stored in a central library.
 
 We publish the schema of an archetype override [here](https://raw.githubusercontent.com/Azure/Azure-Landing-Zones-Library/main/schemas/archetype_override.json) and we have registered the file extensions with [schemastore.org](https://www.schemastore.org/json/) to enable  automatic validation in editors.
 
-An archetype override has a name, which must be unique amonst all archetypes and override archetypes.
+An archetype override has a name, which must be unique amongst all archetypes and override archetypes.
 It also has and a set of policy definitions, policy set definitions, policy assignments, and role definitions to add and remove from the referenced base archetype.
 All of these associated assets are referenced by their name (JSON `.name`) property.
 

diff --git a/docs/content/assets/architectures.md b/docs/content/assets/architectures.md
@@ -28,3 +28,24 @@ If `parent_id` is set to `null`, the management group is created as a child of t
 Typically, this is the tenant root management group.
 
 All of these associated assets are referenced by their name (JSON `.name`) property.
+
+## Example
+
+Here is an example architecture definition file:
+
+```yaml
+name: my architecture
+management_groups:
+  - id: my-mg
+    display_name: My Management Group
+    archetypes:
+      - root
+    parent_id: null
+    exists: false
+  - id: my-mg-child
+    display_name: My Management Group Child
+    archetypes:
+      - landing_zones
+    parent_id: my-mg
+    exists: false
+```
diff --git a/docs/content/assets/policy-default-values.md b/docs/content/assets/policy-default-values.md
@@ -12,7 +12,7 @@ Filename patterns:
 - `alz_policy_default_values.yml`
 
 A policy default values file is a mapping of common values to policy assignments and parameter names.
-There can only be one policy default values file in an archetype, we recommend that this is stored in the root of the library member directory.
+There can only be one policy default values file in an library member, we recommend that this is stored in the root of the library member directory.
 
 It is common to want to specify a default log analytics workspace for all policy assignments that require one.
 This file allows you to specify the default values for these parameters.

diff --git a/platform/alz/README.md b/platform/alz/README.md
@@ -425,13 +425,6 @@ The following policy default values are available in this library:
 - userAssignedIdentityResourceId
 </details>
 
-#### assignment `Deploy-vmArc-ChangeTrack`
-
-<details><summary>1 parameter names</summary>
-
-- userAssignedIdentityResourceId
-</details>
-
 #### assignment `Deploy-VMSS-ChangeTrack`
 
 <details><summary>1 parameter names</summary>
@@ -504,46 +497,46 @@ The following policy default values are available in this library:
 
 ### default name `log_analytics_workspace_id`
 
-#### assignment `Deploy-AzActivity-Log`
+#### assignment `Deploy-MDFC-Config`
 
 <details><summary>1 parameter names</summary>
 
 - logAnalytics
 </details>
 
-#### assignment `Deploy-AzSqlDb-Auditing`
+#### assignment `Deploy-MDFC-DefSQL-AMA`
 
 <details><summary>1 parameter names</summary>
 
-- logAnalyticsWorkspaceId
+- userWorkspaceResourceId
 </details>
 
-#### assignment `Deploy-Diag-Logs`
+#### assignment `Deploy-AzActivity-Log`
 
 <details><summary>1 parameter names</summary>
 
 - logAnalytics
 </details>
 
-#### assignment `Deploy-MDFC-Config-H224`
+#### assignment `Deploy-AzSqlDb-Auditing`
 
 <details><summary>1 parameter names</summary>
 
-- logAnalytics
+- logAnalyticsWorkspaceId
 </details>
 
-#### assignment `Deploy-MDFC-Config`
+#### assignment `Deploy-Diag-Logs`
 
 <details><summary>1 parameter names</summary>
 
 - logAnalytics
 </details>
 
-#### assignment `Deploy-MDFC-DefSQL-AMA`
+#### assignment `Deploy-MDFC-Config-H224`
 
 <details><summary>1 parameter names</summary>
 
-- userWorkspaceResourceId
+- logAnalytics
 </details>
 
 ### default name `log_analytics_workspace_location`

diff --git a/platform/alz/alz_policy_default_values.json b/platform/alz/alz_policy_default_values.json
@@ -10,12 +10,6 @@
           ],
           "policy_assignment_name": "Deploy-VM-ChangeTrack"
         },
-        {
-          "parameter_names": [
-            "userAssignedIdentityResourceId"
-          ],
-          "policy_assignment_name": "Deploy-vmArc-ChangeTrack"
-        },
         {
           "parameter_names": [
             "userAssignedIdentityResourceId"