Skip to content

NLB-7299: docs - add system-assigned managed identity requirement to …#1659

Open
rnandwal-f5 wants to merge 10 commits intonginx:mainfrom
rnandwal-f5:NLB-7299-Make-SystemMI-Required
Open

NLB-7299: docs - add system-assigned managed identity requirement to …#1659
rnandwal-f5 wants to merge 10 commits intonginx:mainfrom
rnandwal-f5:NLB-7299-Make-SystemMI-Required

Conversation

@rnandwal-f5
Copy link
Contributor

@rnandwal-f5 rnandwal-f5 commented Jan 16, 2026

Summary

Updates documentation to reflect that system-assigned managed identity (systemMI) is now required for Geneva logging and monitoring in NGINXaaS for Azure.

Changes

Deployment Guides

  • Portal: Added note that systemMI is automatically created
  • CLI: Added --identity type="SystemAssigned" requirement to all examples
  • Terraform: Added systemMI requirement callout
  • ARM/Bicep/SDK: Added systemMI requirement notes

Key Points

  • Portal: SystemMI created automatically
  • CLI/Terraform/ARM/SDK: Must set identity.type="SystemAssigned"
  • SystemMI cannot be removed once created
  • Backward Compatibility: Legacy deployments without systemMI continue to work without requiring changes

Note: Existing deployments are not affected by this change.

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@rnandwal-f5 rnandwal-f5 requested a review from arpith-f5 January 16, 2026 10:20
@rnandwal-f5 rnandwal-f5 requested review from a team as code owners January 16, 2026 10:20
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginxaas-azure Issues related to NGINX as a Service for Azure labels Jan 16, 2026
Copy link
Contributor

@amudukutore amudukutore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking through the changes here, the call out to add a system assigned MI is repeated across multiple sections which seems a bit excessive. Can we only add it in the section on enabling logs and metrics?

@rnandwal-f5 rnandwal-f5 force-pushed the NLB-7299-Make-SystemMI-Required branch 2 times, most recently from b3cf533 to 94fdd4f Compare January 21, 2026 08:56
@JTorreG
Copy link
Contributor

JTorreG commented Jan 21, 2026

waiting for the suggestions and questions from @arpith-f5 to be addressed before my review

@rnandwal-f5 rnandwal-f5 requested a review from arpith-f5 January 22, 2026 11:26
@arpith-f5
Copy link
Contributor

@rnandwal-f5 lets update the changelog also https://docs.nginx.com/nginxaas/azure/changelog

@rnandwal-f5 rnandwal-f5 requested a review from arpith-f5 January 30, 2026 07:36
rnandwal-f5 and others added 10 commits February 11, 2026 21:38
…deployment documentation

System-assigned MI now required for new deployments

Updates all deployment documentation to reflect systemMI requirement:
- Portal: Automatically creates systemMI
- CLI/Terraform/ARM/SDK: Must set identity.type="SystemAssigned"
- SystemMI cannot be removed once created
- Legacy deployments continue to work

Updated deployment guides, client tools docs, managed identity docs,
monitoring prerequisites, and SSL/TLS prerequisites with requirement
notes and backward compatibility information.
…ions

Removed duplicate references to system-assigned managed identity being
required, as this is already clearly stated in the overview section and nginxaas-azure-snippets docs.Streamlined content to avoid repetition while maintaining clarity.
- Remove systemMI requirement from disaster-recovery and add it to terraform.
- fix docs and remove duplcate callout in mananged-identity-portal.md
…signed managed identity

- Add new section "Checking for deployments without system assigned managed identity"
- Include bash script using Azure CLI to list NGINXaaS deployments missing system MI
- Add prerequisite note about Azure CLI login and subscription selection
…tity requirement

Document the new requirement for system-assigned managed identity on all
NGINXaaS deployments.
…t for managed identity check

Replaced bash script with Resource Graph query that can be run directly in
Azure Portal. The query works across all subscriptions and doesn't require
Azure CLI installation.
- Consolidate system-assigned identity viewing and management sections
- Clarify user-assigned identity removal impacts and move it under remove UAMI section
…o changelog

Add steps to add system MI to deployments which dont have it, along with a call note stating that it can only be used for the deployments which dont have system MI

Update changelog to link steps to add system MI.
@rnandwal-f5 rnandwal-f5 force-pushed the NLB-7299-Make-SystemMI-Required branch from ca5edf3 to 96c6e0c Compare February 11, 2026 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/nginxaas-azure Issues related to NGINX as a Service for Azure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants