Add more information to agent v3 upgrade page. #1566
Conversation
github-actions
bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
| When upgrading to NGINX Agent v3, the installer automatically backs up all configuration files before proceeding. It also converts your v2 configuration to the v3 format, ensuring compatibility and preserving settings. | ||
|
|
||
| {{< call-out "note" >}} | ||
| If you are using a version **older than NGINX Agent v2.31.0**, you must stop NGINX Agent before updating: |
There was a problem hiding this comment.
You may want to include the syntax to get the version. I know you have it in a later step, but having it earlier would help the user settle any doubts about the version they have installed.
|
|
||
| 1. Open an SSH connection to the server where you've installed NGINX Agent. | ||
|
|
||
| 1. Make a backup copy of the following locations to ensure that you can successfully recover if the upgrade does not complete |
There was a problem hiding this comment.
The document earlier explains that the upgrade process makes a backup of your config files for you. Yet, step one has the use make backup files themselves. Why both?
There was a problem hiding this comment.
The installer will only back up the nginx-agent.conf file not the /nginx-agent directory.
| - [Full list of v3 environment variables]({{< ref "/nginx-one-console/agent/configure-instances/configuration-overview/" >}}) | ||
|
|
||
|
|
||
| Taking an example docker-compose file running a NGINX Agent v2 and update to v3. |
There was a problem hiding this comment.
It might be better to show the v2 ENV vars right beside the updated v3 names for them in a table, rather than showing multiple examples files.
There was a problem hiding this comment.
It might be a good idea to show an example on what each variable value should look like/its format etc
There was a problem hiding this comment.
Good point. Including whether or not to use quotes.
Co-authored-by: Daniel Edgar <[email protected]>
Proposed changes
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩