search

Azure / terraform-azurerm-avm-ptn-avd-lza-managementplane

Azure Virtual Desktop Landing Zone Accelerator Management Plane
https://registry.terraform.io/modules/Azure/avm-ptn-avd-lza-managementplane/azurerm/latest
MIT License
3 stars 3 forks source link

AVM-Review #11

Closed mbilalamjad closed 1 month ago

mbilalamjad commented 3 months ago

Dear module owner,

As per the agreed module ownership requirements & responsibilities at the time of assignment, the AVM Team is opening this issue to request you to kindly review your module against the below AVM specs and confirm that they are met by the module.

We appreciate if you don't close this issue till the review is complete. This review is required as a pre-req to be able to publish v0.1.0 the module to the Terraform Registry. AVM team would be happy to assist with any questions that you might have.

Requested Actions

Please use the comments columns to provide additional details especially if you selected N or NA. Please note Y stands for Yes - Compliant, N stand for No - Not Compliant and NA stands for Not Applicable.

### Tasks
- [x] Address comments on your PR if any
- [x] Ensure that all checks on your PR are passing
- [x] Ensure the latest "chore: repository governance" PR is merged ahead of your PR
- [x] Acknowledge specs with comment "Module Owner to action this spec post-publish as appropriate" by ticking this
ID Spec Status Comments
1 ID: SFR1 - Category: Composition - Preview Services NA Select NA if no preview services are used
2 ID: SFR2 - Category: Composition - WAF Aligned Y Ensure only high priority reliability & security recommendations are implemented if any
3 ID: SFR3 - Category: Telemetry - Deployment/Usage Telemetry Y
4 ID: SFR4 - Category: Telemetry - Telemetry Enablement Flexibility Y Select Y if AVM Template Repo has been used
5 ID: SFR5 - Category: Composition - Availability Zones Y Service is zone-redundant
6 ID: SFR6 - Category: Composition - Data Redundancy NA
7 ID: SNFR25 - Category: Composition - Resource Naming Y
8 ID: SNFR1 - Category: Testing - Prescribed Tests Y Select Y if all e2e test, version-check & linting checks passed
9 ID: SNFR2 - Category: Testing - E2E Testing Y Select Y if e2e tests passed
10 ID: SNFR3 - Category: Testing - AVM Compliance Tests Y Select Y if all e2e test, version-check & linting checks passed
11 ID: SNFR4 - Category: Testing - Unit Tests NA Select NA if no tests created in tests folder
12 ID: SNFR5 - Category: Testing - Upgrade Tests NA Module Owner to action this spec post-publish as appropriate
13 ID: SNFR6 - Category: Testing - Static Analysis/Linting Tests Y Select Y if all linting checks passed
14 ID: SNFR7 - Category: Testing - Idempotency Tests Y Select Y if e2e tests passed
15 ID: SNFR24 - Category: Testing - Testing Child, Extension & Interface Resources Y Select Y if e2e tests passed
16 ID: SNFR8 - Category: Contribution/Support - Module Owner(s) GitHub Y
17 ID: SNFR20 - Category: Contribution/Support - GitHub Teams Only Y
18 ID: SNFR9 - Category: Contribution/Support - AVM & PG Teams GitHub Repo Permissions Y
19 ID: SNFR10 - Category: Contribution/Support - MIT Licensing Y Select Y if AVM Template Repo has been used
20 ID: SNFR11 - Category: Contribution/Support - Issues Response Times NA Module Owner to action this spec post-publish as appropriate
21 ID: SNFR12 - Category: Contribution/Support - Versions Supported NA Module Owner to action this spec post-publish as appropriate
22 ID: SNFR23 - Category: Contribution/Support - GitHub Repo Labels Y
23 ID: SNFR14 - Category: Inputs - Data Types Y
24 ID: SNFR22 - Category: Inputs - Parameters/Variables for Resource IDs Y
25 ID: SNFR15 - Category: Documentation - Automatic Documentation Generation Y Select Y if linting / docs check passed
26 ID: SNFR16 - Category: Documentation - Examples/E2E Y Select Y if e2e tests passed
27 ID: SNFR17 - Category: Release - Semantic Versioning Y Select Y if version-check check passed
28 ID: SNFR18 - Category: Release - Breaking Changes NA Module Owner to action this spec post-publish as appropriate
29 ID: SNFR19 - Category: Publishing - Registries Targeted NA Module Owner to action this spec post-publish as appropriate
30 ID: SNFR21 - Category: Publishing - Cross Language Collaboration NA Module Owner to action this spec post-publish as appropriate
31 ID: RMFR1 - Category: Composition - Single Resource Only Y
32 ID: RMFR2 - Category: Composition - No Resource Wrapper Modules Y
33 ID: RMFR3 - Category: Composition - Resource Groups Y
34 ID: RMFR4 - Category: Composition - AVM Consistent Feature & Extension Resources Value Add Y Select Y if linting / terraform check passed
35 ID: RMFR5 - Category: Composition - AVM Consistent Feature & Extension Resources Value Add Interfaces/Schemas Y Select Y if linting / terraform check passed
36 ID: RMFR8 - Category: Composition - Dependency on child and other resources Y
37 ID: RMFR6 - Category: Inputs - Parameter/Variable Naming Y
38 ID: RMFR7 - Category: Outputs - Minimum Required Outputs Y Select Y if linting / terraform check passed
39 ID: RMNFR1 - Category: Naming - Module Naming Y
40 ID: RMNFR2 - Category: Inputs - Parameter/Variable Naming Y
41 ID: RMNFR3 - Category: Composition - RP Collaboration NA Module Owner to action this spec post-publish as appropriate
42 ID: PMFR1 - Category: Composition - Resource Group Creation Y Select NA if this is not a pattern module
43 ID: PMNFR1 - Category: Naming - Module Naming Y Select NA if this is not a pattern module
44 ID: PMNFR2 - Category: Composition - Use Resource Modules to Build a Pattern Module Y Select NA if this is not a pattern module
45 ID: PMNFR3 - Category: Composition - Use other Pattern Modules to Build a Pattern Module Y Select NA if this is not a pattern module
46 ID: PMNFR4 - Category: Hygiene - Missing Resource Module(s) Y Select NA if this is not a pattern module
47 ID: PMNFR5 - Category: Inputs - Parameter/Variable Naming Y Select NA if this is not a pattern module
48 ID: TFFR1 - Category: Composition - Cross-Referencing Modules Y
49 ID: TFFR2 - Category: Outputs - Additional Terraform Outputs Y Select Y if linting / terraform check passed
50 ID: TFNFR1 - Category: Documentation - Descriptions Y
51 ID: TFNFR2 - Category: Documentation - Module Documentation Generation Y Select Y if linting / docs check passed
52 ID: TFNFR3 - Category: Contribution/Support - GitHub Repo Branch Protection Y Select Y if AVM Template Repo has been used
53 ID: TFNFR4 - Category: Composition - Code Styling - lower snake_casing Y Select Y if linting / terraform check passed
54 ID: TFNFR5 - Category: Testing - Test Tooling Y Select Y if linting / terraform check passed
55 ID: TFNFR6 - Category: Code Style - Resource & Data Order Y
56 ID: TFNFR7 - Category: Code Style - count & for_each Use Y
57 ID: TFNFR8 - Category: Code Style - Resource & Data Block Orders Y Select Y if linting / avmfix check passed
58 ID: TFNFR9 - Category: Code Style - Module Block Order Y
59 ID: TFNFR10 - Category: Code Style - No Double Quotes in ignore_changes Y
60 ID: TFNFR11 - Category: Code Style - Null Comparison Toggle Y
61 ID: TFNFR12 - Category: Code Style - Dynamic for Optional Nested Objects Y
62 ID: TFNFR13 - Category: Code Style - Default Values with coalesce/try Y
63 ID: TFNFR14 - Category: Inputs - Not allowed variables Y
64 ID: TFNFR15 - Category: Code Style - Variable Definition Order Y Select Y if linting / avmfix check passed
65 ID: TFNFR16 - Category: Code Style - Variable Naming Rules Y Select Y if linting / terraform check passed
66 ID: TFNFR17 - Category: Code Style - Variables with Descriptions Y Select Y if linting / terraform check passed
67 ID: TFNFR18 - Category: Code Style - Variables with Types Y Select Y if linting / terraform check passed
68 ID: TFNFR19 - Category: Code Style - Sensitive Data Variables Y
69 ID: TFNFR20 - Category: Code Style - Non-Nullable Defaults for collection values Y
70 ID: TFNFR21 - Category: Code Style - Discourage Nullability by Default Y Select Y if linting / avmfix check passed
71 ID: TFNFR22 - Category: Code Style - Avoid sensitive = false Y Select Y if linting / avmfix check passed
72 ID: TFNFR23 - Category: Code Style - Sensitive Default Value Conditions Y Select Y if linting / terraform check passed
73 ID: TFNFR24 - Category: Code Style - Handling Deprecated Variables NA Module Owner to action this spec post-publish as appropriate
74 ID: TFNFR25 - Category: Code Style - Verified Modules Requirements Y Select Y if linting / terraform check passed
75 ID: TFNFR26 - Category: Code Style - Providers in required_providers Y Select Y if linting / terraform check passed
76 ID: TFNFR27 - Category: Code Style - Provider Declarations in Modules Y Select Y if linting / terraform check passed
77 ID: TFNFR28 - Category: Code Style - Provider Declarations in Modules Y Select Y if linting / terraform check passed
78 ID: TFNFR29 - Category: Code Style - Sensitive Data Outputs N Select Y if linting / avmfix check passed
79 ID: TFNFR30 - Category: Code Style - Handling Deprecated Outputs NA Module Owner to action this spec post-publish as appropriate
80 ID: TFNFR31 - Category: Code Style - locals.tf for Locals Only Y
81 ID: TFNFR32 - Category: Code Style - Alphabetical Local Arrangement Y Select Y if linting / avmfix check passed
82 ID: TFNFR33 - Category: Code Style - Precise Local Types Y
83 ID: TFNFR34 - Category: Code Style - Using Feature Toggles NA Module Owner to action this spec post-publish as appropriate
84 ID: TFNFR35 - Category: Code Style - Reviewing Potential Breaking Changes NA Module Owner to action this spec post-publish as appropriate
85 ID: TFNFR36 - Category: Code Style - Setting prevent_deletion_if_contains_resources Y
86 ID: TFNFR37 - Category: Code Style - Tool Usage by Module Owner Y
mbilalamjad commented 1 month ago

Thank you so much for contributing this module and completing the review process per AVM specs to ensure quality.

You may proceed with publishing this module to the HashiCorp Terraform Registry with the initial pre-release version set as v0.1.0.

Please keep future versions also pre-release (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until AVM goes GA after which you can do v1.x.x releases.

I will proceed with closing this issue, once the module is published kindly update the proposal with the below comment.

"The AVM-Review of this module has been completed and the module has been published to the registry. Requesting AVM team to update this module proposal and module index accordingly."