docs(azure-mi-docs) update docs#1246
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR refreshes the azure-mi module documentation by introducing terraform-docs scaffolding, adding example folders, and exposing more managed identity outputs for consumers.
Changes:
- Add
terraform-docssource files/config and regenerate the moduleREADME.md. - Add basic and comprehensive example documentation/HCL/YAML for the module.
- Expand module outputs with additional managed identity identifiers and align formatting in Terraform files.
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
modules/azure-mi/variables.tf |
Aligns access_policies object fields for readability. |
modules/azure-mi/outputs.tf |
Adds descriptions and new identity outputs. |
modules/azure-mi/main.tf |
Aligns Key Vault access policy arguments. |
modules/azure-mi/docs/header.md |
Adds terraform-docs header content for module overview/usage. |
modules/azure-mi/docs/footer.md |
Adds terraform-docs footer content for examples/resources/support. |
modules/azure-mi/_examples/comprehensive/values.reference.yaml |
Adds a comprehensive YAML reference example. |
modules/azure-mi/_examples/comprehensive/module.reference.hcl |
Adds a comprehensive HCL reference example. |
modules/azure-mi/_examples/comprehensive/README.md |
Documents the comprehensive example files. |
modules/azure-mi/_examples/basic/main.tf |
Adds a minimal runnable example. |
modules/azure-mi/_examples/basic/README.md |
Documents the basic example. |
modules/azure-mi/README.md |
Regenerates the public module README with new docs/examples/outputs. |
modules/azure-mi/.terraform-docs.yml |
Adds terraform-docs configuration for README generation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 12 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 12 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…into add/azure-mi-docs-v3
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 12 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 12 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 12 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 12 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **User-assigned identity**: Name, location, and tags. When `tags_from_rg` is **true**, identity tags are **only** those on the resource group (`var.tags` is ignored). When **false**, tags come from `var.tags`. | ||
| - **RBAC**: `rbac` entries flatten to `azurerm_role_assignment` resources, but the current implementation keys them by assignment `name` + individual `role`. Reusing the same `name` with the same `role` on different `scope` values is therefore **not currently supported** and will cause a duplicate-key error; use distinct assignment names in that case. | ||
| - **Federated credentials**: `federated_credentials` entries share `audience`; each entry has `type` `github`, `kubernetes`, or `other` (validated). The variable marks nested fields optional, but **`main.tf` expects real values per type** or plan/apply can fail: **`github`** — set `organization`, `repository`, and `entity` (subject suffix, e.g. `ref:refs/heads/main`); `issuer` defaults to the GitHub Actions OIDC issuer if unset. **`kubernetes`** — set `issuer`, `namespace`, and `service_account_name`. **`other`** — set `issuer` and `subject`. | ||
| - **Key Vault access policies**: Optional `access_policies` to grant the identity permissions on existing vaults by `key_vault_id`. |
| subject = "my-subject" | ||
| }, | ||
| ] | ||
|
|
No description provided.