Skip to content

Add v2 to v3 migration guide#1843

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

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

Conversation

@nginx-seanmoloney
Copy link
Copy Markdown
Contributor

@nginx-seanmoloney nginx-seanmoloney commented Apr 9, 2026

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 owner April 9, 2026 14:00
@nginx-seanmoloney nginx-seanmoloney marked this pull request as draft April 9, 2026 14:00
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/nginx-one-console Issues related to NGINX One Console labels Apr 9, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 9, 2026

Deploy Preview will be available once build job completes!

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

@fabriziofiorucci
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
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
---
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.

Copy link
Copy Markdown
Contributor Author

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
Add in a link to full list of v3 env vars
…dd migration/; remove deprecated upgrade-v2-v3.md
@github-actions github-actions Bot 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
Comment thread content/nginx-one-console/agent/install-upgrade/migration/docker-compose.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/docker-compose.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/docker-standalone.md Outdated

## Before you begin

- Registry access for agent v3 images.
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:"

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done!

## Before you begin

- Registry access for agent v3 images.
- NGINX_LICENSE_JWT and the NGINX Agent command auth token (data plane key).
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:"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done!

Comment thread content/nginx-one-console/agent/install-upgrade/migration/kubernetes.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/kubernetes.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/vm.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/vm.md Outdated
Comment thread content/nginx-one-console/agent/install-upgrade/migration/vm.md Outdated

## Rollback

- Reinstall the previous v2 package and restore your configuration backup if required.
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 and restore your configuration backup if required.
- Reinstall the previous v2 package and, if required, restore your configuration backup.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done!

Comment thread content/nginx-one-console/agent/install-upgrade/update.md Outdated
Copy link
Copy Markdown
Contributor

@kkyle-f5 kkyle-f5 left a comment

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-seanmoloney and others added 13 commits April 20, 2026 14:30
…er-compose.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
…er-compose.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
…er-standalone.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
…er-standalone.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
…er-standalone.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
…rnetes.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
Feeback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
…rnetes.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
…rnetes.md


Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
Feedback from PR

Co-authored-by: kkyle-f5 <k.kyle@f5.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/agent Issues related to NGINX Agent product/nginx-one-console Issues related to NGINX One Console

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants