NLB-2234: update vmss backend documentation #1642

Naveen-Gopu-F5 · 2026-01-08T17:31:15Z

Proposed changes

Included the steps/documentation about the vmss backend which helps in dynamic update of upstreams in NGINXaaS

Checklist

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

I read the Contributing guidelines
My branch adheres to the Git conventions
My content changes adhere to the F5 NGINX Documentation style guide
If my changes involve potentially sensitive information¹, I have assessed the possible impact
I have waited to ensure my changes pass tests, and addressed any discovered issues

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

github-actions · 2026-01-08T17:34:36Z

✅ Deploy Preview will be available once build job completes!

Name	Link
😎 Deploy Preview	https://frontdoor-test-docs.nginx.com/previews/docs/1642/

arussellf5

This is excellent documentation! Thank you

content/nginxaas-azure/vmss-backend.md

content/nginxaas-azure/loadbalancer-vmss.md

content/nginxaas-azure/vmss-backend.md

kafeelhasan · 2026-01-12T07:47:53Z

content/nginxaas-azure/vmss-backend.md

+
+## Getting Started
+
+### Step 1: Create NGINXaaS deployment with dynamic upstreams


Suggested change

### Step 1: Create NGINXaaS deployment with dynamic upstreams

### Create NGINXaaS deployment with dynamic upstreams

Make this at other places as well.
Refer: #1384

updated above suggested changes

russokj · 2026-01-12T21:58:26Z

content/nginxaas-azure/quickstart/dataplane-api-key.md

+
+## 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.


Arent these both load balancing (VMSS and Kubernetes)?

Yes, it is useful both. Thats the reason i created a separate common page and use this reference in both VMSS and kubernetes places

So maybe just call it VMSS load balancing (@arussellf5 what do you think?).

updated to VMSS load balancing

content/nginxaas-azure/quickstart/dataplane-api-key.md

russokj · 2026-01-15T11:48:21Z

content/nginxaas-azure/vmss-backend.md

+
+```bash
+# Set role name
+roleName="VMSS-Network-Read-Role"


Why set this here? It's not used until later (in the Assign the Custom Role script).

Nice catch, shifted it to Assign the Custom Role section

russokj · 2026-01-15T11:59:32Z

content/nginxaas-azure/vmss-backend.md

+```yaml
+# nginx-asg-sync configuration for NGINXaaS for Azure
+cloud_provider: Azure
+subscription_id: your_subscription_id


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?

updated to <SUBSCRIPTION_ID>

russokj · 2026-01-15T12:17:37Z

content/nginxaas-azure/vmss-backend.md

+
+```
+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: []


Probably don't want your name in here (and below)

Removed names and used backend-one

russokj · 2026-01-15T12:49:11Z

content/nginxaas-azure/vmss-backend.md

+
+You can assign managed identity permissions using:
+
+- **Azure Portal**: Navigate to **Resource** → **Identity** → **Role assignments** in the Azure portal


Wasn't clear what the starting point for this was? Which resource should I be looking at in the Portal?

Yes, updated to specific resource like vm, vmss

russokj · 2026-01-16T14:05:21Z

content/nginxaas-azure/vmss-backend.md

@@ -0,0 +1,485 @@
+---
+title: Virtual Machine Scale Sets (VMSS) Backend Integration


We call this file vmss-backend.md but for kubernetes we call it loadbalancer-kubernetes.md. I'm wondering, for consistency sake, we call this loadbalancer-vmss.md instead. I'd also change the title to be consistent too. (@arussellf5 please input if you think differently).

updated the title and file names as suggested to main consistency

russokj · 2026-01-16T14:07:26Z

content/nginxaas-azure/vmss-backend.md

+Before setting up VMSS backend integration, ensure you have:
+
+- An active NGINXaaS for Azure deployment
+- Azure Virtual Machine Scale Sets (VMSS)


Please highlight that the orchestration mode must be set to uniform and not flexible.

Highlighted as suggested above

russokj · 2026-01-16T14:09:26Z

content/nginxaas-azure/vmss-backend.md

+            proxy_pass http://backend-two;
+        }
+
+        location @hc-backend-two {


Do we need to have two backend upstream groups. Seems for simplicity we'd just keep this simple and create one upstream group.

simplified it by including only one upstream group

russokj

No major issues. Just come suggestions.

NLB-2234: update vmss backend documentation

7f32fba

Naveen-Gopu-F5 requested review from arussellf5 and russokj January 8, 2026 17:31

github-actions bot added documentation Improvements or additions to documentation product/nginxaas-azure Issues related to NGINX as a Service for Azure labels Jan 8, 2026

Naveen-Gopu-F5 requested a review from ryepup January 8, 2026 17:40

NLB-2234: Add additional references

f0526a0

arussellf5 reviewed Jan 9, 2026

View reviewed changes

NLB-2234: Make dataplane api key as a common page

13c8156

Naveen-Gopu-F5 requested a review from arussellf5 January 12, 2026 07:15

kafeelhasan reviewed Jan 12, 2026

View reviewed changes

NLB-2234: Remove steps numbering

47fe0dc

Naveen-Gopu-F5 requested a review from kafeelhasan January 12, 2026 09:25

russokj reviewed Jan 12, 2026

View reviewed changes

content/nginxaas-azure/quickstart/dataplane-api-key.md Show resolved Hide resolved

arussellf5 approved these changes Jan 13, 2026

View reviewed changes

NLB-2234: Update container steps for vmss

c62dea8

Naveen-Gopu-F5 marked this pull request as ready for review January 13, 2026 17:53

Naveen-Gopu-F5 requested review from a team as code owners January 13, 2026 17:53

russokj reviewed Jan 15, 2026

View reviewed changes

Naveen-Gopu-F5 added 2 commits January 16, 2026 14:26

NLB:2234: Remove unnecessary usage of pii

4cdbe87

NLB-2234: Add ACI approach for vmss to docs

80cc514

russokj reviewed Jan 16, 2026

View reviewed changes

russokj approved these changes Jan 16, 2026

View reviewed changes

Naveen-Gopu-F5 added 2 commits January 16, 2026 20:46

NLB-2234: Update title to VMSS loadbalancing

1c87b7d

NLB-2234: Update file references

62baf4f


		## Getting Started

		### Step 1: Create NGINXaaS deployment with dynamic upstreams

	### Step 1: Create NGINXaaS deployment with dynamic upstreams
	### Create NGINXaaS deployment with dynamic upstreams


		## 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.


		You can assign managed identity permissions using:

		- Azure Portal: Navigate to Resource → Identity → Role assignments in the Azure portal

		@@ -0,0 +1,485 @@
		---
		title: Virtual Machine Scale Sets (VMSS) Backend Integration

NLB-2234: update vmss backend documentation #1642

Are you sure you want to change the base?

NLB-2234: update vmss backend documentation #1642

Conversation

Naveen-Gopu-F5 commented Jan 8, 2026

Proposed changes

Checklist

Footnotes

Uh oh!

github-actions bot commented Jan 8, 2026

✅ Deploy Preview will be available once build job completes!

Uh oh!

arussellf5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

russokj Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

russokj left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

russokj Jan 15, 2026 •

edited

Loading