NLB-2234: update vmss backend documentation #1642
Conversation
github-actions
bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
arussellf5
left a comment
arussellf5
left a comment
There was a problem hiding this comment.
This is excellent documentation! Thank you
|
|
||
| ## Getting Started | ||
|
|
||
| ### Step 1: Create NGINXaaS deployment with dynamic upstreams |
There was a problem hiding this comment.
| ### Step 1: Create NGINXaaS deployment with dynamic upstreams | |
| ### Create NGINXaaS deployment with dynamic upstreams |
There was a problem hiding this comment.
Make this at other places as well.
Refer: #1384
There was a problem hiding this comment.
updated above suggested changes
|
|
||
| ## Overview | ||
|
|
||
| The NGINXaaS dataplane API key is used to authenticate with your NGINXaaS deployment's dataplane API. This key is required for various integrations including VMSS backend synchronization and Kubernetes load balancing. |
There was a problem hiding this comment.
Arent these both load balancing (VMSS and Kubernetes)?
There was a problem hiding this comment.
Yes, it is useful both. Thats the reason i created a separate common page and use this reference in both VMSS and kubernetes places
|
|
||
| ## Create the API Key | ||
|
|
||
| The data plane API key can be created using the Azure CLI or portal. |
There was a problem hiding this comment.
I think mostly not needed because we are mentioning the both procedures below. If you think if some links would be helpful, then definitely I can include them.
|
|
||
| ```bash | ||
| # Set role name | ||
| roleName="VMSS-Network-Read-Role" |
There was a problem hiding this comment.
Why set this here? It's not used until later (the Assign the Custom Role script).
| ```yaml | ||
| # nginx-asg-sync configuration for NGINXaaS for Azure | ||
| cloud_provider: Azure | ||
| subscription_id: your_subscription_id |
There was a problem hiding this comment.
In the json file mentioned above, you used "<SUBSCRIPTION_ID>" nomenclature to indicate items that the user needed to substitute real values into. Should we use the same pattern here?
|
|
||
| ``` | ||
| 2026/01/08 15:44:12 nginx-asg-sync version 1.0.3 | ||
| 2026/01/08 15:44:13 Updated HTTP servers of backend-one for group naveen-vmss-latest ; Added: [172.19.0.6:80 172.19.0.7:80], Removed: [], Updated: [] |
There was a problem hiding this comment.
Probably don't want your name in here (and below)
|
|
||
| You can assign managed identity permissions using: | ||
|
|
||
| - **Azure Portal**: Navigate to **Resource** → **Identity** → **Role assignments** in the Azure portal |
There was a problem hiding this comment.
Wasn't clear what the starting point for this was? Which resource should I be looking at in the Portal?
Proposed changes
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩