Skip to content

NGINX Agent: Add v3.0 upgrade guide #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from

Conversation

dhurley
Copy link

@dhurley dhurley commented Mar 26, 2025

Proposed changes

Add a page describing how to upgrade from NGINX Agent v2 to v3 and also document the rollback procedure.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

nginx-seanmoloney and others added 7 commits March 4, 2025 16:20
* chore: Update call-out shortcode usage in Contributing

* Update with suggestion

Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>

---------

Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>
Copy link

github-actions bot commented Mar 26, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/agent NGINX Agent labels Mar 26, 2025
@dhurley
Copy link
Author

dhurley commented Mar 26, 2025

I have hereby read the F5 CLA and agree to its terms

Copy link

Deploy Preview will be available once build job completes!

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

./upgrade-agent-config.sh --v2-config-file=./nginx-agent-v2.conf --v3-config-file=nginx-agent-v3.conf
```

If your NGINX Agent container was apart of a config sync group, then your NGINX Agent config needs to be manually updated to add the config sync group label.
Copy link
Contributor

@JTorreG JTorreG Mar 26, 2025

Choose a reason for hiding this comment

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

Suggested change
If your NGINX Agent container was apart of a config sync group, then your NGINX Agent config needs to be manually updated to add the config sync group label.
If your NGINX Agent container was not a member of a config sync group, then your NGINX Agent config must be manually updated to add the config sync group label.

Copy link
Contributor

Choose a reason for hiding this comment

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

@dhurley can you confirm that apart in here means it was outside of config sync groups and not a typo?

Copy link
Author

Choose a reason for hiding this comment

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

Maybe this is a better way to say it.

If your NGINX Agent container was previously a member of a config sync group, then your NGINX Agent config must be manually updated to add the config sync group label.

@JTorreG
Copy link
Contributor

JTorreG commented Mar 26, 2025

@dhurley @nginx-seanmoloney , finished my 1st review pass. I think it will still need more refining

Co-authored-by: Jon Torre <78599298+JTorreG@users.noreply.github.com>
@nginx-seanmoloney nginx-seanmoloney changed the base branch from sm-agent-overview to sm-agent-v3-docs March 27, 2025 17:51
@ADubhlaoich ADubhlaoich deleted the agent-v3-upgrade-guide branch July 3, 2025 15:23
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 NGINX Agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants