Add v2 to v3 migration guide - #1843

Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom
agent/upgrade-v2-v3-doc
Open

Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom
agent/upgrade-v2-v3-doc

Conversation

@nginx-seanmoloney

@nginx-seanmoloneynginx-seanmoloney commented Apr 9, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Proposed changes

  • Add v2 to v3 migration guide
    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks

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

@nginx-seanmoloney
nginx-seanmoloney requested a review from a team as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney marked this pull request as draft April 9, 2026 14:00
@github-actionsgithub-actionsBot added documentation Improvements or additions to documentation product/nginx-one-console Issues related to NGINX One Console labels Apr 9, 2026
@github-actions

github-actionsBot commented Apr 9, 2026

Copy link
Copy Markdown

✅ Deploy Preview will be available once build job completes!

NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/

@fabriziofiorucci

fabriziofiorucci commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file

@nginx-seanmoloney
nginx-seanmoloney marked this pull request as ready for review April 13, 2026 20:47
JTorreG
JTorreG reviewed Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md Outdated
Comment on lines +1 to +8
---
title: Migrate NGINX Agent v2 to v3
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---

@JTorreGJTorreGApr 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md

@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.

@nginx-seanmoloney
nginx-seanmoloney marked this pull request as draft April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot added the product/agent Issues related to NGINX Agent label Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney marked this pull request as ready for review April 16, 2026 12:07
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated

## Before you begin

- Registry access for agent v3 images.

@kkyle-f5kkyle-f5Apr 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Move under "Ensure you have:"

@travisamartintravisamartinApr 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent

@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Done!

kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated
## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).

@kkyle-f5kkyle-f5Apr 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Move under "Ensure you have:"

@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Done!

kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.

@kkyle-f5kkyle-f5Apr 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.

@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Done!

kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md Outdated
kkyle-f5
kkyle-f5 reviewed Apr 16, 2026
View reviewed changes

@kkyle-f5kkyle-f5 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I made a few suggestions.

nginx-seanmoloneyand others added 13 commits April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot deleted the agent/upgrade-v2-v3-doc branch July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add v2 to v3 migration guide - #1843
Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Open
Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Conversation
@nginx-seanmoloney
@nginx-seanmoloneynginx-seanmoloney
commented
Apr 9, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Proposed changes
  • Add v2 to v3 migration guide

    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks
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. ↩
@nginx-seanmoloney
nginx-seanmoloney
requested a review
from a team
as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 9, 2026 14:00
@github-actionsgithub-actionsBot
added

documentation
Improvements or additions to documentation
product/nginx-one-console
Issues related to NGINX One Console
labels
Apr 9, 2026
@github-actions
github-actionsBot
commented
Apr 9, 2026

Copy link


Copy Markdown

✅ Deploy Preview will be available once build job completes!
NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/
@fabriziofiorucci
fabriziofiorucci
commented
Apr 9, 2026

Copy link


Copy Markdown

Contributor
Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 13, 2026 20:47
JTorreG
JTorreG
reviewed
Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md
Outdated


Comment on lines

+1
 to 
+8

---
title: Migrate NGINX Agent v2 to v3 
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---
@JTorreGJTorreGApr 14, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot
added
the 
product/agent
Issues related to NGINX Agent
label
Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 16, 2026 12:07
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated


## Before you begin

- Registry access for agent v3 images.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@travisamartintravisamartinApr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
@kkyle-f5kkyle-f5
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I made a few suggestions.
nginx-seanmoloneyand others
added 13 commits
April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot
deleted the

agent/upgrade-v2-v3-doc

branch
July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.


Assignees


No one assigned


Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add v2 to v3 migration guide - #1843
Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Open
Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Conversation
@nginx-seanmoloney
@nginx-seanmoloneynginx-seanmoloney
commented
Apr 9, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Proposed changes
  • Add v2 to v3 migration guide

    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks
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. ↩
@nginx-seanmoloney
nginx-seanmoloney
requested a review
from a team
as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 9, 2026 14:00
@github-actionsgithub-actionsBot
added

documentation
Improvements or additions to documentation
product/nginx-one-console
Issues related to NGINX One Console
labels
Apr 9, 2026
@github-actions
github-actionsBot
commented
Apr 9, 2026

Copy link


Copy Markdown

✅ Deploy Preview will be available once build job completes!
NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/
@fabriziofiorucci
fabriziofiorucci
commented
Apr 9, 2026

Copy link


Copy Markdown

Contributor
Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 13, 2026 20:47
JTorreG
JTorreG
reviewed
Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md
Outdated


Comment on lines

+1
 to 
+8

---
title: Migrate NGINX Agent v2 to v3 
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---
@JTorreGJTorreGApr 14, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot
added
the 
product/agent
Issues related to NGINX Agent
label
Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 16, 2026 12:07
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated


## Before you begin

- Registry access for agent v3 images.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@travisamartintravisamartinApr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
@kkyle-f5kkyle-f5
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I made a few suggestions.
nginx-seanmoloneyand others
added 13 commits
April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot
deleted the

agent/upgrade-v2-v3-doc

branch
July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.


Assignees


No one assigned


Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add v2 to v3 migration guide - #1843
Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Open
Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Conversation
@nginx-seanmoloney
@nginx-seanmoloneynginx-seanmoloney
commented
Apr 9, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Proposed changes
  • Add v2 to v3 migration guide

    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks
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. ↩
@nginx-seanmoloney
nginx-seanmoloney
requested a review
from a team
as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 9, 2026 14:00
@github-actionsgithub-actionsBot
added

documentation
Improvements or additions to documentation
product/nginx-one-console
Issues related to NGINX One Console
labels
Apr 9, 2026
@github-actions
github-actionsBot
commented
Apr 9, 2026

Copy link


Copy Markdown

✅ Deploy Preview will be available once build job completes!
NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/
@fabriziofiorucci
fabriziofiorucci
commented
Apr 9, 2026

Copy link


Copy Markdown

Contributor
Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 13, 2026 20:47
JTorreG
JTorreG
reviewed
Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md
Outdated


Comment on lines

+1
 to 
+8

---
title: Migrate NGINX Agent v2 to v3 
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---
@JTorreGJTorreGApr 14, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot
added
the 
product/agent
Issues related to NGINX Agent
label
Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 16, 2026 12:07
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated


## Before you begin

- Registry access for agent v3 images.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@travisamartintravisamartinApr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
@kkyle-f5kkyle-f5
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I made a few suggestions.
nginx-seanmoloneyand others
added 13 commits
April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot
deleted the

agent/upgrade-v2-v3-doc

branch
July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.


Assignees


No one assigned


Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add v2 to v3 migration guide - #1843
Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Open
Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Conversation
@nginx-seanmoloney
@nginx-seanmoloneynginx-seanmoloney
commented
Apr 9, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Proposed changes
  • Add v2 to v3 migration guide

    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks
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. ↩
@nginx-seanmoloney
nginx-seanmoloney
requested a review
from a team
as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 9, 2026 14:00
@github-actionsgithub-actionsBot
added

documentation
Improvements or additions to documentation
product/nginx-one-console
Issues related to NGINX One Console
labels
Apr 9, 2026
@github-actions
github-actionsBot
commented
Apr 9, 2026

Copy link


Copy Markdown

✅ Deploy Preview will be available once build job completes!
NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/
@fabriziofiorucci
fabriziofiorucci
commented
Apr 9, 2026

Copy link


Copy Markdown

Contributor
Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 13, 2026 20:47
JTorreG
JTorreG
reviewed
Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md
Outdated


Comment on lines

+1
 to 
+8

---
title: Migrate NGINX Agent v2 to v3 
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---
@JTorreGJTorreGApr 14, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot
added
the 
product/agent
Issues related to NGINX Agent
label
Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 16, 2026 12:07
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated


## Before you begin

- Registry access for agent v3 images.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@travisamartintravisamartinApr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
@kkyle-f5kkyle-f5
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I made a few suggestions.
nginx-seanmoloneyand others
added 13 commits
April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot
deleted the

agent/upgrade-v2-v3-doc

branch
July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.


Assignees


No one assigned


Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add v2 to v3 migration guide - #1843
Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Open
Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Conversation
@nginx-seanmoloney
@nginx-seanmoloneynginx-seanmoloney
commented
Apr 9, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Proposed changes
  • Add v2 to v3 migration guide

    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks
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. ↩
@nginx-seanmoloney
nginx-seanmoloney
requested a review
from a team
as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 9, 2026 14:00
@github-actionsgithub-actionsBot
added

documentation
Improvements or additions to documentation
product/nginx-one-console
Issues related to NGINX One Console
labels
Apr 9, 2026
@github-actions
github-actionsBot
commented
Apr 9, 2026

Copy link


Copy Markdown

✅ Deploy Preview will be available once build job completes!
NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/
@fabriziofiorucci
fabriziofiorucci
commented
Apr 9, 2026

Copy link


Copy Markdown

Contributor
Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 13, 2026 20:47
JTorreG
JTorreG
reviewed
Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md
Outdated


Comment on lines

+1
 to 
+8

---
title: Migrate NGINX Agent v2 to v3 
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---
@JTorreGJTorreGApr 14, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot
added
the 
product/agent
Issues related to NGINX Agent
label
Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 16, 2026 12:07
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated


## Before you begin

- Registry access for agent v3 images.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@travisamartintravisamartinApr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
@kkyle-f5kkyle-f5
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I made a few suggestions.
nginx-seanmoloneyand others
added 13 commits
April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot
deleted the

agent/upgrade-v2-v3-doc

branch
July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.


Assignees


No one assigned


Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add v2 to v3 migration guide - #1843
Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Open
Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Conversation
@nginx-seanmoloney
@nginx-seanmoloneynginx-seanmoloney
commented
Apr 9, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Proposed changes
  • Add v2 to v3 migration guide

    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks
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. ↩
@nginx-seanmoloney
nginx-seanmoloney
requested a review
from a team
as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 9, 2026 14:00
@github-actionsgithub-actionsBot
added

documentation
Improvements or additions to documentation
product/nginx-one-console
Issues related to NGINX One Console
labels
Apr 9, 2026
@github-actions
github-actionsBot
commented
Apr 9, 2026

Copy link


Copy Markdown

✅ Deploy Preview will be available once build job completes!
NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/
@fabriziofiorucci
fabriziofiorucci
commented
Apr 9, 2026

Copy link


Copy Markdown

Contributor
Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 13, 2026 20:47
JTorreG
JTorreG
reviewed
Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md
Outdated


Comment on lines

+1
 to 
+8

---
title: Migrate NGINX Agent v2 to v3 
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---
@JTorreGJTorreGApr 14, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot
added
the 
product/agent
Issues related to NGINX Agent
label
Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 16, 2026 12:07
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated


## Before you begin

- Registry access for agent v3 images.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@travisamartintravisamartinApr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
@kkyle-f5kkyle-f5
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I made a few suggestions.
nginx-seanmoloneyand others
added 13 commits
April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot
deleted the

agent/upgrade-v2-v3-doc

branch
July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.


Assignees


No one assigned


Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add v2 to v3 migration guide - #1843
Open
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Open
Add v2 to v3 migration guide#1843
nginx-seanmoloney wants to merge 17 commits into
mainfrom 
agent/upgrade-v2-v3-doc
Conversation
@nginx-seanmoloney
@nginx-seanmoloneynginx-seanmoloney
commented
Apr 9, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Proposed changes
  • Add v2 to v3 migration guide

    • Document differerent upgrade scenarios
    • Add troubleshooting and post migration checks
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. ↩
@nginx-seanmoloney
nginx-seanmoloney
requested a review
from a team
as a code ownerApril 9, 2026 14:00
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 9, 2026 14:00
@github-actionsgithub-actionsBot
added

documentation
Improvements or additions to documentation
product/nginx-one-console
Issues related to NGINX One Console
labels
Apr 9, 2026
@github-actions
github-actionsBot
commented
Apr 9, 2026

Copy link


Copy Markdown

✅ Deploy Preview will be available once build job completes!
NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/1843/
@fabriziofiorucci
fabriziofiorucci
commented
Apr 9, 2026

Copy link


Copy Markdown

Contributor
Migrate NGINX Agent running in containers - I presume this refers to the case where I have a pod running NGINX and the Agent, and the Agent's config file is mounted through a ConfigMap. Am I correct here? In case I am, it might be worth mentioning this in the MD file
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 13, 2026 20:47
JTorreG
JTorreG
reviewed
Apr 14, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/upgrade-v2-v3.md
Outdated


Comment on lines

+1
 to 
+8

---
title: Migrate NGINX Agent v2 to v3 
weight: 600
toc: true
nd-docs: DOCS-1227
nd-content-type: how-to
nd-product: NAGENT
---
@JTorreGJTorreGApr 14, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Please check the new template for how-to guides
https://github.com/nginx/documentation/blob/main/templates/how-to/guide-how-to.md
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks @JTorreG , yes I have followed the best practices on the linked template.
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as draft
April 15, 2026 09:19
@nginx-seanmoloney
Refactor the update page
ab21ecc
Add in a link to full list of v3 env vars
@nginx-seanmoloney
docs(agent): migrate v2→v3 upgrade guide; update installation docs; a…
e6137ae
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actionsgithub-actionsBot
added
the 
product/agent
Issues related to NGINX Agent
label
Apr 16, 2026
@nginx-seanmoloney
nginx-seanmoloney
marked this pull request as ready for review
April 16, 2026 12:07
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-compose.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated


## Before you begin

- Registry access for agent v3 images.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@travisamartintravisamartinApr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Use the full product name: NGINX Agent
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md
Outdated

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Move under "Ensure you have:"
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/kubernetes.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/migration/vm.md

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
@kkyle-f5kkyle-f5Apr 16, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

- Reinstall the previous v2 package andrestore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.
@nginx-seanmoloneynginx-seanmoloneyApr 22, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Done!
kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
Comment threadcontent/nginx-one-console/agent/install-upgrade/update.md
Outdated

kkyle-f5
kkyle-f5
reviewed
Apr 16, 2026
View reviewed changes
@kkyle-f5kkyle-f5
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I made a few suggestions.
nginx-seanmoloneyand others
added 13 commits
April 20, 2026 14:30
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c6c4de1
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
7fa3b98
…er-compose.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
1d62582
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
d014b58
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/dock…
c4a552a
…er-standalone.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
840ec70
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/update.md
241c6c1
Feeback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney
Feedback from pr
2ce3655
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
76790e3
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/kube…
c52cb11
…rnetes.md
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
b78b317
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
672a005
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@nginx-seanmoloney@kkyle-f5
Update content/nginx-one-console/agent/install-upgrade/migration/vm.md
61a6fea
Feedback from PR
Co-authored-by: kkyle-f5 <k.kyle@f5.com>
@github-actions
github-actionsBot
deleted the

agent/upgrade-v2-v3-doc

branch
July 21, 2026 02:18
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@travisamartintravisamartintravisamartin left review comments
@JTorreGJTorreGJTorreG left review comments
@kkyle-f5kkyle-f5kkyle-f5 left review comments

At least 2 approving reviews are required to merge this pull request.


Assignees


No one assigned


Labels

documentationImprovements or additions to documentationproduct/agentIssues related to NGINX Agentproduct/nginx-one-consoleIssues related to NGINX One Console

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@nginx-seanmoloney@fabriziofiorucci@travisamartin@JTorreG@kkyle-f5